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) (const 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_info) (struct target_ops *, const char *, int)
510 TARGET_DEFAULT_FUNC (default_terminal_info);
511 void (*to_kill) (struct target_ops *)
512 TARGET_DEFAULT_NORETURN (noprocess ());
513 void (*to_load) (struct target_ops *, const char *, int)
514 TARGET_DEFAULT_NORETURN (tcomplain ());
515 /* Start an inferior process and set inferior_ptid to its pid.
516 EXEC_FILE is the file to run.
517 ALLARGS is a string containing the arguments to the program.
518 ENV is the environment vector to pass. Errors reported with error().
519 On VxWorks and various standalone systems, we ignore exec_file. */
520 void (*to_create_inferior) (struct target_ops *,
521 char *, char *, char **, int);
522 void (*to_post_startup_inferior) (struct target_ops *, ptid_t)
523 TARGET_DEFAULT_IGNORE ();
524 int (*to_insert_fork_catchpoint) (struct target_ops *, int)
525 TARGET_DEFAULT_RETURN (1);
526 int (*to_remove_fork_catchpoint) (struct target_ops *, int)
527 TARGET_DEFAULT_RETURN (1);
528 int (*to_insert_vfork_catchpoint) (struct target_ops *, int)
529 TARGET_DEFAULT_RETURN (1);
530 int (*to_remove_vfork_catchpoint) (struct target_ops *, int)
531 TARGET_DEFAULT_RETURN (1);
532 int (*to_follow_fork) (struct target_ops *, int, int)
533 TARGET_DEFAULT_FUNC (default_follow_fork);
534 int (*to_insert_exec_catchpoint) (struct target_ops *, int)
535 TARGET_DEFAULT_RETURN (1);
536 int (*to_remove_exec_catchpoint) (struct target_ops *, int)
537 TARGET_DEFAULT_RETURN (1);
538 int (*to_set_syscall_catchpoint) (struct target_ops *,
539 int, int, int, int, int *)
540 TARGET_DEFAULT_RETURN (1);
541 int (*to_has_exited) (struct target_ops *, int, int, int *)
542 TARGET_DEFAULT_RETURN (0);
543 void (*to_mourn_inferior) (struct target_ops *)
544 TARGET_DEFAULT_FUNC (default_mourn_inferior);
545 /* Note that to_can_run is special and can be invoked on an
546 unpushed target. Targets defining this method must also define
547 to_can_async_p and to_supports_non_stop. */
548 int (*to_can_run) (struct target_ops *)
549 TARGET_DEFAULT_RETURN (0);
551 /* Documentation of this routine is provided with the corresponding
553 void (*to_pass_signals) (struct target_ops *, int,
554 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals))
555 TARGET_DEFAULT_IGNORE ();
557 /* Documentation of this routine is provided with the
558 corresponding target_* function. */
559 void (*to_program_signals) (struct target_ops *, int,
560 unsigned char * TARGET_DEBUG_PRINTER (target_debug_print_signals))
561 TARGET_DEFAULT_IGNORE ();
563 int (*to_thread_alive) (struct target_ops *, ptid_t ptid)
564 TARGET_DEFAULT_RETURN (0);
565 void (*to_find_new_threads) (struct target_ops *)
566 TARGET_DEFAULT_IGNORE ();
567 char *(*to_pid_to_str) (struct target_ops *, ptid_t)
568 TARGET_DEFAULT_FUNC (default_pid_to_str);
569 char *(*to_extra_thread_info) (struct target_ops *, struct thread_info *)
570 TARGET_DEFAULT_RETURN (NULL);
571 char *(*to_thread_name) (struct target_ops *, struct thread_info *)
572 TARGET_DEFAULT_RETURN (NULL);
573 void (*to_stop) (struct target_ops *, ptid_t)
574 TARGET_DEFAULT_IGNORE ();
575 void (*to_rcmd) (struct target_ops *,
576 const char *command, struct ui_file *output)
577 TARGET_DEFAULT_FUNC (default_rcmd);
578 char *(*to_pid_to_exec_file) (struct target_ops *, int pid)
579 TARGET_DEFAULT_RETURN (NULL);
580 void (*to_log_command) (struct target_ops *, const char *)
581 TARGET_DEFAULT_IGNORE ();
582 struct target_section_table *(*to_get_section_table) (struct target_ops *)
583 TARGET_DEFAULT_RETURN (NULL);
584 enum strata to_stratum;
585 int (*to_has_all_memory) (struct target_ops *);
586 int (*to_has_memory) (struct target_ops *);
587 int (*to_has_stack) (struct target_ops *);
588 int (*to_has_registers) (struct target_ops *);
589 int (*to_has_execution) (struct target_ops *, ptid_t);
590 int to_has_thread_control; /* control thread execution */
591 int to_attach_no_wait;
592 /* This method must be implemented in some situations. See the
593 comment on 'to_can_run'. */
594 int (*to_can_async_p) (struct target_ops *)
595 TARGET_DEFAULT_RETURN (0);
596 int (*to_is_async_p) (struct target_ops *)
597 TARGET_DEFAULT_RETURN (0);
598 void (*to_async) (struct target_ops *, async_callback_ftype *, void *)
599 TARGET_DEFAULT_NORETURN (tcomplain ());
600 /* This method must be implemented in some situations. See the
601 comment on 'to_can_run'. */
602 int (*to_supports_non_stop) (struct target_ops *)
603 TARGET_DEFAULT_RETURN (0);
604 /* find_memory_regions support method for gcore */
605 int (*to_find_memory_regions) (struct target_ops *,
606 find_memory_region_ftype func, void *data)
607 TARGET_DEFAULT_FUNC (dummy_find_memory_regions);
608 /* make_corefile_notes support method for gcore */
609 char * (*to_make_corefile_notes) (struct target_ops *, bfd *, int *)
610 TARGET_DEFAULT_FUNC (dummy_make_corefile_notes);
611 /* get_bookmark support method for bookmarks */
612 gdb_byte * (*to_get_bookmark) (struct target_ops *, const char *, int)
613 TARGET_DEFAULT_NORETURN (tcomplain ());
614 /* goto_bookmark support method for bookmarks */
615 void (*to_goto_bookmark) (struct target_ops *, const gdb_byte *, int)
616 TARGET_DEFAULT_NORETURN (tcomplain ());
617 /* Return the thread-local address at OFFSET in the
618 thread-local storage for the thread PTID and the shared library
619 or executable file given by OBJFILE. If that block of
620 thread-local storage hasn't been allocated yet, this function
621 may return an error. LOAD_MODULE_ADDR may be zero for statically
622 linked multithreaded inferiors. */
623 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
625 CORE_ADDR load_module_addr,
627 TARGET_DEFAULT_NORETURN (generic_tls_error ());
629 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
630 OBJECT. The OFFSET, for a seekable object, specifies the
631 starting point. The ANNEX can be used to provide additional
632 data-specific information to the target.
634 Return the transferred status, error or OK (an
635 'enum target_xfer_status' value). Save the number of bytes
636 actually transferred in *XFERED_LEN if transfer is successful
637 (TARGET_XFER_OK) or the number unavailable bytes if the requested
638 data is unavailable (TARGET_XFER_UNAVAILABLE). *XFERED_LEN
639 smaller than LEN does not indicate the end of the object, only
640 the end of the transfer; higher level code should continue
641 transferring if desired. This is handled in target.c.
643 The interface does not support a "retry" mechanism. Instead it
644 assumes that at least one byte will be transfered on each
647 NOTE: cagney/2003-10-17: The current interface can lead to
648 fragmented transfers. Lower target levels should not implement
649 hacks, such as enlarging the transfer, in an attempt to
650 compensate for this. Instead, the target stack should be
651 extended so that it implements supply/collect methods and a
652 look-aside object cache. With that available, the lowest
653 target can safely and freely "push" data up the stack.
655 See target_read and target_write for more information. One,
656 and only one, of readbuf or writebuf must be non-NULL. */
658 enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
659 enum target_object object,
662 const gdb_byte *writebuf,
663 ULONGEST offset, ULONGEST len,
664 ULONGEST *xfered_len)
665 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
667 /* Returns the memory map for the target. A return value of NULL
668 means that no memory map is available. If a memory address
669 does not fall within any returned regions, it's assumed to be
670 RAM. The returned memory regions should not overlap.
672 The order of regions does not matter; target_memory_map will
673 sort regions by starting address. For that reason, this
674 function should not be called directly except via
677 This method should not cache data; if the memory map could
678 change unexpectedly, it should be invalidated, and higher
679 layers will re-fetch it. */
680 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *)
681 TARGET_DEFAULT_RETURN (NULL);
683 /* Erases the region of flash memory starting at ADDRESS, of
686 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
687 on flash block boundaries, as reported by 'to_memory_map'. */
688 void (*to_flash_erase) (struct target_ops *,
689 ULONGEST address, LONGEST length)
690 TARGET_DEFAULT_NORETURN (tcomplain ());
692 /* Finishes a flash memory write sequence. After this operation
693 all flash memory should be available for writing and the result
694 of reading from areas written by 'to_flash_write' should be
695 equal to what was written. */
696 void (*to_flash_done) (struct target_ops *)
697 TARGET_DEFAULT_NORETURN (tcomplain ());
699 /* Describe the architecture-specific features of this target. If
700 OPS doesn't have a description, this should delegate to the
701 "beneath" target. Returns the description found, or NULL if no
702 description was available. */
703 const struct target_desc *(*to_read_description) (struct target_ops *ops)
704 TARGET_DEFAULT_RETURN (NULL);
706 /* Build the PTID of the thread on which a given task is running,
707 based on LWP and THREAD. These values are extracted from the
708 task Private_Data section of the Ada Task Control Block, and
709 their interpretation depends on the target. */
710 ptid_t (*to_get_ada_task_ptid) (struct target_ops *,
711 long lwp, long thread)
712 TARGET_DEFAULT_FUNC (default_get_ada_task_ptid);
714 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
715 Return 0 if *READPTR is already at the end of the buffer.
716 Return -1 if there is insufficient buffer for a whole entry.
717 Return 1 if an entry was read into *TYPEP and *VALP. */
718 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
719 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
720 TARGET_DEFAULT_FUNC (default_auxv_parse);
722 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
723 sequence of bytes in PATTERN with length PATTERN_LEN.
725 The result is 1 if found, 0 if not found, and -1 if there was an error
726 requiring halting of the search (e.g. memory read error).
727 If the pattern is found the address is recorded in FOUND_ADDRP. */
728 int (*to_search_memory) (struct target_ops *ops,
729 CORE_ADDR start_addr, ULONGEST search_space_len,
730 const gdb_byte *pattern, ULONGEST pattern_len,
731 CORE_ADDR *found_addrp)
732 TARGET_DEFAULT_FUNC (default_search_memory);
734 /* Can target execute in reverse? */
735 int (*to_can_execute_reverse) (struct target_ops *)
736 TARGET_DEFAULT_RETURN (0);
738 /* The direction the target is currently executing. Must be
739 implemented on targets that support reverse execution and async
740 mode. The default simply returns forward execution. */
741 enum exec_direction_kind (*to_execution_direction) (struct target_ops *)
742 TARGET_DEFAULT_FUNC (default_execution_direction);
744 /* Does this target support debugging multiple processes
746 int (*to_supports_multi_process) (struct target_ops *)
747 TARGET_DEFAULT_RETURN (0);
749 /* Does this target support enabling and disabling tracepoints while a trace
750 experiment is running? */
751 int (*to_supports_enable_disable_tracepoint) (struct target_ops *)
752 TARGET_DEFAULT_RETURN (0);
754 /* Does this target support disabling address space randomization? */
755 int (*to_supports_disable_randomization) (struct target_ops *);
757 /* Does this target support the tracenz bytecode for string collection? */
758 int (*to_supports_string_tracing) (struct target_ops *)
759 TARGET_DEFAULT_RETURN (0);
761 /* Does this target support evaluation of breakpoint conditions on its
763 int (*to_supports_evaluation_of_breakpoint_conditions) (struct target_ops *)
764 TARGET_DEFAULT_RETURN (0);
766 /* Does this target support evaluation of breakpoint commands on its
768 int (*to_can_run_breakpoint_commands) (struct target_ops *)
769 TARGET_DEFAULT_RETURN (0);
771 /* Determine current architecture of thread PTID.
773 The target is supposed to determine the architecture of the code where
774 the target is currently stopped at (on Cell, if a target is in spu_run,
775 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
776 This is architecture used to perform decr_pc_after_break adjustment,
777 and also determines the frame architecture of the innermost frame.
778 ptrace operations need to operate according to target_gdbarch ().
780 The default implementation always returns target_gdbarch (). */
781 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t)
782 TARGET_DEFAULT_FUNC (default_thread_architecture);
784 /* Determine current address space of thread PTID.
786 The default implementation always returns the inferior's
788 struct address_space *(*to_thread_address_space) (struct target_ops *,
790 TARGET_DEFAULT_FUNC (default_thread_address_space);
792 /* Target file operations. */
794 /* Open FILENAME on the target, using FLAGS and MODE. Return a
795 target file descriptor, or -1 if an error occurs (and set
797 int (*to_fileio_open) (struct target_ops *,
798 const char *filename, int flags, int mode,
801 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
802 Return the number of bytes written, or -1 if an error occurs
803 (and set *TARGET_ERRNO). */
804 int (*to_fileio_pwrite) (struct target_ops *,
805 int fd, const gdb_byte *write_buf, int len,
806 ULONGEST offset, int *target_errno);
808 /* Read up to LEN bytes FD on the target into READ_BUF.
809 Return the number of bytes read, or -1 if an error occurs
810 (and set *TARGET_ERRNO). */
811 int (*to_fileio_pread) (struct target_ops *,
812 int fd, gdb_byte *read_buf, int len,
813 ULONGEST offset, int *target_errno);
815 /* Close FD on the target. Return 0, or -1 if an error occurs
816 (and set *TARGET_ERRNO). */
817 int (*to_fileio_close) (struct target_ops *, int fd, int *target_errno);
819 /* Unlink FILENAME on the target. Return 0, or -1 if an error
820 occurs (and set *TARGET_ERRNO). */
821 int (*to_fileio_unlink) (struct target_ops *,
822 const char *filename, int *target_errno);
824 /* Read value of symbolic link FILENAME on the target. Return a
825 null-terminated string allocated via xmalloc, or NULL if an error
826 occurs (and set *TARGET_ERRNO). */
827 char *(*to_fileio_readlink) (struct target_ops *,
828 const char *filename, int *target_errno);
831 /* Implement the "info proc" command. */
832 void (*to_info_proc) (struct target_ops *, const char *,
833 enum info_proc_what);
835 /* Tracepoint-related operations. */
837 /* Prepare the target for a tracing run. */
838 void (*to_trace_init) (struct target_ops *)
839 TARGET_DEFAULT_NORETURN (tcomplain ());
841 /* Send full details of a tracepoint location to the target. */
842 void (*to_download_tracepoint) (struct target_ops *,
843 struct bp_location *location)
844 TARGET_DEFAULT_NORETURN (tcomplain ());
846 /* Is the target able to download tracepoint locations in current
848 int (*to_can_download_tracepoint) (struct target_ops *)
849 TARGET_DEFAULT_RETURN (0);
851 /* Send full details of a trace state variable to the target. */
852 void (*to_download_trace_state_variable) (struct target_ops *,
853 struct trace_state_variable *tsv)
854 TARGET_DEFAULT_NORETURN (tcomplain ());
856 /* Enable a tracepoint on the target. */
857 void (*to_enable_tracepoint) (struct target_ops *,
858 struct bp_location *location)
859 TARGET_DEFAULT_NORETURN (tcomplain ());
861 /* Disable a tracepoint on the target. */
862 void (*to_disable_tracepoint) (struct target_ops *,
863 struct bp_location *location)
864 TARGET_DEFAULT_NORETURN (tcomplain ());
866 /* Inform the target info of memory regions that are readonly
867 (such as text sections), and so it should return data from
868 those rather than look in the trace buffer. */
869 void (*to_trace_set_readonly_regions) (struct target_ops *)
870 TARGET_DEFAULT_NORETURN (tcomplain ());
872 /* Start a trace run. */
873 void (*to_trace_start) (struct target_ops *)
874 TARGET_DEFAULT_NORETURN (tcomplain ());
876 /* Get the current status of a tracing run. */
877 int (*to_get_trace_status) (struct target_ops *, struct trace_status *ts)
878 TARGET_DEFAULT_RETURN (-1);
880 void (*to_get_tracepoint_status) (struct target_ops *,
881 struct breakpoint *tp,
882 struct uploaded_tp *utp)
883 TARGET_DEFAULT_NORETURN (tcomplain ());
885 /* Stop a trace run. */
886 void (*to_trace_stop) (struct target_ops *)
887 TARGET_DEFAULT_NORETURN (tcomplain ());
889 /* Ask the target to find a trace frame of the given type TYPE,
890 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
891 number of the trace frame, and also the tracepoint number at
892 TPP. If no trace frame matches, return -1. May throw if the
894 int (*to_trace_find) (struct target_ops *,
895 enum trace_find_type type, int num,
896 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
897 TARGET_DEFAULT_RETURN (-1);
899 /* Get the value of the trace state variable number TSV, returning
900 1 if the value is known and writing the value itself into the
901 location pointed to by VAL, else returning 0. */
902 int (*to_get_trace_state_variable_value) (struct target_ops *,
903 int tsv, LONGEST *val)
904 TARGET_DEFAULT_RETURN (0);
906 int (*to_save_trace_data) (struct target_ops *, const char *filename)
907 TARGET_DEFAULT_NORETURN (tcomplain ());
909 int (*to_upload_tracepoints) (struct target_ops *,
910 struct uploaded_tp **utpp)
911 TARGET_DEFAULT_RETURN (0);
913 int (*to_upload_trace_state_variables) (struct target_ops *,
914 struct uploaded_tsv **utsvp)
915 TARGET_DEFAULT_RETURN (0);
917 LONGEST (*to_get_raw_trace_data) (struct target_ops *, gdb_byte *buf,
918 ULONGEST offset, LONGEST len)
919 TARGET_DEFAULT_NORETURN (tcomplain ());
921 /* Get the minimum length of instruction on which a fast tracepoint
922 may be set on the target. If this operation is unsupported,
923 return -1. If for some reason the minimum length cannot be
924 determined, return 0. */
925 int (*to_get_min_fast_tracepoint_insn_len) (struct target_ops *)
926 TARGET_DEFAULT_RETURN (-1);
928 /* Set the target's tracing behavior in response to unexpected
929 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
930 void (*to_set_disconnected_tracing) (struct target_ops *, int val)
931 TARGET_DEFAULT_IGNORE ();
932 void (*to_set_circular_trace_buffer) (struct target_ops *, int val)
933 TARGET_DEFAULT_IGNORE ();
934 /* Set the size of trace buffer in the target. */
935 void (*to_set_trace_buffer_size) (struct target_ops *, LONGEST val)
936 TARGET_DEFAULT_IGNORE ();
938 /* Add/change textual notes about the trace run, returning 1 if
939 successful, 0 otherwise. */
940 int (*to_set_trace_notes) (struct target_ops *,
941 const char *user, const char *notes,
942 const char *stopnotes)
943 TARGET_DEFAULT_RETURN (0);
945 /* Return the processor core that thread PTID was last seen on.
946 This information is updated only when:
947 - update_thread_list is called
949 If the core cannot be determined -- either for the specified
950 thread, or right now, or in this debug session, or for this
951 target -- return -1. */
952 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid)
953 TARGET_DEFAULT_RETURN (-1);
955 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
956 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
957 a match, 0 if there's a mismatch, and -1 if an error is
958 encountered while reading memory. */
959 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
960 CORE_ADDR memaddr, ULONGEST size)
961 TARGET_DEFAULT_FUNC (default_verify_memory);
963 /* Return the address of the start of the Thread Information Block
964 a Windows OS specific feature. */
965 int (*to_get_tib_address) (struct target_ops *,
966 ptid_t ptid, CORE_ADDR *addr)
967 TARGET_DEFAULT_NORETURN (tcomplain ());
969 /* Send the new settings of write permission variables. */
970 void (*to_set_permissions) (struct target_ops *)
971 TARGET_DEFAULT_IGNORE ();
973 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
974 with its details. Return 1 on success, 0 on failure. */
975 int (*to_static_tracepoint_marker_at) (struct target_ops *, CORE_ADDR,
976 struct static_tracepoint_marker *marker)
977 TARGET_DEFAULT_RETURN (0);
979 /* Return a vector of all tracepoints markers string id ID, or all
980 markers if ID is NULL. */
981 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid) (struct target_ops *, const char *id)
982 TARGET_DEFAULT_NORETURN (tcomplain ());
984 /* Return a traceframe info object describing the current
985 traceframe's contents. This method should not cache data;
986 higher layers take care of caching, invalidating, and
987 re-fetching when necessary. */
988 struct traceframe_info *(*to_traceframe_info) (struct target_ops *)
989 TARGET_DEFAULT_NORETURN (tcomplain ());
991 /* Ask the target to use or not to use agent according to USE. Return 1
992 successful, 0 otherwise. */
993 int (*to_use_agent) (struct target_ops *, int use)
994 TARGET_DEFAULT_NORETURN (tcomplain ());
996 /* Is the target able to use agent in current state? */
997 int (*to_can_use_agent) (struct target_ops *)
998 TARGET_DEFAULT_RETURN (0);
1000 /* Check whether the target supports branch tracing. */
1001 int (*to_supports_btrace) (struct target_ops *)
1002 TARGET_DEFAULT_RETURN (0);
1004 /* Enable branch tracing for PTID and allocate a branch trace target
1005 information struct for reading and for disabling branch trace. */
1006 struct btrace_target_info *(*to_enable_btrace) (struct target_ops *,
1008 TARGET_DEFAULT_NORETURN (tcomplain ());
1010 /* Disable branch tracing and deallocate TINFO. */
1011 void (*to_disable_btrace) (struct target_ops *,
1012 struct btrace_target_info *tinfo)
1013 TARGET_DEFAULT_NORETURN (tcomplain ());
1015 /* Disable branch tracing and deallocate TINFO. This function is similar
1016 to to_disable_btrace, except that it is called during teardown and is
1017 only allowed to perform actions that are safe. A counter-example would
1018 be attempting to talk to a remote target. */
1019 void (*to_teardown_btrace) (struct target_ops *,
1020 struct btrace_target_info *tinfo)
1021 TARGET_DEFAULT_NORETURN (tcomplain ());
1023 /* Read branch trace data for the thread indicated by BTINFO into DATA.
1024 DATA is cleared before new trace is added.
1025 The branch trace will start with the most recent block and continue
1026 towards older blocks. */
1027 enum btrace_error (*to_read_btrace) (struct target_ops *self,
1028 VEC (btrace_block_s) **data,
1029 struct btrace_target_info *btinfo,
1030 enum btrace_read_type type)
1031 TARGET_DEFAULT_NORETURN (tcomplain ());
1033 /* Stop trace recording. */
1034 void (*to_stop_recording) (struct target_ops *)
1035 TARGET_DEFAULT_IGNORE ();
1037 /* Print information about the recording. */
1038 void (*to_info_record) (struct target_ops *)
1039 TARGET_DEFAULT_IGNORE ();
1041 /* Save the recorded execution trace into a file. */
1042 void (*to_save_record) (struct target_ops *, const char *filename)
1043 TARGET_DEFAULT_NORETURN (tcomplain ());
1045 /* Delete the recorded execution trace from the current position
1047 void (*to_delete_record) (struct target_ops *)
1048 TARGET_DEFAULT_NORETURN (tcomplain ());
1050 /* Query if the record target is currently replaying. */
1051 int (*to_record_is_replaying) (struct target_ops *)
1052 TARGET_DEFAULT_RETURN (0);
1054 /* Go to the begin of the execution trace. */
1055 void (*to_goto_record_begin) (struct target_ops *)
1056 TARGET_DEFAULT_NORETURN (tcomplain ());
1058 /* Go to the end of the execution trace. */
1059 void (*to_goto_record_end) (struct target_ops *)
1060 TARGET_DEFAULT_NORETURN (tcomplain ());
1062 /* Go to a specific location in the recorded execution trace. */
1063 void (*to_goto_record) (struct target_ops *, ULONGEST insn)
1064 TARGET_DEFAULT_NORETURN (tcomplain ());
1066 /* Disassemble SIZE instructions in the recorded execution trace from
1067 the current position.
1068 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1069 disassemble SIZE succeeding instructions. */
1070 void (*to_insn_history) (struct target_ops *, int size, int flags)
1071 TARGET_DEFAULT_NORETURN (tcomplain ());
1073 /* Disassemble SIZE instructions in the recorded execution trace around
1075 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1076 disassemble SIZE instructions after FROM. */
1077 void (*to_insn_history_from) (struct target_ops *,
1078 ULONGEST from, int size, int flags)
1079 TARGET_DEFAULT_NORETURN (tcomplain ());
1081 /* Disassemble a section of the recorded execution trace from instruction
1082 BEGIN (inclusive) to instruction END (inclusive). */
1083 void (*to_insn_history_range) (struct target_ops *,
1084 ULONGEST begin, ULONGEST end, int flags)
1085 TARGET_DEFAULT_NORETURN (tcomplain ());
1087 /* Print a function trace of the recorded execution trace.
1088 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1089 succeeding functions. */
1090 void (*to_call_history) (struct target_ops *, int size, int flags)
1091 TARGET_DEFAULT_NORETURN (tcomplain ());
1093 /* Print a function trace of the recorded execution trace starting
1095 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1096 SIZE functions after FROM. */
1097 void (*to_call_history_from) (struct target_ops *,
1098 ULONGEST begin, int size, int flags)
1099 TARGET_DEFAULT_NORETURN (tcomplain ());
1101 /* Print a function trace of an execution trace section from function BEGIN
1102 (inclusive) to function END (inclusive). */
1103 void (*to_call_history_range) (struct target_ops *,
1104 ULONGEST begin, ULONGEST end, int flags)
1105 TARGET_DEFAULT_NORETURN (tcomplain ());
1107 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1109 int (*to_augmented_libraries_svr4_read) (struct target_ops *)
1110 TARGET_DEFAULT_RETURN (0);
1112 /* Those unwinders are tried before any other arch unwinders. If
1113 SELF doesn't have unwinders, it should delegate to the
1114 "beneath" target. */
1115 const struct frame_unwind *(*to_get_unwinder) (struct target_ops *self)
1116 TARGET_DEFAULT_RETURN (NULL);
1118 const struct frame_unwind *(*to_get_tailcall_unwinder) (struct target_ops *self)
1119 TARGET_DEFAULT_RETURN (NULL);
1121 /* Return the number of bytes by which the PC needs to be decremented
1122 after executing a breakpoint instruction.
1123 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
1124 CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
1125 struct gdbarch *gdbarch)
1126 TARGET_DEFAULT_FUNC (default_target_decr_pc_after_break);
1128 /* Prepare to generate a core file. */
1129 void (*to_prepare_to_generate_core) (struct target_ops *)
1130 TARGET_DEFAULT_IGNORE ();
1132 /* Cleanup after generating a core file. */
1133 void (*to_done_generating_core) (struct target_ops *)
1134 TARGET_DEFAULT_IGNORE ();
1137 /* Need sub-structure for target machine related rather than comm related?
1141 /* Magic number for checking ops size. If a struct doesn't end with this
1142 number, somebody changed the declaration but didn't change all the
1143 places that initialize one. */
1145 #define OPS_MAGIC 3840
1147 /* The ops structure for our "current" target process. This should
1148 never be NULL. If there is no target, it points to the dummy_target. */
1150 extern struct target_ops current_target;
1152 /* Define easy words for doing these operations on our current target. */
1154 #define target_shortname (current_target.to_shortname)
1155 #define target_longname (current_target.to_longname)
1157 /* Does whatever cleanup is required for a target that we are no
1158 longer going to be calling. This routine is automatically always
1159 called after popping the target off the target stack - the target's
1160 own methods are no longer available through the target vector.
1161 Closing file descriptors and freeing all memory allocated memory are
1162 typical things it should do. */
1164 void target_close (struct target_ops *targ);
1166 /* Find the correct target to use for "attach". If a target on the
1167 current stack supports attaching, then it is returned. Otherwise,
1168 the default run target is returned. */
1170 extern struct target_ops *find_attach_target (void);
1172 /* Find the correct target to use for "run". If a target on the
1173 current stack supports creating a new inferior, then it is
1174 returned. Otherwise, the default run target is returned. */
1176 extern struct target_ops *find_run_target (void);
1178 /* Some targets don't generate traps when attaching to the inferior,
1179 or their target_attach implementation takes care of the waiting.
1180 These targets must set to_attach_no_wait. */
1182 #define target_attach_no_wait \
1183 (current_target.to_attach_no_wait)
1185 /* The target_attach operation places a process under debugger control,
1186 and stops the process.
1188 This operation provides a target-specific hook that allows the
1189 necessary bookkeeping to be performed after an attach completes. */
1190 #define target_post_attach(pid) \
1191 (*current_target.to_post_attach) (¤t_target, pid)
1193 /* Takes a program previously attached to and detaches it.
1194 The program may resume execution (some targets do, some don't) and will
1195 no longer stop on signals, etc. We better not have left any breakpoints
1196 in the program or it'll die when it hits one. ARGS is arguments
1197 typed by the user (e.g. a signal to send the process). FROM_TTY
1198 says whether to be verbose or not. */
1200 extern void target_detach (const char *, int);
1202 /* Disconnect from the current target without resuming it (leaving it
1203 waiting for a debugger). */
1205 extern void target_disconnect (const char *, int);
1207 /* Resume execution of the target process PTID (or a group of
1208 threads). STEP says whether to single-step or to run free; SIGGNAL
1209 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1210 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1211 PTID means `step/resume only this process id'. A wildcard PTID
1212 (all threads, or all threads of process) means `step/resume
1213 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1214 matches) resume with their 'thread->suspend.stop_signal' signal
1215 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1216 if in "no pass" state. */
1218 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1220 /* Wait for process pid to do something. PTID = -1 to wait for any
1221 pid to do something. Return pid of child, or -1 in case of error;
1222 store status through argument pointer STATUS. Note that it is
1223 _NOT_ OK to throw_exception() out of target_wait() without popping
1224 the debugging target from the stack; GDB isn't prepared to get back
1225 to the prompt with a debugging target but without the frame cache,
1226 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1229 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1232 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1234 extern void target_fetch_registers (struct regcache *regcache, int regno);
1236 /* Store at least register REGNO, or all regs if REGNO == -1.
1237 It can store as many registers as it wants to, so target_prepare_to_store
1238 must have been previously called. Calls error() if there are problems. */
1240 extern void target_store_registers (struct regcache *regcache, int regs);
1242 /* Get ready to modify the registers array. On machines which store
1243 individual registers, this doesn't need to do anything. On machines
1244 which store all the registers in one fell swoop, this makes sure
1245 that REGISTERS contains all the registers from the program being
1248 #define target_prepare_to_store(regcache) \
1249 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1251 /* Determine current address space of thread PTID. */
1253 struct address_space *target_thread_address_space (ptid_t);
1255 /* Implement the "info proc" command. This returns one if the request
1256 was handled, and zero otherwise. It can also throw an exception if
1257 an error was encountered while attempting to handle the
1260 int target_info_proc (const char *, enum info_proc_what);
1262 /* Returns true if this target can debug multiple processes
1265 #define target_supports_multi_process() \
1266 (*current_target.to_supports_multi_process) (¤t_target)
1268 /* Returns true if this target can disable address space randomization. */
1270 int target_supports_disable_randomization (void);
1272 /* Returns true if this target can enable and disable tracepoints
1273 while a trace experiment is running. */
1275 #define target_supports_enable_disable_tracepoint() \
1276 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1278 #define target_supports_string_tracing() \
1279 (*current_target.to_supports_string_tracing) (¤t_target)
1281 /* Returns true if this target can handle breakpoint conditions
1284 #define target_supports_evaluation_of_breakpoint_conditions() \
1285 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1287 /* Returns true if this target can handle breakpoint commands
1290 #define target_can_run_breakpoint_commands() \
1291 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1293 extern int target_read_string (CORE_ADDR, char **, int, int *);
1295 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1298 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1301 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1303 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1305 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1308 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1311 /* Fetches the target's memory map. If one is found it is sorted
1312 and returned, after some consistency checking. Otherwise, NULL
1314 VEC(mem_region_s) *target_memory_map (void);
1316 /* Erase the specified flash region. */
1317 void target_flash_erase (ULONGEST address, LONGEST length);
1319 /* Finish a sequence of flash operations. */
1320 void target_flash_done (void);
1322 /* Describes a request for a memory write operation. */
1323 struct memory_write_request
1325 /* Begining address that must be written. */
1327 /* Past-the-end address. */
1329 /* The data to write. */
1331 /* A callback baton for progress reporting for this request. */
1334 typedef struct memory_write_request memory_write_request_s;
1335 DEF_VEC_O(memory_write_request_s);
1337 /* Enumeration specifying different flash preservation behaviour. */
1338 enum flash_preserve_mode
1344 /* Write several memory blocks at once. This version can be more
1345 efficient than making several calls to target_write_memory, in
1346 particular because it can optimize accesses to flash memory.
1348 Moreover, this is currently the only memory access function in gdb
1349 that supports writing to flash memory, and it should be used for
1350 all cases where access to flash memory is desirable.
1352 REQUESTS is the vector (see vec.h) of memory_write_request.
1353 PRESERVE_FLASH_P indicates what to do with blocks which must be
1354 erased, but not completely rewritten.
1355 PROGRESS_CB is a function that will be periodically called to provide
1356 feedback to user. It will be called with the baton corresponding
1357 to the request currently being written. It may also be called
1358 with a NULL baton, when preserved flash sectors are being rewritten.
1360 The function returns 0 on success, and error otherwise. */
1361 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1362 enum flash_preserve_mode preserve_flash_p,
1363 void (*progress_cb) (ULONGEST, void *));
1365 /* Print a line about the current target. */
1367 #define target_files_info() \
1368 (*current_target.to_files_info) (¤t_target)
1370 /* Insert a breakpoint at address BP_TGT->placed_address in
1371 the target machine. Returns 0 for success, and returns non-zero or
1372 throws an error (with a detailed failure reason error code and
1373 message) otherwise. */
1375 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1376 struct bp_target_info *bp_tgt);
1378 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1379 machine. Result is 0 for success, non-zero for error. */
1381 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1382 struct bp_target_info *bp_tgt);
1384 /* Initialize the terminal settings we record for the inferior,
1385 before we actually run the inferior. */
1387 #define target_terminal_init() \
1388 (*current_target.to_terminal_init) (¤t_target)
1390 /* Put the inferior's terminal settings into effect.
1391 This is preparation for starting or resuming the inferior. */
1393 extern void target_terminal_inferior (void);
1395 /* Put some of our terminal settings into effect,
1396 enough to get proper results from our output,
1397 but do not change into or out of RAW mode
1398 so that no input is discarded.
1400 After doing this, either terminal_ours or terminal_inferior
1401 should be called to get back to a normal state of affairs. */
1403 #define target_terminal_ours_for_output() \
1404 (*current_target.to_terminal_ours_for_output) (¤t_target)
1406 /* Put our terminal settings into effect.
1407 First record the inferior's terminal settings
1408 so they can be restored properly later. */
1410 #define target_terminal_ours() \
1411 (*current_target.to_terminal_ours) (¤t_target)
1413 /* Return true if the target stack has a non-default
1414 "to_terminal_ours" method. */
1416 extern int target_supports_terminal_ours (void);
1418 /* Print useful information about our terminal status, if such a thing
1421 #define target_terminal_info(arg, from_tty) \
1422 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1424 /* Kill the inferior process. Make it go away. */
1426 extern void target_kill (void);
1428 /* Load an executable file into the target process. This is expected
1429 to not only bring new code into the target process, but also to
1430 update GDB's symbol tables to match.
1432 ARG contains command-line arguments, to be broken down with
1433 buildargv (). The first non-switch argument is the filename to
1434 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1435 0)), which is an offset to apply to the load addresses of FILE's
1436 sections. The target may define switches, or other non-switch
1437 arguments, as it pleases. */
1439 extern void target_load (const char *arg, int from_tty);
1441 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1442 notification of inferior events such as fork and vork immediately
1443 after the inferior is created. (This because of how gdb gets an
1444 inferior created via invoking a shell to do it. In such a scenario,
1445 if the shell init file has commands in it, the shell will fork and
1446 exec for each of those commands, and we will see each such fork
1449 Such targets will supply an appropriate definition for this function. */
1451 #define target_post_startup_inferior(ptid) \
1452 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1454 /* On some targets, we can catch an inferior fork or vfork event when
1455 it occurs. These functions insert/remove an already-created
1456 catchpoint for such events. They return 0 for success, 1 if the
1457 catchpoint type is not supported and -1 for failure. */
1459 #define target_insert_fork_catchpoint(pid) \
1460 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1462 #define target_remove_fork_catchpoint(pid) \
1463 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1465 #define target_insert_vfork_catchpoint(pid) \
1466 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1468 #define target_remove_vfork_catchpoint(pid) \
1469 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1471 /* If the inferior forks or vforks, this function will be called at
1472 the next resume in order to perform any bookkeeping and fiddling
1473 necessary to continue debugging either the parent or child, as
1474 requested, and releasing the other. Information about the fork
1475 or vfork event is available via get_last_target_status ().
1476 This function returns 1 if the inferior should not be resumed
1477 (i.e. there is another event pending). */
1479 int target_follow_fork (int follow_child, int detach_fork);
1481 /* On some targets, we can catch an inferior exec event when it
1482 occurs. These functions insert/remove an already-created
1483 catchpoint for such events. They return 0 for success, 1 if the
1484 catchpoint type is not supported and -1 for failure. */
1486 #define target_insert_exec_catchpoint(pid) \
1487 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1489 #define target_remove_exec_catchpoint(pid) \
1490 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1494 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1495 If NEEDED is zero, it means the target can disable the mechanism to
1496 catch system calls because there are no more catchpoints of this type.
1498 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1499 being requested. In this case, both TABLE_SIZE and TABLE should
1502 TABLE_SIZE is the number of elements in TABLE. It only matters if
1505 TABLE is an array of ints, indexed by syscall number. An element in
1506 this array is nonzero if that syscall should be caught. This argument
1507 only matters if ANY_COUNT is zero.
1509 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1512 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1513 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1514 pid, needed, any_count, \
1517 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1518 exit code of PID, if any. */
1520 #define target_has_exited(pid,wait_status,exit_status) \
1521 (*current_target.to_has_exited) (¤t_target, \
1522 pid,wait_status,exit_status)
1524 /* The debugger has completed a blocking wait() call. There is now
1525 some process event that must be processed. This function should
1526 be defined by those targets that require the debugger to perform
1527 cleanup or internal state changes in response to the process event. */
1529 /* The inferior process has died. Do what is right. */
1531 void target_mourn_inferior (void);
1533 /* Does target have enough data to do a run or attach command? */
1535 #define target_can_run(t) \
1536 ((t)->to_can_run) (t)
1538 /* Set list of signals to be handled in the target.
1540 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1541 (enum gdb_signal). For every signal whose entry in this array is
1542 non-zero, the target is allowed -but not required- to skip reporting
1543 arrival of the signal to the GDB core by returning from target_wait,
1544 and to pass the signal directly to the inferior instead.
1546 However, if the target is hardware single-stepping a thread that is
1547 about to receive a signal, it needs to be reported in any case, even
1548 if mentioned in a previous target_pass_signals call. */
1550 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1552 /* Set list of signals the target may pass to the inferior. This
1553 directly maps to the "handle SIGNAL pass/nopass" setting.
1555 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1556 number (enum gdb_signal). For every signal whose entry in this
1557 array is non-zero, the target is allowed to pass the signal to the
1558 inferior. Signals not present in the array shall be silently
1559 discarded. This does not influence whether to pass signals to the
1560 inferior as a result of a target_resume call. This is useful in
1561 scenarios where the target needs to decide whether to pass or not a
1562 signal to the inferior without GDB core involvement, such as for
1563 example, when detaching (as threads may have been suspended with
1564 pending signals not reported to GDB). */
1566 extern void target_program_signals (int nsig, unsigned char *program_signals);
1568 /* Check to see if a thread is still alive. */
1570 extern int target_thread_alive (ptid_t ptid);
1572 /* Query for new threads and add them to the thread list. */
1574 extern void target_find_new_threads (void);
1576 /* Make target stop in a continuable fashion. (For instance, under
1577 Unix, this should act like SIGSTOP). This function is normally
1578 used by GUIs to implement a stop button. */
1580 extern void target_stop (ptid_t ptid);
1582 /* Send the specified COMMAND to the target's monitor
1583 (shell,interpreter) for execution. The result of the query is
1584 placed in OUTBUF. */
1586 #define target_rcmd(command, outbuf) \
1587 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1590 /* Does the target include all of memory, or only part of it? This
1591 determines whether we look up the target chain for other parts of
1592 memory if this target can't satisfy a request. */
1594 extern int target_has_all_memory_1 (void);
1595 #define target_has_all_memory target_has_all_memory_1 ()
1597 /* Does the target include memory? (Dummy targets don't.) */
1599 extern int target_has_memory_1 (void);
1600 #define target_has_memory target_has_memory_1 ()
1602 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1603 we start a process.) */
1605 extern int target_has_stack_1 (void);
1606 #define target_has_stack target_has_stack_1 ()
1608 /* Does the target have registers? (Exec files don't.) */
1610 extern int target_has_registers_1 (void);
1611 #define target_has_registers target_has_registers_1 ()
1613 /* Does the target have execution? Can we make it jump (through
1614 hoops), or pop its stack a few times? This means that the current
1615 target is currently executing; for some targets, that's the same as
1616 whether or not the target is capable of execution, but there are
1617 also targets which can be current while not executing. In that
1618 case this will become true after to_create_inferior or
1621 extern int target_has_execution_1 (ptid_t);
1623 /* Like target_has_execution_1, but always passes inferior_ptid. */
1625 extern int target_has_execution_current (void);
1627 #define target_has_execution target_has_execution_current ()
1629 /* Default implementations for process_stratum targets. Return true
1630 if there's a selected inferior, false otherwise. */
1632 extern int default_child_has_all_memory (struct target_ops *ops);
1633 extern int default_child_has_memory (struct target_ops *ops);
1634 extern int default_child_has_stack (struct target_ops *ops);
1635 extern int default_child_has_registers (struct target_ops *ops);
1636 extern int default_child_has_execution (struct target_ops *ops,
1639 /* Can the target support the debugger control of thread execution?
1640 Can it lock the thread scheduler? */
1642 #define target_can_lock_scheduler \
1643 (current_target.to_has_thread_control & tc_schedlock)
1645 /* Controls whether async mode is permitted. */
1646 extern int target_async_permitted;
1648 /* Can the target support asynchronous execution? */
1649 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1651 /* Is the target in asynchronous execution mode? */
1652 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1654 /* Put the target in async mode with the specified callback function. */
1655 #define target_async(CALLBACK,CONTEXT) \
1656 (current_target.to_async (¤t_target, (CALLBACK), (CONTEXT)))
1658 #define target_execution_direction() \
1659 (current_target.to_execution_direction (¤t_target))
1661 /* Converts a process id to a string. Usually, the string just contains
1662 `process xyz', but on some systems it may contain
1663 `process xyz thread abc'. */
1665 extern char *target_pid_to_str (ptid_t ptid);
1667 extern char *normal_pid_to_str (ptid_t ptid);
1669 /* Return a short string describing extra information about PID,
1670 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1673 #define target_extra_thread_info(TP) \
1674 (current_target.to_extra_thread_info (¤t_target, TP))
1676 /* Return the thread's name. A NULL result means that the target
1677 could not determine this thread's name. */
1679 extern char *target_thread_name (struct thread_info *);
1681 /* Attempts to find the pathname of the executable file
1682 that was run to create a specified process.
1684 The process PID must be stopped when this operation is used.
1686 If the executable file cannot be determined, NULL is returned.
1688 Else, a pointer to a character string containing the pathname
1689 is returned. This string should be copied into a buffer by
1690 the client if the string will not be immediately used, or if
1693 #define target_pid_to_exec_file(pid) \
1694 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1696 /* See the to_thread_architecture description in struct target_ops. */
1698 #define target_thread_architecture(ptid) \
1699 (current_target.to_thread_architecture (¤t_target, ptid))
1702 * Iterator function for target memory regions.
1703 * Calls a callback function once for each memory region 'mapped'
1704 * in the child process. Defined as a simple macro rather than
1705 * as a function macro so that it can be tested for nullity.
1708 #define target_find_memory_regions(FUNC, DATA) \
1709 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1712 * Compose corefile .note section.
1715 #define target_make_corefile_notes(BFD, SIZE_P) \
1716 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1718 /* Bookmark interfaces. */
1719 #define target_get_bookmark(ARGS, FROM_TTY) \
1720 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1722 #define target_goto_bookmark(ARG, FROM_TTY) \
1723 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1725 /* Hardware watchpoint interfaces. */
1727 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1728 write). Only the INFERIOR_PTID task is being queried. */
1730 #define target_stopped_by_watchpoint() \
1731 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1733 /* Non-zero if we have steppable watchpoints */
1735 #define target_have_steppable_watchpoint \
1736 (current_target.to_have_steppable_watchpoint)
1738 /* Non-zero if we have continuable watchpoints */
1740 #define target_have_continuable_watchpoint \
1741 (current_target.to_have_continuable_watchpoint)
1743 /* Provide defaults for hardware watchpoint functions. */
1745 /* If the *_hw_beakpoint functions have not been defined
1746 elsewhere use the definitions in the target vector. */
1748 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1749 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1750 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1751 (including this one?). OTHERTYPE is who knows what... */
1753 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1754 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1755 TYPE, CNT, OTHERTYPE);
1757 /* Returns the number of debug registers needed to watch the given
1758 memory region, or zero if not supported. */
1760 #define target_region_ok_for_hw_watchpoint(addr, len) \
1761 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1765 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1766 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1767 COND is the expression for its condition, or NULL if there's none.
1768 Returns 0 for success, 1 if the watchpoint type is not supported,
1771 #define target_insert_watchpoint(addr, len, type, cond) \
1772 (*current_target.to_insert_watchpoint) (¤t_target, \
1773 addr, len, type, cond)
1775 #define target_remove_watchpoint(addr, len, type, cond) \
1776 (*current_target.to_remove_watchpoint) (¤t_target, \
1777 addr, len, type, cond)
1779 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1780 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1781 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1782 masked watchpoints are not supported, -1 for failure. */
1784 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1786 /* Remove a masked watchpoint at ADDR with the mask MASK.
1787 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1788 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1791 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1793 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1794 the target machine. Returns 0 for success, and returns non-zero or
1795 throws an error (with a detailed failure reason error code and
1796 message) otherwise. */
1798 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1799 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1802 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1803 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1806 /* Return number of debug registers needed for a ranged breakpoint,
1807 or -1 if ranged breakpoints are not supported. */
1809 extern int target_ranged_break_num_registers (void);
1811 /* Return non-zero if target knows the data address which triggered this
1812 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1813 INFERIOR_PTID task is being queried. */
1814 #define target_stopped_data_address(target, addr_p) \
1815 (*(target)->to_stopped_data_address) (target, addr_p)
1817 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1818 LENGTH bytes beginning at START. */
1819 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1820 (*(target)->to_watchpoint_addr_within_range) (target, addr, start, length)
1822 /* Return non-zero if the target is capable of using hardware to evaluate
1823 the condition expression. In this case, if the condition is false when
1824 the watched memory location changes, execution may continue without the
1825 debugger being notified.
1827 Due to limitations in the hardware implementation, it may be capable of
1828 avoiding triggering the watchpoint in some cases where the condition
1829 expression is false, but may report some false positives as well.
1830 For this reason, GDB will still evaluate the condition expression when
1831 the watchpoint triggers. */
1832 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1833 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1834 addr, len, type, cond)
1836 /* Return number of debug registers needed for a masked watchpoint,
1837 -1 if masked watchpoints are not supported or -2 if the given address
1838 and mask combination cannot be used. */
1840 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1842 /* Target can execute in reverse? */
1843 #define target_can_execute_reverse \
1844 current_target.to_can_execute_reverse (¤t_target)
1846 extern const struct target_desc *target_read_description (struct target_ops *);
1848 #define target_get_ada_task_ptid(lwp, tid) \
1849 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1851 /* Utility implementation of searching memory. */
1852 extern int simple_search_memory (struct target_ops* ops,
1853 CORE_ADDR start_addr,
1854 ULONGEST search_space_len,
1855 const gdb_byte *pattern,
1856 ULONGEST pattern_len,
1857 CORE_ADDR *found_addrp);
1859 /* Main entry point for searching memory. */
1860 extern int target_search_memory (CORE_ADDR start_addr,
1861 ULONGEST search_space_len,
1862 const gdb_byte *pattern,
1863 ULONGEST pattern_len,
1864 CORE_ADDR *found_addrp);
1866 /* Target file operations. */
1868 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1869 target file descriptor, or -1 if an error occurs (and set
1871 extern int target_fileio_open (const char *filename, int flags, int mode,
1874 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1875 Return the number of bytes written, or -1 if an error occurs
1876 (and set *TARGET_ERRNO). */
1877 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1878 ULONGEST offset, int *target_errno);
1880 /* Read up to LEN bytes FD on the target into READ_BUF.
1881 Return the number of bytes read, or -1 if an error occurs
1882 (and set *TARGET_ERRNO). */
1883 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1884 ULONGEST offset, int *target_errno);
1886 /* Close FD on the target. Return 0, or -1 if an error occurs
1887 (and set *TARGET_ERRNO). */
1888 extern int target_fileio_close (int fd, int *target_errno);
1890 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1891 occurs (and set *TARGET_ERRNO). */
1892 extern int target_fileio_unlink (const char *filename, int *target_errno);
1894 /* Read value of symbolic link FILENAME on the target. Return a
1895 null-terminated string allocated via xmalloc, or NULL if an error
1896 occurs (and set *TARGET_ERRNO). */
1897 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1899 /* Read target file FILENAME. The return value will be -1 if the transfer
1900 fails or is not supported; 0 if the object is empty; or the length
1901 of the object otherwise. If a positive value is returned, a
1902 sufficiently large buffer will be allocated using xmalloc and
1903 returned in *BUF_P containing the contents of the object.
1905 This method should be used for objects sufficiently small to store
1906 in a single xmalloc'd buffer, when no fixed bound on the object's
1907 size is known in advance. */
1908 extern LONGEST target_fileio_read_alloc (const char *filename,
1911 /* Read target file FILENAME. The result is NUL-terminated and
1912 returned as a string, allocated using xmalloc. If an error occurs
1913 or the transfer is unsupported, NULL is returned. Empty objects
1914 are returned as allocated but empty strings. A warning is issued
1915 if the result contains any embedded NUL bytes. */
1916 extern char *target_fileio_read_stralloc (const char *filename);
1919 /* Tracepoint-related operations. */
1921 #define target_trace_init() \
1922 (*current_target.to_trace_init) (¤t_target)
1924 #define target_download_tracepoint(t) \
1925 (*current_target.to_download_tracepoint) (¤t_target, t)
1927 #define target_can_download_tracepoint() \
1928 (*current_target.to_can_download_tracepoint) (¤t_target)
1930 #define target_download_trace_state_variable(tsv) \
1931 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1933 #define target_enable_tracepoint(loc) \
1934 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1936 #define target_disable_tracepoint(loc) \
1937 (*current_target.to_disable_tracepoint) (¤t_target, loc)
1939 #define target_trace_start() \
1940 (*current_target.to_trace_start) (¤t_target)
1942 #define target_trace_set_readonly_regions() \
1943 (*current_target.to_trace_set_readonly_regions) (¤t_target)
1945 #define target_get_trace_status(ts) \
1946 (*current_target.to_get_trace_status) (¤t_target, ts)
1948 #define target_get_tracepoint_status(tp,utp) \
1949 (*current_target.to_get_tracepoint_status) (¤t_target, tp, utp)
1951 #define target_trace_stop() \
1952 (*current_target.to_trace_stop) (¤t_target)
1954 #define target_trace_find(type,num,addr1,addr2,tpp) \
1955 (*current_target.to_trace_find) (¤t_target, \
1956 (type), (num), (addr1), (addr2), (tpp))
1958 #define target_get_trace_state_variable_value(tsv,val) \
1959 (*current_target.to_get_trace_state_variable_value) (¤t_target, \
1962 #define target_save_trace_data(filename) \
1963 (*current_target.to_save_trace_data) (¤t_target, filename)
1965 #define target_upload_tracepoints(utpp) \
1966 (*current_target.to_upload_tracepoints) (¤t_target, utpp)
1968 #define target_upload_trace_state_variables(utsvp) \
1969 (*current_target.to_upload_trace_state_variables) (¤t_target, utsvp)
1971 #define target_get_raw_trace_data(buf,offset,len) \
1972 (*current_target.to_get_raw_trace_data) (¤t_target, \
1973 (buf), (offset), (len))
1975 #define target_get_min_fast_tracepoint_insn_len() \
1976 (*current_target.to_get_min_fast_tracepoint_insn_len) (¤t_target)
1978 #define target_set_disconnected_tracing(val) \
1979 (*current_target.to_set_disconnected_tracing) (¤t_target, val)
1981 #define target_set_circular_trace_buffer(val) \
1982 (*current_target.to_set_circular_trace_buffer) (¤t_target, val)
1984 #define target_set_trace_buffer_size(val) \
1985 (*current_target.to_set_trace_buffer_size) (¤t_target, val)
1987 #define target_set_trace_notes(user,notes,stopnotes) \
1988 (*current_target.to_set_trace_notes) (¤t_target, \
1989 (user), (notes), (stopnotes))
1991 #define target_get_tib_address(ptid, addr) \
1992 (*current_target.to_get_tib_address) (¤t_target, (ptid), (addr))
1994 #define target_set_permissions() \
1995 (*current_target.to_set_permissions) (¤t_target)
1997 #define target_static_tracepoint_marker_at(addr, marker) \
1998 (*current_target.to_static_tracepoint_marker_at) (¤t_target, \
2001 #define target_static_tracepoint_markers_by_strid(marker_id) \
2002 (*current_target.to_static_tracepoint_markers_by_strid) (¤t_target, \
2005 #define target_traceframe_info() \
2006 (*current_target.to_traceframe_info) (¤t_target)
2008 #define target_use_agent(use) \
2009 (*current_target.to_use_agent) (¤t_target, use)
2011 #define target_can_use_agent() \
2012 (*current_target.to_can_use_agent) (¤t_target)
2014 #define target_augmented_libraries_svr4_read() \
2015 (*current_target.to_augmented_libraries_svr4_read) (¤t_target)
2017 /* Command logging facility. */
2019 #define target_log_command(p) \
2020 (*current_target.to_log_command) (¤t_target, p)
2023 extern int target_core_of_thread (ptid_t ptid);
2025 /* See to_get_unwinder in struct target_ops. */
2026 extern const struct frame_unwind *target_get_unwinder (void);
2028 /* See to_get_tailcall_unwinder in struct target_ops. */
2029 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
2031 /* This implements basic memory verification, reading target memory
2032 and performing the comparison here (as opposed to accelerated
2033 verification making use of the qCRC packet, for example). */
2035 extern int simple_verify_memory (struct target_ops* ops,
2036 const gdb_byte *data,
2037 CORE_ADDR memaddr, ULONGEST size);
2039 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2040 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2041 if there's a mismatch, and -1 if an error is encountered while
2042 reading memory. Throws an error if the functionality is found not
2043 to be supported by the current target. */
2044 int target_verify_memory (const gdb_byte *data,
2045 CORE_ADDR memaddr, ULONGEST size);
2047 /* Routines for maintenance of the target structures...
2049 complete_target_initialization: Finalize a target_ops by filling in
2050 any fields needed by the target implementation. Unnecessary for
2051 targets which are registered via add_target, as this part gets
2054 add_target: Add a target to the list of all possible targets.
2055 This only makes sense for targets that should be activated using
2056 the "target TARGET_NAME ..." command.
2058 push_target: Make this target the top of the stack of currently used
2059 targets, within its particular stratum of the stack. Result
2060 is 0 if now atop the stack, nonzero if not on top (maybe
2063 unpush_target: Remove this from the stack of currently used targets,
2064 no matter where it is on the list. Returns 0 if no
2065 change, 1 if removed from stack. */
2067 extern void add_target (struct target_ops *);
2069 extern void add_target_with_completer (struct target_ops *t,
2070 completer_ftype *completer);
2072 extern void complete_target_initialization (struct target_ops *t);
2074 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
2075 for maintaining backwards compatibility when renaming targets. */
2077 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
2079 extern void push_target (struct target_ops *);
2081 extern int unpush_target (struct target_ops *);
2083 extern void target_pre_inferior (int);
2085 extern void target_preopen (int);
2087 /* Does whatever cleanup is required to get rid of all pushed targets. */
2088 extern void pop_all_targets (void);
2090 /* Like pop_all_targets, but pops only targets whose stratum is
2091 strictly above ABOVE_STRATUM. */
2092 extern void pop_all_targets_above (enum strata above_stratum);
2094 extern int target_is_pushed (struct target_ops *t);
2096 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2099 /* Struct target_section maps address ranges to file sections. It is
2100 mostly used with BFD files, but can be used without (e.g. for handling
2101 raw disks, or files not in formats handled by BFD). */
2103 struct target_section
2105 CORE_ADDR addr; /* Lowest address in section */
2106 CORE_ADDR endaddr; /* 1+highest address in section */
2108 struct bfd_section *the_bfd_section;
2110 /* The "owner" of the section.
2111 It can be any unique value. It is set by add_target_sections
2112 and used by remove_target_sections.
2113 For example, for executables it is a pointer to exec_bfd and
2114 for shlibs it is the so_list pointer. */
2118 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2120 struct target_section_table
2122 struct target_section *sections;
2123 struct target_section *sections_end;
2126 /* Return the "section" containing the specified address. */
2127 struct target_section *target_section_by_addr (struct target_ops *target,
2130 /* Return the target section table this target (or the targets
2131 beneath) currently manipulate. */
2133 extern struct target_section_table *target_get_section_table
2134 (struct target_ops *target);
2136 /* From mem-break.c */
2138 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
2139 struct bp_target_info *);
2141 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
2142 struct bp_target_info *);
2144 /* Check whether the memory at the breakpoint's placed address still
2145 contains the expected breakpoint instruction. */
2147 extern int memory_validate_breakpoint (struct gdbarch *gdbarch,
2148 struct bp_target_info *bp_tgt);
2150 extern int default_memory_remove_breakpoint (struct gdbarch *,
2151 struct bp_target_info *);
2153 extern int default_memory_insert_breakpoint (struct gdbarch *,
2154 struct bp_target_info *);
2159 extern void initialize_targets (void);
2161 extern void noprocess (void) ATTRIBUTE_NORETURN;
2163 extern void target_require_runnable (void);
2165 extern void find_default_attach (struct target_ops *, const char *, int);
2167 extern void find_default_create_inferior (struct target_ops *,
2168 char *, char *, char **, int);
2170 extern struct target_ops *find_target_beneath (struct target_ops *);
2172 /* Find the target at STRATUM. If no target is at that stratum,
2175 struct target_ops *find_target_at (enum strata stratum);
2177 /* Read OS data object of type TYPE from the target, and return it in
2178 XML format. The result is NUL-terminated and returned as a string,
2179 allocated using xmalloc. If an error occurs or the transfer is
2180 unsupported, NULL is returned. Empty objects are returned as
2181 allocated but empty strings. */
2183 extern char *target_get_osdata (const char *type);
2186 /* Stuff that should be shared among the various remote targets. */
2188 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2189 information (higher values, more information). */
2190 extern int remote_debug;
2192 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2193 extern int baud_rate;
2194 /* Timeout limit for response from target. */
2195 extern int remote_timeout;
2199 /* Set the show memory breakpoints mode to show, and installs a cleanup
2200 to restore it back to the current value. */
2201 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2203 extern int may_write_registers;
2204 extern int may_write_memory;
2205 extern int may_insert_breakpoints;
2206 extern int may_insert_tracepoints;
2207 extern int may_insert_fast_tracepoints;
2208 extern int may_stop;
2210 extern void update_target_permissions (void);
2213 /* Imported from machine dependent code. */
2215 /* See to_supports_btrace in struct target_ops. */
2216 #define target_supports_btrace() \
2217 (current_target.to_supports_btrace (¤t_target))
2219 /* See to_enable_btrace in struct target_ops. */
2220 extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2222 /* See to_disable_btrace in struct target_ops. */
2223 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2225 /* See to_teardown_btrace in struct target_ops. */
2226 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2228 /* See to_read_btrace in struct target_ops. */
2229 extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2230 struct btrace_target_info *,
2231 enum btrace_read_type);
2233 /* See to_stop_recording in struct target_ops. */
2234 extern void target_stop_recording (void);
2236 /* See to_save_record in struct target_ops. */
2237 extern void target_save_record (const char *filename);
2239 /* Query if the target supports deleting the execution log. */
2240 extern int target_supports_delete_record (void);
2242 /* See to_delete_record in struct target_ops. */
2243 extern void target_delete_record (void);
2245 /* See to_record_is_replaying in struct target_ops. */
2246 extern int target_record_is_replaying (void);
2248 /* See to_goto_record_begin in struct target_ops. */
2249 extern void target_goto_record_begin (void);
2251 /* See to_goto_record_end in struct target_ops. */
2252 extern void target_goto_record_end (void);
2254 /* See to_goto_record in struct target_ops. */
2255 extern void target_goto_record (ULONGEST insn);
2257 /* See to_insn_history. */
2258 extern void target_insn_history (int size, int flags);
2260 /* See to_insn_history_from. */
2261 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2263 /* See to_insn_history_range. */
2264 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2266 /* See to_call_history. */
2267 extern void target_call_history (int size, int flags);
2269 /* See to_call_history_from. */
2270 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2272 /* See to_call_history_range. */
2273 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2275 /* See to_decr_pc_after_break. Start searching for the target at OPS. */
2276 extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2277 struct gdbarch *gdbarch);
2279 /* See to_decr_pc_after_break. */
2280 extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2282 /* See to_prepare_to_generate_core. */
2283 extern void target_prepare_to_generate_core (void);
2285 /* See to_done_generating_core. */
2286 extern void target_done_generating_core (void);
2288 #endif /* !defined (TARGET_H) */