]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/target.h
record-btrace, frame: supply target-specific unwinder
[thirdparty/binutils-gdb.git] / gdb / target.h
CommitLineData
c906108c 1/* Interface between GDB and target environments, including files and processes
0088c768 2
ecd75fc8 3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
0088c768 4
c906108c
SS
5 Contributed by Cygnus Support. Written by John Gilmore.
6
c5aa993b 7 This file is part of GDB.
c906108c 8
c5aa993b
JM
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
a9762ec7 11 the Free Software Foundation; either version 3 of the License, or
c5aa993b 12 (at your option) any later version.
c906108c 13
c5aa993b
JM
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.
c906108c 18
c5aa993b 19 You should have received a copy of the GNU General Public License
a9762ec7 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
21
22#if !defined (TARGET_H)
23#define TARGET_H
24
da3331ec
AC
25struct objfile;
26struct ui_file;
27struct mem_attrib;
1e3ff5ad 28struct target_ops;
d248b706 29struct bp_location;
8181d85f 30struct bp_target_info;
56be3814 31struct regcache;
07b82ea5 32struct target_section_table;
35b1e5cc 33struct trace_state_variable;
00bf0b85
SS
34struct trace_status;
35struct uploaded_tsv;
36struct uploaded_tp;
0fb4aa4b 37struct static_tracepoint_marker;
b3b9301e 38struct traceframe_info;
0cf6dd15 39struct expression;
2a2f9fe4 40struct dcache_struct;
0cf6dd15 41
c906108c
SS
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
45 target.
46
2146d243
RM
47 A TARGET is an interface between the debugger and a particular
48 kind of file or process. Targets can be STACKED in STRATA,
c906108c
SS
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
59 stratum. */
60
33b60d58
LM
61#include "target/resume.h"
62#include "target/wait.h"
63#include "target/waitstatus.h"
c906108c
SS
64#include "bfd.h"
65#include "symtab.h"
29e57380 66#include "memattr.h"
fd79ecee 67#include "vec.h"
2aecd87f 68#include "gdb_signals.h"
02d27625 69#include "btrace.h"
9852c492 70#include "command.h"
c906108c 71
c5aa993b
JM
72enum strata
73 {
74 dummy_stratum, /* The lowest of the low */
75 file_stratum, /* Executable files, etc */
c0edd9ed 76 process_stratum, /* Executing processes or core dump files */
81e64f55 77 thread_stratum, /* Executing threads */
85e747d2
UW
78 record_stratum, /* Support record debugging */
79 arch_stratum /* Architecture overrides */
c5aa993b 80 };
c906108c 81
c5aa993b
JM
82enum thread_control_capabilities
83 {
0d06e24b
JM
84 tc_none = 0, /* Default: can't control thread execution. */
85 tc_schedlock = 1, /* Can lock the thread scheduler. */
c5aa993b 86 };
c906108c 87
a96d9b2e
SDJ
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.
91
92 It's also good to mention that its fields represent everything
93 that we currently know about a syscall in GDB. */
94struct syscall
95 {
96 /* The syscall number. */
97 int number;
98
99 /* The syscall name. */
100 const char *name;
101 };
102
f00150c9
DE
103/* Return a pretty printed form of target_waitstatus.
104 Space for the result is malloc'd, caller must free. */
105extern char *target_waitstatus_to_string (const struct target_waitstatus *);
106
09826ec5
PA
107/* Return a pretty printed form of TARGET_OPTIONS.
108 Space for the result is malloc'd, caller must free. */
109extern char *target_options_to_string (int target_options);
110
2acceee2 111/* Possible types of events that the inferior handler will have to
0d06e24b 112 deal with. */
2acceee2
JM
113enum inferior_event_type
114 {
2acceee2 115 /* Process a normal inferior event which will result in target_wait
0d06e24b 116 being called. */
2146d243 117 INF_REG_EVENT,
0d06e24b 118 /* We are called because a timer went off. */
2acceee2 119 INF_TIMER,
0d06e24b 120 /* We are called to do stuff after the inferior stops. */
c2d11a7d
JM
121 INF_EXEC_COMPLETE,
122 /* We are called to do some stuff after the inferior stops, but we
123 are expected to reenter the proceed() and
c378eb4e 124 handle_inferior_event() functions. This is used only in case of
0d06e24b 125 'step n' like commands. */
c2d11a7d 126 INF_EXEC_CONTINUE
2acceee2 127 };
c906108c 128\f
13547ab6
DJ
129/* Target objects which can be transfered using target_read,
130 target_write, et cetera. */
1e3ff5ad
AC
131
132enum target_object
133{
1e3ff5ad
AC
134 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
135 TARGET_OBJECT_AVR,
23d964e7
UW
136 /* SPU target specific transfer. See "spu-tdep.c". */
137 TARGET_OBJECT_SPU,
1e3ff5ad 138 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
287a334e 139 TARGET_OBJECT_MEMORY,
cf7a04e8
DJ
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,
4e5d721f
DE
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
146 "normal" RAM. */
147 TARGET_OBJECT_STACK_MEMORY,
29453a14
YQ
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,
287a334e
JJ
151 /* Kernel Unwind Table. See "ia64-tdep.c". */
152 TARGET_OBJECT_UNWIND_TABLE,
2146d243
RM
153 /* Transfer auxilliary vector. */
154 TARGET_OBJECT_AUXV,
baf92889 155 /* StackGhost cookie. See "sparc-tdep.c". */
fd79ecee
DJ
156 TARGET_OBJECT_WCOOKIE,
157 /* Target memory map in XML format. */
158 TARGET_OBJECT_MEMORY_MAP,
a76d924d
DJ
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. */
23181151
DJ
163 TARGET_OBJECT_FLASH,
164 /* Available target-specific features, e.g. registers and coprocessors.
165 See "target-descriptions.c". ANNEX should never be empty. */
cfa9d6d9
DJ
166 TARGET_OBJECT_AVAILABLE_FEATURES,
167 /* Currently loaded libraries, in XML format. */
07e059b5 168 TARGET_OBJECT_LIBRARIES,
2268b414
JK
169 /* Currently loaded libraries specific for SVR4 systems, in XML format. */
170 TARGET_OBJECT_LIBRARIES_SVR4,
4d1eb6b4 171 /* Currently loaded libraries specific to AIX systems, in XML format. */
ff99b71b 172 TARGET_OBJECT_LIBRARIES_AIX,
07e059b5 173 /* Get OS specific data. The ANNEX specifies the type (running
113a6f1e
JB
174 processes, etc.). The data being transfered is expected to follow
175 the DTD specified in features/osdata.dtd. */
4aa995e1
PA
176 TARGET_OBJECT_OSDATA,
177 /* Extra signal info. Usually the contents of `siginfo_t' on unix
178 platforms. */
179 TARGET_OBJECT_SIGNAL_INFO,
dc146f7c
VP
180 /* The list of threads that are being debugged. */
181 TARGET_OBJECT_THREADS,
0fb4aa4b
PA
182 /* Collected static trace data. */
183 TARGET_OBJECT_STATIC_TRACE_DATA,
77ca787b
JB
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,
c4de7027
JB
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.
189
190 The size of the data transfered is always 8 bytes (the size of an
191 address on ia64). */
192 TARGET_OBJECT_HPUX_SOLIB_GOT,
b3b9301e
PA
193 /* Traceframe info, in XML format. */
194 TARGET_OBJECT_TRACEFRAME_INFO,
78d85199
YQ
195 /* Load maps for FDPIC systems. */
196 TARGET_OBJECT_FDPIC,
f00c55f8 197 /* Darwin dynamic linker info data. */
169081d0
TG
198 TARGET_OBJECT_DARWIN_DYLD_INFO,
199 /* OpenVMS Unwind Information Block. */
02d27625 200 TARGET_OBJECT_OPENVMS_UIB,
9accd112
MM
201 /* Branch trace data, in XML format. */
202 TARGET_OBJECT_BTRACE
c378eb4e 203 /* Possible future objects: TARGET_OBJECT_FILE, ... */
1e3ff5ad
AC
204};
205
6be7b56e
PA
206/* Possible error codes returned by target_xfer_partial, etc. */
207
208enum target_xfer_error
209{
210 /* Generic I/O error. Note that it's important that this is '-1',
211 as we still have target_xfer-related code returning hardcoded
212 '-1' on error. */
213 TARGET_XFER_E_IO = -1,
214
215 /* Transfer failed because the piece of the object requested is
216 unavailable. */
217 TARGET_XFER_E_UNAVAILABLE = -2,
218
219 /* Keep list in sync with target_xfer_error_to_string. */
220};
221
222/* Return the string form of ERR. */
223
224extern const char *target_xfer_error_to_string (enum target_xfer_error err);
225
35b1e5cc
SS
226/* Enumeration of the kinds of traceframe searches that a target may
227 be able to perform. */
228
229enum trace_find_type
230 {
231 tfind_number,
232 tfind_pc,
233 tfind_tp,
234 tfind_range,
235 tfind_outside,
236 };
237
0fb4aa4b
PA
238typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
239DEF_VEC_P(static_tracepoint_marker_p);
240
4ac248ca
YQ
241typedef LONGEST
242 target_xfer_partial_ftype (struct target_ops *ops,
243 enum target_object object,
244 const char *annex,
245 gdb_byte *readbuf,
246 const gdb_byte *writebuf,
247 ULONGEST offset,
b55e14c7 248 ULONGEST len);
4ac248ca 249
13547ab6
DJ
250/* Request that OPS transfer up to LEN 8-bit bytes of the target's
251 OBJECT. The OFFSET, for a seekable object, specifies the
252 starting point. The ANNEX can be used to provide additional
253 data-specific information to the target.
1e3ff5ad 254
578d3588
PA
255 Return the number of bytes actually transfered, or a negative error
256 code (an 'enum target_xfer_error' value) if the transfer is not
257 supported or otherwise fails. Return of a positive value less than
258 LEN indicates that no further transfer is possible. Unlike the raw
259 to_xfer_partial interface, callers of these functions do not need
260 to retry partial transfers. */
1e3ff5ad 261
1e3ff5ad
AC
262extern LONGEST target_read (struct target_ops *ops,
263 enum target_object object,
1b0ba102 264 const char *annex, gdb_byte *buf,
1e3ff5ad
AC
265 ULONGEST offset, LONGEST len);
266
8dedea02
VP
267struct memory_read_result
268 {
c378eb4e 269 /* First address that was read. */
8dedea02
VP
270 ULONGEST begin;
271 /* Past-the-end address. */
272 ULONGEST end;
273 /* The data. */
274 gdb_byte *data;
275};
276typedef struct memory_read_result memory_read_result_s;
277DEF_VEC_O(memory_read_result_s);
278
279extern void free_memory_read_result_vector (void *);
280
281extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
282 ULONGEST offset,
283 LONGEST len);
d5086790 284
1e3ff5ad
AC
285extern LONGEST target_write (struct target_ops *ops,
286 enum target_object object,
1b0ba102 287 const char *annex, const gdb_byte *buf,
1e3ff5ad 288 ULONGEST offset, LONGEST len);
b6591e8b 289
a76d924d
DJ
290/* Similar to target_write, except that it also calls PROGRESS with
291 the number of bytes written and the opaque BATON after every
292 successful partial write (and before the first write). This is
293 useful for progress reporting and user interaction while writing
294 data. To abort the transfer, the progress callback can throw an
295 exception. */
296
cf7a04e8
DJ
297LONGEST target_write_with_progress (struct target_ops *ops,
298 enum target_object object,
299 const char *annex, const gdb_byte *buf,
300 ULONGEST offset, LONGEST len,
301 void (*progress) (ULONGEST, void *),
302 void *baton);
303
13547ab6
DJ
304/* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
305 be read using OPS. The return value will be -1 if the transfer
306 fails or is not supported; 0 if the object is empty; or the length
307 of the object otherwise. If a positive value is returned, a
308 sufficiently large buffer will be allocated using xmalloc and
309 returned in *BUF_P containing the contents of the object.
310
311 This method should be used for objects sufficiently small to store
312 in a single xmalloc'd buffer, when no fixed bound on the object's
313 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
314 through this function. */
315
316extern LONGEST target_read_alloc (struct target_ops *ops,
317 enum target_object object,
318 const char *annex, gdb_byte **buf_p);
319
159f81f3
DJ
320/* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
321 returned as a string, allocated using xmalloc. If an error occurs
322 or the transfer is unsupported, NULL is returned. Empty objects
323 are returned as allocated but empty strings. A warning is issued
324 if the result contains any embedded NUL bytes. */
325
326extern char *target_read_stralloc (struct target_ops *ops,
327 enum target_object object,
328 const char *annex);
329
6be7b56e 330/* See target_ops->to_xfer_partial. */
4ac248ca 331extern target_xfer_partial_ftype target_xfer_partial;
6be7b56e 332
b6591e8b
AC
333/* Wrappers to target read/write that perform memory transfers. They
334 throw an error if the memory transfer fails.
335
336 NOTE: cagney/2003-10-23: The naming schema is lifted from
337 "frame.h". The parameter order is lifted from get_frame_memory,
338 which in turn lifted it from read_memory. */
339
340extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
1b0ba102 341 gdb_byte *buf, LONGEST len);
b6591e8b 342extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
e17a4113
UW
343 CORE_ADDR addr, int len,
344 enum bfd_endian byte_order);
1e3ff5ad 345\f
0d06e24b
JM
346struct thread_info; /* fwd decl for parameter list below: */
347
b0a16e66
TT
348/* The type of the callback to the to_async method. */
349
350typedef void async_callback_ftype (enum inferior_event_type event_type,
351 void *context);
352
c906108c 353struct target_ops
c5aa993b 354 {
258b763a 355 struct target_ops *beneath; /* To the target under this one. */
c5aa993b
JM
356 char *to_shortname; /* Name this target type */
357 char *to_longname; /* Name for printing */
358 char *to_doc; /* Documentation. Does not include trailing
c906108c 359 newline, and starts with a one-line descrip-
0d06e24b 360 tion (probably similar to to_longname). */
bba2d28d
AC
361 /* Per-target scratch pad. */
362 void *to_data;
f1c07ab0
AC
363 /* The open routine takes the rest of the parameters from the
364 command, and (if successful) pushes a new target onto the
365 stack. Targets should supply this routine, if only to provide
366 an error message. */
507f3c78 367 void (*to_open) (char *, int);
f1c07ab0
AC
368 /* Old targets with a static target vector provide "to_close".
369 New re-entrant targets provide "to_xclose" and that is expected
370 to xfree everything (including the "struct target_ops"). */
460014f5
JK
371 void (*to_xclose) (struct target_ops *targ);
372 void (*to_close) (void);
136d6dae 373 void (*to_attach) (struct target_ops *ops, char *, int);
507f3c78 374 void (*to_post_attach) (int);
52554a0e 375 void (*to_detach) (struct target_ops *ops, const char *, int);
597320e7 376 void (*to_disconnect) (struct target_ops *, char *, int);
2ea28649 377 void (*to_resume) (struct target_ops *, ptid_t, int, enum gdb_signal);
117de6a9 378 ptid_t (*to_wait) (struct target_ops *,
47608cb1 379 ptid_t, struct target_waitstatus *, int);
28439f5e
PA
380 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
381 void (*to_store_registers) (struct target_ops *, struct regcache *, int);
f32dbf8c 382 void (*to_prepare_to_store) (struct target_ops *, struct regcache *);
c5aa993b
JM
383
384 /* Transfer LEN bytes of memory between GDB address MYADDR and
385 target address MEMADDR. If WRITE, transfer them to the target, else
386 transfer them from the target. TARGET is the target from which we
387 get this function.
388
389 Return value, N, is one of the following:
390
391 0 means that we can't handle this. If errno has been set, it is the
392 error which prevented us from doing it (FIXME: What about bfd_error?).
393
394 positive (call it N) means that we have transferred N bytes
395 starting at MEMADDR. We might be able to handle more bytes
396 beyond this length, but no promises.
397
398 negative (call its absolute value N) means that we cannot
399 transfer right at MEMADDR, but we could transfer at least
c8e73a31 400 something at MEMADDR + N.
c5aa993b 401
c8e73a31
AC
402 NOTE: cagney/2004-10-01: This has been entirely superseeded by
403 to_xfer_partial and inferior inheritance. */
404
1b0ba102 405 int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
c8e73a31
AC
406 int len, int write,
407 struct mem_attrib *attrib,
408 struct target_ops *target);
c906108c 409
507f3c78 410 void (*to_files_info) (struct target_ops *);
a6d9a66e
UW
411 int (*to_insert_breakpoint) (struct gdbarch *, struct bp_target_info *);
412 int (*to_remove_breakpoint) (struct gdbarch *, struct bp_target_info *);
ccaa32c7 413 int (*to_can_use_hw_breakpoint) (int, int, int);
f1310107 414 int (*to_ranged_break_num_registers) (struct target_ops *);
a6d9a66e
UW
415 int (*to_insert_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
416 int (*to_remove_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
0cf6dd15
TJB
417
418 /* Documentation of what the two routines below are expected to do is
419 provided with the corresponding target_* macros. */
420 int (*to_remove_watchpoint) (CORE_ADDR, int, int, struct expression *);
421 int (*to_insert_watchpoint) (CORE_ADDR, int, int, struct expression *);
422
9c06b0b4
TJB
423 int (*to_insert_mask_watchpoint) (struct target_ops *,
424 CORE_ADDR, CORE_ADDR, int);
425 int (*to_remove_mask_watchpoint) (struct target_ops *,
426 CORE_ADDR, CORE_ADDR, int);
ccaa32c7 427 int (*to_stopped_by_watchpoint) (void);
74174d2e 428 int to_have_steppable_watchpoint;
7df1a324 429 int to_have_continuable_watchpoint;
4aa7a7f5 430 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
5009afc5
AS
431 int (*to_watchpoint_addr_within_range) (struct target_ops *,
432 CORE_ADDR, CORE_ADDR, int);
e09342b5
TJB
433
434 /* Documentation of this routine is provided with the corresponding
435 target_* macro. */
e0d24f8d 436 int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
e09342b5 437
0cf6dd15
TJB
438 int (*to_can_accel_watchpoint_condition) (CORE_ADDR, int, int,
439 struct expression *);
9c06b0b4
TJB
440 int (*to_masked_watch_num_registers) (struct target_ops *,
441 CORE_ADDR, CORE_ADDR);
507f3c78
KB
442 void (*to_terminal_init) (void);
443 void (*to_terminal_inferior) (void);
444 void (*to_terminal_ours_for_output) (void);
445 void (*to_terminal_ours) (void);
a790ad35 446 void (*to_terminal_save_ours) (void);
503ebb2c 447 void (*to_terminal_info) (const char *, int);
7d85a9c0 448 void (*to_kill) (struct target_ops *);
507f3c78 449 void (*to_load) (char *, int);
136d6dae
VP
450 void (*to_create_inferior) (struct target_ops *,
451 char *, char *, char **, int);
39f77062 452 void (*to_post_startup_inferior) (ptid_t);
77b06cd7 453 int (*to_insert_fork_catchpoint) (int);
507f3c78 454 int (*to_remove_fork_catchpoint) (int);
77b06cd7 455 int (*to_insert_vfork_catchpoint) (int);
507f3c78 456 int (*to_remove_vfork_catchpoint) (int);
07107ca6 457 int (*to_follow_fork) (struct target_ops *, int, int);
77b06cd7 458 int (*to_insert_exec_catchpoint) (int);
507f3c78 459 int (*to_remove_exec_catchpoint) (int);
a96d9b2e 460 int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
507f3c78 461 int (*to_has_exited) (int, int, int *);
136d6dae 462 void (*to_mourn_inferior) (struct target_ops *);
507f3c78 463 int (*to_can_run) (void);
2455069d
UW
464
465 /* Documentation of this routine is provided with the corresponding
466 target_* macro. */
467 void (*to_pass_signals) (int, unsigned char *);
468
9b224c5e
PA
469 /* Documentation of this routine is provided with the
470 corresponding target_* function. */
471 void (*to_program_signals) (int, unsigned char *);
472
28439f5e
PA
473 int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
474 void (*to_find_new_threads) (struct target_ops *);
117de6a9 475 char *(*to_pid_to_str) (struct target_ops *, ptid_t);
507f3c78 476 char *(*to_extra_thread_info) (struct thread_info *);
4694da01 477 char *(*to_thread_name) (struct thread_info *);
94cc34af 478 void (*to_stop) (ptid_t);
d9fcf2fb 479 void (*to_rcmd) (char *command, struct ui_file *output);
507f3c78 480 char *(*to_pid_to_exec_file) (int pid);
49d03eab 481 void (*to_log_command) (const char *);
07b82ea5 482 struct target_section_table *(*to_get_section_table) (struct target_ops *);
c5aa993b 483 enum strata to_stratum;
c35b1492
PA
484 int (*to_has_all_memory) (struct target_ops *);
485 int (*to_has_memory) (struct target_ops *);
486 int (*to_has_stack) (struct target_ops *);
487 int (*to_has_registers) (struct target_ops *);
aeaec162 488 int (*to_has_execution) (struct target_ops *, ptid_t);
c5aa993b 489 int to_has_thread_control; /* control thread execution */
dc177b7a 490 int to_attach_no_wait;
6426a772
JM
491 /* ASYNC target controls */
492 int (*to_can_async_p) (void);
493 int (*to_is_async_p) (void);
b0a16e66 494 void (*to_async) (async_callback_ftype *, void *);
9908b566 495 int (*to_supports_non_stop) (void);
6b04bdb7 496 /* find_memory_regions support method for gcore */
b8edc417 497 int (*to_find_memory_regions) (find_memory_region_ftype func, void *data);
6b04bdb7 498 /* make_corefile_notes support method for gcore */
be4d1333 499 char * (*to_make_corefile_notes) (bfd *, int *);
6b04bdb7
MS
500 /* get_bookmark support method for bookmarks */
501 gdb_byte * (*to_get_bookmark) (char *, int);
502 /* goto_bookmark support method for bookmarks */
503 void (*to_goto_bookmark) (gdb_byte *, int);
3f47be5c
EZ
504 /* Return the thread-local address at OFFSET in the
505 thread-local storage for the thread PTID and the shared library
506 or executable file given by OBJFILE. If that block of
507 thread-local storage hasn't been allocated yet, this function
508 may return an error. */
117de6a9
PA
509 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
510 ptid_t ptid,
b2756930 511 CORE_ADDR load_module_addr,
3f47be5c
EZ
512 CORE_ADDR offset);
513
13547ab6
DJ
514 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
515 OBJECT. The OFFSET, for a seekable object, specifies the
516 starting point. The ANNEX can be used to provide additional
517 data-specific information to the target.
518
519 Return the number of bytes actually transfered, zero when no
6be7b56e
PA
520 further transfer is possible, and a negative error code (really
521 an 'enum target_xfer_error' value) when the transfer is not
13547ab6
DJ
522 supported. Return of a positive value smaller than LEN does
523 not indicate the end of the object, only the end of the
524 transfer; higher level code should continue transferring if
525 desired. This is handled in target.c.
526
527 The interface does not support a "retry" mechanism. Instead it
528 assumes that at least one byte will be transfered on each
529 successful call.
530
531 NOTE: cagney/2003-10-17: The current interface can lead to
532 fragmented transfers. Lower target levels should not implement
533 hacks, such as enlarging the transfer, in an attempt to
534 compensate for this. Instead, the target stack should be
535 extended so that it implements supply/collect methods and a
536 look-aside object cache. With that available, the lowest
537 target can safely and freely "push" data up the stack.
538
539 See target_read and target_write for more information. One,
540 and only one, of readbuf or writebuf must be non-NULL. */
541
4b8a223f 542 LONGEST (*to_xfer_partial) (struct target_ops *ops,
8aa91c1e 543 enum target_object object, const char *annex,
1b0ba102 544 gdb_byte *readbuf, const gdb_byte *writebuf,
b55e14c7 545 ULONGEST offset, ULONGEST len);
1e3ff5ad 546
fd79ecee
DJ
547 /* Returns the memory map for the target. A return value of NULL
548 means that no memory map is available. If a memory address
549 does not fall within any returned regions, it's assumed to be
550 RAM. The returned memory regions should not overlap.
551
552 The order of regions does not matter; target_memory_map will
c378eb4e 553 sort regions by starting address. For that reason, this
fd79ecee
DJ
554 function should not be called directly except via
555 target_memory_map.
556
557 This method should not cache data; if the memory map could
558 change unexpectedly, it should be invalidated, and higher
559 layers will re-fetch it. */
560 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
561
a76d924d
DJ
562 /* Erases the region of flash memory starting at ADDRESS, of
563 length LENGTH.
564
565 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
566 on flash block boundaries, as reported by 'to_memory_map'. */
567 void (*to_flash_erase) (struct target_ops *,
568 ULONGEST address, LONGEST length);
569
570 /* Finishes a flash memory write sequence. After this operation
571 all flash memory should be available for writing and the result
572 of reading from areas written by 'to_flash_write' should be
573 equal to what was written. */
574 void (*to_flash_done) (struct target_ops *);
575
424163ea
DJ
576 /* Describe the architecture-specific features of this target.
577 Returns the description found, or NULL if no description
578 was available. */
579 const struct target_desc *(*to_read_description) (struct target_ops *ops);
580
0ef643c8
JB
581 /* Build the PTID of the thread on which a given task is running,
582 based on LWP and THREAD. These values are extracted from the
583 task Private_Data section of the Ada Task Control Block, and
584 their interpretation depends on the target. */
585 ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
586
c47ffbe3
VP
587 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
588 Return 0 if *READPTR is already at the end of the buffer.
589 Return -1 if there is insufficient buffer for a whole entry.
590 Return 1 if an entry was read into *TYPEP and *VALP. */
591 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
592 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
593
08388c79
DE
594 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
595 sequence of bytes in PATTERN with length PATTERN_LEN.
596
597 The result is 1 if found, 0 if not found, and -1 if there was an error
598 requiring halting of the search (e.g. memory read error).
599 If the pattern is found the address is recorded in FOUND_ADDRP. */
600 int (*to_search_memory) (struct target_ops *ops,
601 CORE_ADDR start_addr, ULONGEST search_space_len,
602 const gdb_byte *pattern, ULONGEST pattern_len,
603 CORE_ADDR *found_addrp);
604
b2175913 605 /* Can target execute in reverse? */
2c0b251b 606 int (*to_can_execute_reverse) (void);
b2175913 607
32231432
PA
608 /* The direction the target is currently executing. Must be
609 implemented on targets that support reverse execution and async
610 mode. The default simply returns forward execution. */
611 enum exec_direction_kind (*to_execution_direction) (void);
612
8a305172
PA
613 /* Does this target support debugging multiple processes
614 simultaneously? */
615 int (*to_supports_multi_process) (void);
616
d248b706
KY
617 /* Does this target support enabling and disabling tracepoints while a trace
618 experiment is running? */
619 int (*to_supports_enable_disable_tracepoint) (void);
620
03583c20
UW
621 /* Does this target support disabling address space randomization? */
622 int (*to_supports_disable_randomization) (void);
623
3065dfb6
SS
624 /* Does this target support the tracenz bytecode for string collection? */
625 int (*to_supports_string_tracing) (void);
626
b775012e
LM
627 /* Does this target support evaluation of breakpoint conditions on its
628 end? */
629 int (*to_supports_evaluation_of_breakpoint_conditions) (void);
630
d3ce09f5
SS
631 /* Does this target support evaluation of breakpoint commands on its
632 end? */
633 int (*to_can_run_breakpoint_commands) (void);
634
3a8f7b07
JK
635 /* Determine current architecture of thread PTID.
636
637 The target is supposed to determine the architecture of the code where
638 the target is currently stopped at (on Cell, if a target is in spu_run,
639 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
640 This is architecture used to perform decr_pc_after_break adjustment,
641 and also determines the frame architecture of the innermost frame.
f5656ead 642 ptrace operations need to operate according to target_gdbarch ().
3a8f7b07 643
f5656ead 644 The default implementation always returns target_gdbarch (). */
c2250ad1
UW
645 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
646
c0694254
PA
647 /* Determine current address space of thread PTID.
648
649 The default implementation always returns the inferior's
650 address space. */
651 struct address_space *(*to_thread_address_space) (struct target_ops *,
652 ptid_t);
653
7313baad
UW
654 /* Target file operations. */
655
656 /* Open FILENAME on the target, using FLAGS and MODE. Return a
657 target file descriptor, or -1 if an error occurs (and set
658 *TARGET_ERRNO). */
659 int (*to_fileio_open) (const char *filename, int flags, int mode,
660 int *target_errno);
661
662 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
663 Return the number of bytes written, or -1 if an error occurs
664 (and set *TARGET_ERRNO). */
665 int (*to_fileio_pwrite) (int fd, const gdb_byte *write_buf, int len,
666 ULONGEST offset, int *target_errno);
667
668 /* Read up to LEN bytes FD on the target into READ_BUF.
669 Return the number of bytes read, or -1 if an error occurs
670 (and set *TARGET_ERRNO). */
671 int (*to_fileio_pread) (int fd, gdb_byte *read_buf, int len,
672 ULONGEST offset, int *target_errno);
673
674 /* Close FD on the target. Return 0, or -1 if an error occurs
675 (and set *TARGET_ERRNO). */
676 int (*to_fileio_close) (int fd, int *target_errno);
677
678 /* Unlink FILENAME on the target. Return 0, or -1 if an error
679 occurs (and set *TARGET_ERRNO). */
680 int (*to_fileio_unlink) (const char *filename, int *target_errno);
681
b9e7b9c3
UW
682 /* Read value of symbolic link FILENAME on the target. Return a
683 null-terminated string allocated via xmalloc, or NULL if an error
684 occurs (and set *TARGET_ERRNO). */
685 char *(*to_fileio_readlink) (const char *filename, int *target_errno);
686
7313baad 687
145b16a9
UW
688 /* Implement the "info proc" command. */
689 void (*to_info_proc) (struct target_ops *, char *, enum info_proc_what);
690
35b1e5cc
SS
691 /* Tracepoint-related operations. */
692
693 /* Prepare the target for a tracing run. */
694 void (*to_trace_init) (void);
695
e8ba3115
YQ
696 /* Send full details of a tracepoint location to the target. */
697 void (*to_download_tracepoint) (struct bp_location *location);
35b1e5cc 698
1e4d1764
YQ
699 /* Is the target able to download tracepoint locations in current
700 state? */
701 int (*to_can_download_tracepoint) (void);
702
35b1e5cc
SS
703 /* Send full details of a trace state variable to the target. */
704 void (*to_download_trace_state_variable) (struct trace_state_variable *tsv);
705
d248b706
KY
706 /* Enable a tracepoint on the target. */
707 void (*to_enable_tracepoint) (struct bp_location *location);
708
709 /* Disable a tracepoint on the target. */
710 void (*to_disable_tracepoint) (struct bp_location *location);
711
35b1e5cc
SS
712 /* Inform the target info of memory regions that are readonly
713 (such as text sections), and so it should return data from
714 those rather than look in the trace buffer. */
715 void (*to_trace_set_readonly_regions) (void);
716
717 /* Start a trace run. */
718 void (*to_trace_start) (void);
719
720 /* Get the current status of a tracing run. */
00bf0b85 721 int (*to_get_trace_status) (struct trace_status *ts);
35b1e5cc 722
f196051f
SS
723 void (*to_get_tracepoint_status) (struct breakpoint *tp,
724 struct uploaded_tp *utp);
725
35b1e5cc
SS
726 /* Stop a trace run. */
727 void (*to_trace_stop) (void);
728
729 /* Ask the target to find a trace frame of the given type TYPE,
730 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
731 number of the trace frame, and also the tracepoint number at
c378eb4e 732 TPP. If no trace frame matches, return -1. May throw if the
f197e0f1 733 operation fails. */
35b1e5cc 734 int (*to_trace_find) (enum trace_find_type type, int num,
cc5925ad 735 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp);
35b1e5cc
SS
736
737 /* Get the value of the trace state variable number TSV, returning
738 1 if the value is known and writing the value itself into the
739 location pointed to by VAL, else returning 0. */
740 int (*to_get_trace_state_variable_value) (int tsv, LONGEST *val);
741
011aacb0 742 int (*to_save_trace_data) (const char *filename);
00bf0b85
SS
743
744 int (*to_upload_tracepoints) (struct uploaded_tp **utpp);
745
746 int (*to_upload_trace_state_variables) (struct uploaded_tsv **utsvp);
747
748 LONGEST (*to_get_raw_trace_data) (gdb_byte *buf,
749 ULONGEST offset, LONGEST len);
750
405f8e94
SS
751 /* Get the minimum length of instruction on which a fast tracepoint
752 may be set on the target. If this operation is unsupported,
753 return -1. If for some reason the minimum length cannot be
754 determined, return 0. */
755 int (*to_get_min_fast_tracepoint_insn_len) (void);
756
35b1e5cc
SS
757 /* Set the target's tracing behavior in response to unexpected
758 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
759 void (*to_set_disconnected_tracing) (int val);
4daf5ac0 760 void (*to_set_circular_trace_buffer) (int val);
f6f899bf
HAQ
761 /* Set the size of trace buffer in the target. */
762 void (*to_set_trace_buffer_size) (LONGEST val);
35b1e5cc 763
f196051f
SS
764 /* Add/change textual notes about the trace run, returning 1 if
765 successful, 0 otherwise. */
ca623f82
TT
766 int (*to_set_trace_notes) (const char *user, const char *notes,
767 const char *stopnotes);
f196051f 768
dc146f7c
VP
769 /* Return the processor core that thread PTID was last seen on.
770 This information is updated only when:
771 - update_thread_list is called
772 - thread stops
3e43a32a
MS
773 If the core cannot be determined -- either for the specified
774 thread, or right now, or in this debug session, or for this
775 target -- return -1. */
dc146f7c
VP
776 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
777
4a5e7a5b
PA
778 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
779 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
780 a match, 0 if there's a mismatch, and -1 if an error is
781 encountered while reading memory. */
782 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
783 CORE_ADDR memaddr, ULONGEST size);
784
711e434b
PM
785 /* Return the address of the start of the Thread Information Block
786 a Windows OS specific feature. */
787 int (*to_get_tib_address) (ptid_t ptid, CORE_ADDR *addr);
788
d914c394
SS
789 /* Send the new settings of write permission variables. */
790 void (*to_set_permissions) (void);
791
0fb4aa4b
PA
792 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
793 with its details. Return 1 on success, 0 on failure. */
794 int (*to_static_tracepoint_marker_at) (CORE_ADDR,
795 struct static_tracepoint_marker *marker);
796
797 /* Return a vector of all tracepoints markers string id ID, or all
798 markers if ID is NULL. */
799 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid)
800 (const char *id);
801
b3b9301e 802 /* Return a traceframe info object describing the current
1527aea8
YQ
803 traceframe's contents. If the target doesn't support
804 traceframe info, return NULL. If the current traceframe is not
805 selected (the current traceframe number is -1), the target can
806 choose to return either NULL or an empty traceframe info. If
807 NULL is returned, for example in remote target, GDB will read
808 from the live inferior. If an empty traceframe info is
809 returned, for example in tfile target, which means the
810 traceframe info is available, but the requested memory is not
811 available in it. GDB will try to see if the requested memory
812 is available in the read-only sections. This method should not
813 cache data; higher layers take care of caching, invalidating,
814 and re-fetching when necessary. */
b3b9301e
PA
815 struct traceframe_info *(*to_traceframe_info) (void);
816
d1feda86
YQ
817 /* Ask the target to use or not to use agent according to USE. Return 1
818 successful, 0 otherwise. */
819 int (*to_use_agent) (int use);
820
821 /* Is the target able to use agent in current state? */
822 int (*to_can_use_agent) (void);
823
02d27625
MM
824 /* Check whether the target supports branch tracing. */
825 int (*to_supports_btrace) (void);
826
827 /* Enable branch tracing for PTID and allocate a branch trace target
828 information struct for reading and for disabling branch trace. */
829 struct btrace_target_info *(*to_enable_btrace) (ptid_t ptid);
830
831 /* Disable branch tracing and deallocate TINFO. */
832 void (*to_disable_btrace) (struct btrace_target_info *tinfo);
833
834 /* Disable branch tracing and deallocate TINFO. This function is similar
835 to to_disable_btrace, except that it is called during teardown and is
836 only allowed to perform actions that are safe. A counter-example would
837 be attempting to talk to a remote target. */
838 void (*to_teardown_btrace) (struct btrace_target_info *tinfo);
839
840 /* Read branch trace data. */
841 VEC (btrace_block_s) *(*to_read_btrace) (struct btrace_target_info *,
842 enum btrace_read_type);
843
7c1687a9
MM
844 /* Stop trace recording. */
845 void (*to_stop_recording) (void);
846
d02ed0bb
MM
847 /* Print information about the recording. */
848 void (*to_info_record) (void);
849
850 /* Save the recorded execution trace into a file. */
85e1311a 851 void (*to_save_record) (const char *filename);
d02ed0bb
MM
852
853 /* Delete the recorded execution trace from the current position onwards. */
854 void (*to_delete_record) (void);
855
856 /* Query if the record target is currently replaying. */
857 int (*to_record_is_replaying) (void);
858
859 /* Go to the begin of the execution trace. */
860 void (*to_goto_record_begin) (void);
861
862 /* Go to the end of the execution trace. */
863 void (*to_goto_record_end) (void);
864
865 /* Go to a specific location in the recorded execution trace. */
866 void (*to_goto_record) (ULONGEST insn);
867
67c86d06
MM
868 /* Disassemble SIZE instructions in the recorded execution trace from
869 the current position.
870 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
871 disassemble SIZE succeeding instructions. */
872 void (*to_insn_history) (int size, int flags);
873
874 /* Disassemble SIZE instructions in the recorded execution trace around
875 FROM.
876 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
877 disassemble SIZE instructions after FROM. */
878 void (*to_insn_history_from) (ULONGEST from, int size, int flags);
879
880 /* Disassemble a section of the recorded execution trace from instruction
0688d04e 881 BEGIN (inclusive) to instruction END (inclusive). */
67c86d06
MM
882 void (*to_insn_history_range) (ULONGEST begin, ULONGEST end, int flags);
883
15984c13
MM
884 /* Print a function trace of the recorded execution trace.
885 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
886 succeeding functions. */
887 void (*to_call_history) (int size, int flags);
888
889 /* Print a function trace of the recorded execution trace starting
890 at function FROM.
891 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
892 SIZE functions after FROM. */
893 void (*to_call_history_from) (ULONGEST begin, int size, int flags);
894
895 /* Print a function trace of an execution trace section from function BEGIN
0688d04e 896 (inclusive) to function END (inclusive). */
15984c13
MM
897 void (*to_call_history_range) (ULONGEST begin, ULONGEST end, int flags);
898
ced63ec0
GB
899 /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
900 non-empty annex. */
901 int (*to_augmented_libraries_svr4_read) (void);
902
ea001bdc
MM
903 /* Those unwinders are tried before any other arch unwinders. Use NULL if
904 it is not used. */
905 const struct frame_unwind *to_get_unwinder;
906 const struct frame_unwind *to_get_tailcall_unwinder;
907
c5aa993b 908 int to_magic;
0d06e24b
JM
909 /* Need sub-structure for target machine related rather than comm related?
910 */
c5aa993b 911 };
c906108c
SS
912
913/* Magic number for checking ops size. If a struct doesn't end with this
914 number, somebody changed the declaration but didn't change all the
915 places that initialize one. */
916
917#define OPS_MAGIC 3840
918
919/* The ops structure for our "current" target process. This should
920 never be NULL. If there is no target, it points to the dummy_target. */
921
c5aa993b 922extern struct target_ops current_target;
c906108c 923
c906108c
SS
924/* Define easy words for doing these operations on our current target. */
925
926#define target_shortname (current_target.to_shortname)
927#define target_longname (current_target.to_longname)
928
f1c07ab0 929/* Does whatever cleanup is required for a target that we are no
460014f5
JK
930 longer going to be calling. This routine is automatically always
931 called after popping the target off the target stack - the target's
932 own methods are no longer available through the target vector.
933 Closing file descriptors and freeing all memory allocated memory are
934 typical things it should do. */
f1c07ab0 935
460014f5 936void target_close (struct target_ops *targ);
c906108c
SS
937
938/* Attaches to a process on the target side. Arguments are as passed
939 to the `attach' command by the user. This routine can be called
940 when the target is not on the target-stack, if the target_can_run
2146d243 941 routine returns 1; in that case, it must push itself onto the stack.
c906108c 942 Upon exit, the target should be ready for normal operations, and
2146d243 943 should be ready to deliver the status of the process immediately
c906108c
SS
944 (without waiting) to an upcoming target_wait call. */
945
136d6dae 946void target_attach (char *, int);
c906108c 947
dc177b7a
PA
948/* Some targets don't generate traps when attaching to the inferior,
949 or their target_attach implementation takes care of the waiting.
950 These targets must set to_attach_no_wait. */
951
952#define target_attach_no_wait \
953 (current_target.to_attach_no_wait)
954
c906108c
SS
955/* The target_attach operation places a process under debugger control,
956 and stops the process.
957
958 This operation provides a target-specific hook that allows the
0d06e24b 959 necessary bookkeeping to be performed after an attach completes. */
c906108c 960#define target_post_attach(pid) \
0d06e24b 961 (*current_target.to_post_attach) (pid)
c906108c 962
c906108c
SS
963/* Takes a program previously attached to and detaches it.
964 The program may resume execution (some targets do, some don't) and will
965 no longer stop on signals, etc. We better not have left any breakpoints
966 in the program or it'll die when it hits one. ARGS is arguments
967 typed by the user (e.g. a signal to send the process). FROM_TTY
968 says whether to be verbose or not. */
969
52554a0e 970extern void target_detach (const char *, int);
c906108c 971
6ad8ae5c
DJ
972/* Disconnect from the current target without resuming it (leaving it
973 waiting for a debugger). */
974
975extern void target_disconnect (char *, int);
976
e5ef252a
PA
977/* Resume execution of the target process PTID (or a group of
978 threads). STEP says whether to single-step or to run free; SIGGNAL
979 is the signal to be given to the target, or GDB_SIGNAL_0 for no
980 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
981 PTID means `step/resume only this process id'. A wildcard PTID
982 (all threads, or all threads of process) means `step/resume
983 INFERIOR_PTID, and let other threads (for which the wildcard PTID
984 matches) resume with their 'thread->suspend.stop_signal' signal
985 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
986 if in "no pass" state. */
c906108c 987
2ea28649 988extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
c906108c 989
b5a2688f
AC
990/* Wait for process pid to do something. PTID = -1 to wait for any
991 pid to do something. Return pid of child, or -1 in case of error;
c906108c 992 store status through argument pointer STATUS. Note that it is
b5a2688f 993 _NOT_ OK to throw_exception() out of target_wait() without popping
c906108c
SS
994 the debugging target from the stack; GDB isn't prepared to get back
995 to the prompt with a debugging target but without the frame cache,
47608cb1
PA
996 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
997 options. */
c906108c 998
47608cb1
PA
999extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1000 int options);
c906108c 1001
17dee195 1002/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c 1003
28439f5e 1004extern void target_fetch_registers (struct regcache *regcache, int regno);
c906108c
SS
1005
1006/* Store at least register REGNO, or all regs if REGNO == -1.
1007 It can store as many registers as it wants to, so target_prepare_to_store
1008 must have been previously called. Calls error() if there are problems. */
1009
28439f5e 1010extern void target_store_registers (struct regcache *regcache, int regs);
c906108c
SS
1011
1012/* Get ready to modify the registers array. On machines which store
1013 individual registers, this doesn't need to do anything. On machines
1014 which store all the registers in one fell swoop, this makes sure
1015 that REGISTERS contains all the registers from the program being
1016 debugged. */
1017
316f2060 1018#define target_prepare_to_store(regcache) \
f32dbf8c 1019 (*current_target.to_prepare_to_store) (&current_target, regcache)
c906108c 1020
6c95b8df
PA
1021/* Determine current address space of thread PTID. */
1022
1023struct address_space *target_thread_address_space (ptid_t);
1024
451b7c33
TT
1025/* Implement the "info proc" command. This returns one if the request
1026 was handled, and zero otherwise. It can also throw an exception if
1027 an error was encountered while attempting to handle the
1028 request. */
145b16a9 1029
451b7c33 1030int target_info_proc (char *, enum info_proc_what);
145b16a9 1031
8a305172
PA
1032/* Returns true if this target can debug multiple processes
1033 simultaneously. */
1034
1035#define target_supports_multi_process() \
1036 (*current_target.to_supports_multi_process) ()
1037
03583c20
UW
1038/* Returns true if this target can disable address space randomization. */
1039
1040int target_supports_disable_randomization (void);
1041
d248b706
KY
1042/* Returns true if this target can enable and disable tracepoints
1043 while a trace experiment is running. */
1044
1045#define target_supports_enable_disable_tracepoint() \
1046 (*current_target.to_supports_enable_disable_tracepoint) ()
1047
3065dfb6
SS
1048#define target_supports_string_tracing() \
1049 (*current_target.to_supports_string_tracing) ()
1050
b775012e
LM
1051/* Returns true if this target can handle breakpoint conditions
1052 on its end. */
1053
1054#define target_supports_evaluation_of_breakpoint_conditions() \
1055 (*current_target.to_supports_evaluation_of_breakpoint_conditions) ()
1056
d3ce09f5
SS
1057/* Returns true if this target can handle breakpoint commands
1058 on its end. */
1059
1060#define target_can_run_breakpoint_commands() \
1061 (*current_target.to_can_run_breakpoint_commands) ()
1062
a14ed312 1063extern int target_read_string (CORE_ADDR, char **, int, int *);
c906108c 1064
5299c1c4 1065extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1b162304 1066 ssize_t len);
c906108c 1067
aee4bf85
PA
1068extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1069 ssize_t len);
1070
45aa4659 1071extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
4e5d721f 1072
29453a14
YQ
1073extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1074
fc1a4b47 1075extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1076 ssize_t len);
c906108c 1077
f0ba3972 1078extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1079 ssize_t len);
f0ba3972 1080
fd79ecee
DJ
1081/* Fetches the target's memory map. If one is found it is sorted
1082 and returned, after some consistency checking. Otherwise, NULL
1083 is returned. */
1084VEC(mem_region_s) *target_memory_map (void);
1085
a76d924d
DJ
1086/* Erase the specified flash region. */
1087void target_flash_erase (ULONGEST address, LONGEST length);
1088
1089/* Finish a sequence of flash operations. */
1090void target_flash_done (void);
1091
1092/* Describes a request for a memory write operation. */
1093struct memory_write_request
1094 {
c378eb4e 1095 /* Begining address that must be written. */
a76d924d 1096 ULONGEST begin;
c378eb4e 1097 /* Past-the-end address. */
a76d924d 1098 ULONGEST end;
c378eb4e 1099 /* The data to write. */
a76d924d
DJ
1100 gdb_byte *data;
1101 /* A callback baton for progress reporting for this request. */
1102 void *baton;
1103 };
1104typedef struct memory_write_request memory_write_request_s;
1105DEF_VEC_O(memory_write_request_s);
1106
1107/* Enumeration specifying different flash preservation behaviour. */
1108enum flash_preserve_mode
1109 {
1110 flash_preserve,
1111 flash_discard
1112 };
1113
1114/* Write several memory blocks at once. This version can be more
1115 efficient than making several calls to target_write_memory, in
1116 particular because it can optimize accesses to flash memory.
1117
1118 Moreover, this is currently the only memory access function in gdb
1119 that supports writing to flash memory, and it should be used for
1120 all cases where access to flash memory is desirable.
1121
1122 REQUESTS is the vector (see vec.h) of memory_write_request.
1123 PRESERVE_FLASH_P indicates what to do with blocks which must be
1124 erased, but not completely rewritten.
1125 PROGRESS_CB is a function that will be periodically called to provide
1126 feedback to user. It will be called with the baton corresponding
1127 to the request currently being written. It may also be called
1128 with a NULL baton, when preserved flash sectors are being rewritten.
1129
1130 The function returns 0 on success, and error otherwise. */
1131int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1132 enum flash_preserve_mode preserve_flash_p,
1133 void (*progress_cb) (ULONGEST, void *));
1134
c906108c
SS
1135/* Print a line about the current target. */
1136
1137#define target_files_info() \
0d06e24b 1138 (*current_target.to_files_info) (&current_target)
c906108c 1139
0000e5cc
PA
1140/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1141 the target machine. Returns 0 for success, and returns non-zero or
1142 throws an error (with a detailed failure reason error code and
1143 message) otherwise. */
c906108c 1144
d914c394
SS
1145extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1146 struct bp_target_info *bp_tgt);
c906108c 1147
8181d85f 1148/* Remove a breakpoint at address BP_TGT->placed_address in the target
578d3588 1149 machine. Result is 0 for success, non-zero for error. */
c906108c 1150
d914c394
SS
1151extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1152 struct bp_target_info *bp_tgt);
c906108c
SS
1153
1154/* Initialize the terminal settings we record for the inferior,
1155 before we actually run the inferior. */
1156
1157#define target_terminal_init() \
0d06e24b 1158 (*current_target.to_terminal_init) ()
c906108c
SS
1159
1160/* Put the inferior's terminal settings into effect.
1161 This is preparation for starting or resuming the inferior. */
1162
d9d2d8b6 1163extern void target_terminal_inferior (void);
c906108c
SS
1164
1165/* Put some of our terminal settings into effect,
1166 enough to get proper results from our output,
1167 but do not change into or out of RAW mode
1168 so that no input is discarded.
1169
1170 After doing this, either terminal_ours or terminal_inferior
1171 should be called to get back to a normal state of affairs. */
1172
1173#define target_terminal_ours_for_output() \
0d06e24b 1174 (*current_target.to_terminal_ours_for_output) ()
c906108c
SS
1175
1176/* Put our terminal settings into effect.
1177 First record the inferior's terminal settings
1178 so they can be restored properly later. */
1179
1180#define target_terminal_ours() \
0d06e24b 1181 (*current_target.to_terminal_ours) ()
c906108c 1182
a790ad35
SC
1183/* Save our terminal settings.
1184 This is called from TUI after entering or leaving the curses
1185 mode. Since curses modifies our terminal this call is here
1186 to take this change into account. */
1187
1188#define target_terminal_save_ours() \
1189 (*current_target.to_terminal_save_ours) ()
1190
c906108c
SS
1191/* Print useful information about our terminal status, if such a thing
1192 exists. */
1193
1194#define target_terminal_info(arg, from_tty) \
0d06e24b 1195 (*current_target.to_terminal_info) (arg, from_tty)
c906108c
SS
1196
1197/* Kill the inferior process. Make it go away. */
1198
7d85a9c0 1199extern void target_kill (void);
c906108c 1200
0d06e24b
JM
1201/* Load an executable file into the target process. This is expected
1202 to not only bring new code into the target process, but also to
1986bccd
AS
1203 update GDB's symbol tables to match.
1204
1205 ARG contains command-line arguments, to be broken down with
1206 buildargv (). The first non-switch argument is the filename to
1207 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1208 0)), which is an offset to apply to the load addresses of FILE's
1209 sections. The target may define switches, or other non-switch
1210 arguments, as it pleases. */
c906108c 1211
11cf8741 1212extern void target_load (char *arg, int from_tty);
c906108c 1213
39f77062 1214/* Start an inferior process and set inferior_ptid to its pid.
c906108c
SS
1215 EXEC_FILE is the file to run.
1216 ALLARGS is a string containing the arguments to the program.
1217 ENV is the environment vector to pass. Errors reported with error().
1218 On VxWorks and various standalone systems, we ignore exec_file. */
c5aa993b 1219
136d6dae
VP
1220void target_create_inferior (char *exec_file, char *args,
1221 char **env, int from_tty);
c906108c
SS
1222
1223/* Some targets (such as ttrace-based HPUX) don't allow us to request
1224 notification of inferior events such as fork and vork immediately
1225 after the inferior is created. (This because of how gdb gets an
1226 inferior created via invoking a shell to do it. In such a scenario,
1227 if the shell init file has commands in it, the shell will fork and
1228 exec for each of those commands, and we will see each such fork
1229 event. Very bad.)
c5aa993b 1230
0d06e24b
JM
1231 Such targets will supply an appropriate definition for this function. */
1232
39f77062
KB
1233#define target_post_startup_inferior(ptid) \
1234 (*current_target.to_post_startup_inferior) (ptid)
c906108c 1235
0d06e24b
JM
1236/* On some targets, we can catch an inferior fork or vfork event when
1237 it occurs. These functions insert/remove an already-created
77b06cd7
TJB
1238 catchpoint for such events. They return 0 for success, 1 if the
1239 catchpoint type is not supported and -1 for failure. */
c906108c 1240
c906108c 1241#define target_insert_fork_catchpoint(pid) \
0d06e24b 1242 (*current_target.to_insert_fork_catchpoint) (pid)
c906108c
SS
1243
1244#define target_remove_fork_catchpoint(pid) \
0d06e24b 1245 (*current_target.to_remove_fork_catchpoint) (pid)
c906108c
SS
1246
1247#define target_insert_vfork_catchpoint(pid) \
0d06e24b 1248 (*current_target.to_insert_vfork_catchpoint) (pid)
c906108c
SS
1249
1250#define target_remove_vfork_catchpoint(pid) \
0d06e24b 1251 (*current_target.to_remove_vfork_catchpoint) (pid)
c906108c 1252
6604731b
DJ
1253/* If the inferior forks or vforks, this function will be called at
1254 the next resume in order to perform any bookkeeping and fiddling
1255 necessary to continue debugging either the parent or child, as
1256 requested, and releasing the other. Information about the fork
1257 or vfork event is available via get_last_target_status ().
1258 This function returns 1 if the inferior should not be resumed
1259 (i.e. there is another event pending). */
0d06e24b 1260
07107ca6 1261int target_follow_fork (int follow_child, int detach_fork);
c906108c
SS
1262
1263/* On some targets, we can catch an inferior exec event when it
0d06e24b 1264 occurs. These functions insert/remove an already-created
77b06cd7
TJB
1265 catchpoint for such events. They return 0 for success, 1 if the
1266 catchpoint type is not supported and -1 for failure. */
0d06e24b 1267
c906108c 1268#define target_insert_exec_catchpoint(pid) \
0d06e24b 1269 (*current_target.to_insert_exec_catchpoint) (pid)
c5aa993b 1270
c906108c 1271#define target_remove_exec_catchpoint(pid) \
0d06e24b 1272 (*current_target.to_remove_exec_catchpoint) (pid)
c906108c 1273
a96d9b2e
SDJ
1274/* Syscall catch.
1275
1276 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1277 If NEEDED is zero, it means the target can disable the mechanism to
1278 catch system calls because there are no more catchpoints of this type.
1279
1280 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1281 being requested. In this case, both TABLE_SIZE and TABLE should
1282 be ignored.
1283
1284 TABLE_SIZE is the number of elements in TABLE. It only matters if
1285 ANY_COUNT is zero.
1286
1287 TABLE is an array of ints, indexed by syscall number. An element in
1288 this array is nonzero if that syscall should be caught. This argument
77b06cd7
TJB
1289 only matters if ANY_COUNT is zero.
1290
1291 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1292 for failure. */
a96d9b2e
SDJ
1293
1294#define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1295 (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
1296 table_size, table)
1297
c906108c 1298/* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
0d06e24b
JM
1299 exit code of PID, if any. */
1300
c906108c 1301#define target_has_exited(pid,wait_status,exit_status) \
0d06e24b 1302 (*current_target.to_has_exited) (pid,wait_status,exit_status)
c906108c
SS
1303
1304/* The debugger has completed a blocking wait() call. There is now
2146d243 1305 some process event that must be processed. This function should
c906108c 1306 be defined by those targets that require the debugger to perform
0d06e24b 1307 cleanup or internal state changes in response to the process event. */
c906108c
SS
1308
1309/* The inferior process has died. Do what is right. */
1310
136d6dae 1311void target_mourn_inferior (void);
c906108c
SS
1312
1313/* Does target have enough data to do a run or attach command? */
1314
1315#define target_can_run(t) \
0d06e24b 1316 ((t)->to_can_run) ()
c906108c 1317
2455069d
UW
1318/* Set list of signals to be handled in the target.
1319
1320 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
2ea28649 1321 (enum gdb_signal). For every signal whose entry in this array is
2455069d
UW
1322 non-zero, the target is allowed -but not required- to skip reporting
1323 arrival of the signal to the GDB core by returning from target_wait,
1324 and to pass the signal directly to the inferior instead.
1325
1326 However, if the target is hardware single-stepping a thread that is
1327 about to receive a signal, it needs to be reported in any case, even
1328 if mentioned in a previous target_pass_signals call. */
c906108c 1329
2455069d 1330extern void target_pass_signals (int nsig, unsigned char *pass_signals);
c906108c 1331
9b224c5e
PA
1332/* Set list of signals the target may pass to the inferior. This
1333 directly maps to the "handle SIGNAL pass/nopass" setting.
1334
1335 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
2ea28649 1336 number (enum gdb_signal). For every signal whose entry in this
9b224c5e
PA
1337 array is non-zero, the target is allowed to pass the signal to the
1338 inferior. Signals not present in the array shall be silently
1339 discarded. This does not influence whether to pass signals to the
1340 inferior as a result of a target_resume call. This is useful in
1341 scenarios where the target needs to decide whether to pass or not a
1342 signal to the inferior without GDB core involvement, such as for
1343 example, when detaching (as threads may have been suspended with
1344 pending signals not reported to GDB). */
1345
1346extern void target_program_signals (int nsig, unsigned char *program_signals);
1347
c906108c
SS
1348/* Check to see if a thread is still alive. */
1349
28439f5e 1350extern int target_thread_alive (ptid_t ptid);
c906108c 1351
b83266a0
SS
1352/* Query for new threads and add them to the thread list. */
1353
28439f5e 1354extern void target_find_new_threads (void);
b83266a0 1355
0d06e24b
JM
1356/* Make target stop in a continuable fashion. (For instance, under
1357 Unix, this should act like SIGSTOP). This function is normally
1358 used by GUIs to implement a stop button. */
c906108c 1359
d914c394 1360extern void target_stop (ptid_t ptid);
c906108c 1361
96baa820
JM
1362/* Send the specified COMMAND to the target's monitor
1363 (shell,interpreter) for execution. The result of the query is
0d06e24b 1364 placed in OUTBUF. */
96baa820
JM
1365
1366#define target_rcmd(command, outbuf) \
1367 (*current_target.to_rcmd) (command, outbuf)
1368
1369
c906108c
SS
1370/* Does the target include all of memory, or only part of it? This
1371 determines whether we look up the target chain for other parts of
1372 memory if this target can't satisfy a request. */
1373
c35b1492
PA
1374extern int target_has_all_memory_1 (void);
1375#define target_has_all_memory target_has_all_memory_1 ()
c906108c
SS
1376
1377/* Does the target include memory? (Dummy targets don't.) */
1378
c35b1492
PA
1379extern int target_has_memory_1 (void);
1380#define target_has_memory target_has_memory_1 ()
c906108c
SS
1381
1382/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1383 we start a process.) */
c5aa993b 1384
c35b1492
PA
1385extern int target_has_stack_1 (void);
1386#define target_has_stack target_has_stack_1 ()
c906108c
SS
1387
1388/* Does the target have registers? (Exec files don't.) */
1389
c35b1492
PA
1390extern int target_has_registers_1 (void);
1391#define target_has_registers target_has_registers_1 ()
c906108c
SS
1392
1393/* Does the target have execution? Can we make it jump (through
52bb452f
DJ
1394 hoops), or pop its stack a few times? This means that the current
1395 target is currently executing; for some targets, that's the same as
1396 whether or not the target is capable of execution, but there are
1397 also targets which can be current while not executing. In that
1398 case this will become true after target_create_inferior or
1399 target_attach. */
c906108c 1400
aeaec162
TT
1401extern int target_has_execution_1 (ptid_t);
1402
1403/* Like target_has_execution_1, but always passes inferior_ptid. */
1404
1405extern int target_has_execution_current (void);
1406
1407#define target_has_execution target_has_execution_current ()
c35b1492
PA
1408
1409/* Default implementations for process_stratum targets. Return true
1410 if there's a selected inferior, false otherwise. */
1411
1412extern int default_child_has_all_memory (struct target_ops *ops);
1413extern int default_child_has_memory (struct target_ops *ops);
1414extern int default_child_has_stack (struct target_ops *ops);
1415extern int default_child_has_registers (struct target_ops *ops);
aeaec162
TT
1416extern int default_child_has_execution (struct target_ops *ops,
1417 ptid_t the_ptid);
c906108c
SS
1418
1419/* Can the target support the debugger control of thread execution?
d6350901 1420 Can it lock the thread scheduler? */
c906108c
SS
1421
1422#define target_can_lock_scheduler \
0d06e24b 1423 (current_target.to_has_thread_control & tc_schedlock)
c906108c 1424
c6ebd6cf
VP
1425/* Should the target enable async mode if it is supported? Temporary
1426 cludge until async mode is a strict superset of sync mode. */
1427extern int target_async_permitted;
1428
c378eb4e 1429/* Can the target support asynchronous execution? */
6426a772
JM
1430#define target_can_async_p() (current_target.to_can_async_p ())
1431
c378eb4e 1432/* Is the target in asynchronous execution mode? */
b84876c2 1433#define target_is_async_p() (current_target.to_is_async_p ())
6426a772 1434
9908b566
VP
1435int target_supports_non_stop (void);
1436
c378eb4e 1437/* Put the target in async mode with the specified callback function. */
0d06e24b 1438#define target_async(CALLBACK,CONTEXT) \
b84876c2 1439 (current_target.to_async ((CALLBACK), (CONTEXT)))
43ff13b4 1440
32231432
PA
1441#define target_execution_direction() \
1442 (current_target.to_execution_direction ())
1443
c906108c
SS
1444/* Converts a process id to a string. Usually, the string just contains
1445 `process xyz', but on some systems it may contain
1446 `process xyz thread abc'. */
1447
117de6a9 1448extern char *target_pid_to_str (ptid_t ptid);
c906108c 1449
39f77062 1450extern char *normal_pid_to_str (ptid_t ptid);
c5aa993b 1451
0d06e24b
JM
1452/* Return a short string describing extra information about PID,
1453 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1454 is okay. */
1455
1456#define target_extra_thread_info(TP) \
1457 (current_target.to_extra_thread_info (TP))
ed9a39eb 1458
4694da01
TT
1459/* Return the thread's name. A NULL result means that the target
1460 could not determine this thread's name. */
1461
1462extern char *target_thread_name (struct thread_info *);
1463
c906108c
SS
1464/* Attempts to find the pathname of the executable file
1465 that was run to create a specified process.
1466
1467 The process PID must be stopped when this operation is used.
c5aa993b 1468
c906108c
SS
1469 If the executable file cannot be determined, NULL is returned.
1470
1471 Else, a pointer to a character string containing the pathname
1472 is returned. This string should be copied into a buffer by
1473 the client if the string will not be immediately used, or if
0d06e24b 1474 it must persist. */
c906108c
SS
1475
1476#define target_pid_to_exec_file(pid) \
0d06e24b 1477 (current_target.to_pid_to_exec_file) (pid)
c906108c 1478
3a8f7b07 1479/* See the to_thread_architecture description in struct target_ops. */
c2250ad1
UW
1480
1481#define target_thread_architecture(ptid) \
1482 (current_target.to_thread_architecture (&current_target, ptid))
1483
be4d1333
MS
1484/*
1485 * Iterator function for target memory regions.
1486 * Calls a callback function once for each memory region 'mapped'
1487 * in the child process. Defined as a simple macro rather than
2146d243 1488 * as a function macro so that it can be tested for nullity.
be4d1333
MS
1489 */
1490
1491#define target_find_memory_regions(FUNC, DATA) \
1492 (current_target.to_find_memory_regions) (FUNC, DATA)
1493
1494/*
1495 * Compose corefile .note section.
1496 */
1497
1498#define target_make_corefile_notes(BFD, SIZE_P) \
1499 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1500
6b04bdb7
MS
1501/* Bookmark interfaces. */
1502#define target_get_bookmark(ARGS, FROM_TTY) \
1503 (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1504
1505#define target_goto_bookmark(ARG, FROM_TTY) \
1506 (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1507
c906108c
SS
1508/* Hardware watchpoint interfaces. */
1509
1510/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
7f82dfc7 1511 write). Only the INFERIOR_PTID task is being queried. */
c906108c 1512
d92524f1
PM
1513#define target_stopped_by_watchpoint \
1514 (*current_target.to_stopped_by_watchpoint)
7df1a324 1515
74174d2e
UW
1516/* Non-zero if we have steppable watchpoints */
1517
d92524f1 1518#define target_have_steppable_watchpoint \
74174d2e 1519 (current_target.to_have_steppable_watchpoint)
74174d2e 1520
7df1a324
KW
1521/* Non-zero if we have continuable watchpoints */
1522
d92524f1 1523#define target_have_continuable_watchpoint \
7df1a324 1524 (current_target.to_have_continuable_watchpoint)
c906108c 1525
ccaa32c7 1526/* Provide defaults for hardware watchpoint functions. */
c906108c 1527
2146d243 1528/* If the *_hw_beakpoint functions have not been defined
ccaa32c7 1529 elsewhere use the definitions in the target vector. */
c906108c
SS
1530
1531/* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1532 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1533 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1534 (including this one?). OTHERTYPE is who knows what... */
1535
d92524f1 1536#define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
ccaa32c7 1537 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
c906108c 1538
e09342b5
TJB
1539/* Returns the number of debug registers needed to watch the given
1540 memory region, or zero if not supported. */
1541
d92524f1 1542#define target_region_ok_for_hw_watchpoint(addr, len) \
e0d24f8d 1543 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
e0d24f8d 1544
c906108c 1545
85d721b8
PA
1546/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1547 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
0cf6dd15 1548 COND is the expression for its condition, or NULL if there's none.
85d721b8
PA
1549 Returns 0 for success, 1 if the watchpoint type is not supported,
1550 -1 for failure. */
c906108c 1551
0cf6dd15
TJB
1552#define target_insert_watchpoint(addr, len, type, cond) \
1553 (*current_target.to_insert_watchpoint) (addr, len, type, cond)
c906108c 1554
0cf6dd15
TJB
1555#define target_remove_watchpoint(addr, len, type, cond) \
1556 (*current_target.to_remove_watchpoint) (addr, len, type, cond)
c906108c 1557
9c06b0b4
TJB
1558/* Insert a new masked watchpoint at ADDR using the mask MASK.
1559 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1560 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1561 masked watchpoints are not supported, -1 for failure. */
1562
1563extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1564
1565/* Remove a masked watchpoint at ADDR with the mask MASK.
1566 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1567 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1568 for failure. */
1569
1570extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1571
0000e5cc
PA
1572/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1573 the target machine. Returns 0 for success, and returns non-zero or
1574 throws an error (with a detailed failure reason error code and
1575 message) otherwise. */
1576
a6d9a66e
UW
1577#define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1578 (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
ccaa32c7 1579
a6d9a66e
UW
1580#define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1581 (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
c906108c 1582
f1310107
TJB
1583/* Return number of debug registers needed for a ranged breakpoint,
1584 or -1 if ranged breakpoints are not supported. */
1585
1586extern int target_ranged_break_num_registers (void);
1587
7f82dfc7
JK
1588/* Return non-zero if target knows the data address which triggered this
1589 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1590 INFERIOR_PTID task is being queried. */
1591#define target_stopped_data_address(target, addr_p) \
1592 (*target.to_stopped_data_address) (target, addr_p)
c906108c 1593
9b3e86b1
MR
1594/* Return non-zero if ADDR is within the range of a watchpoint spanning
1595 LENGTH bytes beginning at START. */
5009afc5
AS
1596#define target_watchpoint_addr_within_range(target, addr, start, length) \
1597 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1598
0cf6dd15
TJB
1599/* Return non-zero if the target is capable of using hardware to evaluate
1600 the condition expression. In this case, if the condition is false when
1601 the watched memory location changes, execution may continue without the
1602 debugger being notified.
1603
1604 Due to limitations in the hardware implementation, it may be capable of
1605 avoiding triggering the watchpoint in some cases where the condition
1606 expression is false, but may report some false positives as well.
1607 For this reason, GDB will still evaluate the condition expression when
1608 the watchpoint triggers. */
1609#define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1610 (*current_target.to_can_accel_watchpoint_condition) (addr, len, type, cond)
1611
9c06b0b4
TJB
1612/* Return number of debug registers needed for a masked watchpoint,
1613 -1 if masked watchpoints are not supported or -2 if the given address
1614 and mask combination cannot be used. */
1615
1616extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1617
b2175913
MS
1618/* Target can execute in reverse? */
1619#define target_can_execute_reverse \
1620 (current_target.to_can_execute_reverse ? \
1621 current_target.to_can_execute_reverse () : 0)
1622
424163ea
DJ
1623extern const struct target_desc *target_read_description (struct target_ops *);
1624
0ef643c8
JB
1625#define target_get_ada_task_ptid(lwp, tid) \
1626 (*current_target.to_get_ada_task_ptid) (lwp,tid)
1627
08388c79
DE
1628/* Utility implementation of searching memory. */
1629extern int simple_search_memory (struct target_ops* ops,
1630 CORE_ADDR start_addr,
1631 ULONGEST search_space_len,
1632 const gdb_byte *pattern,
1633 ULONGEST pattern_len,
1634 CORE_ADDR *found_addrp);
1635
1636/* Main entry point for searching memory. */
1637extern int target_search_memory (CORE_ADDR start_addr,
1638 ULONGEST search_space_len,
1639 const gdb_byte *pattern,
1640 ULONGEST pattern_len,
1641 CORE_ADDR *found_addrp);
1642
7313baad
UW
1643/* Target file operations. */
1644
1645/* Open FILENAME on the target, using FLAGS and MODE. Return a
1646 target file descriptor, or -1 if an error occurs (and set
1647 *TARGET_ERRNO). */
1648extern int target_fileio_open (const char *filename, int flags, int mode,
1649 int *target_errno);
1650
1651/* Write up to LEN bytes from WRITE_BUF to FD on the target.
1652 Return the number of bytes written, or -1 if an error occurs
1653 (and set *TARGET_ERRNO). */
1654extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1655 ULONGEST offset, int *target_errno);
1656
1657/* Read up to LEN bytes FD on the target into READ_BUF.
1658 Return the number of bytes read, or -1 if an error occurs
1659 (and set *TARGET_ERRNO). */
1660extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1661 ULONGEST offset, int *target_errno);
1662
1663/* Close FD on the target. Return 0, or -1 if an error occurs
1664 (and set *TARGET_ERRNO). */
1665extern int target_fileio_close (int fd, int *target_errno);
1666
1667/* Unlink FILENAME on the target. Return 0, or -1 if an error
1668 occurs (and set *TARGET_ERRNO). */
1669extern int target_fileio_unlink (const char *filename, int *target_errno);
1670
b9e7b9c3
UW
1671/* Read value of symbolic link FILENAME on the target. Return a
1672 null-terminated string allocated via xmalloc, or NULL if an error
1673 occurs (and set *TARGET_ERRNO). */
1674extern char *target_fileio_readlink (const char *filename, int *target_errno);
1675
7313baad
UW
1676/* Read target file FILENAME. The return value will be -1 if the transfer
1677 fails or is not supported; 0 if the object is empty; or the length
1678 of the object otherwise. If a positive value is returned, a
1679 sufficiently large buffer will be allocated using xmalloc and
1680 returned in *BUF_P containing the contents of the object.
1681
1682 This method should be used for objects sufficiently small to store
1683 in a single xmalloc'd buffer, when no fixed bound on the object's
1684 size is known in advance. */
1685extern LONGEST target_fileio_read_alloc (const char *filename,
1686 gdb_byte **buf_p);
1687
1688/* Read target file FILENAME. The result is NUL-terminated and
1689 returned as a string, allocated using xmalloc. If an error occurs
1690 or the transfer is unsupported, NULL is returned. Empty objects
1691 are returned as allocated but empty strings. A warning is issued
1692 if the result contains any embedded NUL bytes. */
1693extern char *target_fileio_read_stralloc (const char *filename);
1694
1695
35b1e5cc
SS
1696/* Tracepoint-related operations. */
1697
1698#define target_trace_init() \
1699 (*current_target.to_trace_init) ()
1700
1701#define target_download_tracepoint(t) \
1702 (*current_target.to_download_tracepoint) (t)
1703
1e4d1764
YQ
1704#define target_can_download_tracepoint() \
1705 (*current_target.to_can_download_tracepoint) ()
1706
35b1e5cc
SS
1707#define target_download_trace_state_variable(tsv) \
1708 (*current_target.to_download_trace_state_variable) (tsv)
1709
d248b706
KY
1710#define target_enable_tracepoint(loc) \
1711 (*current_target.to_enable_tracepoint) (loc)
1712
1713#define target_disable_tracepoint(loc) \
1714 (*current_target.to_disable_tracepoint) (loc)
1715
35b1e5cc
SS
1716#define target_trace_start() \
1717 (*current_target.to_trace_start) ()
1718
1719#define target_trace_set_readonly_regions() \
1720 (*current_target.to_trace_set_readonly_regions) ()
1721
00bf0b85
SS
1722#define target_get_trace_status(ts) \
1723 (*current_target.to_get_trace_status) (ts)
35b1e5cc 1724
f196051f
SS
1725#define target_get_tracepoint_status(tp,utp) \
1726 (*current_target.to_get_tracepoint_status) (tp, utp)
1727
35b1e5cc
SS
1728#define target_trace_stop() \
1729 (*current_target.to_trace_stop) ()
1730
1731#define target_trace_find(type,num,addr1,addr2,tpp) \
1732 (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1733
1734#define target_get_trace_state_variable_value(tsv,val) \
1735 (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1736
00bf0b85
SS
1737#define target_save_trace_data(filename) \
1738 (*current_target.to_save_trace_data) (filename)
1739
1740#define target_upload_tracepoints(utpp) \
1741 (*current_target.to_upload_tracepoints) (utpp)
1742
1743#define target_upload_trace_state_variables(utsvp) \
1744 (*current_target.to_upload_trace_state_variables) (utsvp)
1745
1746#define target_get_raw_trace_data(buf,offset,len) \
1747 (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1748
405f8e94
SS
1749#define target_get_min_fast_tracepoint_insn_len() \
1750 (*current_target.to_get_min_fast_tracepoint_insn_len) ()
1751
35b1e5cc
SS
1752#define target_set_disconnected_tracing(val) \
1753 (*current_target.to_set_disconnected_tracing) (val)
1754
4daf5ac0
SS
1755#define target_set_circular_trace_buffer(val) \
1756 (*current_target.to_set_circular_trace_buffer) (val)
1757
f6f899bf
HAQ
1758#define target_set_trace_buffer_size(val) \
1759 (*current_target.to_set_trace_buffer_size) (val)
1760
f196051f
SS
1761#define target_set_trace_notes(user,notes,stopnotes) \
1762 (*current_target.to_set_trace_notes) ((user), (notes), (stopnotes))
1763
711e434b
PM
1764#define target_get_tib_address(ptid, addr) \
1765 (*current_target.to_get_tib_address) ((ptid), (addr))
1766
d914c394
SS
1767#define target_set_permissions() \
1768 (*current_target.to_set_permissions) ()
1769
0fb4aa4b
PA
1770#define target_static_tracepoint_marker_at(addr, marker) \
1771 (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1772
1773#define target_static_tracepoint_markers_by_strid(marker_id) \
1774 (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1775
b3b9301e
PA
1776#define target_traceframe_info() \
1777 (*current_target.to_traceframe_info) ()
1778
d1feda86
YQ
1779#define target_use_agent(use) \
1780 (*current_target.to_use_agent) (use)
1781
1782#define target_can_use_agent() \
1783 (*current_target.to_can_use_agent) ()
1784
ced63ec0
GB
1785#define target_augmented_libraries_svr4_read() \
1786 (*current_target.to_augmented_libraries_svr4_read) ()
1787
49d03eab
MR
1788/* Command logging facility. */
1789
1790#define target_log_command(p) \
1791 do \
1792 if (current_target.to_log_command) \
1793 (*current_target.to_log_command) (p); \
1794 while (0)
1795
dc146f7c
VP
1796
1797extern int target_core_of_thread (ptid_t ptid);
1798
ea001bdc
MM
1799/* See to_get_unwinder in struct target_ops. */
1800extern const struct frame_unwind *target_get_unwinder (void);
1801
1802/* See to_get_tailcall_unwinder in struct target_ops. */
1803extern const struct frame_unwind *target_get_tailcall_unwinder (void);
1804
4a5e7a5b
PA
1805/* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1806 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1807 if there's a mismatch, and -1 if an error is encountered while
1808 reading memory. Throws an error if the functionality is found not
1809 to be supported by the current target. */
1810int target_verify_memory (const gdb_byte *data,
1811 CORE_ADDR memaddr, ULONGEST size);
1812
c906108c
SS
1813/* Routines for maintenance of the target structures...
1814
c22a2b88
TT
1815 complete_target_initialization: Finalize a target_ops by filling in
1816 any fields needed by the target implementation.
1817
c906108c
SS
1818 add_target: Add a target to the list of all possible targets.
1819
1820 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
1821 targets, within its particular stratum of the stack. Result
1822 is 0 if now atop the stack, nonzero if not on top (maybe
1823 should warn user).
c906108c
SS
1824
1825 unpush_target: Remove this from the stack of currently used targets,
c5aa993b 1826 no matter where it is on the list. Returns 0 if no
7fdc1521 1827 change, 1 if removed from stack. */
c906108c 1828
a14ed312 1829extern void add_target (struct target_ops *);
c906108c 1830
9852c492
YQ
1831extern void add_target_with_completer (struct target_ops *t,
1832 completer_ftype *completer);
1833
c22a2b88
TT
1834extern void complete_target_initialization (struct target_ops *t);
1835
b48d48eb
MM
1836/* Adds a command ALIAS for target T and marks it deprecated. This is useful
1837 for maintaining backwards compatibility when renaming targets. */
1838
1839extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
1840
b26a4dcb 1841extern void push_target (struct target_ops *);
c906108c 1842
a14ed312 1843extern int unpush_target (struct target_ops *);
c906108c 1844
fd79ecee
DJ
1845extern void target_pre_inferior (int);
1846
a14ed312 1847extern void target_preopen (int);
c906108c 1848
460014f5
JK
1849/* Does whatever cleanup is required to get rid of all pushed targets. */
1850extern void pop_all_targets (void);
aa76d38d 1851
87ab71f0
PA
1852/* Like pop_all_targets, but pops only targets whose stratum is
1853 strictly above ABOVE_STRATUM. */
460014f5 1854extern void pop_all_targets_above (enum strata above_stratum);
87ab71f0 1855
c0edd9ed
JK
1856extern int target_is_pushed (struct target_ops *t);
1857
9e35dae4
DJ
1858extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1859 CORE_ADDR offset);
1860
0542c86d 1861/* Struct target_section maps address ranges to file sections. It is
c906108c
SS
1862 mostly used with BFD files, but can be used without (e.g. for handling
1863 raw disks, or files not in formats handled by BFD). */
1864
0542c86d 1865struct target_section
c5aa993b
JM
1866 {
1867 CORE_ADDR addr; /* Lowest address in section */
1868 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 1869
7be0c536 1870 struct bfd_section *the_bfd_section;
c906108c 1871
046ac79f
JK
1872 /* The "owner" of the section.
1873 It can be any unique value. It is set by add_target_sections
1874 and used by remove_target_sections.
1875 For example, for executables it is a pointer to exec_bfd and
1876 for shlibs it is the so_list pointer. */
1877 void *owner;
c5aa993b 1878 };
c906108c 1879
07b82ea5
PA
1880/* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1881
1882struct target_section_table
1883{
1884 struct target_section *sections;
1885 struct target_section *sections_end;
1886};
1887
8db32d44 1888/* Return the "section" containing the specified address. */
0542c86d
PA
1889struct target_section *target_section_by_addr (struct target_ops *target,
1890 CORE_ADDR addr);
8db32d44 1891
07b82ea5
PA
1892/* Return the target section table this target (or the targets
1893 beneath) currently manipulate. */
1894
1895extern struct target_section_table *target_get_section_table
1896 (struct target_ops *target);
1897
c906108c
SS
1898/* From mem-break.c */
1899
3e43a32a
MS
1900extern int memory_remove_breakpoint (struct gdbarch *,
1901 struct bp_target_info *);
c906108c 1902
3e43a32a
MS
1903extern int memory_insert_breakpoint (struct gdbarch *,
1904 struct bp_target_info *);
c906108c 1905
3e43a32a
MS
1906extern int default_memory_remove_breakpoint (struct gdbarch *,
1907 struct bp_target_info *);
917317f4 1908
3e43a32a
MS
1909extern int default_memory_insert_breakpoint (struct gdbarch *,
1910 struct bp_target_info *);
917317f4 1911
c906108c
SS
1912
1913/* From target.c */
1914
a14ed312 1915extern void initialize_targets (void);
c906108c 1916
c25c4a8b 1917extern void noprocess (void) ATTRIBUTE_NORETURN;
c906108c 1918
8edfe269
DJ
1919extern void target_require_runnable (void);
1920
136d6dae 1921extern void find_default_attach (struct target_ops *, char *, int);
c906108c 1922
136d6dae
VP
1923extern void find_default_create_inferior (struct target_ops *,
1924 char *, char *, char **, int);
c906108c 1925
a14ed312 1926extern struct target_ops *find_target_beneath (struct target_ops *);
ed9a39eb 1927
e0665bc8
PA
1928/* Read OS data object of type TYPE from the target, and return it in
1929 XML format. The result is NUL-terminated and returned as a string,
1930 allocated using xmalloc. If an error occurs or the transfer is
1931 unsupported, NULL is returned. Empty objects are returned as
1932 allocated but empty strings. */
1933
07e059b5
VP
1934extern char *target_get_osdata (const char *type);
1935
c906108c
SS
1936\f
1937/* Stuff that should be shared among the various remote targets. */
1938
1939/* Debugging level. 0 is off, and non-zero values mean to print some debug
1940 information (higher values, more information). */
1941extern int remote_debug;
1942
1943/* Speed in bits per second, or -1 which means don't mess with the speed. */
1944extern int baud_rate;
c378eb4e 1945/* Timeout limit for response from target. */
c906108c
SS
1946extern int remote_timeout;
1947
c906108c 1948\f
c906108c 1949
8defab1a
DJ
1950/* Set the show memory breakpoints mode to show, and installs a cleanup
1951 to restore it back to the current value. */
1952extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1953
d914c394
SS
1954extern int may_write_registers;
1955extern int may_write_memory;
1956extern int may_insert_breakpoints;
1957extern int may_insert_tracepoints;
1958extern int may_insert_fast_tracepoints;
1959extern int may_stop;
1960
1961extern void update_target_permissions (void);
1962
c906108c 1963\f
c378eb4e 1964/* Imported from machine dependent code. */
c906108c 1965
c378eb4e 1966/* Blank target vector entries are initialized to target_ignore. */
a14ed312 1967void target_ignore (void);
c906108c 1968
02d27625
MM
1969/* See to_supports_btrace in struct target_ops. */
1970extern int target_supports_btrace (void);
1971
1972/* See to_enable_btrace in struct target_ops. */
1973extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
1974
1975/* See to_disable_btrace in struct target_ops. */
1976extern void target_disable_btrace (struct btrace_target_info *btinfo);
1977
1978/* See to_teardown_btrace in struct target_ops. */
1979extern void target_teardown_btrace (struct btrace_target_info *btinfo);
1980
1981/* See to_read_btrace in struct target_ops. */
1982extern VEC (btrace_block_s) *target_read_btrace (struct btrace_target_info *,
1983 enum btrace_read_type);
1984
7c1687a9
MM
1985/* See to_stop_recording in struct target_ops. */
1986extern void target_stop_recording (void);
1987
d02ed0bb
MM
1988/* See to_info_record in struct target_ops. */
1989extern void target_info_record (void);
1990
1991/* See to_save_record in struct target_ops. */
85e1311a 1992extern void target_save_record (const char *filename);
d02ed0bb
MM
1993
1994/* Query if the target supports deleting the execution log. */
1995extern int target_supports_delete_record (void);
1996
1997/* See to_delete_record in struct target_ops. */
1998extern void target_delete_record (void);
1999
2000/* See to_record_is_replaying in struct target_ops. */
2001extern int target_record_is_replaying (void);
2002
2003/* See to_goto_record_begin in struct target_ops. */
2004extern void target_goto_record_begin (void);
2005
2006/* See to_goto_record_end in struct target_ops. */
2007extern void target_goto_record_end (void);
2008
2009/* See to_goto_record in struct target_ops. */
2010extern void target_goto_record (ULONGEST insn);
02d27625 2011
67c86d06
MM
2012/* See to_insn_history. */
2013extern void target_insn_history (int size, int flags);
2014
2015/* See to_insn_history_from. */
2016extern void target_insn_history_from (ULONGEST from, int size, int flags);
2017
2018/* See to_insn_history_range. */
2019extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2020
15984c13
MM
2021/* See to_call_history. */
2022extern void target_call_history (int size, int flags);
2023
2024/* See to_call_history_from. */
2025extern void target_call_history_from (ULONGEST begin, int size, int flags);
2026
2027/* See to_call_history_range. */
2028extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2029
c5aa993b 2030#endif /* !defined (TARGET_H) */