1 /* Interface between GDB and target environments, including files and processes
3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
5 Contributed by Cygnus Support. Written by John Gilmore.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #if !defined (TARGET_H)
30 struct bp_target_info;
32 struct target_section_table;
33 struct trace_state_variable;
37 struct static_tracepoint_marker;
38 struct traceframe_info;
42 /* This include file defines the interface between the main part
43 of the debugger, and the part which is target-specific, or
44 specific to the communications interface between us and the
47 A TARGET is an interface between the debugger and a particular
48 kind of file or process. Targets can be STACKED in STRATA,
49 so that more than one target can potentially respond to a request.
50 In particular, memory accesses will walk down the stack of targets
51 until they find a target that is interested in handling that particular
52 address. STRATA are artificial boundaries on the stack, within
53 which particular kinds of targets live. Strata exist so that
54 people don't get confused by pushing e.g. a process target and then
55 a file target, and wondering why they can't see the current values
56 of variables any more (the file target is handling them and they
57 never get to the process target). So when you push a file target,
58 it goes into the file stratum, which is always below the process
61 #include "target/resume.h"
62 #include "target/wait.h"
63 #include "target/waitstatus.h"
68 #include "gdb_signals.h"
74 dummy_stratum, /* The lowest of the low */
75 file_stratum, /* Executable files, etc */
76 process_stratum, /* Executing processes or core dump files */
77 thread_stratum, /* Executing threads */
78 record_stratum, /* Support record debugging */
79 arch_stratum /* Architecture overrides */
82 enum thread_control_capabilities
84 tc_none = 0, /* Default: can't control thread execution. */
85 tc_schedlock = 1, /* Can lock the thread scheduler. */
88 /* The structure below stores information about a system call.
89 It is basically used in the "catch syscall" command, and in
90 every function that gives information about a system call.
92 It's also good to mention that its fields represent everything
93 that we currently know about a syscall in GDB. */
96 /* The syscall number. */
99 /* The syscall name. */
103 /* Return a pretty printed form of target_waitstatus.
104 Space for the result is malloc'd, caller must free. */
105 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
107 /* Return a pretty printed form of TARGET_OPTIONS.
108 Space for the result is malloc'd, caller must free. */
109 extern char *target_options_to_string (int target_options);
111 /* Possible types of events that the inferior handler will have to
113 enum inferior_event_type
115 /* Process a normal inferior event which will result in target_wait
118 /* We are called because a timer went off. */
120 /* We are called to do stuff after the inferior stops. */
122 /* We are called to do some stuff after the inferior stops, but we
123 are expected to reenter the proceed() and
124 handle_inferior_event() functions. This is used only in case of
125 'step n' like commands. */
129 /* Target objects which can be transfered using target_read,
130 target_write, et cetera. */
134 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
136 /* SPU target specific transfer. See "spu-tdep.c". */
138 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
139 TARGET_OBJECT_MEMORY,
140 /* Memory, avoiding GDB's data cache and trusting the executable.
141 Target implementations of to_xfer_partial never need to handle
142 this object, and most callers should not use it. */
143 TARGET_OBJECT_RAW_MEMORY,
144 /* Memory known to be part of the target's stack. This is cached even
145 if it is not in a region marked as such, since it is known to be
147 TARGET_OBJECT_STACK_MEMORY,
148 /* Memory known to be part of the target code. This is cached even
149 if it is not in a region marked as such. */
150 TARGET_OBJECT_CODE_MEMORY,
151 /* Kernel Unwind Table. See "ia64-tdep.c". */
152 TARGET_OBJECT_UNWIND_TABLE,
153 /* Transfer auxilliary vector. */
155 /* StackGhost cookie. See "sparc-tdep.c". */
156 TARGET_OBJECT_WCOOKIE,
157 /* Target memory map in XML format. */
158 TARGET_OBJECT_MEMORY_MAP,
159 /* Flash memory. This object can be used to write contents to
160 a previously erased flash memory. Using it without erasing
161 flash can have unexpected results. Addresses are physical
162 address on target, and not relative to flash start. */
164 /* Available target-specific features, e.g. registers and coprocessors.
165 See "target-descriptions.c". ANNEX should never be empty. */
166 TARGET_OBJECT_AVAILABLE_FEATURES,
167 /* Currently loaded libraries, in XML format. */
168 TARGET_OBJECT_LIBRARIES,
169 /* Currently loaded libraries specific for SVR4 systems, in XML format. */
170 TARGET_OBJECT_LIBRARIES_SVR4,
171 /* Currently loaded libraries specific to AIX systems, in XML format. */
172 TARGET_OBJECT_LIBRARIES_AIX,
173 /* Get OS specific data. The ANNEX specifies the type (running
174 processes, etc.). The data being transfered is expected to follow
175 the DTD specified in features/osdata.dtd. */
176 TARGET_OBJECT_OSDATA,
177 /* Extra signal info. Usually the contents of `siginfo_t' on unix
179 TARGET_OBJECT_SIGNAL_INFO,
180 /* The list of threads that are being debugged. */
181 TARGET_OBJECT_THREADS,
182 /* Collected static trace data. */
183 TARGET_OBJECT_STATIC_TRACE_DATA,
184 /* The HP-UX registers (those that can be obtained or modified by using
185 the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests). */
186 TARGET_OBJECT_HPUX_UREGS,
187 /* The HP-UX shared library linkage pointer. ANNEX should be a string
188 image of the code address whose linkage pointer we are looking for.
190 The size of the data transfered is always 8 bytes (the size of an
192 TARGET_OBJECT_HPUX_SOLIB_GOT,
193 /* Traceframe info, in XML format. */
194 TARGET_OBJECT_TRACEFRAME_INFO,
195 /* Load maps for FDPIC systems. */
197 /* Darwin dynamic linker info data. */
198 TARGET_OBJECT_DARWIN_DYLD_INFO,
199 /* OpenVMS Unwind Information Block. */
200 TARGET_OBJECT_OPENVMS_UIB,
201 /* Branch trace data, in XML format. */
203 /* Possible future objects: TARGET_OBJECT_FILE, ... */
206 /* Possible values returned by target_xfer_partial, etc. */
208 enum target_xfer_status
210 /* Some bytes are transferred. */
213 /* No further transfer is possible. */
216 /* Generic I/O error. Note that it's important that this is '-1',
217 as we still have target_xfer-related code returning hardcoded
219 TARGET_XFER_E_IO = -1,
221 /* Transfer failed because the piece of the object requested is
223 TARGET_XFER_E_UNAVAILABLE = -2,
225 /* Keep list in sync with target_xfer_error_to_string. */
228 #define TARGET_XFER_STATUS_ERROR_P(STATUS) ((STATUS) < TARGET_XFER_EOF)
230 /* Return the string form of ERR. */
232 extern const char *target_xfer_status_to_string (enum target_xfer_status err);
234 /* Enumeration of the kinds of traceframe searches that a target may
235 be able to perform. */
246 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
247 DEF_VEC_P(static_tracepoint_marker_p);
249 typedef enum target_xfer_status
250 target_xfer_partial_ftype (struct target_ops *ops,
251 enum target_object object,
254 const gdb_byte *writebuf,
257 ULONGEST *xfered_len);
259 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
260 OBJECT. The OFFSET, for a seekable object, specifies the
261 starting point. The ANNEX can be used to provide additional
262 data-specific information to the target.
264 Return the number of bytes actually transfered, or a negative error
265 code (an 'enum target_xfer_error' value) if the transfer is not
266 supported or otherwise fails. Return of a positive value less than
267 LEN indicates that no further transfer is possible. Unlike the raw
268 to_xfer_partial interface, callers of these functions do not need
269 to retry partial transfers. */
271 extern LONGEST target_read (struct target_ops *ops,
272 enum target_object object,
273 const char *annex, gdb_byte *buf,
274 ULONGEST offset, LONGEST len);
276 struct memory_read_result
278 /* First address that was read. */
280 /* Past-the-end address. */
285 typedef struct memory_read_result memory_read_result_s;
286 DEF_VEC_O(memory_read_result_s);
288 extern void free_memory_read_result_vector (void *);
290 extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
294 extern LONGEST target_write (struct target_ops *ops,
295 enum target_object object,
296 const char *annex, const gdb_byte *buf,
297 ULONGEST offset, LONGEST len);
299 /* Similar to target_write, except that it also calls PROGRESS with
300 the number of bytes written and the opaque BATON after every
301 successful partial write (and before the first write). This is
302 useful for progress reporting and user interaction while writing
303 data. To abort the transfer, the progress callback can throw an
306 LONGEST target_write_with_progress (struct target_ops *ops,
307 enum target_object object,
308 const char *annex, const gdb_byte *buf,
309 ULONGEST offset, LONGEST len,
310 void (*progress) (ULONGEST, void *),
313 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
314 be read using OPS. The return value will be -1 if the transfer
315 fails or is not supported; 0 if the object is empty; or the length
316 of the object otherwise. If a positive value is returned, a
317 sufficiently large buffer will be allocated using xmalloc and
318 returned in *BUF_P containing the contents of the object.
320 This method should be used for objects sufficiently small to store
321 in a single xmalloc'd buffer, when no fixed bound on the object's
322 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
323 through this function. */
325 extern LONGEST target_read_alloc (struct target_ops *ops,
326 enum target_object object,
327 const char *annex, gdb_byte **buf_p);
329 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
330 returned as a string, allocated using xmalloc. If an error occurs
331 or the transfer is unsupported, NULL is returned. Empty objects
332 are returned as allocated but empty strings. A warning is issued
333 if the result contains any embedded NUL bytes. */
335 extern char *target_read_stralloc (struct target_ops *ops,
336 enum target_object object,
339 /* See target_ops->to_xfer_partial. */
340 extern target_xfer_partial_ftype target_xfer_partial;
342 /* Wrappers to target read/write that perform memory transfers. They
343 throw an error if the memory transfer fails.
345 NOTE: cagney/2003-10-23: The naming schema is lifted from
346 "frame.h". The parameter order is lifted from get_frame_memory,
347 which in turn lifted it from read_memory. */
349 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
350 gdb_byte *buf, LONGEST len);
351 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
352 CORE_ADDR addr, int len,
353 enum bfd_endian byte_order);
355 struct thread_info; /* fwd decl for parameter list below: */
357 /* The type of the callback to the to_async method. */
359 typedef void async_callback_ftype (enum inferior_event_type event_type,
362 /* These defines are used to mark target_ops methods. The script
363 make-target-delegates scans these and auto-generates the base
364 method implementations. There are four macros that can be used:
366 1. TARGET_DEFAULT_IGNORE. There is no argument. The base method
367 does nothing. This is only valid if the method return type is
370 2. TARGET_DEFAULT_NORETURN. The argument is a function call, like
371 'tcomplain ()'. The base method simply makes this call, which is
372 assumed not to return.
374 3. TARGET_DEFAULT_RETURN. The argument is a C expression. The
375 base method returns this expression's value.
377 4. TARGET_DEFAULT_FUNC. The argument is the name of a function.
378 make-target-delegates does not generate a base method in this case,
379 but instead uses the argument function as the base method. */
381 #define TARGET_DEFAULT_IGNORE()
382 #define TARGET_DEFAULT_NORETURN(ARG)
383 #define TARGET_DEFAULT_RETURN(ARG)
384 #define TARGET_DEFAULT_FUNC(ARG)
388 struct target_ops *beneath; /* To the target under this one. */
389 char *to_shortname; /* Name this target type */
390 char *to_longname; /* Name for printing */
391 char *to_doc; /* Documentation. Does not include trailing
392 newline, and starts with a one-line descrip-
393 tion (probably similar to to_longname). */
394 /* Per-target scratch pad. */
396 /* The open routine takes the rest of the parameters from the
397 command, and (if successful) pushes a new target onto the
398 stack. Targets should supply this routine, if only to provide
400 void (*to_open) (char *, int);
401 /* Old targets with a static target vector provide "to_close".
402 New re-entrant targets provide "to_xclose" and that is expected
403 to xfree everything (including the "struct target_ops"). */
404 void (*to_xclose) (struct target_ops *targ);
405 void (*to_close) (struct target_ops *);
406 void (*to_attach) (struct target_ops *ops, char *, int);
407 void (*to_post_attach) (struct target_ops *, int);
408 void (*to_detach) (struct target_ops *ops, const char *, int);
409 void (*to_disconnect) (struct target_ops *, char *, int);
410 void (*to_resume) (struct target_ops *, ptid_t, int, enum gdb_signal)
411 TARGET_DEFAULT_NORETURN (noprocess ());
412 ptid_t (*to_wait) (struct target_ops *,
413 ptid_t, struct target_waitstatus *, int)
414 TARGET_DEFAULT_NORETURN (noprocess ());
415 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
416 void (*to_store_registers) (struct target_ops *, struct regcache *, int)
417 TARGET_DEFAULT_NORETURN (noprocess ());
418 void (*to_prepare_to_store) (struct target_ops *, struct regcache *);
420 /* Transfer LEN bytes of memory between GDB address MYADDR and
421 target address MEMADDR. If WRITE, transfer them to the target, else
422 transfer them from the target. TARGET is the target from which we
425 Return value, N, is one of the following:
427 0 means that we can't handle this. If errno has been set, it is the
428 error which prevented us from doing it (FIXME: What about bfd_error?).
430 positive (call it N) means that we have transferred N bytes
431 starting at MEMADDR. We might be able to handle more bytes
432 beyond this length, but no promises.
434 negative (call its absolute value N) means that we cannot
435 transfer right at MEMADDR, but we could transfer at least
436 something at MEMADDR + N.
438 NOTE: cagney/2004-10-01: This has been entirely superseeded by
439 to_xfer_partial and inferior inheritance. */
441 int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
443 struct mem_attrib *attrib,
444 struct target_ops *target);
446 void (*to_files_info) (struct target_ops *);
447 int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
448 struct bp_target_info *)
449 TARGET_DEFAULT_FUNC (memory_insert_breakpoint);
450 int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
451 struct bp_target_info *)
452 TARGET_DEFAULT_FUNC (memory_remove_breakpoint);
453 int (*to_can_use_hw_breakpoint) (struct target_ops *, int, int, int);
454 int (*to_ranged_break_num_registers) (struct target_ops *);
455 int (*to_insert_hw_breakpoint) (struct target_ops *,
456 struct gdbarch *, struct bp_target_info *);
457 int (*to_remove_hw_breakpoint) (struct target_ops *,
458 struct gdbarch *, struct bp_target_info *);
460 /* Documentation of what the two routines below are expected to do is
461 provided with the corresponding target_* macros. */
462 int (*to_remove_watchpoint) (struct target_ops *,
463 CORE_ADDR, int, int, struct expression *);
464 int (*to_insert_watchpoint) (struct target_ops *,
465 CORE_ADDR, int, int, struct expression *);
467 int (*to_insert_mask_watchpoint) (struct target_ops *,
468 CORE_ADDR, CORE_ADDR, int);
469 int (*to_remove_mask_watchpoint) (struct target_ops *,
470 CORE_ADDR, CORE_ADDR, int);
471 int (*to_stopped_by_watchpoint) (struct target_ops *)
472 TARGET_DEFAULT_RETURN (0);
473 int to_have_steppable_watchpoint;
474 int to_have_continuable_watchpoint;
475 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *)
476 TARGET_DEFAULT_RETURN (0);
477 int (*to_watchpoint_addr_within_range) (struct target_ops *,
478 CORE_ADDR, CORE_ADDR, int);
480 /* Documentation of this routine is provided with the corresponding
482 int (*to_region_ok_for_hw_watchpoint) (struct target_ops *,
485 int (*to_can_accel_watchpoint_condition) (struct target_ops *,
487 struct expression *);
488 int (*to_masked_watch_num_registers) (struct target_ops *,
489 CORE_ADDR, CORE_ADDR);
490 void (*to_terminal_init) (struct target_ops *);
491 void (*to_terminal_inferior) (struct target_ops *);
492 void (*to_terminal_ours_for_output) (struct target_ops *);
493 void (*to_terminal_ours) (struct target_ops *);
494 void (*to_terminal_save_ours) (struct target_ops *);
495 void (*to_terminal_info) (struct target_ops *, const char *, int);
496 void (*to_kill) (struct target_ops *);
497 void (*to_load) (struct target_ops *, char *, int);
498 void (*to_create_inferior) (struct target_ops *,
499 char *, char *, char **, int);
500 void (*to_post_startup_inferior) (struct target_ops *, ptid_t);
501 int (*to_insert_fork_catchpoint) (struct target_ops *, int);
502 int (*to_remove_fork_catchpoint) (struct target_ops *, int);
503 int (*to_insert_vfork_catchpoint) (struct target_ops *, int);
504 int (*to_remove_vfork_catchpoint) (struct target_ops *, int);
505 int (*to_follow_fork) (struct target_ops *, int, int);
506 int (*to_insert_exec_catchpoint) (struct target_ops *, int);
507 int (*to_remove_exec_catchpoint) (struct target_ops *, int);
508 int (*to_set_syscall_catchpoint) (struct target_ops *,
509 int, int, int, int, int *);
510 int (*to_has_exited) (struct target_ops *, int, int, int *);
511 void (*to_mourn_inferior) (struct target_ops *);
512 int (*to_can_run) (struct target_ops *);
514 /* Documentation of this routine is provided with the corresponding
516 void (*to_pass_signals) (struct target_ops *, int, unsigned char *);
518 /* Documentation of this routine is provided with the
519 corresponding target_* function. */
520 void (*to_program_signals) (struct target_ops *, int, unsigned char *);
522 int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
523 void (*to_find_new_threads) (struct target_ops *);
524 char *(*to_pid_to_str) (struct target_ops *, ptid_t);
525 char *(*to_extra_thread_info) (struct target_ops *, struct thread_info *);
526 char *(*to_thread_name) (struct target_ops *, struct thread_info *);
527 void (*to_stop) (struct target_ops *, ptid_t);
528 void (*to_rcmd) (struct target_ops *,
529 char *command, struct ui_file *output);
530 char *(*to_pid_to_exec_file) (struct target_ops *, int pid);
531 void (*to_log_command) (struct target_ops *, const char *);
532 struct target_section_table *(*to_get_section_table) (struct target_ops *);
533 enum strata to_stratum;
534 int (*to_has_all_memory) (struct target_ops *);
535 int (*to_has_memory) (struct target_ops *);
536 int (*to_has_stack) (struct target_ops *);
537 int (*to_has_registers) (struct target_ops *);
538 int (*to_has_execution) (struct target_ops *, ptid_t);
539 int to_has_thread_control; /* control thread execution */
540 int to_attach_no_wait;
541 /* ASYNC target controls */
542 int (*to_can_async_p) (struct target_ops *)
543 TARGET_DEFAULT_FUNC (find_default_can_async_p);
544 int (*to_is_async_p) (struct target_ops *)
545 TARGET_DEFAULT_FUNC (find_default_is_async_p);
546 void (*to_async) (struct target_ops *, async_callback_ftype *, void *)
547 TARGET_DEFAULT_NORETURN (tcomplain ());
548 int (*to_supports_non_stop) (struct target_ops *);
549 /* find_memory_regions support method for gcore */
550 int (*to_find_memory_regions) (struct target_ops *,
551 find_memory_region_ftype func, void *data);
552 /* make_corefile_notes support method for gcore */
553 char * (*to_make_corefile_notes) (struct target_ops *, bfd *, int *);
554 /* get_bookmark support method for bookmarks */
555 gdb_byte * (*to_get_bookmark) (struct target_ops *, char *, int);
556 /* goto_bookmark support method for bookmarks */
557 void (*to_goto_bookmark) (struct target_ops *, gdb_byte *, int);
558 /* Return the thread-local address at OFFSET in the
559 thread-local storage for the thread PTID and the shared library
560 or executable file given by OBJFILE. If that block of
561 thread-local storage hasn't been allocated yet, this function
562 may return an error. */
563 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
565 CORE_ADDR load_module_addr,
568 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
569 OBJECT. The OFFSET, for a seekable object, specifies the
570 starting point. The ANNEX can be used to provide additional
571 data-specific information to the target.
573 Return the transferred status, error or OK (an
574 'enum target_xfer_status' value). Save the number of bytes
575 actually transferred in *XFERED_LEN if transfer is successful
576 (TARGET_XFER_OK) or the number unavailable bytes if the requested
577 data is unavailable (TARGET_XFER_E_UNAVAILABLE). *XFERED_LEN
578 smaller than LEN does not indicate the end of the object, only
579 the end of the transfer; higher level code should continue
580 transferring if desired. This is handled in target.c.
582 The interface does not support a "retry" mechanism. Instead it
583 assumes that at least one byte will be transfered on each
586 NOTE: cagney/2003-10-17: The current interface can lead to
587 fragmented transfers. Lower target levels should not implement
588 hacks, such as enlarging the transfer, in an attempt to
589 compensate for this. Instead, the target stack should be
590 extended so that it implements supply/collect methods and a
591 look-aside object cache. With that available, the lowest
592 target can safely and freely "push" data up the stack.
594 See target_read and target_write for more information. One,
595 and only one, of readbuf or writebuf must be non-NULL. */
597 enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
598 enum target_object object,
601 const gdb_byte *writebuf,
602 ULONGEST offset, ULONGEST len,
603 ULONGEST *xfered_len)
604 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
606 /* Returns the memory map for the target. A return value of NULL
607 means that no memory map is available. If a memory address
608 does not fall within any returned regions, it's assumed to be
609 RAM. The returned memory regions should not overlap.
611 The order of regions does not matter; target_memory_map will
612 sort regions by starting address. For that reason, this
613 function should not be called directly except via
616 This method should not cache data; if the memory map could
617 change unexpectedly, it should be invalidated, and higher
618 layers will re-fetch it. */
619 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
621 /* Erases the region of flash memory starting at ADDRESS, of
624 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
625 on flash block boundaries, as reported by 'to_memory_map'. */
626 void (*to_flash_erase) (struct target_ops *,
627 ULONGEST address, LONGEST length);
629 /* Finishes a flash memory write sequence. After this operation
630 all flash memory should be available for writing and the result
631 of reading from areas written by 'to_flash_write' should be
632 equal to what was written. */
633 void (*to_flash_done) (struct target_ops *);
635 /* Describe the architecture-specific features of this target.
636 Returns the description found, or NULL if no description
638 const struct target_desc *(*to_read_description) (struct target_ops *ops);
640 /* Build the PTID of the thread on which a given task is running,
641 based on LWP and THREAD. These values are extracted from the
642 task Private_Data section of the Ada Task Control Block, and
643 their interpretation depends on the target. */
644 ptid_t (*to_get_ada_task_ptid) (struct target_ops *,
645 long lwp, long thread);
647 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
648 Return 0 if *READPTR is already at the end of the buffer.
649 Return -1 if there is insufficient buffer for a whole entry.
650 Return 1 if an entry was read into *TYPEP and *VALP. */
651 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
652 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
654 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
655 sequence of bytes in PATTERN with length PATTERN_LEN.
657 The result is 1 if found, 0 if not found, and -1 if there was an error
658 requiring halting of the search (e.g. memory read error).
659 If the pattern is found the address is recorded in FOUND_ADDRP. */
660 int (*to_search_memory) (struct target_ops *ops,
661 CORE_ADDR start_addr, ULONGEST search_space_len,
662 const gdb_byte *pattern, ULONGEST pattern_len,
663 CORE_ADDR *found_addrp);
665 /* Can target execute in reverse? */
666 int (*to_can_execute_reverse) (struct target_ops *);
668 /* The direction the target is currently executing. Must be
669 implemented on targets that support reverse execution and async
670 mode. The default simply returns forward execution. */
671 enum exec_direction_kind (*to_execution_direction) (struct target_ops *);
673 /* Does this target support debugging multiple processes
675 int (*to_supports_multi_process) (struct target_ops *);
677 /* Does this target support enabling and disabling tracepoints while a trace
678 experiment is running? */
679 int (*to_supports_enable_disable_tracepoint) (struct target_ops *);
681 /* Does this target support disabling address space randomization? */
682 int (*to_supports_disable_randomization) (struct target_ops *);
684 /* Does this target support the tracenz bytecode for string collection? */
685 int (*to_supports_string_tracing) (struct target_ops *);
687 /* Does this target support evaluation of breakpoint conditions on its
689 int (*to_supports_evaluation_of_breakpoint_conditions) (struct target_ops *);
691 /* Does this target support evaluation of breakpoint commands on its
693 int (*to_can_run_breakpoint_commands) (struct target_ops *);
695 /* Determine current architecture of thread PTID.
697 The target is supposed to determine the architecture of the code where
698 the target is currently stopped at (on Cell, if a target is in spu_run,
699 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
700 This is architecture used to perform decr_pc_after_break adjustment,
701 and also determines the frame architecture of the innermost frame.
702 ptrace operations need to operate according to target_gdbarch ().
704 The default implementation always returns target_gdbarch (). */
705 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
707 /* Determine current address space of thread PTID.
709 The default implementation always returns the inferior's
711 struct address_space *(*to_thread_address_space) (struct target_ops *,
714 /* Target file operations. */
716 /* Open FILENAME on the target, using FLAGS and MODE. Return a
717 target file descriptor, or -1 if an error occurs (and set
719 int (*to_fileio_open) (struct target_ops *,
720 const char *filename, int flags, int mode,
723 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
724 Return the number of bytes written, or -1 if an error occurs
725 (and set *TARGET_ERRNO). */
726 int (*to_fileio_pwrite) (struct target_ops *,
727 int fd, const gdb_byte *write_buf, int len,
728 ULONGEST offset, int *target_errno);
730 /* Read up to LEN bytes FD on the target into READ_BUF.
731 Return the number of bytes read, or -1 if an error occurs
732 (and set *TARGET_ERRNO). */
733 int (*to_fileio_pread) (struct target_ops *,
734 int fd, gdb_byte *read_buf, int len,
735 ULONGEST offset, int *target_errno);
737 /* Close FD on the target. Return 0, or -1 if an error occurs
738 (and set *TARGET_ERRNO). */
739 int (*to_fileio_close) (struct target_ops *, int fd, int *target_errno);
741 /* Unlink FILENAME on the target. Return 0, or -1 if an error
742 occurs (and set *TARGET_ERRNO). */
743 int (*to_fileio_unlink) (struct target_ops *,
744 const char *filename, int *target_errno);
746 /* Read value of symbolic link FILENAME on the target. Return a
747 null-terminated string allocated via xmalloc, or NULL if an error
748 occurs (and set *TARGET_ERRNO). */
749 char *(*to_fileio_readlink) (struct target_ops *,
750 const char *filename, int *target_errno);
753 /* Implement the "info proc" command. */
754 void (*to_info_proc) (struct target_ops *, char *, enum info_proc_what);
756 /* Tracepoint-related operations. */
758 /* Prepare the target for a tracing run. */
759 void (*to_trace_init) (struct target_ops *);
761 /* Send full details of a tracepoint location to the target. */
762 void (*to_download_tracepoint) (struct target_ops *,
763 struct bp_location *location);
765 /* Is the target able to download tracepoint locations in current
767 int (*to_can_download_tracepoint) (struct target_ops *);
769 /* Send full details of a trace state variable to the target. */
770 void (*to_download_trace_state_variable) (struct target_ops *,
771 struct trace_state_variable *tsv);
773 /* Enable a tracepoint on the target. */
774 void (*to_enable_tracepoint) (struct target_ops *,
775 struct bp_location *location);
777 /* Disable a tracepoint on the target. */
778 void (*to_disable_tracepoint) (struct bp_location *location);
780 /* Inform the target info of memory regions that are readonly
781 (such as text sections), and so it should return data from
782 those rather than look in the trace buffer. */
783 void (*to_trace_set_readonly_regions) (void);
785 /* Start a trace run. */
786 void (*to_trace_start) (void);
788 /* Get the current status of a tracing run. */
789 int (*to_get_trace_status) (struct trace_status *ts);
791 void (*to_get_tracepoint_status) (struct breakpoint *tp,
792 struct uploaded_tp *utp);
794 /* Stop a trace run. */
795 void (*to_trace_stop) (void);
797 /* Ask the target to find a trace frame of the given type TYPE,
798 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
799 number of the trace frame, and also the tracepoint number at
800 TPP. If no trace frame matches, return -1. May throw if the
802 int (*to_trace_find) (enum trace_find_type type, int num,
803 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp);
805 /* Get the value of the trace state variable number TSV, returning
806 1 if the value is known and writing the value itself into the
807 location pointed to by VAL, else returning 0. */
808 int (*to_get_trace_state_variable_value) (int tsv, LONGEST *val);
810 int (*to_save_trace_data) (const char *filename);
812 int (*to_upload_tracepoints) (struct uploaded_tp **utpp);
814 int (*to_upload_trace_state_variables) (struct uploaded_tsv **utsvp);
816 LONGEST (*to_get_raw_trace_data) (gdb_byte *buf,
817 ULONGEST offset, LONGEST len);
819 /* Get the minimum length of instruction on which a fast tracepoint
820 may be set on the target. If this operation is unsupported,
821 return -1. If for some reason the minimum length cannot be
822 determined, return 0. */
823 int (*to_get_min_fast_tracepoint_insn_len) (void);
825 /* Set the target's tracing behavior in response to unexpected
826 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
827 void (*to_set_disconnected_tracing) (int val);
828 void (*to_set_circular_trace_buffer) (int val);
829 /* Set the size of trace buffer in the target. */
830 void (*to_set_trace_buffer_size) (LONGEST val);
832 /* Add/change textual notes about the trace run, returning 1 if
833 successful, 0 otherwise. */
834 int (*to_set_trace_notes) (const char *user, const char *notes,
835 const char *stopnotes);
837 /* Return the processor core that thread PTID was last seen on.
838 This information is updated only when:
839 - update_thread_list is called
841 If the core cannot be determined -- either for the specified
842 thread, or right now, or in this debug session, or for this
843 target -- return -1. */
844 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
846 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
847 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
848 a match, 0 if there's a mismatch, and -1 if an error is
849 encountered while reading memory. */
850 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
851 CORE_ADDR memaddr, ULONGEST size);
853 /* Return the address of the start of the Thread Information Block
854 a Windows OS specific feature. */
855 int (*to_get_tib_address) (ptid_t ptid, CORE_ADDR *addr);
857 /* Send the new settings of write permission variables. */
858 void (*to_set_permissions) (void);
860 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
861 with its details. Return 1 on success, 0 on failure. */
862 int (*to_static_tracepoint_marker_at) (CORE_ADDR,
863 struct static_tracepoint_marker *marker);
865 /* Return a vector of all tracepoints markers string id ID, or all
866 markers if ID is NULL. */
867 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid)
870 /* Return a traceframe info object describing the current
871 traceframe's contents. If the target doesn't support
872 traceframe info, return NULL. If the current traceframe is not
873 selected (the current traceframe number is -1), the target can
874 choose to return either NULL or an empty traceframe info. If
875 NULL is returned, for example in remote target, GDB will read
876 from the live inferior. If an empty traceframe info is
877 returned, for example in tfile target, which means the
878 traceframe info is available, but the requested memory is not
879 available in it. GDB will try to see if the requested memory
880 is available in the read-only sections. This method should not
881 cache data; higher layers take care of caching, invalidating,
882 and re-fetching when necessary. */
883 struct traceframe_info *(*to_traceframe_info) (void);
885 /* Ask the target to use or not to use agent according to USE. Return 1
886 successful, 0 otherwise. */
887 int (*to_use_agent) (int use);
889 /* Is the target able to use agent in current state? */
890 int (*to_can_use_agent) (void);
892 /* Check whether the target supports branch tracing. */
893 int (*to_supports_btrace) (struct target_ops *)
894 TARGET_DEFAULT_RETURN (0);
896 /* Enable branch tracing for PTID and allocate a branch trace target
897 information struct for reading and for disabling branch trace. */
898 struct btrace_target_info *(*to_enable_btrace) (ptid_t ptid);
900 /* Disable branch tracing and deallocate TINFO. */
901 void (*to_disable_btrace) (struct btrace_target_info *tinfo);
903 /* Disable branch tracing and deallocate TINFO. This function is similar
904 to to_disable_btrace, except that it is called during teardown and is
905 only allowed to perform actions that are safe. A counter-example would
906 be attempting to talk to a remote target. */
907 void (*to_teardown_btrace) (struct btrace_target_info *tinfo);
909 /* Read branch trace data for the thread indicated by BTINFO into DATA.
910 DATA is cleared before new trace is added.
911 The branch trace will start with the most recent block and continue
912 towards older blocks. */
913 enum btrace_error (*to_read_btrace) (VEC (btrace_block_s) **data,
914 struct btrace_target_info *btinfo,
915 enum btrace_read_type type);
917 /* Stop trace recording. */
918 void (*to_stop_recording) (void);
920 /* Print information about the recording. */
921 void (*to_info_record) (void);
923 /* Save the recorded execution trace into a file. */
924 void (*to_save_record) (const char *filename);
926 /* Delete the recorded execution trace from the current position onwards. */
927 void (*to_delete_record) (void);
929 /* Query if the record target is currently replaying. */
930 int (*to_record_is_replaying) (void);
932 /* Go to the begin of the execution trace. */
933 void (*to_goto_record_begin) (void);
935 /* Go to the end of the execution trace. */
936 void (*to_goto_record_end) (void);
938 /* Go to a specific location in the recorded execution trace. */
939 void (*to_goto_record) (ULONGEST insn);
941 /* Disassemble SIZE instructions in the recorded execution trace from
942 the current position.
943 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
944 disassemble SIZE succeeding instructions. */
945 void (*to_insn_history) (int size, int flags);
947 /* Disassemble SIZE instructions in the recorded execution trace around
949 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
950 disassemble SIZE instructions after FROM. */
951 void (*to_insn_history_from) (ULONGEST from, int size, int flags);
953 /* Disassemble a section of the recorded execution trace from instruction
954 BEGIN (inclusive) to instruction END (inclusive). */
955 void (*to_insn_history_range) (ULONGEST begin, ULONGEST end, int flags);
957 /* Print a function trace of the recorded execution trace.
958 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
959 succeeding functions. */
960 void (*to_call_history) (int size, int flags);
962 /* Print a function trace of the recorded execution trace starting
964 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
965 SIZE functions after FROM. */
966 void (*to_call_history_from) (ULONGEST begin, int size, int flags);
968 /* Print a function trace of an execution trace section from function BEGIN
969 (inclusive) to function END (inclusive). */
970 void (*to_call_history_range) (ULONGEST begin, ULONGEST end, int flags);
972 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
974 int (*to_augmented_libraries_svr4_read) (void);
976 /* Those unwinders are tried before any other arch unwinders. Use NULL if
978 const struct frame_unwind *to_get_unwinder;
979 const struct frame_unwind *to_get_tailcall_unwinder;
981 /* Return the number of bytes by which the PC needs to be decremented
982 after executing a breakpoint instruction.
983 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
984 CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
985 struct gdbarch *gdbarch);
988 /* Need sub-structure for target machine related rather than comm related?
992 /* Magic number for checking ops size. If a struct doesn't end with this
993 number, somebody changed the declaration but didn't change all the
994 places that initialize one. */
996 #define OPS_MAGIC 3840
998 /* The ops structure for our "current" target process. This should
999 never be NULL. If there is no target, it points to the dummy_target. */
1001 extern struct target_ops current_target;
1003 /* Define easy words for doing these operations on our current target. */
1005 #define target_shortname (current_target.to_shortname)
1006 #define target_longname (current_target.to_longname)
1008 /* Does whatever cleanup is required for a target that we are no
1009 longer going to be calling. This routine is automatically always
1010 called after popping the target off the target stack - the target's
1011 own methods are no longer available through the target vector.
1012 Closing file descriptors and freeing all memory allocated memory are
1013 typical things it should do. */
1015 void target_close (struct target_ops *targ);
1017 /* Attaches to a process on the target side. Arguments are as passed
1018 to the `attach' command by the user. This routine can be called
1019 when the target is not on the target-stack, if the target_can_run
1020 routine returns 1; in that case, it must push itself onto the stack.
1021 Upon exit, the target should be ready for normal operations, and
1022 should be ready to deliver the status of the process immediately
1023 (without waiting) to an upcoming target_wait call. */
1025 void target_attach (char *, int);
1027 /* Some targets don't generate traps when attaching to the inferior,
1028 or their target_attach implementation takes care of the waiting.
1029 These targets must set to_attach_no_wait. */
1031 #define target_attach_no_wait \
1032 (current_target.to_attach_no_wait)
1034 /* The target_attach operation places a process under debugger control,
1035 and stops the process.
1037 This operation provides a target-specific hook that allows the
1038 necessary bookkeeping to be performed after an attach completes. */
1039 #define target_post_attach(pid) \
1040 (*current_target.to_post_attach) (¤t_target, pid)
1042 /* Takes a program previously attached to and detaches it.
1043 The program may resume execution (some targets do, some don't) and will
1044 no longer stop on signals, etc. We better not have left any breakpoints
1045 in the program or it'll die when it hits one. ARGS is arguments
1046 typed by the user (e.g. a signal to send the process). FROM_TTY
1047 says whether to be verbose or not. */
1049 extern void target_detach (const char *, int);
1051 /* Disconnect from the current target without resuming it (leaving it
1052 waiting for a debugger). */
1054 extern void target_disconnect (char *, int);
1056 /* Resume execution of the target process PTID (or a group of
1057 threads). STEP says whether to single-step or to run free; SIGGNAL
1058 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1059 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1060 PTID means `step/resume only this process id'. A wildcard PTID
1061 (all threads, or all threads of process) means `step/resume
1062 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1063 matches) resume with their 'thread->suspend.stop_signal' signal
1064 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1065 if in "no pass" state. */
1067 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1069 /* Wait for process pid to do something. PTID = -1 to wait for any
1070 pid to do something. Return pid of child, or -1 in case of error;
1071 store status through argument pointer STATUS. Note that it is
1072 _NOT_ OK to throw_exception() out of target_wait() without popping
1073 the debugging target from the stack; GDB isn't prepared to get back
1074 to the prompt with a debugging target but without the frame cache,
1075 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1078 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1081 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1083 extern void target_fetch_registers (struct regcache *regcache, int regno);
1085 /* Store at least register REGNO, or all regs if REGNO == -1.
1086 It can store as many registers as it wants to, so target_prepare_to_store
1087 must have been previously called. Calls error() if there are problems. */
1089 extern void target_store_registers (struct regcache *regcache, int regs);
1091 /* Get ready to modify the registers array. On machines which store
1092 individual registers, this doesn't need to do anything. On machines
1093 which store all the registers in one fell swoop, this makes sure
1094 that REGISTERS contains all the registers from the program being
1097 #define target_prepare_to_store(regcache) \
1098 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1100 /* Determine current address space of thread PTID. */
1102 struct address_space *target_thread_address_space (ptid_t);
1104 /* Implement the "info proc" command. This returns one if the request
1105 was handled, and zero otherwise. It can also throw an exception if
1106 an error was encountered while attempting to handle the
1109 int target_info_proc (char *, enum info_proc_what);
1111 /* Returns true if this target can debug multiple processes
1114 #define target_supports_multi_process() \
1115 (*current_target.to_supports_multi_process) (¤t_target)
1117 /* Returns true if this target can disable address space randomization. */
1119 int target_supports_disable_randomization (void);
1121 /* Returns true if this target can enable and disable tracepoints
1122 while a trace experiment is running. */
1124 #define target_supports_enable_disable_tracepoint() \
1125 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1127 #define target_supports_string_tracing() \
1128 (*current_target.to_supports_string_tracing) (¤t_target)
1130 /* Returns true if this target can handle breakpoint conditions
1133 #define target_supports_evaluation_of_breakpoint_conditions() \
1134 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1136 /* Returns true if this target can handle breakpoint commands
1139 #define target_can_run_breakpoint_commands() \
1140 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1142 extern int target_read_string (CORE_ADDR, char **, int, int *);
1144 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1147 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1150 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1152 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1154 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1157 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1160 /* Fetches the target's memory map. If one is found it is sorted
1161 and returned, after some consistency checking. Otherwise, NULL
1163 VEC(mem_region_s) *target_memory_map (void);
1165 /* Erase the specified flash region. */
1166 void target_flash_erase (ULONGEST address, LONGEST length);
1168 /* Finish a sequence of flash operations. */
1169 void target_flash_done (void);
1171 /* Describes a request for a memory write operation. */
1172 struct memory_write_request
1174 /* Begining address that must be written. */
1176 /* Past-the-end address. */
1178 /* The data to write. */
1180 /* A callback baton for progress reporting for this request. */
1183 typedef struct memory_write_request memory_write_request_s;
1184 DEF_VEC_O(memory_write_request_s);
1186 /* Enumeration specifying different flash preservation behaviour. */
1187 enum flash_preserve_mode
1193 /* Write several memory blocks at once. This version can be more
1194 efficient than making several calls to target_write_memory, in
1195 particular because it can optimize accesses to flash memory.
1197 Moreover, this is currently the only memory access function in gdb
1198 that supports writing to flash memory, and it should be used for
1199 all cases where access to flash memory is desirable.
1201 REQUESTS is the vector (see vec.h) of memory_write_request.
1202 PRESERVE_FLASH_P indicates what to do with blocks which must be
1203 erased, but not completely rewritten.
1204 PROGRESS_CB is a function that will be periodically called to provide
1205 feedback to user. It will be called with the baton corresponding
1206 to the request currently being written. It may also be called
1207 with a NULL baton, when preserved flash sectors are being rewritten.
1209 The function returns 0 on success, and error otherwise. */
1210 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1211 enum flash_preserve_mode preserve_flash_p,
1212 void (*progress_cb) (ULONGEST, void *));
1214 /* Print a line about the current target. */
1216 #define target_files_info() \
1217 (*current_target.to_files_info) (¤t_target)
1219 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1220 the target machine. Returns 0 for success, and returns non-zero or
1221 throws an error (with a detailed failure reason error code and
1222 message) otherwise. */
1224 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1225 struct bp_target_info *bp_tgt);
1227 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1228 machine. Result is 0 for success, non-zero for error. */
1230 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1231 struct bp_target_info *bp_tgt);
1233 /* Initialize the terminal settings we record for the inferior,
1234 before we actually run the inferior. */
1236 #define target_terminal_init() \
1237 (*current_target.to_terminal_init) (¤t_target)
1239 /* Put the inferior's terminal settings into effect.
1240 This is preparation for starting or resuming the inferior. */
1242 extern void target_terminal_inferior (void);
1244 /* Put some of our terminal settings into effect,
1245 enough to get proper results from our output,
1246 but do not change into or out of RAW mode
1247 so that no input is discarded.
1249 After doing this, either terminal_ours or terminal_inferior
1250 should be called to get back to a normal state of affairs. */
1252 #define target_terminal_ours_for_output() \
1253 (*current_target.to_terminal_ours_for_output) (¤t_target)
1255 /* Put our terminal settings into effect.
1256 First record the inferior's terminal settings
1257 so they can be restored properly later. */
1259 #define target_terminal_ours() \
1260 (*current_target.to_terminal_ours) (¤t_target)
1262 /* Save our terminal settings.
1263 This is called from TUI after entering or leaving the curses
1264 mode. Since curses modifies our terminal this call is here
1265 to take this change into account. */
1267 #define target_terminal_save_ours() \
1268 (*current_target.to_terminal_save_ours) (¤t_target)
1270 /* Print useful information about our terminal status, if such a thing
1273 #define target_terminal_info(arg, from_tty) \
1274 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1276 /* Kill the inferior process. Make it go away. */
1278 extern void target_kill (void);
1280 /* Load an executable file into the target process. This is expected
1281 to not only bring new code into the target process, but also to
1282 update GDB's symbol tables to match.
1284 ARG contains command-line arguments, to be broken down with
1285 buildargv (). The first non-switch argument is the filename to
1286 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1287 0)), which is an offset to apply to the load addresses of FILE's
1288 sections. The target may define switches, or other non-switch
1289 arguments, as it pleases. */
1291 extern void target_load (char *arg, int from_tty);
1293 /* Start an inferior process and set inferior_ptid to its pid.
1294 EXEC_FILE is the file to run.
1295 ALLARGS is a string containing the arguments to the program.
1296 ENV is the environment vector to pass. Errors reported with error().
1297 On VxWorks and various standalone systems, we ignore exec_file. */
1299 void target_create_inferior (char *exec_file, char *args,
1300 char **env, int from_tty);
1302 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1303 notification of inferior events such as fork and vork immediately
1304 after the inferior is created. (This because of how gdb gets an
1305 inferior created via invoking a shell to do it. In such a scenario,
1306 if the shell init file has commands in it, the shell will fork and
1307 exec for each of those commands, and we will see each such fork
1310 Such targets will supply an appropriate definition for this function. */
1312 #define target_post_startup_inferior(ptid) \
1313 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1315 /* On some targets, we can catch an inferior fork or vfork event when
1316 it occurs. These functions insert/remove an already-created
1317 catchpoint for such events. They return 0 for success, 1 if the
1318 catchpoint type is not supported and -1 for failure. */
1320 #define target_insert_fork_catchpoint(pid) \
1321 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1323 #define target_remove_fork_catchpoint(pid) \
1324 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1326 #define target_insert_vfork_catchpoint(pid) \
1327 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1329 #define target_remove_vfork_catchpoint(pid) \
1330 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1332 /* If the inferior forks or vforks, this function will be called at
1333 the next resume in order to perform any bookkeeping and fiddling
1334 necessary to continue debugging either the parent or child, as
1335 requested, and releasing the other. Information about the fork
1336 or vfork event is available via get_last_target_status ().
1337 This function returns 1 if the inferior should not be resumed
1338 (i.e. there is another event pending). */
1340 int target_follow_fork (int follow_child, int detach_fork);
1342 /* On some targets, we can catch an inferior exec event when it
1343 occurs. These functions insert/remove an already-created
1344 catchpoint for such events. They return 0 for success, 1 if the
1345 catchpoint type is not supported and -1 for failure. */
1347 #define target_insert_exec_catchpoint(pid) \
1348 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1350 #define target_remove_exec_catchpoint(pid) \
1351 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1355 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1356 If NEEDED is zero, it means the target can disable the mechanism to
1357 catch system calls because there are no more catchpoints of this type.
1359 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1360 being requested. In this case, both TABLE_SIZE and TABLE should
1363 TABLE_SIZE is the number of elements in TABLE. It only matters if
1366 TABLE is an array of ints, indexed by syscall number. An element in
1367 this array is nonzero if that syscall should be caught. This argument
1368 only matters if ANY_COUNT is zero.
1370 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1373 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1374 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1375 pid, needed, any_count, \
1378 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1379 exit code of PID, if any. */
1381 #define target_has_exited(pid,wait_status,exit_status) \
1382 (*current_target.to_has_exited) (¤t_target, \
1383 pid,wait_status,exit_status)
1385 /* The debugger has completed a blocking wait() call. There is now
1386 some process event that must be processed. This function should
1387 be defined by those targets that require the debugger to perform
1388 cleanup or internal state changes in response to the process event. */
1390 /* The inferior process has died. Do what is right. */
1392 void target_mourn_inferior (void);
1394 /* Does target have enough data to do a run or attach command? */
1396 #define target_can_run(t) \
1397 ((t)->to_can_run) (t)
1399 /* Set list of signals to be handled in the target.
1401 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1402 (enum gdb_signal). For every signal whose entry in this array is
1403 non-zero, the target is allowed -but not required- to skip reporting
1404 arrival of the signal to the GDB core by returning from target_wait,
1405 and to pass the signal directly to the inferior instead.
1407 However, if the target is hardware single-stepping a thread that is
1408 about to receive a signal, it needs to be reported in any case, even
1409 if mentioned in a previous target_pass_signals call. */
1411 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1413 /* Set list of signals the target may pass to the inferior. This
1414 directly maps to the "handle SIGNAL pass/nopass" setting.
1416 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1417 number (enum gdb_signal). For every signal whose entry in this
1418 array is non-zero, the target is allowed to pass the signal to the
1419 inferior. Signals not present in the array shall be silently
1420 discarded. This does not influence whether to pass signals to the
1421 inferior as a result of a target_resume call. This is useful in
1422 scenarios where the target needs to decide whether to pass or not a
1423 signal to the inferior without GDB core involvement, such as for
1424 example, when detaching (as threads may have been suspended with
1425 pending signals not reported to GDB). */
1427 extern void target_program_signals (int nsig, unsigned char *program_signals);
1429 /* Check to see if a thread is still alive. */
1431 extern int target_thread_alive (ptid_t ptid);
1433 /* Query for new threads and add them to the thread list. */
1435 extern void target_find_new_threads (void);
1437 /* Make target stop in a continuable fashion. (For instance, under
1438 Unix, this should act like SIGSTOP). This function is normally
1439 used by GUIs to implement a stop button. */
1441 extern void target_stop (ptid_t ptid);
1443 /* Send the specified COMMAND to the target's monitor
1444 (shell,interpreter) for execution. The result of the query is
1445 placed in OUTBUF. */
1447 #define target_rcmd(command, outbuf) \
1448 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1451 /* Does the target include all of memory, or only part of it? This
1452 determines whether we look up the target chain for other parts of
1453 memory if this target can't satisfy a request. */
1455 extern int target_has_all_memory_1 (void);
1456 #define target_has_all_memory target_has_all_memory_1 ()
1458 /* Does the target include memory? (Dummy targets don't.) */
1460 extern int target_has_memory_1 (void);
1461 #define target_has_memory target_has_memory_1 ()
1463 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1464 we start a process.) */
1466 extern int target_has_stack_1 (void);
1467 #define target_has_stack target_has_stack_1 ()
1469 /* Does the target have registers? (Exec files don't.) */
1471 extern int target_has_registers_1 (void);
1472 #define target_has_registers target_has_registers_1 ()
1474 /* Does the target have execution? Can we make it jump (through
1475 hoops), or pop its stack a few times? This means that the current
1476 target is currently executing; for some targets, that's the same as
1477 whether or not the target is capable of execution, but there are
1478 also targets which can be current while not executing. In that
1479 case this will become true after target_create_inferior or
1482 extern int target_has_execution_1 (ptid_t);
1484 /* Like target_has_execution_1, but always passes inferior_ptid. */
1486 extern int target_has_execution_current (void);
1488 #define target_has_execution target_has_execution_current ()
1490 /* Default implementations for process_stratum targets. Return true
1491 if there's a selected inferior, false otherwise. */
1493 extern int default_child_has_all_memory (struct target_ops *ops);
1494 extern int default_child_has_memory (struct target_ops *ops);
1495 extern int default_child_has_stack (struct target_ops *ops);
1496 extern int default_child_has_registers (struct target_ops *ops);
1497 extern int default_child_has_execution (struct target_ops *ops,
1500 /* Can the target support the debugger control of thread execution?
1501 Can it lock the thread scheduler? */
1503 #define target_can_lock_scheduler \
1504 (current_target.to_has_thread_control & tc_schedlock)
1506 /* Should the target enable async mode if it is supported? Temporary
1507 cludge until async mode is a strict superset of sync mode. */
1508 extern int target_async_permitted;
1510 /* Can the target support asynchronous execution? */
1511 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1513 /* Is the target in asynchronous execution mode? */
1514 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1516 int target_supports_non_stop (void);
1518 /* Put the target in async mode with the specified callback function. */
1519 #define target_async(CALLBACK,CONTEXT) \
1520 (current_target.to_async (¤t_target, (CALLBACK), (CONTEXT)))
1522 #define target_execution_direction() \
1523 (current_target.to_execution_direction (¤t_target))
1525 /* Converts a process id to a string. Usually, the string just contains
1526 `process xyz', but on some systems it may contain
1527 `process xyz thread abc'. */
1529 extern char *target_pid_to_str (ptid_t ptid);
1531 extern char *normal_pid_to_str (ptid_t ptid);
1533 /* Return a short string describing extra information about PID,
1534 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1537 #define target_extra_thread_info(TP) \
1538 (current_target.to_extra_thread_info (¤t_target, TP))
1540 /* Return the thread's name. A NULL result means that the target
1541 could not determine this thread's name. */
1543 extern char *target_thread_name (struct thread_info *);
1545 /* Attempts to find the pathname of the executable file
1546 that was run to create a specified process.
1548 The process PID must be stopped when this operation is used.
1550 If the executable file cannot be determined, NULL is returned.
1552 Else, a pointer to a character string containing the pathname
1553 is returned. This string should be copied into a buffer by
1554 the client if the string will not be immediately used, or if
1557 #define target_pid_to_exec_file(pid) \
1558 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1560 /* See the to_thread_architecture description in struct target_ops. */
1562 #define target_thread_architecture(ptid) \
1563 (current_target.to_thread_architecture (¤t_target, ptid))
1566 * Iterator function for target memory regions.
1567 * Calls a callback function once for each memory region 'mapped'
1568 * in the child process. Defined as a simple macro rather than
1569 * as a function macro so that it can be tested for nullity.
1572 #define target_find_memory_regions(FUNC, DATA) \
1573 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1576 * Compose corefile .note section.
1579 #define target_make_corefile_notes(BFD, SIZE_P) \
1580 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1582 /* Bookmark interfaces. */
1583 #define target_get_bookmark(ARGS, FROM_TTY) \
1584 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1586 #define target_goto_bookmark(ARG, FROM_TTY) \
1587 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1589 /* Hardware watchpoint interfaces. */
1591 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1592 write). Only the INFERIOR_PTID task is being queried. */
1594 #define target_stopped_by_watchpoint() \
1595 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1597 /* Non-zero if we have steppable watchpoints */
1599 #define target_have_steppable_watchpoint \
1600 (current_target.to_have_steppable_watchpoint)
1602 /* Non-zero if we have continuable watchpoints */
1604 #define target_have_continuable_watchpoint \
1605 (current_target.to_have_continuable_watchpoint)
1607 /* Provide defaults for hardware watchpoint functions. */
1609 /* If the *_hw_beakpoint functions have not been defined
1610 elsewhere use the definitions in the target vector. */
1612 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1613 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1614 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1615 (including this one?). OTHERTYPE is who knows what... */
1617 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1618 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1619 TYPE, CNT, OTHERTYPE);
1621 /* Returns the number of debug registers needed to watch the given
1622 memory region, or zero if not supported. */
1624 #define target_region_ok_for_hw_watchpoint(addr, len) \
1625 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1629 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1630 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1631 COND is the expression for its condition, or NULL if there's none.
1632 Returns 0 for success, 1 if the watchpoint type is not supported,
1635 #define target_insert_watchpoint(addr, len, type, cond) \
1636 (*current_target.to_insert_watchpoint) (¤t_target, \
1637 addr, len, type, cond)
1639 #define target_remove_watchpoint(addr, len, type, cond) \
1640 (*current_target.to_remove_watchpoint) (¤t_target, \
1641 addr, len, type, cond)
1643 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1644 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1645 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1646 masked watchpoints are not supported, -1 for failure. */
1648 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1650 /* Remove a masked watchpoint at ADDR with the mask MASK.
1651 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1652 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1655 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1657 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1658 the target machine. Returns 0 for success, and returns non-zero or
1659 throws an error (with a detailed failure reason error code and
1660 message) otherwise. */
1662 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1663 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1666 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1667 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1670 /* Return number of debug registers needed for a ranged breakpoint,
1671 or -1 if ranged breakpoints are not supported. */
1673 extern int target_ranged_break_num_registers (void);
1675 /* Return non-zero if target knows the data address which triggered this
1676 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1677 INFERIOR_PTID task is being queried. */
1678 #define target_stopped_data_address(target, addr_p) \
1679 (*target.to_stopped_data_address) (target, addr_p)
1681 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1682 LENGTH bytes beginning at START. */
1683 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1684 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1686 /* Return non-zero if the target is capable of using hardware to evaluate
1687 the condition expression. In this case, if the condition is false when
1688 the watched memory location changes, execution may continue without the
1689 debugger being notified.
1691 Due to limitations in the hardware implementation, it may be capable of
1692 avoiding triggering the watchpoint in some cases where the condition
1693 expression is false, but may report some false positives as well.
1694 For this reason, GDB will still evaluate the condition expression when
1695 the watchpoint triggers. */
1696 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1697 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1698 addr, len, type, cond)
1700 /* Return number of debug registers needed for a masked watchpoint,
1701 -1 if masked watchpoints are not supported or -2 if the given address
1702 and mask combination cannot be used. */
1704 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1706 /* Target can execute in reverse? */
1707 #define target_can_execute_reverse \
1708 (current_target.to_can_execute_reverse ? \
1709 current_target.to_can_execute_reverse (¤t_target) : 0)
1711 extern const struct target_desc *target_read_description (struct target_ops *);
1713 #define target_get_ada_task_ptid(lwp, tid) \
1714 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1716 /* Utility implementation of searching memory. */
1717 extern int simple_search_memory (struct target_ops* ops,
1718 CORE_ADDR start_addr,
1719 ULONGEST search_space_len,
1720 const gdb_byte *pattern,
1721 ULONGEST pattern_len,
1722 CORE_ADDR *found_addrp);
1724 /* Main entry point for searching memory. */
1725 extern int target_search_memory (CORE_ADDR start_addr,
1726 ULONGEST search_space_len,
1727 const gdb_byte *pattern,
1728 ULONGEST pattern_len,
1729 CORE_ADDR *found_addrp);
1731 /* Target file operations. */
1733 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1734 target file descriptor, or -1 if an error occurs (and set
1736 extern int target_fileio_open (const char *filename, int flags, int mode,
1739 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1740 Return the number of bytes written, or -1 if an error occurs
1741 (and set *TARGET_ERRNO). */
1742 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1743 ULONGEST offset, int *target_errno);
1745 /* Read up to LEN bytes FD on the target into READ_BUF.
1746 Return the number of bytes read, or -1 if an error occurs
1747 (and set *TARGET_ERRNO). */
1748 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1749 ULONGEST offset, int *target_errno);
1751 /* Close FD on the target. Return 0, or -1 if an error occurs
1752 (and set *TARGET_ERRNO). */
1753 extern int target_fileio_close (int fd, int *target_errno);
1755 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1756 occurs (and set *TARGET_ERRNO). */
1757 extern int target_fileio_unlink (const char *filename, int *target_errno);
1759 /* Read value of symbolic link FILENAME on the target. Return a
1760 null-terminated string allocated via xmalloc, or NULL if an error
1761 occurs (and set *TARGET_ERRNO). */
1762 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1764 /* Read target file FILENAME. The return value will be -1 if the transfer
1765 fails or is not supported; 0 if the object is empty; or the length
1766 of the object otherwise. If a positive value is returned, a
1767 sufficiently large buffer will be allocated using xmalloc and
1768 returned in *BUF_P containing the contents of the object.
1770 This method should be used for objects sufficiently small to store
1771 in a single xmalloc'd buffer, when no fixed bound on the object's
1772 size is known in advance. */
1773 extern LONGEST target_fileio_read_alloc (const char *filename,
1776 /* Read target file FILENAME. The result is NUL-terminated and
1777 returned as a string, allocated using xmalloc. If an error occurs
1778 or the transfer is unsupported, NULL is returned. Empty objects
1779 are returned as allocated but empty strings. A warning is issued
1780 if the result contains any embedded NUL bytes. */
1781 extern char *target_fileio_read_stralloc (const char *filename);
1784 /* Tracepoint-related operations. */
1786 #define target_trace_init() \
1787 (*current_target.to_trace_init) (¤t_target)
1789 #define target_download_tracepoint(t) \
1790 (*current_target.to_download_tracepoint) (¤t_target, t)
1792 #define target_can_download_tracepoint() \
1793 (*current_target.to_can_download_tracepoint) (¤t_target)
1795 #define target_download_trace_state_variable(tsv) \
1796 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1798 #define target_enable_tracepoint(loc) \
1799 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1801 #define target_disable_tracepoint(loc) \
1802 (*current_target.to_disable_tracepoint) (loc)
1804 #define target_trace_start() \
1805 (*current_target.to_trace_start) ()
1807 #define target_trace_set_readonly_regions() \
1808 (*current_target.to_trace_set_readonly_regions) ()
1810 #define target_get_trace_status(ts) \
1811 (*current_target.to_get_trace_status) (ts)
1813 #define target_get_tracepoint_status(tp,utp) \
1814 (*current_target.to_get_tracepoint_status) (tp, utp)
1816 #define target_trace_stop() \
1817 (*current_target.to_trace_stop) ()
1819 #define target_trace_find(type,num,addr1,addr2,tpp) \
1820 (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1822 #define target_get_trace_state_variable_value(tsv,val) \
1823 (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1825 #define target_save_trace_data(filename) \
1826 (*current_target.to_save_trace_data) (filename)
1828 #define target_upload_tracepoints(utpp) \
1829 (*current_target.to_upload_tracepoints) (utpp)
1831 #define target_upload_trace_state_variables(utsvp) \
1832 (*current_target.to_upload_trace_state_variables) (utsvp)
1834 #define target_get_raw_trace_data(buf,offset,len) \
1835 (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1837 #define target_get_min_fast_tracepoint_insn_len() \
1838 (*current_target.to_get_min_fast_tracepoint_insn_len) ()
1840 #define target_set_disconnected_tracing(val) \
1841 (*current_target.to_set_disconnected_tracing) (val)
1843 #define target_set_circular_trace_buffer(val) \
1844 (*current_target.to_set_circular_trace_buffer) (val)
1846 #define target_set_trace_buffer_size(val) \
1847 (*current_target.to_set_trace_buffer_size) (val)
1849 #define target_set_trace_notes(user,notes,stopnotes) \
1850 (*current_target.to_set_trace_notes) ((user), (notes), (stopnotes))
1852 #define target_get_tib_address(ptid, addr) \
1853 (*current_target.to_get_tib_address) ((ptid), (addr))
1855 #define target_set_permissions() \
1856 (*current_target.to_set_permissions) ()
1858 #define target_static_tracepoint_marker_at(addr, marker) \
1859 (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1861 #define target_static_tracepoint_markers_by_strid(marker_id) \
1862 (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1864 #define target_traceframe_info() \
1865 (*current_target.to_traceframe_info) ()
1867 #define target_use_agent(use) \
1868 (*current_target.to_use_agent) (use)
1870 #define target_can_use_agent() \
1871 (*current_target.to_can_use_agent) ()
1873 #define target_augmented_libraries_svr4_read() \
1874 (*current_target.to_augmented_libraries_svr4_read) ()
1876 /* Command logging facility. */
1878 #define target_log_command(p) \
1880 if (current_target.to_log_command) \
1881 (*current_target.to_log_command) (¤t_target, \
1886 extern int target_core_of_thread (ptid_t ptid);
1888 /* See to_get_unwinder in struct target_ops. */
1889 extern const struct frame_unwind *target_get_unwinder (void);
1891 /* See to_get_tailcall_unwinder in struct target_ops. */
1892 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
1894 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1895 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1896 if there's a mismatch, and -1 if an error is encountered while
1897 reading memory. Throws an error if the functionality is found not
1898 to be supported by the current target. */
1899 int target_verify_memory (const gdb_byte *data,
1900 CORE_ADDR memaddr, ULONGEST size);
1902 /* Routines for maintenance of the target structures...
1904 complete_target_initialization: Finalize a target_ops by filling in
1905 any fields needed by the target implementation.
1907 add_target: Add a target to the list of all possible targets.
1909 push_target: Make this target the top of the stack of currently used
1910 targets, within its particular stratum of the stack. Result
1911 is 0 if now atop the stack, nonzero if not on top (maybe
1914 unpush_target: Remove this from the stack of currently used targets,
1915 no matter where it is on the list. Returns 0 if no
1916 change, 1 if removed from stack. */
1918 extern void add_target (struct target_ops *);
1920 extern void add_target_with_completer (struct target_ops *t,
1921 completer_ftype *completer);
1923 extern void complete_target_initialization (struct target_ops *t);
1925 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
1926 for maintaining backwards compatibility when renaming targets. */
1928 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
1930 extern void push_target (struct target_ops *);
1932 extern int unpush_target (struct target_ops *);
1934 extern void target_pre_inferior (int);
1936 extern void target_preopen (int);
1938 /* Does whatever cleanup is required to get rid of all pushed targets. */
1939 extern void pop_all_targets (void);
1941 /* Like pop_all_targets, but pops only targets whose stratum is
1942 strictly above ABOVE_STRATUM. */
1943 extern void pop_all_targets_above (enum strata above_stratum);
1945 extern int target_is_pushed (struct target_ops *t);
1947 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1950 /* Struct target_section maps address ranges to file sections. It is
1951 mostly used with BFD files, but can be used without (e.g. for handling
1952 raw disks, or files not in formats handled by BFD). */
1954 struct target_section
1956 CORE_ADDR addr; /* Lowest address in section */
1957 CORE_ADDR endaddr; /* 1+highest address in section */
1959 struct bfd_section *the_bfd_section;
1961 /* The "owner" of the section.
1962 It can be any unique value. It is set by add_target_sections
1963 and used by remove_target_sections.
1964 For example, for executables it is a pointer to exec_bfd and
1965 for shlibs it is the so_list pointer. */
1969 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1971 struct target_section_table
1973 struct target_section *sections;
1974 struct target_section *sections_end;
1977 /* Return the "section" containing the specified address. */
1978 struct target_section *target_section_by_addr (struct target_ops *target,
1981 /* Return the target section table this target (or the targets
1982 beneath) currently manipulate. */
1984 extern struct target_section_table *target_get_section_table
1985 (struct target_ops *target);
1987 /* From mem-break.c */
1989 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
1990 struct bp_target_info *);
1992 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
1993 struct bp_target_info *);
1995 extern int default_memory_remove_breakpoint (struct gdbarch *,
1996 struct bp_target_info *);
1998 extern int default_memory_insert_breakpoint (struct gdbarch *,
1999 struct bp_target_info *);
2004 extern void initialize_targets (void);
2006 extern void noprocess (void) ATTRIBUTE_NORETURN;
2008 extern void target_require_runnable (void);
2010 extern void find_default_attach (struct target_ops *, char *, int);
2012 extern void find_default_create_inferior (struct target_ops *,
2013 char *, char *, char **, int);
2015 extern struct target_ops *find_target_beneath (struct target_ops *);
2017 /* Find the target at STRATUM. If no target is at that stratum,
2020 struct target_ops *find_target_at (enum strata stratum);
2022 /* Read OS data object of type TYPE from the target, and return it in
2023 XML format. The result is NUL-terminated and returned as a string,
2024 allocated using xmalloc. If an error occurs or the transfer is
2025 unsupported, NULL is returned. Empty objects are returned as
2026 allocated but empty strings. */
2028 extern char *target_get_osdata (const char *type);
2031 /* Stuff that should be shared among the various remote targets. */
2033 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2034 information (higher values, more information). */
2035 extern int remote_debug;
2037 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2038 extern int baud_rate;
2039 /* Timeout limit for response from target. */
2040 extern int remote_timeout;
2044 /* Set the show memory breakpoints mode to show, and installs a cleanup
2045 to restore it back to the current value. */
2046 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2048 extern int may_write_registers;
2049 extern int may_write_memory;
2050 extern int may_insert_breakpoints;
2051 extern int may_insert_tracepoints;
2052 extern int may_insert_fast_tracepoints;
2053 extern int may_stop;
2055 extern void update_target_permissions (void);
2058 /* Imported from machine dependent code. */
2060 /* Blank target vector entries are initialized to target_ignore. */
2061 void target_ignore (void);
2063 /* See to_supports_btrace in struct target_ops. */
2064 #define target_supports_btrace() \
2065 (current_target.to_supports_btrace (¤t_target))
2067 /* See to_enable_btrace in struct target_ops. */
2068 extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2070 /* See to_disable_btrace in struct target_ops. */
2071 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2073 /* See to_teardown_btrace in struct target_ops. */
2074 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2076 /* See to_read_btrace in struct target_ops. */
2077 extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2078 struct btrace_target_info *,
2079 enum btrace_read_type);
2081 /* See to_stop_recording in struct target_ops. */
2082 extern void target_stop_recording (void);
2084 /* See to_info_record in struct target_ops. */
2085 extern void target_info_record (void);
2087 /* See to_save_record in struct target_ops. */
2088 extern void target_save_record (const char *filename);
2090 /* Query if the target supports deleting the execution log. */
2091 extern int target_supports_delete_record (void);
2093 /* See to_delete_record in struct target_ops. */
2094 extern void target_delete_record (void);
2096 /* See to_record_is_replaying in struct target_ops. */
2097 extern int target_record_is_replaying (void);
2099 /* See to_goto_record_begin in struct target_ops. */
2100 extern void target_goto_record_begin (void);
2102 /* See to_goto_record_end in struct target_ops. */
2103 extern void target_goto_record_end (void);
2105 /* See to_goto_record in struct target_ops. */
2106 extern void target_goto_record (ULONGEST insn);
2108 /* See to_insn_history. */
2109 extern void target_insn_history (int size, int flags);
2111 /* See to_insn_history_from. */
2112 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2114 /* See to_insn_history_range. */
2115 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2117 /* See to_call_history. */
2118 extern void target_call_history (int size, int flags);
2120 /* See to_call_history_from. */
2121 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2123 /* See to_call_history_range. */
2124 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2126 /* See to_decr_pc_after_break. Start searching for the target at OPS. */
2127 extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2128 struct gdbarch *gdbarch);
2130 /* See to_decr_pc_after_break. */
2131 extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2133 #endif /* !defined (TARGET_H) */