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 TARGET_DEFAULT_FUNC (find_default_attach
);
408 void (*to_post_attach
) (struct target_ops
*, int)
409 TARGET_DEFAULT_IGNORE ();
410 void (*to_detach
) (struct target_ops
*ops
, const char *, int)
411 TARGET_DEFAULT_IGNORE ();
412 void (*to_disconnect
) (struct target_ops
*, char *, int);
413 void (*to_resume
) (struct target_ops
*, ptid_t
, int, enum gdb_signal
)
414 TARGET_DEFAULT_NORETURN (noprocess ());
415 ptid_t (*to_wait
) (struct target_ops
*,
416 ptid_t
, struct target_waitstatus
*, int)
417 TARGET_DEFAULT_NORETURN (noprocess ());
418 void (*to_fetch_registers
) (struct target_ops
*, struct regcache
*, int);
419 void (*to_store_registers
) (struct target_ops
*, struct regcache
*, int)
420 TARGET_DEFAULT_NORETURN (noprocess ());
421 void (*to_prepare_to_store
) (struct target_ops
*, struct regcache
*)
422 TARGET_DEFAULT_NORETURN (noprocess ());
424 /* Transfer LEN bytes of memory between GDB address MYADDR and
425 target address MEMADDR. If WRITE, transfer them to the target, else
426 transfer them from the target. TARGET is the target from which we
429 Return value, N, is one of the following:
431 0 means that we can't handle this. If errno has been set, it is the
432 error which prevented us from doing it (FIXME: What about bfd_error?).
434 positive (call it N) means that we have transferred N bytes
435 starting at MEMADDR. We might be able to handle more bytes
436 beyond this length, but no promises.
438 negative (call its absolute value N) means that we cannot
439 transfer right at MEMADDR, but we could transfer at least
440 something at MEMADDR + N.
442 NOTE: cagney/2004-10-01: This has been entirely superseeded by
443 to_xfer_partial and inferior inheritance. */
445 int (*deprecated_xfer_memory
) (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
447 struct mem_attrib
*attrib
,
448 struct target_ops
*target
);
450 void (*to_files_info
) (struct target_ops
*)
451 TARGET_DEFAULT_IGNORE ();
452 int (*to_insert_breakpoint
) (struct target_ops
*, struct gdbarch
*,
453 struct bp_target_info
*)
454 TARGET_DEFAULT_FUNC (memory_insert_breakpoint
);
455 int (*to_remove_breakpoint
) (struct target_ops
*, struct gdbarch
*,
456 struct bp_target_info
*)
457 TARGET_DEFAULT_FUNC (memory_remove_breakpoint
);
458 int (*to_can_use_hw_breakpoint
) (struct target_ops
*, int, int, int)
459 TARGET_DEFAULT_RETURN (0);
460 int (*to_ranged_break_num_registers
) (struct target_ops
*);
461 int (*to_insert_hw_breakpoint
) (struct target_ops
*,
462 struct gdbarch
*, struct bp_target_info
*)
463 TARGET_DEFAULT_RETURN (-1);
464 int (*to_remove_hw_breakpoint
) (struct target_ops
*,
465 struct gdbarch
*, struct bp_target_info
*)
466 TARGET_DEFAULT_RETURN (-1);
468 /* Documentation of what the two routines below are expected to do is
469 provided with the corresponding target_* macros. */
470 int (*to_remove_watchpoint
) (struct target_ops
*,
471 CORE_ADDR
, int, int, struct expression
*)
472 TARGET_DEFAULT_RETURN (-1);
473 int (*to_insert_watchpoint
) (struct target_ops
*,
474 CORE_ADDR
, int, int, struct expression
*)
475 TARGET_DEFAULT_RETURN (-1);
477 int (*to_insert_mask_watchpoint
) (struct target_ops
*,
478 CORE_ADDR
, CORE_ADDR
, int);
479 int (*to_remove_mask_watchpoint
) (struct target_ops
*,
480 CORE_ADDR
, CORE_ADDR
, int);
481 int (*to_stopped_by_watchpoint
) (struct target_ops
*)
482 TARGET_DEFAULT_RETURN (0);
483 int to_have_steppable_watchpoint
;
484 int to_have_continuable_watchpoint
;
485 int (*to_stopped_data_address
) (struct target_ops
*, CORE_ADDR
*)
486 TARGET_DEFAULT_RETURN (0);
487 int (*to_watchpoint_addr_within_range
) (struct target_ops
*,
488 CORE_ADDR
, CORE_ADDR
, int)
489 TARGET_DEFAULT_FUNC (default_watchpoint_addr_within_range
);
491 /* Documentation of this routine is provided with the corresponding
493 int (*to_region_ok_for_hw_watchpoint
) (struct target_ops
*,
495 TARGET_DEFAULT_FUNC (default_region_ok_for_hw_watchpoint
);
497 int (*to_can_accel_watchpoint_condition
) (struct target_ops
*,
500 TARGET_DEFAULT_RETURN (0);
501 int (*to_masked_watch_num_registers
) (struct target_ops
*,
502 CORE_ADDR
, CORE_ADDR
);
503 void (*to_terminal_init
) (struct target_ops
*)
504 TARGET_DEFAULT_IGNORE ();
505 void (*to_terminal_inferior
) (struct target_ops
*)
506 TARGET_DEFAULT_IGNORE ();
507 void (*to_terminal_ours_for_output
) (struct target_ops
*)
508 TARGET_DEFAULT_IGNORE ();
509 void (*to_terminal_ours
) (struct target_ops
*)
510 TARGET_DEFAULT_IGNORE ();
511 void (*to_terminal_save_ours
) (struct target_ops
*)
512 TARGET_DEFAULT_IGNORE ();
513 void (*to_terminal_info
) (struct target_ops
*, const char *, int)
514 TARGET_DEFAULT_FUNC (default_terminal_info
);
515 void (*to_kill
) (struct target_ops
*);
516 void (*to_load
) (struct target_ops
*, char *, int)
517 TARGET_DEFAULT_NORETURN (tcomplain ());
518 void (*to_create_inferior
) (struct target_ops
*,
519 char *, char *, char **, int);
520 void (*to_post_startup_inferior
) (struct target_ops
*, ptid_t
)
521 TARGET_DEFAULT_IGNORE ();
522 int (*to_insert_fork_catchpoint
) (struct target_ops
*, int)
523 TARGET_DEFAULT_RETURN (1);
524 int (*to_remove_fork_catchpoint
) (struct target_ops
*, int)
525 TARGET_DEFAULT_RETURN (1);
526 int (*to_insert_vfork_catchpoint
) (struct target_ops
*, int)
527 TARGET_DEFAULT_RETURN (1);
528 int (*to_remove_vfork_catchpoint
) (struct target_ops
*, int)
529 TARGET_DEFAULT_RETURN (1);
530 int (*to_follow_fork
) (struct target_ops
*, int, int);
531 int (*to_insert_exec_catchpoint
) (struct target_ops
*, int)
532 TARGET_DEFAULT_RETURN (1);
533 int (*to_remove_exec_catchpoint
) (struct target_ops
*, int)
534 TARGET_DEFAULT_RETURN (1);
535 int (*to_set_syscall_catchpoint
) (struct target_ops
*,
536 int, int, int, int, int *)
537 TARGET_DEFAULT_RETURN (1);
538 int (*to_has_exited
) (struct target_ops
*, int, int, int *)
539 TARGET_DEFAULT_RETURN (0);
540 void (*to_mourn_inferior
) (struct target_ops
*);
541 int (*to_can_run
) (struct target_ops
*);
543 /* Documentation of this routine is provided with the corresponding
545 void (*to_pass_signals
) (struct target_ops
*, int, unsigned char *);
547 /* Documentation of this routine is provided with the
548 corresponding target_* function. */
549 void (*to_program_signals
) (struct target_ops
*, int, unsigned char *);
551 int (*to_thread_alive
) (struct target_ops
*, ptid_t ptid
);
552 void (*to_find_new_threads
) (struct target_ops
*);
553 char *(*to_pid_to_str
) (struct target_ops
*, ptid_t
);
554 char *(*to_extra_thread_info
) (struct target_ops
*, struct thread_info
*)
555 TARGET_DEFAULT_RETURN (0);
556 char *(*to_thread_name
) (struct target_ops
*, struct thread_info
*)
557 TARGET_DEFAULT_RETURN (0);
558 void (*to_stop
) (struct target_ops
*, ptid_t
);
559 void (*to_rcmd
) (struct target_ops
*,
560 char *command
, struct ui_file
*output
)
561 TARGET_DEFAULT_FUNC (default_rcmd
);
562 char *(*to_pid_to_exec_file
) (struct target_ops
*, int pid
)
563 TARGET_DEFAULT_RETURN (0);
564 void (*to_log_command
) (struct target_ops
*, const char *)
565 TARGET_DEFAULT_IGNORE ();
566 struct target_section_table
*(*to_get_section_table
) (struct target_ops
*);
567 enum strata to_stratum
;
568 int (*to_has_all_memory
) (struct target_ops
*);
569 int (*to_has_memory
) (struct target_ops
*);
570 int (*to_has_stack
) (struct target_ops
*);
571 int (*to_has_registers
) (struct target_ops
*);
572 int (*to_has_execution
) (struct target_ops
*, ptid_t
);
573 int to_has_thread_control
; /* control thread execution */
574 int to_attach_no_wait
;
575 /* ASYNC target controls */
576 int (*to_can_async_p
) (struct target_ops
*)
577 TARGET_DEFAULT_FUNC (find_default_can_async_p
);
578 int (*to_is_async_p
) (struct target_ops
*)
579 TARGET_DEFAULT_FUNC (find_default_is_async_p
);
580 void (*to_async
) (struct target_ops
*, async_callback_ftype
*, void *)
581 TARGET_DEFAULT_NORETURN (tcomplain ());
582 int (*to_supports_non_stop
) (struct target_ops
*);
583 /* find_memory_regions support method for gcore */
584 int (*to_find_memory_regions
) (struct target_ops
*,
585 find_memory_region_ftype func
, void *data
);
586 /* make_corefile_notes support method for gcore */
587 char * (*to_make_corefile_notes
) (struct target_ops
*, bfd
*, int *);
588 /* get_bookmark support method for bookmarks */
589 gdb_byte
* (*to_get_bookmark
) (struct target_ops
*, char *, int);
590 /* goto_bookmark support method for bookmarks */
591 void (*to_goto_bookmark
) (struct target_ops
*, gdb_byte
*, int);
592 /* Return the thread-local address at OFFSET in the
593 thread-local storage for the thread PTID and the shared library
594 or executable file given by OBJFILE. If that block of
595 thread-local storage hasn't been allocated yet, this function
596 may return an error. */
597 CORE_ADDR (*to_get_thread_local_address
) (struct target_ops
*ops
,
599 CORE_ADDR load_module_addr
,
602 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
603 OBJECT. The OFFSET, for a seekable object, specifies the
604 starting point. The ANNEX can be used to provide additional
605 data-specific information to the target.
607 Return the transferred status, error or OK (an
608 'enum target_xfer_status' value). Save the number of bytes
609 actually transferred in *XFERED_LEN if transfer is successful
610 (TARGET_XFER_OK) or the number unavailable bytes if the requested
611 data is unavailable (TARGET_XFER_E_UNAVAILABLE). *XFERED_LEN
612 smaller than LEN does not indicate the end of the object, only
613 the end of the transfer; higher level code should continue
614 transferring if desired. This is handled in target.c.
616 The interface does not support a "retry" mechanism. Instead it
617 assumes that at least one byte will be transfered on each
620 NOTE: cagney/2003-10-17: The current interface can lead to
621 fragmented transfers. Lower target levels should not implement
622 hacks, such as enlarging the transfer, in an attempt to
623 compensate for this. Instead, the target stack should be
624 extended so that it implements supply/collect methods and a
625 look-aside object cache. With that available, the lowest
626 target can safely and freely "push" data up the stack.
628 See target_read and target_write for more information. One,
629 and only one, of readbuf or writebuf must be non-NULL. */
631 enum target_xfer_status (*to_xfer_partial
) (struct target_ops
*ops
,
632 enum target_object object
,
635 const gdb_byte
*writebuf
,
636 ULONGEST offset
, ULONGEST len
,
637 ULONGEST
*xfered_len
)
638 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO
);
640 /* Returns the memory map for the target. A return value of NULL
641 means that no memory map is available. If a memory address
642 does not fall within any returned regions, it's assumed to be
643 RAM. The returned memory regions should not overlap.
645 The order of regions does not matter; target_memory_map will
646 sort regions by starting address. For that reason, this
647 function should not be called directly except via
650 This method should not cache data; if the memory map could
651 change unexpectedly, it should be invalidated, and higher
652 layers will re-fetch it. */
653 VEC(mem_region_s
) *(*to_memory_map
) (struct target_ops
*);
655 /* Erases the region of flash memory starting at ADDRESS, of
658 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
659 on flash block boundaries, as reported by 'to_memory_map'. */
660 void (*to_flash_erase
) (struct target_ops
*,
661 ULONGEST address
, LONGEST length
);
663 /* Finishes a flash memory write sequence. After this operation
664 all flash memory should be available for writing and the result
665 of reading from areas written by 'to_flash_write' should be
666 equal to what was written. */
667 void (*to_flash_done
) (struct target_ops
*);
669 /* Describe the architecture-specific features of this target.
670 Returns the description found, or NULL if no description
672 const struct target_desc
*(*to_read_description
) (struct target_ops
*ops
);
674 /* Build the PTID of the thread on which a given task is running,
675 based on LWP and THREAD. These values are extracted from the
676 task Private_Data section of the Ada Task Control Block, and
677 their interpretation depends on the target. */
678 ptid_t (*to_get_ada_task_ptid
) (struct target_ops
*,
679 long lwp
, long thread
);
681 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
682 Return 0 if *READPTR is already at the end of the buffer.
683 Return -1 if there is insufficient buffer for a whole entry.
684 Return 1 if an entry was read into *TYPEP and *VALP. */
685 int (*to_auxv_parse
) (struct target_ops
*ops
, gdb_byte
**readptr
,
686 gdb_byte
*endptr
, CORE_ADDR
*typep
, CORE_ADDR
*valp
);
688 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
689 sequence of bytes in PATTERN with length PATTERN_LEN.
691 The result is 1 if found, 0 if not found, and -1 if there was an error
692 requiring halting of the search (e.g. memory read error).
693 If the pattern is found the address is recorded in FOUND_ADDRP. */
694 int (*to_search_memory
) (struct target_ops
*ops
,
695 CORE_ADDR start_addr
, ULONGEST search_space_len
,
696 const gdb_byte
*pattern
, ULONGEST pattern_len
,
697 CORE_ADDR
*found_addrp
);
699 /* Can target execute in reverse? */
700 int (*to_can_execute_reverse
) (struct target_ops
*);
702 /* The direction the target is currently executing. Must be
703 implemented on targets that support reverse execution and async
704 mode. The default simply returns forward execution. */
705 enum exec_direction_kind (*to_execution_direction
) (struct target_ops
*);
707 /* Does this target support debugging multiple processes
709 int (*to_supports_multi_process
) (struct target_ops
*);
711 /* Does this target support enabling and disabling tracepoints while a trace
712 experiment is running? */
713 int (*to_supports_enable_disable_tracepoint
) (struct target_ops
*);
715 /* Does this target support disabling address space randomization? */
716 int (*to_supports_disable_randomization
) (struct target_ops
*);
718 /* Does this target support the tracenz bytecode for string collection? */
719 int (*to_supports_string_tracing
) (struct target_ops
*);
721 /* Does this target support evaluation of breakpoint conditions on its
723 int (*to_supports_evaluation_of_breakpoint_conditions
) (struct target_ops
*);
725 /* Does this target support evaluation of breakpoint commands on its
727 int (*to_can_run_breakpoint_commands
) (struct target_ops
*);
729 /* Determine current architecture of thread PTID.
731 The target is supposed to determine the architecture of the code where
732 the target is currently stopped at (on Cell, if a target is in spu_run,
733 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
734 This is architecture used to perform decr_pc_after_break adjustment,
735 and also determines the frame architecture of the innermost frame.
736 ptrace operations need to operate according to target_gdbarch ().
738 The default implementation always returns target_gdbarch (). */
739 struct gdbarch
*(*to_thread_architecture
) (struct target_ops
*, ptid_t
);
741 /* Determine current address space of thread PTID.
743 The default implementation always returns the inferior's
745 struct address_space
*(*to_thread_address_space
) (struct target_ops
*,
748 /* Target file operations. */
750 /* Open FILENAME on the target, using FLAGS and MODE. Return a
751 target file descriptor, or -1 if an error occurs (and set
753 int (*to_fileio_open
) (struct target_ops
*,
754 const char *filename
, int flags
, int mode
,
757 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
758 Return the number of bytes written, or -1 if an error occurs
759 (and set *TARGET_ERRNO). */
760 int (*to_fileio_pwrite
) (struct target_ops
*,
761 int fd
, const gdb_byte
*write_buf
, int len
,
762 ULONGEST offset
, int *target_errno
);
764 /* Read up to LEN bytes FD on the target into READ_BUF.
765 Return the number of bytes read, or -1 if an error occurs
766 (and set *TARGET_ERRNO). */
767 int (*to_fileio_pread
) (struct target_ops
*,
768 int fd
, gdb_byte
*read_buf
, int len
,
769 ULONGEST offset
, int *target_errno
);
771 /* Close FD on the target. Return 0, or -1 if an error occurs
772 (and set *TARGET_ERRNO). */
773 int (*to_fileio_close
) (struct target_ops
*, int fd
, int *target_errno
);
775 /* Unlink FILENAME on the target. Return 0, or -1 if an error
776 occurs (and set *TARGET_ERRNO). */
777 int (*to_fileio_unlink
) (struct target_ops
*,
778 const char *filename
, int *target_errno
);
780 /* Read value of symbolic link FILENAME on the target. Return a
781 null-terminated string allocated via xmalloc, or NULL if an error
782 occurs (and set *TARGET_ERRNO). */
783 char *(*to_fileio_readlink
) (struct target_ops
*,
784 const char *filename
, int *target_errno
);
787 /* Implement the "info proc" command. */
788 void (*to_info_proc
) (struct target_ops
*, char *, enum info_proc_what
);
790 /* Tracepoint-related operations. */
792 /* Prepare the target for a tracing run. */
793 void (*to_trace_init
) (struct target_ops
*);
795 /* Send full details of a tracepoint location to the target. */
796 void (*to_download_tracepoint
) (struct target_ops
*,
797 struct bp_location
*location
);
799 /* Is the target able to download tracepoint locations in current
801 int (*to_can_download_tracepoint
) (struct target_ops
*);
803 /* Send full details of a trace state variable to the target. */
804 void (*to_download_trace_state_variable
) (struct target_ops
*,
805 struct trace_state_variable
*tsv
);
807 /* Enable a tracepoint on the target. */
808 void (*to_enable_tracepoint
) (struct target_ops
*,
809 struct bp_location
*location
);
811 /* Disable a tracepoint on the target. */
812 void (*to_disable_tracepoint
) (struct target_ops
*,
813 struct bp_location
*location
);
815 /* Inform the target info of memory regions that are readonly
816 (such as text sections), and so it should return data from
817 those rather than look in the trace buffer. */
818 void (*to_trace_set_readonly_regions
) (struct target_ops
*);
820 /* Start a trace run. */
821 void (*to_trace_start
) (struct target_ops
*);
823 /* Get the current status of a tracing run. */
824 int (*to_get_trace_status
) (struct target_ops
*, struct trace_status
*ts
);
826 void (*to_get_tracepoint_status
) (struct target_ops
*,
827 struct breakpoint
*tp
,
828 struct uploaded_tp
*utp
);
830 /* Stop a trace run. */
831 void (*to_trace_stop
) (struct target_ops
*);
833 /* Ask the target to find a trace frame of the given type TYPE,
834 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
835 number of the trace frame, and also the tracepoint number at
836 TPP. If no trace frame matches, return -1. May throw if the
838 int (*to_trace_find
) (struct target_ops
*,
839 enum trace_find_type type
, int num
,
840 CORE_ADDR addr1
, CORE_ADDR addr2
, int *tpp
);
842 /* Get the value of the trace state variable number TSV, returning
843 1 if the value is known and writing the value itself into the
844 location pointed to by VAL, else returning 0. */
845 int (*to_get_trace_state_variable_value
) (struct target_ops
*,
846 int tsv
, LONGEST
*val
);
848 int (*to_save_trace_data
) (struct target_ops
*, const char *filename
);
850 int (*to_upload_tracepoints
) (struct target_ops
*,
851 struct uploaded_tp
**utpp
);
853 int (*to_upload_trace_state_variables
) (struct target_ops
*,
854 struct uploaded_tsv
**utsvp
);
856 LONGEST (*to_get_raw_trace_data
) (struct target_ops
*, gdb_byte
*buf
,
857 ULONGEST offset
, LONGEST len
);
859 /* Get the minimum length of instruction on which a fast tracepoint
860 may be set on the target. If this operation is unsupported,
861 return -1. If for some reason the minimum length cannot be
862 determined, return 0. */
863 int (*to_get_min_fast_tracepoint_insn_len
) (struct target_ops
*);
865 /* Set the target's tracing behavior in response to unexpected
866 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
867 void (*to_set_disconnected_tracing
) (struct target_ops
*, int val
);
868 void (*to_set_circular_trace_buffer
) (struct target_ops
*, int val
);
869 /* Set the size of trace buffer in the target. */
870 void (*to_set_trace_buffer_size
) (struct target_ops
*, LONGEST val
);
872 /* Add/change textual notes about the trace run, returning 1 if
873 successful, 0 otherwise. */
874 int (*to_set_trace_notes
) (struct target_ops
*,
875 const char *user
, const char *notes
,
876 const char *stopnotes
);
878 /* Return the processor core that thread PTID was last seen on.
879 This information is updated only when:
880 - update_thread_list is called
882 If the core cannot be determined -- either for the specified
883 thread, or right now, or in this debug session, or for this
884 target -- return -1. */
885 int (*to_core_of_thread
) (struct target_ops
*, ptid_t ptid
);
887 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
888 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
889 a match, 0 if there's a mismatch, and -1 if an error is
890 encountered while reading memory. */
891 int (*to_verify_memory
) (struct target_ops
*, const gdb_byte
*data
,
892 CORE_ADDR memaddr
, ULONGEST size
);
894 /* Return the address of the start of the Thread Information Block
895 a Windows OS specific feature. */
896 int (*to_get_tib_address
) (struct target_ops
*,
897 ptid_t ptid
, CORE_ADDR
*addr
);
899 /* Send the new settings of write permission variables. */
900 void (*to_set_permissions
) (struct target_ops
*);
902 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
903 with its details. Return 1 on success, 0 on failure. */
904 int (*to_static_tracepoint_marker_at
) (struct target_ops
*, CORE_ADDR
,
905 struct static_tracepoint_marker
*marker
);
907 /* Return a vector of all tracepoints markers string id ID, or all
908 markers if ID is NULL. */
909 VEC(static_tracepoint_marker_p
) *(*to_static_tracepoint_markers_by_strid
)
910 (struct target_ops
*, const char *id
);
912 /* Return a traceframe info object describing the current
913 traceframe's contents. If the target doesn't support
914 traceframe info, return NULL. If the current traceframe is not
915 selected (the current traceframe number is -1), the target can
916 choose to return either NULL or an empty traceframe info. If
917 NULL is returned, for example in remote target, GDB will read
918 from the live inferior. If an empty traceframe info is
919 returned, for example in tfile target, which means the
920 traceframe info is available, but the requested memory is not
921 available in it. GDB will try to see if the requested memory
922 is available in the read-only sections. This method should not
923 cache data; higher layers take care of caching, invalidating,
924 and re-fetching when necessary. */
925 struct traceframe_info
*(*to_traceframe_info
) (struct target_ops
*);
927 /* Ask the target to use or not to use agent according to USE. Return 1
928 successful, 0 otherwise. */
929 int (*to_use_agent
) (struct target_ops
*, int use
);
931 /* Is the target able to use agent in current state? */
932 int (*to_can_use_agent
) (struct target_ops
*);
934 /* Check whether the target supports branch tracing. */
935 int (*to_supports_btrace
) (struct target_ops
*)
936 TARGET_DEFAULT_RETURN (0);
938 /* Enable branch tracing for PTID and allocate a branch trace target
939 information struct for reading and for disabling branch trace. */
940 struct btrace_target_info
*(*to_enable_btrace
) (struct target_ops
*,
943 /* Disable branch tracing and deallocate TINFO. */
944 void (*to_disable_btrace
) (struct target_ops
*,
945 struct btrace_target_info
*tinfo
);
947 /* Disable branch tracing and deallocate TINFO. This function is similar
948 to to_disable_btrace, except that it is called during teardown and is
949 only allowed to perform actions that are safe. A counter-example would
950 be attempting to talk to a remote target. */
951 void (*to_teardown_btrace
) (struct target_ops
*,
952 struct btrace_target_info
*tinfo
);
954 /* Read branch trace data for the thread indicated by BTINFO into DATA.
955 DATA is cleared before new trace is added.
956 The branch trace will start with the most recent block and continue
957 towards older blocks. */
958 enum btrace_error (*to_read_btrace
) (struct target_ops
*self
,
959 VEC (btrace_block_s
) **data
,
960 struct btrace_target_info
*btinfo
,
961 enum btrace_read_type type
);
963 /* Stop trace recording. */
964 void (*to_stop_recording
) (struct target_ops
*);
966 /* Print information about the recording. */
967 void (*to_info_record
) (struct target_ops
*);
969 /* Save the recorded execution trace into a file. */
970 void (*to_save_record
) (struct target_ops
*, const char *filename
);
972 /* Delete the recorded execution trace from the current position onwards. */
973 void (*to_delete_record
) (struct target_ops
*);
975 /* Query if the record target is currently replaying. */
976 int (*to_record_is_replaying
) (struct target_ops
*);
978 /* Go to the begin of the execution trace. */
979 void (*to_goto_record_begin
) (struct target_ops
*);
981 /* Go to the end of the execution trace. */
982 void (*to_goto_record_end
) (struct target_ops
*);
984 /* Go to a specific location in the recorded execution trace. */
985 void (*to_goto_record
) (struct target_ops
*, ULONGEST insn
);
987 /* Disassemble SIZE instructions in the recorded execution trace from
988 the current position.
989 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
990 disassemble SIZE succeeding instructions. */
991 void (*to_insn_history
) (struct target_ops
*, int size
, int flags
);
993 /* Disassemble SIZE instructions in the recorded execution trace around
995 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
996 disassemble SIZE instructions after FROM. */
997 void (*to_insn_history_from
) (struct target_ops
*,
998 ULONGEST from
, int size
, int flags
);
1000 /* Disassemble a section of the recorded execution trace from instruction
1001 BEGIN (inclusive) to instruction END (inclusive). */
1002 void (*to_insn_history_range
) (struct target_ops
*,
1003 ULONGEST begin
, ULONGEST end
, int flags
);
1005 /* Print a function trace of the recorded execution trace.
1006 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1007 succeeding functions. */
1008 void (*to_call_history
) (struct target_ops
*, int size
, int flags
);
1010 /* Print a function trace of the recorded execution trace starting
1012 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1013 SIZE functions after FROM. */
1014 void (*to_call_history_from
) (struct target_ops
*,
1015 ULONGEST begin
, int size
, int flags
);
1017 /* Print a function trace of an execution trace section from function BEGIN
1018 (inclusive) to function END (inclusive). */
1019 void (*to_call_history_range
) (struct target_ops
*,
1020 ULONGEST begin
, ULONGEST end
, int flags
);
1022 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1024 int (*to_augmented_libraries_svr4_read
) (struct target_ops
*);
1026 /* Those unwinders are tried before any other arch unwinders. Use NULL if
1028 const struct frame_unwind
*to_get_unwinder
;
1029 const struct frame_unwind
*to_get_tailcall_unwinder
;
1031 /* Return the number of bytes by which the PC needs to be decremented
1032 after executing a breakpoint instruction.
1033 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
1034 CORE_ADDR (*to_decr_pc_after_break
) (struct target_ops
*ops
,
1035 struct gdbarch
*gdbarch
);
1038 /* Need sub-structure for target machine related rather than comm related?
1042 /* Magic number for checking ops size. If a struct doesn't end with this
1043 number, somebody changed the declaration but didn't change all the
1044 places that initialize one. */
1046 #define OPS_MAGIC 3840
1048 /* The ops structure for our "current" target process. This should
1049 never be NULL. If there is no target, it points to the dummy_target. */
1051 extern struct target_ops current_target
;
1053 /* Define easy words for doing these operations on our current target. */
1055 #define target_shortname (current_target.to_shortname)
1056 #define target_longname (current_target.to_longname)
1058 /* Does whatever cleanup is required for a target that we are no
1059 longer going to be calling. This routine is automatically always
1060 called after popping the target off the target stack - the target's
1061 own methods are no longer available through the target vector.
1062 Closing file descriptors and freeing all memory allocated memory are
1063 typical things it should do. */
1065 void target_close (struct target_ops
*targ
);
1067 /* Attaches to a process on the target side. Arguments are as passed
1068 to the `attach' command by the user. This routine can be called
1069 when the target is not on the target-stack, if the target_can_run
1070 routine returns 1; in that case, it must push itself onto the stack.
1071 Upon exit, the target should be ready for normal operations, and
1072 should be ready to deliver the status of the process immediately
1073 (without waiting) to an upcoming target_wait call. */
1075 void target_attach (char *, int);
1077 /* Some targets don't generate traps when attaching to the inferior,
1078 or their target_attach implementation takes care of the waiting.
1079 These targets must set to_attach_no_wait. */
1081 #define target_attach_no_wait \
1082 (current_target.to_attach_no_wait)
1084 /* The target_attach operation places a process under debugger control,
1085 and stops the process.
1087 This operation provides a target-specific hook that allows the
1088 necessary bookkeeping to be performed after an attach completes. */
1089 #define target_post_attach(pid) \
1090 (*current_target.to_post_attach) (¤t_target, pid)
1092 /* Takes a program previously attached to and detaches it.
1093 The program may resume execution (some targets do, some don't) and will
1094 no longer stop on signals, etc. We better not have left any breakpoints
1095 in the program or it'll die when it hits one. ARGS is arguments
1096 typed by the user (e.g. a signal to send the process). FROM_TTY
1097 says whether to be verbose or not. */
1099 extern void target_detach (const char *, int);
1101 /* Disconnect from the current target without resuming it (leaving it
1102 waiting for a debugger). */
1104 extern void target_disconnect (char *, int);
1106 /* Resume execution of the target process PTID (or a group of
1107 threads). STEP says whether to single-step or to run free; SIGGNAL
1108 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1109 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1110 PTID means `step/resume only this process id'. A wildcard PTID
1111 (all threads, or all threads of process) means `step/resume
1112 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1113 matches) resume with their 'thread->suspend.stop_signal' signal
1114 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1115 if in "no pass" state. */
1117 extern void target_resume (ptid_t ptid
, int step
, enum gdb_signal signal
);
1119 /* Wait for process pid to do something. PTID = -1 to wait for any
1120 pid to do something. Return pid of child, or -1 in case of error;
1121 store status through argument pointer STATUS. Note that it is
1122 _NOT_ OK to throw_exception() out of target_wait() without popping
1123 the debugging target from the stack; GDB isn't prepared to get back
1124 to the prompt with a debugging target but without the frame cache,
1125 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1128 extern ptid_t
target_wait (ptid_t ptid
, struct target_waitstatus
*status
,
1131 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1133 extern void target_fetch_registers (struct regcache
*regcache
, int regno
);
1135 /* Store at least register REGNO, or all regs if REGNO == -1.
1136 It can store as many registers as it wants to, so target_prepare_to_store
1137 must have been previously called. Calls error() if there are problems. */
1139 extern void target_store_registers (struct regcache
*regcache
, int regs
);
1141 /* Get ready to modify the registers array. On machines which store
1142 individual registers, this doesn't need to do anything. On machines
1143 which store all the registers in one fell swoop, this makes sure
1144 that REGISTERS contains all the registers from the program being
1147 #define target_prepare_to_store(regcache) \
1148 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1150 /* Determine current address space of thread PTID. */
1152 struct address_space
*target_thread_address_space (ptid_t
);
1154 /* Implement the "info proc" command. This returns one if the request
1155 was handled, and zero otherwise. It can also throw an exception if
1156 an error was encountered while attempting to handle the
1159 int target_info_proc (char *, enum info_proc_what
);
1161 /* Returns true if this target can debug multiple processes
1164 #define target_supports_multi_process() \
1165 (*current_target.to_supports_multi_process) (¤t_target)
1167 /* Returns true if this target can disable address space randomization. */
1169 int target_supports_disable_randomization (void);
1171 /* Returns true if this target can enable and disable tracepoints
1172 while a trace experiment is running. */
1174 #define target_supports_enable_disable_tracepoint() \
1175 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1177 #define target_supports_string_tracing() \
1178 (*current_target.to_supports_string_tracing) (¤t_target)
1180 /* Returns true if this target can handle breakpoint conditions
1183 #define target_supports_evaluation_of_breakpoint_conditions() \
1184 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1186 /* Returns true if this target can handle breakpoint commands
1189 #define target_can_run_breakpoint_commands() \
1190 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1192 extern int target_read_string (CORE_ADDR
, char **, int, int *);
1194 extern int target_read_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
1197 extern int target_read_raw_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
1200 extern int target_read_stack (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
);
1202 extern int target_read_code (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
);
1204 extern int target_write_memory (CORE_ADDR memaddr
, const gdb_byte
*myaddr
,
1207 extern int target_write_raw_memory (CORE_ADDR memaddr
, const gdb_byte
*myaddr
,
1210 /* Fetches the target's memory map. If one is found it is sorted
1211 and returned, after some consistency checking. Otherwise, NULL
1213 VEC(mem_region_s
) *target_memory_map (void);
1215 /* Erase the specified flash region. */
1216 void target_flash_erase (ULONGEST address
, LONGEST length
);
1218 /* Finish a sequence of flash operations. */
1219 void target_flash_done (void);
1221 /* Describes a request for a memory write operation. */
1222 struct memory_write_request
1224 /* Begining address that must be written. */
1226 /* Past-the-end address. */
1228 /* The data to write. */
1230 /* A callback baton for progress reporting for this request. */
1233 typedef struct memory_write_request memory_write_request_s
;
1234 DEF_VEC_O(memory_write_request_s
);
1236 /* Enumeration specifying different flash preservation behaviour. */
1237 enum flash_preserve_mode
1243 /* Write several memory blocks at once. This version can be more
1244 efficient than making several calls to target_write_memory, in
1245 particular because it can optimize accesses to flash memory.
1247 Moreover, this is currently the only memory access function in gdb
1248 that supports writing to flash memory, and it should be used for
1249 all cases where access to flash memory is desirable.
1251 REQUESTS is the vector (see vec.h) of memory_write_request.
1252 PRESERVE_FLASH_P indicates what to do with blocks which must be
1253 erased, but not completely rewritten.
1254 PROGRESS_CB is a function that will be periodically called to provide
1255 feedback to user. It will be called with the baton corresponding
1256 to the request currently being written. It may also be called
1257 with a NULL baton, when preserved flash sectors are being rewritten.
1259 The function returns 0 on success, and error otherwise. */
1260 int target_write_memory_blocks (VEC(memory_write_request_s
) *requests
,
1261 enum flash_preserve_mode preserve_flash_p
,
1262 void (*progress_cb
) (ULONGEST
, void *));
1264 /* Print a line about the current target. */
1266 #define target_files_info() \
1267 (*current_target.to_files_info) (¤t_target)
1269 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1270 the target machine. Returns 0 for success, and returns non-zero or
1271 throws an error (with a detailed failure reason error code and
1272 message) otherwise. */
1274 extern int target_insert_breakpoint (struct gdbarch
*gdbarch
,
1275 struct bp_target_info
*bp_tgt
);
1277 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1278 machine. Result is 0 for success, non-zero for error. */
1280 extern int target_remove_breakpoint (struct gdbarch
*gdbarch
,
1281 struct bp_target_info
*bp_tgt
);
1283 /* Initialize the terminal settings we record for the inferior,
1284 before we actually run the inferior. */
1286 #define target_terminal_init() \
1287 (*current_target.to_terminal_init) (¤t_target)
1289 /* Put the inferior's terminal settings into effect.
1290 This is preparation for starting or resuming the inferior. */
1292 extern void target_terminal_inferior (void);
1294 /* Put some of our terminal settings into effect,
1295 enough to get proper results from our output,
1296 but do not change into or out of RAW mode
1297 so that no input is discarded.
1299 After doing this, either terminal_ours or terminal_inferior
1300 should be called to get back to a normal state of affairs. */
1302 #define target_terminal_ours_for_output() \
1303 (*current_target.to_terminal_ours_for_output) (¤t_target)
1305 /* Put our terminal settings into effect.
1306 First record the inferior's terminal settings
1307 so they can be restored properly later. */
1309 #define target_terminal_ours() \
1310 (*current_target.to_terminal_ours) (¤t_target)
1312 /* Save our terminal settings.
1313 This is called from TUI after entering or leaving the curses
1314 mode. Since curses modifies our terminal this call is here
1315 to take this change into account. */
1317 #define target_terminal_save_ours() \
1318 (*current_target.to_terminal_save_ours) (¤t_target)
1320 /* Print useful information about our terminal status, if such a thing
1323 #define target_terminal_info(arg, from_tty) \
1324 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1326 /* Kill the inferior process. Make it go away. */
1328 extern void target_kill (void);
1330 /* Load an executable file into the target process. This is expected
1331 to not only bring new code into the target process, but also to
1332 update GDB's symbol tables to match.
1334 ARG contains command-line arguments, to be broken down with
1335 buildargv (). The first non-switch argument is the filename to
1336 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1337 0)), which is an offset to apply to the load addresses of FILE's
1338 sections. The target may define switches, or other non-switch
1339 arguments, as it pleases. */
1341 extern void target_load (char *arg
, int from_tty
);
1343 /* Start an inferior process and set inferior_ptid to its pid.
1344 EXEC_FILE is the file to run.
1345 ALLARGS is a string containing the arguments to the program.
1346 ENV is the environment vector to pass. Errors reported with error().
1347 On VxWorks and various standalone systems, we ignore exec_file. */
1349 void target_create_inferior (char *exec_file
, char *args
,
1350 char **env
, int from_tty
);
1352 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1353 notification of inferior events such as fork and vork immediately
1354 after the inferior is created. (This because of how gdb gets an
1355 inferior created via invoking a shell to do it. In such a scenario,
1356 if the shell init file has commands in it, the shell will fork and
1357 exec for each of those commands, and we will see each such fork
1360 Such targets will supply an appropriate definition for this function. */
1362 #define target_post_startup_inferior(ptid) \
1363 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1365 /* On some targets, we can catch an inferior fork or vfork event when
1366 it occurs. These functions insert/remove an already-created
1367 catchpoint for such events. They return 0 for success, 1 if the
1368 catchpoint type is not supported and -1 for failure. */
1370 #define target_insert_fork_catchpoint(pid) \
1371 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1373 #define target_remove_fork_catchpoint(pid) \
1374 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1376 #define target_insert_vfork_catchpoint(pid) \
1377 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1379 #define target_remove_vfork_catchpoint(pid) \
1380 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1382 /* If the inferior forks or vforks, this function will be called at
1383 the next resume in order to perform any bookkeeping and fiddling
1384 necessary to continue debugging either the parent or child, as
1385 requested, and releasing the other. Information about the fork
1386 or vfork event is available via get_last_target_status ().
1387 This function returns 1 if the inferior should not be resumed
1388 (i.e. there is another event pending). */
1390 int target_follow_fork (int follow_child
, int detach_fork
);
1392 /* On some targets, we can catch an inferior exec event when it
1393 occurs. These functions insert/remove an already-created
1394 catchpoint for such events. They return 0 for success, 1 if the
1395 catchpoint type is not supported and -1 for failure. */
1397 #define target_insert_exec_catchpoint(pid) \
1398 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1400 #define target_remove_exec_catchpoint(pid) \
1401 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1405 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1406 If NEEDED is zero, it means the target can disable the mechanism to
1407 catch system calls because there are no more catchpoints of this type.
1409 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1410 being requested. In this case, both TABLE_SIZE and TABLE should
1413 TABLE_SIZE is the number of elements in TABLE. It only matters if
1416 TABLE is an array of ints, indexed by syscall number. An element in
1417 this array is nonzero if that syscall should be caught. This argument
1418 only matters if ANY_COUNT is zero.
1420 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1423 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1424 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1425 pid, needed, any_count, \
1428 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1429 exit code of PID, if any. */
1431 #define target_has_exited(pid,wait_status,exit_status) \
1432 (*current_target.to_has_exited) (¤t_target, \
1433 pid,wait_status,exit_status)
1435 /* The debugger has completed a blocking wait() call. There is now
1436 some process event that must be processed. This function should
1437 be defined by those targets that require the debugger to perform
1438 cleanup or internal state changes in response to the process event. */
1440 /* The inferior process has died. Do what is right. */
1442 void target_mourn_inferior (void);
1444 /* Does target have enough data to do a run or attach command? */
1446 #define target_can_run(t) \
1447 ((t)->to_can_run) (t)
1449 /* Set list of signals to be handled in the target.
1451 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1452 (enum gdb_signal). For every signal whose entry in this array is
1453 non-zero, the target is allowed -but not required- to skip reporting
1454 arrival of the signal to the GDB core by returning from target_wait,
1455 and to pass the signal directly to the inferior instead.
1457 However, if the target is hardware single-stepping a thread that is
1458 about to receive a signal, it needs to be reported in any case, even
1459 if mentioned in a previous target_pass_signals call. */
1461 extern void target_pass_signals (int nsig
, unsigned char *pass_signals
);
1463 /* Set list of signals the target may pass to the inferior. This
1464 directly maps to the "handle SIGNAL pass/nopass" setting.
1466 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1467 number (enum gdb_signal). For every signal whose entry in this
1468 array is non-zero, the target is allowed to pass the signal to the
1469 inferior. Signals not present in the array shall be silently
1470 discarded. This does not influence whether to pass signals to the
1471 inferior as a result of a target_resume call. This is useful in
1472 scenarios where the target needs to decide whether to pass or not a
1473 signal to the inferior without GDB core involvement, such as for
1474 example, when detaching (as threads may have been suspended with
1475 pending signals not reported to GDB). */
1477 extern void target_program_signals (int nsig
, unsigned char *program_signals
);
1479 /* Check to see if a thread is still alive. */
1481 extern int target_thread_alive (ptid_t ptid
);
1483 /* Query for new threads and add them to the thread list. */
1485 extern void target_find_new_threads (void);
1487 /* Make target stop in a continuable fashion. (For instance, under
1488 Unix, this should act like SIGSTOP). This function is normally
1489 used by GUIs to implement a stop button. */
1491 extern void target_stop (ptid_t ptid
);
1493 /* Send the specified COMMAND to the target's monitor
1494 (shell,interpreter) for execution. The result of the query is
1495 placed in OUTBUF. */
1497 #define target_rcmd(command, outbuf) \
1498 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1501 /* Does the target include all of memory, or only part of it? This
1502 determines whether we look up the target chain for other parts of
1503 memory if this target can't satisfy a request. */
1505 extern int target_has_all_memory_1 (void);
1506 #define target_has_all_memory target_has_all_memory_1 ()
1508 /* Does the target include memory? (Dummy targets don't.) */
1510 extern int target_has_memory_1 (void);
1511 #define target_has_memory target_has_memory_1 ()
1513 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1514 we start a process.) */
1516 extern int target_has_stack_1 (void);
1517 #define target_has_stack target_has_stack_1 ()
1519 /* Does the target have registers? (Exec files don't.) */
1521 extern int target_has_registers_1 (void);
1522 #define target_has_registers target_has_registers_1 ()
1524 /* Does the target have execution? Can we make it jump (through
1525 hoops), or pop its stack a few times? This means that the current
1526 target is currently executing; for some targets, that's the same as
1527 whether or not the target is capable of execution, but there are
1528 also targets which can be current while not executing. In that
1529 case this will become true after target_create_inferior or
1532 extern int target_has_execution_1 (ptid_t
);
1534 /* Like target_has_execution_1, but always passes inferior_ptid. */
1536 extern int target_has_execution_current (void);
1538 #define target_has_execution target_has_execution_current ()
1540 /* Default implementations for process_stratum targets. Return true
1541 if there's a selected inferior, false otherwise. */
1543 extern int default_child_has_all_memory (struct target_ops
*ops
);
1544 extern int default_child_has_memory (struct target_ops
*ops
);
1545 extern int default_child_has_stack (struct target_ops
*ops
);
1546 extern int default_child_has_registers (struct target_ops
*ops
);
1547 extern int default_child_has_execution (struct target_ops
*ops
,
1550 /* Can the target support the debugger control of thread execution?
1551 Can it lock the thread scheduler? */
1553 #define target_can_lock_scheduler \
1554 (current_target.to_has_thread_control & tc_schedlock)
1556 /* Should the target enable async mode if it is supported? Temporary
1557 cludge until async mode is a strict superset of sync mode. */
1558 extern int target_async_permitted
;
1560 /* Can the target support asynchronous execution? */
1561 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1563 /* Is the target in asynchronous execution mode? */
1564 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1566 int target_supports_non_stop (void);
1568 /* Put the target in async mode with the specified callback function. */
1569 #define target_async(CALLBACK,CONTEXT) \
1570 (current_target.to_async (¤t_target, (CALLBACK), (CONTEXT)))
1572 #define target_execution_direction() \
1573 (current_target.to_execution_direction (¤t_target))
1575 /* Converts a process id to a string. Usually, the string just contains
1576 `process xyz', but on some systems it may contain
1577 `process xyz thread abc'. */
1579 extern char *target_pid_to_str (ptid_t ptid
);
1581 extern char *normal_pid_to_str (ptid_t ptid
);
1583 /* Return a short string describing extra information about PID,
1584 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1587 #define target_extra_thread_info(TP) \
1588 (current_target.to_extra_thread_info (¤t_target, TP))
1590 /* Return the thread's name. A NULL result means that the target
1591 could not determine this thread's name. */
1593 extern char *target_thread_name (struct thread_info
*);
1595 /* Attempts to find the pathname of the executable file
1596 that was run to create a specified process.
1598 The process PID must be stopped when this operation is used.
1600 If the executable file cannot be determined, NULL is returned.
1602 Else, a pointer to a character string containing the pathname
1603 is returned. This string should be copied into a buffer by
1604 the client if the string will not be immediately used, or if
1607 #define target_pid_to_exec_file(pid) \
1608 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1610 /* See the to_thread_architecture description in struct target_ops. */
1612 #define target_thread_architecture(ptid) \
1613 (current_target.to_thread_architecture (¤t_target, ptid))
1616 * Iterator function for target memory regions.
1617 * Calls a callback function once for each memory region 'mapped'
1618 * in the child process. Defined as a simple macro rather than
1619 * as a function macro so that it can be tested for nullity.
1622 #define target_find_memory_regions(FUNC, DATA) \
1623 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1626 * Compose corefile .note section.
1629 #define target_make_corefile_notes(BFD, SIZE_P) \
1630 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1632 /* Bookmark interfaces. */
1633 #define target_get_bookmark(ARGS, FROM_TTY) \
1634 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1636 #define target_goto_bookmark(ARG, FROM_TTY) \
1637 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1639 /* Hardware watchpoint interfaces. */
1641 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1642 write). Only the INFERIOR_PTID task is being queried. */
1644 #define target_stopped_by_watchpoint() \
1645 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1647 /* Non-zero if we have steppable watchpoints */
1649 #define target_have_steppable_watchpoint \
1650 (current_target.to_have_steppable_watchpoint)
1652 /* Non-zero if we have continuable watchpoints */
1654 #define target_have_continuable_watchpoint \
1655 (current_target.to_have_continuable_watchpoint)
1657 /* Provide defaults for hardware watchpoint functions. */
1659 /* If the *_hw_beakpoint functions have not been defined
1660 elsewhere use the definitions in the target vector. */
1662 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1663 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1664 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1665 (including this one?). OTHERTYPE is who knows what... */
1667 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1668 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1669 TYPE, CNT, OTHERTYPE);
1671 /* Returns the number of debug registers needed to watch the given
1672 memory region, or zero if not supported. */
1674 #define target_region_ok_for_hw_watchpoint(addr, len) \
1675 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1679 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1680 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1681 COND is the expression for its condition, or NULL if there's none.
1682 Returns 0 for success, 1 if the watchpoint type is not supported,
1685 #define target_insert_watchpoint(addr, len, type, cond) \
1686 (*current_target.to_insert_watchpoint) (¤t_target, \
1687 addr, len, type, cond)
1689 #define target_remove_watchpoint(addr, len, type, cond) \
1690 (*current_target.to_remove_watchpoint) (¤t_target, \
1691 addr, len, type, cond)
1693 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1694 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1695 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1696 masked watchpoints are not supported, -1 for failure. */
1698 extern int target_insert_mask_watchpoint (CORE_ADDR
, CORE_ADDR
, int);
1700 /* Remove a masked watchpoint at ADDR with the mask MASK.
1701 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1702 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1705 extern int target_remove_mask_watchpoint (CORE_ADDR
, CORE_ADDR
, int);
1707 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1708 the target machine. Returns 0 for success, and returns non-zero or
1709 throws an error (with a detailed failure reason error code and
1710 message) otherwise. */
1712 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1713 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1716 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1717 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1720 /* Return number of debug registers needed for a ranged breakpoint,
1721 or -1 if ranged breakpoints are not supported. */
1723 extern int target_ranged_break_num_registers (void);
1725 /* Return non-zero if target knows the data address which triggered this
1726 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1727 INFERIOR_PTID task is being queried. */
1728 #define target_stopped_data_address(target, addr_p) \
1729 (*target.to_stopped_data_address) (target, addr_p)
1731 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1732 LENGTH bytes beginning at START. */
1733 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1734 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1736 /* Return non-zero if the target is capable of using hardware to evaluate
1737 the condition expression. In this case, if the condition is false when
1738 the watched memory location changes, execution may continue without the
1739 debugger being notified.
1741 Due to limitations in the hardware implementation, it may be capable of
1742 avoiding triggering the watchpoint in some cases where the condition
1743 expression is false, but may report some false positives as well.
1744 For this reason, GDB will still evaluate the condition expression when
1745 the watchpoint triggers. */
1746 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1747 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1748 addr, len, type, cond)
1750 /* Return number of debug registers needed for a masked watchpoint,
1751 -1 if masked watchpoints are not supported or -2 if the given address
1752 and mask combination cannot be used. */
1754 extern int target_masked_watch_num_registers (CORE_ADDR addr
, CORE_ADDR mask
);
1756 /* Target can execute in reverse? */
1757 #define target_can_execute_reverse \
1758 (current_target.to_can_execute_reverse ? \
1759 current_target.to_can_execute_reverse (¤t_target) : 0)
1761 extern const struct target_desc
*target_read_description (struct target_ops
*);
1763 #define target_get_ada_task_ptid(lwp, tid) \
1764 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1766 /* Utility implementation of searching memory. */
1767 extern int simple_search_memory (struct target_ops
* ops
,
1768 CORE_ADDR start_addr
,
1769 ULONGEST search_space_len
,
1770 const gdb_byte
*pattern
,
1771 ULONGEST pattern_len
,
1772 CORE_ADDR
*found_addrp
);
1774 /* Main entry point for searching memory. */
1775 extern int target_search_memory (CORE_ADDR start_addr
,
1776 ULONGEST search_space_len
,
1777 const gdb_byte
*pattern
,
1778 ULONGEST pattern_len
,
1779 CORE_ADDR
*found_addrp
);
1781 /* Target file operations. */
1783 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1784 target file descriptor, or -1 if an error occurs (and set
1786 extern int target_fileio_open (const char *filename
, int flags
, int mode
,
1789 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1790 Return the number of bytes written, or -1 if an error occurs
1791 (and set *TARGET_ERRNO). */
1792 extern int target_fileio_pwrite (int fd
, const gdb_byte
*write_buf
, int len
,
1793 ULONGEST offset
, int *target_errno
);
1795 /* Read up to LEN bytes FD on the target into READ_BUF.
1796 Return the number of bytes read, or -1 if an error occurs
1797 (and set *TARGET_ERRNO). */
1798 extern int target_fileio_pread (int fd
, gdb_byte
*read_buf
, int len
,
1799 ULONGEST offset
, int *target_errno
);
1801 /* Close FD on the target. Return 0, or -1 if an error occurs
1802 (and set *TARGET_ERRNO). */
1803 extern int target_fileio_close (int fd
, int *target_errno
);
1805 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1806 occurs (and set *TARGET_ERRNO). */
1807 extern int target_fileio_unlink (const char *filename
, int *target_errno
);
1809 /* Read value of symbolic link FILENAME on the target. Return a
1810 null-terminated string allocated via xmalloc, or NULL if an error
1811 occurs (and set *TARGET_ERRNO). */
1812 extern char *target_fileio_readlink (const char *filename
, int *target_errno
);
1814 /* Read target file FILENAME. The return value will be -1 if the transfer
1815 fails or is not supported; 0 if the object is empty; or the length
1816 of the object otherwise. If a positive value is returned, a
1817 sufficiently large buffer will be allocated using xmalloc and
1818 returned in *BUF_P containing the contents of the object.
1820 This method should be used for objects sufficiently small to store
1821 in a single xmalloc'd buffer, when no fixed bound on the object's
1822 size is known in advance. */
1823 extern LONGEST
target_fileio_read_alloc (const char *filename
,
1826 /* Read target file FILENAME. The result is NUL-terminated and
1827 returned as a string, allocated using xmalloc. If an error occurs
1828 or the transfer is unsupported, NULL is returned. Empty objects
1829 are returned as allocated but empty strings. A warning is issued
1830 if the result contains any embedded NUL bytes. */
1831 extern char *target_fileio_read_stralloc (const char *filename
);
1834 /* Tracepoint-related operations. */
1836 #define target_trace_init() \
1837 (*current_target.to_trace_init) (¤t_target)
1839 #define target_download_tracepoint(t) \
1840 (*current_target.to_download_tracepoint) (¤t_target, t)
1842 #define target_can_download_tracepoint() \
1843 (*current_target.to_can_download_tracepoint) (¤t_target)
1845 #define target_download_trace_state_variable(tsv) \
1846 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1848 #define target_enable_tracepoint(loc) \
1849 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1851 #define target_disable_tracepoint(loc) \
1852 (*current_target.to_disable_tracepoint) (¤t_target, loc)
1854 #define target_trace_start() \
1855 (*current_target.to_trace_start) (¤t_target)
1857 #define target_trace_set_readonly_regions() \
1858 (*current_target.to_trace_set_readonly_regions) (¤t_target)
1860 #define target_get_trace_status(ts) \
1861 (*current_target.to_get_trace_status) (¤t_target, ts)
1863 #define target_get_tracepoint_status(tp,utp) \
1864 (*current_target.to_get_tracepoint_status) (¤t_target, tp, utp)
1866 #define target_trace_stop() \
1867 (*current_target.to_trace_stop) (¤t_target)
1869 #define target_trace_find(type,num,addr1,addr2,tpp) \
1870 (*current_target.to_trace_find) (¤t_target, \
1871 (type), (num), (addr1), (addr2), (tpp))
1873 #define target_get_trace_state_variable_value(tsv,val) \
1874 (*current_target.to_get_trace_state_variable_value) (¤t_target, \
1877 #define target_save_trace_data(filename) \
1878 (*current_target.to_save_trace_data) (¤t_target, filename)
1880 #define target_upload_tracepoints(utpp) \
1881 (*current_target.to_upload_tracepoints) (¤t_target, utpp)
1883 #define target_upload_trace_state_variables(utsvp) \
1884 (*current_target.to_upload_trace_state_variables) (¤t_target, utsvp)
1886 #define target_get_raw_trace_data(buf,offset,len) \
1887 (*current_target.to_get_raw_trace_data) (¤t_target, \
1888 (buf), (offset), (len))
1890 #define target_get_min_fast_tracepoint_insn_len() \
1891 (*current_target.to_get_min_fast_tracepoint_insn_len) (¤t_target)
1893 #define target_set_disconnected_tracing(val) \
1894 (*current_target.to_set_disconnected_tracing) (¤t_target, val)
1896 #define target_set_circular_trace_buffer(val) \
1897 (*current_target.to_set_circular_trace_buffer) (¤t_target, val)
1899 #define target_set_trace_buffer_size(val) \
1900 (*current_target.to_set_trace_buffer_size) (¤t_target, val)
1902 #define target_set_trace_notes(user,notes,stopnotes) \
1903 (*current_target.to_set_trace_notes) (¤t_target, \
1904 (user), (notes), (stopnotes))
1906 #define target_get_tib_address(ptid, addr) \
1907 (*current_target.to_get_tib_address) (¤t_target, (ptid), (addr))
1909 #define target_set_permissions() \
1910 (*current_target.to_set_permissions) (¤t_target)
1912 #define target_static_tracepoint_marker_at(addr, marker) \
1913 (*current_target.to_static_tracepoint_marker_at) (¤t_target, \
1916 #define target_static_tracepoint_markers_by_strid(marker_id) \
1917 (*current_target.to_static_tracepoint_markers_by_strid) (¤t_target, \
1920 #define target_traceframe_info() \
1921 (*current_target.to_traceframe_info) (¤t_target)
1923 #define target_use_agent(use) \
1924 (*current_target.to_use_agent) (¤t_target, use)
1926 #define target_can_use_agent() \
1927 (*current_target.to_can_use_agent) (¤t_target)
1929 #define target_augmented_libraries_svr4_read() \
1930 (*current_target.to_augmented_libraries_svr4_read) (¤t_target)
1932 /* Command logging facility. */
1934 #define target_log_command(p) \
1935 (*current_target.to_log_command) (¤t_target, p)
1938 extern int target_core_of_thread (ptid_t ptid
);
1940 /* See to_get_unwinder in struct target_ops. */
1941 extern const struct frame_unwind
*target_get_unwinder (void);
1943 /* See to_get_tailcall_unwinder in struct target_ops. */
1944 extern const struct frame_unwind
*target_get_tailcall_unwinder (void);
1946 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1947 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1948 if there's a mismatch, and -1 if an error is encountered while
1949 reading memory. Throws an error if the functionality is found not
1950 to be supported by the current target. */
1951 int target_verify_memory (const gdb_byte
*data
,
1952 CORE_ADDR memaddr
, ULONGEST size
);
1954 /* Routines for maintenance of the target structures...
1956 complete_target_initialization: Finalize a target_ops by filling in
1957 any fields needed by the target implementation.
1959 add_target: Add a target to the list of all possible targets.
1961 push_target: Make this target the top of the stack of currently used
1962 targets, within its particular stratum of the stack. Result
1963 is 0 if now atop the stack, nonzero if not on top (maybe
1966 unpush_target: Remove this from the stack of currently used targets,
1967 no matter where it is on the list. Returns 0 if no
1968 change, 1 if removed from stack. */
1970 extern void add_target (struct target_ops
*);
1972 extern void add_target_with_completer (struct target_ops
*t
,
1973 completer_ftype
*completer
);
1975 extern void complete_target_initialization (struct target_ops
*t
);
1977 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
1978 for maintaining backwards compatibility when renaming targets. */
1980 extern void add_deprecated_target_alias (struct target_ops
*t
, char *alias
);
1982 extern void push_target (struct target_ops
*);
1984 extern int unpush_target (struct target_ops
*);
1986 extern void target_pre_inferior (int);
1988 extern void target_preopen (int);
1990 /* Does whatever cleanup is required to get rid of all pushed targets. */
1991 extern void pop_all_targets (void);
1993 /* Like pop_all_targets, but pops only targets whose stratum is
1994 strictly above ABOVE_STRATUM. */
1995 extern void pop_all_targets_above (enum strata above_stratum
);
1997 extern int target_is_pushed (struct target_ops
*t
);
1999 extern CORE_ADDR
target_translate_tls_address (struct objfile
*objfile
,
2002 /* Struct target_section maps address ranges to file sections. It is
2003 mostly used with BFD files, but can be used without (e.g. for handling
2004 raw disks, or files not in formats handled by BFD). */
2006 struct target_section
2008 CORE_ADDR addr
; /* Lowest address in section */
2009 CORE_ADDR endaddr
; /* 1+highest address in section */
2011 struct bfd_section
*the_bfd_section
;
2013 /* The "owner" of the section.
2014 It can be any unique value. It is set by add_target_sections
2015 and used by remove_target_sections.
2016 For example, for executables it is a pointer to exec_bfd and
2017 for shlibs it is the so_list pointer. */
2021 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2023 struct target_section_table
2025 struct target_section
*sections
;
2026 struct target_section
*sections_end
;
2029 /* Return the "section" containing the specified address. */
2030 struct target_section
*target_section_by_addr (struct target_ops
*target
,
2033 /* Return the target section table this target (or the targets
2034 beneath) currently manipulate. */
2036 extern struct target_section_table
*target_get_section_table
2037 (struct target_ops
*target
);
2039 /* From mem-break.c */
2041 extern int memory_remove_breakpoint (struct target_ops
*, struct gdbarch
*,
2042 struct bp_target_info
*);
2044 extern int memory_insert_breakpoint (struct target_ops
*, struct gdbarch
*,
2045 struct bp_target_info
*);
2047 extern int default_memory_remove_breakpoint (struct gdbarch
*,
2048 struct bp_target_info
*);
2050 extern int default_memory_insert_breakpoint (struct gdbarch
*,
2051 struct bp_target_info
*);
2056 extern void initialize_targets (void);
2058 extern void noprocess (void) ATTRIBUTE_NORETURN
;
2060 extern void target_require_runnable (void);
2062 extern void find_default_attach (struct target_ops
*, char *, int);
2064 extern void find_default_create_inferior (struct target_ops
*,
2065 char *, char *, char **, int);
2067 extern struct target_ops
*find_target_beneath (struct target_ops
*);
2069 /* Find the target at STRATUM. If no target is at that stratum,
2072 struct target_ops
*find_target_at (enum strata stratum
);
2074 /* Read OS data object of type TYPE from the target, and return it in
2075 XML format. The result is NUL-terminated and returned as a string,
2076 allocated using xmalloc. If an error occurs or the transfer is
2077 unsupported, NULL is returned. Empty objects are returned as
2078 allocated but empty strings. */
2080 extern char *target_get_osdata (const char *type
);
2083 /* Stuff that should be shared among the various remote targets. */
2085 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2086 information (higher values, more information). */
2087 extern int remote_debug
;
2089 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2090 extern int baud_rate
;
2091 /* Timeout limit for response from target. */
2092 extern int remote_timeout
;
2096 /* Set the show memory breakpoints mode to show, and installs a cleanup
2097 to restore it back to the current value. */
2098 extern struct cleanup
*make_show_memory_breakpoints_cleanup (int show
);
2100 extern int may_write_registers
;
2101 extern int may_write_memory
;
2102 extern int may_insert_breakpoints
;
2103 extern int may_insert_tracepoints
;
2104 extern int may_insert_fast_tracepoints
;
2105 extern int may_stop
;
2107 extern void update_target_permissions (void);
2110 /* Imported from machine dependent code. */
2112 /* Blank target vector entries are initialized to target_ignore. */
2113 void target_ignore (void);
2115 /* See to_supports_btrace in struct target_ops. */
2116 #define target_supports_btrace() \
2117 (current_target.to_supports_btrace (¤t_target))
2119 /* See to_enable_btrace in struct target_ops. */
2120 extern struct btrace_target_info
*target_enable_btrace (ptid_t ptid
);
2122 /* See to_disable_btrace in struct target_ops. */
2123 extern void target_disable_btrace (struct btrace_target_info
*btinfo
);
2125 /* See to_teardown_btrace in struct target_ops. */
2126 extern void target_teardown_btrace (struct btrace_target_info
*btinfo
);
2128 /* See to_read_btrace in struct target_ops. */
2129 extern enum btrace_error
target_read_btrace (VEC (btrace_block_s
) **,
2130 struct btrace_target_info
*,
2131 enum btrace_read_type
);
2133 /* See to_stop_recording in struct target_ops. */
2134 extern void target_stop_recording (void);
2136 /* See to_info_record in struct target_ops. */
2137 extern void target_info_record (void);
2139 /* See to_save_record in struct target_ops. */
2140 extern void target_save_record (const char *filename
);
2142 /* Query if the target supports deleting the execution log. */
2143 extern int target_supports_delete_record (void);
2145 /* See to_delete_record in struct target_ops. */
2146 extern void target_delete_record (void);
2148 /* See to_record_is_replaying in struct target_ops. */
2149 extern int target_record_is_replaying (void);
2151 /* See to_goto_record_begin in struct target_ops. */
2152 extern void target_goto_record_begin (void);
2154 /* See to_goto_record_end in struct target_ops. */
2155 extern void target_goto_record_end (void);
2157 /* See to_goto_record in struct target_ops. */
2158 extern void target_goto_record (ULONGEST insn
);
2160 /* See to_insn_history. */
2161 extern void target_insn_history (int size
, int flags
);
2163 /* See to_insn_history_from. */
2164 extern void target_insn_history_from (ULONGEST from
, int size
, int flags
);
2166 /* See to_insn_history_range. */
2167 extern void target_insn_history_range (ULONGEST begin
, ULONGEST end
, int flags
);
2169 /* See to_call_history. */
2170 extern void target_call_history (int size
, int flags
);
2172 /* See to_call_history_from. */
2173 extern void target_call_history_from (ULONGEST begin
, int size
, int flags
);
2175 /* See to_call_history_range. */
2176 extern void target_call_history_range (ULONGEST begin
, ULONGEST end
, int flags
);
2178 /* See to_decr_pc_after_break. Start searching for the target at OPS. */
2179 extern CORE_ADDR
forward_target_decr_pc_after_break (struct target_ops
*ops
,
2180 struct gdbarch
*gdbarch
);
2182 /* See to_decr_pc_after_break. */
2183 extern CORE_ADDR
target_decr_pc_after_break (struct gdbarch
*gdbarch
);
2185 #endif /* !defined (TARGET_H) */