1 /* Interface between GDB and target environments, including files and processes
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 Free Software Foundation, Inc.
7 Contributed by Cygnus Support. Written by John Gilmore.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #if !defined (TARGET_H)
32 struct bp_target_info;
34 struct target_section_table;
35 struct trace_state_variable;
39 struct static_tracepoint_marker;
40 struct traceframe_info;
43 /* This include file defines the interface between the main part
44 of the debugger, and the part which is target-specific, or
45 specific to the communications interface between us and the
48 A TARGET is an interface between the debugger and a particular
49 kind of file or process. Targets can be STACKED in STRATA,
50 so that more than one target can potentially respond to a request.
51 In particular, memory accesses will walk down the stack of targets
52 until they find a target that is interested in handling that particular
53 address. STRATA are artificial boundaries on the stack, within
54 which particular kinds of targets live. Strata exist so that
55 people don't get confused by pushing e.g. a process target and then
56 a file target, and wondering why they can't see the current values
57 of variables any more (the file target is handling them and they
58 never get to the process target). So when you push a file target,
59 it goes into the file stratum, which is always below the process
66 #include "gdb_signals.h"
70 dummy_stratum, /* The lowest of the low */
71 file_stratum, /* Executable files, etc */
72 process_stratum, /* Executing processes or core dump files */
73 thread_stratum, /* Executing threads */
74 record_stratum, /* Support record debugging */
75 arch_stratum /* Architecture overrides */
78 enum thread_control_capabilities
80 tc_none = 0, /* Default: can't control thread execution. */
81 tc_schedlock = 1, /* Can lock the thread scheduler. */
84 /* Stuff for target_wait. */
86 /* Generally, what has the program done? */
89 /* The program has exited. The exit status is in value.integer. */
90 TARGET_WAITKIND_EXITED,
92 /* The program has stopped with a signal. Which signal is in
94 TARGET_WAITKIND_STOPPED,
96 /* The program has terminated with a signal. Which signal is in
98 TARGET_WAITKIND_SIGNALLED,
100 /* The program is letting us know that it dynamically loaded something
101 (e.g. it called load(2) on AIX). */
102 TARGET_WAITKIND_LOADED,
104 /* The program has forked. A "related" process' PTID is in
105 value.related_pid. I.e., if the child forks, value.related_pid
106 is the parent's ID. */
108 TARGET_WAITKIND_FORKED,
110 /* The program has vforked. A "related" process's PTID is in
111 value.related_pid. */
113 TARGET_WAITKIND_VFORKED,
115 /* The program has exec'ed a new executable file. The new file's
116 pathname is pointed to by value.execd_pathname. */
118 TARGET_WAITKIND_EXECD,
120 /* The program had previously vforked, and now the child is done
121 with the shared memory region, because it exec'ed or exited.
122 Note that the event is reported to the vfork parent. This is
123 only used if GDB did not stay attached to the vfork child,
124 otherwise, a TARGET_WAITKIND_EXECD or
125 TARGET_WAITKIND_EXIT|SIGNALLED event associated with the child
126 has the same effect. */
127 TARGET_WAITKIND_VFORK_DONE,
129 /* The program has entered or returned from a system call. On
130 HP-UX, this is used in the hardware watchpoint implementation.
131 The syscall's unique integer ID number is in value.syscall_id. */
133 TARGET_WAITKIND_SYSCALL_ENTRY,
134 TARGET_WAITKIND_SYSCALL_RETURN,
136 /* Nothing happened, but we stopped anyway. This perhaps should be handled
137 within target_wait, but I'm not sure target_wait should be resuming the
139 TARGET_WAITKIND_SPURIOUS,
141 /* An event has occured, but we should wait again.
142 Remote_async_wait() returns this when there is an event
143 on the inferior, but the rest of the world is not interested in
144 it. The inferior has not stopped, but has just sent some output
145 to the console, for instance. In this case, we want to go back
146 to the event loop and wait there for another event from the
147 inferior, rather than being stuck in the remote_async_wait()
148 function. sThis way the event loop is responsive to other events,
149 like for instance the user typing. */
150 TARGET_WAITKIND_IGNORE,
152 /* The target has run out of history information,
153 and cannot run backward any further. */
154 TARGET_WAITKIND_NO_HISTORY,
156 /* There are no resumed children left in the program. */
157 TARGET_WAITKIND_NO_RESUMED
160 struct target_waitstatus
162 enum target_waitkind kind;
164 /* Forked child pid, execd pathname, exit status, signal number or
169 enum target_signal sig;
171 char *execd_pathname;
177 /* Options that can be passed to target_wait. */
179 /* Return immediately if there's no event already queued. If this
180 options is not requested, target_wait blocks waiting for an
182 #define TARGET_WNOHANG 1
184 /* The structure below stores information about a system call.
185 It is basically used in the "catch syscall" command, and in
186 every function that gives information about a system call.
188 It's also good to mention that its fields represent everything
189 that we currently know about a syscall in GDB. */
192 /* The syscall number. */
195 /* The syscall name. */
199 /* Return a pretty printed form of target_waitstatus.
200 Space for the result is malloc'd, caller must free. */
201 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
203 /* Possible types of events that the inferior handler will have to
205 enum inferior_event_type
207 /* Process a normal inferior event which will result in target_wait
210 /* We are called because a timer went off. */
212 /* We are called to do stuff after the inferior stops. */
214 /* We are called to do some stuff after the inferior stops, but we
215 are expected to reenter the proceed() and
216 handle_inferior_event() functions. This is used only in case of
217 'step n' like commands. */
221 /* Target objects which can be transfered using target_read,
222 target_write, et cetera. */
226 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
228 /* SPU target specific transfer. See "spu-tdep.c". */
230 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
231 TARGET_OBJECT_MEMORY,
232 /* Memory, avoiding GDB's data cache and trusting the executable.
233 Target implementations of to_xfer_partial never need to handle
234 this object, and most callers should not use it. */
235 TARGET_OBJECT_RAW_MEMORY,
236 /* Memory known to be part of the target's stack. This is cached even
237 if it is not in a region marked as such, since it is known to be
239 TARGET_OBJECT_STACK_MEMORY,
240 /* Kernel Unwind Table. See "ia64-tdep.c". */
241 TARGET_OBJECT_UNWIND_TABLE,
242 /* Transfer auxilliary vector. */
244 /* StackGhost cookie. See "sparc-tdep.c". */
245 TARGET_OBJECT_WCOOKIE,
246 /* Target memory map in XML format. */
247 TARGET_OBJECT_MEMORY_MAP,
248 /* Flash memory. This object can be used to write contents to
249 a previously erased flash memory. Using it without erasing
250 flash can have unexpected results. Addresses are physical
251 address on target, and not relative to flash start. */
253 /* Available target-specific features, e.g. registers and coprocessors.
254 See "target-descriptions.c". ANNEX should never be empty. */
255 TARGET_OBJECT_AVAILABLE_FEATURES,
256 /* Currently loaded libraries, in XML format. */
257 TARGET_OBJECT_LIBRARIES,
258 /* Get OS specific data. The ANNEX specifies the type (running
259 processes, etc.). The data being transfered is expected to follow
260 the DTD specified in features/osdata.dtd. */
261 TARGET_OBJECT_OSDATA,
262 /* Extra signal info. Usually the contents of `siginfo_t' on unix
264 TARGET_OBJECT_SIGNAL_INFO,
265 /* The list of threads that are being debugged. */
266 TARGET_OBJECT_THREADS,
267 /* Collected static trace data. */
268 TARGET_OBJECT_STATIC_TRACE_DATA,
269 /* The HP-UX registers (those that can be obtained or modified by using
270 the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests). */
271 TARGET_OBJECT_HPUX_UREGS,
272 /* The HP-UX shared library linkage pointer. ANNEX should be a string
273 image of the code address whose linkage pointer we are looking for.
275 The size of the data transfered is always 8 bytes (the size of an
277 TARGET_OBJECT_HPUX_SOLIB_GOT,
278 /* Traceframe info, in XML format. */
279 TARGET_OBJECT_TRACEFRAME_INFO,
280 /* Load maps for FDPIC systems. */
282 /* Darwin dynamic linker info data. */
283 TARGET_OBJECT_DARWIN_DYLD_INFO
284 /* Possible future objects: TARGET_OBJECT_FILE, ... */
287 /* Enumeration of the kinds of traceframe searches that a target may
288 be able to perform. */
299 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
300 DEF_VEC_P(static_tracepoint_marker_p);
302 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
303 OBJECT. The OFFSET, for a seekable object, specifies the
304 starting point. The ANNEX can be used to provide additional
305 data-specific information to the target.
307 Return the number of bytes actually transfered, or -1 if the
308 transfer is not supported or otherwise fails. Return of a positive
309 value less than LEN indicates that no further transfer is possible.
310 Unlike the raw to_xfer_partial interface, callers of these
311 functions do not need to retry partial transfers. */
313 extern LONGEST target_read (struct target_ops *ops,
314 enum target_object object,
315 const char *annex, gdb_byte *buf,
316 ULONGEST offset, LONGEST len);
318 struct memory_read_result
320 /* First address that was read. */
322 /* Past-the-end address. */
327 typedef struct memory_read_result memory_read_result_s;
328 DEF_VEC_O(memory_read_result_s);
330 extern void free_memory_read_result_vector (void *);
332 extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
336 extern LONGEST target_write (struct target_ops *ops,
337 enum target_object object,
338 const char *annex, const gdb_byte *buf,
339 ULONGEST offset, LONGEST len);
341 /* Similar to target_write, except that it also calls PROGRESS with
342 the number of bytes written and the opaque BATON after every
343 successful partial write (and before the first write). This is
344 useful for progress reporting and user interaction while writing
345 data. To abort the transfer, the progress callback can throw an
348 LONGEST target_write_with_progress (struct target_ops *ops,
349 enum target_object object,
350 const char *annex, const gdb_byte *buf,
351 ULONGEST offset, LONGEST len,
352 void (*progress) (ULONGEST, void *),
355 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
356 be read using OPS. The return value will be -1 if the transfer
357 fails or is not supported; 0 if the object is empty; or the length
358 of the object otherwise. If a positive value is returned, a
359 sufficiently large buffer will be allocated using xmalloc and
360 returned in *BUF_P containing the contents of the object.
362 This method should be used for objects sufficiently small to store
363 in a single xmalloc'd buffer, when no fixed bound on the object's
364 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
365 through this function. */
367 extern LONGEST target_read_alloc (struct target_ops *ops,
368 enum target_object object,
369 const char *annex, gdb_byte **buf_p);
371 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
372 returned as a string, allocated using xmalloc. If an error occurs
373 or the transfer is unsupported, NULL is returned. Empty objects
374 are returned as allocated but empty strings. A warning is issued
375 if the result contains any embedded NUL bytes. */
377 extern char *target_read_stralloc (struct target_ops *ops,
378 enum target_object object,
381 /* Wrappers to target read/write that perform memory transfers. They
382 throw an error if the memory transfer fails.
384 NOTE: cagney/2003-10-23: The naming schema is lifted from
385 "frame.h". The parameter order is lifted from get_frame_memory,
386 which in turn lifted it from read_memory. */
388 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
389 gdb_byte *buf, LONGEST len);
390 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
391 CORE_ADDR addr, int len,
392 enum bfd_endian byte_order);
394 struct thread_info; /* fwd decl for parameter list below: */
398 struct target_ops *beneath; /* To the target under this one. */
399 char *to_shortname; /* Name this target type */
400 char *to_longname; /* Name for printing */
401 char *to_doc; /* Documentation. Does not include trailing
402 newline, and starts with a one-line descrip-
403 tion (probably similar to to_longname). */
404 /* Per-target scratch pad. */
406 /* The open routine takes the rest of the parameters from the
407 command, and (if successful) pushes a new target onto the
408 stack. Targets should supply this routine, if only to provide
410 void (*to_open) (char *, int);
411 /* Old targets with a static target vector provide "to_close".
412 New re-entrant targets provide "to_xclose" and that is expected
413 to xfree everything (including the "struct target_ops"). */
414 void (*to_xclose) (struct target_ops *targ, int quitting);
415 void (*to_close) (int);
416 void (*to_attach) (struct target_ops *ops, char *, int);
417 void (*to_post_attach) (int);
418 void (*to_detach) (struct target_ops *ops, char *, int);
419 void (*to_disconnect) (struct target_ops *, char *, int);
420 void (*to_resume) (struct target_ops *, ptid_t, int, enum target_signal);
421 ptid_t (*to_wait) (struct target_ops *,
422 ptid_t, struct target_waitstatus *, int);
423 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
424 void (*to_store_registers) (struct target_ops *, struct regcache *, int);
425 void (*to_prepare_to_store) (struct regcache *);
427 /* Transfer LEN bytes of memory between GDB address MYADDR and
428 target address MEMADDR. If WRITE, transfer them to the target, else
429 transfer them from the target. TARGET is the target from which we
432 Return value, N, is one of the following:
434 0 means that we can't handle this. If errno has been set, it is the
435 error which prevented us from doing it (FIXME: What about bfd_error?).
437 positive (call it N) means that we have transferred N bytes
438 starting at MEMADDR. We might be able to handle more bytes
439 beyond this length, but no promises.
441 negative (call its absolute value N) means that we cannot
442 transfer right at MEMADDR, but we could transfer at least
443 something at MEMADDR + N.
445 NOTE: cagney/2004-10-01: This has been entirely superseeded by
446 to_xfer_partial and inferior inheritance. */
448 int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
450 struct mem_attrib *attrib,
451 struct target_ops *target);
453 void (*to_files_info) (struct target_ops *);
454 int (*to_insert_breakpoint) (struct gdbarch *, struct bp_target_info *);
455 int (*to_remove_breakpoint) (struct gdbarch *, struct bp_target_info *);
456 int (*to_can_use_hw_breakpoint) (int, int, int);
457 int (*to_ranged_break_num_registers) (struct target_ops *);
458 int (*to_insert_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
459 int (*to_remove_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
461 /* Documentation of what the two routines below are expected to do is
462 provided with the corresponding target_* macros. */
463 int (*to_remove_watchpoint) (CORE_ADDR, int, int, struct expression *);
464 int (*to_insert_watchpoint) (CORE_ADDR, int, int, struct expression *);
466 int (*to_insert_mask_watchpoint) (struct target_ops *,
467 CORE_ADDR, CORE_ADDR, int);
468 int (*to_remove_mask_watchpoint) (struct target_ops *,
469 CORE_ADDR, CORE_ADDR, int);
470 int (*to_stopped_by_watchpoint) (void);
471 int to_have_steppable_watchpoint;
472 int to_have_continuable_watchpoint;
473 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
474 int (*to_watchpoint_addr_within_range) (struct target_ops *,
475 CORE_ADDR, CORE_ADDR, int);
477 /* Documentation of this routine is provided with the corresponding
479 int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
481 int (*to_can_accel_watchpoint_condition) (CORE_ADDR, int, int,
482 struct expression *);
483 int (*to_masked_watch_num_registers) (struct target_ops *,
484 CORE_ADDR, CORE_ADDR);
485 void (*to_terminal_init) (void);
486 void (*to_terminal_inferior) (void);
487 void (*to_terminal_ours_for_output) (void);
488 void (*to_terminal_ours) (void);
489 void (*to_terminal_save_ours) (void);
490 void (*to_terminal_info) (char *, int);
491 void (*to_kill) (struct target_ops *);
492 void (*to_load) (char *, int);
493 void (*to_create_inferior) (struct target_ops *,
494 char *, char *, char **, int);
495 void (*to_post_startup_inferior) (ptid_t);
496 int (*to_insert_fork_catchpoint) (int);
497 int (*to_remove_fork_catchpoint) (int);
498 int (*to_insert_vfork_catchpoint) (int);
499 int (*to_remove_vfork_catchpoint) (int);
500 int (*to_follow_fork) (struct target_ops *, int);
501 int (*to_insert_exec_catchpoint) (int);
502 int (*to_remove_exec_catchpoint) (int);
503 int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
504 int (*to_has_exited) (int, int, int *);
505 void (*to_mourn_inferior) (struct target_ops *);
506 int (*to_can_run) (void);
508 /* Documentation of this routine is provided with the corresponding
510 void (*to_pass_signals) (int, unsigned char *);
512 int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
513 void (*to_find_new_threads) (struct target_ops *);
514 char *(*to_pid_to_str) (struct target_ops *, ptid_t);
515 char *(*to_extra_thread_info) (struct thread_info *);
516 char *(*to_thread_name) (struct thread_info *);
517 void (*to_stop) (ptid_t);
518 void (*to_rcmd) (char *command, struct ui_file *output);
519 char *(*to_pid_to_exec_file) (int pid);
520 void (*to_log_command) (const char *);
521 struct target_section_table *(*to_get_section_table) (struct target_ops *);
522 enum strata to_stratum;
523 int (*to_has_all_memory) (struct target_ops *);
524 int (*to_has_memory) (struct target_ops *);
525 int (*to_has_stack) (struct target_ops *);
526 int (*to_has_registers) (struct target_ops *);
527 int (*to_has_execution) (struct target_ops *, ptid_t);
528 int to_has_thread_control; /* control thread execution */
529 int to_attach_no_wait;
530 /* ASYNC target controls */
531 int (*to_can_async_p) (void);
532 int (*to_is_async_p) (void);
533 void (*to_async) (void (*) (enum inferior_event_type, void *), void *);
534 int (*to_supports_non_stop) (void);
535 /* find_memory_regions support method for gcore */
536 int (*to_find_memory_regions) (find_memory_region_ftype func, void *data);
537 /* make_corefile_notes support method for gcore */
538 char * (*to_make_corefile_notes) (bfd *, int *);
539 /* get_bookmark support method for bookmarks */
540 gdb_byte * (*to_get_bookmark) (char *, int);
541 /* goto_bookmark support method for bookmarks */
542 void (*to_goto_bookmark) (gdb_byte *, int);
543 /* Return the thread-local address at OFFSET in the
544 thread-local storage for the thread PTID and the shared library
545 or executable file given by OBJFILE. If that block of
546 thread-local storage hasn't been allocated yet, this function
547 may return an error. */
548 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
550 CORE_ADDR load_module_addr,
553 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
554 OBJECT. The OFFSET, for a seekable object, specifies the
555 starting point. The ANNEX can be used to provide additional
556 data-specific information to the target.
558 Return the number of bytes actually transfered, zero when no
559 further transfer is possible, and -1 when the transfer is not
560 supported. Return of a positive value smaller than LEN does
561 not indicate the end of the object, only the end of the
562 transfer; higher level code should continue transferring if
563 desired. This is handled in target.c.
565 The interface does not support a "retry" mechanism. Instead it
566 assumes that at least one byte will be transfered on each
569 NOTE: cagney/2003-10-17: The current interface can lead to
570 fragmented transfers. Lower target levels should not implement
571 hacks, such as enlarging the transfer, in an attempt to
572 compensate for this. Instead, the target stack should be
573 extended so that it implements supply/collect methods and a
574 look-aside object cache. With that available, the lowest
575 target can safely and freely "push" data up the stack.
577 See target_read and target_write for more information. One,
578 and only one, of readbuf or writebuf must be non-NULL. */
580 LONGEST (*to_xfer_partial) (struct target_ops *ops,
581 enum target_object object, const char *annex,
582 gdb_byte *readbuf, const gdb_byte *writebuf,
583 ULONGEST offset, LONGEST len);
585 /* Returns the memory map for the target. A return value of NULL
586 means that no memory map is available. If a memory address
587 does not fall within any returned regions, it's assumed to be
588 RAM. The returned memory regions should not overlap.
590 The order of regions does not matter; target_memory_map will
591 sort regions by starting address. For that reason, this
592 function should not be called directly except via
595 This method should not cache data; if the memory map could
596 change unexpectedly, it should be invalidated, and higher
597 layers will re-fetch it. */
598 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
600 /* Erases the region of flash memory starting at ADDRESS, of
603 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
604 on flash block boundaries, as reported by 'to_memory_map'. */
605 void (*to_flash_erase) (struct target_ops *,
606 ULONGEST address, LONGEST length);
608 /* Finishes a flash memory write sequence. After this operation
609 all flash memory should be available for writing and the result
610 of reading from areas written by 'to_flash_write' should be
611 equal to what was written. */
612 void (*to_flash_done) (struct target_ops *);
614 /* Describe the architecture-specific features of this target.
615 Returns the description found, or NULL if no description
617 const struct target_desc *(*to_read_description) (struct target_ops *ops);
619 /* Build the PTID of the thread on which a given task is running,
620 based on LWP and THREAD. These values are extracted from the
621 task Private_Data section of the Ada Task Control Block, and
622 their interpretation depends on the target. */
623 ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
625 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
626 Return 0 if *READPTR is already at the end of the buffer.
627 Return -1 if there is insufficient buffer for a whole entry.
628 Return 1 if an entry was read into *TYPEP and *VALP. */
629 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
630 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
632 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
633 sequence of bytes in PATTERN with length PATTERN_LEN.
635 The result is 1 if found, 0 if not found, and -1 if there was an error
636 requiring halting of the search (e.g. memory read error).
637 If the pattern is found the address is recorded in FOUND_ADDRP. */
638 int (*to_search_memory) (struct target_ops *ops,
639 CORE_ADDR start_addr, ULONGEST search_space_len,
640 const gdb_byte *pattern, ULONGEST pattern_len,
641 CORE_ADDR *found_addrp);
643 /* Can target execute in reverse? */
644 int (*to_can_execute_reverse) (void);
646 /* The direction the target is currently executing. Must be
647 implemented on targets that support reverse execution and async
648 mode. The default simply returns forward execution. */
649 enum exec_direction_kind (*to_execution_direction) (void);
651 /* Does this target support debugging multiple processes
653 int (*to_supports_multi_process) (void);
655 /* Does this target support enabling and disabling tracepoints while a trace
656 experiment is running? */
657 int (*to_supports_enable_disable_tracepoint) (void);
659 /* Does this target support disabling address space randomization? */
660 int (*to_supports_disable_randomization) (void);
662 /* Does this target support the tracenz bytecode for string collection? */
663 int (*to_supports_string_tracing) (void);
665 /* Determine current architecture of thread PTID.
667 The target is supposed to determine the architecture of the code where
668 the target is currently stopped at (on Cell, if a target is in spu_run,
669 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
670 This is architecture used to perform decr_pc_after_break adjustment,
671 and also determines the frame architecture of the innermost frame.
672 ptrace operations need to operate according to target_gdbarch.
674 The default implementation always returns target_gdbarch. */
675 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
677 /* Determine current address space of thread PTID.
679 The default implementation always returns the inferior's
681 struct address_space *(*to_thread_address_space) (struct target_ops *,
684 /* Tracepoint-related operations. */
686 /* Prepare the target for a tracing run. */
687 void (*to_trace_init) (void);
689 /* Send full details of a tracepoint location to the target. */
690 void (*to_download_tracepoint) (struct bp_location *location);
692 /* Send full details of a trace state variable to the target. */
693 void (*to_download_trace_state_variable) (struct trace_state_variable *tsv);
695 /* Enable a tracepoint on the target. */
696 void (*to_enable_tracepoint) (struct bp_location *location);
698 /* Disable a tracepoint on the target. */
699 void (*to_disable_tracepoint) (struct bp_location *location);
701 /* Inform the target info of memory regions that are readonly
702 (such as text sections), and so it should return data from
703 those rather than look in the trace buffer. */
704 void (*to_trace_set_readonly_regions) (void);
706 /* Start a trace run. */
707 void (*to_trace_start) (void);
709 /* Get the current status of a tracing run. */
710 int (*to_get_trace_status) (struct trace_status *ts);
712 /* Stop a trace run. */
713 void (*to_trace_stop) (void);
715 /* Ask the target to find a trace frame of the given type TYPE,
716 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
717 number of the trace frame, and also the tracepoint number at
718 TPP. If no trace frame matches, return -1. May throw if the
720 int (*to_trace_find) (enum trace_find_type type, int num,
721 ULONGEST addr1, ULONGEST addr2, int *tpp);
723 /* Get the value of the trace state variable number TSV, returning
724 1 if the value is known and writing the value itself into the
725 location pointed to by VAL, else returning 0. */
726 int (*to_get_trace_state_variable_value) (int tsv, LONGEST *val);
728 int (*to_save_trace_data) (const char *filename);
730 int (*to_upload_tracepoints) (struct uploaded_tp **utpp);
732 int (*to_upload_trace_state_variables) (struct uploaded_tsv **utsvp);
734 LONGEST (*to_get_raw_trace_data) (gdb_byte *buf,
735 ULONGEST offset, LONGEST len);
737 /* Set the target's tracing behavior in response to unexpected
738 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
739 void (*to_set_disconnected_tracing) (int val);
740 void (*to_set_circular_trace_buffer) (int val);
742 /* Return the processor core that thread PTID was last seen on.
743 This information is updated only when:
744 - update_thread_list is called
746 If the core cannot be determined -- either for the specified
747 thread, or right now, or in this debug session, or for this
748 target -- return -1. */
749 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
751 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
752 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
753 a match, 0 if there's a mismatch, and -1 if an error is
754 encountered while reading memory. */
755 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
756 CORE_ADDR memaddr, ULONGEST size);
758 /* Return the address of the start of the Thread Information Block
759 a Windows OS specific feature. */
760 int (*to_get_tib_address) (ptid_t ptid, CORE_ADDR *addr);
762 /* Send the new settings of write permission variables. */
763 void (*to_set_permissions) (void);
765 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
766 with its details. Return 1 on success, 0 on failure. */
767 int (*to_static_tracepoint_marker_at) (CORE_ADDR,
768 struct static_tracepoint_marker *marker);
770 /* Return a vector of all tracepoints markers string id ID, or all
771 markers if ID is NULL. */
772 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid)
775 /* Return a traceframe info object describing the current
776 traceframe's contents. This method should not cache data;
777 higher layers take care of caching, invalidating, and
778 re-fetching when necessary. */
779 struct traceframe_info *(*to_traceframe_info) (void);
782 /* Need sub-structure for target machine related rather than comm related?
786 /* Magic number for checking ops size. If a struct doesn't end with this
787 number, somebody changed the declaration but didn't change all the
788 places that initialize one. */
790 #define OPS_MAGIC 3840
792 /* The ops structure for our "current" target process. This should
793 never be NULL. If there is no target, it points to the dummy_target. */
795 extern struct target_ops current_target;
797 /* Define easy words for doing these operations on our current target. */
799 #define target_shortname (current_target.to_shortname)
800 #define target_longname (current_target.to_longname)
802 /* Does whatever cleanup is required for a target that we are no
803 longer going to be calling. QUITTING indicates that GDB is exiting
804 and should not get hung on an error (otherwise it is important to
805 perform clean termination, even if it takes a while). This routine
806 is automatically always called when popping the target off the
807 target stack (to_beneath is undefined). Closing file descriptors
808 and freeing all memory allocated memory are typical things it
811 void target_close (struct target_ops *targ, int quitting);
813 /* Attaches to a process on the target side. Arguments are as passed
814 to the `attach' command by the user. This routine can be called
815 when the target is not on the target-stack, if the target_can_run
816 routine returns 1; in that case, it must push itself onto the stack.
817 Upon exit, the target should be ready for normal operations, and
818 should be ready to deliver the status of the process immediately
819 (without waiting) to an upcoming target_wait call. */
821 void target_attach (char *, int);
823 /* Some targets don't generate traps when attaching to the inferior,
824 or their target_attach implementation takes care of the waiting.
825 These targets must set to_attach_no_wait. */
827 #define target_attach_no_wait \
828 (current_target.to_attach_no_wait)
830 /* The target_attach operation places a process under debugger control,
831 and stops the process.
833 This operation provides a target-specific hook that allows the
834 necessary bookkeeping to be performed after an attach completes. */
835 #define target_post_attach(pid) \
836 (*current_target.to_post_attach) (pid)
838 /* Takes a program previously attached to and detaches it.
839 The program may resume execution (some targets do, some don't) and will
840 no longer stop on signals, etc. We better not have left any breakpoints
841 in the program or it'll die when it hits one. ARGS is arguments
842 typed by the user (e.g. a signal to send the process). FROM_TTY
843 says whether to be verbose or not. */
845 extern void target_detach (char *, int);
847 /* Disconnect from the current target without resuming it (leaving it
848 waiting for a debugger). */
850 extern void target_disconnect (char *, int);
852 /* Resume execution of the target process PTID. STEP says whether to
853 single-step or to run free; SIGGNAL is the signal to be given to
854 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
855 pass TARGET_SIGNAL_DEFAULT. */
857 extern void target_resume (ptid_t ptid, int step, enum target_signal signal);
859 /* Wait for process pid to do something. PTID = -1 to wait for any
860 pid to do something. Return pid of child, or -1 in case of error;
861 store status through argument pointer STATUS. Note that it is
862 _NOT_ OK to throw_exception() out of target_wait() without popping
863 the debugging target from the stack; GDB isn't prepared to get back
864 to the prompt with a debugging target but without the frame cache,
865 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
868 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
871 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
873 extern void target_fetch_registers (struct regcache *regcache, int regno);
875 /* Store at least register REGNO, or all regs if REGNO == -1.
876 It can store as many registers as it wants to, so target_prepare_to_store
877 must have been previously called. Calls error() if there are problems. */
879 extern void target_store_registers (struct regcache *regcache, int regs);
881 /* Get ready to modify the registers array. On machines which store
882 individual registers, this doesn't need to do anything. On machines
883 which store all the registers in one fell swoop, this makes sure
884 that REGISTERS contains all the registers from the program being
887 #define target_prepare_to_store(regcache) \
888 (*current_target.to_prepare_to_store) (regcache)
890 /* Determine current address space of thread PTID. */
892 struct address_space *target_thread_address_space (ptid_t);
894 /* Returns true if this target can debug multiple processes
897 #define target_supports_multi_process() \
898 (*current_target.to_supports_multi_process) ()
900 /* Returns true if this target can disable address space randomization. */
902 int target_supports_disable_randomization (void);
904 /* Returns true if this target can enable and disable tracepoints
905 while a trace experiment is running. */
907 #define target_supports_enable_disable_tracepoint() \
908 (*current_target.to_supports_enable_disable_tracepoint) ()
910 #define target_supports_string_tracing() \
911 (*current_target.to_supports_string_tracing) ()
913 /* Invalidate all target dcaches. */
914 extern void target_dcache_invalidate (void);
916 extern int target_read_string (CORE_ADDR, char **, int, int *);
918 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
920 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
922 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
925 /* Fetches the target's memory map. If one is found it is sorted
926 and returned, after some consistency checking. Otherwise, NULL
928 VEC(mem_region_s) *target_memory_map (void);
930 /* Erase the specified flash region. */
931 void target_flash_erase (ULONGEST address, LONGEST length);
933 /* Finish a sequence of flash operations. */
934 void target_flash_done (void);
936 /* Describes a request for a memory write operation. */
937 struct memory_write_request
939 /* Begining address that must be written. */
941 /* Past-the-end address. */
943 /* The data to write. */
945 /* A callback baton for progress reporting for this request. */
948 typedef struct memory_write_request memory_write_request_s;
949 DEF_VEC_O(memory_write_request_s);
951 /* Enumeration specifying different flash preservation behaviour. */
952 enum flash_preserve_mode
958 /* Write several memory blocks at once. This version can be more
959 efficient than making several calls to target_write_memory, in
960 particular because it can optimize accesses to flash memory.
962 Moreover, this is currently the only memory access function in gdb
963 that supports writing to flash memory, and it should be used for
964 all cases where access to flash memory is desirable.
966 REQUESTS is the vector (see vec.h) of memory_write_request.
967 PRESERVE_FLASH_P indicates what to do with blocks which must be
968 erased, but not completely rewritten.
969 PROGRESS_CB is a function that will be periodically called to provide
970 feedback to user. It will be called with the baton corresponding
971 to the request currently being written. It may also be called
972 with a NULL baton, when preserved flash sectors are being rewritten.
974 The function returns 0 on success, and error otherwise. */
975 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
976 enum flash_preserve_mode preserve_flash_p,
977 void (*progress_cb) (ULONGEST, void *));
981 extern int inferior_has_forked (ptid_t pid, ptid_t *child_pid);
983 extern int inferior_has_vforked (ptid_t pid, ptid_t *child_pid);
985 extern int inferior_has_execd (ptid_t pid, char **execd_pathname);
987 extern int inferior_has_called_syscall (ptid_t pid, int *syscall_number);
989 /* Print a line about the current target. */
991 #define target_files_info() \
992 (*current_target.to_files_info) (¤t_target)
994 /* Insert a breakpoint at address BP_TGT->placed_address in the target
995 machine. Result is 0 for success, or an errno value. */
997 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
998 struct bp_target_info *bp_tgt);
1000 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1001 machine. Result is 0 for success, or an errno value. */
1003 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1004 struct bp_target_info *bp_tgt);
1006 /* Initialize the terminal settings we record for the inferior,
1007 before we actually run the inferior. */
1009 #define target_terminal_init() \
1010 (*current_target.to_terminal_init) ()
1012 /* Put the inferior's terminal settings into effect.
1013 This is preparation for starting or resuming the inferior. */
1015 extern void target_terminal_inferior (void);
1017 /* Put some of our terminal settings into effect,
1018 enough to get proper results from our output,
1019 but do not change into or out of RAW mode
1020 so that no input is discarded.
1022 After doing this, either terminal_ours or terminal_inferior
1023 should be called to get back to a normal state of affairs. */
1025 #define target_terminal_ours_for_output() \
1026 (*current_target.to_terminal_ours_for_output) ()
1028 /* Put our terminal settings into effect.
1029 First record the inferior's terminal settings
1030 so they can be restored properly later. */
1032 #define target_terminal_ours() \
1033 (*current_target.to_terminal_ours) ()
1035 /* Save our terminal settings.
1036 This is called from TUI after entering or leaving the curses
1037 mode. Since curses modifies our terminal this call is here
1038 to take this change into account. */
1040 #define target_terminal_save_ours() \
1041 (*current_target.to_terminal_save_ours) ()
1043 /* Print useful information about our terminal status, if such a thing
1046 #define target_terminal_info(arg, from_tty) \
1047 (*current_target.to_terminal_info) (arg, from_tty)
1049 /* Kill the inferior process. Make it go away. */
1051 extern void target_kill (void);
1053 /* Load an executable file into the target process. This is expected
1054 to not only bring new code into the target process, but also to
1055 update GDB's symbol tables to match.
1057 ARG contains command-line arguments, to be broken down with
1058 buildargv (). The first non-switch argument is the filename to
1059 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1060 0)), which is an offset to apply to the load addresses of FILE's
1061 sections. The target may define switches, or other non-switch
1062 arguments, as it pleases. */
1064 extern void target_load (char *arg, int from_tty);
1066 /* Start an inferior process and set inferior_ptid to its pid.
1067 EXEC_FILE is the file to run.
1068 ALLARGS is a string containing the arguments to the program.
1069 ENV is the environment vector to pass. Errors reported with error().
1070 On VxWorks and various standalone systems, we ignore exec_file. */
1072 void target_create_inferior (char *exec_file, char *args,
1073 char **env, int from_tty);
1075 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1076 notification of inferior events such as fork and vork immediately
1077 after the inferior is created. (This because of how gdb gets an
1078 inferior created via invoking a shell to do it. In such a scenario,
1079 if the shell init file has commands in it, the shell will fork and
1080 exec for each of those commands, and we will see each such fork
1083 Such targets will supply an appropriate definition for this function. */
1085 #define target_post_startup_inferior(ptid) \
1086 (*current_target.to_post_startup_inferior) (ptid)
1088 /* On some targets, we can catch an inferior fork or vfork event when
1089 it occurs. These functions insert/remove an already-created
1090 catchpoint for such events. They return 0 for success, 1 if the
1091 catchpoint type is not supported and -1 for failure. */
1093 #define target_insert_fork_catchpoint(pid) \
1094 (*current_target.to_insert_fork_catchpoint) (pid)
1096 #define target_remove_fork_catchpoint(pid) \
1097 (*current_target.to_remove_fork_catchpoint) (pid)
1099 #define target_insert_vfork_catchpoint(pid) \
1100 (*current_target.to_insert_vfork_catchpoint) (pid)
1102 #define target_remove_vfork_catchpoint(pid) \
1103 (*current_target.to_remove_vfork_catchpoint) (pid)
1105 /* If the inferior forks or vforks, this function will be called at
1106 the next resume in order to perform any bookkeeping and fiddling
1107 necessary to continue debugging either the parent or child, as
1108 requested, and releasing the other. Information about the fork
1109 or vfork event is available via get_last_target_status ().
1110 This function returns 1 if the inferior should not be resumed
1111 (i.e. there is another event pending). */
1113 int target_follow_fork (int follow_child);
1115 /* On some targets, we can catch an inferior exec event when it
1116 occurs. These functions insert/remove an already-created
1117 catchpoint for such events. They return 0 for success, 1 if the
1118 catchpoint type is not supported and -1 for failure. */
1120 #define target_insert_exec_catchpoint(pid) \
1121 (*current_target.to_insert_exec_catchpoint) (pid)
1123 #define target_remove_exec_catchpoint(pid) \
1124 (*current_target.to_remove_exec_catchpoint) (pid)
1128 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1129 If NEEDED is zero, it means the target can disable the mechanism to
1130 catch system calls because there are no more catchpoints of this type.
1132 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1133 being requested. In this case, both TABLE_SIZE and TABLE should
1136 TABLE_SIZE is the number of elements in TABLE. It only matters if
1139 TABLE is an array of ints, indexed by syscall number. An element in
1140 this array is nonzero if that syscall should be caught. This argument
1141 only matters if ANY_COUNT is zero.
1143 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1146 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1147 (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
1150 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1151 exit code of PID, if any. */
1153 #define target_has_exited(pid,wait_status,exit_status) \
1154 (*current_target.to_has_exited) (pid,wait_status,exit_status)
1156 /* The debugger has completed a blocking wait() call. There is now
1157 some process event that must be processed. This function should
1158 be defined by those targets that require the debugger to perform
1159 cleanup or internal state changes in response to the process event. */
1161 /* The inferior process has died. Do what is right. */
1163 void target_mourn_inferior (void);
1165 /* Does target have enough data to do a run or attach command? */
1167 #define target_can_run(t) \
1168 ((t)->to_can_run) ()
1170 /* Set list of signals to be handled in the target.
1172 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1173 (enum target_signal). For every signal whose entry in this array is
1174 non-zero, the target is allowed -but not required- to skip reporting
1175 arrival of the signal to the GDB core by returning from target_wait,
1176 and to pass the signal directly to the inferior instead.
1178 However, if the target is hardware single-stepping a thread that is
1179 about to receive a signal, it needs to be reported in any case, even
1180 if mentioned in a previous target_pass_signals call. */
1182 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1184 /* Check to see if a thread is still alive. */
1186 extern int target_thread_alive (ptid_t ptid);
1188 /* Query for new threads and add them to the thread list. */
1190 extern void target_find_new_threads (void);
1192 /* Make target stop in a continuable fashion. (For instance, under
1193 Unix, this should act like SIGSTOP). This function is normally
1194 used by GUIs to implement a stop button. */
1196 extern void target_stop (ptid_t ptid);
1198 /* Send the specified COMMAND to the target's monitor
1199 (shell,interpreter) for execution. The result of the query is
1200 placed in OUTBUF. */
1202 #define target_rcmd(command, outbuf) \
1203 (*current_target.to_rcmd) (command, outbuf)
1206 /* Does the target include all of memory, or only part of it? This
1207 determines whether we look up the target chain for other parts of
1208 memory if this target can't satisfy a request. */
1210 extern int target_has_all_memory_1 (void);
1211 #define target_has_all_memory target_has_all_memory_1 ()
1213 /* Does the target include memory? (Dummy targets don't.) */
1215 extern int target_has_memory_1 (void);
1216 #define target_has_memory target_has_memory_1 ()
1218 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1219 we start a process.) */
1221 extern int target_has_stack_1 (void);
1222 #define target_has_stack target_has_stack_1 ()
1224 /* Does the target have registers? (Exec files don't.) */
1226 extern int target_has_registers_1 (void);
1227 #define target_has_registers target_has_registers_1 ()
1229 /* Does the target have execution? Can we make it jump (through
1230 hoops), or pop its stack a few times? This means that the current
1231 target is currently executing; for some targets, that's the same as
1232 whether or not the target is capable of execution, but there are
1233 also targets which can be current while not executing. In that
1234 case this will become true after target_create_inferior or
1237 extern int target_has_execution_1 (ptid_t);
1239 /* Like target_has_execution_1, but always passes inferior_ptid. */
1241 extern int target_has_execution_current (void);
1243 #define target_has_execution target_has_execution_current ()
1245 /* Default implementations for process_stratum targets. Return true
1246 if there's a selected inferior, false otherwise. */
1248 extern int default_child_has_all_memory (struct target_ops *ops);
1249 extern int default_child_has_memory (struct target_ops *ops);
1250 extern int default_child_has_stack (struct target_ops *ops);
1251 extern int default_child_has_registers (struct target_ops *ops);
1252 extern int default_child_has_execution (struct target_ops *ops,
1255 /* Can the target support the debugger control of thread execution?
1256 Can it lock the thread scheduler? */
1258 #define target_can_lock_scheduler \
1259 (current_target.to_has_thread_control & tc_schedlock)
1261 /* Should the target enable async mode if it is supported? Temporary
1262 cludge until async mode is a strict superset of sync mode. */
1263 extern int target_async_permitted;
1265 /* Can the target support asynchronous execution? */
1266 #define target_can_async_p() (current_target.to_can_async_p ())
1268 /* Is the target in asynchronous execution mode? */
1269 #define target_is_async_p() (current_target.to_is_async_p ())
1271 int target_supports_non_stop (void);
1273 /* Put the target in async mode with the specified callback function. */
1274 #define target_async(CALLBACK,CONTEXT) \
1275 (current_target.to_async ((CALLBACK), (CONTEXT)))
1277 #define target_execution_direction() \
1278 (current_target.to_execution_direction ())
1280 /* Converts a process id to a string. Usually, the string just contains
1281 `process xyz', but on some systems it may contain
1282 `process xyz thread abc'. */
1284 extern char *target_pid_to_str (ptid_t ptid);
1286 extern char *normal_pid_to_str (ptid_t ptid);
1288 /* Return a short string describing extra information about PID,
1289 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1292 #define target_extra_thread_info(TP) \
1293 (current_target.to_extra_thread_info (TP))
1295 /* Return the thread's name. A NULL result means that the target
1296 could not determine this thread's name. */
1298 extern char *target_thread_name (struct thread_info *);
1300 /* Attempts to find the pathname of the executable file
1301 that was run to create a specified process.
1303 The process PID must be stopped when this operation is used.
1305 If the executable file cannot be determined, NULL is returned.
1307 Else, a pointer to a character string containing the pathname
1308 is returned. This string should be copied into a buffer by
1309 the client if the string will not be immediately used, or if
1312 #define target_pid_to_exec_file(pid) \
1313 (current_target.to_pid_to_exec_file) (pid)
1315 /* See the to_thread_architecture description in struct target_ops. */
1317 #define target_thread_architecture(ptid) \
1318 (current_target.to_thread_architecture (¤t_target, ptid))
1321 * Iterator function for target memory regions.
1322 * Calls a callback function once for each memory region 'mapped'
1323 * in the child process. Defined as a simple macro rather than
1324 * as a function macro so that it can be tested for nullity.
1327 #define target_find_memory_regions(FUNC, DATA) \
1328 (current_target.to_find_memory_regions) (FUNC, DATA)
1331 * Compose corefile .note section.
1334 #define target_make_corefile_notes(BFD, SIZE_P) \
1335 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1337 /* Bookmark interfaces. */
1338 #define target_get_bookmark(ARGS, FROM_TTY) \
1339 (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1341 #define target_goto_bookmark(ARG, FROM_TTY) \
1342 (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1344 /* Hardware watchpoint interfaces. */
1346 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1347 write). Only the INFERIOR_PTID task is being queried. */
1349 #define target_stopped_by_watchpoint \
1350 (*current_target.to_stopped_by_watchpoint)
1352 /* Non-zero if we have steppable watchpoints */
1354 #define target_have_steppable_watchpoint \
1355 (current_target.to_have_steppable_watchpoint)
1357 /* Non-zero if we have continuable watchpoints */
1359 #define target_have_continuable_watchpoint \
1360 (current_target.to_have_continuable_watchpoint)
1362 /* Provide defaults for hardware watchpoint functions. */
1364 /* If the *_hw_beakpoint functions have not been defined
1365 elsewhere use the definitions in the target vector. */
1367 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1368 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1369 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1370 (including this one?). OTHERTYPE is who knows what... */
1372 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1373 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
1375 /* Returns the number of debug registers needed to watch the given
1376 memory region, or zero if not supported. */
1378 #define target_region_ok_for_hw_watchpoint(addr, len) \
1379 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
1382 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1383 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1384 COND is the expression for its condition, or NULL if there's none.
1385 Returns 0 for success, 1 if the watchpoint type is not supported,
1388 #define target_insert_watchpoint(addr, len, type, cond) \
1389 (*current_target.to_insert_watchpoint) (addr, len, type, cond)
1391 #define target_remove_watchpoint(addr, len, type, cond) \
1392 (*current_target.to_remove_watchpoint) (addr, len, type, cond)
1394 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1395 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1396 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1397 masked watchpoints are not supported, -1 for failure. */
1399 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1401 /* Remove a masked watchpoint at ADDR with the mask MASK.
1402 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1403 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1406 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1408 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1409 (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
1411 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1412 (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
1414 /* Return number of debug registers needed for a ranged breakpoint,
1415 or -1 if ranged breakpoints are not supported. */
1417 extern int target_ranged_break_num_registers (void);
1419 /* Return non-zero if target knows the data address which triggered this
1420 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1421 INFERIOR_PTID task is being queried. */
1422 #define target_stopped_data_address(target, addr_p) \
1423 (*target.to_stopped_data_address) (target, addr_p)
1425 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1426 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1428 /* Return non-zero if the target is capable of using hardware to evaluate
1429 the condition expression. In this case, if the condition is false when
1430 the watched memory location changes, execution may continue without the
1431 debugger being notified.
1433 Due to limitations in the hardware implementation, it may be capable of
1434 avoiding triggering the watchpoint in some cases where the condition
1435 expression is false, but may report some false positives as well.
1436 For this reason, GDB will still evaluate the condition expression when
1437 the watchpoint triggers. */
1438 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1439 (*current_target.to_can_accel_watchpoint_condition) (addr, len, type, cond)
1441 /* Return number of debug registers needed for a masked watchpoint,
1442 -1 if masked watchpoints are not supported or -2 if the given address
1443 and mask combination cannot be used. */
1445 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1447 /* Target can execute in reverse? */
1448 #define target_can_execute_reverse \
1449 (current_target.to_can_execute_reverse ? \
1450 current_target.to_can_execute_reverse () : 0)
1452 extern const struct target_desc *target_read_description (struct target_ops *);
1454 #define target_get_ada_task_ptid(lwp, tid) \
1455 (*current_target.to_get_ada_task_ptid) (lwp,tid)
1457 /* Utility implementation of searching memory. */
1458 extern int simple_search_memory (struct target_ops* ops,
1459 CORE_ADDR start_addr,
1460 ULONGEST search_space_len,
1461 const gdb_byte *pattern,
1462 ULONGEST pattern_len,
1463 CORE_ADDR *found_addrp);
1465 /* Main entry point for searching memory. */
1466 extern int target_search_memory (CORE_ADDR start_addr,
1467 ULONGEST search_space_len,
1468 const gdb_byte *pattern,
1469 ULONGEST pattern_len,
1470 CORE_ADDR *found_addrp);
1472 /* Tracepoint-related operations. */
1474 #define target_trace_init() \
1475 (*current_target.to_trace_init) ()
1477 #define target_download_tracepoint(t) \
1478 (*current_target.to_download_tracepoint) (t)
1480 #define target_download_trace_state_variable(tsv) \
1481 (*current_target.to_download_trace_state_variable) (tsv)
1483 #define target_enable_tracepoint(loc) \
1484 (*current_target.to_enable_tracepoint) (loc)
1486 #define target_disable_tracepoint(loc) \
1487 (*current_target.to_disable_tracepoint) (loc)
1489 #define target_trace_start() \
1490 (*current_target.to_trace_start) ()
1492 #define target_trace_set_readonly_regions() \
1493 (*current_target.to_trace_set_readonly_regions) ()
1495 #define target_get_trace_status(ts) \
1496 (*current_target.to_get_trace_status) (ts)
1498 #define target_trace_stop() \
1499 (*current_target.to_trace_stop) ()
1501 #define target_trace_find(type,num,addr1,addr2,tpp) \
1502 (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1504 #define target_get_trace_state_variable_value(tsv,val) \
1505 (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1507 #define target_save_trace_data(filename) \
1508 (*current_target.to_save_trace_data) (filename)
1510 #define target_upload_tracepoints(utpp) \
1511 (*current_target.to_upload_tracepoints) (utpp)
1513 #define target_upload_trace_state_variables(utsvp) \
1514 (*current_target.to_upload_trace_state_variables) (utsvp)
1516 #define target_get_raw_trace_data(buf,offset,len) \
1517 (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1519 #define target_set_disconnected_tracing(val) \
1520 (*current_target.to_set_disconnected_tracing) (val)
1522 #define target_set_circular_trace_buffer(val) \
1523 (*current_target.to_set_circular_trace_buffer) (val)
1525 #define target_get_tib_address(ptid, addr) \
1526 (*current_target.to_get_tib_address) ((ptid), (addr))
1528 #define target_set_permissions() \
1529 (*current_target.to_set_permissions) ()
1531 #define target_static_tracepoint_marker_at(addr, marker) \
1532 (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1534 #define target_static_tracepoint_markers_by_strid(marker_id) \
1535 (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1537 #define target_traceframe_info() \
1538 (*current_target.to_traceframe_info) ()
1540 /* Command logging facility. */
1542 #define target_log_command(p) \
1544 if (current_target.to_log_command) \
1545 (*current_target.to_log_command) (p); \
1549 extern int target_core_of_thread (ptid_t ptid);
1551 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1552 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1553 if there's a mismatch, and -1 if an error is encountered while
1554 reading memory. Throws an error if the functionality is found not
1555 to be supported by the current target. */
1556 int target_verify_memory (const gdb_byte *data,
1557 CORE_ADDR memaddr, ULONGEST size);
1559 /* Routines for maintenance of the target structures...
1561 add_target: Add a target to the list of all possible targets.
1563 push_target: Make this target the top of the stack of currently used
1564 targets, within its particular stratum of the stack. Result
1565 is 0 if now atop the stack, nonzero if not on top (maybe
1568 unpush_target: Remove this from the stack of currently used targets,
1569 no matter where it is on the list. Returns 0 if no
1570 change, 1 if removed from stack.
1572 pop_target: Remove the top thing on the stack of current targets. */
1574 extern void add_target (struct target_ops *);
1576 extern void push_target (struct target_ops *);
1578 extern int unpush_target (struct target_ops *);
1580 extern void target_pre_inferior (int);
1582 extern void target_preopen (int);
1584 extern void pop_target (void);
1586 /* Does whatever cleanup is required to get rid of all pushed targets.
1587 QUITTING is propagated to target_close; it indicates that GDB is
1588 exiting and should not get hung on an error (otherwise it is
1589 important to perform clean termination, even if it takes a
1591 extern void pop_all_targets (int quitting);
1593 /* Like pop_all_targets, but pops only targets whose stratum is
1594 strictly above ABOVE_STRATUM. */
1595 extern void pop_all_targets_above (enum strata above_stratum, int quitting);
1597 extern int target_is_pushed (struct target_ops *t);
1599 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1602 /* Struct target_section maps address ranges to file sections. It is
1603 mostly used with BFD files, but can be used without (e.g. for handling
1604 raw disks, or files not in formats handled by BFD). */
1606 struct target_section
1608 CORE_ADDR addr; /* Lowest address in section */
1609 CORE_ADDR endaddr; /* 1+highest address in section */
1611 struct bfd_section *the_bfd_section;
1613 bfd *bfd; /* BFD file pointer */
1616 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1618 struct target_section_table
1620 struct target_section *sections;
1621 struct target_section *sections_end;
1624 /* Return the "section" containing the specified address. */
1625 struct target_section *target_section_by_addr (struct target_ops *target,
1628 /* Return the target section table this target (or the targets
1629 beneath) currently manipulate. */
1631 extern struct target_section_table *target_get_section_table
1632 (struct target_ops *target);
1634 /* From mem-break.c */
1636 extern int memory_remove_breakpoint (struct gdbarch *,
1637 struct bp_target_info *);
1639 extern int memory_insert_breakpoint (struct gdbarch *,
1640 struct bp_target_info *);
1642 extern int default_memory_remove_breakpoint (struct gdbarch *,
1643 struct bp_target_info *);
1645 extern int default_memory_insert_breakpoint (struct gdbarch *,
1646 struct bp_target_info *);
1651 extern void initialize_targets (void);
1653 extern void noprocess (void) ATTRIBUTE_NORETURN;
1655 extern void target_require_runnable (void);
1657 extern void find_default_attach (struct target_ops *, char *, int);
1659 extern void find_default_create_inferior (struct target_ops *,
1660 char *, char *, char **, int);
1662 extern struct target_ops *find_run_target (void);
1664 extern struct target_ops *find_target_beneath (struct target_ops *);
1666 /* Read OS data object of type TYPE from the target, and return it in
1667 XML format. The result is NUL-terminated and returned as a string,
1668 allocated using xmalloc. If an error occurs or the transfer is
1669 unsupported, NULL is returned. Empty objects are returned as
1670 allocated but empty strings. */
1672 extern char *target_get_osdata (const char *type);
1675 /* Stuff that should be shared among the various remote targets. */
1677 /* Debugging level. 0 is off, and non-zero values mean to print some debug
1678 information (higher values, more information). */
1679 extern int remote_debug;
1681 /* Speed in bits per second, or -1 which means don't mess with the speed. */
1682 extern int baud_rate;
1683 /* Timeout limit for response from target. */
1684 extern int remote_timeout;
1687 /* Functions for helping to write a native target. */
1689 /* This is for native targets which use a unix/POSIX-style waitstatus. */
1690 extern void store_waitstatus (struct target_waitstatus *, int);
1692 /* These are in common/signals.c, but they're only used by gdb. */
1693 extern enum target_signal default_target_signal_from_host (struct gdbarch *,
1695 extern int default_target_signal_to_host (struct gdbarch *,
1696 enum target_signal);
1698 /* Convert from a number used in a GDB command to an enum target_signal. */
1699 extern enum target_signal target_signal_from_command (int);
1700 /* End of files in common/signals.c. */
1702 /* Set the show memory breakpoints mode to show, and installs a cleanup
1703 to restore it back to the current value. */
1704 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1706 extern int may_write_registers;
1707 extern int may_write_memory;
1708 extern int may_insert_breakpoints;
1709 extern int may_insert_tracepoints;
1710 extern int may_insert_fast_tracepoints;
1711 extern int may_stop;
1713 extern void update_target_permissions (void);
1716 /* Imported from machine dependent code. */
1718 /* Blank target vector entries are initialized to target_ignore. */
1719 void target_ignore (void);
1721 #endif /* !defined (TARGET_H) */