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 /* The piece of the object requested is unavailable. */
217 TARGET_XFER_UNAVAILABLE = 2,
219 /* Generic I/O error. Note that it's important that this is '-1',
220 as we still have target_xfer-related code returning hardcoded
222 TARGET_XFER_E_IO = -1,
224 /* Keep list in sync with target_xfer_status_to_string. */
227 /* Return the string form of STATUS. */
230 target_xfer_status_to_string (enum target_xfer_status status);
232 /* Enumeration of the kinds of traceframe searches that a target may
233 be able to perform. */
244 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
245 DEF_VEC_P(static_tracepoint_marker_p);
247 typedef enum target_xfer_status
248 target_xfer_partial_ftype (struct target_ops *ops,
249 enum target_object object,
252 const gdb_byte *writebuf,
255 ULONGEST *xfered_len);
257 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
258 OBJECT. The OFFSET, for a seekable object, specifies the
259 starting point. The ANNEX can be used to provide additional
260 data-specific information to the target.
262 Return the number of bytes actually transfered, or a negative error
263 code (an 'enum target_xfer_error' value) if the transfer is not
264 supported or otherwise fails. Return of a positive value less than
265 LEN indicates that no further transfer is possible. Unlike the raw
266 to_xfer_partial interface, callers of these functions do not need
267 to retry partial transfers. */
269 extern LONGEST target_read (struct target_ops *ops,
270 enum target_object object,
271 const char *annex, gdb_byte *buf,
272 ULONGEST offset, LONGEST len);
274 struct memory_read_result
276 /* First address that was read. */
278 /* Past-the-end address. */
283 typedef struct memory_read_result memory_read_result_s;
284 DEF_VEC_O(memory_read_result_s);
286 extern void free_memory_read_result_vector (void *);
288 extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
292 extern LONGEST target_write (struct target_ops *ops,
293 enum target_object object,
294 const char *annex, const gdb_byte *buf,
295 ULONGEST offset, LONGEST len);
297 /* Similar to target_write, except that it also calls PROGRESS with
298 the number of bytes written and the opaque BATON after every
299 successful partial write (and before the first write). This is
300 useful for progress reporting and user interaction while writing
301 data. To abort the transfer, the progress callback can throw an
304 LONGEST target_write_with_progress (struct target_ops *ops,
305 enum target_object object,
306 const char *annex, const gdb_byte *buf,
307 ULONGEST offset, LONGEST len,
308 void (*progress) (ULONGEST, void *),
311 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
312 be read using OPS. The return value will be -1 if the transfer
313 fails or is not supported; 0 if the object is empty; or the length
314 of the object otherwise. If a positive value is returned, a
315 sufficiently large buffer will be allocated using xmalloc and
316 returned in *BUF_P containing the contents of the object.
318 This method should be used for objects sufficiently small to store
319 in a single xmalloc'd buffer, when no fixed bound on the object's
320 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
321 through this function. */
323 extern LONGEST target_read_alloc (struct target_ops *ops,
324 enum target_object object,
325 const char *annex, gdb_byte **buf_p);
327 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
328 returned as a string, allocated using xmalloc. If an error occurs
329 or the transfer is unsupported, NULL is returned. Empty objects
330 are returned as allocated but empty strings. A warning is issued
331 if the result contains any embedded NUL bytes. */
333 extern char *target_read_stralloc (struct target_ops *ops,
334 enum target_object object,
337 /* See target_ops->to_xfer_partial. */
338 extern target_xfer_partial_ftype target_xfer_partial;
340 /* Wrappers to target read/write that perform memory transfers. They
341 throw an error if the memory transfer fails.
343 NOTE: cagney/2003-10-23: The naming schema is lifted from
344 "frame.h". The parameter order is lifted from get_frame_memory,
345 which in turn lifted it from read_memory. */
347 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
348 gdb_byte *buf, LONGEST len);
349 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
350 CORE_ADDR addr, int len,
351 enum bfd_endian byte_order);
353 struct thread_info; /* fwd decl for parameter list below: */
355 /* The type of the callback to the to_async method. */
357 typedef void async_callback_ftype (enum inferior_event_type event_type,
360 /* Normally target debug printing is purely type-based. However,
361 sometimes it is necessary to override the debug printing on a
362 per-argument basis. This macro can be used, attribute-style, to
363 name the target debug printing function for a particular method
364 argument. FUNC is the name of the function. The macro's
365 definition is empty because it is only used by the
366 make-target-delegates script. */
368 #define TARGET_DEBUG_PRINTER(FUNC)
370 /* These defines are used to mark target_ops methods. The script
371 make-target-delegates scans these and auto-generates the base
372 method implementations. There are four macros that can be used:
374 1. TARGET_DEFAULT_IGNORE. There is no argument. The base method
375 does nothing. This is only valid if the method return type is
378 2. TARGET_DEFAULT_NORETURN. The argument is a function call, like
379 'tcomplain ()'. The base method simply makes this call, which is
380 assumed not to return.
382 3. TARGET_DEFAULT_RETURN. The argument is a C expression. The
383 base method returns this expression's value.
385 4. TARGET_DEFAULT_FUNC. The argument is the name of a function.
386 make-target-delegates does not generate a base method in this case,
387 but instead uses the argument function as the base method. */
389 #define TARGET_DEFAULT_IGNORE()
390 #define TARGET_DEFAULT_NORETURN(ARG)
391 #define TARGET_DEFAULT_RETURN(ARG)
392 #define TARGET_DEFAULT_FUNC(ARG)
396 struct target_ops *beneath; /* To the target under this one. */
397 const char *to_shortname; /* Name this target type */
398 const char *to_longname; /* Name for printing */
399 const char *to_doc; /* Documentation. Does not include trailing
400 newline, and starts with a one-line descrip-
401 tion (probably similar to to_longname). */
402 /* Per-target scratch pad. */
404 /* The open routine takes the rest of the parameters from the
405 command, and (if successful) pushes a new target onto the
406 stack. Targets should supply this routine, if only to provide
408 void (*to_open) (char *, int);
409 /* Old targets with a static target vector provide "to_close".
410 New re-entrant targets provide "to_xclose" and that is expected
411 to xfree everything (including the "struct target_ops"). */
412 void (*to_xclose) (struct target_ops *targ);
413 void (*to_close) (struct target_ops *);
414 /* Attaches to a process on the target side. Arguments are as
415 passed to the `attach' command by the user. This routine can
416 be called when the target is not on the target-stack, if the
417 target_can_run routine returns 1; in that case, it must push
418 itself onto the stack. Upon exit, the target should be ready
419 for normal operations, and should be ready to deliver the
420 status of the process immediately (without waiting) to an
421 upcoming target_wait call. */
422 void (*to_attach) (struct target_ops *ops, const char *, int);
423 void (*to_post_attach) (struct target_ops *, int)
424 TARGET_DEFAULT_IGNORE ();
425 void (*to_detach) (struct target_ops *ops, const char *, int)
426 TARGET_DEFAULT_IGNORE ();
427 void (*to_disconnect) (struct target_ops *, const char *, int)
428 TARGET_DEFAULT_NORETURN (tcomplain ());
429 void (*to_resume) (struct target_ops *, ptid_t,
430 int TARGET_DEBUG_PRINTER (target_debug_print_step),
432 TARGET_DEFAULT_NORETURN (noprocess ());
433 ptid_t (*to_wait) (struct target_ops *,
434 ptid_t, struct target_waitstatus *,
435 int TARGET_DEBUG_PRINTER (target_debug_print_options))
436 TARGET_DEFAULT_NORETURN (noprocess ());
437 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int)
438 TARGET_DEFAULT_IGNORE ();
439 void (*to_store_registers) (struct target_ops *, struct regcache *, int)
440 TARGET_DEFAULT_NORETURN (noprocess ());
441 void (*to_prepare_to_store) (struct target_ops *, struct regcache *)
442 TARGET_DEFAULT_NORETURN (noprocess ());
444 void (*to_files_info) (struct target_ops *)
445 TARGET_DEFAULT_IGNORE ();
446 int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
447 struct bp_target_info *)
448 TARGET_DEFAULT_FUNC (memory_insert_breakpoint);
449 int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
450 struct bp_target_info *)
451 TARGET_DEFAULT_FUNC (memory_remove_breakpoint);
452 int (*to_can_use_hw_breakpoint) (struct target_ops *, int, int, int)
453 TARGET_DEFAULT_RETURN (0);
454 int (*to_ranged_break_num_registers) (struct target_ops *)
455 TARGET_DEFAULT_RETURN (-1);
456 int (*to_insert_hw_breakpoint) (struct target_ops *,
457 struct gdbarch *, struct bp_target_info *)
458 TARGET_DEFAULT_RETURN (-1);
459 int (*to_remove_hw_breakpoint) (struct target_ops *,
460 struct gdbarch *, struct bp_target_info *)
461 TARGET_DEFAULT_RETURN (-1);
463 /* Documentation of what the two routines below are expected to do is
464 provided with the corresponding target_* macros. */
465 int (*to_remove_watchpoint) (struct target_ops *,
466 CORE_ADDR, int, int, struct expression *)
467 TARGET_DEFAULT_RETURN (-1);
468 int (*to_insert_watchpoint) (struct target_ops *,
469 CORE_ADDR, int, int, struct expression *)
470 TARGET_DEFAULT_RETURN (-1);
472 int (*to_insert_mask_watchpoint) (struct target_ops *,
473 CORE_ADDR, CORE_ADDR, int)
474 TARGET_DEFAULT_RETURN (1);
475 int (*to_remove_mask_watchpoint) (struct target_ops *,
476 CORE_ADDR, CORE_ADDR, int)
477 TARGET_DEFAULT_RETURN (1);
478 int (*to_stopped_by_watchpoint) (struct target_ops *)
479 TARGET_DEFAULT_RETURN (0);
480 int to_have_steppable_watchpoint;
481 int to_have_continuable_watchpoint;
482 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *)
483 TARGET_DEFAULT_RETURN (0);
484 int (*to_watchpoint_addr_within_range) (struct target_ops *,
485 CORE_ADDR, CORE_ADDR, int)
486 TARGET_DEFAULT_FUNC (default_watchpoint_addr_within_range);
488 /* Documentation of this routine is provided with the corresponding
490 int (*to_region_ok_for_hw_watchpoint) (struct target_ops *,
492 TARGET_DEFAULT_FUNC (default_region_ok_for_hw_watchpoint);
494 int (*to_can_accel_watchpoint_condition) (struct target_ops *,
497 TARGET_DEFAULT_RETURN (0);
498 int (*to_masked_watch_num_registers) (struct target_ops *,
499 CORE_ADDR, CORE_ADDR)
500 TARGET_DEFAULT_RETURN (-1);
501 void (*to_terminal_init) (struct target_ops *)
502 TARGET_DEFAULT_IGNORE ();
503 void (*to_terminal_inferior) (struct target_ops *)
504 TARGET_DEFAULT_IGNORE ();
505 void (*to_terminal_ours_for_output) (struct target_ops *)
506 TARGET_DEFAULT_IGNORE ();
507 void (*to_terminal_ours) (struct target_ops *)
508 TARGET_DEFAULT_IGNORE ();
509 void (*to_terminal_save_ours) (struct target_ops *)
510 TARGET_DEFAULT_IGNORE ();
511 void (*to_terminal_info) (struct target_ops *, const char *, int)
512 TARGET_DEFAULT_FUNC (default_terminal_info);
513 void (*to_kill) (struct target_ops *)
514 TARGET_DEFAULT_NORETURN (noprocess ());
515 void (*to_load) (struct target_ops *, const char *, int)
516 TARGET_DEFAULT_NORETURN (tcomplain ());
517 /* Start an inferior process and set inferior_ptid to its pid.
518 EXEC_FILE is the file to run.
519 ALLARGS is a string containing the arguments to the program.
520 ENV is the environment vector to pass. Errors reported with error().
521 On VxWorks and various standalone systems, we ignore exec_file. */
522 void (*to_create_inferior) (struct target_ops *,
523 char *, char *, char **, int);
524 void (*to_post_startup_inferior) (struct target_ops *, ptid_t)
525 TARGET_DEFAULT_IGNORE ();
526 int (*to_insert_fork_catchpoint) (struct target_ops *, int)
527 TARGET_DEFAULT_RETURN (1);
528 int (*to_remove_fork_catchpoint) (struct target_ops *, int)
529 TARGET_DEFAULT_RETURN (1);
530 int (*to_insert_vfork_catchpoint) (struct target_ops *, int)
531 TARGET_DEFAULT_RETURN (1);
532 int (*to_remove_vfork_catchpoint) (struct target_ops *, int)
533 TARGET_DEFAULT_RETURN (1);
534 int (*to_follow_fork) (struct target_ops *, int, int)
535 TARGET_DEFAULT_FUNC (default_follow_fork);
536 int (*to_insert_exec_catchpoint) (struct target_ops *, int)
537 TARGET_DEFAULT_RETURN (1);
538 int (*to_remove_exec_catchpoint) (struct target_ops *, int)
539 TARGET_DEFAULT_RETURN (1);
540 int (*to_set_syscall_catchpoint) (struct target_ops *,
541 int, int, int, int, int *)
542 TARGET_DEFAULT_RETURN (1);
543 int (*to_has_exited) (struct target_ops *, int, int, int *)
544 TARGET_DEFAULT_RETURN (0);
545 void (*to_mourn_inferior) (struct target_ops *)
546 TARGET_DEFAULT_FUNC (default_mourn_inferior);
547 /* Note that to_can_run is special and can be invoked on an
548 unpushed target. Targets defining this method must also define
549 to_can_async_p and to_supports_non_stop. */
550 int (*to_can_run) (struct target_ops *)
551 TARGET_DEFAULT_RETURN (0);
553 /* Documentation of this routine is provided with the corresponding
555 void (*to_pass_signals) (struct target_ops *, int,
556 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals))
557 TARGET_DEFAULT_IGNORE ();
559 /* Documentation of this routine is provided with the
560 corresponding target_* function. */
561 void (*to_program_signals) (struct target_ops *, int,
562 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals))
563 TARGET_DEFAULT_IGNORE ();
565 int (*to_thread_alive) (struct target_ops *, ptid_t ptid)
566 TARGET_DEFAULT_RETURN (0);
567 void (*to_find_new_threads) (struct target_ops *)
568 TARGET_DEFAULT_IGNORE ();
569 char *(*to_pid_to_str) (struct target_ops *, ptid_t)
570 TARGET_DEFAULT_FUNC (default_pid_to_str);
571 char *(*to_extra_thread_info) (struct target_ops *, struct thread_info *)
572 TARGET_DEFAULT_RETURN (NULL);
573 char *(*to_thread_name) (struct target_ops *, struct thread_info *)
574 TARGET_DEFAULT_RETURN (NULL);
575 void (*to_stop) (struct target_ops *, ptid_t)
576 TARGET_DEFAULT_IGNORE ();
577 void (*to_rcmd) (struct target_ops *,
578 const char *command, struct ui_file *output)
579 TARGET_DEFAULT_FUNC (default_rcmd);
580 char *(*to_pid_to_exec_file) (struct target_ops *, int pid)
581 TARGET_DEFAULT_RETURN (NULL);
582 void (*to_log_command) (struct target_ops *, const char *)
583 TARGET_DEFAULT_IGNORE ();
584 struct target_section_table *(*to_get_section_table) (struct target_ops *)
585 TARGET_DEFAULT_RETURN (NULL);
586 enum strata to_stratum;
587 int (*to_has_all_memory) (struct target_ops *);
588 int (*to_has_memory) (struct target_ops *);
589 int (*to_has_stack) (struct target_ops *);
590 int (*to_has_registers) (struct target_ops *);
591 int (*to_has_execution) (struct target_ops *, ptid_t);
592 int to_has_thread_control; /* control thread execution */
593 int to_attach_no_wait;
594 /* This method must be implemented in some situations. See the
595 comment on 'to_can_run'. */
596 int (*to_can_async_p) (struct target_ops *)
597 TARGET_DEFAULT_RETURN (0);
598 int (*to_is_async_p) (struct target_ops *)
599 TARGET_DEFAULT_RETURN (0);
600 void (*to_async) (struct target_ops *, async_callback_ftype *, void *)
601 TARGET_DEFAULT_NORETURN (tcomplain ());
602 /* This method must be implemented in some situations. See the
603 comment on 'to_can_run'. */
604 int (*to_supports_non_stop) (struct target_ops *)
605 TARGET_DEFAULT_RETURN (0);
606 /* find_memory_regions support method for gcore */
607 int (*to_find_memory_regions) (struct target_ops *,
608 find_memory_region_ftype func, void *data)
609 TARGET_DEFAULT_FUNC (dummy_find_memory_regions);
610 /* make_corefile_notes support method for gcore */
611 char * (*to_make_corefile_notes) (struct target_ops *, bfd *, int *)
612 TARGET_DEFAULT_FUNC (dummy_make_corefile_notes);
613 /* get_bookmark support method for bookmarks */
614 gdb_byte * (*to_get_bookmark) (struct target_ops *, const char *, int)
615 TARGET_DEFAULT_NORETURN (tcomplain ());
616 /* goto_bookmark support method for bookmarks */
617 void (*to_goto_bookmark) (struct target_ops *, const gdb_byte *, int)
618 TARGET_DEFAULT_NORETURN (tcomplain ());
619 /* Return the thread-local address at OFFSET in the
620 thread-local storage for the thread PTID and the shared library
621 or executable file given by OBJFILE. If that block of
622 thread-local storage hasn't been allocated yet, this function
623 may return an error. LOAD_MODULE_ADDR may be zero for statically
624 linked multithreaded inferiors. */
625 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
627 CORE_ADDR load_module_addr,
629 TARGET_DEFAULT_NORETURN (generic_tls_error ());
631 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
632 OBJECT. The OFFSET, for a seekable object, specifies the
633 starting point. The ANNEX can be used to provide additional
634 data-specific information to the target.
636 Return the transferred status, error or OK (an
637 'enum target_xfer_status' value). Save the number of bytes
638 actually transferred in *XFERED_LEN if transfer is successful
639 (TARGET_XFER_OK) or the number unavailable bytes if the requested
640 data is unavailable (TARGET_XFER_UNAVAILABLE). *XFERED_LEN
641 smaller than LEN does not indicate the end of the object, only
642 the end of the transfer; higher level code should continue
643 transferring if desired. This is handled in target.c.
645 The interface does not support a "retry" mechanism. Instead it
646 assumes that at least one byte will be transfered on each
649 NOTE: cagney/2003-10-17: The current interface can lead to
650 fragmented transfers. Lower target levels should not implement
651 hacks, such as enlarging the transfer, in an attempt to
652 compensate for this. Instead, the target stack should be
653 extended so that it implements supply/collect methods and a
654 look-aside object cache. With that available, the lowest
655 target can safely and freely "push" data up the stack.
657 See target_read and target_write for more information. One,
658 and only one, of readbuf or writebuf must be non-NULL. */
660 enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
661 enum target_object object,
664 const gdb_byte *writebuf,
665 ULONGEST offset, ULONGEST len,
666 ULONGEST *xfered_len)
667 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
669 /* Returns the memory map for the target. A return value of NULL
670 means that no memory map is available. If a memory address
671 does not fall within any returned regions, it's assumed to be
672 RAM. The returned memory regions should not overlap.
674 The order of regions does not matter; target_memory_map will
675 sort regions by starting address. For that reason, this
676 function should not be called directly except via
679 This method should not cache data; if the memory map could
680 change unexpectedly, it should be invalidated, and higher
681 layers will re-fetch it. */
682 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *)
683 TARGET_DEFAULT_RETURN (NULL);
685 /* Erases the region of flash memory starting at ADDRESS, of
688 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
689 on flash block boundaries, as reported by 'to_memory_map'. */
690 void (*to_flash_erase) (struct target_ops *,
691 ULONGEST address, LONGEST length)
692 TARGET_DEFAULT_NORETURN (tcomplain ());
694 /* Finishes a flash memory write sequence. After this operation
695 all flash memory should be available for writing and the result
696 of reading from areas written by 'to_flash_write' should be
697 equal to what was written. */
698 void (*to_flash_done) (struct target_ops *)
699 TARGET_DEFAULT_NORETURN (tcomplain ());
701 /* Describe the architecture-specific features of this target. If
702 OPS doesn't have a description, this should delegate to the
703 "beneath" target. Returns the description found, or NULL if no
704 description was available. */
705 const struct target_desc *(*to_read_description) (struct target_ops *ops)
706 TARGET_DEFAULT_RETURN (NULL);
708 /* Build the PTID of the thread on which a given task is running,
709 based on LWP and THREAD. These values are extracted from the
710 task Private_Data section of the Ada Task Control Block, and
711 their interpretation depends on the target. */
712 ptid_t (*to_get_ada_task_ptid) (struct target_ops *,
713 long lwp, long thread)
714 TARGET_DEFAULT_FUNC (default_get_ada_task_ptid);
716 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
717 Return 0 if *READPTR is already at the end of the buffer.
718 Return -1 if there is insufficient buffer for a whole entry.
719 Return 1 if an entry was read into *TYPEP and *VALP. */
720 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
721 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
722 TARGET_DEFAULT_FUNC (default_auxv_parse);
724 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
725 sequence of bytes in PATTERN with length PATTERN_LEN.
727 The result is 1 if found, 0 if not found, and -1 if there was an error
728 requiring halting of the search (e.g. memory read error).
729 If the pattern is found the address is recorded in FOUND_ADDRP. */
730 int (*to_search_memory) (struct target_ops *ops,
731 CORE_ADDR start_addr, ULONGEST search_space_len,
732 const gdb_byte *pattern, ULONGEST pattern_len,
733 CORE_ADDR *found_addrp)
734 TARGET_DEFAULT_FUNC (default_search_memory);
736 /* Can target execute in reverse? */
737 int (*to_can_execute_reverse) (struct target_ops *)
738 TARGET_DEFAULT_RETURN (0);
740 /* The direction the target is currently executing. Must be
741 implemented on targets that support reverse execution and async
742 mode. The default simply returns forward execution. */
743 enum exec_direction_kind (*to_execution_direction) (struct target_ops *)
744 TARGET_DEFAULT_FUNC (default_execution_direction);
746 /* Does this target support debugging multiple processes
748 int (*to_supports_multi_process) (struct target_ops *)
749 TARGET_DEFAULT_RETURN (0);
751 /* Does this target support enabling and disabling tracepoints while a trace
752 experiment is running? */
753 int (*to_supports_enable_disable_tracepoint) (struct target_ops *)
754 TARGET_DEFAULT_RETURN (0);
756 /* Does this target support disabling address space randomization? */
757 int (*to_supports_disable_randomization) (struct target_ops *);
759 /* Does this target support the tracenz bytecode for string collection? */
760 int (*to_supports_string_tracing) (struct target_ops *)
761 TARGET_DEFAULT_RETURN (0);
763 /* Does this target support evaluation of breakpoint conditions on its
765 int (*to_supports_evaluation_of_breakpoint_conditions) (struct target_ops *)
766 TARGET_DEFAULT_RETURN (0);
768 /* Does this target support evaluation of breakpoint commands on its
770 int (*to_can_run_breakpoint_commands) (struct target_ops *)
771 TARGET_DEFAULT_RETURN (0);
773 /* Determine current architecture of thread PTID.
775 The target is supposed to determine the architecture of the code where
776 the target is currently stopped at (on Cell, if a target is in spu_run,
777 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
778 This is architecture used to perform decr_pc_after_break adjustment,
779 and also determines the frame architecture of the innermost frame.
780 ptrace operations need to operate according to target_gdbarch ().
782 The default implementation always returns target_gdbarch (). */
783 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t)
784 TARGET_DEFAULT_FUNC (default_thread_architecture);
786 /* Determine current address space of thread PTID.
788 The default implementation always returns the inferior's
790 struct address_space *(*to_thread_address_space) (struct target_ops *,
792 TARGET_DEFAULT_FUNC (default_thread_address_space);
794 /* Target file operations. */
796 /* Open FILENAME on the target, using FLAGS and MODE. Return a
797 target file descriptor, or -1 if an error occurs (and set
799 int (*to_fileio_open) (struct target_ops *,
800 const char *filename, int flags, int mode,
803 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
804 Return the number of bytes written, or -1 if an error occurs
805 (and set *TARGET_ERRNO). */
806 int (*to_fileio_pwrite) (struct target_ops *,
807 int fd, const gdb_byte *write_buf, int len,
808 ULONGEST offset, int *target_errno);
810 /* Read up to LEN bytes FD on the target into READ_BUF.
811 Return the number of bytes read, or -1 if an error occurs
812 (and set *TARGET_ERRNO). */
813 int (*to_fileio_pread) (struct target_ops *,
814 int fd, gdb_byte *read_buf, int len,
815 ULONGEST offset, int *target_errno);
817 /* Close FD on the target. Return 0, or -1 if an error occurs
818 (and set *TARGET_ERRNO). */
819 int (*to_fileio_close) (struct target_ops *, int fd, int *target_errno);
821 /* Unlink FILENAME on the target. Return 0, or -1 if an error
822 occurs (and set *TARGET_ERRNO). */
823 int (*to_fileio_unlink) (struct target_ops *,
824 const char *filename, int *target_errno);
826 /* Read value of symbolic link FILENAME on the target. Return a
827 null-terminated string allocated via xmalloc, or NULL if an error
828 occurs (and set *TARGET_ERRNO). */
829 char *(*to_fileio_readlink) (struct target_ops *,
830 const char *filename, int *target_errno);
833 /* Implement the "info proc" command. */
834 void (*to_info_proc) (struct target_ops *, const char *,
835 enum info_proc_what);
837 /* Tracepoint-related operations. */
839 /* Prepare the target for a tracing run. */
840 void (*to_trace_init) (struct target_ops *)
841 TARGET_DEFAULT_NORETURN (tcomplain ());
843 /* Send full details of a tracepoint location to the target. */
844 void (*to_download_tracepoint) (struct target_ops *,
845 struct bp_location *location)
846 TARGET_DEFAULT_NORETURN (tcomplain ());
848 /* Is the target able to download tracepoint locations in current
850 int (*to_can_download_tracepoint) (struct target_ops *)
851 TARGET_DEFAULT_RETURN (0);
853 /* Send full details of a trace state variable to the target. */
854 void (*to_download_trace_state_variable) (struct target_ops *,
855 struct trace_state_variable *tsv)
856 TARGET_DEFAULT_NORETURN (tcomplain ());
858 /* Enable a tracepoint on the target. */
859 void (*to_enable_tracepoint) (struct target_ops *,
860 struct bp_location *location)
861 TARGET_DEFAULT_NORETURN (tcomplain ());
863 /* Disable a tracepoint on the target. */
864 void (*to_disable_tracepoint) (struct target_ops *,
865 struct bp_location *location)
866 TARGET_DEFAULT_NORETURN (tcomplain ());
868 /* Inform the target info of memory regions that are readonly
869 (such as text sections), and so it should return data from
870 those rather than look in the trace buffer. */
871 void (*to_trace_set_readonly_regions) (struct target_ops *)
872 TARGET_DEFAULT_NORETURN (tcomplain ());
874 /* Start a trace run. */
875 void (*to_trace_start) (struct target_ops *)
876 TARGET_DEFAULT_NORETURN (tcomplain ());
878 /* Get the current status of a tracing run. */
879 int (*to_get_trace_status) (struct target_ops *, struct trace_status *ts)
880 TARGET_DEFAULT_RETURN (-1);
882 void (*to_get_tracepoint_status) (struct target_ops *,
883 struct breakpoint *tp,
884 struct uploaded_tp *utp)
885 TARGET_DEFAULT_NORETURN (tcomplain ());
887 /* Stop a trace run. */
888 void (*to_trace_stop) (struct target_ops *)
889 TARGET_DEFAULT_NORETURN (tcomplain ());
891 /* Ask the target to find a trace frame of the given type TYPE,
892 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
893 number of the trace frame, and also the tracepoint number at
894 TPP. If no trace frame matches, return -1. May throw if the
896 int (*to_trace_find) (struct target_ops *,
897 enum trace_find_type type, int num,
898 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
899 TARGET_DEFAULT_RETURN (-1);
901 /* Get the value of the trace state variable number TSV, returning
902 1 if the value is known and writing the value itself into the
903 location pointed to by VAL, else returning 0. */
904 int (*to_get_trace_state_variable_value) (struct target_ops *,
905 int tsv, LONGEST *val)
906 TARGET_DEFAULT_RETURN (0);
908 int (*to_save_trace_data) (struct target_ops *, const char *filename)
909 TARGET_DEFAULT_NORETURN (tcomplain ());
911 int (*to_upload_tracepoints) (struct target_ops *,
912 struct uploaded_tp **utpp)
913 TARGET_DEFAULT_RETURN (0);
915 int (*to_upload_trace_state_variables) (struct target_ops *,
916 struct uploaded_tsv **utsvp)
917 TARGET_DEFAULT_RETURN (0);
919 LONGEST (*to_get_raw_trace_data) (struct target_ops *, gdb_byte *buf,
920 ULONGEST offset, LONGEST len)
921 TARGET_DEFAULT_NORETURN (tcomplain ());
923 /* Get the minimum length of instruction on which a fast tracepoint
924 may be set on the target. If this operation is unsupported,
925 return -1. If for some reason the minimum length cannot be
926 determined, return 0. */
927 int (*to_get_min_fast_tracepoint_insn_len) (struct target_ops *)
928 TARGET_DEFAULT_RETURN (-1);
930 /* Set the target's tracing behavior in response to unexpected
931 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
932 void (*to_set_disconnected_tracing) (struct target_ops *, int val)
933 TARGET_DEFAULT_IGNORE ();
934 void (*to_set_circular_trace_buffer) (struct target_ops *, int val)
935 TARGET_DEFAULT_IGNORE ();
936 /* Set the size of trace buffer in the target. */
937 void (*to_set_trace_buffer_size) (struct target_ops *, LONGEST val)
938 TARGET_DEFAULT_IGNORE ();
940 /* Add/change textual notes about the trace run, returning 1 if
941 successful, 0 otherwise. */
942 int (*to_set_trace_notes) (struct target_ops *,
943 const char *user, const char *notes,
944 const char *stopnotes)
945 TARGET_DEFAULT_RETURN (0);
947 /* Return the processor core that thread PTID was last seen on.
948 This information is updated only when:
949 - update_thread_list is called
951 If the core cannot be determined -- either for the specified
952 thread, or right now, or in this debug session, or for this
953 target -- return -1. */
954 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid)
955 TARGET_DEFAULT_RETURN (-1);
957 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
958 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
959 a match, 0 if there's a mismatch, and -1 if an error is
960 encountered while reading memory. */
961 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
962 CORE_ADDR memaddr, ULONGEST size)
963 TARGET_DEFAULT_FUNC (default_verify_memory);
965 /* Return the address of the start of the Thread Information Block
966 a Windows OS specific feature. */
967 int (*to_get_tib_address) (struct target_ops *,
968 ptid_t ptid, CORE_ADDR *addr)
969 TARGET_DEFAULT_NORETURN (tcomplain ());
971 /* Send the new settings of write permission variables. */
972 void (*to_set_permissions) (struct target_ops *)
973 TARGET_DEFAULT_IGNORE ();
975 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
976 with its details. Return 1 on success, 0 on failure. */
977 int (*to_static_tracepoint_marker_at) (struct target_ops *, CORE_ADDR,
978 struct static_tracepoint_marker *marker)
979 TARGET_DEFAULT_RETURN (0);
981 /* Return a vector of all tracepoints markers string id ID, or all
982 markers if ID is NULL. */
983 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid) (struct target_ops *, const char *id)
984 TARGET_DEFAULT_NORETURN (tcomplain ());
986 /* Return a traceframe info object describing the current
987 traceframe's contents. This method should not cache data;
988 higher layers take care of caching, invalidating, and
989 re-fetching when necessary. */
990 struct traceframe_info *(*to_traceframe_info) (struct target_ops *)
991 TARGET_DEFAULT_NORETURN (tcomplain ());
993 /* Ask the target to use or not to use agent according to USE. Return 1
994 successful, 0 otherwise. */
995 int (*to_use_agent) (struct target_ops *, int use)
996 TARGET_DEFAULT_NORETURN (tcomplain ());
998 /* Is the target able to use agent in current state? */
999 int (*to_can_use_agent) (struct target_ops *)
1000 TARGET_DEFAULT_RETURN (0);
1002 /* Check whether the target supports branch tracing. */
1003 int (*to_supports_btrace) (struct target_ops *)
1004 TARGET_DEFAULT_RETURN (0);
1006 /* Enable branch tracing for PTID and allocate a branch trace target
1007 information struct for reading and for disabling branch trace. */
1008 struct btrace_target_info *(*to_enable_btrace) (struct target_ops *,
1010 TARGET_DEFAULT_NORETURN (tcomplain ());
1012 /* Disable branch tracing and deallocate TINFO. */
1013 void (*to_disable_btrace) (struct target_ops *,
1014 struct btrace_target_info *tinfo)
1015 TARGET_DEFAULT_NORETURN (tcomplain ());
1017 /* Disable branch tracing and deallocate TINFO. This function is similar
1018 to to_disable_btrace, except that it is called during teardown and is
1019 only allowed to perform actions that are safe. A counter-example would
1020 be attempting to talk to a remote target. */
1021 void (*to_teardown_btrace) (struct target_ops *,
1022 struct btrace_target_info *tinfo)
1023 TARGET_DEFAULT_NORETURN (tcomplain ());
1025 /* Read branch trace data for the thread indicated by BTINFO into DATA.
1026 DATA is cleared before new trace is added.
1027 The branch trace will start with the most recent block and continue
1028 towards older blocks. */
1029 enum btrace_error (*to_read_btrace) (struct target_ops *self,
1030 VEC (btrace_block_s) **data,
1031 struct btrace_target_info *btinfo,
1032 enum btrace_read_type type)
1033 TARGET_DEFAULT_NORETURN (tcomplain ());
1035 /* Stop trace recording. */
1036 void (*to_stop_recording) (struct target_ops *)
1037 TARGET_DEFAULT_IGNORE ();
1039 /* Print information about the recording. */
1040 void (*to_info_record) (struct target_ops *)
1041 TARGET_DEFAULT_IGNORE ();
1043 /* Save the recorded execution trace into a file. */
1044 void (*to_save_record) (struct target_ops *, const char *filename)
1045 TARGET_DEFAULT_NORETURN (tcomplain ());
1047 /* Delete the recorded execution trace from the current position
1049 void (*to_delete_record) (struct target_ops *)
1050 TARGET_DEFAULT_NORETURN (tcomplain ());
1052 /* Query if the record target is currently replaying. */
1053 int (*to_record_is_replaying) (struct target_ops *)
1054 TARGET_DEFAULT_RETURN (0);
1056 /* Go to the begin of the execution trace. */
1057 void (*to_goto_record_begin) (struct target_ops *)
1058 TARGET_DEFAULT_NORETURN (tcomplain ());
1060 /* Go to the end of the execution trace. */
1061 void (*to_goto_record_end) (struct target_ops *)
1062 TARGET_DEFAULT_NORETURN (tcomplain ());
1064 /* Go to a specific location in the recorded execution trace. */
1065 void (*to_goto_record) (struct target_ops *, ULONGEST insn)
1066 TARGET_DEFAULT_NORETURN (tcomplain ());
1068 /* Disassemble SIZE instructions in the recorded execution trace from
1069 the current position.
1070 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1071 disassemble SIZE succeeding instructions. */
1072 void (*to_insn_history) (struct target_ops *, int size, int flags)
1073 TARGET_DEFAULT_NORETURN (tcomplain ());
1075 /* Disassemble SIZE instructions in the recorded execution trace around
1077 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1078 disassemble SIZE instructions after FROM. */
1079 void (*to_insn_history_from) (struct target_ops *,
1080 ULONGEST from, int size, int flags)
1081 TARGET_DEFAULT_NORETURN (tcomplain ());
1083 /* Disassemble a section of the recorded execution trace from instruction
1084 BEGIN (inclusive) to instruction END (inclusive). */
1085 void (*to_insn_history_range) (struct target_ops *,
1086 ULONGEST begin, ULONGEST end, int flags)
1087 TARGET_DEFAULT_NORETURN (tcomplain ());
1089 /* Print a function trace of the recorded execution trace.
1090 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1091 succeeding functions. */
1092 void (*to_call_history) (struct target_ops *, int size, int flags)
1093 TARGET_DEFAULT_NORETURN (tcomplain ());
1095 /* Print a function trace of the recorded execution trace starting
1097 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1098 SIZE functions after FROM. */
1099 void (*to_call_history_from) (struct target_ops *,
1100 ULONGEST begin, int size, int flags)
1101 TARGET_DEFAULT_NORETURN (tcomplain ());
1103 /* Print a function trace of an execution trace section from function BEGIN
1104 (inclusive) to function END (inclusive). */
1105 void (*to_call_history_range) (struct target_ops *,
1106 ULONGEST begin, ULONGEST end, int flags)
1107 TARGET_DEFAULT_NORETURN (tcomplain ());
1109 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1111 int (*to_augmented_libraries_svr4_read) (struct target_ops *)
1112 TARGET_DEFAULT_RETURN (0);
1114 /* Those unwinders are tried before any other arch unwinders. If
1115 SELF doesn't have unwinders, it should delegate to the
1116 "beneath" target. */
1117 const struct frame_unwind *(*to_get_unwinder) (struct target_ops *self)
1118 TARGET_DEFAULT_RETURN (NULL);
1120 const struct frame_unwind *(*to_get_tailcall_unwinder) (struct target_ops *self)
1121 TARGET_DEFAULT_RETURN (NULL);
1123 /* Return the number of bytes by which the PC needs to be decremented
1124 after executing a breakpoint instruction.
1125 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
1126 CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
1127 struct gdbarch *gdbarch)
1128 TARGET_DEFAULT_FUNC (default_target_decr_pc_after_break);
1130 /* Prepare to generate a core file. */
1131 void (*to_prepare_to_generate_core) (struct target_ops *)
1132 TARGET_DEFAULT_IGNORE ();
1134 /* Cleanup after generating a core file. */
1135 void (*to_done_generating_core) (struct target_ops *)
1136 TARGET_DEFAULT_IGNORE ();
1139 /* Need sub-structure for target machine related rather than comm related?
1143 /* Magic number for checking ops size. If a struct doesn't end with this
1144 number, somebody changed the declaration but didn't change all the
1145 places that initialize one. */
1147 #define OPS_MAGIC 3840
1149 /* The ops structure for our "current" target process. This should
1150 never be NULL. If there is no target, it points to the dummy_target. */
1152 extern struct target_ops current_target;
1154 /* Define easy words for doing these operations on our current target. */
1156 #define target_shortname (current_target.to_shortname)
1157 #define target_longname (current_target.to_longname)
1159 /* Does whatever cleanup is required for a target that we are no
1160 longer going to be calling. This routine is automatically always
1161 called after popping the target off the target stack - the target's
1162 own methods are no longer available through the target vector.
1163 Closing file descriptors and freeing all memory allocated memory are
1164 typical things it should do. */
1166 void target_close (struct target_ops *targ);
1168 /* Find the correct target to use for "attach". If a target on the
1169 current stack supports attaching, then it is returned. Otherwise,
1170 the default run target is returned. */
1172 extern struct target_ops *find_attach_target (void);
1174 /* Find the correct target to use for "run". If a target on the
1175 current stack supports creating a new inferior, then it is
1176 returned. Otherwise, the default run target is returned. */
1178 extern struct target_ops *find_run_target (void);
1180 /* Some targets don't generate traps when attaching to the inferior,
1181 or their target_attach implementation takes care of the waiting.
1182 These targets must set to_attach_no_wait. */
1184 #define target_attach_no_wait \
1185 (current_target.to_attach_no_wait)
1187 /* The target_attach operation places a process under debugger control,
1188 and stops the process.
1190 This operation provides a target-specific hook that allows the
1191 necessary bookkeeping to be performed after an attach completes. */
1192 #define target_post_attach(pid) \
1193 (*current_target.to_post_attach) (¤t_target, pid)
1195 /* Takes a program previously attached to and detaches it.
1196 The program may resume execution (some targets do, some don't) and will
1197 no longer stop on signals, etc. We better not have left any breakpoints
1198 in the program or it'll die when it hits one. ARGS is arguments
1199 typed by the user (e.g. a signal to send the process). FROM_TTY
1200 says whether to be verbose or not. */
1202 extern void target_detach (const char *, int);
1204 /* Disconnect from the current target without resuming it (leaving it
1205 waiting for a debugger). */
1207 extern void target_disconnect (const char *, int);
1209 /* Resume execution of the target process PTID (or a group of
1210 threads). STEP says whether to single-step or to run free; SIGGNAL
1211 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1212 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1213 PTID means `step/resume only this process id'. A wildcard PTID
1214 (all threads, or all threads of process) means `step/resume
1215 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1216 matches) resume with their 'thread->suspend.stop_signal' signal
1217 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1218 if in "no pass" state. */
1220 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1222 /* Wait for process pid to do something. PTID = -1 to wait for any
1223 pid to do something. Return pid of child, or -1 in case of error;
1224 store status through argument pointer STATUS. Note that it is
1225 _NOT_ OK to throw_exception() out of target_wait() without popping
1226 the debugging target from the stack; GDB isn't prepared to get back
1227 to the prompt with a debugging target but without the frame cache,
1228 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1231 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1234 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1236 extern void target_fetch_registers (struct regcache *regcache, int regno);
1238 /* Store at least register REGNO, or all regs if REGNO == -1.
1239 It can store as many registers as it wants to, so target_prepare_to_store
1240 must have been previously called. Calls error() if there are problems. */
1242 extern void target_store_registers (struct regcache *regcache, int regs);
1244 /* Get ready to modify the registers array. On machines which store
1245 individual registers, this doesn't need to do anything. On machines
1246 which store all the registers in one fell swoop, this makes sure
1247 that REGISTERS contains all the registers from the program being
1250 #define target_prepare_to_store(regcache) \
1251 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1253 /* Determine current address space of thread PTID. */
1255 struct address_space *target_thread_address_space (ptid_t);
1257 /* Implement the "info proc" command. This returns one if the request
1258 was handled, and zero otherwise. It can also throw an exception if
1259 an error was encountered while attempting to handle the
1262 int target_info_proc (const char *, enum info_proc_what);
1264 /* Returns true if this target can debug multiple processes
1267 #define target_supports_multi_process() \
1268 (*current_target.to_supports_multi_process) (¤t_target)
1270 /* Returns true if this target can disable address space randomization. */
1272 int target_supports_disable_randomization (void);
1274 /* Returns true if this target can enable and disable tracepoints
1275 while a trace experiment is running. */
1277 #define target_supports_enable_disable_tracepoint() \
1278 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1280 #define target_supports_string_tracing() \
1281 (*current_target.to_supports_string_tracing) (¤t_target)
1283 /* Returns true if this target can handle breakpoint conditions
1286 #define target_supports_evaluation_of_breakpoint_conditions() \
1287 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1289 /* Returns true if this target can handle breakpoint commands
1292 #define target_can_run_breakpoint_commands() \
1293 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1295 extern int target_read_string (CORE_ADDR, char **, int, int *);
1297 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1300 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1303 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1305 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1307 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1310 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1313 /* Fetches the target's memory map. If one is found it is sorted
1314 and returned, after some consistency checking. Otherwise, NULL
1316 VEC(mem_region_s) *target_memory_map (void);
1318 /* Erase the specified flash region. */
1319 void target_flash_erase (ULONGEST address, LONGEST length);
1321 /* Finish a sequence of flash operations. */
1322 void target_flash_done (void);
1324 /* Describes a request for a memory write operation. */
1325 struct memory_write_request
1327 /* Begining address that must be written. */
1329 /* Past-the-end address. */
1331 /* The data to write. */
1333 /* A callback baton for progress reporting for this request. */
1336 typedef struct memory_write_request memory_write_request_s;
1337 DEF_VEC_O(memory_write_request_s);
1339 /* Enumeration specifying different flash preservation behaviour. */
1340 enum flash_preserve_mode
1346 /* Write several memory blocks at once. This version can be more
1347 efficient than making several calls to target_write_memory, in
1348 particular because it can optimize accesses to flash memory.
1350 Moreover, this is currently the only memory access function in gdb
1351 that supports writing to flash memory, and it should be used for
1352 all cases where access to flash memory is desirable.
1354 REQUESTS is the vector (see vec.h) of memory_write_request.
1355 PRESERVE_FLASH_P indicates what to do with blocks which must be
1356 erased, but not completely rewritten.
1357 PROGRESS_CB is a function that will be periodically called to provide
1358 feedback to user. It will be called with the baton corresponding
1359 to the request currently being written. It may also be called
1360 with a NULL baton, when preserved flash sectors are being rewritten.
1362 The function returns 0 on success, and error otherwise. */
1363 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1364 enum flash_preserve_mode preserve_flash_p,
1365 void (*progress_cb) (ULONGEST, void *));
1367 /* Print a line about the current target. */
1369 #define target_files_info() \
1370 (*current_target.to_files_info) (¤t_target)
1372 /* Insert a breakpoint at address BP_TGT->placed_address in
1373 the target machine. Returns 0 for success, and returns non-zero or
1374 throws an error (with a detailed failure reason error code and
1375 message) otherwise. */
1377 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1378 struct bp_target_info *bp_tgt);
1380 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1381 machine. Result is 0 for success, non-zero for error. */
1383 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1384 struct bp_target_info *bp_tgt);
1386 /* Initialize the terminal settings we record for the inferior,
1387 before we actually run the inferior. */
1389 #define target_terminal_init() \
1390 (*current_target.to_terminal_init) (¤t_target)
1392 /* Put the inferior's terminal settings into effect.
1393 This is preparation for starting or resuming the inferior. */
1395 extern void target_terminal_inferior (void);
1397 /* Put some of our terminal settings into effect,
1398 enough to get proper results from our output,
1399 but do not change into or out of RAW mode
1400 so that no input is discarded.
1402 After doing this, either terminal_ours or terminal_inferior
1403 should be called to get back to a normal state of affairs. */
1405 #define target_terminal_ours_for_output() \
1406 (*current_target.to_terminal_ours_for_output) (¤t_target)
1408 /* Put our terminal settings into effect.
1409 First record the inferior's terminal settings
1410 so they can be restored properly later. */
1412 #define target_terminal_ours() \
1413 (*current_target.to_terminal_ours) (¤t_target)
1415 /* Return true if the target stack has a non-default
1416 "to_terminal_ours" method. */
1418 extern int target_supports_terminal_ours (void);
1420 /* Save our terminal settings.
1421 This is called from TUI after entering or leaving the curses
1422 mode. Since curses modifies our terminal this call is here
1423 to take this change into account. */
1425 #define target_terminal_save_ours() \
1426 (*current_target.to_terminal_save_ours) (¤t_target)
1428 /* Print useful information about our terminal status, if such a thing
1431 #define target_terminal_info(arg, from_tty) \
1432 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1434 /* Kill the inferior process. Make it go away. */
1436 extern void target_kill (void);
1438 /* Load an executable file into the target process. This is expected
1439 to not only bring new code into the target process, but also to
1440 update GDB's symbol tables to match.
1442 ARG contains command-line arguments, to be broken down with
1443 buildargv (). The first non-switch argument is the filename to
1444 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1445 0)), which is an offset to apply to the load addresses of FILE's
1446 sections. The target may define switches, or other non-switch
1447 arguments, as it pleases. */
1449 extern void target_load (const char *arg, int from_tty);
1451 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1452 notification of inferior events such as fork and vork immediately
1453 after the inferior is created. (This because of how gdb gets an
1454 inferior created via invoking a shell to do it. In such a scenario,
1455 if the shell init file has commands in it, the shell will fork and
1456 exec for each of those commands, and we will see each such fork
1459 Such targets will supply an appropriate definition for this function. */
1461 #define target_post_startup_inferior(ptid) \
1462 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1464 /* On some targets, we can catch an inferior fork or vfork event when
1465 it occurs. These functions insert/remove an already-created
1466 catchpoint for such events. They return 0 for success, 1 if the
1467 catchpoint type is not supported and -1 for failure. */
1469 #define target_insert_fork_catchpoint(pid) \
1470 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1472 #define target_remove_fork_catchpoint(pid) \
1473 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1475 #define target_insert_vfork_catchpoint(pid) \
1476 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1478 #define target_remove_vfork_catchpoint(pid) \
1479 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1481 /* If the inferior forks or vforks, this function will be called at
1482 the next resume in order to perform any bookkeeping and fiddling
1483 necessary to continue debugging either the parent or child, as
1484 requested, and releasing the other. Information about the fork
1485 or vfork event is available via get_last_target_status ().
1486 This function returns 1 if the inferior should not be resumed
1487 (i.e. there is another event pending). */
1489 int target_follow_fork (int follow_child, int detach_fork);
1491 /* On some targets, we can catch an inferior exec event when it
1492 occurs. These functions insert/remove an already-created
1493 catchpoint for such events. They return 0 for success, 1 if the
1494 catchpoint type is not supported and -1 for failure. */
1496 #define target_insert_exec_catchpoint(pid) \
1497 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1499 #define target_remove_exec_catchpoint(pid) \
1500 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1504 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1505 If NEEDED is zero, it means the target can disable the mechanism to
1506 catch system calls because there are no more catchpoints of this type.
1508 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1509 being requested. In this case, both TABLE_SIZE and TABLE should
1512 TABLE_SIZE is the number of elements in TABLE. It only matters if
1515 TABLE is an array of ints, indexed by syscall number. An element in
1516 this array is nonzero if that syscall should be caught. This argument
1517 only matters if ANY_COUNT is zero.
1519 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1522 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1523 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1524 pid, needed, any_count, \
1527 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1528 exit code of PID, if any. */
1530 #define target_has_exited(pid,wait_status,exit_status) \
1531 (*current_target.to_has_exited) (¤t_target, \
1532 pid,wait_status,exit_status)
1534 /* The debugger has completed a blocking wait() call. There is now
1535 some process event that must be processed. This function should
1536 be defined by those targets that require the debugger to perform
1537 cleanup or internal state changes in response to the process event. */
1539 /* The inferior process has died. Do what is right. */
1541 void target_mourn_inferior (void);
1543 /* Does target have enough data to do a run or attach command? */
1545 #define target_can_run(t) \
1546 ((t)->to_can_run) (t)
1548 /* Set list of signals to be handled in the target.
1550 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1551 (enum gdb_signal). For every signal whose entry in this array is
1552 non-zero, the target is allowed -but not required- to skip reporting
1553 arrival of the signal to the GDB core by returning from target_wait,
1554 and to pass the signal directly to the inferior instead.
1556 However, if the target is hardware single-stepping a thread that is
1557 about to receive a signal, it needs to be reported in any case, even
1558 if mentioned in a previous target_pass_signals call. */
1560 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1562 /* Set list of signals the target may pass to the inferior. This
1563 directly maps to the "handle SIGNAL pass/nopass" setting.
1565 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1566 number (enum gdb_signal). For every signal whose entry in this
1567 array is non-zero, the target is allowed to pass the signal to the
1568 inferior. Signals not present in the array shall be silently
1569 discarded. This does not influence whether to pass signals to the
1570 inferior as a result of a target_resume call. This is useful in
1571 scenarios where the target needs to decide whether to pass or not a
1572 signal to the inferior without GDB core involvement, such as for
1573 example, when detaching (as threads may have been suspended with
1574 pending signals not reported to GDB). */
1576 extern void target_program_signals (int nsig, unsigned char *program_signals);
1578 /* Check to see if a thread is still alive. */
1580 extern int target_thread_alive (ptid_t ptid);
1582 /* Query for new threads and add them to the thread list. */
1584 extern void target_find_new_threads (void);
1586 /* Make target stop in a continuable fashion. (For instance, under
1587 Unix, this should act like SIGSTOP). This function is normally
1588 used by GUIs to implement a stop button. */
1590 extern void target_stop (ptid_t ptid);
1592 /* Send the specified COMMAND to the target's monitor
1593 (shell,interpreter) for execution. The result of the query is
1594 placed in OUTBUF. */
1596 #define target_rcmd(command, outbuf) \
1597 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1600 /* Does the target include all of memory, or only part of it? This
1601 determines whether we look up the target chain for other parts of
1602 memory if this target can't satisfy a request. */
1604 extern int target_has_all_memory_1 (void);
1605 #define target_has_all_memory target_has_all_memory_1 ()
1607 /* Does the target include memory? (Dummy targets don't.) */
1609 extern int target_has_memory_1 (void);
1610 #define target_has_memory target_has_memory_1 ()
1612 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1613 we start a process.) */
1615 extern int target_has_stack_1 (void);
1616 #define target_has_stack target_has_stack_1 ()
1618 /* Does the target have registers? (Exec files don't.) */
1620 extern int target_has_registers_1 (void);
1621 #define target_has_registers target_has_registers_1 ()
1623 /* Does the target have execution? Can we make it jump (through
1624 hoops), or pop its stack a few times? This means that the current
1625 target is currently executing; for some targets, that's the same as
1626 whether or not the target is capable of execution, but there are
1627 also targets which can be current while not executing. In that
1628 case this will become true after to_create_inferior or
1631 extern int target_has_execution_1 (ptid_t);
1633 /* Like target_has_execution_1, but always passes inferior_ptid. */
1635 extern int target_has_execution_current (void);
1637 #define target_has_execution target_has_execution_current ()
1639 /* Default implementations for process_stratum targets. Return true
1640 if there's a selected inferior, false otherwise. */
1642 extern int default_child_has_all_memory (struct target_ops *ops);
1643 extern int default_child_has_memory (struct target_ops *ops);
1644 extern int default_child_has_stack (struct target_ops *ops);
1645 extern int default_child_has_registers (struct target_ops *ops);
1646 extern int default_child_has_execution (struct target_ops *ops,
1649 /* Can the target support the debugger control of thread execution?
1650 Can it lock the thread scheduler? */
1652 #define target_can_lock_scheduler \
1653 (current_target.to_has_thread_control & tc_schedlock)
1655 /* Controls whether async mode is permitted. */
1656 extern int target_async_permitted;
1658 /* Can the target support asynchronous execution? */
1659 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1661 /* Is the target in asynchronous execution mode? */
1662 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1664 /* Put the target in async mode with the specified callback function. */
1665 #define target_async(CALLBACK,CONTEXT) \
1666 (current_target.to_async (¤t_target, (CALLBACK), (CONTEXT)))
1668 #define target_execution_direction() \
1669 (current_target.to_execution_direction (¤t_target))
1671 /* Converts a process id to a string. Usually, the string just contains
1672 `process xyz', but on some systems it may contain
1673 `process xyz thread abc'. */
1675 extern char *target_pid_to_str (ptid_t ptid);
1677 extern char *normal_pid_to_str (ptid_t ptid);
1679 /* Return a short string describing extra information about PID,
1680 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1683 #define target_extra_thread_info(TP) \
1684 (current_target.to_extra_thread_info (¤t_target, TP))
1686 /* Return the thread's name. A NULL result means that the target
1687 could not determine this thread's name. */
1689 extern char *target_thread_name (struct thread_info *);
1691 /* Attempts to find the pathname of the executable file
1692 that was run to create a specified process.
1694 The process PID must be stopped when this operation is used.
1696 If the executable file cannot be determined, NULL is returned.
1698 Else, a pointer to a character string containing the pathname
1699 is returned. This string should be copied into a buffer by
1700 the client if the string will not be immediately used, or if
1703 #define target_pid_to_exec_file(pid) \
1704 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1706 /* See the to_thread_architecture description in struct target_ops. */
1708 #define target_thread_architecture(ptid) \
1709 (current_target.to_thread_architecture (¤t_target, ptid))
1712 * Iterator function for target memory regions.
1713 * Calls a callback function once for each memory region 'mapped'
1714 * in the child process. Defined as a simple macro rather than
1715 * as a function macro so that it can be tested for nullity.
1718 #define target_find_memory_regions(FUNC, DATA) \
1719 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1722 * Compose corefile .note section.
1725 #define target_make_corefile_notes(BFD, SIZE_P) \
1726 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1728 /* Bookmark interfaces. */
1729 #define target_get_bookmark(ARGS, FROM_TTY) \
1730 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1732 #define target_goto_bookmark(ARG, FROM_TTY) \
1733 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1735 /* Hardware watchpoint interfaces. */
1737 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1738 write). Only the INFERIOR_PTID task is being queried. */
1740 #define target_stopped_by_watchpoint() \
1741 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1743 /* Non-zero if we have steppable watchpoints */
1745 #define target_have_steppable_watchpoint \
1746 (current_target.to_have_steppable_watchpoint)
1748 /* Non-zero if we have continuable watchpoints */
1750 #define target_have_continuable_watchpoint \
1751 (current_target.to_have_continuable_watchpoint)
1753 /* Provide defaults for hardware watchpoint functions. */
1755 /* If the *_hw_beakpoint functions have not been defined
1756 elsewhere use the definitions in the target vector. */
1758 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1759 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1760 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1761 (including this one?). OTHERTYPE is who knows what... */
1763 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1764 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1765 TYPE, CNT, OTHERTYPE);
1767 /* Returns the number of debug registers needed to watch the given
1768 memory region, or zero if not supported. */
1770 #define target_region_ok_for_hw_watchpoint(addr, len) \
1771 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1775 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1776 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1777 COND is the expression for its condition, or NULL if there's none.
1778 Returns 0 for success, 1 if the watchpoint type is not supported,
1781 #define target_insert_watchpoint(addr, len, type, cond) \
1782 (*current_target.to_insert_watchpoint) (¤t_target, \
1783 addr, len, type, cond)
1785 #define target_remove_watchpoint(addr, len, type, cond) \
1786 (*current_target.to_remove_watchpoint) (¤t_target, \
1787 addr, len, type, cond)
1789 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1790 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1791 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1792 masked watchpoints are not supported, -1 for failure. */
1794 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1796 /* Remove a masked watchpoint at ADDR with the mask MASK.
1797 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1798 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1801 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1803 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1804 the target machine. Returns 0 for success, and returns non-zero or
1805 throws an error (with a detailed failure reason error code and
1806 message) otherwise. */
1808 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1809 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1812 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1813 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1816 /* Return number of debug registers needed for a ranged breakpoint,
1817 or -1 if ranged breakpoints are not supported. */
1819 extern int target_ranged_break_num_registers (void);
1821 /* Return non-zero if target knows the data address which triggered this
1822 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1823 INFERIOR_PTID task is being queried. */
1824 #define target_stopped_data_address(target, addr_p) \
1825 (*target.to_stopped_data_address) (target, addr_p)
1827 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1828 LENGTH bytes beginning at START. */
1829 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1830 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1832 /* Return non-zero if the target is capable of using hardware to evaluate
1833 the condition expression. In this case, if the condition is false when
1834 the watched memory location changes, execution may continue without the
1835 debugger being notified.
1837 Due to limitations in the hardware implementation, it may be capable of
1838 avoiding triggering the watchpoint in some cases where the condition
1839 expression is false, but may report some false positives as well.
1840 For this reason, GDB will still evaluate the condition expression when
1841 the watchpoint triggers. */
1842 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1843 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1844 addr, len, type, cond)
1846 /* Return number of debug registers needed for a masked watchpoint,
1847 -1 if masked watchpoints are not supported or -2 if the given address
1848 and mask combination cannot be used. */
1850 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1852 /* Target can execute in reverse? */
1853 #define target_can_execute_reverse \
1854 current_target.to_can_execute_reverse (¤t_target)
1856 extern const struct target_desc *target_read_description (struct target_ops *);
1858 #define target_get_ada_task_ptid(lwp, tid) \
1859 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1861 /* Utility implementation of searching memory. */
1862 extern int simple_search_memory (struct target_ops* ops,
1863 CORE_ADDR start_addr,
1864 ULONGEST search_space_len,
1865 const gdb_byte *pattern,
1866 ULONGEST pattern_len,
1867 CORE_ADDR *found_addrp);
1869 /* Main entry point for searching memory. */
1870 extern int target_search_memory (CORE_ADDR start_addr,
1871 ULONGEST search_space_len,
1872 const gdb_byte *pattern,
1873 ULONGEST pattern_len,
1874 CORE_ADDR *found_addrp);
1876 /* Target file operations. */
1878 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1879 target file descriptor, or -1 if an error occurs (and set
1881 extern int target_fileio_open (const char *filename, int flags, int mode,
1884 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1885 Return the number of bytes written, or -1 if an error occurs
1886 (and set *TARGET_ERRNO). */
1887 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1888 ULONGEST offset, int *target_errno);
1890 /* Read up to LEN bytes FD on the target into READ_BUF.
1891 Return the number of bytes read, or -1 if an error occurs
1892 (and set *TARGET_ERRNO). */
1893 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1894 ULONGEST offset, int *target_errno);
1896 /* Close FD on the target. Return 0, or -1 if an error occurs
1897 (and set *TARGET_ERRNO). */
1898 extern int target_fileio_close (int fd, int *target_errno);
1900 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1901 occurs (and set *TARGET_ERRNO). */
1902 extern int target_fileio_unlink (const char *filename, int *target_errno);
1904 /* Read value of symbolic link FILENAME on the target. Return a
1905 null-terminated string allocated via xmalloc, or NULL if an error
1906 occurs (and set *TARGET_ERRNO). */
1907 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1909 /* Read target file FILENAME. The return value will be -1 if the transfer
1910 fails or is not supported; 0 if the object is empty; or the length
1911 of the object otherwise. If a positive value is returned, a
1912 sufficiently large buffer will be allocated using xmalloc and
1913 returned in *BUF_P containing the contents of the object.
1915 This method should be used for objects sufficiently small to store
1916 in a single xmalloc'd buffer, when no fixed bound on the object's
1917 size is known in advance. */
1918 extern LONGEST target_fileio_read_alloc (const char *filename,
1921 /* Read target file FILENAME. The result is NUL-terminated and
1922 returned as a string, allocated using xmalloc. If an error occurs
1923 or the transfer is unsupported, NULL is returned. Empty objects
1924 are returned as allocated but empty strings. A warning is issued
1925 if the result contains any embedded NUL bytes. */
1926 extern char *target_fileio_read_stralloc (const char *filename);
1929 /* Tracepoint-related operations. */
1931 #define target_trace_init() \
1932 (*current_target.to_trace_init) (¤t_target)
1934 #define target_download_tracepoint(t) \
1935 (*current_target.to_download_tracepoint) (¤t_target, t)
1937 #define target_can_download_tracepoint() \
1938 (*current_target.to_can_download_tracepoint) (¤t_target)
1940 #define target_download_trace_state_variable(tsv) \
1941 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1943 #define target_enable_tracepoint(loc) \
1944 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1946 #define target_disable_tracepoint(loc) \
1947 (*current_target.to_disable_tracepoint) (¤t_target, loc)
1949 #define target_trace_start() \
1950 (*current_target.to_trace_start) (¤t_target)
1952 #define target_trace_set_readonly_regions() \
1953 (*current_target.to_trace_set_readonly_regions) (¤t_target)
1955 #define target_get_trace_status(ts) \
1956 (*current_target.to_get_trace_status) (¤t_target, ts)
1958 #define target_get_tracepoint_status(tp,utp) \
1959 (*current_target.to_get_tracepoint_status) (¤t_target, tp, utp)
1961 #define target_trace_stop() \
1962 (*current_target.to_trace_stop) (¤t_target)
1964 #define target_trace_find(type,num,addr1,addr2,tpp) \
1965 (*current_target.to_trace_find) (¤t_target, \
1966 (type), (num), (addr1), (addr2), (tpp))
1968 #define target_get_trace_state_variable_value(tsv,val) \
1969 (*current_target.to_get_trace_state_variable_value) (¤t_target, \
1972 #define target_save_trace_data(filename) \
1973 (*current_target.to_save_trace_data) (¤t_target, filename)
1975 #define target_upload_tracepoints(utpp) \
1976 (*current_target.to_upload_tracepoints) (¤t_target, utpp)
1978 #define target_upload_trace_state_variables(utsvp) \
1979 (*current_target.to_upload_trace_state_variables) (¤t_target, utsvp)
1981 #define target_get_raw_trace_data(buf,offset,len) \
1982 (*current_target.to_get_raw_trace_data) (¤t_target, \
1983 (buf), (offset), (len))
1985 #define target_get_min_fast_tracepoint_insn_len() \
1986 (*current_target.to_get_min_fast_tracepoint_insn_len) (¤t_target)
1988 #define target_set_disconnected_tracing(val) \
1989 (*current_target.to_set_disconnected_tracing) (¤t_target, val)
1991 #define target_set_circular_trace_buffer(val) \
1992 (*current_target.to_set_circular_trace_buffer) (¤t_target, val)
1994 #define target_set_trace_buffer_size(val) \
1995 (*current_target.to_set_trace_buffer_size) (¤t_target, val)
1997 #define target_set_trace_notes(user,notes,stopnotes) \
1998 (*current_target.to_set_trace_notes) (¤t_target, \
1999 (user), (notes), (stopnotes))
2001 #define target_get_tib_address(ptid, addr) \
2002 (*current_target.to_get_tib_address) (¤t_target, (ptid), (addr))
2004 #define target_set_permissions() \
2005 (*current_target.to_set_permissions) (¤t_target)
2007 #define target_static_tracepoint_marker_at(addr, marker) \
2008 (*current_target.to_static_tracepoint_marker_at) (¤t_target, \
2011 #define target_static_tracepoint_markers_by_strid(marker_id) \
2012 (*current_target.to_static_tracepoint_markers_by_strid) (¤t_target, \
2015 #define target_traceframe_info() \
2016 (*current_target.to_traceframe_info) (¤t_target)
2018 #define target_use_agent(use) \
2019 (*current_target.to_use_agent) (¤t_target, use)
2021 #define target_can_use_agent() \
2022 (*current_target.to_can_use_agent) (¤t_target)
2024 #define target_augmented_libraries_svr4_read() \
2025 (*current_target.to_augmented_libraries_svr4_read) (¤t_target)
2027 /* Command logging facility. */
2029 #define target_log_command(p) \
2030 (*current_target.to_log_command) (¤t_target, p)
2033 extern int target_core_of_thread (ptid_t ptid);
2035 /* See to_get_unwinder in struct target_ops. */
2036 extern const struct frame_unwind *target_get_unwinder (void);
2038 /* See to_get_tailcall_unwinder in struct target_ops. */
2039 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
2041 /* This implements basic memory verification, reading target memory
2042 and performing the comparison here (as opposed to accelerated
2043 verification making use of the qCRC packet, for example). */
2045 extern int simple_verify_memory (struct target_ops* ops,
2046 const gdb_byte *data,
2047 CORE_ADDR memaddr, ULONGEST size);
2049 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2050 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2051 if there's a mismatch, and -1 if an error is encountered while
2052 reading memory. Throws an error if the functionality is found not
2053 to be supported by the current target. */
2054 int target_verify_memory (const gdb_byte *data,
2055 CORE_ADDR memaddr, ULONGEST size);
2057 /* Routines for maintenance of the target structures...
2059 complete_target_initialization: Finalize a target_ops by filling in
2060 any fields needed by the target implementation. Unnecessary for
2061 targets which are registered via add_target, as this part gets
2064 add_target: Add a target to the list of all possible targets.
2065 This only makes sense for targets that should be activated using
2066 the "target TARGET_NAME ..." command.
2068 push_target: Make this target the top of the stack of currently used
2069 targets, within its particular stratum of the stack. Result
2070 is 0 if now atop the stack, nonzero if not on top (maybe
2073 unpush_target: Remove this from the stack of currently used targets,
2074 no matter where it is on the list. Returns 0 if no
2075 change, 1 if removed from stack. */
2077 extern void add_target (struct target_ops *);
2079 extern void add_target_with_completer (struct target_ops *t,
2080 completer_ftype *completer);
2082 extern void complete_target_initialization (struct target_ops *t);
2084 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
2085 for maintaining backwards compatibility when renaming targets. */
2087 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
2089 extern void push_target (struct target_ops *);
2091 extern int unpush_target (struct target_ops *);
2093 extern void target_pre_inferior (int);
2095 extern void target_preopen (int);
2097 /* Does whatever cleanup is required to get rid of all pushed targets. */
2098 extern void pop_all_targets (void);
2100 /* Like pop_all_targets, but pops only targets whose stratum is
2101 strictly above ABOVE_STRATUM. */
2102 extern void pop_all_targets_above (enum strata above_stratum);
2104 extern int target_is_pushed (struct target_ops *t);
2106 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2109 /* Struct target_section maps address ranges to file sections. It is
2110 mostly used with BFD files, but can be used without (e.g. for handling
2111 raw disks, or files not in formats handled by BFD). */
2113 struct target_section
2115 CORE_ADDR addr; /* Lowest address in section */
2116 CORE_ADDR endaddr; /* 1+highest address in section */
2118 struct bfd_section *the_bfd_section;
2120 /* The "owner" of the section.
2121 It can be any unique value. It is set by add_target_sections
2122 and used by remove_target_sections.
2123 For example, for executables it is a pointer to exec_bfd and
2124 for shlibs it is the so_list pointer. */
2128 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2130 struct target_section_table
2132 struct target_section *sections;
2133 struct target_section *sections_end;
2136 /* Return the "section" containing the specified address. */
2137 struct target_section *target_section_by_addr (struct target_ops *target,
2140 /* Return the target section table this target (or the targets
2141 beneath) currently manipulate. */
2143 extern struct target_section_table *target_get_section_table
2144 (struct target_ops *target);
2146 /* From mem-break.c */
2148 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
2149 struct bp_target_info *);
2151 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
2152 struct bp_target_info *);
2154 /* Check whether the memory at the breakpoint's placed address still
2155 contains the expected breakpoint instruction. */
2157 extern int memory_validate_breakpoint (struct gdbarch *gdbarch,
2158 struct bp_target_info *bp_tgt);
2160 extern int default_memory_remove_breakpoint (struct gdbarch *,
2161 struct bp_target_info *);
2163 extern int default_memory_insert_breakpoint (struct gdbarch *,
2164 struct bp_target_info *);
2169 extern void initialize_targets (void);
2171 extern void noprocess (void) ATTRIBUTE_NORETURN;
2173 extern void target_require_runnable (void);
2175 extern void find_default_attach (struct target_ops *, const char *, int);
2177 extern void find_default_create_inferior (struct target_ops *,
2178 char *, char *, char **, int);
2180 extern struct target_ops *find_target_beneath (struct target_ops *);
2182 /* Find the target at STRATUM. If no target is at that stratum,
2185 struct target_ops *find_target_at (enum strata stratum);
2187 /* Read OS data object of type TYPE from the target, and return it in
2188 XML format. The result is NUL-terminated and returned as a string,
2189 allocated using xmalloc. If an error occurs or the transfer is
2190 unsupported, NULL is returned. Empty objects are returned as
2191 allocated but empty strings. */
2193 extern char *target_get_osdata (const char *type);
2196 /* Stuff that should be shared among the various remote targets. */
2198 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2199 information (higher values, more information). */
2200 extern int remote_debug;
2202 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2203 extern int baud_rate;
2204 /* Timeout limit for response from target. */
2205 extern int remote_timeout;
2209 /* Set the show memory breakpoints mode to show, and installs a cleanup
2210 to restore it back to the current value. */
2211 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2213 extern int may_write_registers;
2214 extern int may_write_memory;
2215 extern int may_insert_breakpoints;
2216 extern int may_insert_tracepoints;
2217 extern int may_insert_fast_tracepoints;
2218 extern int may_stop;
2220 extern void update_target_permissions (void);
2223 /* Imported from machine dependent code. */
2225 /* See to_supports_btrace in struct target_ops. */
2226 #define target_supports_btrace() \
2227 (current_target.to_supports_btrace (¤t_target))
2229 /* See to_enable_btrace in struct target_ops. */
2230 extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2232 /* See to_disable_btrace in struct target_ops. */
2233 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2235 /* See to_teardown_btrace in struct target_ops. */
2236 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2238 /* See to_read_btrace in struct target_ops. */
2239 extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2240 struct btrace_target_info *,
2241 enum btrace_read_type);
2243 /* See to_stop_recording in struct target_ops. */
2244 extern void target_stop_recording (void);
2246 /* See to_save_record in struct target_ops. */
2247 extern void target_save_record (const char *filename);
2249 /* Query if the target supports deleting the execution log. */
2250 extern int target_supports_delete_record (void);
2252 /* See to_delete_record in struct target_ops. */
2253 extern void target_delete_record (void);
2255 /* See to_record_is_replaying in struct target_ops. */
2256 extern int target_record_is_replaying (void);
2258 /* See to_goto_record_begin in struct target_ops. */
2259 extern void target_goto_record_begin (void);
2261 /* See to_goto_record_end in struct target_ops. */
2262 extern void target_goto_record_end (void);
2264 /* See to_goto_record in struct target_ops. */
2265 extern void target_goto_record (ULONGEST insn);
2267 /* See to_insn_history. */
2268 extern void target_insn_history (int size, int flags);
2270 /* See to_insn_history_from. */
2271 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2273 /* See to_insn_history_range. */
2274 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2276 /* See to_call_history. */
2277 extern void target_call_history (int size, int flags);
2279 /* See to_call_history_from. */
2280 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2282 /* See to_call_history_range. */
2283 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2285 /* See to_decr_pc_after_break. Start searching for the target at OPS. */
2286 extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2287 struct gdbarch *gdbarch);
2289 /* See to_decr_pc_after_break. */
2290 extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2292 /* See to_prepare_to_generate_core. */
2293 extern void target_prepare_to_generate_core (void);
2295 /* See to_done_generating_core. */
2296 extern void target_done_generating_core (void);
2298 #endif /* !defined (TARGET_H) */