]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/gdbserver/target.h
Initialise target descrption after skipping extra traps for --wrapper
[thirdparty/binutils-gdb.git] / gdb / gdbserver / target.h
1 /* Target operations for the remote server for GDB.
2 Copyright (C) 2002-2015 Free Software Foundation, Inc.
3
4 Contributed by MontaVista Software.
5
6 This file is part of GDB.
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20
21 #ifndef TARGET_H
22 #define TARGET_H
23
24 #include "target/target.h"
25 #include "target/resume.h"
26 #include "target/wait.h"
27 #include "target/waitstatus.h"
28 #include "mem-break.h"
29 #include "btrace-common.h"
30
31 struct emit_ops;
32 struct buffer;
33 struct process_info;
34
35 /* This structure describes how to resume a particular thread (or all
36 threads) based on the client's request. If thread is -1, then this
37 entry applies to all threads. These are passed around as an
38 array. */
39
40 struct thread_resume
41 {
42 ptid_t thread;
43
44 /* How to "resume". */
45 enum resume_kind kind;
46
47 /* If non-zero, send this signal when we resume, or to stop the
48 thread. If stopping a thread, and this is 0, the target should
49 stop the thread however it best decides to (e.g., SIGSTOP on
50 linux; SuspendThread on win32). This is a host signal value (not
51 enum gdb_signal). */
52 int sig;
53
54 /* Range to single step within. Valid only iff KIND is resume_step.
55
56 Single-step once, and then continuing stepping as long as the
57 thread stops in this range. (If the range is empty
58 [STEP_RANGE_START == STEP_RANGE_END], then this is a single-step
59 request.) */
60 CORE_ADDR step_range_start; /* Inclusive */
61 CORE_ADDR step_range_end; /* Exclusive */
62 };
63
64 struct target_ops
65 {
66 /* Start a new process.
67
68 PROGRAM is a path to the program to execute.
69 ARGS is a standard NULL-terminated array of arguments,
70 to be passed to the inferior as ``argv''.
71
72 Returns the new PID on success, -1 on failure. Registers the new
73 process with the process list. */
74
75 int (*create_inferior) (char *program, char **args);
76
77 /* Architecture-specific setup. */
78 void (*arch_setup) (void);
79
80 /* Attach to a running process.
81
82 PID is the process ID to attach to, specified by the user
83 or a higher layer.
84
85 Returns -1 if attaching is unsupported, 0 on success, and calls
86 error() otherwise. */
87
88 int (*attach) (unsigned long pid);
89
90 /* Kill inferior PID. Return -1 on failure, and 0 on success. */
91
92 int (*kill) (int pid);
93
94 /* Detach from inferior PID. Return -1 on failure, and 0 on
95 success. */
96
97 int (*detach) (int pid);
98
99 /* The inferior process has died. Do what is right. */
100
101 void (*mourn) (struct process_info *proc);
102
103 /* Wait for inferior PID to exit. */
104 void (*join) (int pid);
105
106 /* Return 1 iff the thread with process ID PID is alive. */
107
108 int (*thread_alive) (ptid_t pid);
109
110 /* Resume the inferior process. */
111
112 void (*resume) (struct thread_resume *resume_info, size_t n);
113
114 /* Wait for the inferior process or thread to change state. Store
115 status through argument pointer STATUS.
116
117 PTID = -1 to wait for any pid to do something, PTID(pid,0,0) to
118 wait for any thread of process pid to do something. Return ptid
119 of child, or -1 in case of error; store status through argument
120 pointer STATUS. OPTIONS is a bit set of options defined as
121 TARGET_W* above. If options contains TARGET_WNOHANG and there's
122 no child stop to report, return is
123 null_ptid/TARGET_WAITKIND_IGNORE. */
124
125 ptid_t (*wait) (ptid_t ptid, struct target_waitstatus *status, int options);
126
127 /* Fetch registers from the inferior process.
128
129 If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO. */
130
131 void (*fetch_registers) (struct regcache *regcache, int regno);
132
133 /* Store registers to the inferior process.
134
135 If REGNO is -1, store all registers; otherwise, store at least REGNO. */
136
137 void (*store_registers) (struct regcache *regcache, int regno);
138
139 /* Prepare to read or write memory from the inferior process.
140 Targets use this to do what is necessary to get the state of the
141 inferior such that it is possible to access memory.
142
143 This should generally only be called from client facing routines,
144 such as gdb_read_memory/gdb_write_memory, or the GDB breakpoint
145 insertion routine.
146
147 Like `read_memory' and `write_memory' below, returns 0 on success
148 and errno on failure. */
149
150 int (*prepare_to_access_memory) (void);
151
152 /* Undo the effects of prepare_to_access_memory. */
153
154 void (*done_accessing_memory) (void);
155
156 /* Read memory from the inferior process. This should generally be
157 called through read_inferior_memory, which handles breakpoint shadowing.
158
159 Read LEN bytes at MEMADDR into a buffer at MYADDR.
160
161 Returns 0 on success and errno on failure. */
162
163 int (*read_memory) (CORE_ADDR memaddr, unsigned char *myaddr, int len);
164
165 /* Write memory to the inferior process. This should generally be
166 called through write_inferior_memory, which handles breakpoint shadowing.
167
168 Write LEN bytes from the buffer at MYADDR to MEMADDR.
169
170 Returns 0 on success and errno on failure. */
171
172 int (*write_memory) (CORE_ADDR memaddr, const unsigned char *myaddr,
173 int len);
174
175 /* Query GDB for the values of any symbols we're interested in.
176 This function is called whenever we receive a "qSymbols::"
177 query, which corresponds to every time more symbols (might)
178 become available. NULL if we aren't interested in any
179 symbols. */
180
181 void (*look_up_symbols) (void);
182
183 /* Send an interrupt request to the inferior process,
184 however is appropriate. */
185
186 void (*request_interrupt) (void);
187
188 /* Read auxiliary vector data from the inferior process.
189
190 Read LEN bytes at OFFSET into a buffer at MYADDR. */
191
192 int (*read_auxv) (CORE_ADDR offset, unsigned char *myaddr,
193 unsigned int len);
194
195 /* Returns true if GDB Z breakpoint type TYPE is supported, false
196 otherwise. The type is coded as follows:
197 '0' - software-breakpoint
198 '1' - hardware-breakpoint
199 '2' - write watchpoint
200 '3' - read watchpoint
201 '4' - access watchpoint
202 */
203 int (*supports_z_point_type) (char z_type);
204
205 /* Insert and remove a break or watchpoint.
206 Returns 0 on success, -1 on failure and 1 on unsupported. */
207
208 int (*insert_point) (enum raw_bkpt_type type, CORE_ADDR addr,
209 int size, struct raw_breakpoint *bp);
210 int (*remove_point) (enum raw_bkpt_type type, CORE_ADDR addr,
211 int size, struct raw_breakpoint *bp);
212
213 /* Returns 1 if the target stopped because it executed a software
214 breakpoint instruction, 0 otherwise. */
215 int (*stopped_by_sw_breakpoint) (void);
216
217 /* Returns true if the target knows whether a trap was caused by a
218 SW breakpoint triggering. */
219 int (*supports_stopped_by_sw_breakpoint) (void);
220
221 /* Returns 1 if the target stopped for a hardware breakpoint. */
222 int (*stopped_by_hw_breakpoint) (void);
223
224 /* Returns true if the target knows whether a trap was caused by a
225 HW breakpoint triggering. */
226 int (*supports_stopped_by_hw_breakpoint) (void);
227
228 /* Returns true if the target can evaluate conditions of
229 breakpoints. */
230 int (*supports_conditional_breakpoints) (void);
231
232 /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise. */
233
234 int (*stopped_by_watchpoint) (void);
235
236 /* Returns the address associated with the watchpoint that hit, if any;
237 returns 0 otherwise. */
238
239 CORE_ADDR (*stopped_data_address) (void);
240
241 /* Reports the text, data offsets of the executable. This is
242 needed for uclinux where the executable is relocated during load
243 time. */
244
245 int (*read_offsets) (CORE_ADDR *text, CORE_ADDR *data);
246
247 /* Fetch the address associated with a specific thread local storage
248 area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
249 Stores it in *ADDRESS and returns zero on success; otherwise returns
250 an error code. A return value of -1 means this system does not
251 support the operation. */
252
253 int (*get_tls_address) (struct thread_info *thread, CORE_ADDR offset,
254 CORE_ADDR load_module, CORE_ADDR *address);
255
256 /* Read/Write from/to spufs using qXfer packets. */
257 int (*qxfer_spu) (const char *annex, unsigned char *readbuf,
258 unsigned const char *writebuf, CORE_ADDR offset, int len);
259
260 /* Fill BUF with an hostio error packet representing the last hostio
261 error. */
262 void (*hostio_last_error) (char *buf);
263
264 /* Read/Write OS data using qXfer packets. */
265 int (*qxfer_osdata) (const char *annex, unsigned char *readbuf,
266 unsigned const char *writebuf, CORE_ADDR offset,
267 int len);
268
269 /* Read/Write extra signal info. */
270 int (*qxfer_siginfo) (const char *annex, unsigned char *readbuf,
271 unsigned const char *writebuf,
272 CORE_ADDR offset, int len);
273
274 int (*supports_non_stop) (void);
275
276 /* Enables async target events. Returns the previous enable
277 state. */
278 int (*async) (int enable);
279
280 /* Switch to non-stop (1) or all-stop (0) mode. Return 0 on
281 success, -1 otherwise. */
282 int (*start_non_stop) (int);
283
284 /* Returns true if the target supports multi-process debugging. */
285 int (*supports_multi_process) (void);
286
287 /* Returns true if fork events are supported. */
288 int (*supports_fork_events) (void);
289
290 /* Returns true if vfork events are supported. */
291 int (*supports_vfork_events) (void);
292
293 /* Allows target to re-initialize connection-specific settings. */
294 void (*handle_new_gdb_connection) (void);
295
296 /* If not NULL, target-specific routine to process monitor command.
297 Returns 1 if handled, or 0 to perform default processing. */
298 int (*handle_monitor_command) (char *);
299
300 /* Returns the core given a thread, or -1 if not known. */
301 int (*core_of_thread) (ptid_t);
302
303 /* Read loadmaps. Read LEN bytes at OFFSET into a buffer at MYADDR. */
304 int (*read_loadmap) (const char *annex, CORE_ADDR offset,
305 unsigned char *myaddr, unsigned int len);
306
307 /* Target specific qSupported support. */
308 void (*process_qsupported) (const char *);
309
310 /* Return 1 if the target supports tracepoints, 0 (or leave the
311 callback NULL) otherwise. */
312 int (*supports_tracepoints) (void);
313
314 /* Read PC from REGCACHE. */
315 CORE_ADDR (*read_pc) (struct regcache *regcache);
316
317 /* Write PC to REGCACHE. */
318 void (*write_pc) (struct regcache *regcache, CORE_ADDR pc);
319
320 /* Return true if THREAD is known to be stopped now. */
321 int (*thread_stopped) (struct thread_info *thread);
322
323 /* Read Thread Information Block address. */
324 int (*get_tib_address) (ptid_t ptid, CORE_ADDR *address);
325
326 /* Pause all threads. If FREEZE, arrange for any resume attempt to
327 be ignored until an unpause_all call unfreezes threads again.
328 There can be nested calls to pause_all, so a freeze counter
329 should be maintained. */
330 void (*pause_all) (int freeze);
331
332 /* Unpause all threads. Threads that hadn't been resumed by the
333 client should be left stopped. Basically a pause/unpause call
334 pair should not end up resuming threads that were stopped before
335 the pause call. */
336 void (*unpause_all) (int unfreeze);
337
338 /* Stabilize all threads. That is, force them out of jump pads. */
339 void (*stabilize_threads) (void);
340
341 /* Install a fast tracepoint jump pad. TPOINT is the address of the
342 tracepoint internal object as used by the IPA agent. TPADDR is
343 the address of tracepoint. COLLECTOR is address of the function
344 the jump pad redirects to. LOCKADDR is the address of the jump
345 pad lock object. ORIG_SIZE is the size in bytes of the
346 instruction at TPADDR. JUMP_ENTRY points to the address of the
347 jump pad entry, and on return holds the address past the end of
348 the created jump pad. If a trampoline is created by the function,
349 then TRAMPOLINE and TRAMPOLINE_SIZE return the address and size of
350 the trampoline, else they remain unchanged. JJUMP_PAD_INSN is a
351 buffer containing a copy of the instruction at TPADDR.
352 ADJUST_INSN_ADDR and ADJUST_INSN_ADDR_END are output parameters that
353 return the address range where the instruction at TPADDR was relocated
354 to. If an error occurs, the ERR may be used to pass on an error
355 message. */
356 int (*install_fast_tracepoint_jump_pad) (CORE_ADDR tpoint, CORE_ADDR tpaddr,
357 CORE_ADDR collector,
358 CORE_ADDR lockaddr,
359 ULONGEST orig_size,
360 CORE_ADDR *jump_entry,
361 CORE_ADDR *trampoline,
362 ULONGEST *trampoline_size,
363 unsigned char *jjump_pad_insn,
364 ULONGEST *jjump_pad_insn_size,
365 CORE_ADDR *adjusted_insn_addr,
366 CORE_ADDR *adjusted_insn_addr_end,
367 char *err);
368
369 /* Return the bytecode operations vector for the current inferior.
370 Returns NULL if bytecode compilation is not supported. */
371 struct emit_ops *(*emit_ops) (void);
372
373 /* Returns true if the target supports disabling randomization. */
374 int (*supports_disable_randomization) (void);
375
376 /* Return the minimum length of an instruction that can be safely overwritten
377 for use as a fast tracepoint. */
378 int (*get_min_fast_tracepoint_insn_len) (void);
379
380 /* Read solib info on SVR4 platforms. */
381 int (*qxfer_libraries_svr4) (const char *annex, unsigned char *readbuf,
382 unsigned const char *writebuf,
383 CORE_ADDR offset, int len);
384
385 /* Return true if target supports debugging agent. */
386 int (*supports_agent) (void);
387
388 /* Check whether the target supports branch tracing. */
389 int (*supports_btrace) (struct target_ops *, enum btrace_format);
390
391 /* Enable branch tracing for PTID based on CONF and allocate a branch trace
392 target information struct for reading and for disabling branch trace. */
393 struct btrace_target_info *(*enable_btrace)
394 (ptid_t ptid, const struct btrace_config *conf);
395
396 /* Disable branch tracing.
397 Returns zero on success, non-zero otherwise. */
398 int (*disable_btrace) (struct btrace_target_info *tinfo);
399
400 /* Read branch trace data into buffer. We use an int to specify the type
401 to break a cyclic dependency.
402 Return 0 on success; print an error message into BUFFER and return -1,
403 otherwise. */
404 int (*read_btrace) (struct btrace_target_info *, struct buffer *, int type);
405
406 /* Read the branch trace configuration into BUFFER.
407 Return 0 on success; print an error message into BUFFER and return -1
408 otherwise. */
409 int (*read_btrace_conf) (const struct btrace_target_info *, struct buffer *);
410
411 /* Return true if target supports range stepping. */
412 int (*supports_range_stepping) (void);
413
414 /* Return the full absolute name of the executable file that was
415 run to create the process PID. If the executable file cannot
416 be determined, NULL is returned. Otherwise, a pointer to a
417 character string containing the pathname is returned. This
418 string should be copied into a buffer by the client if the string
419 will not be immediately used, or if it must persist. */
420 char *(*pid_to_exec_file) (int pid);
421
422 /* Multiple-filesystem-aware open. Like open(2), but operating in
423 the filesystem as it appears to process PID. Systems where all
424 processes share a common filesystem should set this to NULL.
425 If NULL, the caller should fall back to open(2). */
426 int (*multifs_open) (int pid, const char *filename,
427 int flags, mode_t mode);
428
429 /* Multiple-filesystem-aware unlink. Like unlink(2), but operates
430 in the filesystem as it appears to process PID. Systems where
431 all processes share a common filesystem should set this to NULL.
432 If NULL, the caller should fall back to unlink(2). */
433 int (*multifs_unlink) (int pid, const char *filename);
434
435 /* Multiple-filesystem-aware readlink. Like readlink(2), but
436 operating in the filesystem as it appears to process PID.
437 Systems where all processes share a common filesystem should
438 set this to NULL. If NULL, the caller should fall back to
439 readlink(2). */
440 ssize_t (*multifs_readlink) (int pid, const char *filename,
441 char *buf, size_t bufsiz);
442 };
443
444 extern struct target_ops *the_target;
445
446 void set_target_ops (struct target_ops *);
447
448 #define create_inferior(program, args) \
449 (*the_target->create_inferior) (program, args)
450
451 #define target_arch_setup() \
452 do \
453 { \
454 if (the_target->arch_setup != NULL) \
455 (*the_target->arch_setup) (); \
456 } while (0)
457
458 #define myattach(pid) \
459 (*the_target->attach) (pid)
460
461 int kill_inferior (int);
462
463 #define target_supports_fork_events() \
464 (the_target->supports_fork_events ? \
465 (*the_target->supports_fork_events) () : 0)
466
467 #define target_supports_vfork_events() \
468 (the_target->supports_vfork_events ? \
469 (*the_target->supports_vfork_events) () : 0)
470
471 #define target_handle_new_gdb_connection() \
472 do \
473 { \
474 if (the_target->handle_new_gdb_connection != NULL) \
475 (*the_target->handle_new_gdb_connection) (); \
476 } while (0)
477
478 #define detach_inferior(pid) \
479 (*the_target->detach) (pid)
480
481 #define mourn_inferior(PROC) \
482 (*the_target->mourn) (PROC)
483
484 #define mythread_alive(pid) \
485 (*the_target->thread_alive) (pid)
486
487 #define fetch_inferior_registers(regcache, regno) \
488 (*the_target->fetch_registers) (regcache, regno)
489
490 #define store_inferior_registers(regcache, regno) \
491 (*the_target->store_registers) (regcache, regno)
492
493 #define join_inferior(pid) \
494 (*the_target->join) (pid)
495
496 #define target_supports_non_stop() \
497 (the_target->supports_non_stop ? (*the_target->supports_non_stop ) () : 0)
498
499 #define target_async(enable) \
500 (the_target->async ? (*the_target->async) (enable) : 0)
501
502 #define target_supports_multi_process() \
503 (the_target->supports_multi_process ? \
504 (*the_target->supports_multi_process) () : 0)
505
506 #define target_process_qsupported(query) \
507 do \
508 { \
509 if (the_target->process_qsupported) \
510 the_target->process_qsupported (query); \
511 } while (0)
512
513 #define target_supports_tracepoints() \
514 (the_target->supports_tracepoints \
515 ? (*the_target->supports_tracepoints) () : 0)
516
517 #define target_supports_fast_tracepoints() \
518 (the_target->install_fast_tracepoint_jump_pad != NULL)
519
520 #define target_get_min_fast_tracepoint_insn_len() \
521 (the_target->get_min_fast_tracepoint_insn_len \
522 ? (*the_target->get_min_fast_tracepoint_insn_len) () : 0)
523
524 #define thread_stopped(thread) \
525 (*the_target->thread_stopped) (thread)
526
527 #define pause_all(freeze) \
528 do \
529 { \
530 if (the_target->pause_all) \
531 (*the_target->pause_all) (freeze); \
532 } while (0)
533
534 #define unpause_all(unfreeze) \
535 do \
536 { \
537 if (the_target->unpause_all) \
538 (*the_target->unpause_all) (unfreeze); \
539 } while (0)
540
541 #define stabilize_threads() \
542 do \
543 { \
544 if (the_target->stabilize_threads) \
545 (*the_target->stabilize_threads) (); \
546 } while (0)
547
548 #define install_fast_tracepoint_jump_pad(tpoint, tpaddr, \
549 collector, lockaddr, \
550 orig_size, \
551 jump_entry, \
552 trampoline, trampoline_size, \
553 jjump_pad_insn, \
554 jjump_pad_insn_size, \
555 adjusted_insn_addr, \
556 adjusted_insn_addr_end, \
557 err) \
558 (*the_target->install_fast_tracepoint_jump_pad) (tpoint, tpaddr, \
559 collector,lockaddr, \
560 orig_size, jump_entry, \
561 trampoline, \
562 trampoline_size, \
563 jjump_pad_insn, \
564 jjump_pad_insn_size, \
565 adjusted_insn_addr, \
566 adjusted_insn_addr_end, \
567 err)
568
569 #define target_emit_ops() \
570 (the_target->emit_ops ? (*the_target->emit_ops) () : NULL)
571
572 #define target_supports_disable_randomization() \
573 (the_target->supports_disable_randomization ? \
574 (*the_target->supports_disable_randomization) () : 0)
575
576 #define target_supports_agent() \
577 (the_target->supports_agent ? \
578 (*the_target->supports_agent) () : 0)
579
580 #define target_supports_btrace(format) \
581 (the_target->supports_btrace \
582 ? (*the_target->supports_btrace) (the_target, format) : 0)
583
584 #define target_enable_btrace(ptid, conf) \
585 (*the_target->enable_btrace) (ptid, conf)
586
587 #define target_disable_btrace(tinfo) \
588 (*the_target->disable_btrace) (tinfo)
589
590 #define target_read_btrace(tinfo, buffer, type) \
591 (*the_target->read_btrace) (tinfo, buffer, type)
592
593 #define target_read_btrace_conf(tinfo, buffer) \
594 (*the_target->read_btrace_conf) (tinfo, buffer)
595
596 #define target_supports_range_stepping() \
597 (the_target->supports_range_stepping ? \
598 (*the_target->supports_range_stepping) () : 0)
599
600 #define target_supports_stopped_by_sw_breakpoint() \
601 (the_target->supports_stopped_by_sw_breakpoint ? \
602 (*the_target->supports_stopped_by_sw_breakpoint) () : 0)
603
604 #define target_stopped_by_sw_breakpoint() \
605 (the_target->stopped_by_sw_breakpoint ? \
606 (*the_target->stopped_by_sw_breakpoint) () : 0)
607
608 #define target_supports_stopped_by_hw_breakpoint() \
609 (the_target->supports_stopped_by_hw_breakpoint ? \
610 (*the_target->supports_stopped_by_hw_breakpoint) () : 0)
611
612 #define target_supports_conditional_breakpoints() \
613 (the_target->supports_conditional_breakpoints ? \
614 (*the_target->supports_conditional_breakpoints) () : 0)
615
616 #define target_stopped_by_hw_breakpoint() \
617 (the_target->stopped_by_hw_breakpoint ? \
618 (*the_target->stopped_by_hw_breakpoint) () : 0)
619
620 /* Start non-stop mode, returns 0 on success, -1 on failure. */
621
622 int start_non_stop (int nonstop);
623
624 ptid_t mywait (ptid_t ptid, struct target_waitstatus *ourstatus, int options,
625 int connected_wait);
626
627 #define prepare_to_access_memory() \
628 (the_target->prepare_to_access_memory \
629 ? (*the_target->prepare_to_access_memory) () \
630 : 0)
631
632 #define done_accessing_memory() \
633 do \
634 { \
635 if (the_target->done_accessing_memory) \
636 (*the_target->done_accessing_memory) (); \
637 } while (0)
638
639 #define target_core_of_thread(ptid) \
640 (the_target->core_of_thread ? (*the_target->core_of_thread) (ptid) \
641 : -1)
642
643 int read_inferior_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len);
644
645 int write_inferior_memory (CORE_ADDR memaddr, const unsigned char *myaddr,
646 int len);
647
648 void set_desired_thread (int id);
649
650 const char *target_pid_to_str (ptid_t);
651
652 #endif /* TARGET_H */