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 /* These defines are used to mark target_ops methods. The script
361 make-target-delegates scans these and auto-generates the base
362 method implementations. There are four macros that can be used:
364 1. TARGET_DEFAULT_IGNORE. There is no argument. The base method
365 does nothing. This is only valid if the method return type is
368 2. TARGET_DEFAULT_NORETURN. The argument is a function call, like
369 'tcomplain ()'. The base method simply makes this call, which is
370 assumed not to return.
372 3. TARGET_DEFAULT_RETURN. The argument is a C expression. The
373 base method returns this expression's value.
375 4. TARGET_DEFAULT_FUNC. The argument is the name of a function.
376 make-target-delegates does not generate a base method in this case,
377 but instead uses the argument function as the base method. */
379 #define TARGET_DEFAULT_IGNORE()
380 #define TARGET_DEFAULT_NORETURN(ARG)
381 #define TARGET_DEFAULT_RETURN(ARG)
382 #define TARGET_DEFAULT_FUNC(ARG)
386 struct target_ops *beneath; /* To the target under this one. */
387 char *to_shortname; /* Name this target type */
388 char *to_longname; /* Name for printing */
389 char *to_doc; /* Documentation. Does not include trailing
390 newline, and starts with a one-line descrip-
391 tion (probably similar to to_longname). */
392 /* Per-target scratch pad. */
394 /* The open routine takes the rest of the parameters from the
395 command, and (if successful) pushes a new target onto the
396 stack. Targets should supply this routine, if only to provide
398 void (*to_open) (char *, int);
399 /* Old targets with a static target vector provide "to_close".
400 New re-entrant targets provide "to_xclose" and that is expected
401 to xfree everything (including the "struct target_ops"). */
402 void (*to_xclose) (struct target_ops *targ);
403 void (*to_close) (struct target_ops *);
404 /* Attaches to a process on the target side. Arguments are as
405 passed to the `attach' command by the user. This routine can
406 be called when the target is not on the target-stack, if the
407 target_can_run routine returns 1; in that case, it must push
408 itself onto the stack. Upon exit, the target should be ready
409 for normal operations, and should be ready to deliver the
410 status of the process immediately (without waiting) to an
411 upcoming target_wait call. */
412 void (*to_attach) (struct target_ops *ops, char *, int);
413 void (*to_post_attach) (struct target_ops *, int)
414 TARGET_DEFAULT_IGNORE ();
415 void (*to_detach) (struct target_ops *ops, const char *, int)
416 TARGET_DEFAULT_IGNORE ();
417 void (*to_disconnect) (struct target_ops *, char *, int)
418 TARGET_DEFAULT_NORETURN (tcomplain ());
419 void (*to_resume) (struct target_ops *, ptid_t, int, enum gdb_signal)
420 TARGET_DEFAULT_NORETURN (noprocess ());
421 ptid_t (*to_wait) (struct target_ops *,
422 ptid_t, struct target_waitstatus *, int)
423 TARGET_DEFAULT_NORETURN (noprocess ());
424 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int)
425 TARGET_DEFAULT_IGNORE ();
426 void (*to_store_registers) (struct target_ops *, struct regcache *, int)
427 TARGET_DEFAULT_NORETURN (noprocess ());
428 void (*to_prepare_to_store) (struct target_ops *, struct regcache *)
429 TARGET_DEFAULT_NORETURN (noprocess ());
431 void (*to_files_info) (struct target_ops *)
432 TARGET_DEFAULT_IGNORE ();
433 int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
434 struct bp_target_info *)
435 TARGET_DEFAULT_FUNC (memory_insert_breakpoint);
436 int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
437 struct bp_target_info *)
438 TARGET_DEFAULT_FUNC (memory_remove_breakpoint);
439 int (*to_can_use_hw_breakpoint) (struct target_ops *, int, int, int)
440 TARGET_DEFAULT_RETURN (0);
441 int (*to_ranged_break_num_registers) (struct target_ops *)
442 TARGET_DEFAULT_RETURN (-1);
443 int (*to_insert_hw_breakpoint) (struct target_ops *,
444 struct gdbarch *, struct bp_target_info *)
445 TARGET_DEFAULT_RETURN (-1);
446 int (*to_remove_hw_breakpoint) (struct target_ops *,
447 struct gdbarch *, struct bp_target_info *)
448 TARGET_DEFAULT_RETURN (-1);
450 /* Documentation of what the two routines below are expected to do is
451 provided with the corresponding target_* macros. */
452 int (*to_remove_watchpoint) (struct target_ops *,
453 CORE_ADDR, int, int, struct expression *)
454 TARGET_DEFAULT_RETURN (-1);
455 int (*to_insert_watchpoint) (struct target_ops *,
456 CORE_ADDR, int, int, struct expression *)
457 TARGET_DEFAULT_RETURN (-1);
459 int (*to_insert_mask_watchpoint) (struct target_ops *,
460 CORE_ADDR, CORE_ADDR, int)
461 TARGET_DEFAULT_RETURN (1);
462 int (*to_remove_mask_watchpoint) (struct target_ops *,
463 CORE_ADDR, CORE_ADDR, int)
464 TARGET_DEFAULT_RETURN (1);
465 int (*to_stopped_by_watchpoint) (struct target_ops *)
466 TARGET_DEFAULT_RETURN (0);
467 int to_have_steppable_watchpoint;
468 int to_have_continuable_watchpoint;
469 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *)
470 TARGET_DEFAULT_RETURN (0);
471 int (*to_watchpoint_addr_within_range) (struct target_ops *,
472 CORE_ADDR, CORE_ADDR, int)
473 TARGET_DEFAULT_FUNC (default_watchpoint_addr_within_range);
475 /* Documentation of this routine is provided with the corresponding
477 int (*to_region_ok_for_hw_watchpoint) (struct target_ops *,
479 TARGET_DEFAULT_FUNC (default_region_ok_for_hw_watchpoint);
481 int (*to_can_accel_watchpoint_condition) (struct target_ops *,
484 TARGET_DEFAULT_RETURN (0);
485 int (*to_masked_watch_num_registers) (struct target_ops *,
486 CORE_ADDR, CORE_ADDR)
487 TARGET_DEFAULT_RETURN (-1);
488 void (*to_terminal_init) (struct target_ops *)
489 TARGET_DEFAULT_IGNORE ();
490 void (*to_terminal_inferior) (struct target_ops *)
491 TARGET_DEFAULT_IGNORE ();
492 void (*to_terminal_ours_for_output) (struct target_ops *)
493 TARGET_DEFAULT_IGNORE ();
494 void (*to_terminal_ours) (struct target_ops *)
495 TARGET_DEFAULT_IGNORE ();
496 void (*to_terminal_save_ours) (struct target_ops *)
497 TARGET_DEFAULT_IGNORE ();
498 void (*to_terminal_info) (struct target_ops *, const char *, int)
499 TARGET_DEFAULT_FUNC (default_terminal_info);
500 void (*to_kill) (struct target_ops *)
501 TARGET_DEFAULT_NORETURN (noprocess ());
502 void (*to_load) (struct target_ops *, char *, int)
503 TARGET_DEFAULT_NORETURN (tcomplain ());
504 /* Start an inferior process and set inferior_ptid to its pid.
505 EXEC_FILE is the file to run.
506 ALLARGS is a string containing the arguments to the program.
507 ENV is the environment vector to pass. Errors reported with error().
508 On VxWorks and various standalone systems, we ignore exec_file. */
509 void (*to_create_inferior) (struct target_ops *,
510 char *, char *, char **, int);
511 void (*to_post_startup_inferior) (struct target_ops *, ptid_t)
512 TARGET_DEFAULT_IGNORE ();
513 int (*to_insert_fork_catchpoint) (struct target_ops *, int)
514 TARGET_DEFAULT_RETURN (1);
515 int (*to_remove_fork_catchpoint) (struct target_ops *, int)
516 TARGET_DEFAULT_RETURN (1);
517 int (*to_insert_vfork_catchpoint) (struct target_ops *, int)
518 TARGET_DEFAULT_RETURN (1);
519 int (*to_remove_vfork_catchpoint) (struct target_ops *, int)
520 TARGET_DEFAULT_RETURN (1);
521 int (*to_follow_fork) (struct target_ops *, int, int)
522 TARGET_DEFAULT_FUNC (default_follow_fork);
523 int (*to_insert_exec_catchpoint) (struct target_ops *, int)
524 TARGET_DEFAULT_RETURN (1);
525 int (*to_remove_exec_catchpoint) (struct target_ops *, int)
526 TARGET_DEFAULT_RETURN (1);
527 int (*to_set_syscall_catchpoint) (struct target_ops *,
528 int, int, int, int, int *)
529 TARGET_DEFAULT_RETURN (1);
530 int (*to_has_exited) (struct target_ops *, int, int, int *)
531 TARGET_DEFAULT_RETURN (0);
532 void (*to_mourn_inferior) (struct target_ops *)
533 TARGET_DEFAULT_FUNC (default_mourn_inferior);
534 /* Note that to_can_run is special and can be invoked on an
535 unpushed target. Targets defining this method must also define
536 to_can_async_p and to_supports_non_stop. */
537 int (*to_can_run) (struct target_ops *)
538 TARGET_DEFAULT_RETURN (0);
540 /* Documentation of this routine is provided with the corresponding
542 void (*to_pass_signals) (struct target_ops *, int, unsigned char *)
543 TARGET_DEFAULT_IGNORE ();
545 /* Documentation of this routine is provided with the
546 corresponding target_* function. */
547 void (*to_program_signals) (struct target_ops *, int, unsigned char *)
548 TARGET_DEFAULT_IGNORE ();
550 int (*to_thread_alive) (struct target_ops *, ptid_t ptid)
551 TARGET_DEFAULT_RETURN (0);
552 void (*to_find_new_threads) (struct target_ops *)
553 TARGET_DEFAULT_IGNORE ();
554 char *(*to_pid_to_str) (struct target_ops *, ptid_t)
555 TARGET_DEFAULT_FUNC (default_pid_to_str);
556 char *(*to_extra_thread_info) (struct target_ops *, struct thread_info *)
557 TARGET_DEFAULT_RETURN (NULL);
558 char *(*to_thread_name) (struct target_ops *, struct thread_info *)
559 TARGET_DEFAULT_RETURN (NULL);
560 void (*to_stop) (struct target_ops *, ptid_t)
561 TARGET_DEFAULT_IGNORE ();
562 void (*to_rcmd) (struct target_ops *,
563 char *command, struct ui_file *output)
564 TARGET_DEFAULT_FUNC (default_rcmd);
565 char *(*to_pid_to_exec_file) (struct target_ops *, int pid)
566 TARGET_DEFAULT_RETURN (NULL);
567 void (*to_log_command) (struct target_ops *, const char *)
568 TARGET_DEFAULT_IGNORE ();
569 struct target_section_table *(*to_get_section_table) (struct target_ops *)
570 TARGET_DEFAULT_RETURN (NULL);
571 enum strata to_stratum;
572 int (*to_has_all_memory) (struct target_ops *);
573 int (*to_has_memory) (struct target_ops *);
574 int (*to_has_stack) (struct target_ops *);
575 int (*to_has_registers) (struct target_ops *);
576 int (*to_has_execution) (struct target_ops *, ptid_t);
577 int to_has_thread_control; /* control thread execution */
578 int to_attach_no_wait;
579 /* This method must be implemented in some situations. See the
580 comment on 'to_can_run'. */
581 int (*to_can_async_p) (struct target_ops *)
582 TARGET_DEFAULT_RETURN (0);
583 int (*to_is_async_p) (struct target_ops *)
584 TARGET_DEFAULT_RETURN (0);
585 void (*to_async) (struct target_ops *, async_callback_ftype *, void *)
586 TARGET_DEFAULT_NORETURN (tcomplain ());
587 /* This method must be implemented in some situations. See the
588 comment on 'to_can_run'. */
589 int (*to_supports_non_stop) (struct target_ops *)
590 TARGET_DEFAULT_RETURN (0);
591 /* find_memory_regions support method for gcore */
592 int (*to_find_memory_regions) (struct target_ops *,
593 find_memory_region_ftype func, void *data)
594 TARGET_DEFAULT_FUNC (dummy_find_memory_regions);
595 /* make_corefile_notes support method for gcore */
596 char * (*to_make_corefile_notes) (struct target_ops *, bfd *, int *)
597 TARGET_DEFAULT_FUNC (dummy_make_corefile_notes);
598 /* get_bookmark support method for bookmarks */
599 gdb_byte * (*to_get_bookmark) (struct target_ops *, char *, int)
600 TARGET_DEFAULT_NORETURN (tcomplain ());
601 /* goto_bookmark support method for bookmarks */
602 void (*to_goto_bookmark) (struct target_ops *, gdb_byte *, int)
603 TARGET_DEFAULT_NORETURN (tcomplain ());
604 /* Return the thread-local address at OFFSET in the
605 thread-local storage for the thread PTID and the shared library
606 or executable file given by OBJFILE. If that block of
607 thread-local storage hasn't been allocated yet, this function
608 may return an error. LOAD_MODULE_ADDR may be zero for statically
609 linked multithreaded inferiors. */
610 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
612 CORE_ADDR load_module_addr,
615 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
616 OBJECT. The OFFSET, for a seekable object, specifies the
617 starting point. The ANNEX can be used to provide additional
618 data-specific information to the target.
620 Return the transferred status, error or OK (an
621 'enum target_xfer_status' value). Save the number of bytes
622 actually transferred in *XFERED_LEN if transfer is successful
623 (TARGET_XFER_OK) or the number unavailable bytes if the requested
624 data is unavailable (TARGET_XFER_UNAVAILABLE). *XFERED_LEN
625 smaller than LEN does not indicate the end of the object, only
626 the end of the transfer; higher level code should continue
627 transferring if desired. This is handled in target.c.
629 The interface does not support a "retry" mechanism. Instead it
630 assumes that at least one byte will be transfered on each
633 NOTE: cagney/2003-10-17: The current interface can lead to
634 fragmented transfers. Lower target levels should not implement
635 hacks, such as enlarging the transfer, in an attempt to
636 compensate for this. Instead, the target stack should be
637 extended so that it implements supply/collect methods and a
638 look-aside object cache. With that available, the lowest
639 target can safely and freely "push" data up the stack.
641 See target_read and target_write for more information. One,
642 and only one, of readbuf or writebuf must be non-NULL. */
644 enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
645 enum target_object object,
648 const gdb_byte *writebuf,
649 ULONGEST offset, ULONGEST len,
650 ULONGEST *xfered_len)
651 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
653 /* Returns the memory map for the target. A return value of NULL
654 means that no memory map is available. If a memory address
655 does not fall within any returned regions, it's assumed to be
656 RAM. The returned memory regions should not overlap.
658 The order of regions does not matter; target_memory_map will
659 sort regions by starting address. For that reason, this
660 function should not be called directly except via
663 This method should not cache data; if the memory map could
664 change unexpectedly, it should be invalidated, and higher
665 layers will re-fetch it. */
666 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *)
667 TARGET_DEFAULT_RETURN (NULL);
669 /* Erases the region of flash memory starting at ADDRESS, of
672 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
673 on flash block boundaries, as reported by 'to_memory_map'. */
674 void (*to_flash_erase) (struct target_ops *,
675 ULONGEST address, LONGEST length)
676 TARGET_DEFAULT_NORETURN (tcomplain ());
678 /* Finishes a flash memory write sequence. After this operation
679 all flash memory should be available for writing and the result
680 of reading from areas written by 'to_flash_write' should be
681 equal to what was written. */
682 void (*to_flash_done) (struct target_ops *)
683 TARGET_DEFAULT_NORETURN (tcomplain ());
685 /* Describe the architecture-specific features of this target. If
686 OPS doesn't have a description, this should delegate to the
687 "beneath" target. Returns the description found, or NULL if no
688 description was available. */
689 const struct target_desc *(*to_read_description) (struct target_ops *ops)
690 TARGET_DEFAULT_RETURN (NULL);
692 /* Build the PTID of the thread on which a given task is running,
693 based on LWP and THREAD. These values are extracted from the
694 task Private_Data section of the Ada Task Control Block, and
695 their interpretation depends on the target. */
696 ptid_t (*to_get_ada_task_ptid) (struct target_ops *,
697 long lwp, long thread)
698 TARGET_DEFAULT_FUNC (default_get_ada_task_ptid);
700 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
701 Return 0 if *READPTR is already at the end of the buffer.
702 Return -1 if there is insufficient buffer for a whole entry.
703 Return 1 if an entry was read into *TYPEP and *VALP. */
704 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
705 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
706 TARGET_DEFAULT_FUNC (default_auxv_parse);
708 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
709 sequence of bytes in PATTERN with length PATTERN_LEN.
711 The result is 1 if found, 0 if not found, and -1 if there was an error
712 requiring halting of the search (e.g. memory read error).
713 If the pattern is found the address is recorded in FOUND_ADDRP. */
714 int (*to_search_memory) (struct target_ops *ops,
715 CORE_ADDR start_addr, ULONGEST search_space_len,
716 const gdb_byte *pattern, ULONGEST pattern_len,
717 CORE_ADDR *found_addrp)
718 TARGET_DEFAULT_FUNC (default_search_memory);
720 /* Can target execute in reverse? */
721 int (*to_can_execute_reverse) (struct target_ops *)
722 TARGET_DEFAULT_RETURN (0);
724 /* The direction the target is currently executing. Must be
725 implemented on targets that support reverse execution and async
726 mode. The default simply returns forward execution. */
727 enum exec_direction_kind (*to_execution_direction) (struct target_ops *)
728 TARGET_DEFAULT_FUNC (default_execution_direction);
730 /* Does this target support debugging multiple processes
732 int (*to_supports_multi_process) (struct target_ops *)
733 TARGET_DEFAULT_RETURN (0);
735 /* Does this target support enabling and disabling tracepoints while a trace
736 experiment is running? */
737 int (*to_supports_enable_disable_tracepoint) (struct target_ops *)
738 TARGET_DEFAULT_RETURN (0);
740 /* Does this target support disabling address space randomization? */
741 int (*to_supports_disable_randomization) (struct target_ops *);
743 /* Does this target support the tracenz bytecode for string collection? */
744 int (*to_supports_string_tracing) (struct target_ops *)
745 TARGET_DEFAULT_RETURN (0);
747 /* Does this target support evaluation of breakpoint conditions on its
749 int (*to_supports_evaluation_of_breakpoint_conditions) (struct target_ops *)
750 TARGET_DEFAULT_RETURN (0);
752 /* Does this target support evaluation of breakpoint commands on its
754 int (*to_can_run_breakpoint_commands) (struct target_ops *)
755 TARGET_DEFAULT_RETURN (0);
757 /* Determine current architecture of thread PTID.
759 The target is supposed to determine the architecture of the code where
760 the target is currently stopped at (on Cell, if a target is in spu_run,
761 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
762 This is architecture used to perform decr_pc_after_break adjustment,
763 and also determines the frame architecture of the innermost frame.
764 ptrace operations need to operate according to target_gdbarch ().
766 The default implementation always returns target_gdbarch (). */
767 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t)
768 TARGET_DEFAULT_FUNC (default_thread_architecture);
770 /* Determine current address space of thread PTID.
772 The default implementation always returns the inferior's
774 struct address_space *(*to_thread_address_space) (struct target_ops *,
777 /* Target file operations. */
779 /* Open FILENAME on the target, using FLAGS and MODE. Return a
780 target file descriptor, or -1 if an error occurs (and set
782 int (*to_fileio_open) (struct target_ops *,
783 const char *filename, int flags, int mode,
786 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
787 Return the number of bytes written, or -1 if an error occurs
788 (and set *TARGET_ERRNO). */
789 int (*to_fileio_pwrite) (struct target_ops *,
790 int fd, const gdb_byte *write_buf, int len,
791 ULONGEST offset, int *target_errno);
793 /* Read up to LEN bytes FD on the target into READ_BUF.
794 Return the number of bytes read, or -1 if an error occurs
795 (and set *TARGET_ERRNO). */
796 int (*to_fileio_pread) (struct target_ops *,
797 int fd, gdb_byte *read_buf, int len,
798 ULONGEST offset, int *target_errno);
800 /* Close FD on the target. Return 0, or -1 if an error occurs
801 (and set *TARGET_ERRNO). */
802 int (*to_fileio_close) (struct target_ops *, int fd, int *target_errno);
804 /* Unlink FILENAME on the target. Return 0, or -1 if an error
805 occurs (and set *TARGET_ERRNO). */
806 int (*to_fileio_unlink) (struct target_ops *,
807 const char *filename, int *target_errno);
809 /* Read value of symbolic link FILENAME on the target. Return a
810 null-terminated string allocated via xmalloc, or NULL if an error
811 occurs (and set *TARGET_ERRNO). */
812 char *(*to_fileio_readlink) (struct target_ops *,
813 const char *filename, int *target_errno);
816 /* Implement the "info proc" command. */
817 void (*to_info_proc) (struct target_ops *, char *, enum info_proc_what);
819 /* Tracepoint-related operations. */
821 /* Prepare the target for a tracing run. */
822 void (*to_trace_init) (struct target_ops *)
823 TARGET_DEFAULT_NORETURN (tcomplain ());
825 /* Send full details of a tracepoint location to the target. */
826 void (*to_download_tracepoint) (struct target_ops *,
827 struct bp_location *location)
828 TARGET_DEFAULT_NORETURN (tcomplain ());
830 /* Is the target able to download tracepoint locations in current
832 int (*to_can_download_tracepoint) (struct target_ops *)
833 TARGET_DEFAULT_RETURN (0);
835 /* Send full details of a trace state variable to the target. */
836 void (*to_download_trace_state_variable) (struct target_ops *,
837 struct trace_state_variable *tsv)
838 TARGET_DEFAULT_NORETURN (tcomplain ());
840 /* Enable a tracepoint on the target. */
841 void (*to_enable_tracepoint) (struct target_ops *,
842 struct bp_location *location)
843 TARGET_DEFAULT_NORETURN (tcomplain ());
845 /* Disable a tracepoint on the target. */
846 void (*to_disable_tracepoint) (struct target_ops *,
847 struct bp_location *location)
848 TARGET_DEFAULT_NORETURN (tcomplain ());
850 /* Inform the target info of memory regions that are readonly
851 (such as text sections), and so it should return data from
852 those rather than look in the trace buffer. */
853 void (*to_trace_set_readonly_regions) (struct target_ops *)
854 TARGET_DEFAULT_NORETURN (tcomplain ());
856 /* Start a trace run. */
857 void (*to_trace_start) (struct target_ops *)
858 TARGET_DEFAULT_NORETURN (tcomplain ());
860 /* Get the current status of a tracing run. */
861 int (*to_get_trace_status) (struct target_ops *, struct trace_status *ts)
862 TARGET_DEFAULT_RETURN (-1);
864 void (*to_get_tracepoint_status) (struct target_ops *,
865 struct breakpoint *tp,
866 struct uploaded_tp *utp)
867 TARGET_DEFAULT_NORETURN (tcomplain ());
869 /* Stop a trace run. */
870 void (*to_trace_stop) (struct target_ops *)
871 TARGET_DEFAULT_NORETURN (tcomplain ());
873 /* Ask the target to find a trace frame of the given type TYPE,
874 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
875 number of the trace frame, and also the tracepoint number at
876 TPP. If no trace frame matches, return -1. May throw if the
878 int (*to_trace_find) (struct target_ops *,
879 enum trace_find_type type, int num,
880 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
881 TARGET_DEFAULT_RETURN (-1);
883 /* Get the value of the trace state variable number TSV, returning
884 1 if the value is known and writing the value itself into the
885 location pointed to by VAL, else returning 0. */
886 int (*to_get_trace_state_variable_value) (struct target_ops *,
887 int tsv, LONGEST *val)
888 TARGET_DEFAULT_RETURN (0);
890 int (*to_save_trace_data) (struct target_ops *, const char *filename)
891 TARGET_DEFAULT_NORETURN (tcomplain ());
893 int (*to_upload_tracepoints) (struct target_ops *,
894 struct uploaded_tp **utpp)
895 TARGET_DEFAULT_RETURN (0);
897 int (*to_upload_trace_state_variables) (struct target_ops *,
898 struct uploaded_tsv **utsvp)
899 TARGET_DEFAULT_RETURN (0);
901 LONGEST (*to_get_raw_trace_data) (struct target_ops *, gdb_byte *buf,
902 ULONGEST offset, LONGEST len)
903 TARGET_DEFAULT_NORETURN (tcomplain ());
905 /* Get the minimum length of instruction on which a fast tracepoint
906 may be set on the target. If this operation is unsupported,
907 return -1. If for some reason the minimum length cannot be
908 determined, return 0. */
909 int (*to_get_min_fast_tracepoint_insn_len) (struct target_ops *)
910 TARGET_DEFAULT_RETURN (-1);
912 /* Set the target's tracing behavior in response to unexpected
913 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
914 void (*to_set_disconnected_tracing) (struct target_ops *, int val)
915 TARGET_DEFAULT_IGNORE ();
916 void (*to_set_circular_trace_buffer) (struct target_ops *, int val)
917 TARGET_DEFAULT_IGNORE ();
918 /* Set the size of trace buffer in the target. */
919 void (*to_set_trace_buffer_size) (struct target_ops *, LONGEST val)
920 TARGET_DEFAULT_IGNORE ();
922 /* Add/change textual notes about the trace run, returning 1 if
923 successful, 0 otherwise. */
924 int (*to_set_trace_notes) (struct target_ops *,
925 const char *user, const char *notes,
926 const char *stopnotes)
927 TARGET_DEFAULT_RETURN (0);
929 /* Return the processor core that thread PTID was last seen on.
930 This information is updated only when:
931 - update_thread_list is called
933 If the core cannot be determined -- either for the specified
934 thread, or right now, or in this debug session, or for this
935 target -- return -1. */
936 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid)
937 TARGET_DEFAULT_RETURN (-1);
939 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
940 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
941 a match, 0 if there's a mismatch, and -1 if an error is
942 encountered while reading memory. */
943 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
944 CORE_ADDR memaddr, ULONGEST size)
945 TARGET_DEFAULT_FUNC (default_verify_memory);
947 /* Return the address of the start of the Thread Information Block
948 a Windows OS specific feature. */
949 int (*to_get_tib_address) (struct target_ops *,
950 ptid_t ptid, CORE_ADDR *addr)
951 TARGET_DEFAULT_NORETURN (tcomplain ());
953 /* Send the new settings of write permission variables. */
954 void (*to_set_permissions) (struct target_ops *)
955 TARGET_DEFAULT_IGNORE ();
957 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
958 with its details. Return 1 on success, 0 on failure. */
959 int (*to_static_tracepoint_marker_at) (struct target_ops *, CORE_ADDR,
960 struct static_tracepoint_marker *marker)
961 TARGET_DEFAULT_RETURN (0);
963 /* Return a vector of all tracepoints markers string id ID, or all
964 markers if ID is NULL. */
965 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid) (struct target_ops *, const char *id)
966 TARGET_DEFAULT_NORETURN (tcomplain ());
968 /* Return a traceframe info object describing the current
969 traceframe's contents. This method should not cache data;
970 higher layers take care of caching, invalidating, and
971 re-fetching when necessary. */
972 struct traceframe_info *(*to_traceframe_info) (struct target_ops *)
973 TARGET_DEFAULT_NORETURN (tcomplain ());
975 /* Ask the target to use or not to use agent according to USE. Return 1
976 successful, 0 otherwise. */
977 int (*to_use_agent) (struct target_ops *, int use)
978 TARGET_DEFAULT_NORETURN (tcomplain ());
980 /* Is the target able to use agent in current state? */
981 int (*to_can_use_agent) (struct target_ops *)
982 TARGET_DEFAULT_RETURN (0);
984 /* Check whether the target supports branch tracing. */
985 int (*to_supports_btrace) (struct target_ops *)
986 TARGET_DEFAULT_RETURN (0);
988 /* Enable branch tracing for PTID and allocate a branch trace target
989 information struct for reading and for disabling branch trace. */
990 struct btrace_target_info *(*to_enable_btrace) (struct target_ops *,
992 TARGET_DEFAULT_NORETURN (tcomplain ());
994 /* Disable branch tracing and deallocate TINFO. */
995 void (*to_disable_btrace) (struct target_ops *,
996 struct btrace_target_info *tinfo)
997 TARGET_DEFAULT_NORETURN (tcomplain ());
999 /* Disable branch tracing and deallocate TINFO. This function is similar
1000 to to_disable_btrace, except that it is called during teardown and is
1001 only allowed to perform actions that are safe. A counter-example would
1002 be attempting to talk to a remote target. */
1003 void (*to_teardown_btrace) (struct target_ops *,
1004 struct btrace_target_info *tinfo)
1005 TARGET_DEFAULT_NORETURN (tcomplain ());
1007 /* Read branch trace data for the thread indicated by BTINFO into DATA.
1008 DATA is cleared before new trace is added.
1009 The branch trace will start with the most recent block and continue
1010 towards older blocks. */
1011 enum btrace_error (*to_read_btrace) (struct target_ops *self,
1012 VEC (btrace_block_s) **data,
1013 struct btrace_target_info *btinfo,
1014 enum btrace_read_type type)
1015 TARGET_DEFAULT_NORETURN (tcomplain ());
1017 /* Stop trace recording. */
1018 void (*to_stop_recording) (struct target_ops *)
1019 TARGET_DEFAULT_IGNORE ();
1021 /* Print information about the recording. */
1022 void (*to_info_record) (struct target_ops *);
1024 /* Save the recorded execution trace into a file. */
1025 void (*to_save_record) (struct target_ops *, const char *filename)
1026 TARGET_DEFAULT_NORETURN (tcomplain ());
1028 /* Delete the recorded execution trace from the current position onwards. */
1029 void (*to_delete_record) (struct target_ops *)
1030 TARGET_DEFAULT_NORETURN (tcomplain ());
1032 /* Query if the record target is currently replaying. */
1033 int (*to_record_is_replaying) (struct target_ops *)
1034 TARGET_DEFAULT_RETURN (0);
1036 /* Go to the begin of the execution trace. */
1037 void (*to_goto_record_begin) (struct target_ops *)
1038 TARGET_DEFAULT_NORETURN (tcomplain ());
1040 /* Go to the end of the execution trace. */
1041 void (*to_goto_record_end) (struct target_ops *)
1042 TARGET_DEFAULT_NORETURN (tcomplain ());
1044 /* Go to a specific location in the recorded execution trace. */
1045 void (*to_goto_record) (struct target_ops *, ULONGEST insn)
1046 TARGET_DEFAULT_NORETURN (tcomplain ());
1048 /* Disassemble SIZE instructions in the recorded execution trace from
1049 the current position.
1050 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1051 disassemble SIZE succeeding instructions. */
1052 void (*to_insn_history) (struct target_ops *, int size, int flags)
1053 TARGET_DEFAULT_NORETURN (tcomplain ());
1055 /* Disassemble SIZE instructions in the recorded execution trace around
1057 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1058 disassemble SIZE instructions after FROM. */
1059 void (*to_insn_history_from) (struct target_ops *,
1060 ULONGEST from, int size, int flags)
1061 TARGET_DEFAULT_NORETURN (tcomplain ());
1063 /* Disassemble a section of the recorded execution trace from instruction
1064 BEGIN (inclusive) to instruction END (inclusive). */
1065 void (*to_insn_history_range) (struct target_ops *,
1066 ULONGEST begin, ULONGEST end, int flags)
1067 TARGET_DEFAULT_NORETURN (tcomplain ());
1069 /* Print a function trace of the recorded execution trace.
1070 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1071 succeeding functions. */
1072 void (*to_call_history) (struct target_ops *, int size, int flags)
1073 TARGET_DEFAULT_NORETURN (tcomplain ());
1075 /* Print a function trace of the recorded execution trace starting
1077 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1078 SIZE functions after FROM. */
1079 void (*to_call_history_from) (struct target_ops *,
1080 ULONGEST begin, int size, int flags)
1081 TARGET_DEFAULT_NORETURN (tcomplain ());
1083 /* Print a function trace of an execution trace section from function BEGIN
1084 (inclusive) to function END (inclusive). */
1085 void (*to_call_history_range) (struct target_ops *,
1086 ULONGEST begin, ULONGEST end, int flags)
1087 TARGET_DEFAULT_NORETURN (tcomplain ());
1089 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1091 int (*to_augmented_libraries_svr4_read) (struct target_ops *)
1092 TARGET_DEFAULT_RETURN (0);
1094 /* Those unwinders are tried before any other arch unwinders. If
1095 SELF doesn't have unwinders, it should delegate to the
1096 "beneath" target. */
1097 const struct frame_unwind *(*to_get_unwinder) (struct target_ops *self)
1098 TARGET_DEFAULT_RETURN (NULL);
1100 const struct frame_unwind *(*to_get_tailcall_unwinder) (struct target_ops *self)
1101 TARGET_DEFAULT_RETURN (NULL);
1103 /* Return the number of bytes by which the PC needs to be decremented
1104 after executing a breakpoint instruction.
1105 Defaults to gdbarch_decr_pc_after_break (GDBARCH). */
1106 CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
1107 struct gdbarch *gdbarch)
1108 TARGET_DEFAULT_FUNC (default_target_decr_pc_after_break);
1111 /* Need sub-structure for target machine related rather than comm related?
1115 /* Magic number for checking ops size. If a struct doesn't end with this
1116 number, somebody changed the declaration but didn't change all the
1117 places that initialize one. */
1119 #define OPS_MAGIC 3840
1121 /* The ops structure for our "current" target process. This should
1122 never be NULL. If there is no target, it points to the dummy_target. */
1124 extern struct target_ops current_target;
1126 /* Define easy words for doing these operations on our current target. */
1128 #define target_shortname (current_target.to_shortname)
1129 #define target_longname (current_target.to_longname)
1131 /* Does whatever cleanup is required for a target that we are no
1132 longer going to be calling. This routine is automatically always
1133 called after popping the target off the target stack - the target's
1134 own methods are no longer available through the target vector.
1135 Closing file descriptors and freeing all memory allocated memory are
1136 typical things it should do. */
1138 void target_close (struct target_ops *targ);
1140 /* Find the correct target to use for "attach". If a target on the
1141 current stack supports attaching, then it is returned. Otherwise,
1142 the default run target is returned. */
1144 extern struct target_ops *find_attach_target (void);
1146 /* Find the correct target to use for "run". If a target on the
1147 current stack supports creating a new inferior, then it is
1148 returned. Otherwise, the default run target is returned. */
1150 extern struct target_ops *find_run_target (void);
1152 /* Some targets don't generate traps when attaching to the inferior,
1153 or their target_attach implementation takes care of the waiting.
1154 These targets must set to_attach_no_wait. */
1156 #define target_attach_no_wait \
1157 (current_target.to_attach_no_wait)
1159 /* The target_attach operation places a process under debugger control,
1160 and stops the process.
1162 This operation provides a target-specific hook that allows the
1163 necessary bookkeeping to be performed after an attach completes. */
1164 #define target_post_attach(pid) \
1165 (*current_target.to_post_attach) (¤t_target, pid)
1167 /* Takes a program previously attached to and detaches it.
1168 The program may resume execution (some targets do, some don't) and will
1169 no longer stop on signals, etc. We better not have left any breakpoints
1170 in the program or it'll die when it hits one. ARGS is arguments
1171 typed by the user (e.g. a signal to send the process). FROM_TTY
1172 says whether to be verbose or not. */
1174 extern void target_detach (const char *, int);
1176 /* Disconnect from the current target without resuming it (leaving it
1177 waiting for a debugger). */
1179 extern void target_disconnect (char *, int);
1181 /* Resume execution of the target process PTID (or a group of
1182 threads). STEP says whether to single-step or to run free; SIGGNAL
1183 is the signal to be given to the target, or GDB_SIGNAL_0 for no
1184 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
1185 PTID means `step/resume only this process id'. A wildcard PTID
1186 (all threads, or all threads of process) means `step/resume
1187 INFERIOR_PTID, and let other threads (for which the wildcard PTID
1188 matches) resume with their 'thread->suspend.stop_signal' signal
1189 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1190 if in "no pass" state. */
1192 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1194 /* Wait for process pid to do something. PTID = -1 to wait for any
1195 pid to do something. Return pid of child, or -1 in case of error;
1196 store status through argument pointer STATUS. Note that it is
1197 _NOT_ OK to throw_exception() out of target_wait() without popping
1198 the debugging target from the stack; GDB isn't prepared to get back
1199 to the prompt with a debugging target but without the frame cache,
1200 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
1203 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1206 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
1208 extern void target_fetch_registers (struct regcache *regcache, int regno);
1210 /* Store at least register REGNO, or all regs if REGNO == -1.
1211 It can store as many registers as it wants to, so target_prepare_to_store
1212 must have been previously called. Calls error() if there are problems. */
1214 extern void target_store_registers (struct regcache *regcache, int regs);
1216 /* Get ready to modify the registers array. On machines which store
1217 individual registers, this doesn't need to do anything. On machines
1218 which store all the registers in one fell swoop, this makes sure
1219 that REGISTERS contains all the registers from the program being
1222 #define target_prepare_to_store(regcache) \
1223 (*current_target.to_prepare_to_store) (¤t_target, regcache)
1225 /* Determine current address space of thread PTID. */
1227 struct address_space *target_thread_address_space (ptid_t);
1229 /* Implement the "info proc" command. This returns one if the request
1230 was handled, and zero otherwise. It can also throw an exception if
1231 an error was encountered while attempting to handle the
1234 int target_info_proc (char *, enum info_proc_what);
1236 /* Returns true if this target can debug multiple processes
1239 #define target_supports_multi_process() \
1240 (*current_target.to_supports_multi_process) (¤t_target)
1242 /* Returns true if this target can disable address space randomization. */
1244 int target_supports_disable_randomization (void);
1246 /* Returns true if this target can enable and disable tracepoints
1247 while a trace experiment is running. */
1249 #define target_supports_enable_disable_tracepoint() \
1250 (*current_target.to_supports_enable_disable_tracepoint) (¤t_target)
1252 #define target_supports_string_tracing() \
1253 (*current_target.to_supports_string_tracing) (¤t_target)
1255 /* Returns true if this target can handle breakpoint conditions
1258 #define target_supports_evaluation_of_breakpoint_conditions() \
1259 (*current_target.to_supports_evaluation_of_breakpoint_conditions) (¤t_target)
1261 /* Returns true if this target can handle breakpoint commands
1264 #define target_can_run_breakpoint_commands() \
1265 (*current_target.to_can_run_breakpoint_commands) (¤t_target)
1267 extern int target_read_string (CORE_ADDR, char **, int, int *);
1269 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1272 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1275 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1277 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1279 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1282 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1285 /* Fetches the target's memory map. If one is found it is sorted
1286 and returned, after some consistency checking. Otherwise, NULL
1288 VEC(mem_region_s) *target_memory_map (void);
1290 /* Erase the specified flash region. */
1291 void target_flash_erase (ULONGEST address, LONGEST length);
1293 /* Finish a sequence of flash operations. */
1294 void target_flash_done (void);
1296 /* Describes a request for a memory write operation. */
1297 struct memory_write_request
1299 /* Begining address that must be written. */
1301 /* Past-the-end address. */
1303 /* The data to write. */
1305 /* A callback baton for progress reporting for this request. */
1308 typedef struct memory_write_request memory_write_request_s;
1309 DEF_VEC_O(memory_write_request_s);
1311 /* Enumeration specifying different flash preservation behaviour. */
1312 enum flash_preserve_mode
1318 /* Write several memory blocks at once. This version can be more
1319 efficient than making several calls to target_write_memory, in
1320 particular because it can optimize accesses to flash memory.
1322 Moreover, this is currently the only memory access function in gdb
1323 that supports writing to flash memory, and it should be used for
1324 all cases where access to flash memory is desirable.
1326 REQUESTS is the vector (see vec.h) of memory_write_request.
1327 PRESERVE_FLASH_P indicates what to do with blocks which must be
1328 erased, but not completely rewritten.
1329 PROGRESS_CB is a function that will be periodically called to provide
1330 feedback to user. It will be called with the baton corresponding
1331 to the request currently being written. It may also be called
1332 with a NULL baton, when preserved flash sectors are being rewritten.
1334 The function returns 0 on success, and error otherwise. */
1335 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1336 enum flash_preserve_mode preserve_flash_p,
1337 void (*progress_cb) (ULONGEST, void *));
1339 /* Print a line about the current target. */
1341 #define target_files_info() \
1342 (*current_target.to_files_info) (¤t_target)
1344 /* Insert a breakpoint at address BP_TGT->placed_address in
1345 the target machine. Returns 0 for success, and returns non-zero or
1346 throws an error (with a detailed failure reason error code and
1347 message) otherwise. */
1349 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1350 struct bp_target_info *bp_tgt);
1352 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1353 machine. Result is 0 for success, non-zero for error. */
1355 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1356 struct bp_target_info *bp_tgt);
1358 /* Initialize the terminal settings we record for the inferior,
1359 before we actually run the inferior. */
1361 #define target_terminal_init() \
1362 (*current_target.to_terminal_init) (¤t_target)
1364 /* Put the inferior's terminal settings into effect.
1365 This is preparation for starting or resuming the inferior. */
1367 extern void target_terminal_inferior (void);
1369 /* Put some of our terminal settings into effect,
1370 enough to get proper results from our output,
1371 but do not change into or out of RAW mode
1372 so that no input is discarded.
1374 After doing this, either terminal_ours or terminal_inferior
1375 should be called to get back to a normal state of affairs. */
1377 #define target_terminal_ours_for_output() \
1378 (*current_target.to_terminal_ours_for_output) (¤t_target)
1380 /* Put our terminal settings into effect.
1381 First record the inferior's terminal settings
1382 so they can be restored properly later. */
1384 #define target_terminal_ours() \
1385 (*current_target.to_terminal_ours) (¤t_target)
1387 /* Save our terminal settings.
1388 This is called from TUI after entering or leaving the curses
1389 mode. Since curses modifies our terminal this call is here
1390 to take this change into account. */
1392 #define target_terminal_save_ours() \
1393 (*current_target.to_terminal_save_ours) (¤t_target)
1395 /* Print useful information about our terminal status, if such a thing
1398 #define target_terminal_info(arg, from_tty) \
1399 (*current_target.to_terminal_info) (¤t_target, arg, from_tty)
1401 /* Kill the inferior process. Make it go away. */
1403 extern void target_kill (void);
1405 /* Load an executable file into the target process. This is expected
1406 to not only bring new code into the target process, but also to
1407 update GDB's symbol tables to match.
1409 ARG contains command-line arguments, to be broken down with
1410 buildargv (). The first non-switch argument is the filename to
1411 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1412 0)), which is an offset to apply to the load addresses of FILE's
1413 sections. The target may define switches, or other non-switch
1414 arguments, as it pleases. */
1416 extern void target_load (char *arg, int from_tty);
1418 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1419 notification of inferior events such as fork and vork immediately
1420 after the inferior is created. (This because of how gdb gets an
1421 inferior created via invoking a shell to do it. In such a scenario,
1422 if the shell init file has commands in it, the shell will fork and
1423 exec for each of those commands, and we will see each such fork
1426 Such targets will supply an appropriate definition for this function. */
1428 #define target_post_startup_inferior(ptid) \
1429 (*current_target.to_post_startup_inferior) (¤t_target, ptid)
1431 /* On some targets, we can catch an inferior fork or vfork event when
1432 it occurs. These functions insert/remove an already-created
1433 catchpoint for such events. They return 0 for success, 1 if the
1434 catchpoint type is not supported and -1 for failure. */
1436 #define target_insert_fork_catchpoint(pid) \
1437 (*current_target.to_insert_fork_catchpoint) (¤t_target, pid)
1439 #define target_remove_fork_catchpoint(pid) \
1440 (*current_target.to_remove_fork_catchpoint) (¤t_target, pid)
1442 #define target_insert_vfork_catchpoint(pid) \
1443 (*current_target.to_insert_vfork_catchpoint) (¤t_target, pid)
1445 #define target_remove_vfork_catchpoint(pid) \
1446 (*current_target.to_remove_vfork_catchpoint) (¤t_target, pid)
1448 /* If the inferior forks or vforks, this function will be called at
1449 the next resume in order to perform any bookkeeping and fiddling
1450 necessary to continue debugging either the parent or child, as
1451 requested, and releasing the other. Information about the fork
1452 or vfork event is available via get_last_target_status ().
1453 This function returns 1 if the inferior should not be resumed
1454 (i.e. there is another event pending). */
1456 int target_follow_fork (int follow_child, int detach_fork);
1458 /* On some targets, we can catch an inferior exec event when it
1459 occurs. These functions insert/remove an already-created
1460 catchpoint for such events. They return 0 for success, 1 if the
1461 catchpoint type is not supported and -1 for failure. */
1463 #define target_insert_exec_catchpoint(pid) \
1464 (*current_target.to_insert_exec_catchpoint) (¤t_target, pid)
1466 #define target_remove_exec_catchpoint(pid) \
1467 (*current_target.to_remove_exec_catchpoint) (¤t_target, pid)
1471 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1472 If NEEDED is zero, it means the target can disable the mechanism to
1473 catch system calls because there are no more catchpoints of this type.
1475 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1476 being requested. In this case, both TABLE_SIZE and TABLE should
1479 TABLE_SIZE is the number of elements in TABLE. It only matters if
1482 TABLE is an array of ints, indexed by syscall number. An element in
1483 this array is nonzero if that syscall should be caught. This argument
1484 only matters if ANY_COUNT is zero.
1486 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1489 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1490 (*current_target.to_set_syscall_catchpoint) (¤t_target, \
1491 pid, needed, any_count, \
1494 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1495 exit code of PID, if any. */
1497 #define target_has_exited(pid,wait_status,exit_status) \
1498 (*current_target.to_has_exited) (¤t_target, \
1499 pid,wait_status,exit_status)
1501 /* The debugger has completed a blocking wait() call. There is now
1502 some process event that must be processed. This function should
1503 be defined by those targets that require the debugger to perform
1504 cleanup or internal state changes in response to the process event. */
1506 /* The inferior process has died. Do what is right. */
1508 void target_mourn_inferior (void);
1510 /* Does target have enough data to do a run or attach command? */
1512 #define target_can_run(t) \
1513 ((t)->to_can_run) (t)
1515 /* Set list of signals to be handled in the target.
1517 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1518 (enum gdb_signal). For every signal whose entry in this array is
1519 non-zero, the target is allowed -but not required- to skip reporting
1520 arrival of the signal to the GDB core by returning from target_wait,
1521 and to pass the signal directly to the inferior instead.
1523 However, if the target is hardware single-stepping a thread that is
1524 about to receive a signal, it needs to be reported in any case, even
1525 if mentioned in a previous target_pass_signals call. */
1527 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1529 /* Set list of signals the target may pass to the inferior. This
1530 directly maps to the "handle SIGNAL pass/nopass" setting.
1532 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1533 number (enum gdb_signal). For every signal whose entry in this
1534 array is non-zero, the target is allowed to pass the signal to the
1535 inferior. Signals not present in the array shall be silently
1536 discarded. This does not influence whether to pass signals to the
1537 inferior as a result of a target_resume call. This is useful in
1538 scenarios where the target needs to decide whether to pass or not a
1539 signal to the inferior without GDB core involvement, such as for
1540 example, when detaching (as threads may have been suspended with
1541 pending signals not reported to GDB). */
1543 extern void target_program_signals (int nsig, unsigned char *program_signals);
1545 /* Check to see if a thread is still alive. */
1547 extern int target_thread_alive (ptid_t ptid);
1549 /* Query for new threads and add them to the thread list. */
1551 extern void target_find_new_threads (void);
1553 /* Make target stop in a continuable fashion. (For instance, under
1554 Unix, this should act like SIGSTOP). This function is normally
1555 used by GUIs to implement a stop button. */
1557 extern void target_stop (ptid_t ptid);
1559 /* Send the specified COMMAND to the target's monitor
1560 (shell,interpreter) for execution. The result of the query is
1561 placed in OUTBUF. */
1563 #define target_rcmd(command, outbuf) \
1564 (*current_target.to_rcmd) (¤t_target, command, outbuf)
1567 /* Does the target include all of memory, or only part of it? This
1568 determines whether we look up the target chain for other parts of
1569 memory if this target can't satisfy a request. */
1571 extern int target_has_all_memory_1 (void);
1572 #define target_has_all_memory target_has_all_memory_1 ()
1574 /* Does the target include memory? (Dummy targets don't.) */
1576 extern int target_has_memory_1 (void);
1577 #define target_has_memory target_has_memory_1 ()
1579 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1580 we start a process.) */
1582 extern int target_has_stack_1 (void);
1583 #define target_has_stack target_has_stack_1 ()
1585 /* Does the target have registers? (Exec files don't.) */
1587 extern int target_has_registers_1 (void);
1588 #define target_has_registers target_has_registers_1 ()
1590 /* Does the target have execution? Can we make it jump (through
1591 hoops), or pop its stack a few times? This means that the current
1592 target is currently executing; for some targets, that's the same as
1593 whether or not the target is capable of execution, but there are
1594 also targets which can be current while not executing. In that
1595 case this will become true after to_create_inferior or
1598 extern int target_has_execution_1 (ptid_t);
1600 /* Like target_has_execution_1, but always passes inferior_ptid. */
1602 extern int target_has_execution_current (void);
1604 #define target_has_execution target_has_execution_current ()
1606 /* Default implementations for process_stratum targets. Return true
1607 if there's a selected inferior, false otherwise. */
1609 extern int default_child_has_all_memory (struct target_ops *ops);
1610 extern int default_child_has_memory (struct target_ops *ops);
1611 extern int default_child_has_stack (struct target_ops *ops);
1612 extern int default_child_has_registers (struct target_ops *ops);
1613 extern int default_child_has_execution (struct target_ops *ops,
1616 /* Can the target support the debugger control of thread execution?
1617 Can it lock the thread scheduler? */
1619 #define target_can_lock_scheduler \
1620 (current_target.to_has_thread_control & tc_schedlock)
1622 /* Controls whether async mode is permitted. */
1623 extern int target_async_permitted;
1625 /* Can the target support asynchronous execution? */
1626 #define target_can_async_p() (current_target.to_can_async_p (¤t_target))
1628 /* Is the target in asynchronous execution mode? */
1629 #define target_is_async_p() (current_target.to_is_async_p (¤t_target))
1631 /* Put the target in async mode with the specified callback function. */
1632 #define target_async(CALLBACK,CONTEXT) \
1633 (current_target.to_async (¤t_target, (CALLBACK), (CONTEXT)))
1635 #define target_execution_direction() \
1636 (current_target.to_execution_direction (¤t_target))
1638 /* Converts a process id to a string. Usually, the string just contains
1639 `process xyz', but on some systems it may contain
1640 `process xyz thread abc'. */
1642 extern char *target_pid_to_str (ptid_t ptid);
1644 extern char *normal_pid_to_str (ptid_t ptid);
1646 /* Return a short string describing extra information about PID,
1647 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1650 #define target_extra_thread_info(TP) \
1651 (current_target.to_extra_thread_info (¤t_target, TP))
1653 /* Return the thread's name. A NULL result means that the target
1654 could not determine this thread's name. */
1656 extern char *target_thread_name (struct thread_info *);
1658 /* Attempts to find the pathname of the executable file
1659 that was run to create a specified process.
1661 The process PID must be stopped when this operation is used.
1663 If the executable file cannot be determined, NULL is returned.
1665 Else, a pointer to a character string containing the pathname
1666 is returned. This string should be copied into a buffer by
1667 the client if the string will not be immediately used, or if
1670 #define target_pid_to_exec_file(pid) \
1671 (current_target.to_pid_to_exec_file) (¤t_target, pid)
1673 /* See the to_thread_architecture description in struct target_ops. */
1675 #define target_thread_architecture(ptid) \
1676 (current_target.to_thread_architecture (¤t_target, ptid))
1679 * Iterator function for target memory regions.
1680 * Calls a callback function once for each memory region 'mapped'
1681 * in the child process. Defined as a simple macro rather than
1682 * as a function macro so that it can be tested for nullity.
1685 #define target_find_memory_regions(FUNC, DATA) \
1686 (current_target.to_find_memory_regions) (¤t_target, FUNC, DATA)
1689 * Compose corefile .note section.
1692 #define target_make_corefile_notes(BFD, SIZE_P) \
1693 (current_target.to_make_corefile_notes) (¤t_target, BFD, SIZE_P)
1695 /* Bookmark interfaces. */
1696 #define target_get_bookmark(ARGS, FROM_TTY) \
1697 (current_target.to_get_bookmark) (¤t_target, ARGS, FROM_TTY)
1699 #define target_goto_bookmark(ARG, FROM_TTY) \
1700 (current_target.to_goto_bookmark) (¤t_target, ARG, FROM_TTY)
1702 /* Hardware watchpoint interfaces. */
1704 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1705 write). Only the INFERIOR_PTID task is being queried. */
1707 #define target_stopped_by_watchpoint() \
1708 ((*current_target.to_stopped_by_watchpoint) (¤t_target))
1710 /* Non-zero if we have steppable watchpoints */
1712 #define target_have_steppable_watchpoint \
1713 (current_target.to_have_steppable_watchpoint)
1715 /* Non-zero if we have continuable watchpoints */
1717 #define target_have_continuable_watchpoint \
1718 (current_target.to_have_continuable_watchpoint)
1720 /* Provide defaults for hardware watchpoint functions. */
1722 /* If the *_hw_beakpoint functions have not been defined
1723 elsewhere use the definitions in the target vector. */
1725 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1726 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1727 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1728 (including this one?). OTHERTYPE is who knows what... */
1730 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1731 (*current_target.to_can_use_hw_breakpoint) (¤t_target, \
1732 TYPE, CNT, OTHERTYPE);
1734 /* Returns the number of debug registers needed to watch the given
1735 memory region, or zero if not supported. */
1737 #define target_region_ok_for_hw_watchpoint(addr, len) \
1738 (*current_target.to_region_ok_for_hw_watchpoint) (¤t_target, \
1742 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1743 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1744 COND is the expression for its condition, or NULL if there's none.
1745 Returns 0 for success, 1 if the watchpoint type is not supported,
1748 #define target_insert_watchpoint(addr, len, type, cond) \
1749 (*current_target.to_insert_watchpoint) (¤t_target, \
1750 addr, len, type, cond)
1752 #define target_remove_watchpoint(addr, len, type, cond) \
1753 (*current_target.to_remove_watchpoint) (¤t_target, \
1754 addr, len, type, cond)
1756 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1757 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1758 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1759 masked watchpoints are not supported, -1 for failure. */
1761 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1763 /* Remove a masked watchpoint at ADDR with the mask MASK.
1764 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1765 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1768 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1770 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1771 the target machine. Returns 0 for success, and returns non-zero or
1772 throws an error (with a detailed failure reason error code and
1773 message) otherwise. */
1775 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1776 (*current_target.to_insert_hw_breakpoint) (¤t_target, \
1779 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1780 (*current_target.to_remove_hw_breakpoint) (¤t_target, \
1783 /* Return number of debug registers needed for a ranged breakpoint,
1784 or -1 if ranged breakpoints are not supported. */
1786 extern int target_ranged_break_num_registers (void);
1788 /* Return non-zero if target knows the data address which triggered this
1789 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1790 INFERIOR_PTID task is being queried. */
1791 #define target_stopped_data_address(target, addr_p) \
1792 (*target.to_stopped_data_address) (target, addr_p)
1794 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1795 LENGTH bytes beginning at START. */
1796 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1797 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1799 /* Return non-zero if the target is capable of using hardware to evaluate
1800 the condition expression. In this case, if the condition is false when
1801 the watched memory location changes, execution may continue without the
1802 debugger being notified.
1804 Due to limitations in the hardware implementation, it may be capable of
1805 avoiding triggering the watchpoint in some cases where the condition
1806 expression is false, but may report some false positives as well.
1807 For this reason, GDB will still evaluate the condition expression when
1808 the watchpoint triggers. */
1809 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1810 (*current_target.to_can_accel_watchpoint_condition) (¤t_target, \
1811 addr, len, type, cond)
1813 /* Return number of debug registers needed for a masked watchpoint,
1814 -1 if masked watchpoints are not supported or -2 if the given address
1815 and mask combination cannot be used. */
1817 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1819 /* Target can execute in reverse? */
1820 #define target_can_execute_reverse \
1821 current_target.to_can_execute_reverse (¤t_target)
1823 extern const struct target_desc *target_read_description (struct target_ops *);
1825 #define target_get_ada_task_ptid(lwp, tid) \
1826 (*current_target.to_get_ada_task_ptid) (¤t_target, lwp,tid)
1828 /* Utility implementation of searching memory. */
1829 extern int simple_search_memory (struct target_ops* ops,
1830 CORE_ADDR start_addr,
1831 ULONGEST search_space_len,
1832 const gdb_byte *pattern,
1833 ULONGEST pattern_len,
1834 CORE_ADDR *found_addrp);
1836 /* Main entry point for searching memory. */
1837 extern int target_search_memory (CORE_ADDR start_addr,
1838 ULONGEST search_space_len,
1839 const gdb_byte *pattern,
1840 ULONGEST pattern_len,
1841 CORE_ADDR *found_addrp);
1843 /* Target file operations. */
1845 /* Open FILENAME on the target, using FLAGS and MODE. Return a
1846 target file descriptor, or -1 if an error occurs (and set
1848 extern int target_fileio_open (const char *filename, int flags, int mode,
1851 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1852 Return the number of bytes written, or -1 if an error occurs
1853 (and set *TARGET_ERRNO). */
1854 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1855 ULONGEST offset, int *target_errno);
1857 /* Read up to LEN bytes FD on the target into READ_BUF.
1858 Return the number of bytes read, or -1 if an error occurs
1859 (and set *TARGET_ERRNO). */
1860 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1861 ULONGEST offset, int *target_errno);
1863 /* Close FD on the target. Return 0, or -1 if an error occurs
1864 (and set *TARGET_ERRNO). */
1865 extern int target_fileio_close (int fd, int *target_errno);
1867 /* Unlink FILENAME on the target. Return 0, or -1 if an error
1868 occurs (and set *TARGET_ERRNO). */
1869 extern int target_fileio_unlink (const char *filename, int *target_errno);
1871 /* Read value of symbolic link FILENAME on the target. Return a
1872 null-terminated string allocated via xmalloc, or NULL if an error
1873 occurs (and set *TARGET_ERRNO). */
1874 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1876 /* Read target file FILENAME. The return value will be -1 if the transfer
1877 fails or is not supported; 0 if the object is empty; or the length
1878 of the object otherwise. If a positive value is returned, a
1879 sufficiently large buffer will be allocated using xmalloc and
1880 returned in *BUF_P containing the contents of the object.
1882 This method should be used for objects sufficiently small to store
1883 in a single xmalloc'd buffer, when no fixed bound on the object's
1884 size is known in advance. */
1885 extern LONGEST target_fileio_read_alloc (const char *filename,
1888 /* Read target file FILENAME. The result is NUL-terminated and
1889 returned as a string, allocated using xmalloc. If an error occurs
1890 or the transfer is unsupported, NULL is returned. Empty objects
1891 are returned as allocated but empty strings. A warning is issued
1892 if the result contains any embedded NUL bytes. */
1893 extern char *target_fileio_read_stralloc (const char *filename);
1896 /* Tracepoint-related operations. */
1898 #define target_trace_init() \
1899 (*current_target.to_trace_init) (¤t_target)
1901 #define target_download_tracepoint(t) \
1902 (*current_target.to_download_tracepoint) (¤t_target, t)
1904 #define target_can_download_tracepoint() \
1905 (*current_target.to_can_download_tracepoint) (¤t_target)
1907 #define target_download_trace_state_variable(tsv) \
1908 (*current_target.to_download_trace_state_variable) (¤t_target, tsv)
1910 #define target_enable_tracepoint(loc) \
1911 (*current_target.to_enable_tracepoint) (¤t_target, loc)
1913 #define target_disable_tracepoint(loc) \
1914 (*current_target.to_disable_tracepoint) (¤t_target, loc)
1916 #define target_trace_start() \
1917 (*current_target.to_trace_start) (¤t_target)
1919 #define target_trace_set_readonly_regions() \
1920 (*current_target.to_trace_set_readonly_regions) (¤t_target)
1922 #define target_get_trace_status(ts) \
1923 (*current_target.to_get_trace_status) (¤t_target, ts)
1925 #define target_get_tracepoint_status(tp,utp) \
1926 (*current_target.to_get_tracepoint_status) (¤t_target, tp, utp)
1928 #define target_trace_stop() \
1929 (*current_target.to_trace_stop) (¤t_target)
1931 #define target_trace_find(type,num,addr1,addr2,tpp) \
1932 (*current_target.to_trace_find) (¤t_target, \
1933 (type), (num), (addr1), (addr2), (tpp))
1935 #define target_get_trace_state_variable_value(tsv,val) \
1936 (*current_target.to_get_trace_state_variable_value) (¤t_target, \
1939 #define target_save_trace_data(filename) \
1940 (*current_target.to_save_trace_data) (¤t_target, filename)
1942 #define target_upload_tracepoints(utpp) \
1943 (*current_target.to_upload_tracepoints) (¤t_target, utpp)
1945 #define target_upload_trace_state_variables(utsvp) \
1946 (*current_target.to_upload_trace_state_variables) (¤t_target, utsvp)
1948 #define target_get_raw_trace_data(buf,offset,len) \
1949 (*current_target.to_get_raw_trace_data) (¤t_target, \
1950 (buf), (offset), (len))
1952 #define target_get_min_fast_tracepoint_insn_len() \
1953 (*current_target.to_get_min_fast_tracepoint_insn_len) (¤t_target)
1955 #define target_set_disconnected_tracing(val) \
1956 (*current_target.to_set_disconnected_tracing) (¤t_target, val)
1958 #define target_set_circular_trace_buffer(val) \
1959 (*current_target.to_set_circular_trace_buffer) (¤t_target, val)
1961 #define target_set_trace_buffer_size(val) \
1962 (*current_target.to_set_trace_buffer_size) (¤t_target, val)
1964 #define target_set_trace_notes(user,notes,stopnotes) \
1965 (*current_target.to_set_trace_notes) (¤t_target, \
1966 (user), (notes), (stopnotes))
1968 #define target_get_tib_address(ptid, addr) \
1969 (*current_target.to_get_tib_address) (¤t_target, (ptid), (addr))
1971 #define target_set_permissions() \
1972 (*current_target.to_set_permissions) (¤t_target)
1974 #define target_static_tracepoint_marker_at(addr, marker) \
1975 (*current_target.to_static_tracepoint_marker_at) (¤t_target, \
1978 #define target_static_tracepoint_markers_by_strid(marker_id) \
1979 (*current_target.to_static_tracepoint_markers_by_strid) (¤t_target, \
1982 #define target_traceframe_info() \
1983 (*current_target.to_traceframe_info) (¤t_target)
1985 #define target_use_agent(use) \
1986 (*current_target.to_use_agent) (¤t_target, use)
1988 #define target_can_use_agent() \
1989 (*current_target.to_can_use_agent) (¤t_target)
1991 #define target_augmented_libraries_svr4_read() \
1992 (*current_target.to_augmented_libraries_svr4_read) (¤t_target)
1994 /* Command logging facility. */
1996 #define target_log_command(p) \
1997 (*current_target.to_log_command) (¤t_target, p)
2000 extern int target_core_of_thread (ptid_t ptid);
2002 /* See to_get_unwinder in struct target_ops. */
2003 extern const struct frame_unwind *target_get_unwinder (void);
2005 /* See to_get_tailcall_unwinder in struct target_ops. */
2006 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
2008 /* This implements basic memory verification, reading target memory
2009 and performing the comparison here (as opposed to accelerated
2010 verification making use of the qCRC packet, for example). */
2012 extern int simple_verify_memory (struct target_ops* ops,
2013 const gdb_byte *data,
2014 CORE_ADDR memaddr, ULONGEST size);
2016 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2017 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2018 if there's a mismatch, and -1 if an error is encountered while
2019 reading memory. Throws an error if the functionality is found not
2020 to be supported by the current target. */
2021 int target_verify_memory (const gdb_byte *data,
2022 CORE_ADDR memaddr, ULONGEST size);
2024 /* Routines for maintenance of the target structures...
2026 complete_target_initialization: Finalize a target_ops by filling in
2027 any fields needed by the target implementation. Unnecessary for
2028 targets which are registered via add_target, as this part gets
2031 add_target: Add a target to the list of all possible targets.
2032 This only makes sense for targets that should be activated using
2033 the "target TARGET_NAME ..." command.
2035 push_target: Make this target the top of the stack of currently used
2036 targets, within its particular stratum of the stack. Result
2037 is 0 if now atop the stack, nonzero if not on top (maybe
2040 unpush_target: Remove this from the stack of currently used targets,
2041 no matter where it is on the list. Returns 0 if no
2042 change, 1 if removed from stack. */
2044 extern void add_target (struct target_ops *);
2046 extern void add_target_with_completer (struct target_ops *t,
2047 completer_ftype *completer);
2049 extern void complete_target_initialization (struct target_ops *t);
2051 /* Adds a command ALIAS for target T and marks it deprecated. This is useful
2052 for maintaining backwards compatibility when renaming targets. */
2054 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
2056 extern void push_target (struct target_ops *);
2058 extern int unpush_target (struct target_ops *);
2060 extern void target_pre_inferior (int);
2062 extern void target_preopen (int);
2064 /* Does whatever cleanup is required to get rid of all pushed targets. */
2065 extern void pop_all_targets (void);
2067 /* Like pop_all_targets, but pops only targets whose stratum is
2068 strictly above ABOVE_STRATUM. */
2069 extern void pop_all_targets_above (enum strata above_stratum);
2071 extern int target_is_pushed (struct target_ops *t);
2073 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2076 /* Struct target_section maps address ranges to file sections. It is
2077 mostly used with BFD files, but can be used without (e.g. for handling
2078 raw disks, or files not in formats handled by BFD). */
2080 struct target_section
2082 CORE_ADDR addr; /* Lowest address in section */
2083 CORE_ADDR endaddr; /* 1+highest address in section */
2085 struct bfd_section *the_bfd_section;
2087 /* The "owner" of the section.
2088 It can be any unique value. It is set by add_target_sections
2089 and used by remove_target_sections.
2090 For example, for executables it is a pointer to exec_bfd and
2091 for shlibs it is the so_list pointer. */
2095 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2097 struct target_section_table
2099 struct target_section *sections;
2100 struct target_section *sections_end;
2103 /* Return the "section" containing the specified address. */
2104 struct target_section *target_section_by_addr (struct target_ops *target,
2107 /* Return the target section table this target (or the targets
2108 beneath) currently manipulate. */
2110 extern struct target_section_table *target_get_section_table
2111 (struct target_ops *target);
2113 /* From mem-break.c */
2115 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
2116 struct bp_target_info *);
2118 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
2119 struct bp_target_info *);
2121 /* Check whether the memory at the breakpoint's placed address still
2122 contains the expected breakpoint instruction. */
2124 extern int memory_validate_breakpoint (struct gdbarch *gdbarch,
2125 struct bp_target_info *bp_tgt);
2127 extern int default_memory_remove_breakpoint (struct gdbarch *,
2128 struct bp_target_info *);
2130 extern int default_memory_insert_breakpoint (struct gdbarch *,
2131 struct bp_target_info *);
2136 extern void initialize_targets (void);
2138 extern void noprocess (void) ATTRIBUTE_NORETURN;
2140 extern void target_require_runnable (void);
2142 extern void find_default_attach (struct target_ops *, char *, int);
2144 extern void find_default_create_inferior (struct target_ops *,
2145 char *, char *, char **, int);
2147 extern struct target_ops *find_target_beneath (struct target_ops *);
2149 /* Find the target at STRATUM. If no target is at that stratum,
2152 struct target_ops *find_target_at (enum strata stratum);
2154 /* Read OS data object of type TYPE from the target, and return it in
2155 XML format. The result is NUL-terminated and returned as a string,
2156 allocated using xmalloc. If an error occurs or the transfer is
2157 unsupported, NULL is returned. Empty objects are returned as
2158 allocated but empty strings. */
2160 extern char *target_get_osdata (const char *type);
2163 /* Stuff that should be shared among the various remote targets. */
2165 /* Debugging level. 0 is off, and non-zero values mean to print some debug
2166 information (higher values, more information). */
2167 extern int remote_debug;
2169 /* Speed in bits per second, or -1 which means don't mess with the speed. */
2170 extern int baud_rate;
2171 /* Timeout limit for response from target. */
2172 extern int remote_timeout;
2176 /* Set the show memory breakpoints mode to show, and installs a cleanup
2177 to restore it back to the current value. */
2178 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2180 extern int may_write_registers;
2181 extern int may_write_memory;
2182 extern int may_insert_breakpoints;
2183 extern int may_insert_tracepoints;
2184 extern int may_insert_fast_tracepoints;
2185 extern int may_stop;
2187 extern void update_target_permissions (void);
2190 /* Imported from machine dependent code. */
2192 /* See to_supports_btrace in struct target_ops. */
2193 #define target_supports_btrace() \
2194 (current_target.to_supports_btrace (¤t_target))
2196 /* See to_enable_btrace in struct target_ops. */
2197 extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2199 /* See to_disable_btrace in struct target_ops. */
2200 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2202 /* See to_teardown_btrace in struct target_ops. */
2203 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2205 /* See to_read_btrace in struct target_ops. */
2206 extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2207 struct btrace_target_info *,
2208 enum btrace_read_type);
2210 /* See to_stop_recording in struct target_ops. */
2211 extern void target_stop_recording (void);
2213 /* See to_info_record in struct target_ops. */
2214 extern void target_info_record (void);
2216 /* See to_save_record in struct target_ops. */
2217 extern void target_save_record (const char *filename);
2219 /* Query if the target supports deleting the execution log. */
2220 extern int target_supports_delete_record (void);
2222 /* See to_delete_record in struct target_ops. */
2223 extern void target_delete_record (void);
2225 /* See to_record_is_replaying in struct target_ops. */
2226 extern int target_record_is_replaying (void);
2228 /* See to_goto_record_begin in struct target_ops. */
2229 extern void target_goto_record_begin (void);
2231 /* See to_goto_record_end in struct target_ops. */
2232 extern void target_goto_record_end (void);
2234 /* See to_goto_record in struct target_ops. */
2235 extern void target_goto_record (ULONGEST insn);
2237 /* See to_insn_history. */
2238 extern void target_insn_history (int size, int flags);
2240 /* See to_insn_history_from. */
2241 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2243 /* See to_insn_history_range. */
2244 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2246 /* See to_call_history. */
2247 extern void target_call_history (int size, int flags);
2249 /* See to_call_history_from. */
2250 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2252 /* See to_call_history_range. */
2253 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2255 /* See to_decr_pc_after_break. Start searching for the target at OPS. */
2256 extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2257 struct gdbarch *gdbarch);
2259 /* See to_decr_pc_after_break. */
2260 extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2262 #endif /* !defined (TARGET_H) */