1 /* Interface between GDB and target environments, including files and processes
3 Copyright (C) 1990-2015 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/target.h"
62 #include "target/resume.h"
63 #include "target/wait.h"
64 #include "target/waitstatus.h"
69 #include "gdb_signals.h"
75 dummy_stratum
, /* The lowest of the low */
76 file_stratum
, /* Executable files, etc */
77 process_stratum
, /* Executing processes or core dump files */
78 thread_stratum
, /* Executing threads */
79 record_stratum
, /* Support record debugging */
80 arch_stratum
/* Architecture overrides */
83 enum thread_control_capabilities
85 tc_none
= 0, /* Default: can't control thread execution. */
86 tc_schedlock
= 1, /* Can lock the thread scheduler. */
89 /* The structure below stores information about a system call.
90 It is basically used in the "catch syscall" command, and in
91 every function that gives information about a system call.
93 It's also good to mention that its fields represent everything
94 that we currently know about a syscall in GDB. */
97 /* The syscall number. */
100 /* The syscall name. */
104 /* Return a pretty printed form of target_waitstatus.
105 Space for the result is malloc'd, caller must free. */
106 extern char *target_waitstatus_to_string (const struct target_waitstatus
*);
108 /* Return a pretty printed form of TARGET_OPTIONS.
109 Space for the result is malloc'd, caller must free. */
110 extern char *target_options_to_string (int target_options
);
112 /* Possible types of events that the inferior handler will have to
114 enum inferior_event_type
116 /* Process a normal inferior event which will result in target_wait
119 /* We are called because a timer went off. */
121 /* We are called to do stuff after the inferior stops. */
123 /* We are called to do some stuff after the inferior stops, but we
124 are expected to reenter the proceed() and
125 handle_inferior_event() functions. This is used only in case of
126 'step n' like commands. */
130 /* Target objects which can be transfered using target_read,
131 target_write, et cetera. */
135 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
137 /* SPU target specific transfer. See "spu-tdep.c". */
139 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
140 TARGET_OBJECT_MEMORY
,
141 /* Memory, avoiding GDB's data cache and trusting the executable.
142 Target implementations of to_xfer_partial never need to handle
143 this object, and most callers should not use it. */
144 TARGET_OBJECT_RAW_MEMORY
,
145 /* Memory known to be part of the target's stack. This is cached even
146 if it is not in a region marked as such, since it is known to be
148 TARGET_OBJECT_STACK_MEMORY
,
149 /* Memory known to be part of the target code. This is cached even
150 if it is not in a region marked as such. */
151 TARGET_OBJECT_CODE_MEMORY
,
152 /* Kernel Unwind Table. See "ia64-tdep.c". */
153 TARGET_OBJECT_UNWIND_TABLE
,
154 /* Transfer auxilliary vector. */
156 /* StackGhost cookie. See "sparc-tdep.c". */
157 TARGET_OBJECT_WCOOKIE
,
158 /* Target memory map in XML format. */
159 TARGET_OBJECT_MEMORY_MAP
,
160 /* Flash memory. This object can be used to write contents to
161 a previously erased flash memory. Using it without erasing
162 flash can have unexpected results. Addresses are physical
163 address on target, and not relative to flash start. */
165 /* Available target-specific features, e.g. registers and coprocessors.
166 See "target-descriptions.c". ANNEX should never be empty. */
167 TARGET_OBJECT_AVAILABLE_FEATURES
,
168 /* Currently loaded libraries, in XML format. */
169 TARGET_OBJECT_LIBRARIES
,
170 /* Currently loaded libraries specific for SVR4 systems, in XML format. */
171 TARGET_OBJECT_LIBRARIES_SVR4
,
172 /* Currently loaded libraries specific to AIX systems, in XML format. */
173 TARGET_OBJECT_LIBRARIES_AIX
,
174 /* Get OS specific data. The ANNEX specifies the type (running
175 processes, etc.). The data being transfered is expected to follow
176 the DTD specified in features/osdata.dtd. */
177 TARGET_OBJECT_OSDATA
,
178 /* Extra signal info. Usually the contents of `siginfo_t' on unix
180 TARGET_OBJECT_SIGNAL_INFO
,
181 /* The list of threads that are being debugged. */
182 TARGET_OBJECT_THREADS
,
183 /* Collected static trace data. */
184 TARGET_OBJECT_STATIC_TRACE_DATA
,
185 /* The HP-UX registers (those that can be obtained or modified by using
186 the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests). */
187 TARGET_OBJECT_HPUX_UREGS
,
188 /* The HP-UX shared library linkage pointer. ANNEX should be a string
189 image of the code address whose linkage pointer we are looking for.
191 The size of the data transfered is always 8 bytes (the size of an
193 TARGET_OBJECT_HPUX_SOLIB_GOT
,
194 /* Traceframe info, in XML format. */
195 TARGET_OBJECT_TRACEFRAME_INFO
,
196 /* Load maps for FDPIC systems. */
198 /* Darwin dynamic linker info data. */
199 TARGET_OBJECT_DARWIN_DYLD_INFO
,
200 /* OpenVMS Unwind Information Block. */
201 TARGET_OBJECT_OPENVMS_UIB
,
202 /* Branch trace data, in XML format. */
203 TARGET_OBJECT_BTRACE
,
204 /* Branch trace configuration, in XML format. */
205 TARGET_OBJECT_BTRACE_CONF
206 /* Possible future objects: TARGET_OBJECT_FILE, ... */
209 /* Possible values returned by target_xfer_partial, etc. */
211 enum target_xfer_status
213 /* Some bytes are transferred. */
216 /* No further transfer is possible. */
219 /* The piece of the object requested is unavailable. */
220 TARGET_XFER_UNAVAILABLE
= 2,
222 /* Generic I/O error. Note that it's important that this is '-1',
223 as we still have target_xfer-related code returning hardcoded
225 TARGET_XFER_E_IO
= -1,
227 /* Keep list in sync with target_xfer_status_to_string. */
230 /* Return the string form of STATUS. */
233 target_xfer_status_to_string (enum target_xfer_status status
);
235 /* Enumeration of the kinds of traceframe searches that a target may
236 be able to perform. */
247 typedef struct static_tracepoint_marker
*static_tracepoint_marker_p
;
248 DEF_VEC_P(static_tracepoint_marker_p
);
250 typedef enum target_xfer_status
251 target_xfer_partial_ftype (struct target_ops
*ops
,
252 enum target_object object
,
255 const gdb_byte
*writebuf
,
258 ULONGEST
*xfered_len
);
260 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
261 OBJECT. The OFFSET, for a seekable object, specifies the
262 starting point. The ANNEX can be used to provide additional
263 data-specific information to the target.
265 Return the number of bytes actually transfered, or a negative error
266 code (an 'enum target_xfer_error' value) if the transfer is not
267 supported or otherwise fails. Return of a positive value less than
268 LEN indicates that no further transfer is possible. Unlike the raw
269 to_xfer_partial interface, callers of these functions do not need
270 to retry partial transfers. */
272 extern LONGEST
target_read (struct target_ops
*ops
,
273 enum target_object object
,
274 const char *annex
, gdb_byte
*buf
,
275 ULONGEST offset
, LONGEST len
);
277 struct memory_read_result
279 /* First address that was read. */
281 /* Past-the-end address. */
286 typedef struct memory_read_result memory_read_result_s
;
287 DEF_VEC_O(memory_read_result_s
);
289 extern void free_memory_read_result_vector (void *);
291 extern VEC(memory_read_result_s
)* read_memory_robust (struct target_ops
*ops
,
295 extern LONGEST
target_write (struct target_ops
*ops
,
296 enum target_object object
,
297 const char *annex
, const gdb_byte
*buf
,
298 ULONGEST offset
, LONGEST len
);
300 /* Similar to target_write, except that it also calls PROGRESS with
301 the number of bytes written and the opaque BATON after every
302 successful partial write (and before the first write). This is
303 useful for progress reporting and user interaction while writing
304 data. To abort the transfer, the progress callback can throw an
307 LONGEST
target_write_with_progress (struct target_ops
*ops
,
308 enum target_object object
,
309 const char *annex
, const gdb_byte
*buf
,
310 ULONGEST offset
, LONGEST len
,
311 void (*progress
) (ULONGEST
, void *),
314 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
315 be read using OPS. The return value will be -1 if the transfer
316 fails or is not supported; 0 if the object is empty; or the length
317 of the object otherwise. If a positive value is returned, a
318 sufficiently large buffer will be allocated using xmalloc and
319 returned in *BUF_P containing the contents of the object.
321 This method should be used for objects sufficiently small to store
322 in a single xmalloc'd buffer, when no fixed bound on the object's
323 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
324 through this function. */
326 extern LONGEST
target_read_alloc (struct target_ops
*ops
,
327 enum target_object object
,
328 const char *annex
, gdb_byte
**buf_p
);
330 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
331 returned as a string, allocated using xmalloc. If an error occurs
332 or the transfer is unsupported, NULL is returned. Empty objects
333 are returned as allocated but empty strings. A warning is issued
334 if the result contains any embedded NUL bytes. */
336 extern char *target_read_stralloc (struct target_ops
*ops
,
337 enum target_object object
,
340 /* See target_ops->to_xfer_partial. */
341 extern target_xfer_partial_ftype target_xfer_partial
;
343 /* Wrappers to target read/write that perform memory transfers. They
344 throw an error if the memory transfer fails.
346 NOTE: cagney/2003-10-23: The naming schema is lifted from
347 "frame.h". The parameter order is lifted from get_frame_memory,
348 which in turn lifted it from read_memory. */
350 extern void get_target_memory (struct target_ops
*ops
, CORE_ADDR addr
,
351 gdb_byte
*buf
, LONGEST len
);
352 extern ULONGEST
get_target_memory_unsigned (struct target_ops
*ops
,
353 CORE_ADDR addr
, int len
,
354 enum bfd_endian byte_order
);
356 struct thread_info
; /* fwd decl for parameter list below: */
358 /* The type of the callback to the to_async method. */
360 typedef void async_callback_ftype (enum inferior_event_type event_type
,
363 /* Normally target debug printing is purely type-based. However,
364 sometimes it is necessary to override the debug printing on a
365 per-argument basis. This macro can be used, attribute-style, to
366 name the target debug printing function for a particular method
367 argument. FUNC is the name of the function. The macro's
368 definition is empty because it is only used by the
369 make-target-delegates script. */
371 #define TARGET_DEBUG_PRINTER(FUNC)
373 /* These defines are used to mark target_ops methods. The script
374 make-target-delegates scans these and auto-generates the base
375 method implementations. There are four macros that can be used:
377 1. TARGET_DEFAULT_IGNORE. There is no argument. The base method
378 does nothing. This is only valid if the method return type is
381 2. TARGET_DEFAULT_NORETURN. The argument is a function call, like
382 'tcomplain ()'. The base method simply makes this call, which is
383 assumed not to return.
385 3. TARGET_DEFAULT_RETURN. The argument is a C expression. The
386 base method returns this expression's value.
388 4. TARGET_DEFAULT_FUNC. The argument is the name of a function.
389 make-target-delegates does not generate a base method in this case,
390 but instead uses the argument function as the base method. */
392 #define TARGET_DEFAULT_IGNORE()
393 #define TARGET_DEFAULT_NORETURN(ARG)
394 #define TARGET_DEFAULT_RETURN(ARG)
395 #define TARGET_DEFAULT_FUNC(ARG)
399 struct target_ops
*beneath
; /* To the target under this one. */
400 const char *to_shortname
; /* Name this target type */
401 const char *to_longname
; /* Name for printing */
402 const char *to_doc
; /* Documentation. Does not include trailing
403 newline, and starts with a one-line descrip-
404 tion (probably similar to to_longname). */
405 /* Per-target scratch pad. */
407 /* The open routine takes the rest of the parameters from the
408 command, and (if successful) pushes a new target onto the
409 stack. Targets should supply this routine, if only to provide
411 void (*to_open
) (const char *, int);
412 /* Old targets with a static target vector provide "to_close".
413 New re-entrant targets provide "to_xclose" and that is expected
414 to xfree everything (including the "struct target_ops"). */
415 void (*to_xclose
) (struct target_ops
*targ
);
416 void (*to_close
) (struct target_ops
*);
417 /* Attaches to a process on the target side. Arguments are as
418 passed to the `attach' command by the user. This routine can
419 be called when the target is not on the target-stack, if the
420 target_can_run routine returns 1; in that case, it must push
421 itself onto the stack. Upon exit, the target should be ready
422 for normal operations, and should be ready to deliver the
423 status of the process immediately (without waiting) to an
424 upcoming target_wait call. */
425 void (*to_attach
) (struct target_ops
*ops
, const char *, int);
426 void (*to_post_attach
) (struct target_ops
*, int)
427 TARGET_DEFAULT_IGNORE ();
428 void (*to_detach
) (struct target_ops
*ops
, const char *, int)
429 TARGET_DEFAULT_IGNORE ();
430 void (*to_disconnect
) (struct target_ops
*, const char *, int)
431 TARGET_DEFAULT_NORETURN (tcomplain ());
432 void (*to_resume
) (struct target_ops
*, ptid_t
,
433 int TARGET_DEBUG_PRINTER (target_debug_print_step
),
435 TARGET_DEFAULT_NORETURN (noprocess ());
436 ptid_t (*to_wait
) (struct target_ops
*,
437 ptid_t
, struct target_waitstatus
*,
438 int TARGET_DEBUG_PRINTER (target_debug_print_options
))
439 TARGET_DEFAULT_NORETURN (noprocess ());
440 void (*to_fetch_registers
) (struct target_ops
*, struct regcache
*, int)
441 TARGET_DEFAULT_IGNORE ();
442 void (*to_store_registers
) (struct target_ops
*, struct regcache
*, int)
443 TARGET_DEFAULT_NORETURN (noprocess ());
444 void (*to_prepare_to_store
) (struct target_ops
*, struct regcache
*)
445 TARGET_DEFAULT_NORETURN (noprocess ());
447 void (*to_files_info
) (struct target_ops
*)
448 TARGET_DEFAULT_IGNORE ();
449 int (*to_insert_breakpoint
) (struct target_ops
*, struct gdbarch
*,
450 struct bp_target_info
*)
451 TARGET_DEFAULT_FUNC (memory_insert_breakpoint
);
452 int (*to_remove_breakpoint
) (struct target_ops
*, struct gdbarch
*,
453 struct bp_target_info
*)
454 TARGET_DEFAULT_FUNC (memory_remove_breakpoint
);
455 int (*to_can_use_hw_breakpoint
) (struct target_ops
*, int, int, int)
456 TARGET_DEFAULT_RETURN (0);
457 int (*to_ranged_break_num_registers
) (struct target_ops
*)
458 TARGET_DEFAULT_RETURN (-1);
459 int (*to_insert_hw_breakpoint
) (struct target_ops
*,
460 struct gdbarch
*, struct bp_target_info
*)
461 TARGET_DEFAULT_RETURN (-1);
462 int (*to_remove_hw_breakpoint
) (struct target_ops
*,
463 struct gdbarch
*, struct bp_target_info
*)
464 TARGET_DEFAULT_RETURN (-1);
466 /* Documentation of what the two routines below are expected to do is
467 provided with the corresponding target_* macros. */
468 int (*to_remove_watchpoint
) (struct target_ops
*,
469 CORE_ADDR
, int, int, struct expression
*)
470 TARGET_DEFAULT_RETURN (-1);
471 int (*to_insert_watchpoint
) (struct target_ops
*,
472 CORE_ADDR
, int, int, struct expression
*)
473 TARGET_DEFAULT_RETURN (-1);
475 int (*to_insert_mask_watchpoint
) (struct target_ops
*,
476 CORE_ADDR
, CORE_ADDR
, int)
477 TARGET_DEFAULT_RETURN (1);
478 int (*to_remove_mask_watchpoint
) (struct target_ops
*,
479 CORE_ADDR
, CORE_ADDR
, int)
480 TARGET_DEFAULT_RETURN (1);
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 TARGET_DEFAULT_RETURN (-1);
504 void (*to_terminal_init
) (struct target_ops
*)
505 TARGET_DEFAULT_IGNORE ();
506 void (*to_terminal_inferior
) (struct target_ops
*)
507 TARGET_DEFAULT_IGNORE ();
508 void (*to_terminal_ours_for_output
) (struct target_ops
*)
509 TARGET_DEFAULT_IGNORE ();
510 void (*to_terminal_ours
) (struct target_ops
*)
511 TARGET_DEFAULT_IGNORE ();
512 void (*to_terminal_info
) (struct target_ops
*, const char *, int)
513 TARGET_DEFAULT_FUNC (default_terminal_info
);
514 void (*to_kill
) (struct target_ops
*)
515 TARGET_DEFAULT_NORETURN (noprocess ());
516 void (*to_load
) (struct target_ops
*, const char *, int)
517 TARGET_DEFAULT_NORETURN (tcomplain ());
518 /* Start an inferior process and set inferior_ptid to its pid.
519 EXEC_FILE is the file to run.
520 ALLARGS is a string containing the arguments to the program.
521 ENV is the environment vector to pass. Errors reported with error().
522 On VxWorks and various standalone systems, we ignore exec_file. */
523 void (*to_create_inferior
) (struct target_ops
*,
524 char *, char *, char **, int);
525 void (*to_post_startup_inferior
) (struct target_ops
*, ptid_t
)
526 TARGET_DEFAULT_IGNORE ();
527 int (*to_insert_fork_catchpoint
) (struct target_ops
*, int)
528 TARGET_DEFAULT_RETURN (1);
529 int (*to_remove_fork_catchpoint
) (struct target_ops
*, int)
530 TARGET_DEFAULT_RETURN (1);
531 int (*to_insert_vfork_catchpoint
) (struct target_ops
*, int)
532 TARGET_DEFAULT_RETURN (1);
533 int (*to_remove_vfork_catchpoint
) (struct target_ops
*, int)
534 TARGET_DEFAULT_RETURN (1);
535 int (*to_follow_fork
) (struct target_ops
*, int, int)
536 TARGET_DEFAULT_FUNC (default_follow_fork
);
537 int (*to_insert_exec_catchpoint
) (struct target_ops
*, int)
538 TARGET_DEFAULT_RETURN (1);
539 int (*to_remove_exec_catchpoint
) (struct target_ops
*, int)
540 TARGET_DEFAULT_RETURN (1);
541 int (*to_set_syscall_catchpoint
) (struct target_ops
*,
542 int, int, int, int, int *)
543 TARGET_DEFAULT_RETURN (1);
544 int (*to_has_exited
) (struct target_ops
*, int, int, int *)
545 TARGET_DEFAULT_RETURN (0);
546 void (*to_mourn_inferior
) (struct target_ops
*)
547 TARGET_DEFAULT_FUNC (default_mourn_inferior
);
548 /* Note that to_can_run is special and can be invoked on an
549 unpushed target. Targets defining this method must also define
550 to_can_async_p and to_supports_non_stop. */
551 int (*to_can_run
) (struct target_ops
*)
552 TARGET_DEFAULT_RETURN (0);
554 /* Documentation of this routine is provided with the corresponding
556 void (*to_pass_signals
) (struct target_ops
*, int,
557 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals
))
558 TARGET_DEFAULT_IGNORE ();
560 /* Documentation of this routine is provided with the
561 corresponding target_* function. */
562 void (*to_program_signals
) (struct target_ops
*, int,
563 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals
))
564 TARGET_DEFAULT_IGNORE ();
566 int (*to_thread_alive
) (struct target_ops
*, ptid_t ptid
)
567 TARGET_DEFAULT_RETURN (0);
568 void (*to_update_thread_list
) (struct target_ops
*)
569 TARGET_DEFAULT_IGNORE ();
570 char *(*to_pid_to_str
) (struct target_ops
*, ptid_t
)
571 TARGET_DEFAULT_FUNC (default_pid_to_str
);
572 char *(*to_extra_thread_info
) (struct target_ops
*, struct thread_info
*)
573 TARGET_DEFAULT_RETURN (NULL
);
574 char *(*to_thread_name
) (struct target_ops
*, struct thread_info
*)
575 TARGET_DEFAULT_RETURN (NULL
);
576 void (*to_stop
) (struct target_ops
*, ptid_t
)
577 TARGET_DEFAULT_IGNORE ();
578 void (*to_rcmd
) (struct target_ops
*,
579 const char *command
, struct ui_file
*output
)
580 TARGET_DEFAULT_FUNC (default_rcmd
);
581 char *(*to_pid_to_exec_file
) (struct target_ops
*, int pid
)
582 TARGET_DEFAULT_RETURN (NULL
);
583 void (*to_log_command
) (struct target_ops
*, const char *)
584 TARGET_DEFAULT_IGNORE ();
585 struct target_section_table
*(*to_get_section_table
) (struct target_ops
*)
586 TARGET_DEFAULT_RETURN (NULL
);
587 enum strata to_stratum
;
588 int (*to_has_all_memory
) (struct target_ops
*);
589 int (*to_has_memory
) (struct target_ops
*);
590 int (*to_has_stack
) (struct target_ops
*);
591 int (*to_has_registers
) (struct target_ops
*);
592 int (*to_has_execution
) (struct target_ops
*, ptid_t
);
593 int to_has_thread_control
; /* control thread execution */
594 int to_attach_no_wait
;
595 /* This method must be implemented in some situations. See the
596 comment on 'to_can_run'. */
597 int (*to_can_async_p
) (struct target_ops
*)
598 TARGET_DEFAULT_RETURN (0);
599 int (*to_is_async_p
) (struct target_ops
*)
600 TARGET_DEFAULT_RETURN (0);
601 void (*to_async
) (struct target_ops
*, async_callback_ftype
*, void *)
602 TARGET_DEFAULT_NORETURN (tcomplain ());
603 /* This method must be implemented in some situations. See the
604 comment on 'to_can_run'. */
605 int (*to_supports_non_stop
) (struct target_ops
*)
606 TARGET_DEFAULT_RETURN (0);
607 /* find_memory_regions support method for gcore */
608 int (*to_find_memory_regions
) (struct target_ops
*,
609 find_memory_region_ftype func
, void *data
)
610 TARGET_DEFAULT_FUNC (dummy_find_memory_regions
);
611 /* make_corefile_notes support method for gcore */
612 char * (*to_make_corefile_notes
) (struct target_ops
*, bfd
*, int *)
613 TARGET_DEFAULT_FUNC (dummy_make_corefile_notes
);
614 /* get_bookmark support method for bookmarks */
615 gdb_byte
* (*to_get_bookmark
) (struct target_ops
*, const char *, int)
616 TARGET_DEFAULT_NORETURN (tcomplain ());
617 /* goto_bookmark support method for bookmarks */
618 void (*to_goto_bookmark
) (struct target_ops
*, const gdb_byte
*, int)
619 TARGET_DEFAULT_NORETURN (tcomplain ());
620 /* Return the thread-local address at OFFSET in the
621 thread-local storage for the thread PTID and the shared library
622 or executable file given by OBJFILE. If that block of
623 thread-local storage hasn't been allocated yet, this function
624 may return an error. LOAD_MODULE_ADDR may be zero for statically
625 linked multithreaded inferiors. */
626 CORE_ADDR (*to_get_thread_local_address
) (struct target_ops
*ops
,
628 CORE_ADDR load_module_addr
,
630 TARGET_DEFAULT_NORETURN (generic_tls_error ());
632 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
633 OBJECT. The OFFSET, for a seekable object, specifies the
634 starting point. The ANNEX can be used to provide additional
635 data-specific information to the target.
637 Return the transferred status, error or OK (an
638 'enum target_xfer_status' value). Save the number of bytes
639 actually transferred in *XFERED_LEN if transfer is successful
640 (TARGET_XFER_OK) or the number unavailable bytes if the requested
641 data is unavailable (TARGET_XFER_UNAVAILABLE). *XFERED_LEN
642 smaller than LEN does not indicate the end of the object, only
643 the end of the transfer; higher level code should continue
644 transferring if desired. This is handled in target.c.
646 The interface does not support a "retry" mechanism. Instead it
647 assumes that at least one byte will be transfered on each
650 NOTE: cagney/2003-10-17: The current interface can lead to
651 fragmented transfers. Lower target levels should not implement
652 hacks, such as enlarging the transfer, in an attempt to
653 compensate for this. Instead, the target stack should be
654 extended so that it implements supply/collect methods and a
655 look-aside object cache. With that available, the lowest
656 target can safely and freely "push" data up the stack.
658 See target_read and target_write for more information. One,
659 and only one, of readbuf or writebuf must be non-NULL. */
661 enum target_xfer_status (*to_xfer_partial
) (struct target_ops
*ops
,
662 enum target_object object
,
665 const gdb_byte
*writebuf
,
666 ULONGEST offset
, ULONGEST len
,
667 ULONGEST
*xfered_len
)
668 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO
);
670 /* Returns the memory map for the target. A return value of NULL
671 means that no memory map is available. If a memory address
672 does not fall within any returned regions, it's assumed to be
673 RAM. The returned memory regions should not overlap.
675 The order of regions does not matter; target_memory_map will
676 sort regions by starting address. For that reason, this
677 function should not be called directly except via
680 This method should not cache data; if the memory map could
681 change unexpectedly, it should be invalidated, and higher
682 layers will re-fetch it. */
683 VEC(mem_region_s
) *(*to_memory_map
) (struct target_ops
*)
684 TARGET_DEFAULT_RETURN (NULL
);
686 /* Erases the region of flash memory starting at ADDRESS, of
689 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
690 on flash block boundaries, as reported by 'to_memory_map'. */
691 void (*to_flash_erase
) (struct target_ops
*,
692 ULONGEST address
, LONGEST length
)
693 TARGET_DEFAULT_NORETURN (tcomplain ());
695 /* Finishes a flash memory write sequence. After this operation
696 all flash memory should be available for writing and the result
697 of reading from areas written by 'to_flash_write' should be
698 equal to what was written. */
699 void (*to_flash_done
) (struct target_ops
*)
700 TARGET_DEFAULT_NORETURN (tcomplain ());
702 /* Describe the architecture-specific features of this target. If
703 OPS doesn't have a description, this should delegate to the
704 "beneath" target. Returns the description found, or NULL if no
705 description was available. */
706 const struct target_desc
*(*to_read_description
) (struct target_ops
*ops
)
707 TARGET_DEFAULT_RETURN (NULL
);
709 /* Build the PTID of the thread on which a given task is running,
710 based on LWP and THREAD. These values are extracted from the
711 task Private_Data section of the Ada Task Control Block, and
712 their interpretation depends on the target. */
713 ptid_t (*to_get_ada_task_ptid
) (struct target_ops
*,
714 long lwp
, long thread
)
715 TARGET_DEFAULT_FUNC (default_get_ada_task_ptid
);
717 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
718 Return 0 if *READPTR is already at the end of the buffer.
719 Return -1 if there is insufficient buffer for a whole entry.
720 Return 1 if an entry was read into *TYPEP and *VALP. */
721 int (*to_auxv_parse
) (struct target_ops
*ops
, gdb_byte
**readptr
,
722 gdb_byte
*endptr
, CORE_ADDR
*typep
, CORE_ADDR
*valp
)
723 TARGET_DEFAULT_FUNC (default_auxv_parse
);
725 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
726 sequence of bytes in PATTERN with length PATTERN_LEN.
728 The result is 1 if found, 0 if not found, and -1 if there was an error
729 requiring halting of the search (e.g. memory read error).
730 If the pattern is found the address is recorded in FOUND_ADDRP. */
731 int (*to_search_memory
) (struct target_ops
*ops
,
732 CORE_ADDR start_addr
, ULONGEST search_space_len
,
733 const gdb_byte
*pattern
, ULONGEST pattern_len
,
734 CORE_ADDR
*found_addrp
)
735 TARGET_DEFAULT_FUNC (default_search_memory
);
737 /* Can target execute in reverse? */
738 int (*to_can_execute_reverse
) (struct target_ops
*)
739 TARGET_DEFAULT_RETURN (0);
741 /* The direction the target is currently executing. Must be
742 implemented on targets that support reverse execution and async
743 mode. The default simply returns forward execution. */
744 enum exec_direction_kind (*to_execution_direction
) (struct target_ops
*)
745 TARGET_DEFAULT_FUNC (default_execution_direction
);
747 /* Does this target support debugging multiple processes
749 int (*to_supports_multi_process
) (struct target_ops
*)
750 TARGET_DEFAULT_RETURN (0);
752 /* Does this target support enabling and disabling tracepoints while a trace
753 experiment is running? */
754 int (*to_supports_enable_disable_tracepoint
) (struct target_ops
*)
755 TARGET_DEFAULT_RETURN (0);
757 /* Does this target support disabling address space randomization? */
758 int (*to_supports_disable_randomization
) (struct target_ops
*);
760 /* Does this target support the tracenz bytecode for string collection? */
761 int (*to_supports_string_tracing
) (struct target_ops
*)
762 TARGET_DEFAULT_RETURN (0);
764 /* Does this target support evaluation of breakpoint conditions on its
766 int (*to_supports_evaluation_of_breakpoint_conditions
) (struct target_ops
*)
767 TARGET_DEFAULT_RETURN (0);
769 /* Does this target support evaluation of breakpoint commands on its
771 int (*to_can_run_breakpoint_commands
) (struct target_ops
*)
772 TARGET_DEFAULT_RETURN (0);
774 /* Determine current architecture of thread PTID.
776 The target is supposed to determine the architecture of the code where
777 the target is currently stopped at (on Cell, if a target is in spu_run,
778 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
779 This is architecture used to perform decr_pc_after_break adjustment,
780 and also determines the frame architecture of the innermost frame.
781 ptrace operations need to operate according to target_gdbarch ().
783 The default implementation always returns target_gdbarch (). */
784 struct gdbarch
*(*to_thread_architecture
) (struct target_ops
*, ptid_t
)
785 TARGET_DEFAULT_FUNC (default_thread_architecture
);
787 /* Determine current address space of thread PTID.
789 The default implementation always returns the inferior's
791 struct address_space
*(*to_thread_address_space
) (struct target_ops
*,
793 TARGET_DEFAULT_FUNC (default_thread_address_space
);
795 /* Target file operations. */
797 /* Open FILENAME on the target, using FLAGS and MODE. Return a
798 target file descriptor, or -1 if an error occurs (and set
800 int (*to_fileio_open
) (struct target_ops
*,
801 const char *filename
, int flags
, int mode
,
804 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
805 Return the number of bytes written, or -1 if an error occurs
806 (and set *TARGET_ERRNO). */
807 int (*to_fileio_pwrite
) (struct target_ops
*,
808 int fd
, const gdb_byte
*write_buf
, int len
,
809 ULONGEST offset
, int *target_errno
);
811 /* Read up to LEN bytes FD on the target into READ_BUF.
812 Return the number of bytes read, or -1 if an error occurs
813 (and set *TARGET_ERRNO). */
814 int (*to_fileio_pread
) (struct target_ops
*,
815 int fd
, gdb_byte
*read_buf
, int len
,
816 ULONGEST offset
, int *target_errno
);
818 /* Close FD on the target. Return 0, or -1 if an error occurs
819 (and set *TARGET_ERRNO). */
820 int (*to_fileio_close
) (struct target_ops
*, int fd
, int *target_errno
);
822 /* Unlink FILENAME on the target. Return 0, or -1 if an error
823 occurs (and set *TARGET_ERRNO). */
824 int (*to_fileio_unlink
) (struct target_ops
*,
825 const char *filename
, int *target_errno
);
827 /* Read value of symbolic link FILENAME on the target. Return a
828 null-terminated string allocated via xmalloc, or NULL if an error
829 occurs (and set *TARGET_ERRNO). */
830 char *(*to_fileio_readlink
) (struct target_ops
*,
831 const char *filename
, int *target_errno
);
834 /* Implement the "info proc" command. */
835 void (*to_info_proc
) (struct target_ops
*, const char *,
836 enum info_proc_what
);
838 /* Tracepoint-related operations. */
840 /* Prepare the target for a tracing run. */
841 void (*to_trace_init
) (struct target_ops
*)
842 TARGET_DEFAULT_NORETURN (tcomplain ());
844 /* Send full details of a tracepoint location to the target. */
845 void (*to_download_tracepoint
) (struct target_ops
*,
846 struct bp_location
*location
)
847 TARGET_DEFAULT_NORETURN (tcomplain ());
849 /* Is the target able to download tracepoint locations in current
851 int (*to_can_download_tracepoint
) (struct target_ops
*)
852 TARGET_DEFAULT_RETURN (0);
854 /* Send full details of a trace state variable to the target. */
855 void (*to_download_trace_state_variable
) (struct target_ops
*,
856 struct trace_state_variable
*tsv
)
857 TARGET_DEFAULT_NORETURN (tcomplain ());
859 /* Enable a tracepoint on the target. */
860 void (*to_enable_tracepoint
) (struct target_ops
*,
861 struct bp_location
*location
)
862 TARGET_DEFAULT_NORETURN (tcomplain ());
864 /* Disable a tracepoint on the target. */
865 void (*to_disable_tracepoint
) (struct target_ops
*,
866 struct bp_location
*location
)
867 TARGET_DEFAULT_NORETURN (tcomplain ());
869 /* Inform the target info of memory regions that are readonly
870 (such as text sections), and so it should return data from
871 those rather than look in the trace buffer. */
872 void (*to_trace_set_readonly_regions
) (struct target_ops
*)
873 TARGET_DEFAULT_NORETURN (tcomplain ());
875 /* Start a trace run. */
876 void (*to_trace_start
) (struct target_ops
*)
877 TARGET_DEFAULT_NORETURN (tcomplain ());
879 /* Get the current status of a tracing run. */
880 int (*to_get_trace_status
) (struct target_ops
*, struct trace_status
*ts
)
881 TARGET_DEFAULT_RETURN (-1);
883 void (*to_get_tracepoint_status
) (struct target_ops
*,
884 struct breakpoint
*tp
,
885 struct uploaded_tp
*utp
)
886 TARGET_DEFAULT_NORETURN (tcomplain ());
888 /* Stop a trace run. */
889 void (*to_trace_stop
) (struct target_ops
*)
890 TARGET_DEFAULT_NORETURN (tcomplain ());
892 /* Ask the target to find a trace frame of the given type TYPE,
893 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
894 number of the trace frame, and also the tracepoint number at
895 TPP. If no trace frame matches, return -1. May throw if the
897 int (*to_trace_find
) (struct target_ops
*,
898 enum trace_find_type type
, int num
,
899 CORE_ADDR addr1
, CORE_ADDR addr2
, int *tpp
)
900 TARGET_DEFAULT_RETURN (-1);
902 /* Get the value of the trace state variable number TSV, returning
903 1 if the value is known and writing the value itself into the
904 location pointed to by VAL, else returning 0. */
905 int (*to_get_trace_state_variable_value
) (struct target_ops
*,
906 int tsv
, LONGEST
*val
)
907 TARGET_DEFAULT_RETURN (0);
909 int (*to_save_trace_data
) (struct target_ops
*, const char *filename
)
910 TARGET_DEFAULT_NORETURN (tcomplain ());
912 int (*to_upload_tracepoints
) (struct target_ops
*,
913 struct uploaded_tp
**utpp
)
914 TARGET_DEFAULT_RETURN (0);
916 int (*to_upload_trace_state_variables
) (struct target_ops
*,
917 struct uploaded_tsv
**utsvp
)
918 TARGET_DEFAULT_RETURN (0);
920 LONGEST (*to_get_raw_trace_data
) (struct target_ops
*, gdb_byte
*buf
,
921 ULONGEST offset
, LONGEST len
)
922 TARGET_DEFAULT_NORETURN (tcomplain ());
924 /* Get the minimum length of instruction on which a fast tracepoint
925 may be set on the target. If this operation is unsupported,
926 return -1. If for some reason the minimum length cannot be
927 determined, return 0. */
928 int (*to_get_min_fast_tracepoint_insn_len
) (struct target_ops
*)
929 TARGET_DEFAULT_RETURN (-1);
931 /* Set the target's tracing behavior in response to unexpected
932 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
933 void (*to_set_disconnected_tracing
) (struct target_ops
*, int val
)
934 TARGET_DEFAULT_IGNORE ();
935 void (*to_set_circular_trace_buffer
) (struct target_ops
*, int val
)
936 TARGET_DEFAULT_IGNORE ();
937 /* Set the size of trace buffer in the target. */
938 void (*to_set_trace_buffer_size
) (struct target_ops
*, LONGEST val
)
939 TARGET_DEFAULT_IGNORE ();
941 /* Add/change textual notes about the trace run, returning 1 if
942 successful, 0 otherwise. */
943 int (*to_set_trace_notes
) (struct target_ops
*,
944 const char *user
, const char *notes
,
945 const char *stopnotes
)
946 TARGET_DEFAULT_RETURN (0);
948 /* Return the processor core that thread PTID was last seen on.
949 This information is updated only when:
950 - update_thread_list is called
952 If the core cannot be determined -- either for the specified
953 thread, or right now, or in this debug session, or for this
954 target -- return -1. */
955 int (*to_core_of_thread
) (struct target_ops
*, ptid_t ptid
)
956 TARGET_DEFAULT_RETURN (-1);
958 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
959 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
960 a match, 0 if there's a mismatch, and -1 if an error is
961 encountered while reading memory. */
962 int (*to_verify_memory
) (struct target_ops
*, const gdb_byte
*data
,
963 CORE_ADDR memaddr
, ULONGEST size
)
964 TARGET_DEFAULT_FUNC (default_verify_memory
);
966 /* Return the address of the start of the Thread Information Block
967 a Windows OS specific feature. */
968 int (*to_get_tib_address
) (struct target_ops
*,
969 ptid_t ptid
, CORE_ADDR
*addr
)
970 TARGET_DEFAULT_NORETURN (tcomplain ());
972 /* Send the new settings of write permission variables. */
973 void (*to_set_permissions
) (struct target_ops
*)
974 TARGET_DEFAULT_IGNORE ();
976 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
977 with its details. Return 1 on success, 0 on failure. */
978 int (*to_static_tracepoint_marker_at
) (struct target_ops
*, CORE_ADDR
,
979 struct static_tracepoint_marker
*marker
)
980 TARGET_DEFAULT_RETURN (0);
982 /* Return a vector of all tracepoints markers string id ID, or all
983 markers if ID is NULL. */
984 VEC(static_tracepoint_marker_p
) *(*to_static_tracepoint_markers_by_strid
) (struct target_ops
*, const char *id
)
985 TARGET_DEFAULT_NORETURN (tcomplain ());
987 /* Return a traceframe info object describing the current
988 traceframe's contents. This method should not cache data;
989 higher layers take care of caching, invalidating, and
990 re-fetching when necessary. */
991 struct traceframe_info
*(*to_traceframe_info
) (struct target_ops
*)
992 TARGET_DEFAULT_NORETURN (tcomplain ());
994 /* Ask the target to use or not to use agent according to USE. Return 1
995 successful, 0 otherwise. */
996 int (*to_use_agent
) (struct target_ops
*, int use
)
997 TARGET_DEFAULT_NORETURN (tcomplain ());
999 /* Is the target able to use agent in current state? */
1000 int (*to_can_use_agent
) (struct target_ops
*)
1001 TARGET_DEFAULT_RETURN (0);
1003 /* Check whether the target supports branch tracing. */
1004 int (*to_supports_btrace
) (struct target_ops
*, enum btrace_format
)
1005 TARGET_DEFAULT_RETURN (0);
1007 /* Enable branch tracing for PTID using CONF configuration.
1008 Return a branch trace target information struct for reading and for
1009 disabling branch trace. */
1010 struct btrace_target_info
*(*to_enable_btrace
) (struct target_ops
*,
1012 const struct btrace_config
*conf
)
1013 TARGET_DEFAULT_NORETURN (tcomplain ());
1015 /* Disable branch tracing and deallocate TINFO. */
1016 void (*to_disable_btrace
) (struct target_ops
*,
1017 struct btrace_target_info
*tinfo
)
1018 TARGET_DEFAULT_NORETURN (tcomplain ());
1020 /* Disable branch tracing and deallocate TINFO. This function is similar
1021 to to_disable_btrace, except that it is called during teardown and is
1022 only allowed to perform actions that are safe. A counter-example would
1023 be attempting to talk to a remote target. */
1024 void (*to_teardown_btrace
) (struct target_ops
*,
1025 struct btrace_target_info
*tinfo
)
1026 TARGET_DEFAULT_NORETURN (tcomplain ());
1028 /* Read branch trace data for the thread indicated by BTINFO into DATA.
1029 DATA is cleared before new trace is added. */
1030 enum btrace_error (*to_read_btrace
) (struct target_ops
*self
,
1031 struct btrace_data
*data
,
1032 struct btrace_target_info
*btinfo
,
1033 enum btrace_read_type type
)
1034 TARGET_DEFAULT_NORETURN (tcomplain ());
1036 /* Get the branch trace configuration. */
1037 const struct btrace_config
*(*to_btrace_conf
) (struct target_ops
*self
,
1038 const struct btrace_target_info
*)
1039 TARGET_DEFAULT_RETURN (NULL
);
1041 /* Stop trace recording. */
1042 void (*to_stop_recording
) (struct target_ops
*)
1043 TARGET_DEFAULT_IGNORE ();
1045 /* Print information about the recording. */
1046 void (*to_info_record
) (struct target_ops
*)
1047 TARGET_DEFAULT_IGNORE ();
1049 /* Save the recorded execution trace into a file. */
1050 void (*to_save_record
) (struct target_ops
*, const char *filename
)
1051 TARGET_DEFAULT_NORETURN (tcomplain ());
1053 /* Delete the recorded execution trace from the current position
1055 void (*to_delete_record
) (struct target_ops
*)
1056 TARGET_DEFAULT_NORETURN (tcomplain ());
1058 /* Query if the record target is currently replaying. */
1059 int (*to_record_is_replaying
) (struct target_ops
*)
1060 TARGET_DEFAULT_RETURN (0);
1062 /* Go to the begin of the execution trace. */
1063 void (*to_goto_record_begin
) (struct target_ops
*)
1064 TARGET_DEFAULT_NORETURN (tcomplain ());
1066 /* Go to the end of the execution trace. */
1067 void (*to_goto_record_end
) (struct target_ops
*)
1068 TARGET_DEFAULT_NORETURN (tcomplain ());
1070 /* Go to a specific location in the recorded execution trace. */
1071 void (*to_goto_record
) (struct target_ops
*, ULONGEST insn
)
1072 TARGET_DEFAULT_NORETURN (tcomplain ());
1074 /* Disassemble SIZE instructions in the recorded execution trace from
1075 the current position.
1076 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1077 disassemble SIZE succeeding instructions. */
1078 void (*to_insn_history
) (struct target_ops
*, int size
, int flags
)
1079 TARGET_DEFAULT_NORETURN (tcomplain ());
1081 /* Disassemble SIZE instructions in the recorded execution trace around
1083 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1084 disassemble SIZE instructions after FROM. */
1085 void (*to_insn_history_from
) (struct target_ops
*,
1086 ULONGEST from
, int size
, int flags
)
1087 TARGET_DEFAULT_NORETURN (tcomplain ());
1089 /* Disassemble a section of the recorded execution trace from instruction
1090 BEGIN (inclusive) to instruction END (inclusive). */
1091 void (*to_insn_history_range
) (struct target_ops
*,
1092 ULONGEST begin
, ULONGEST end
, int flags
)
1093 TARGET_DEFAULT_NORETURN (tcomplain ());
1095 /* Print a function trace of the recorded execution trace.
1096 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1097 succeeding functions. */
1098 void (*to_call_history
) (struct target_ops
*, int size
, int flags
)
1099 TARGET_DEFAULT_NORETURN (tcomplain ());
1101 /* Print a function trace of the recorded execution trace starting
1103 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1104 SIZE functions after FROM. */
1105 void (*to_call_history_from
) (struct target_ops
*,
1106 ULONGEST begin
, int size
, int flags
)
1107 TARGET_DEFAULT_NORETURN (tcomplain ());
1109 /* Print a function trace of an execution trace section from function BEGIN
1110 (inclusive) to function END (inclusive). */
1111 void (*to_call_history_range
) (struct target_ops
*,
1112 ULONGEST begin
, ULONGEST end
, int flags
)
1113 TARGET_DEFAULT_NORETURN (tcomplain ());
1115 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1117 int (*to_augmented_libraries_svr4_read
) (struct target_ops
*)
1118 TARGET_DEFAULT_RETURN (0);
1120 /* Those unwinders are tried before any other arch unwinders. If
1121 SELF doesn't have unwinders, it should delegate to the
1122 "beneath" target. */
1123 const struct frame_unwind
*(*to_get_unwinder
) (struct target_ops
*self
)
1124 TARGET_DEFAULT_RETURN (NULL
);
1126 const struct frame_unwind
*(*to_get_tailcall_unwinder
) (struct target_ops
*self
)
1127 TARGET_DEFAULT_RETURN (NULL
);
1129 /* Return the number of bytes by which the PC needs to be decremented
1130 after executing a breakpoint instruction.
1131 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
1132 CORE_ADDR (*to_decr_pc_after_break
) (struct target_ops
*ops
,
1133 struct gdbarch
*gdbarch
)
1134 TARGET_DEFAULT_FUNC (default_target_decr_pc_after_break
);
1136 /* Prepare to generate a core file. */
1137 void (*to_prepare_to_generate_core
) (struct target_ops
*)
1138 TARGET_DEFAULT_IGNORE ();
1140 /* Cleanup after generating a core file. */
1141 void (*to_done_generating_core
) (struct target_ops
*)
1142 TARGET_DEFAULT_IGNORE ();
1145 /* Need sub-structure for target machine related rather than comm related?
1149 /* Magic number for checking ops size. If a struct doesn't end with this
1150 number, somebody changed the declaration but didn't change all the
1151 places that initialize one. */
1153 #define OPS_MAGIC 3840
1155 /* The ops structure for our "current" target process. This should
1156 never be NULL. If there is no target, it points to the dummy_target. */
1158 extern struct target_ops current_target
;
1160 /* Define easy words for doing these operations on our current target. */
1162 #define target_shortname (current_target.to_shortname)
1163 #define target_longname (current_target.to_longname)
1165 /* Does whatever cleanup is required for a target that we are no
1166 longer going to be calling. This routine is automatically always
1167 called after popping the target off the target stack - the target's
1168 own methods are no longer available through the target vector.
1169 Closing file descriptors and freeing all memory allocated memory are
1170 typical things it should do. */
1172 void target_close (struct target_ops
*targ
);
1174 /* Find the correct target to use for "attach". If a target on the
1175 current stack supports attaching, then it is returned. Otherwise,
1176 the default run target is returned. */
1178 extern struct target_ops
*find_attach_target (void);
1180 /* Find the correct target to use for "run". If a target on the
1181 current stack supports creating a new inferior, then it is
1182 returned. Otherwise, the default run target is returned. */
1184 extern struct target_ops
*find_run_target (void);
1186 /* Some targets don't generate traps when attaching to the inferior,
1187 or their target_attach implementation takes care of the waiting.
1188 These targets must set to_attach_no_wait. */
1190 #define target_attach_no_wait \
1191 (current_target.to_attach_no_wait)
1193 /* The target_attach operation places a process under debugger control,
1194 and stops the process.
1196 This operation provides a target-specific hook that allows the
1197 necessary bookkeeping to be performed after an attach completes. */
1198 #define target_post_attach(pid) \
1199 (*current_target.to_post_attach) (¤t_target, pid)
1201 /* Takes a program previously attached to and detaches it.
1202 The program may resume execution (some targets do, some don't) and will
1203 no longer stop on signals, etc. We better not have left any breakpoints
1204 in the program or it'll die when it hits one. ARGS is arguments
1205 typed by the user (e.g. a signal to send the process). FROM_TTY
1206 says whether to be verbose or not. */
1208 extern void target_detach (const char *, int);
1210 /* Disconnect from the current target without resuming it (leaving it
1211 waiting for a debugger). */
1213 extern void target_disconnect (const char *, int);
1215 /* Resume execution of the target process PTID (or a group of
1216 threads). STEP says whether to single-step or to run free; SIGGNAL
1217 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1218 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1219 PTID means `step/resume only this process id'. A wildcard PTID
1220 (all threads, or all threads of process) means `step/resume
1221 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1222 matches) resume with their 'thread->suspend.stop_signal' signal
1223 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1224 if in "no pass" state. */
1226 extern void target_resume (ptid_t ptid
, int step
, enum gdb_signal signal
);
1228 /* Wait for process pid to do something. PTID = -1 to wait for any
1229 pid to do something. Return pid of child, or -1 in case of error;
1230 store status through argument pointer STATUS. Note that it is
1231 _NOT_ OK to throw_exception() out of target_wait() without popping
1232 the debugging target from the stack; GDB isn't prepared to get back
1233 to the prompt with a debugging target but without the frame cache,
1234 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1237 extern ptid_t
target_wait (ptid_t ptid
, struct target_waitstatus
*status
,
1240 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1242 extern void target_fetch_registers (struct regcache
*regcache
, int regno
);
1244 /* Store at least register REGNO, or all regs if REGNO == -1.
1245 It can store as many registers as it wants to, so target_prepare_to_store
1246 must have been previously called. Calls error() if there are problems. */
1248 extern void target_store_registers (struct regcache
*regcache
, int regs
);
1250 /* Get ready to modify the registers array. On machines which store
1251 individual registers, this doesn't need to do anything. On machines
1252 which store all the registers in one fell swoop, this makes sure
1253 that REGISTERS contains all the registers from the program being
1256 #define target_prepare_to_store(regcache) \
1257 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1259 /* Determine current address space of thread PTID. */
1261 struct address_space
*target_thread_address_space (ptid_t
);
1263 /* Implement the "info proc" command. This returns one if the request
1264 was handled, and zero otherwise. It can also throw an exception if
1265 an error was encountered while attempting to handle the
1268 int target_info_proc (const char *, enum info_proc_what
);
1270 /* Returns true if this target can debug multiple processes
1273 #define target_supports_multi_process() \
1274 (*current_target.to_supports_multi_process) (¤t_target)
1276 /* Returns true if this target can disable address space randomization. */
1278 int target_supports_disable_randomization (void);
1280 /* Returns true if this target can enable and disable tracepoints
1281 while a trace experiment is running. */
1283 #define target_supports_enable_disable_tracepoint() \
1284 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1286 #define target_supports_string_tracing() \
1287 (*current_target.to_supports_string_tracing) (¤t_target)
1289 /* Returns true if this target can handle breakpoint conditions
1292 #define target_supports_evaluation_of_breakpoint_conditions() \
1293 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1295 /* Returns true if this target can handle breakpoint commands
1298 #define target_can_run_breakpoint_commands() \
1299 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1301 extern int target_read_string (CORE_ADDR
, char **, int, int *);
1303 /* For target_read_memory see target/target.h. */
1305 extern int target_read_raw_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
1308 extern int target_read_stack (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
);
1310 extern int target_read_code (CORE_ADDR memaddr
, gdb_byte
*myaddr
, ssize_t len
);
1312 /* For target_write_memory see target/target.h. */
1314 extern int target_write_raw_memory (CORE_ADDR memaddr
, const gdb_byte
*myaddr
,
1317 /* Fetches the target's memory map. If one is found it is sorted
1318 and returned, after some consistency checking. Otherwise, NULL
1320 VEC(mem_region_s
) *target_memory_map (void);
1322 /* Erase the specified flash region. */
1323 void target_flash_erase (ULONGEST address
, LONGEST length
);
1325 /* Finish a sequence of flash operations. */
1326 void target_flash_done (void);
1328 /* Describes a request for a memory write operation. */
1329 struct memory_write_request
1331 /* Begining address that must be written. */
1333 /* Past-the-end address. */
1335 /* The data to write. */
1337 /* A callback baton for progress reporting for this request. */
1340 typedef struct memory_write_request memory_write_request_s
;
1341 DEF_VEC_O(memory_write_request_s
);
1343 /* Enumeration specifying different flash preservation behaviour. */
1344 enum flash_preserve_mode
1350 /* Write several memory blocks at once. This version can be more
1351 efficient than making several calls to target_write_memory, in
1352 particular because it can optimize accesses to flash memory.
1354 Moreover, this is currently the only memory access function in gdb
1355 that supports writing to flash memory, and it should be used for
1356 all cases where access to flash memory is desirable.
1358 REQUESTS is the vector (see vec.h) of memory_write_request.
1359 PRESERVE_FLASH_P indicates what to do with blocks which must be
1360 erased, but not completely rewritten.
1361 PROGRESS_CB is a function that will be periodically called to provide
1362 feedback to user. It will be called with the baton corresponding
1363 to the request currently being written. It may also be called
1364 with a NULL baton, when preserved flash sectors are being rewritten.
1366 The function returns 0 on success, and error otherwise. */
1367 int target_write_memory_blocks (VEC(memory_write_request_s
) *requests
,
1368 enum flash_preserve_mode preserve_flash_p
,
1369 void (*progress_cb
) (ULONGEST
, void *));
1371 /* Print a line about the current target. */
1373 #define target_files_info() \
1374 (*current_target.to_files_info) (¤t_target)
1376 /* Insert a breakpoint at address BP_TGT->placed_address in
1377 the target machine. Returns 0 for success, and returns non-zero or
1378 throws an error (with a detailed failure reason error code and
1379 message) otherwise. */
1381 extern int target_insert_breakpoint (struct gdbarch
*gdbarch
,
1382 struct bp_target_info
*bp_tgt
);
1384 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1385 machine. Result is 0 for success, non-zero for error. */
1387 extern int target_remove_breakpoint (struct gdbarch
*gdbarch
,
1388 struct bp_target_info
*bp_tgt
);
1390 /* Returns true if the terminal settings of the inferior are in
1393 extern int target_terminal_is_inferior (void);
1395 /* Initialize the terminal settings we record for the inferior,
1396 before we actually run the inferior. */
1398 extern void target_terminal_init (void);
1400 /* Put the inferior's terminal settings into effect.
1401 This is preparation for starting or resuming the inferior. */
1403 extern void target_terminal_inferior (void);
1405 /* Put some of our terminal settings into effect, enough to get proper
1406 results from our output, but do not change into or out of RAW mode
1407 so that no input is discarded. This is a no-op if terminal_ours
1408 was most recently called. */
1410 extern void target_terminal_ours_for_output (void);
1412 /* Put our terminal settings into effect.
1413 First record the inferior's terminal settings
1414 so they can be restored properly later. */
1416 extern void target_terminal_ours (void);
1418 /* Return true if the target stack has a non-default
1419 "to_terminal_ours" method. */
1421 extern int target_supports_terminal_ours (void);
1423 /* Make a cleanup that restores the state of the terminal to the current
1425 extern struct cleanup
*make_cleanup_restore_target_terminal (void);
1427 /* Print useful information about our terminal status, if such a thing
1430 #define target_terminal_info(arg, from_tty) \
1431 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1433 /* Kill the inferior process. Make it go away. */
1435 extern void target_kill (void);
1437 /* Load an executable file into the target process. This is expected
1438 to not only bring new code into the target process, but also to
1439 update GDB's symbol tables to match.
1441 ARG contains command-line arguments, to be broken down with
1442 buildargv (). The first non-switch argument is the filename to
1443 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1444 0)), which is an offset to apply to the load addresses of FILE's
1445 sections. The target may define switches, or other non-switch
1446 arguments, as it pleases. */
1448 extern void target_load (const char *arg
, int from_tty
);
1450 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1451 notification of inferior events such as fork and vork immediately
1452 after the inferior is created. (This because of how gdb gets an
1453 inferior created via invoking a shell to do it. In such a scenario,
1454 if the shell init file has commands in it, the shell will fork and
1455 exec for each of those commands, and we will see each such fork
1458 Such targets will supply an appropriate definition for this function. */
1460 #define target_post_startup_inferior(ptid) \
1461 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1463 /* On some targets, we can catch an inferior fork or vfork event when
1464 it occurs. These functions insert/remove an already-created
1465 catchpoint for such events. They return 0 for success, 1 if the
1466 catchpoint type is not supported and -1 for failure. */
1468 #define target_insert_fork_catchpoint(pid) \
1469 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1471 #define target_remove_fork_catchpoint(pid) \
1472 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1474 #define target_insert_vfork_catchpoint(pid) \
1475 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1477 #define target_remove_vfork_catchpoint(pid) \
1478 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1480 /* If the inferior forks or vforks, this function will be called at
1481 the next resume in order to perform any bookkeeping and fiddling
1482 necessary to continue debugging either the parent or child, as
1483 requested, and releasing the other. Information about the fork
1484 or vfork event is available via get_last_target_status ().
1485 This function returns 1 if the inferior should not be resumed
1486 (i.e. there is another event pending). */
1488 int target_follow_fork (int follow_child
, int detach_fork
);
1490 /* On some targets, we can catch an inferior exec event when it
1491 occurs. These functions insert/remove an already-created
1492 catchpoint for such events. They return 0 for success, 1 if the
1493 catchpoint type is not supported and -1 for failure. */
1495 #define target_insert_exec_catchpoint(pid) \
1496 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1498 #define target_remove_exec_catchpoint(pid) \
1499 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1503 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1504 If NEEDED is zero, it means the target can disable the mechanism to
1505 catch system calls because there are no more catchpoints of this type.
1507 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1508 being requested. In this case, both TABLE_SIZE and TABLE should
1511 TABLE_SIZE is the number of elements in TABLE. It only matters if
1514 TABLE is an array of ints, indexed by syscall number. An element in
1515 this array is nonzero if that syscall should be caught. This argument
1516 only matters if ANY_COUNT is zero.
1518 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1521 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1522 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1523 pid, needed, any_count, \
1526 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1527 exit code of PID, if any. */
1529 #define target_has_exited(pid,wait_status,exit_status) \
1530 (*current_target.to_has_exited) (¤t_target, \
1531 pid,wait_status,exit_status)
1533 /* The debugger has completed a blocking wait() call. There is now
1534 some process event that must be processed. This function should
1535 be defined by those targets that require the debugger to perform
1536 cleanup or internal state changes in response to the process event. */
1538 /* The inferior process has died. Do what is right. */
1540 void target_mourn_inferior (void);
1542 /* Does target have enough data to do a run or attach command? */
1544 #define target_can_run(t) \
1545 ((t)->to_can_run) (t)
1547 /* Set list of signals to be handled in the target.
1549 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1550 (enum gdb_signal). For every signal whose entry in this array is
1551 non-zero, the target is allowed -but not required- to skip reporting
1552 arrival of the signal to the GDB core by returning from target_wait,
1553 and to pass the signal directly to the inferior instead.
1555 However, if the target is hardware single-stepping a thread that is
1556 about to receive a signal, it needs to be reported in any case, even
1557 if mentioned in a previous target_pass_signals call. */
1559 extern void target_pass_signals (int nsig
, unsigned char *pass_signals
);
1561 /* Set list of signals the target may pass to the inferior. This
1562 directly maps to the "handle SIGNAL pass/nopass" setting.
1564 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1565 number (enum gdb_signal). For every signal whose entry in this
1566 array is non-zero, the target is allowed to pass the signal to the
1567 inferior. Signals not present in the array shall be silently
1568 discarded. This does not influence whether to pass signals to the
1569 inferior as a result of a target_resume call. This is useful in
1570 scenarios where the target needs to decide whether to pass or not a
1571 signal to the inferior without GDB core involvement, such as for
1572 example, when detaching (as threads may have been suspended with
1573 pending signals not reported to GDB). */
1575 extern void target_program_signals (int nsig
, unsigned char *program_signals
);
1577 /* Check to see if a thread is still alive. */
1579 extern int target_thread_alive (ptid_t ptid
);
1581 /* Sync the target's threads with GDB's thread list. */
1583 extern void target_update_thread_list (void);
1585 /* Make target stop in a continuable fashion. (For instance, under
1586 Unix, this should act like SIGSTOP). Note that this function is
1587 asynchronous: it does not wait for the target to become stopped
1588 before returning. If this is the behavior you want please use
1589 target_stop_and_wait. */
1591 extern void target_stop (ptid_t ptid
);
1593 /* Send the specified COMMAND to the target's monitor
1594 (shell,interpreter) for execution. The result of the query is
1595 placed in OUTBUF. */
1597 #define target_rcmd(command, outbuf) \
1598 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1601 /* Does the target include all of memory, or only part of it? This
1602 determines whether we look up the target chain for other parts of
1603 memory if this target can't satisfy a request. */
1605 extern int target_has_all_memory_1 (void);
1606 #define target_has_all_memory target_has_all_memory_1 ()
1608 /* Does the target include memory? (Dummy targets don't.) */
1610 extern int target_has_memory_1 (void);
1611 #define target_has_memory target_has_memory_1 ()
1613 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1614 we start a process.) */
1616 extern int target_has_stack_1 (void);
1617 #define target_has_stack target_has_stack_1 ()
1619 /* Does the target have registers? (Exec files don't.) */
1621 extern int target_has_registers_1 (void);
1622 #define target_has_registers target_has_registers_1 ()
1624 /* Does the target have execution? Can we make it jump (through
1625 hoops), or pop its stack a few times? This means that the current
1626 target is currently executing; for some targets, that's the same as
1627 whether or not the target is capable of execution, but there are
1628 also targets which can be current while not executing. In that
1629 case this will become true after to_create_inferior or
1632 extern int target_has_execution_1 (ptid_t
);
1634 /* Like target_has_execution_1, but always passes inferior_ptid. */
1636 extern int target_has_execution_current (void);
1638 #define target_has_execution target_has_execution_current ()
1640 /* Default implementations for process_stratum targets. Return true
1641 if there's a selected inferior, false otherwise. */
1643 extern int default_child_has_all_memory (struct target_ops
*ops
);
1644 extern int default_child_has_memory (struct target_ops
*ops
);
1645 extern int default_child_has_stack (struct target_ops
*ops
);
1646 extern int default_child_has_registers (struct target_ops
*ops
);
1647 extern int default_child_has_execution (struct target_ops
*ops
,
1650 /* Can the target support the debugger control of thread execution?
1651 Can it lock the thread scheduler? */
1653 #define target_can_lock_scheduler \
1654 (current_target.to_has_thread_control & tc_schedlock)
1656 /* Controls whether async mode is permitted. */
1657 extern int target_async_permitted
;
1659 /* Can the target support asynchronous execution? */
1660 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1662 /* Is the target in asynchronous execution mode? */
1663 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1665 /* Put the target in async mode with the specified callback function. */
1666 #define target_async(CALLBACK,CONTEXT) \
1667 (current_target.to_async (¤t_target, (CALLBACK), (CONTEXT)))
1669 #define target_execution_direction() \
1670 (current_target.to_execution_direction (¤t_target))
1672 /* Converts a process id to a string. Usually, the string just contains
1673 `process xyz', but on some systems it may contain
1674 `process xyz thread abc'. */
1676 extern char *target_pid_to_str (ptid_t ptid
);
1678 extern char *normal_pid_to_str (ptid_t ptid
);
1680 /* Return a short string describing extra information about PID,
1681 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1684 #define target_extra_thread_info(TP) \
1685 (current_target.to_extra_thread_info (¤t_target, TP))
1687 /* Return the thread's name. A NULL result means that the target
1688 could not determine this thread's name. */
1690 extern char *target_thread_name (struct thread_info
*);
1692 /* Attempts to find the pathname of the executable file
1693 that was run to create a specified process.
1695 The process PID must be stopped when this operation is used.
1697 If the executable file cannot be determined, NULL is returned.
1699 Else, a pointer to a character string containing the pathname
1700 is returned. This string should be copied into a buffer by
1701 the client if the string will not be immediately used, or if
1704 #define target_pid_to_exec_file(pid) \
1705 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1707 /* See the to_thread_architecture description in struct target_ops. */
1709 #define target_thread_architecture(ptid) \
1710 (current_target.to_thread_architecture (¤t_target, ptid))
1713 * Iterator function for target memory regions.
1714 * Calls a callback function once for each memory region 'mapped'
1715 * in the child process. Defined as a simple macro rather than
1716 * as a function macro so that it can be tested for nullity.
1719 #define target_find_memory_regions(FUNC, DATA) \
1720 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1723 * Compose corefile .note section.
1726 #define target_make_corefile_notes(BFD, SIZE_P) \
1727 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1729 /* Bookmark interfaces. */
1730 #define target_get_bookmark(ARGS, FROM_TTY) \
1731 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1733 #define target_goto_bookmark(ARG, FROM_TTY) \
1734 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1736 /* Hardware watchpoint interfaces. */
1738 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1739 write). Only the INFERIOR_PTID task is being queried. */
1741 #define target_stopped_by_watchpoint() \
1742 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1744 /* Non-zero if we have steppable watchpoints */
1746 #define target_have_steppable_watchpoint \
1747 (current_target.to_have_steppable_watchpoint)
1749 /* Non-zero if we have continuable watchpoints */
1751 #define target_have_continuable_watchpoint \
1752 (current_target.to_have_continuable_watchpoint)
1754 /* Provide defaults for hardware watchpoint functions. */
1756 /* If the *_hw_beakpoint functions have not been defined
1757 elsewhere use the definitions in the target vector. */
1759 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1760 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1761 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1762 (including this one?). OTHERTYPE is who knows what... */
1764 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1765 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1766 TYPE, CNT, OTHERTYPE);
1768 /* Returns the number of debug registers needed to watch the given
1769 memory region, or zero if not supported. */
1771 #define target_region_ok_for_hw_watchpoint(addr, len) \
1772 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1776 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1777 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1778 COND is the expression for its condition, or NULL if there's none.
1779 Returns 0 for success, 1 if the watchpoint type is not supported,
1782 #define target_insert_watchpoint(addr, len, type, cond) \
1783 (*current_target.to_insert_watchpoint) (¤t_target, \
1784 addr, len, type, cond)
1786 #define target_remove_watchpoint(addr, len, type, cond) \
1787 (*current_target.to_remove_watchpoint) (¤t_target, \
1788 addr, len, type, cond)
1790 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1791 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1792 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1793 masked watchpoints are not supported, -1 for failure. */
1795 extern int target_insert_mask_watchpoint (CORE_ADDR
, CORE_ADDR
, int);
1797 /* Remove a masked watchpoint at ADDR with the mask MASK.
1798 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1799 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1802 extern int target_remove_mask_watchpoint (CORE_ADDR
, CORE_ADDR
, int);
1804 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1805 the target machine. Returns 0 for success, and returns non-zero or
1806 throws an error (with a detailed failure reason error code and
1807 message) otherwise. */
1809 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1810 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1813 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1814 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1817 /* Return number of debug registers needed for a ranged breakpoint,
1818 or -1 if ranged breakpoints are not supported. */
1820 extern int target_ranged_break_num_registers (void);
1822 /* Return non-zero if target knows the data address which triggered this
1823 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1824 INFERIOR_PTID task is being queried. */
1825 #define target_stopped_data_address(target, addr_p) \
1826 (*(target)->to_stopped_data_address) (target, addr_p)
1828 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1829 LENGTH bytes beginning at START. */
1830 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1831 (*(target)->to_watchpoint_addr_within_range) (target, addr, start, length)
1833 /* Return non-zero if the target is capable of using hardware to evaluate
1834 the condition expression. In this case, if the condition is false when
1835 the watched memory location changes, execution may continue without the
1836 debugger being notified.
1838 Due to limitations in the hardware implementation, it may be capable of
1839 avoiding triggering the watchpoint in some cases where the condition
1840 expression is false, but may report some false positives as well.
1841 For this reason, GDB will still evaluate the condition expression when
1842 the watchpoint triggers. */
1843 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1844 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1845 addr, len, type, cond)
1847 /* Return number of debug registers needed for a masked watchpoint,
1848 -1 if masked watchpoints are not supported or -2 if the given address
1849 and mask combination cannot be used. */
1851 extern int target_masked_watch_num_registers (CORE_ADDR addr
, CORE_ADDR mask
);
1853 /* Target can execute in reverse? */
1854 #define target_can_execute_reverse \
1855 current_target.to_can_execute_reverse (¤t_target)
1857 extern const struct target_desc
*target_read_description (struct target_ops
*);
1859 #define target_get_ada_task_ptid(lwp, tid) \
1860 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1862 /* Utility implementation of searching memory. */
1863 extern int simple_search_memory (struct target_ops
* ops
,
1864 CORE_ADDR start_addr
,
1865 ULONGEST search_space_len
,
1866 const gdb_byte
*pattern
,
1867 ULONGEST pattern_len
,
1868 CORE_ADDR
*found_addrp
);
1870 /* Main entry point for searching memory. */
1871 extern int target_search_memory (CORE_ADDR start_addr
,
1872 ULONGEST search_space_len
,
1873 const gdb_byte
*pattern
,
1874 ULONGEST pattern_len
,
1875 CORE_ADDR
*found_addrp
);
1877 /* Target file operations. */
1879 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1880 target file descriptor, or -1 if an error occurs (and set
1882 extern int target_fileio_open (const char *filename
, int flags
, int mode
,
1885 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1886 Return the number of bytes written, or -1 if an error occurs
1887 (and set *TARGET_ERRNO). */
1888 extern int target_fileio_pwrite (int fd
, const gdb_byte
*write_buf
, int len
,
1889 ULONGEST offset
, int *target_errno
);
1891 /* Read up to LEN bytes FD on the target into READ_BUF.
1892 Return the number of bytes read, or -1 if an error occurs
1893 (and set *TARGET_ERRNO). */
1894 extern int target_fileio_pread (int fd
, gdb_byte
*read_buf
, int len
,
1895 ULONGEST offset
, int *target_errno
);
1897 /* Close FD on the target. Return 0, or -1 if an error occurs
1898 (and set *TARGET_ERRNO). */
1899 extern int target_fileio_close (int fd
, int *target_errno
);
1901 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1902 occurs (and set *TARGET_ERRNO). */
1903 extern int target_fileio_unlink (const char *filename
, int *target_errno
);
1905 /* Read value of symbolic link FILENAME on the target. Return a
1906 null-terminated string allocated via xmalloc, or NULL if an error
1907 occurs (and set *TARGET_ERRNO). */
1908 extern char *target_fileio_readlink (const char *filename
, int *target_errno
);
1910 /* Read target file FILENAME. The return value will be -1 if the transfer
1911 fails or is not supported; 0 if the object is empty; or the length
1912 of the object otherwise. If a positive value is returned, a
1913 sufficiently large buffer will be allocated using xmalloc and
1914 returned in *BUF_P containing the contents of the object.
1916 This method should be used for objects sufficiently small to store
1917 in a single xmalloc'd buffer, when no fixed bound on the object's
1918 size is known in advance. */
1919 extern LONGEST
target_fileio_read_alloc (const char *filename
,
1922 /* Read target file FILENAME. The result is NUL-terminated and
1923 returned as a string, allocated using xmalloc. If an error occurs
1924 or the transfer is unsupported, NULL is returned. Empty objects
1925 are returned as allocated but empty strings. A warning is issued
1926 if the result contains any embedded NUL bytes. */
1927 extern char *target_fileio_read_stralloc (const char *filename
);
1930 /* Tracepoint-related operations. */
1932 #define target_trace_init() \
1933 (*current_target.to_trace_init) (¤t_target)
1935 #define target_download_tracepoint(t) \
1936 (*current_target.to_download_tracepoint) (¤t_target, t)
1938 #define target_can_download_tracepoint() \
1939 (*current_target.to_can_download_tracepoint) (¤t_target)
1941 #define target_download_trace_state_variable(tsv) \
1942 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1944 #define target_enable_tracepoint(loc) \
1945 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1947 #define target_disable_tracepoint(loc) \
1948 (*current_target.to_disable_tracepoint) (¤t_target, loc)
1950 #define target_trace_start() \
1951 (*current_target.to_trace_start) (¤t_target)
1953 #define target_trace_set_readonly_regions() \
1954 (*current_target.to_trace_set_readonly_regions) (¤t_target)
1956 #define target_get_trace_status(ts) \
1957 (*current_target.to_get_trace_status) (¤t_target, ts)
1959 #define target_get_tracepoint_status(tp,utp) \
1960 (*current_target.to_get_tracepoint_status) (¤t_target, tp, utp)
1962 #define target_trace_stop() \
1963 (*current_target.to_trace_stop) (¤t_target)
1965 #define target_trace_find(type,num,addr1,addr2,tpp) \
1966 (*current_target.to_trace_find) (¤t_target, \
1967 (type), (num), (addr1), (addr2), (tpp))
1969 #define target_get_trace_state_variable_value(tsv,val) \
1970 (*current_target.to_get_trace_state_variable_value) (¤t_target, \
1973 #define target_save_trace_data(filename) \
1974 (*current_target.to_save_trace_data) (¤t_target, filename)
1976 #define target_upload_tracepoints(utpp) \
1977 (*current_target.to_upload_tracepoints) (¤t_target, utpp)
1979 #define target_upload_trace_state_variables(utsvp) \
1980 (*current_target.to_upload_trace_state_variables) (¤t_target, utsvp)
1982 #define target_get_raw_trace_data(buf,offset,len) \
1983 (*current_target.to_get_raw_trace_data) (¤t_target, \
1984 (buf), (offset), (len))
1986 #define target_get_min_fast_tracepoint_insn_len() \
1987 (*current_target.to_get_min_fast_tracepoint_insn_len) (¤t_target)
1989 #define target_set_disconnected_tracing(val) \
1990 (*current_target.to_set_disconnected_tracing) (¤t_target, val)
1992 #define target_set_circular_trace_buffer(val) \
1993 (*current_target.to_set_circular_trace_buffer) (¤t_target, val)
1995 #define target_set_trace_buffer_size(val) \
1996 (*current_target.to_set_trace_buffer_size) (¤t_target, val)
1998 #define target_set_trace_notes(user,notes,stopnotes) \
1999 (*current_target.to_set_trace_notes) (¤t_target, \
2000 (user), (notes), (stopnotes))
2002 #define target_get_tib_address(ptid, addr) \
2003 (*current_target.to_get_tib_address) (¤t_target, (ptid), (addr))
2005 #define target_set_permissions() \
2006 (*current_target.to_set_permissions) (¤t_target)
2008 #define target_static_tracepoint_marker_at(addr, marker) \
2009 (*current_target.to_static_tracepoint_marker_at) (¤t_target, \
2012 #define target_static_tracepoint_markers_by_strid(marker_id) \
2013 (*current_target.to_static_tracepoint_markers_by_strid) (¤t_target, \
2016 #define target_traceframe_info() \
2017 (*current_target.to_traceframe_info) (¤t_target)
2019 #define target_use_agent(use) \
2020 (*current_target.to_use_agent) (¤t_target, use)
2022 #define target_can_use_agent() \
2023 (*current_target.to_can_use_agent) (¤t_target)
2025 #define target_augmented_libraries_svr4_read() \
2026 (*current_target.to_augmented_libraries_svr4_read) (¤t_target)
2028 /* Command logging facility. */
2030 #define target_log_command(p) \
2031 (*current_target.to_log_command) (¤t_target, p)
2034 extern int target_core_of_thread (ptid_t ptid
);
2036 /* See to_get_unwinder in struct target_ops. */
2037 extern const struct frame_unwind
*target_get_unwinder (void);
2039 /* See to_get_tailcall_unwinder in struct target_ops. */
2040 extern const struct frame_unwind
*target_get_tailcall_unwinder (void);
2042 /* This implements basic memory verification, reading target memory
2043 and performing the comparison here (as opposed to accelerated
2044 verification making use of the qCRC packet, for example). */
2046 extern int simple_verify_memory (struct target_ops
* ops
,
2047 const gdb_byte
*data
,
2048 CORE_ADDR memaddr
, ULONGEST size
);
2050 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2051 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2052 if there's a mismatch, and -1 if an error is encountered while
2053 reading memory. Throws an error if the functionality is found not
2054 to be supported by the current target. */
2055 int target_verify_memory (const gdb_byte
*data
,
2056 CORE_ADDR memaddr
, ULONGEST size
);
2058 /* Routines for maintenance of the target structures...
2060 complete_target_initialization: Finalize a target_ops by filling in
2061 any fields needed by the target implementation. Unnecessary for
2062 targets which are registered via add_target, as this part gets
2065 add_target: Add a target to the list of all possible targets.
2066 This only makes sense for targets that should be activated using
2067 the "target TARGET_NAME ..." command.
2069 push_target: Make this target the top of the stack of currently used
2070 targets, within its particular stratum of the stack. Result
2071 is 0 if now atop the stack, nonzero if not on top (maybe
2074 unpush_target: Remove this from the stack of currently used targets,
2075 no matter where it is on the list. Returns 0 if no
2076 change, 1 if removed from stack. */
2078 extern void add_target (struct target_ops
*);
2080 extern void add_target_with_completer (struct target_ops
*t
,
2081 completer_ftype
*completer
);
2083 extern void complete_target_initialization (struct target_ops
*t
);
2085 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
2086 for maintaining backwards compatibility when renaming targets. */
2088 extern void add_deprecated_target_alias (struct target_ops
*t
, char *alias
);
2090 extern void push_target (struct target_ops
*);
2092 extern int unpush_target (struct target_ops
*);
2094 extern void target_pre_inferior (int);
2096 extern void target_preopen (int);
2098 /* Does whatever cleanup is required to get rid of all pushed targets. */
2099 extern void pop_all_targets (void);
2101 /* Like pop_all_targets, but pops only targets whose stratum is
2102 strictly above ABOVE_STRATUM. */
2103 extern void pop_all_targets_above (enum strata above_stratum
);
2105 extern int target_is_pushed (struct target_ops
*t
);
2107 extern CORE_ADDR
target_translate_tls_address (struct objfile
*objfile
,
2110 /* Struct target_section maps address ranges to file sections. It is
2111 mostly used with BFD files, but can be used without (e.g. for handling
2112 raw disks, or files not in formats handled by BFD). */
2114 struct target_section
2116 CORE_ADDR addr
; /* Lowest address in section */
2117 CORE_ADDR endaddr
; /* 1+highest address in section */
2119 struct bfd_section
*the_bfd_section
;
2121 /* The "owner" of the section.
2122 It can be any unique value. It is set by add_target_sections
2123 and used by remove_target_sections.
2124 For example, for executables it is a pointer to exec_bfd and
2125 for shlibs it is the so_list pointer. */
2129 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2131 struct target_section_table
2133 struct target_section
*sections
;
2134 struct target_section
*sections_end
;
2137 /* Return the "section" containing the specified address. */
2138 struct target_section
*target_section_by_addr (struct target_ops
*target
,
2141 /* Return the target section table this target (or the targets
2142 beneath) currently manipulate. */
2144 extern struct target_section_table
*target_get_section_table
2145 (struct target_ops
*target
);
2147 /* From mem-break.c */
2149 extern int memory_remove_breakpoint (struct target_ops
*, struct gdbarch
*,
2150 struct bp_target_info
*);
2152 extern int memory_insert_breakpoint (struct target_ops
*, struct gdbarch
*,
2153 struct bp_target_info
*);
2155 /* Check whether the memory at the breakpoint's placed address still
2156 contains the expected breakpoint instruction. */
2158 extern int memory_validate_breakpoint (struct gdbarch
*gdbarch
,
2159 struct bp_target_info
*bp_tgt
);
2161 extern int default_memory_remove_breakpoint (struct gdbarch
*,
2162 struct bp_target_info
*);
2164 extern int default_memory_insert_breakpoint (struct gdbarch
*,
2165 struct bp_target_info
*);
2170 extern void initialize_targets (void);
2172 extern void noprocess (void) ATTRIBUTE_NORETURN
;
2174 extern void target_require_runnable (void);
2176 extern void find_default_attach (struct target_ops
*, const char *, int);
2178 extern void find_default_create_inferior (struct target_ops
*,
2179 char *, char *, char **, int);
2181 extern struct target_ops
*find_target_beneath (struct target_ops
*);
2183 /* Find the target at STRATUM. If no target is at that stratum,
2186 struct target_ops
*find_target_at (enum strata stratum
);
2188 /* Read OS data object of type TYPE from the target, and return it in
2189 XML format. The result is NUL-terminated and returned as a string,
2190 allocated using xmalloc. If an error occurs or the transfer is
2191 unsupported, NULL is returned. Empty objects are returned as
2192 allocated but empty strings. */
2194 extern char *target_get_osdata (const char *type
);
2197 /* Stuff that should be shared among the various remote targets. */
2199 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2200 information (higher values, more information). */
2201 extern int remote_debug
;
2203 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2204 extern int baud_rate
;
2205 /* Timeout limit for response from target. */
2206 extern int remote_timeout
;
2210 /* Set the show memory breakpoints mode to show, and installs a cleanup
2211 to restore it back to the current value. */
2212 extern struct cleanup
*make_show_memory_breakpoints_cleanup (int show
);
2214 extern int may_write_registers
;
2215 extern int may_write_memory
;
2216 extern int may_insert_breakpoints
;
2217 extern int may_insert_tracepoints
;
2218 extern int may_insert_fast_tracepoints
;
2219 extern int may_stop
;
2221 extern void update_target_permissions (void);
2224 /* Imported from machine dependent code. */
2226 /* See to_supports_btrace in struct target_ops. */
2227 extern int target_supports_btrace (enum btrace_format
);
2229 /* See to_enable_btrace in struct target_ops. */
2230 extern struct btrace_target_info
*
2231 target_enable_btrace (ptid_t ptid
, const struct btrace_config
*);
2233 /* See to_disable_btrace in struct target_ops. */
2234 extern void target_disable_btrace (struct btrace_target_info
*btinfo
);
2236 /* See to_teardown_btrace in struct target_ops. */
2237 extern void target_teardown_btrace (struct btrace_target_info
*btinfo
);
2239 /* See to_read_btrace in struct target_ops. */
2240 extern enum btrace_error
target_read_btrace (struct btrace_data
*,
2241 struct btrace_target_info
*,
2242 enum btrace_read_type
);
2244 /* See to_btrace_conf in struct target_ops. */
2245 extern const struct btrace_config
*
2246 target_btrace_conf (const struct btrace_target_info
*);
2248 /* See to_stop_recording in struct target_ops. */
2249 extern void target_stop_recording (void);
2251 /* See to_save_record in struct target_ops. */
2252 extern void target_save_record (const char *filename
);
2254 /* Query if the target supports deleting the execution log. */
2255 extern int target_supports_delete_record (void);
2257 /* See to_delete_record in struct target_ops. */
2258 extern void target_delete_record (void);
2260 /* See to_record_is_replaying in struct target_ops. */
2261 extern int target_record_is_replaying (void);
2263 /* See to_goto_record_begin in struct target_ops. */
2264 extern void target_goto_record_begin (void);
2266 /* See to_goto_record_end in struct target_ops. */
2267 extern void target_goto_record_end (void);
2269 /* See to_goto_record in struct target_ops. */
2270 extern void target_goto_record (ULONGEST insn
);
2272 /* See to_insn_history. */
2273 extern void target_insn_history (int size
, int flags
);
2275 /* See to_insn_history_from. */
2276 extern void target_insn_history_from (ULONGEST from
, int size
, int flags
);
2278 /* See to_insn_history_range. */
2279 extern void target_insn_history_range (ULONGEST begin
, ULONGEST end
, int flags
);
2281 /* See to_call_history. */
2282 extern void target_call_history (int size
, int flags
);
2284 /* See to_call_history_from. */
2285 extern void target_call_history_from (ULONGEST begin
, int size
, int flags
);
2287 /* See to_call_history_range. */
2288 extern void target_call_history_range (ULONGEST begin
, ULONGEST end
, int flags
);
2290 /* See to_decr_pc_after_break. */
2291 extern CORE_ADDR
target_decr_pc_after_break (struct gdbarch
*gdbarch
);
2293 /* See to_prepare_to_generate_core. */
2294 extern void target_prepare_to_generate_core (void);
2296 /* See to_done_generating_core. */
2297 extern void target_done_generating_core (void);
2299 #endif /* !defined (TARGET_H) */