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 #include "infrun.h" /* For enum exec_direction_kind. */
44 /* This include file defines the interface between the main part
45 of the debugger, and the part which is target-specific, or
46 specific to the communications interface between us and the
49 A TARGET is an interface between the debugger and a particular
50 kind of file or process. Targets can be STACKED in STRATA,
51 so that more than one target can potentially respond to a request.
52 In particular, memory accesses will walk down the stack of targets
53 until they find a target that is interested in handling that particular
54 address. STRATA are artificial boundaries on the stack, within
55 which particular kinds of targets live. Strata exist so that
56 people don't get confused by pushing e.g. a process target and then
57 a file target, and wondering why they can't see the current values
58 of variables any more (the file target is handling them and they
59 never get to the process target). So when you push a file target,
60 it goes into the file stratum, which is always below the process
63 #include "target/target.h"
64 #include "target/resume.h"
65 #include "target/wait.h"
66 #include "target/waitstatus.h"
71 #include "gdb_signals.h"
77 dummy_stratum, /* The lowest of the low */
78 file_stratum, /* Executable files, etc */
79 process_stratum, /* Executing processes or core dump files */
80 thread_stratum, /* Executing threads */
81 record_stratum, /* Support record debugging */
82 arch_stratum /* Architecture overrides */
85 enum thread_control_capabilities
87 tc_none = 0, /* Default: can't control thread execution. */
88 tc_schedlock = 1, /* Can lock the thread scheduler. */
91 /* The structure below stores information about a system call.
92 It is basically used in the "catch syscall" command, and in
93 every function that gives information about a system call.
95 It's also good to mention that its fields represent everything
96 that we currently know about a syscall in GDB. */
99 /* The syscall number. */
102 /* The syscall name. */
106 /* Return a pretty printed form of target_waitstatus.
107 Space for the result is malloc'd, caller must free. */
108 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
110 /* Return a pretty printed form of TARGET_OPTIONS.
111 Space for the result is malloc'd, caller must free. */
112 extern char *target_options_to_string (int target_options);
114 /* Possible types of events that the inferior handler will have to
116 enum inferior_event_type
118 /* Process a normal inferior event which will result in target_wait
121 /* We are called because a timer went off. */
123 /* We are called to do stuff after the inferior stops. */
125 /* We are called to do some stuff after the inferior stops, but we
126 are expected to reenter the proceed() and
127 handle_inferior_event() functions. This is used only in case of
128 'step n' like commands. */
132 /* Target objects which can be transfered using target_read,
133 target_write, et cetera. */
137 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
139 /* SPU target specific transfer. See "spu-tdep.c". */
141 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
142 TARGET_OBJECT_MEMORY,
143 /* Memory, avoiding GDB's data cache and trusting the executable.
144 Target implementations of to_xfer_partial never need to handle
145 this object, and most callers should not use it. */
146 TARGET_OBJECT_RAW_MEMORY,
147 /* Memory known to be part of the target's stack. This is cached even
148 if it is not in a region marked as such, since it is known to be
150 TARGET_OBJECT_STACK_MEMORY,
151 /* Memory known to be part of the target code. This is cached even
152 if it is not in a region marked as such. */
153 TARGET_OBJECT_CODE_MEMORY,
154 /* Kernel Unwind Table. See "ia64-tdep.c". */
155 TARGET_OBJECT_UNWIND_TABLE,
156 /* Transfer auxilliary vector. */
158 /* StackGhost cookie. See "sparc-tdep.c". */
159 TARGET_OBJECT_WCOOKIE,
160 /* Target memory map in XML format. */
161 TARGET_OBJECT_MEMORY_MAP,
162 /* Flash memory. This object can be used to write contents to
163 a previously erased flash memory. Using it without erasing
164 flash can have unexpected results. Addresses are physical
165 address on target, and not relative to flash start. */
167 /* Available target-specific features, e.g. registers and coprocessors.
168 See "target-descriptions.c". ANNEX should never be empty. */
169 TARGET_OBJECT_AVAILABLE_FEATURES,
170 /* Currently loaded libraries, in XML format. */
171 TARGET_OBJECT_LIBRARIES,
172 /* Currently loaded libraries specific for SVR4 systems, in XML format. */
173 TARGET_OBJECT_LIBRARIES_SVR4,
174 /* Currently loaded libraries specific to AIX systems, in XML format. */
175 TARGET_OBJECT_LIBRARIES_AIX,
176 /* Get OS specific data. The ANNEX specifies the type (running
177 processes, etc.). The data being transfered is expected to follow
178 the DTD specified in features/osdata.dtd. */
179 TARGET_OBJECT_OSDATA,
180 /* Extra signal info. Usually the contents of `siginfo_t' on unix
182 TARGET_OBJECT_SIGNAL_INFO,
183 /* The list of threads that are being debugged. */
184 TARGET_OBJECT_THREADS,
185 /* Collected static trace data. */
186 TARGET_OBJECT_STATIC_TRACE_DATA,
187 /* The HP-UX registers (those that can be obtained or modified by using
188 the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests). */
189 TARGET_OBJECT_HPUX_UREGS,
190 /* The HP-UX shared library linkage pointer. ANNEX should be a string
191 image of the code address whose linkage pointer we are looking for.
193 The size of the data transfered is always 8 bytes (the size of an
195 TARGET_OBJECT_HPUX_SOLIB_GOT,
196 /* Traceframe info, in XML format. */
197 TARGET_OBJECT_TRACEFRAME_INFO,
198 /* Load maps for FDPIC systems. */
200 /* Darwin dynamic linker info data. */
201 TARGET_OBJECT_DARWIN_DYLD_INFO,
202 /* OpenVMS Unwind Information Block. */
203 TARGET_OBJECT_OPENVMS_UIB,
204 /* Branch trace data, in XML format. */
205 TARGET_OBJECT_BTRACE,
206 /* Branch trace configuration, in XML format. */
207 TARGET_OBJECT_BTRACE_CONF
208 /* Possible future objects: TARGET_OBJECT_FILE, ... */
211 /* Possible values returned by target_xfer_partial, etc. */
213 enum target_xfer_status
215 /* Some bytes are transferred. */
218 /* No further transfer is possible. */
221 /* The piece of the object requested is unavailable. */
222 TARGET_XFER_UNAVAILABLE = 2,
224 /* Generic I/O error. Note that it's important that this is '-1',
225 as we still have target_xfer-related code returning hardcoded
227 TARGET_XFER_E_IO = -1,
229 /* Keep list in sync with target_xfer_status_to_string. */
232 /* Return the string form of STATUS. */
235 target_xfer_status_to_string (enum target_xfer_status status);
237 /* Enumeration of the kinds of traceframe searches that a target may
238 be able to perform. */
249 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
250 DEF_VEC_P(static_tracepoint_marker_p);
252 typedef enum target_xfer_status
253 target_xfer_partial_ftype (struct target_ops *ops,
254 enum target_object object,
257 const gdb_byte *writebuf,
260 ULONGEST *xfered_len);
262 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
263 OBJECT. The OFFSET, for a seekable object, specifies the
264 starting point. The ANNEX can be used to provide additional
265 data-specific information to the target.
267 Return the number of bytes actually transfered, or a negative error
268 code (an 'enum target_xfer_error' value) if the transfer is not
269 supported or otherwise fails. Return of a positive value less than
270 LEN indicates that no further transfer is possible. Unlike the raw
271 to_xfer_partial interface, callers of these functions do not need
272 to retry partial transfers. */
274 extern LONGEST target_read (struct target_ops *ops,
275 enum target_object object,
276 const char *annex, gdb_byte *buf,
277 ULONGEST offset, LONGEST len);
279 struct memory_read_result
281 /* First address that was read. */
283 /* Past-the-end address. */
288 typedef struct memory_read_result memory_read_result_s;
289 DEF_VEC_O(memory_read_result_s);
291 extern void free_memory_read_result_vector (void *);
293 extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
297 extern LONGEST target_write (struct target_ops *ops,
298 enum target_object object,
299 const char *annex, const gdb_byte *buf,
300 ULONGEST offset, LONGEST len);
302 /* Similar to target_write, except that it also calls PROGRESS with
303 the number of bytes written and the opaque BATON after every
304 successful partial write (and before the first write). This is
305 useful for progress reporting and user interaction while writing
306 data. To abort the transfer, the progress callback can throw an
309 LONGEST target_write_with_progress (struct target_ops *ops,
310 enum target_object object,
311 const char *annex, const gdb_byte *buf,
312 ULONGEST offset, LONGEST len,
313 void (*progress) (ULONGEST, void *),
316 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
317 be read using OPS. The return value will be -1 if the transfer
318 fails or is not supported; 0 if the object is empty; or the length
319 of the object otherwise. If a positive value is returned, a
320 sufficiently large buffer will be allocated using xmalloc and
321 returned in *BUF_P containing the contents of the object.
323 This method should be used for objects sufficiently small to store
324 in a single xmalloc'd buffer, when no fixed bound on the object's
325 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
326 through this function. */
328 extern LONGEST target_read_alloc (struct target_ops *ops,
329 enum target_object object,
330 const char *annex, gdb_byte **buf_p);
332 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
333 returned as a string, allocated using xmalloc. If an error occurs
334 or the transfer is unsupported, NULL is returned. Empty objects
335 are returned as allocated but empty strings. A warning is issued
336 if the result contains any embedded NUL bytes. */
338 extern char *target_read_stralloc (struct target_ops *ops,
339 enum target_object object,
342 /* See target_ops->to_xfer_partial. */
343 extern target_xfer_partial_ftype target_xfer_partial;
345 /* Wrappers to target read/write that perform memory transfers. They
346 throw an error if the memory transfer fails.
348 NOTE: cagney/2003-10-23: The naming schema is lifted from
349 "frame.h". The parameter order is lifted from get_frame_memory,
350 which in turn lifted it from read_memory. */
352 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
353 gdb_byte *buf, LONGEST len);
354 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
355 CORE_ADDR addr, int len,
356 enum bfd_endian byte_order);
358 struct thread_info; /* fwd decl for parameter list below: */
360 /* The type of the callback to the to_async method. */
362 typedef void async_callback_ftype (enum inferior_event_type event_type,
365 /* Normally target debug printing is purely type-based. However,
366 sometimes it is necessary to override the debug printing on a
367 per-argument basis. This macro can be used, attribute-style, to
368 name the target debug printing function for a particular method
369 argument. FUNC is the name of the function. The macro's
370 definition is empty because it is only used by the
371 make-target-delegates script. */
373 #define TARGET_DEBUG_PRINTER(FUNC)
375 /* These defines are used to mark target_ops methods. The script
376 make-target-delegates scans these and auto-generates the base
377 method implementations. There are four macros that can be used:
379 1. TARGET_DEFAULT_IGNORE. There is no argument. The base method
380 does nothing. This is only valid if the method return type is
383 2. TARGET_DEFAULT_NORETURN. The argument is a function call, like
384 'tcomplain ()'. The base method simply makes this call, which is
385 assumed not to return.
387 3. TARGET_DEFAULT_RETURN. The argument is a C expression. The
388 base method returns this expression's value.
390 4. TARGET_DEFAULT_FUNC. The argument is the name of a function.
391 make-target-delegates does not generate a base method in this case,
392 but instead uses the argument function as the base method. */
394 #define TARGET_DEFAULT_IGNORE()
395 #define TARGET_DEFAULT_NORETURN(ARG)
396 #define TARGET_DEFAULT_RETURN(ARG)
397 #define TARGET_DEFAULT_FUNC(ARG)
401 struct target_ops *beneath; /* To the target under this one. */
402 const char *to_shortname; /* Name this target type */
403 const char *to_longname; /* Name for printing */
404 const char *to_doc; /* Documentation. Does not include trailing
405 newline, and starts with a one-line descrip-
406 tion (probably similar to to_longname). */
407 /* Per-target scratch pad. */
409 /* The open routine takes the rest of the parameters from the
410 command, and (if successful) pushes a new target onto the
411 stack. Targets should supply this routine, if only to provide
413 void (*to_open) (const char *, int);
414 /* Old targets with a static target vector provide "to_close".
415 New re-entrant targets provide "to_xclose" and that is expected
416 to xfree everything (including the "struct target_ops"). */
417 void (*to_xclose) (struct target_ops *targ);
418 void (*to_close) (struct target_ops *);
419 /* Attaches to a process on the target side. Arguments are as
420 passed to the `attach' command by the user. This routine can
421 be called when the target is not on the target-stack, if the
422 target_can_run routine returns 1; in that case, it must push
423 itself onto the stack. Upon exit, the target should be ready
424 for normal operations, and should be ready to deliver the
425 status of the process immediately (without waiting) to an
426 upcoming target_wait call. */
427 void (*to_attach) (struct target_ops *ops, const char *, int);
428 void (*to_post_attach) (struct target_ops *, int)
429 TARGET_DEFAULT_IGNORE ();
430 void (*to_detach) (struct target_ops *ops, const char *, int)
431 TARGET_DEFAULT_IGNORE ();
432 void (*to_disconnect) (struct target_ops *, const char *, int)
433 TARGET_DEFAULT_NORETURN (tcomplain ());
434 void (*to_resume) (struct target_ops *, ptid_t,
435 int TARGET_DEBUG_PRINTER (target_debug_print_step),
437 TARGET_DEFAULT_NORETURN (noprocess ());
438 ptid_t (*to_wait) (struct target_ops *,
439 ptid_t, struct target_waitstatus *,
440 int TARGET_DEBUG_PRINTER (target_debug_print_options))
441 TARGET_DEFAULT_NORETURN (noprocess ());
442 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int)
443 TARGET_DEFAULT_IGNORE ();
444 void (*to_store_registers) (struct target_ops *, struct regcache *, int)
445 TARGET_DEFAULT_NORETURN (noprocess ());
446 void (*to_prepare_to_store) (struct target_ops *, struct regcache *)
447 TARGET_DEFAULT_NORETURN (noprocess ());
449 void (*to_files_info) (struct target_ops *)
450 TARGET_DEFAULT_IGNORE ();
451 int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
452 struct bp_target_info *)
453 TARGET_DEFAULT_FUNC (memory_insert_breakpoint);
454 int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
455 struct bp_target_info *)
456 TARGET_DEFAULT_FUNC (memory_remove_breakpoint);
458 /* Returns true if the target stopped because it executed a
459 software breakpoint. This is necessary for correct background
460 execution / non-stop mode operation, and for correct PC
461 adjustment on targets where the PC needs to be adjusted when a
462 software breakpoint triggers. In these modes, by the time GDB
463 processes a breakpoint event, the breakpoint may already be
464 done from the target, so GDB needs to be able to tell whether
465 it should ignore the event and whether it should adjust the PC.
466 See adjust_pc_after_break. */
467 int (*to_stopped_by_sw_breakpoint) (struct target_ops *)
468 TARGET_DEFAULT_RETURN (0);
469 /* Returns true if the above method is supported. */
470 int (*to_supports_stopped_by_sw_breakpoint) (struct target_ops *)
471 TARGET_DEFAULT_RETURN (0);
473 /* Returns true if the target stopped for a hardware breakpoint.
474 Likewise, if the target supports hardware breakpoints, this
475 method is necessary for correct background execution / non-stop
476 mode operation. Even though hardware breakpoints do not
477 require PC adjustment, GDB needs to be able to tell whether the
478 hardware breakpoint event is a delayed event for a breakpoint
479 that is already gone and should thus be ignored. */
480 int (*to_stopped_by_hw_breakpoint) (struct target_ops *)
481 TARGET_DEFAULT_RETURN (0);
482 /* Returns true if the above method is supported. */
483 int (*to_supports_stopped_by_hw_breakpoint) (struct target_ops *)
484 TARGET_DEFAULT_RETURN (0);
486 int (*to_can_use_hw_breakpoint) (struct target_ops *, int, int, int)
487 TARGET_DEFAULT_RETURN (0);
488 int (*to_ranged_break_num_registers) (struct target_ops *)
489 TARGET_DEFAULT_RETURN (-1);
490 int (*to_insert_hw_breakpoint) (struct target_ops *,
491 struct gdbarch *, struct bp_target_info *)
492 TARGET_DEFAULT_RETURN (-1);
493 int (*to_remove_hw_breakpoint) (struct target_ops *,
494 struct gdbarch *, struct bp_target_info *)
495 TARGET_DEFAULT_RETURN (-1);
497 /* Documentation of what the two routines below are expected to do is
498 provided with the corresponding target_* macros. */
499 int (*to_remove_watchpoint) (struct target_ops *,
500 CORE_ADDR, int, int, struct expression *)
501 TARGET_DEFAULT_RETURN (-1);
502 int (*to_insert_watchpoint) (struct target_ops *,
503 CORE_ADDR, int, int, struct expression *)
504 TARGET_DEFAULT_RETURN (-1);
506 int (*to_insert_mask_watchpoint) (struct target_ops *,
507 CORE_ADDR, CORE_ADDR, int)
508 TARGET_DEFAULT_RETURN (1);
509 int (*to_remove_mask_watchpoint) (struct target_ops *,
510 CORE_ADDR, CORE_ADDR, int)
511 TARGET_DEFAULT_RETURN (1);
512 int (*to_stopped_by_watchpoint) (struct target_ops *)
513 TARGET_DEFAULT_RETURN (0);
514 int to_have_steppable_watchpoint;
515 int to_have_continuable_watchpoint;
516 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *)
517 TARGET_DEFAULT_RETURN (0);
518 int (*to_watchpoint_addr_within_range) (struct target_ops *,
519 CORE_ADDR, CORE_ADDR, int)
520 TARGET_DEFAULT_FUNC (default_watchpoint_addr_within_range);
522 /* Documentation of this routine is provided with the corresponding
524 int (*to_region_ok_for_hw_watchpoint) (struct target_ops *,
526 TARGET_DEFAULT_FUNC (default_region_ok_for_hw_watchpoint);
528 int (*to_can_accel_watchpoint_condition) (struct target_ops *,
531 TARGET_DEFAULT_RETURN (0);
532 int (*to_masked_watch_num_registers) (struct target_ops *,
533 CORE_ADDR, CORE_ADDR)
534 TARGET_DEFAULT_RETURN (-1);
535 void (*to_terminal_init) (struct target_ops *)
536 TARGET_DEFAULT_IGNORE ();
537 void (*to_terminal_inferior) (struct target_ops *)
538 TARGET_DEFAULT_IGNORE ();
539 void (*to_terminal_ours_for_output) (struct target_ops *)
540 TARGET_DEFAULT_IGNORE ();
541 void (*to_terminal_ours) (struct target_ops *)
542 TARGET_DEFAULT_IGNORE ();
543 void (*to_terminal_info) (struct target_ops *, const char *, int)
544 TARGET_DEFAULT_FUNC (default_terminal_info);
545 void (*to_kill) (struct target_ops *)
546 TARGET_DEFAULT_NORETURN (noprocess ());
547 void (*to_load) (struct target_ops *, const char *, int)
548 TARGET_DEFAULT_NORETURN (tcomplain ());
549 /* Start an inferior process and set inferior_ptid to its pid.
550 EXEC_FILE is the file to run.
551 ALLARGS is a string containing the arguments to the program.
552 ENV is the environment vector to pass. Errors reported with error().
553 On VxWorks and various standalone systems, we ignore exec_file. */
554 void (*to_create_inferior) (struct target_ops *,
555 char *, char *, char **, int);
556 void (*to_post_startup_inferior) (struct target_ops *, ptid_t)
557 TARGET_DEFAULT_IGNORE ();
558 int (*to_insert_fork_catchpoint) (struct target_ops *, int)
559 TARGET_DEFAULT_RETURN (1);
560 int (*to_remove_fork_catchpoint) (struct target_ops *, int)
561 TARGET_DEFAULT_RETURN (1);
562 int (*to_insert_vfork_catchpoint) (struct target_ops *, int)
563 TARGET_DEFAULT_RETURN (1);
564 int (*to_remove_vfork_catchpoint) (struct target_ops *, int)
565 TARGET_DEFAULT_RETURN (1);
566 int (*to_follow_fork) (struct target_ops *, int, int)
567 TARGET_DEFAULT_FUNC (default_follow_fork);
568 int (*to_insert_exec_catchpoint) (struct target_ops *, int)
569 TARGET_DEFAULT_RETURN (1);
570 int (*to_remove_exec_catchpoint) (struct target_ops *, int)
571 TARGET_DEFAULT_RETURN (1);
572 int (*to_set_syscall_catchpoint) (struct target_ops *,
573 int, int, int, int, int *)
574 TARGET_DEFAULT_RETURN (1);
575 int (*to_has_exited) (struct target_ops *, int, int, int *)
576 TARGET_DEFAULT_RETURN (0);
577 void (*to_mourn_inferior) (struct target_ops *)
578 TARGET_DEFAULT_FUNC (default_mourn_inferior);
579 /* Note that to_can_run is special and can be invoked on an
580 unpushed target. Targets defining this method must also define
581 to_can_async_p and to_supports_non_stop. */
582 int (*to_can_run) (struct target_ops *)
583 TARGET_DEFAULT_RETURN (0);
585 /* Documentation of this routine is provided with the corresponding
587 void (*to_pass_signals) (struct target_ops *, int,
588 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals))
589 TARGET_DEFAULT_IGNORE ();
591 /* Documentation of this routine is provided with the
592 corresponding target_* function. */
593 void (*to_program_signals) (struct target_ops *, int,
594 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals))
595 TARGET_DEFAULT_IGNORE ();
597 int (*to_thread_alive) (struct target_ops *, ptid_t ptid)
598 TARGET_DEFAULT_RETURN (0);
599 void (*to_update_thread_list) (struct target_ops *)
600 TARGET_DEFAULT_IGNORE ();
601 char *(*to_pid_to_str) (struct target_ops *, ptid_t)
602 TARGET_DEFAULT_FUNC (default_pid_to_str);
603 char *(*to_extra_thread_info) (struct target_ops *, struct thread_info *)
604 TARGET_DEFAULT_RETURN (NULL);
605 char *(*to_thread_name) (struct target_ops *, struct thread_info *)
606 TARGET_DEFAULT_RETURN (NULL);
607 void (*to_stop) (struct target_ops *, ptid_t)
608 TARGET_DEFAULT_IGNORE ();
609 void (*to_rcmd) (struct target_ops *,
610 const char *command, struct ui_file *output)
611 TARGET_DEFAULT_FUNC (default_rcmd);
612 char *(*to_pid_to_exec_file) (struct target_ops *, int pid)
613 TARGET_DEFAULT_RETURN (NULL);
614 void (*to_log_command) (struct target_ops *, const char *)
615 TARGET_DEFAULT_IGNORE ();
616 struct target_section_table *(*to_get_section_table) (struct target_ops *)
617 TARGET_DEFAULT_RETURN (NULL);
618 enum strata to_stratum;
619 int (*to_has_all_memory) (struct target_ops *);
620 int (*to_has_memory) (struct target_ops *);
621 int (*to_has_stack) (struct target_ops *);
622 int (*to_has_registers) (struct target_ops *);
623 int (*to_has_execution) (struct target_ops *, ptid_t);
624 int to_has_thread_control; /* control thread execution */
625 int to_attach_no_wait;
626 /* This method must be implemented in some situations. See the
627 comment on 'to_can_run'. */
628 int (*to_can_async_p) (struct target_ops *)
629 TARGET_DEFAULT_RETURN (0);
630 int (*to_is_async_p) (struct target_ops *)
631 TARGET_DEFAULT_RETURN (0);
632 void (*to_async) (struct target_ops *, int)
633 TARGET_DEFAULT_NORETURN (tcomplain ());
634 /* This method must be implemented in some situations. See the
635 comment on 'to_can_run'. */
636 int (*to_supports_non_stop) (struct target_ops *)
637 TARGET_DEFAULT_RETURN (0);
638 /* find_memory_regions support method for gcore */
639 int (*to_find_memory_regions) (struct target_ops *,
640 find_memory_region_ftype func, void *data)
641 TARGET_DEFAULT_FUNC (dummy_find_memory_regions);
642 /* make_corefile_notes support method for gcore */
643 char * (*to_make_corefile_notes) (struct target_ops *, bfd *, int *)
644 TARGET_DEFAULT_FUNC (dummy_make_corefile_notes);
645 /* get_bookmark support method for bookmarks */
646 gdb_byte * (*to_get_bookmark) (struct target_ops *, const char *, int)
647 TARGET_DEFAULT_NORETURN (tcomplain ());
648 /* goto_bookmark support method for bookmarks */
649 void (*to_goto_bookmark) (struct target_ops *, const gdb_byte *, int)
650 TARGET_DEFAULT_NORETURN (tcomplain ());
651 /* Return the thread-local address at OFFSET in the
652 thread-local storage for the thread PTID and the shared library
653 or executable file given by OBJFILE. If that block of
654 thread-local storage hasn't been allocated yet, this function
655 may return an error. LOAD_MODULE_ADDR may be zero for statically
656 linked multithreaded inferiors. */
657 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
659 CORE_ADDR load_module_addr,
661 TARGET_DEFAULT_NORETURN (generic_tls_error ());
663 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
664 OBJECT. The OFFSET, for a seekable object, specifies the
665 starting point. The ANNEX can be used to provide additional
666 data-specific information to the target.
668 Return the transferred status, error or OK (an
669 'enum target_xfer_status' value). Save the number of bytes
670 actually transferred in *XFERED_LEN if transfer is successful
671 (TARGET_XFER_OK) or the number unavailable bytes if the requested
672 data is unavailable (TARGET_XFER_UNAVAILABLE). *XFERED_LEN
673 smaller than LEN does not indicate the end of the object, only
674 the end of the transfer; higher level code should continue
675 transferring if desired. This is handled in target.c.
677 The interface does not support a "retry" mechanism. Instead it
678 assumes that at least one byte will be transfered on each
681 NOTE: cagney/2003-10-17: The current interface can lead to
682 fragmented transfers. Lower target levels should not implement
683 hacks, such as enlarging the transfer, in an attempt to
684 compensate for this. Instead, the target stack should be
685 extended so that it implements supply/collect methods and a
686 look-aside object cache. With that available, the lowest
687 target can safely and freely "push" data up the stack.
689 See target_read and target_write for more information. One,
690 and only one, of readbuf or writebuf must be non-NULL. */
692 enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
693 enum target_object object,
696 const gdb_byte *writebuf,
697 ULONGEST offset, ULONGEST len,
698 ULONGEST *xfered_len)
699 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
701 /* Returns the memory map for the target. A return value of NULL
702 means that no memory map is available. If a memory address
703 does not fall within any returned regions, it's assumed to be
704 RAM. The returned memory regions should not overlap.
706 The order of regions does not matter; target_memory_map will
707 sort regions by starting address. For that reason, this
708 function should not be called directly except via
711 This method should not cache data; if the memory map could
712 change unexpectedly, it should be invalidated, and higher
713 layers will re-fetch it. */
714 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *)
715 TARGET_DEFAULT_RETURN (NULL);
717 /* Erases the region of flash memory starting at ADDRESS, of
720 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
721 on flash block boundaries, as reported by 'to_memory_map'. */
722 void (*to_flash_erase) (struct target_ops *,
723 ULONGEST address, LONGEST length)
724 TARGET_DEFAULT_NORETURN (tcomplain ());
726 /* Finishes a flash memory write sequence. After this operation
727 all flash memory should be available for writing and the result
728 of reading from areas written by 'to_flash_write' should be
729 equal to what was written. */
730 void (*to_flash_done) (struct target_ops *)
731 TARGET_DEFAULT_NORETURN (tcomplain ());
733 /* Describe the architecture-specific features of this target. If
734 OPS doesn't have a description, this should delegate to the
735 "beneath" target. Returns the description found, or NULL if no
736 description was available. */
737 const struct target_desc *(*to_read_description) (struct target_ops *ops)
738 TARGET_DEFAULT_RETURN (NULL);
740 /* Build the PTID of the thread on which a given task is running,
741 based on LWP and THREAD. These values are extracted from the
742 task Private_Data section of the Ada Task Control Block, and
743 their interpretation depends on the target. */
744 ptid_t (*to_get_ada_task_ptid) (struct target_ops *,
745 long lwp, long thread)
746 TARGET_DEFAULT_FUNC (default_get_ada_task_ptid);
748 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
749 Return 0 if *READPTR is already at the end of the buffer.
750 Return -1 if there is insufficient buffer for a whole entry.
751 Return 1 if an entry was read into *TYPEP and *VALP. */
752 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
753 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
754 TARGET_DEFAULT_FUNC (default_auxv_parse);
756 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
757 sequence of bytes in PATTERN with length PATTERN_LEN.
759 The result is 1 if found, 0 if not found, and -1 if there was an error
760 requiring halting of the search (e.g. memory read error).
761 If the pattern is found the address is recorded in FOUND_ADDRP. */
762 int (*to_search_memory) (struct target_ops *ops,
763 CORE_ADDR start_addr, ULONGEST search_space_len,
764 const gdb_byte *pattern, ULONGEST pattern_len,
765 CORE_ADDR *found_addrp)
766 TARGET_DEFAULT_FUNC (default_search_memory);
768 /* Can target execute in reverse? */
769 int (*to_can_execute_reverse) (struct target_ops *)
770 TARGET_DEFAULT_RETURN (0);
772 /* The direction the target is currently executing. Must be
773 implemented on targets that support reverse execution and async
774 mode. The default simply returns forward execution. */
775 enum exec_direction_kind (*to_execution_direction) (struct target_ops *)
776 TARGET_DEFAULT_FUNC (default_execution_direction);
778 /* Does this target support debugging multiple processes
780 int (*to_supports_multi_process) (struct target_ops *)
781 TARGET_DEFAULT_RETURN (0);
783 /* Does this target support enabling and disabling tracepoints while a trace
784 experiment is running? */
785 int (*to_supports_enable_disable_tracepoint) (struct target_ops *)
786 TARGET_DEFAULT_RETURN (0);
788 /* Does this target support disabling address space randomization? */
789 int (*to_supports_disable_randomization) (struct target_ops *);
791 /* Does this target support the tracenz bytecode for string collection? */
792 int (*to_supports_string_tracing) (struct target_ops *)
793 TARGET_DEFAULT_RETURN (0);
795 /* Does this target support evaluation of breakpoint conditions on its
797 int (*to_supports_evaluation_of_breakpoint_conditions) (struct target_ops *)
798 TARGET_DEFAULT_RETURN (0);
800 /* Does this target support evaluation of breakpoint commands on its
802 int (*to_can_run_breakpoint_commands) (struct target_ops *)
803 TARGET_DEFAULT_RETURN (0);
805 /* Determine current architecture of thread PTID.
807 The target is supposed to determine the architecture of the code where
808 the target is currently stopped at (on Cell, if a target is in spu_run,
809 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
810 This is architecture used to perform decr_pc_after_break adjustment,
811 and also determines the frame architecture of the innermost frame.
812 ptrace operations need to operate according to target_gdbarch ().
814 The default implementation always returns target_gdbarch (). */
815 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t)
816 TARGET_DEFAULT_FUNC (default_thread_architecture);
818 /* Determine current address space of thread PTID.
820 The default implementation always returns the inferior's
822 struct address_space *(*to_thread_address_space) (struct target_ops *,
824 TARGET_DEFAULT_FUNC (default_thread_address_space);
826 /* Target file operations. */
828 /* Open FILENAME on the target, using FLAGS and MODE. Return a
829 target file descriptor, or -1 if an error occurs (and set
831 int (*to_fileio_open) (struct target_ops *,
832 const char *filename, int flags, int mode,
835 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
836 Return the number of bytes written, or -1 if an error occurs
837 (and set *TARGET_ERRNO). */
838 int (*to_fileio_pwrite) (struct target_ops *,
839 int fd, const gdb_byte *write_buf, int len,
840 ULONGEST offset, int *target_errno);
842 /* Read up to LEN bytes FD on the target into READ_BUF.
843 Return the number of bytes read, or -1 if an error occurs
844 (and set *TARGET_ERRNO). */
845 int (*to_fileio_pread) (struct target_ops *,
846 int fd, gdb_byte *read_buf, int len,
847 ULONGEST offset, int *target_errno);
849 /* Close FD on the target. Return 0, or -1 if an error occurs
850 (and set *TARGET_ERRNO). */
851 int (*to_fileio_close) (struct target_ops *, int fd, int *target_errno);
853 /* Unlink FILENAME on the target. Return 0, or -1 if an error
854 occurs (and set *TARGET_ERRNO). */
855 int (*to_fileio_unlink) (struct target_ops *,
856 const char *filename, int *target_errno);
858 /* Read value of symbolic link FILENAME on the target. Return a
859 null-terminated string allocated via xmalloc, or NULL if an error
860 occurs (and set *TARGET_ERRNO). */
861 char *(*to_fileio_readlink) (struct target_ops *,
862 const char *filename, int *target_errno);
865 /* Implement the "info proc" command. */
866 void (*to_info_proc) (struct target_ops *, const char *,
867 enum info_proc_what);
869 /* Tracepoint-related operations. */
871 /* Prepare the target for a tracing run. */
872 void (*to_trace_init) (struct target_ops *)
873 TARGET_DEFAULT_NORETURN (tcomplain ());
875 /* Send full details of a tracepoint location to the target. */
876 void (*to_download_tracepoint) (struct target_ops *,
877 struct bp_location *location)
878 TARGET_DEFAULT_NORETURN (tcomplain ());
880 /* Is the target able to download tracepoint locations in current
882 int (*to_can_download_tracepoint) (struct target_ops *)
883 TARGET_DEFAULT_RETURN (0);
885 /* Send full details of a trace state variable to the target. */
886 void (*to_download_trace_state_variable) (struct target_ops *,
887 struct trace_state_variable *tsv)
888 TARGET_DEFAULT_NORETURN (tcomplain ());
890 /* Enable a tracepoint on the target. */
891 void (*to_enable_tracepoint) (struct target_ops *,
892 struct bp_location *location)
893 TARGET_DEFAULT_NORETURN (tcomplain ());
895 /* Disable a tracepoint on the target. */
896 void (*to_disable_tracepoint) (struct target_ops *,
897 struct bp_location *location)
898 TARGET_DEFAULT_NORETURN (tcomplain ());
900 /* Inform the target info of memory regions that are readonly
901 (such as text sections), and so it should return data from
902 those rather than look in the trace buffer. */
903 void (*to_trace_set_readonly_regions) (struct target_ops *)
904 TARGET_DEFAULT_NORETURN (tcomplain ());
906 /* Start a trace run. */
907 void (*to_trace_start) (struct target_ops *)
908 TARGET_DEFAULT_NORETURN (tcomplain ());
910 /* Get the current status of a tracing run. */
911 int (*to_get_trace_status) (struct target_ops *, struct trace_status *ts)
912 TARGET_DEFAULT_RETURN (-1);
914 void (*to_get_tracepoint_status) (struct target_ops *,
915 struct breakpoint *tp,
916 struct uploaded_tp *utp)
917 TARGET_DEFAULT_NORETURN (tcomplain ());
919 /* Stop a trace run. */
920 void (*to_trace_stop) (struct target_ops *)
921 TARGET_DEFAULT_NORETURN (tcomplain ());
923 /* Ask the target to find a trace frame of the given type TYPE,
924 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
925 number of the trace frame, and also the tracepoint number at
926 TPP. If no trace frame matches, return -1. May throw if the
928 int (*to_trace_find) (struct target_ops *,
929 enum trace_find_type type, int num,
930 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
931 TARGET_DEFAULT_RETURN (-1);
933 /* Get the value of the trace state variable number TSV, returning
934 1 if the value is known and writing the value itself into the
935 location pointed to by VAL, else returning 0. */
936 int (*to_get_trace_state_variable_value) (struct target_ops *,
937 int tsv, LONGEST *val)
938 TARGET_DEFAULT_RETURN (0);
940 int (*to_save_trace_data) (struct target_ops *, const char *filename)
941 TARGET_DEFAULT_NORETURN (tcomplain ());
943 int (*to_upload_tracepoints) (struct target_ops *,
944 struct uploaded_tp **utpp)
945 TARGET_DEFAULT_RETURN (0);
947 int (*to_upload_trace_state_variables) (struct target_ops *,
948 struct uploaded_tsv **utsvp)
949 TARGET_DEFAULT_RETURN (0);
951 LONGEST (*to_get_raw_trace_data) (struct target_ops *, gdb_byte *buf,
952 ULONGEST offset, LONGEST len)
953 TARGET_DEFAULT_NORETURN (tcomplain ());
955 /* Get the minimum length of instruction on which a fast tracepoint
956 may be set on the target. If this operation is unsupported,
957 return -1. If for some reason the minimum length cannot be
958 determined, return 0. */
959 int (*to_get_min_fast_tracepoint_insn_len) (struct target_ops *)
960 TARGET_DEFAULT_RETURN (-1);
962 /* Set the target's tracing behavior in response to unexpected
963 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
964 void (*to_set_disconnected_tracing) (struct target_ops *, int val)
965 TARGET_DEFAULT_IGNORE ();
966 void (*to_set_circular_trace_buffer) (struct target_ops *, int val)
967 TARGET_DEFAULT_IGNORE ();
968 /* Set the size of trace buffer in the target. */
969 void (*to_set_trace_buffer_size) (struct target_ops *, LONGEST val)
970 TARGET_DEFAULT_IGNORE ();
972 /* Add/change textual notes about the trace run, returning 1 if
973 successful, 0 otherwise. */
974 int (*to_set_trace_notes) (struct target_ops *,
975 const char *user, const char *notes,
976 const char *stopnotes)
977 TARGET_DEFAULT_RETURN (0);
979 /* Return the processor core that thread PTID was last seen on.
980 This information is updated only when:
981 - update_thread_list is called
983 If the core cannot be determined -- either for the specified
984 thread, or right now, or in this debug session, or for this
985 target -- return -1. */
986 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid)
987 TARGET_DEFAULT_RETURN (-1);
989 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
990 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
991 a match, 0 if there's a mismatch, and -1 if an error is
992 encountered while reading memory. */
993 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
994 CORE_ADDR memaddr, ULONGEST size)
995 TARGET_DEFAULT_FUNC (default_verify_memory);
997 /* Return the address of the start of the Thread Information Block
998 a Windows OS specific feature. */
999 int (*to_get_tib_address) (struct target_ops *,
1000 ptid_t ptid, CORE_ADDR *addr)
1001 TARGET_DEFAULT_NORETURN (tcomplain ());
1003 /* Send the new settings of write permission variables. */
1004 void (*to_set_permissions) (struct target_ops *)
1005 TARGET_DEFAULT_IGNORE ();
1007 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
1008 with its details. Return 1 on success, 0 on failure. */
1009 int (*to_static_tracepoint_marker_at) (struct target_ops *, CORE_ADDR,
1010 struct static_tracepoint_marker *marker)
1011 TARGET_DEFAULT_RETURN (0);
1013 /* Return a vector of all tracepoints markers string id ID, or all
1014 markers if ID is NULL. */
1015 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid) (struct target_ops *, const char *id)
1016 TARGET_DEFAULT_NORETURN (tcomplain ());
1018 /* Return a traceframe info object describing the current
1019 traceframe's contents. This method should not cache data;
1020 higher layers take care of caching, invalidating, and
1021 re-fetching when necessary. */
1022 struct traceframe_info *(*to_traceframe_info) (struct target_ops *)
1023 TARGET_DEFAULT_NORETURN (tcomplain ());
1025 /* Ask the target to use or not to use agent according to USE. Return 1
1026 successful, 0 otherwise. */
1027 int (*to_use_agent) (struct target_ops *, int use)
1028 TARGET_DEFAULT_NORETURN (tcomplain ());
1030 /* Is the target able to use agent in current state? */
1031 int (*to_can_use_agent) (struct target_ops *)
1032 TARGET_DEFAULT_RETURN (0);
1034 /* Check whether the target supports branch tracing. */
1035 int (*to_supports_btrace) (struct target_ops *, enum btrace_format)
1036 TARGET_DEFAULT_RETURN (0);
1038 /* Enable branch tracing for PTID using CONF configuration.
1039 Return a branch trace target information struct for reading and for
1040 disabling branch trace. */
1041 struct btrace_target_info *(*to_enable_btrace) (struct target_ops *,
1043 const struct btrace_config *conf)
1044 TARGET_DEFAULT_NORETURN (tcomplain ());
1046 /* Disable branch tracing and deallocate TINFO. */
1047 void (*to_disable_btrace) (struct target_ops *,
1048 struct btrace_target_info *tinfo)
1049 TARGET_DEFAULT_NORETURN (tcomplain ());
1051 /* Disable branch tracing and deallocate TINFO. This function is similar
1052 to to_disable_btrace, except that it is called during teardown and is
1053 only allowed to perform actions that are safe. A counter-example would
1054 be attempting to talk to a remote target. */
1055 void (*to_teardown_btrace) (struct target_ops *,
1056 struct btrace_target_info *tinfo)
1057 TARGET_DEFAULT_NORETURN (tcomplain ());
1059 /* Read branch trace data for the thread indicated by BTINFO into DATA.
1060 DATA is cleared before new trace is added. */
1061 enum btrace_error (*to_read_btrace) (struct target_ops *self,
1062 struct btrace_data *data,
1063 struct btrace_target_info *btinfo,
1064 enum btrace_read_type type)
1065 TARGET_DEFAULT_NORETURN (tcomplain ());
1067 /* Get the branch trace configuration. */
1068 const struct btrace_config *(*to_btrace_conf) (struct target_ops *self,
1069 const struct btrace_target_info *)
1070 TARGET_DEFAULT_RETURN (NULL);
1072 /* Stop trace recording. */
1073 void (*to_stop_recording) (struct target_ops *)
1074 TARGET_DEFAULT_IGNORE ();
1076 /* Print information about the recording. */
1077 void (*to_info_record) (struct target_ops *)
1078 TARGET_DEFAULT_IGNORE ();
1080 /* Save the recorded execution trace into a file. */
1081 void (*to_save_record) (struct target_ops *, const char *filename)
1082 TARGET_DEFAULT_NORETURN (tcomplain ());
1084 /* Delete the recorded execution trace from the current position
1086 void (*to_delete_record) (struct target_ops *)
1087 TARGET_DEFAULT_NORETURN (tcomplain ());
1089 /* Query if the record target is currently replaying. */
1090 int (*to_record_is_replaying) (struct target_ops *)
1091 TARGET_DEFAULT_RETURN (0);
1093 /* Go to the begin of the execution trace. */
1094 void (*to_goto_record_begin) (struct target_ops *)
1095 TARGET_DEFAULT_NORETURN (tcomplain ());
1097 /* Go to the end of the execution trace. */
1098 void (*to_goto_record_end) (struct target_ops *)
1099 TARGET_DEFAULT_NORETURN (tcomplain ());
1101 /* Go to a specific location in the recorded execution trace. */
1102 void (*to_goto_record) (struct target_ops *, ULONGEST insn)
1103 TARGET_DEFAULT_NORETURN (tcomplain ());
1105 /* Disassemble SIZE instructions in the recorded execution trace from
1106 the current position.
1107 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1108 disassemble SIZE succeeding instructions. */
1109 void (*to_insn_history) (struct target_ops *, int size, int flags)
1110 TARGET_DEFAULT_NORETURN (tcomplain ());
1112 /* Disassemble SIZE instructions in the recorded execution trace around
1114 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1115 disassemble SIZE instructions after FROM. */
1116 void (*to_insn_history_from) (struct target_ops *,
1117 ULONGEST from, int size, int flags)
1118 TARGET_DEFAULT_NORETURN (tcomplain ());
1120 /* Disassemble a section of the recorded execution trace from instruction
1121 BEGIN (inclusive) to instruction END (inclusive). */
1122 void (*to_insn_history_range) (struct target_ops *,
1123 ULONGEST begin, ULONGEST end, int flags)
1124 TARGET_DEFAULT_NORETURN (tcomplain ());
1126 /* Print a function trace of the recorded execution trace.
1127 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1128 succeeding functions. */
1129 void (*to_call_history) (struct target_ops *, int size, int flags)
1130 TARGET_DEFAULT_NORETURN (tcomplain ());
1132 /* Print a function trace of the recorded execution trace starting
1134 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1135 SIZE functions after FROM. */
1136 void (*to_call_history_from) (struct target_ops *,
1137 ULONGEST begin, int size, int flags)
1138 TARGET_DEFAULT_NORETURN (tcomplain ());
1140 /* Print a function trace of an execution trace section from function BEGIN
1141 (inclusive) to function END (inclusive). */
1142 void (*to_call_history_range) (struct target_ops *,
1143 ULONGEST begin, ULONGEST end, int flags)
1144 TARGET_DEFAULT_NORETURN (tcomplain ());
1146 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1148 int (*to_augmented_libraries_svr4_read) (struct target_ops *)
1149 TARGET_DEFAULT_RETURN (0);
1151 /* Those unwinders are tried before any other arch unwinders. If
1152 SELF doesn't have unwinders, it should delegate to the
1153 "beneath" target. */
1154 const struct frame_unwind *(*to_get_unwinder) (struct target_ops *self)
1155 TARGET_DEFAULT_RETURN (NULL);
1157 const struct frame_unwind *(*to_get_tailcall_unwinder) (struct target_ops *self)
1158 TARGET_DEFAULT_RETURN (NULL);
1160 /* Prepare to generate a core file. */
1161 void (*to_prepare_to_generate_core) (struct target_ops *)
1162 TARGET_DEFAULT_IGNORE ();
1164 /* Cleanup after generating a core file. */
1165 void (*to_done_generating_core) (struct target_ops *)
1166 TARGET_DEFAULT_IGNORE ();
1169 /* Need sub-structure for target machine related rather than comm related?
1173 /* Magic number for checking ops size. If a struct doesn't end with this
1174 number, somebody changed the declaration but didn't change all the
1175 places that initialize one. */
1177 #define OPS_MAGIC 3840
1179 /* The ops structure for our "current" target process. This should
1180 never be NULL. If there is no target, it points to the dummy_target. */
1182 extern struct target_ops current_target;
1184 /* Define easy words for doing these operations on our current target. */
1186 #define target_shortname (current_target.to_shortname)
1187 #define target_longname (current_target.to_longname)
1189 /* Does whatever cleanup is required for a target that we are no
1190 longer going to be calling. This routine is automatically always
1191 called after popping the target off the target stack - the target's
1192 own methods are no longer available through the target vector.
1193 Closing file descriptors and freeing all memory allocated memory are
1194 typical things it should do. */
1196 void target_close (struct target_ops *targ);
1198 /* Find the correct target to use for "attach". If a target on the
1199 current stack supports attaching, then it is returned. Otherwise,
1200 the default run target is returned. */
1202 extern struct target_ops *find_attach_target (void);
1204 /* Find the correct target to use for "run". If a target on the
1205 current stack supports creating a new inferior, then it is
1206 returned. Otherwise, the default run target is returned. */
1208 extern struct target_ops *find_run_target (void);
1210 /* Some targets don't generate traps when attaching to the inferior,
1211 or their target_attach implementation takes care of the waiting.
1212 These targets must set to_attach_no_wait. */
1214 #define target_attach_no_wait \
1215 (current_target.to_attach_no_wait)
1217 /* The target_attach operation places a process under debugger control,
1218 and stops the process.
1220 This operation provides a target-specific hook that allows the
1221 necessary bookkeeping to be performed after an attach completes. */
1222 #define target_post_attach(pid) \
1223 (*current_target.to_post_attach) (¤t_target, pid)
1225 /* Takes a program previously attached to and detaches it.
1226 The program may resume execution (some targets do, some don't) and will
1227 no longer stop on signals, etc. We better not have left any breakpoints
1228 in the program or it'll die when it hits one. ARGS is arguments
1229 typed by the user (e.g. a signal to send the process). FROM_TTY
1230 says whether to be verbose or not. */
1232 extern void target_detach (const char *, int);
1234 /* Disconnect from the current target without resuming it (leaving it
1235 waiting for a debugger). */
1237 extern void target_disconnect (const char *, int);
1239 /* Resume execution of the target process PTID (or a group of
1240 threads). STEP says whether to single-step or to run free; SIGGNAL
1241 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1242 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1243 PTID means `step/resume only this process id'. A wildcard PTID
1244 (all threads, or all threads of process) means `step/resume
1245 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1246 matches) resume with their 'thread->suspend.stop_signal' signal
1247 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1248 if in "no pass" state. */
1250 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1252 /* Wait for process pid to do something. PTID = -1 to wait for any
1253 pid to do something. Return pid of child, or -1 in case of error;
1254 store status through argument pointer STATUS. Note that it is
1255 _NOT_ OK to throw_exception() out of target_wait() without popping
1256 the debugging target from the stack; GDB isn't prepared to get back
1257 to the prompt with a debugging target but without the frame cache,
1258 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1261 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1264 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1266 extern void target_fetch_registers (struct regcache *regcache, int regno);
1268 /* Store at least register REGNO, or all regs if REGNO == -1.
1269 It can store as many registers as it wants to, so target_prepare_to_store
1270 must have been previously called. Calls error() if there are problems. */
1272 extern void target_store_registers (struct regcache *regcache, int regs);
1274 /* Get ready to modify the registers array. On machines which store
1275 individual registers, this doesn't need to do anything. On machines
1276 which store all the registers in one fell swoop, this makes sure
1277 that REGISTERS contains all the registers from the program being
1280 #define target_prepare_to_store(regcache) \
1281 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1283 /* Determine current address space of thread PTID. */
1285 struct address_space *target_thread_address_space (ptid_t);
1287 /* Implement the "info proc" command. This returns one if the request
1288 was handled, and zero otherwise. It can also throw an exception if
1289 an error was encountered while attempting to handle the
1292 int target_info_proc (const char *, enum info_proc_what);
1294 /* Returns true if this target can debug multiple processes
1297 #define target_supports_multi_process() \
1298 (*current_target.to_supports_multi_process) (¤t_target)
1300 /* Returns true if this target can disable address space randomization. */
1302 int target_supports_disable_randomization (void);
1304 /* Returns true if this target can enable and disable tracepoints
1305 while a trace experiment is running. */
1307 #define target_supports_enable_disable_tracepoint() \
1308 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1310 #define target_supports_string_tracing() \
1311 (*current_target.to_supports_string_tracing) (¤t_target)
1313 /* Returns true if this target can handle breakpoint conditions
1316 #define target_supports_evaluation_of_breakpoint_conditions() \
1317 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1319 /* Returns true if this target can handle breakpoint commands
1322 #define target_can_run_breakpoint_commands() \
1323 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1325 extern int target_read_string (CORE_ADDR, char **, int, int *);
1327 /* For target_read_memory see target/target.h. */
1329 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1332 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1334 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1336 /* For target_write_memory see target/target.h. */
1338 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1341 /* Fetches the target's memory map. If one is found it is sorted
1342 and returned, after some consistency checking. Otherwise, NULL
1344 VEC(mem_region_s) *target_memory_map (void);
1346 /* Erase the specified flash region. */
1347 void target_flash_erase (ULONGEST address, LONGEST length);
1349 /* Finish a sequence of flash operations. */
1350 void target_flash_done (void);
1352 /* Describes a request for a memory write operation. */
1353 struct memory_write_request
1355 /* Begining address that must be written. */
1357 /* Past-the-end address. */
1359 /* The data to write. */
1361 /* A callback baton for progress reporting for this request. */
1364 typedef struct memory_write_request memory_write_request_s;
1365 DEF_VEC_O(memory_write_request_s);
1367 /* Enumeration specifying different flash preservation behaviour. */
1368 enum flash_preserve_mode
1374 /* Write several memory blocks at once. This version can be more
1375 efficient than making several calls to target_write_memory, in
1376 particular because it can optimize accesses to flash memory.
1378 Moreover, this is currently the only memory access function in gdb
1379 that supports writing to flash memory, and it should be used for
1380 all cases where access to flash memory is desirable.
1382 REQUESTS is the vector (see vec.h) of memory_write_request.
1383 PRESERVE_FLASH_P indicates what to do with blocks which must be
1384 erased, but not completely rewritten.
1385 PROGRESS_CB is a function that will be periodically called to provide
1386 feedback to user. It will be called with the baton corresponding
1387 to the request currently being written. It may also be called
1388 with a NULL baton, when preserved flash sectors are being rewritten.
1390 The function returns 0 on success, and error otherwise. */
1391 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1392 enum flash_preserve_mode preserve_flash_p,
1393 void (*progress_cb) (ULONGEST, void *));
1395 /* Print a line about the current target. */
1397 #define target_files_info() \
1398 (*current_target.to_files_info) (¤t_target)
1400 /* Insert a breakpoint at address BP_TGT->placed_address in
1401 the target machine. Returns 0 for success, and returns non-zero or
1402 throws an error (with a detailed failure reason error code and
1403 message) otherwise. */
1405 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1406 struct bp_target_info *bp_tgt);
1408 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1409 machine. Result is 0 for success, non-zero for error. */
1411 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1412 struct bp_target_info *bp_tgt);
1414 /* Returns true if the terminal settings of the inferior are in
1417 extern int target_terminal_is_inferior (void);
1419 /* Initialize the terminal settings we record for the inferior,
1420 before we actually run the inferior. */
1422 extern void target_terminal_init (void);
1424 /* Put the inferior's terminal settings into effect.
1425 This is preparation for starting or resuming the inferior. */
1427 extern void target_terminal_inferior (void);
1429 /* Put some of our terminal settings into effect, enough to get proper
1430 results from our output, but do not change into or out of RAW mode
1431 so that no input is discarded. This is a no-op if terminal_ours
1432 was most recently called. */
1434 extern void target_terminal_ours_for_output (void);
1436 /* Put our terminal settings into effect.
1437 First record the inferior's terminal settings
1438 so they can be restored properly later. */
1440 extern void target_terminal_ours (void);
1442 /* Return true if the target stack has a non-default
1443 "to_terminal_ours" method. */
1445 extern int target_supports_terminal_ours (void);
1447 /* Make a cleanup that restores the state of the terminal to the current
1449 extern struct cleanup *make_cleanup_restore_target_terminal (void);
1451 /* Print useful information about our terminal status, if such a thing
1454 #define target_terminal_info(arg, from_tty) \
1455 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1457 /* Kill the inferior process. Make it go away. */
1459 extern void target_kill (void);
1461 /* Load an executable file into the target process. This is expected
1462 to not only bring new code into the target process, but also to
1463 update GDB's symbol tables to match.
1465 ARG contains command-line arguments, to be broken down with
1466 buildargv (). The first non-switch argument is the filename to
1467 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1468 0)), which is an offset to apply to the load addresses of FILE's
1469 sections. The target may define switches, or other non-switch
1470 arguments, as it pleases. */
1472 extern void target_load (const char *arg, int from_tty);
1474 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1475 notification of inferior events such as fork and vork immediately
1476 after the inferior is created. (This because of how gdb gets an
1477 inferior created via invoking a shell to do it. In such a scenario,
1478 if the shell init file has commands in it, the shell will fork and
1479 exec for each of those commands, and we will see each such fork
1482 Such targets will supply an appropriate definition for this function. */
1484 #define target_post_startup_inferior(ptid) \
1485 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1487 /* On some targets, we can catch an inferior fork or vfork event when
1488 it occurs. These functions insert/remove an already-created
1489 catchpoint for such events. They return 0 for success, 1 if the
1490 catchpoint type is not supported and -1 for failure. */
1492 #define target_insert_fork_catchpoint(pid) \
1493 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1495 #define target_remove_fork_catchpoint(pid) \
1496 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1498 #define target_insert_vfork_catchpoint(pid) \
1499 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1501 #define target_remove_vfork_catchpoint(pid) \
1502 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1504 /* If the inferior forks or vforks, this function will be called at
1505 the next resume in order to perform any bookkeeping and fiddling
1506 necessary to continue debugging either the parent or child, as
1507 requested, and releasing the other. Information about the fork
1508 or vfork event is available via get_last_target_status ().
1509 This function returns 1 if the inferior should not be resumed
1510 (i.e. there is another event pending). */
1512 int target_follow_fork (int follow_child, int detach_fork);
1514 /* On some targets, we can catch an inferior exec event when it
1515 occurs. These functions insert/remove an already-created
1516 catchpoint for such events. They return 0 for success, 1 if the
1517 catchpoint type is not supported and -1 for failure. */
1519 #define target_insert_exec_catchpoint(pid) \
1520 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1522 #define target_remove_exec_catchpoint(pid) \
1523 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1527 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1528 If NEEDED is zero, it means the target can disable the mechanism to
1529 catch system calls because there are no more catchpoints of this type.
1531 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1532 being requested. In this case, both TABLE_SIZE and TABLE should
1535 TABLE_SIZE is the number of elements in TABLE. It only matters if
1538 TABLE is an array of ints, indexed by syscall number. An element in
1539 this array is nonzero if that syscall should be caught. This argument
1540 only matters if ANY_COUNT is zero.
1542 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1545 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1546 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1547 pid, needed, any_count, \
1550 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1551 exit code of PID, if any. */
1553 #define target_has_exited(pid,wait_status,exit_status) \
1554 (*current_target.to_has_exited) (¤t_target, \
1555 pid,wait_status,exit_status)
1557 /* The debugger has completed a blocking wait() call. There is now
1558 some process event that must be processed. This function should
1559 be defined by those targets that require the debugger to perform
1560 cleanup or internal state changes in response to the process event. */
1562 /* The inferior process has died. Do what is right. */
1564 void target_mourn_inferior (void);
1566 /* Does target have enough data to do a run or attach command? */
1568 #define target_can_run(t) \
1569 ((t)->to_can_run) (t)
1571 /* Set list of signals to be handled in the target.
1573 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1574 (enum gdb_signal). For every signal whose entry in this array is
1575 non-zero, the target is allowed -but not required- to skip reporting
1576 arrival of the signal to the GDB core by returning from target_wait,
1577 and to pass the signal directly to the inferior instead.
1579 However, if the target is hardware single-stepping a thread that is
1580 about to receive a signal, it needs to be reported in any case, even
1581 if mentioned in a previous target_pass_signals call. */
1583 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1585 /* Set list of signals the target may pass to the inferior. This
1586 directly maps to the "handle SIGNAL pass/nopass" setting.
1588 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1589 number (enum gdb_signal). For every signal whose entry in this
1590 array is non-zero, the target is allowed to pass the signal to the
1591 inferior. Signals not present in the array shall be silently
1592 discarded. This does not influence whether to pass signals to the
1593 inferior as a result of a target_resume call. This is useful in
1594 scenarios where the target needs to decide whether to pass or not a
1595 signal to the inferior without GDB core involvement, such as for
1596 example, when detaching (as threads may have been suspended with
1597 pending signals not reported to GDB). */
1599 extern void target_program_signals (int nsig, unsigned char *program_signals);
1601 /* Check to see if a thread is still alive. */
1603 extern int target_thread_alive (ptid_t ptid);
1605 /* Sync the target's threads with GDB's thread list. */
1607 extern void target_update_thread_list (void);
1609 /* Make target stop in a continuable fashion. (For instance, under
1610 Unix, this should act like SIGSTOP). Note that this function is
1611 asynchronous: it does not wait for the target to become stopped
1612 before returning. If this is the behavior you want please use
1613 target_stop_and_wait. */
1615 extern void target_stop (ptid_t ptid);
1617 /* Send the specified COMMAND to the target's monitor
1618 (shell,interpreter) for execution. The result of the query is
1619 placed in OUTBUF. */
1621 #define target_rcmd(command, outbuf) \
1622 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1625 /* Does the target include all of memory, or only part of it? This
1626 determines whether we look up the target chain for other parts of
1627 memory if this target can't satisfy a request. */
1629 extern int target_has_all_memory_1 (void);
1630 #define target_has_all_memory target_has_all_memory_1 ()
1632 /* Does the target include memory? (Dummy targets don't.) */
1634 extern int target_has_memory_1 (void);
1635 #define target_has_memory target_has_memory_1 ()
1637 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1638 we start a process.) */
1640 extern int target_has_stack_1 (void);
1641 #define target_has_stack target_has_stack_1 ()
1643 /* Does the target have registers? (Exec files don't.) */
1645 extern int target_has_registers_1 (void);
1646 #define target_has_registers target_has_registers_1 ()
1648 /* Does the target have execution? Can we make it jump (through
1649 hoops), or pop its stack a few times? This means that the current
1650 target is currently executing; for some targets, that's the same as
1651 whether or not the target is capable of execution, but there are
1652 also targets which can be current while not executing. In that
1653 case this will become true after to_create_inferior or
1656 extern int target_has_execution_1 (ptid_t);
1658 /* Like target_has_execution_1, but always passes inferior_ptid. */
1660 extern int target_has_execution_current (void);
1662 #define target_has_execution target_has_execution_current ()
1664 /* Default implementations for process_stratum targets. Return true
1665 if there's a selected inferior, false otherwise. */
1667 extern int default_child_has_all_memory (struct target_ops *ops);
1668 extern int default_child_has_memory (struct target_ops *ops);
1669 extern int default_child_has_stack (struct target_ops *ops);
1670 extern int default_child_has_registers (struct target_ops *ops);
1671 extern int default_child_has_execution (struct target_ops *ops,
1674 /* Can the target support the debugger control of thread execution?
1675 Can it lock the thread scheduler? */
1677 #define target_can_lock_scheduler \
1678 (current_target.to_has_thread_control & tc_schedlock)
1680 /* Controls whether async mode is permitted. */
1681 extern int target_async_permitted;
1683 /* Can the target support asynchronous execution? */
1684 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1686 /* Is the target in asynchronous execution mode? */
1687 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1689 /* Enables/disabled async target events. */
1690 #define target_async(ENABLE) \
1691 (current_target.to_async (¤t_target, (ENABLE)))
1693 #define target_execution_direction() \
1694 (current_target.to_execution_direction (¤t_target))
1696 /* Converts a process id to a string. Usually, the string just contains
1697 `process xyz', but on some systems it may contain
1698 `process xyz thread abc'. */
1700 extern char *target_pid_to_str (ptid_t ptid);
1702 extern char *normal_pid_to_str (ptid_t ptid);
1704 /* Return a short string describing extra information about PID,
1705 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1708 #define target_extra_thread_info(TP) \
1709 (current_target.to_extra_thread_info (¤t_target, TP))
1711 /* Return the thread's name. A NULL result means that the target
1712 could not determine this thread's name. */
1714 extern char *target_thread_name (struct thread_info *);
1716 /* Attempts to find the pathname of the executable file
1717 that was run to create a specified process.
1719 The process PID must be stopped when this operation is used.
1721 If the executable file cannot be determined, NULL is returned.
1723 Else, a pointer to a character string containing the pathname
1724 is returned. This string should be copied into a buffer by
1725 the client if the string will not be immediately used, or if
1728 #define target_pid_to_exec_file(pid) \
1729 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1731 /* See the to_thread_architecture description in struct target_ops. */
1733 #define target_thread_architecture(ptid) \
1734 (current_target.to_thread_architecture (¤t_target, ptid))
1737 * Iterator function for target memory regions.
1738 * Calls a callback function once for each memory region 'mapped'
1739 * in the child process. Defined as a simple macro rather than
1740 * as a function macro so that it can be tested for nullity.
1743 #define target_find_memory_regions(FUNC, DATA) \
1744 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1747 * Compose corefile .note section.
1750 #define target_make_corefile_notes(BFD, SIZE_P) \
1751 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1753 /* Bookmark interfaces. */
1754 #define target_get_bookmark(ARGS, FROM_TTY) \
1755 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1757 #define target_goto_bookmark(ARG, FROM_TTY) \
1758 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1760 /* Hardware watchpoint interfaces. */
1762 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1763 write). Only the INFERIOR_PTID task is being queried. */
1765 #define target_stopped_by_watchpoint() \
1766 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1768 /* Returns non-zero if the target stopped because it executed a
1769 software breakpoint instruction. */
1771 #define target_stopped_by_sw_breakpoint() \
1772 ((*current_target.to_stopped_by_sw_breakpoint) (¤t_target))
1774 #define target_supports_stopped_by_sw_breakpoint() \
1775 ((*current_target.to_supports_stopped_by_sw_breakpoint) (¤t_target))
1777 #define target_stopped_by_hw_breakpoint() \
1778 ((*current_target.to_stopped_by_hw_breakpoint) (¤t_target))
1780 #define target_supports_stopped_by_hw_breakpoint() \
1781 ((*current_target.to_supports_stopped_by_hw_breakpoint) (¤t_target))
1783 /* Non-zero if we have steppable watchpoints */
1785 #define target_have_steppable_watchpoint \
1786 (current_target.to_have_steppable_watchpoint)
1788 /* Non-zero if we have continuable watchpoints */
1790 #define target_have_continuable_watchpoint \
1791 (current_target.to_have_continuable_watchpoint)
1793 /* Provide defaults for hardware watchpoint functions. */
1795 /* If the *_hw_beakpoint functions have not been defined
1796 elsewhere use the definitions in the target vector. */
1798 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1799 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1800 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1801 (including this one?). OTHERTYPE is who knows what... */
1803 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1804 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1805 TYPE, CNT, OTHERTYPE);
1807 /* Returns the number of debug registers needed to watch the given
1808 memory region, or zero if not supported. */
1810 #define target_region_ok_for_hw_watchpoint(addr, len) \
1811 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1815 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1816 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1817 COND is the expression for its condition, or NULL if there's none.
1818 Returns 0 for success, 1 if the watchpoint type is not supported,
1821 #define target_insert_watchpoint(addr, len, type, cond) \
1822 (*current_target.to_insert_watchpoint) (¤t_target, \
1823 addr, len, type, cond)
1825 #define target_remove_watchpoint(addr, len, type, cond) \
1826 (*current_target.to_remove_watchpoint) (¤t_target, \
1827 addr, len, type, cond)
1829 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1830 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1831 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1832 masked watchpoints are not supported, -1 for failure. */
1834 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1836 /* Remove a masked watchpoint at ADDR with the mask MASK.
1837 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1838 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1841 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1843 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1844 the target machine. Returns 0 for success, and returns non-zero or
1845 throws an error (with a detailed failure reason error code and
1846 message) otherwise. */
1848 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1849 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1852 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1853 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1856 /* Return number of debug registers needed for a ranged breakpoint,
1857 or -1 if ranged breakpoints are not supported. */
1859 extern int target_ranged_break_num_registers (void);
1861 /* Return non-zero if target knows the data address which triggered this
1862 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1863 INFERIOR_PTID task is being queried. */
1864 #define target_stopped_data_address(target, addr_p) \
1865 (*(target)->to_stopped_data_address) (target, addr_p)
1867 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1868 LENGTH bytes beginning at START. */
1869 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1870 (*(target)->to_watchpoint_addr_within_range) (target, addr, start, length)
1872 /* Return non-zero if the target is capable of using hardware to evaluate
1873 the condition expression. In this case, if the condition is false when
1874 the watched memory location changes, execution may continue without the
1875 debugger being notified.
1877 Due to limitations in the hardware implementation, it may be capable of
1878 avoiding triggering the watchpoint in some cases where the condition
1879 expression is false, but may report some false positives as well.
1880 For this reason, GDB will still evaluate the condition expression when
1881 the watchpoint triggers. */
1882 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1883 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1884 addr, len, type, cond)
1886 /* Return number of debug registers needed for a masked watchpoint,
1887 -1 if masked watchpoints are not supported or -2 if the given address
1888 and mask combination cannot be used. */
1890 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1892 /* Target can execute in reverse? */
1893 #define target_can_execute_reverse \
1894 current_target.to_can_execute_reverse (¤t_target)
1896 extern const struct target_desc *target_read_description (struct target_ops *);
1898 #define target_get_ada_task_ptid(lwp, tid) \
1899 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1901 /* Utility implementation of searching memory. */
1902 extern int simple_search_memory (struct target_ops* ops,
1903 CORE_ADDR start_addr,
1904 ULONGEST search_space_len,
1905 const gdb_byte *pattern,
1906 ULONGEST pattern_len,
1907 CORE_ADDR *found_addrp);
1909 /* Main entry point for searching memory. */
1910 extern int target_search_memory (CORE_ADDR start_addr,
1911 ULONGEST search_space_len,
1912 const gdb_byte *pattern,
1913 ULONGEST pattern_len,
1914 CORE_ADDR *found_addrp);
1916 /* Target file operations. */
1918 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1919 target file descriptor, or -1 if an error occurs (and set
1921 extern int target_fileio_open (const char *filename, int flags, int mode,
1924 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1925 Return the number of bytes written, or -1 if an error occurs
1926 (and set *TARGET_ERRNO). */
1927 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1928 ULONGEST offset, int *target_errno);
1930 /* Read up to LEN bytes FD on the target into READ_BUF.
1931 Return the number of bytes read, or -1 if an error occurs
1932 (and set *TARGET_ERRNO). */
1933 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1934 ULONGEST offset, int *target_errno);
1936 /* Close FD on the target. Return 0, or -1 if an error occurs
1937 (and set *TARGET_ERRNO). */
1938 extern int target_fileio_close (int fd, int *target_errno);
1940 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1941 occurs (and set *TARGET_ERRNO). */
1942 extern int target_fileio_unlink (const char *filename, int *target_errno);
1944 /* Read value of symbolic link FILENAME on the target. Return a
1945 null-terminated string allocated via xmalloc, or NULL if an error
1946 occurs (and set *TARGET_ERRNO). */
1947 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1949 /* Read target file FILENAME. The return value will be -1 if the transfer
1950 fails or is not supported; 0 if the object is empty; or the length
1951 of the object otherwise. If a positive value is returned, a
1952 sufficiently large buffer will be allocated using xmalloc and
1953 returned in *BUF_P containing the contents of the object.
1955 This method should be used for objects sufficiently small to store
1956 in a single xmalloc'd buffer, when no fixed bound on the object's
1957 size is known in advance. */
1958 extern LONGEST target_fileio_read_alloc (const char *filename,
1961 /* Read target file FILENAME. The result is NUL-terminated and
1962 returned as a string, allocated using xmalloc. If an error occurs
1963 or the transfer is unsupported, NULL is returned. Empty objects
1964 are returned as allocated but empty strings. A warning is issued
1965 if the result contains any embedded NUL bytes. */
1966 extern char *target_fileio_read_stralloc (const char *filename);
1969 /* Tracepoint-related operations. */
1971 #define target_trace_init() \
1972 (*current_target.to_trace_init) (¤t_target)
1974 #define target_download_tracepoint(t) \
1975 (*current_target.to_download_tracepoint) (¤t_target, t)
1977 #define target_can_download_tracepoint() \
1978 (*current_target.to_can_download_tracepoint) (¤t_target)
1980 #define target_download_trace_state_variable(tsv) \
1981 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1983 #define target_enable_tracepoint(loc) \
1984 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1986 #define target_disable_tracepoint(loc) \
1987 (*current_target.to_disable_tracepoint) (¤t_target, loc)
1989 #define target_trace_start() \
1990 (*current_target.to_trace_start) (¤t_target)
1992 #define target_trace_set_readonly_regions() \
1993 (*current_target.to_trace_set_readonly_regions) (¤t_target)
1995 #define target_get_trace_status(ts) \
1996 (*current_target.to_get_trace_status) (¤t_target, ts)
1998 #define target_get_tracepoint_status(tp,utp) \
1999 (*current_target.to_get_tracepoint_status) (¤t_target, tp, utp)
2001 #define target_trace_stop() \
2002 (*current_target.to_trace_stop) (¤t_target)
2004 #define target_trace_find(type,num,addr1,addr2,tpp) \
2005 (*current_target.to_trace_find) (¤t_target, \
2006 (type), (num), (addr1), (addr2), (tpp))
2008 #define target_get_trace_state_variable_value(tsv,val) \
2009 (*current_target.to_get_trace_state_variable_value) (¤t_target, \
2012 #define target_save_trace_data(filename) \
2013 (*current_target.to_save_trace_data) (¤t_target, filename)
2015 #define target_upload_tracepoints(utpp) \
2016 (*current_target.to_upload_tracepoints) (¤t_target, utpp)
2018 #define target_upload_trace_state_variables(utsvp) \
2019 (*current_target.to_upload_trace_state_variables) (¤t_target, utsvp)
2021 #define target_get_raw_trace_data(buf,offset,len) \
2022 (*current_target.to_get_raw_trace_data) (¤t_target, \
2023 (buf), (offset), (len))
2025 #define target_get_min_fast_tracepoint_insn_len() \
2026 (*current_target.to_get_min_fast_tracepoint_insn_len) (¤t_target)
2028 #define target_set_disconnected_tracing(val) \
2029 (*current_target.to_set_disconnected_tracing) (¤t_target, val)
2031 #define target_set_circular_trace_buffer(val) \
2032 (*current_target.to_set_circular_trace_buffer) (¤t_target, val)
2034 #define target_set_trace_buffer_size(val) \
2035 (*current_target.to_set_trace_buffer_size) (¤t_target, val)
2037 #define target_set_trace_notes(user,notes,stopnotes) \
2038 (*current_target.to_set_trace_notes) (¤t_target, \
2039 (user), (notes), (stopnotes))
2041 #define target_get_tib_address(ptid, addr) \
2042 (*current_target.to_get_tib_address) (¤t_target, (ptid), (addr))
2044 #define target_set_permissions() \
2045 (*current_target.to_set_permissions) (¤t_target)
2047 #define target_static_tracepoint_marker_at(addr, marker) \
2048 (*current_target.to_static_tracepoint_marker_at) (¤t_target, \
2051 #define target_static_tracepoint_markers_by_strid(marker_id) \
2052 (*current_target.to_static_tracepoint_markers_by_strid) (¤t_target, \
2055 #define target_traceframe_info() \
2056 (*current_target.to_traceframe_info) (¤t_target)
2058 #define target_use_agent(use) \
2059 (*current_target.to_use_agent) (¤t_target, use)
2061 #define target_can_use_agent() \
2062 (*current_target.to_can_use_agent) (¤t_target)
2064 #define target_augmented_libraries_svr4_read() \
2065 (*current_target.to_augmented_libraries_svr4_read) (¤t_target)
2067 /* Command logging facility. */
2069 #define target_log_command(p) \
2070 (*current_target.to_log_command) (¤t_target, p)
2073 extern int target_core_of_thread (ptid_t ptid);
2075 /* See to_get_unwinder in struct target_ops. */
2076 extern const struct frame_unwind *target_get_unwinder (void);
2078 /* See to_get_tailcall_unwinder in struct target_ops. */
2079 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
2081 /* This implements basic memory verification, reading target memory
2082 and performing the comparison here (as opposed to accelerated
2083 verification making use of the qCRC packet, for example). */
2085 extern int simple_verify_memory (struct target_ops* ops,
2086 const gdb_byte *data,
2087 CORE_ADDR memaddr, ULONGEST size);
2089 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2090 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2091 if there's a mismatch, and -1 if an error is encountered while
2092 reading memory. Throws an error if the functionality is found not
2093 to be supported by the current target. */
2094 int target_verify_memory (const gdb_byte *data,
2095 CORE_ADDR memaddr, ULONGEST size);
2097 /* Routines for maintenance of the target structures...
2099 complete_target_initialization: Finalize a target_ops by filling in
2100 any fields needed by the target implementation. Unnecessary for
2101 targets which are registered via add_target, as this part gets
2104 add_target: Add a target to the list of all possible targets.
2105 This only makes sense for targets that should be activated using
2106 the "target TARGET_NAME ..." command.
2108 push_target: Make this target the top of the stack of currently used
2109 targets, within its particular stratum of the stack. Result
2110 is 0 if now atop the stack, nonzero if not on top (maybe
2113 unpush_target: Remove this from the stack of currently used targets,
2114 no matter where it is on the list. Returns 0 if no
2115 change, 1 if removed from stack. */
2117 extern void add_target (struct target_ops *);
2119 extern void add_target_with_completer (struct target_ops *t,
2120 completer_ftype *completer);
2122 extern void complete_target_initialization (struct target_ops *t);
2124 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
2125 for maintaining backwards compatibility when renaming targets. */
2127 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
2129 extern void push_target (struct target_ops *);
2131 extern int unpush_target (struct target_ops *);
2133 extern void target_pre_inferior (int);
2135 extern void target_preopen (int);
2137 /* Does whatever cleanup is required to get rid of all pushed targets. */
2138 extern void pop_all_targets (void);
2140 /* Like pop_all_targets, but pops only targets whose stratum is
2141 strictly above ABOVE_STRATUM. */
2142 extern void pop_all_targets_above (enum strata above_stratum);
2144 extern int target_is_pushed (struct target_ops *t);
2146 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2149 /* Struct target_section maps address ranges to file sections. It is
2150 mostly used with BFD files, but can be used without (e.g. for handling
2151 raw disks, or files not in formats handled by BFD). */
2153 struct target_section
2155 CORE_ADDR addr; /* Lowest address in section */
2156 CORE_ADDR endaddr; /* 1+highest address in section */
2158 struct bfd_section *the_bfd_section;
2160 /* The "owner" of the section.
2161 It can be any unique value. It is set by add_target_sections
2162 and used by remove_target_sections.
2163 For example, for executables it is a pointer to exec_bfd and
2164 for shlibs it is the so_list pointer. */
2168 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2170 struct target_section_table
2172 struct target_section *sections;
2173 struct target_section *sections_end;
2176 /* Return the "section" containing the specified address. */
2177 struct target_section *target_section_by_addr (struct target_ops *target,
2180 /* Return the target section table this target (or the targets
2181 beneath) currently manipulate. */
2183 extern struct target_section_table *target_get_section_table
2184 (struct target_ops *target);
2186 /* From mem-break.c */
2188 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
2189 struct bp_target_info *);
2191 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
2192 struct bp_target_info *);
2194 /* Check whether the memory at the breakpoint's placed address still
2195 contains the expected breakpoint instruction. */
2197 extern int memory_validate_breakpoint (struct gdbarch *gdbarch,
2198 struct bp_target_info *bp_tgt);
2200 extern int default_memory_remove_breakpoint (struct gdbarch *,
2201 struct bp_target_info *);
2203 extern int default_memory_insert_breakpoint (struct gdbarch *,
2204 struct bp_target_info *);
2209 extern void initialize_targets (void);
2211 extern void noprocess (void) ATTRIBUTE_NORETURN;
2213 extern void target_require_runnable (void);
2215 extern struct target_ops *find_target_beneath (struct target_ops *);
2217 /* Find the target at STRATUM. If no target is at that stratum,
2220 struct target_ops *find_target_at (enum strata stratum);
2222 /* Read OS data object of type TYPE from the target, and return it in
2223 XML format. The result is NUL-terminated and returned as a string,
2224 allocated using xmalloc. If an error occurs or the transfer is
2225 unsupported, NULL is returned. Empty objects are returned as
2226 allocated but empty strings. */
2228 extern char *target_get_osdata (const char *type);
2231 /* Stuff that should be shared among the various remote targets. */
2233 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2234 information (higher values, more information). */
2235 extern int remote_debug;
2237 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2238 extern int baud_rate;
2240 /* Parity for serial port */
2241 extern int serial_parity;
2243 /* Timeout limit for response from target. */
2244 extern int remote_timeout;
2248 /* Set the show memory breakpoints mode to show, and installs a cleanup
2249 to restore it back to the current value. */
2250 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2252 extern int may_write_registers;
2253 extern int may_write_memory;
2254 extern int may_insert_breakpoints;
2255 extern int may_insert_tracepoints;
2256 extern int may_insert_fast_tracepoints;
2257 extern int may_stop;
2259 extern void update_target_permissions (void);
2262 /* Imported from machine dependent code. */
2264 /* See to_supports_btrace in struct target_ops. */
2265 extern int target_supports_btrace (enum btrace_format);
2267 /* See to_enable_btrace in struct target_ops. */
2268 extern struct btrace_target_info *
2269 target_enable_btrace (ptid_t ptid, const struct btrace_config *);
2271 /* See to_disable_btrace in struct target_ops. */
2272 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2274 /* See to_teardown_btrace in struct target_ops. */
2275 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2277 /* See to_read_btrace in struct target_ops. */
2278 extern enum btrace_error target_read_btrace (struct btrace_data *,
2279 struct btrace_target_info *,
2280 enum btrace_read_type);
2282 /* See to_btrace_conf in struct target_ops. */
2283 extern const struct btrace_config *
2284 target_btrace_conf (const struct btrace_target_info *);
2286 /* See to_stop_recording in struct target_ops. */
2287 extern void target_stop_recording (void);
2289 /* See to_save_record in struct target_ops. */
2290 extern void target_save_record (const char *filename);
2292 /* Query if the target supports deleting the execution log. */
2293 extern int target_supports_delete_record (void);
2295 /* See to_delete_record in struct target_ops. */
2296 extern void target_delete_record (void);
2298 /* See to_record_is_replaying in struct target_ops. */
2299 extern int target_record_is_replaying (void);
2301 /* See to_goto_record_begin in struct target_ops. */
2302 extern void target_goto_record_begin (void);
2304 /* See to_goto_record_end in struct target_ops. */
2305 extern void target_goto_record_end (void);
2307 /* See to_goto_record in struct target_ops. */
2308 extern void target_goto_record (ULONGEST insn);
2310 /* See to_insn_history. */
2311 extern void target_insn_history (int size, int flags);
2313 /* See to_insn_history_from. */
2314 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2316 /* See to_insn_history_range. */
2317 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2319 /* See to_call_history. */
2320 extern void target_call_history (int size, int flags);
2322 /* See to_call_history_from. */
2323 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2325 /* See to_call_history_range. */
2326 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2328 /* See to_prepare_to_generate_core. */
2329 extern void target_prepare_to_generate_core (void);
2331 /* See to_done_generating_core. */
2332 extern void target_done_generating_core (void);
2334 #endif /* !defined (TARGET_H) */