btrace: add replay position to btrace thread info
[deliverable/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);
316f2060 382 void (*to_prepare_to_store) (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
c5aa993b 903 int to_magic;
0d06e24b
JM
904 /* Need sub-structure for target machine related rather than comm related?
905 */
c5aa993b 906 };
c906108c
SS
907
908/* Magic number for checking ops size. If a struct doesn't end with this
909 number, somebody changed the declaration but didn't change all the
910 places that initialize one. */
911
912#define OPS_MAGIC 3840
913
914/* The ops structure for our "current" target process. This should
915 never be NULL. If there is no target, it points to the dummy_target. */
916
c5aa993b 917extern struct target_ops current_target;
c906108c 918
c906108c
SS
919/* Define easy words for doing these operations on our current target. */
920
921#define target_shortname (current_target.to_shortname)
922#define target_longname (current_target.to_longname)
923
f1c07ab0 924/* Does whatever cleanup is required for a target that we are no
460014f5
JK
925 longer going to be calling. This routine is automatically always
926 called after popping the target off the target stack - the target's
927 own methods are no longer available through the target vector.
928 Closing file descriptors and freeing all memory allocated memory are
929 typical things it should do. */
f1c07ab0 930
460014f5 931void target_close (struct target_ops *targ);
c906108c
SS
932
933/* Attaches to a process on the target side. Arguments are as passed
934 to the `attach' command by the user. This routine can be called
935 when the target is not on the target-stack, if the target_can_run
2146d243 936 routine returns 1; in that case, it must push itself onto the stack.
c906108c 937 Upon exit, the target should be ready for normal operations, and
2146d243 938 should be ready to deliver the status of the process immediately
c906108c
SS
939 (without waiting) to an upcoming target_wait call. */
940
136d6dae 941void target_attach (char *, int);
c906108c 942
dc177b7a
PA
943/* Some targets don't generate traps when attaching to the inferior,
944 or their target_attach implementation takes care of the waiting.
945 These targets must set to_attach_no_wait. */
946
947#define target_attach_no_wait \
948 (current_target.to_attach_no_wait)
949
c906108c
SS
950/* The target_attach operation places a process under debugger control,
951 and stops the process.
952
953 This operation provides a target-specific hook that allows the
0d06e24b 954 necessary bookkeeping to be performed after an attach completes. */
c906108c 955#define target_post_attach(pid) \
0d06e24b 956 (*current_target.to_post_attach) (pid)
c906108c 957
c906108c
SS
958/* Takes a program previously attached to and detaches it.
959 The program may resume execution (some targets do, some don't) and will
960 no longer stop on signals, etc. We better not have left any breakpoints
961 in the program or it'll die when it hits one. ARGS is arguments
962 typed by the user (e.g. a signal to send the process). FROM_TTY
963 says whether to be verbose or not. */
964
52554a0e 965extern void target_detach (const char *, int);
c906108c 966
6ad8ae5c
DJ
967/* Disconnect from the current target without resuming it (leaving it
968 waiting for a debugger). */
969
970extern void target_disconnect (char *, int);
971
e5ef252a
PA
972/* Resume execution of the target process PTID (or a group of
973 threads). STEP says whether to single-step or to run free; SIGGNAL
974 is the signal to be given to the target, or GDB_SIGNAL_0 for no
975 signal. The caller may not pass GDB_SIGNAL_DEFAULT. A specific
976 PTID means `step/resume only this process id'. A wildcard PTID
977 (all threads, or all threads of process) means `step/resume
978 INFERIOR_PTID, and let other threads (for which the wildcard PTID
979 matches) resume with their 'thread->suspend.stop_signal' signal
980 (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
981 if in "no pass" state. */
c906108c 982
2ea28649 983extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
c906108c 984
b5a2688f
AC
985/* Wait for process pid to do something. PTID = -1 to wait for any
986 pid to do something. Return pid of child, or -1 in case of error;
c906108c 987 store status through argument pointer STATUS. Note that it is
b5a2688f 988 _NOT_ OK to throw_exception() out of target_wait() without popping
c906108c
SS
989 the debugging target from the stack; GDB isn't prepared to get back
990 to the prompt with a debugging target but without the frame cache,
47608cb1
PA
991 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
992 options. */
c906108c 993
47608cb1
PA
994extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
995 int options);
c906108c 996
17dee195 997/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c 998
28439f5e 999extern void target_fetch_registers (struct regcache *regcache, int regno);
c906108c
SS
1000
1001/* Store at least register REGNO, or all regs if REGNO == -1.
1002 It can store as many registers as it wants to, so target_prepare_to_store
1003 must have been previously called. Calls error() if there are problems. */
1004
28439f5e 1005extern void target_store_registers (struct regcache *regcache, int regs);
c906108c
SS
1006
1007/* Get ready to modify the registers array. On machines which store
1008 individual registers, this doesn't need to do anything. On machines
1009 which store all the registers in one fell swoop, this makes sure
1010 that REGISTERS contains all the registers from the program being
1011 debugged. */
1012
316f2060
UW
1013#define target_prepare_to_store(regcache) \
1014 (*current_target.to_prepare_to_store) (regcache)
c906108c 1015
6c95b8df
PA
1016/* Determine current address space of thread PTID. */
1017
1018struct address_space *target_thread_address_space (ptid_t);
1019
451b7c33
TT
1020/* Implement the "info proc" command. This returns one if the request
1021 was handled, and zero otherwise. It can also throw an exception if
1022 an error was encountered while attempting to handle the
1023 request. */
145b16a9 1024
451b7c33 1025int target_info_proc (char *, enum info_proc_what);
145b16a9 1026
8a305172
PA
1027/* Returns true if this target can debug multiple processes
1028 simultaneously. */
1029
1030#define target_supports_multi_process() \
1031 (*current_target.to_supports_multi_process) ()
1032
03583c20
UW
1033/* Returns true if this target can disable address space randomization. */
1034
1035int target_supports_disable_randomization (void);
1036
d248b706
KY
1037/* Returns true if this target can enable and disable tracepoints
1038 while a trace experiment is running. */
1039
1040#define target_supports_enable_disable_tracepoint() \
1041 (*current_target.to_supports_enable_disable_tracepoint) ()
1042
3065dfb6
SS
1043#define target_supports_string_tracing() \
1044 (*current_target.to_supports_string_tracing) ()
1045
b775012e
LM
1046/* Returns true if this target can handle breakpoint conditions
1047 on its end. */
1048
1049#define target_supports_evaluation_of_breakpoint_conditions() \
1050 (*current_target.to_supports_evaluation_of_breakpoint_conditions) ()
1051
d3ce09f5
SS
1052/* Returns true if this target can handle breakpoint commands
1053 on its end. */
1054
1055#define target_can_run_breakpoint_commands() \
1056 (*current_target.to_can_run_breakpoint_commands) ()
1057
a14ed312 1058extern int target_read_string (CORE_ADDR, char **, int, int *);
c906108c 1059
5299c1c4 1060extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1b162304 1061 ssize_t len);
c906108c 1062
aee4bf85
PA
1063extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1064 ssize_t len);
1065
45aa4659 1066extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
4e5d721f 1067
29453a14
YQ
1068extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1069
fc1a4b47 1070extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1071 ssize_t len);
c906108c 1072
f0ba3972 1073extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1074 ssize_t len);
f0ba3972 1075
fd79ecee
DJ
1076/* Fetches the target's memory map. If one is found it is sorted
1077 and returned, after some consistency checking. Otherwise, NULL
1078 is returned. */
1079VEC(mem_region_s) *target_memory_map (void);
1080
a76d924d
DJ
1081/* Erase the specified flash region. */
1082void target_flash_erase (ULONGEST address, LONGEST length);
1083
1084/* Finish a sequence of flash operations. */
1085void target_flash_done (void);
1086
1087/* Describes a request for a memory write operation. */
1088struct memory_write_request
1089 {
c378eb4e 1090 /* Begining address that must be written. */
a76d924d 1091 ULONGEST begin;
c378eb4e 1092 /* Past-the-end address. */
a76d924d 1093 ULONGEST end;
c378eb4e 1094 /* The data to write. */
a76d924d
DJ
1095 gdb_byte *data;
1096 /* A callback baton for progress reporting for this request. */
1097 void *baton;
1098 };
1099typedef struct memory_write_request memory_write_request_s;
1100DEF_VEC_O(memory_write_request_s);
1101
1102/* Enumeration specifying different flash preservation behaviour. */
1103enum flash_preserve_mode
1104 {
1105 flash_preserve,
1106 flash_discard
1107 };
1108
1109/* Write several memory blocks at once. This version can be more
1110 efficient than making several calls to target_write_memory, in
1111 particular because it can optimize accesses to flash memory.
1112
1113 Moreover, this is currently the only memory access function in gdb
1114 that supports writing to flash memory, and it should be used for
1115 all cases where access to flash memory is desirable.
1116
1117 REQUESTS is the vector (see vec.h) of memory_write_request.
1118 PRESERVE_FLASH_P indicates what to do with blocks which must be
1119 erased, but not completely rewritten.
1120 PROGRESS_CB is a function that will be periodically called to provide
1121 feedback to user. It will be called with the baton corresponding
1122 to the request currently being written. It may also be called
1123 with a NULL baton, when preserved flash sectors are being rewritten.
1124
1125 The function returns 0 on success, and error otherwise. */
1126int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1127 enum flash_preserve_mode preserve_flash_p,
1128 void (*progress_cb) (ULONGEST, void *));
1129
c906108c
SS
1130/* Print a line about the current target. */
1131
1132#define target_files_info() \
0d06e24b 1133 (*current_target.to_files_info) (&current_target)
c906108c 1134
0000e5cc
PA
1135/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1136 the target machine. Returns 0 for success, and returns non-zero or
1137 throws an error (with a detailed failure reason error code and
1138 message) otherwise. */
c906108c 1139
d914c394
SS
1140extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1141 struct bp_target_info *bp_tgt);
c906108c 1142
8181d85f 1143/* Remove a breakpoint at address BP_TGT->placed_address in the target
578d3588 1144 machine. Result is 0 for success, non-zero for error. */
c906108c 1145
d914c394
SS
1146extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1147 struct bp_target_info *bp_tgt);
c906108c
SS
1148
1149/* Initialize the terminal settings we record for the inferior,
1150 before we actually run the inferior. */
1151
1152#define target_terminal_init() \
0d06e24b 1153 (*current_target.to_terminal_init) ()
c906108c
SS
1154
1155/* Put the inferior's terminal settings into effect.
1156 This is preparation for starting or resuming the inferior. */
1157
d9d2d8b6 1158extern void target_terminal_inferior (void);
c906108c
SS
1159
1160/* Put some of our terminal settings into effect,
1161 enough to get proper results from our output,
1162 but do not change into or out of RAW mode
1163 so that no input is discarded.
1164
1165 After doing this, either terminal_ours or terminal_inferior
1166 should be called to get back to a normal state of affairs. */
1167
1168#define target_terminal_ours_for_output() \
0d06e24b 1169 (*current_target.to_terminal_ours_for_output) ()
c906108c
SS
1170
1171/* Put our terminal settings into effect.
1172 First record the inferior's terminal settings
1173 so they can be restored properly later. */
1174
1175#define target_terminal_ours() \
0d06e24b 1176 (*current_target.to_terminal_ours) ()
c906108c 1177
a790ad35
SC
1178/* Save our terminal settings.
1179 This is called from TUI after entering or leaving the curses
1180 mode. Since curses modifies our terminal this call is here
1181 to take this change into account. */
1182
1183#define target_terminal_save_ours() \
1184 (*current_target.to_terminal_save_ours) ()
1185
c906108c
SS
1186/* Print useful information about our terminal status, if such a thing
1187 exists. */
1188
1189#define target_terminal_info(arg, from_tty) \
0d06e24b 1190 (*current_target.to_terminal_info) (arg, from_tty)
c906108c
SS
1191
1192/* Kill the inferior process. Make it go away. */
1193
7d85a9c0 1194extern void target_kill (void);
c906108c 1195
0d06e24b
JM
1196/* Load an executable file into the target process. This is expected
1197 to not only bring new code into the target process, but also to
1986bccd
AS
1198 update GDB's symbol tables to match.
1199
1200 ARG contains command-line arguments, to be broken down with
1201 buildargv (). The first non-switch argument is the filename to
1202 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1203 0)), which is an offset to apply to the load addresses of FILE's
1204 sections. The target may define switches, or other non-switch
1205 arguments, as it pleases. */
c906108c 1206
11cf8741 1207extern void target_load (char *arg, int from_tty);
c906108c 1208
39f77062 1209/* Start an inferior process and set inferior_ptid to its pid.
c906108c
SS
1210 EXEC_FILE is the file to run.
1211 ALLARGS is a string containing the arguments to the program.
1212 ENV is the environment vector to pass. Errors reported with error().
1213 On VxWorks and various standalone systems, we ignore exec_file. */
c5aa993b 1214
136d6dae
VP
1215void target_create_inferior (char *exec_file, char *args,
1216 char **env, int from_tty);
c906108c
SS
1217
1218/* Some targets (such as ttrace-based HPUX) don't allow us to request
1219 notification of inferior events such as fork and vork immediately
1220 after the inferior is created. (This because of how gdb gets an
1221 inferior created via invoking a shell to do it. In such a scenario,
1222 if the shell init file has commands in it, the shell will fork and
1223 exec for each of those commands, and we will see each such fork
1224 event. Very bad.)
c5aa993b 1225
0d06e24b
JM
1226 Such targets will supply an appropriate definition for this function. */
1227
39f77062
KB
1228#define target_post_startup_inferior(ptid) \
1229 (*current_target.to_post_startup_inferior) (ptid)
c906108c 1230
0d06e24b
JM
1231/* On some targets, we can catch an inferior fork or vfork event when
1232 it occurs. These functions insert/remove an already-created
77b06cd7
TJB
1233 catchpoint for such events. They return 0 for success, 1 if the
1234 catchpoint type is not supported and -1 for failure. */
c906108c 1235
c906108c 1236#define target_insert_fork_catchpoint(pid) \
0d06e24b 1237 (*current_target.to_insert_fork_catchpoint) (pid)
c906108c
SS
1238
1239#define target_remove_fork_catchpoint(pid) \
0d06e24b 1240 (*current_target.to_remove_fork_catchpoint) (pid)
c906108c
SS
1241
1242#define target_insert_vfork_catchpoint(pid) \
0d06e24b 1243 (*current_target.to_insert_vfork_catchpoint) (pid)
c906108c
SS
1244
1245#define target_remove_vfork_catchpoint(pid) \
0d06e24b 1246 (*current_target.to_remove_vfork_catchpoint) (pid)
c906108c 1247
6604731b
DJ
1248/* If the inferior forks or vforks, this function will be called at
1249 the next resume in order to perform any bookkeeping and fiddling
1250 necessary to continue debugging either the parent or child, as
1251 requested, and releasing the other. Information about the fork
1252 or vfork event is available via get_last_target_status ().
1253 This function returns 1 if the inferior should not be resumed
1254 (i.e. there is another event pending). */
0d06e24b 1255
07107ca6 1256int target_follow_fork (int follow_child, int detach_fork);
c906108c
SS
1257
1258/* On some targets, we can catch an inferior exec event when it
0d06e24b 1259 occurs. These functions insert/remove an already-created
77b06cd7
TJB
1260 catchpoint for such events. They return 0 for success, 1 if the
1261 catchpoint type is not supported and -1 for failure. */
0d06e24b 1262
c906108c 1263#define target_insert_exec_catchpoint(pid) \
0d06e24b 1264 (*current_target.to_insert_exec_catchpoint) (pid)
c5aa993b 1265
c906108c 1266#define target_remove_exec_catchpoint(pid) \
0d06e24b 1267 (*current_target.to_remove_exec_catchpoint) (pid)
c906108c 1268
a96d9b2e
SDJ
1269/* Syscall catch.
1270
1271 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1272 If NEEDED is zero, it means the target can disable the mechanism to
1273 catch system calls because there are no more catchpoints of this type.
1274
1275 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1276 being requested. In this case, both TABLE_SIZE and TABLE should
1277 be ignored.
1278
1279 TABLE_SIZE is the number of elements in TABLE. It only matters if
1280 ANY_COUNT is zero.
1281
1282 TABLE is an array of ints, indexed by syscall number. An element in
1283 this array is nonzero if that syscall should be caught. This argument
77b06cd7
TJB
1284 only matters if ANY_COUNT is zero.
1285
1286 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1287 for failure. */
a96d9b2e
SDJ
1288
1289#define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1290 (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
1291 table_size, table)
1292
c906108c 1293/* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
0d06e24b
JM
1294 exit code of PID, if any. */
1295
c906108c 1296#define target_has_exited(pid,wait_status,exit_status) \
0d06e24b 1297 (*current_target.to_has_exited) (pid,wait_status,exit_status)
c906108c
SS
1298
1299/* The debugger has completed a blocking wait() call. There is now
2146d243 1300 some process event that must be processed. This function should
c906108c 1301 be defined by those targets that require the debugger to perform
0d06e24b 1302 cleanup or internal state changes in response to the process event. */
c906108c
SS
1303
1304/* The inferior process has died. Do what is right. */
1305
136d6dae 1306void target_mourn_inferior (void);
c906108c
SS
1307
1308/* Does target have enough data to do a run or attach command? */
1309
1310#define target_can_run(t) \
0d06e24b 1311 ((t)->to_can_run) ()
c906108c 1312
2455069d
UW
1313/* Set list of signals to be handled in the target.
1314
1315 PASS_SIGNALS is an array of size NSIG, indexed by target signal number
2ea28649 1316 (enum gdb_signal). For every signal whose entry in this array is
2455069d
UW
1317 non-zero, the target is allowed -but not required- to skip reporting
1318 arrival of the signal to the GDB core by returning from target_wait,
1319 and to pass the signal directly to the inferior instead.
1320
1321 However, if the target is hardware single-stepping a thread that is
1322 about to receive a signal, it needs to be reported in any case, even
1323 if mentioned in a previous target_pass_signals call. */
c906108c 1324
2455069d 1325extern void target_pass_signals (int nsig, unsigned char *pass_signals);
c906108c 1326
9b224c5e
PA
1327/* Set list of signals the target may pass to the inferior. This
1328 directly maps to the "handle SIGNAL pass/nopass" setting.
1329
1330 PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
2ea28649 1331 number (enum gdb_signal). For every signal whose entry in this
9b224c5e
PA
1332 array is non-zero, the target is allowed to pass the signal to the
1333 inferior. Signals not present in the array shall be silently
1334 discarded. This does not influence whether to pass signals to the
1335 inferior as a result of a target_resume call. This is useful in
1336 scenarios where the target needs to decide whether to pass or not a
1337 signal to the inferior without GDB core involvement, such as for
1338 example, when detaching (as threads may have been suspended with
1339 pending signals not reported to GDB). */
1340
1341extern void target_program_signals (int nsig, unsigned char *program_signals);
1342
c906108c
SS
1343/* Check to see if a thread is still alive. */
1344
28439f5e 1345extern int target_thread_alive (ptid_t ptid);
c906108c 1346
b83266a0
SS
1347/* Query for new threads and add them to the thread list. */
1348
28439f5e 1349extern void target_find_new_threads (void);
b83266a0 1350
0d06e24b
JM
1351/* Make target stop in a continuable fashion. (For instance, under
1352 Unix, this should act like SIGSTOP). This function is normally
1353 used by GUIs to implement a stop button. */
c906108c 1354
d914c394 1355extern void target_stop (ptid_t ptid);
c906108c 1356
96baa820
JM
1357/* Send the specified COMMAND to the target's monitor
1358 (shell,interpreter) for execution. The result of the query is
0d06e24b 1359 placed in OUTBUF. */
96baa820
JM
1360
1361#define target_rcmd(command, outbuf) \
1362 (*current_target.to_rcmd) (command, outbuf)
1363
1364
c906108c
SS
1365/* Does the target include all of memory, or only part of it? This
1366 determines whether we look up the target chain for other parts of
1367 memory if this target can't satisfy a request. */
1368
c35b1492
PA
1369extern int target_has_all_memory_1 (void);
1370#define target_has_all_memory target_has_all_memory_1 ()
c906108c
SS
1371
1372/* Does the target include memory? (Dummy targets don't.) */
1373
c35b1492
PA
1374extern int target_has_memory_1 (void);
1375#define target_has_memory target_has_memory_1 ()
c906108c
SS
1376
1377/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1378 we start a process.) */
c5aa993b 1379
c35b1492
PA
1380extern int target_has_stack_1 (void);
1381#define target_has_stack target_has_stack_1 ()
c906108c
SS
1382
1383/* Does the target have registers? (Exec files don't.) */
1384
c35b1492
PA
1385extern int target_has_registers_1 (void);
1386#define target_has_registers target_has_registers_1 ()
c906108c
SS
1387
1388/* Does the target have execution? Can we make it jump (through
52bb452f
DJ
1389 hoops), or pop its stack a few times? This means that the current
1390 target is currently executing; for some targets, that's the same as
1391 whether or not the target is capable of execution, but there are
1392 also targets which can be current while not executing. In that
1393 case this will become true after target_create_inferior or
1394 target_attach. */
c906108c 1395
aeaec162
TT
1396extern int target_has_execution_1 (ptid_t);
1397
1398/* Like target_has_execution_1, but always passes inferior_ptid. */
1399
1400extern int target_has_execution_current (void);
1401
1402#define target_has_execution target_has_execution_current ()
c35b1492
PA
1403
1404/* Default implementations for process_stratum targets. Return true
1405 if there's a selected inferior, false otherwise. */
1406
1407extern int default_child_has_all_memory (struct target_ops *ops);
1408extern int default_child_has_memory (struct target_ops *ops);
1409extern int default_child_has_stack (struct target_ops *ops);
1410extern int default_child_has_registers (struct target_ops *ops);
aeaec162
TT
1411extern int default_child_has_execution (struct target_ops *ops,
1412 ptid_t the_ptid);
c906108c
SS
1413
1414/* Can the target support the debugger control of thread execution?
d6350901 1415 Can it lock the thread scheduler? */
c906108c
SS
1416
1417#define target_can_lock_scheduler \
0d06e24b 1418 (current_target.to_has_thread_control & tc_schedlock)
c906108c 1419
c6ebd6cf
VP
1420/* Should the target enable async mode if it is supported? Temporary
1421 cludge until async mode is a strict superset of sync mode. */
1422extern int target_async_permitted;
1423
c378eb4e 1424/* Can the target support asynchronous execution? */
6426a772
JM
1425#define target_can_async_p() (current_target.to_can_async_p ())
1426
c378eb4e 1427/* Is the target in asynchronous execution mode? */
b84876c2 1428#define target_is_async_p() (current_target.to_is_async_p ())
6426a772 1429
9908b566
VP
1430int target_supports_non_stop (void);
1431
c378eb4e 1432/* Put the target in async mode with the specified callback function. */
0d06e24b 1433#define target_async(CALLBACK,CONTEXT) \
b84876c2 1434 (current_target.to_async ((CALLBACK), (CONTEXT)))
43ff13b4 1435
32231432
PA
1436#define target_execution_direction() \
1437 (current_target.to_execution_direction ())
1438
c906108c
SS
1439/* Converts a process id to a string. Usually, the string just contains
1440 `process xyz', but on some systems it may contain
1441 `process xyz thread abc'. */
1442
117de6a9 1443extern char *target_pid_to_str (ptid_t ptid);
c906108c 1444
39f77062 1445extern char *normal_pid_to_str (ptid_t ptid);
c5aa993b 1446
0d06e24b
JM
1447/* Return a short string describing extra information about PID,
1448 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1449 is okay. */
1450
1451#define target_extra_thread_info(TP) \
1452 (current_target.to_extra_thread_info (TP))
ed9a39eb 1453
4694da01
TT
1454/* Return the thread's name. A NULL result means that the target
1455 could not determine this thread's name. */
1456
1457extern char *target_thread_name (struct thread_info *);
1458
c906108c
SS
1459/* Attempts to find the pathname of the executable file
1460 that was run to create a specified process.
1461
1462 The process PID must be stopped when this operation is used.
c5aa993b 1463
c906108c
SS
1464 If the executable file cannot be determined, NULL is returned.
1465
1466 Else, a pointer to a character string containing the pathname
1467 is returned. This string should be copied into a buffer by
1468 the client if the string will not be immediately used, or if
0d06e24b 1469 it must persist. */
c906108c
SS
1470
1471#define target_pid_to_exec_file(pid) \
0d06e24b 1472 (current_target.to_pid_to_exec_file) (pid)
c906108c 1473
3a8f7b07 1474/* See the to_thread_architecture description in struct target_ops. */
c2250ad1
UW
1475
1476#define target_thread_architecture(ptid) \
1477 (current_target.to_thread_architecture (&current_target, ptid))
1478
be4d1333
MS
1479/*
1480 * Iterator function for target memory regions.
1481 * Calls a callback function once for each memory region 'mapped'
1482 * in the child process. Defined as a simple macro rather than
2146d243 1483 * as a function macro so that it can be tested for nullity.
be4d1333
MS
1484 */
1485
1486#define target_find_memory_regions(FUNC, DATA) \
1487 (current_target.to_find_memory_regions) (FUNC, DATA)
1488
1489/*
1490 * Compose corefile .note section.
1491 */
1492
1493#define target_make_corefile_notes(BFD, SIZE_P) \
1494 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1495
6b04bdb7
MS
1496/* Bookmark interfaces. */
1497#define target_get_bookmark(ARGS, FROM_TTY) \
1498 (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1499
1500#define target_goto_bookmark(ARG, FROM_TTY) \
1501 (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1502
c906108c
SS
1503/* Hardware watchpoint interfaces. */
1504
1505/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
7f82dfc7 1506 write). Only the INFERIOR_PTID task is being queried. */
c906108c 1507
d92524f1
PM
1508#define target_stopped_by_watchpoint \
1509 (*current_target.to_stopped_by_watchpoint)
7df1a324 1510
74174d2e
UW
1511/* Non-zero if we have steppable watchpoints */
1512
d92524f1 1513#define target_have_steppable_watchpoint \
74174d2e 1514 (current_target.to_have_steppable_watchpoint)
74174d2e 1515
7df1a324
KW
1516/* Non-zero if we have continuable watchpoints */
1517
d92524f1 1518#define target_have_continuable_watchpoint \
7df1a324 1519 (current_target.to_have_continuable_watchpoint)
c906108c 1520
ccaa32c7 1521/* Provide defaults for hardware watchpoint functions. */
c906108c 1522
2146d243 1523/* If the *_hw_beakpoint functions have not been defined
ccaa32c7 1524 elsewhere use the definitions in the target vector. */
c906108c
SS
1525
1526/* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1527 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1528 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1529 (including this one?). OTHERTYPE is who knows what... */
1530
d92524f1 1531#define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
ccaa32c7 1532 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
c906108c 1533
e09342b5
TJB
1534/* Returns the number of debug registers needed to watch the given
1535 memory region, or zero if not supported. */
1536
d92524f1 1537#define target_region_ok_for_hw_watchpoint(addr, len) \
e0d24f8d 1538 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
e0d24f8d 1539
c906108c 1540
85d721b8
PA
1541/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1542 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
0cf6dd15 1543 COND is the expression for its condition, or NULL if there's none.
85d721b8
PA
1544 Returns 0 for success, 1 if the watchpoint type is not supported,
1545 -1 for failure. */
c906108c 1546
0cf6dd15
TJB
1547#define target_insert_watchpoint(addr, len, type, cond) \
1548 (*current_target.to_insert_watchpoint) (addr, len, type, cond)
c906108c 1549
0cf6dd15
TJB
1550#define target_remove_watchpoint(addr, len, type, cond) \
1551 (*current_target.to_remove_watchpoint) (addr, len, type, cond)
c906108c 1552
9c06b0b4
TJB
1553/* Insert a new masked watchpoint at ADDR using the mask MASK.
1554 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1555 or hw_access for an access watchpoint. Returns 0 for success, 1 if
1556 masked watchpoints are not supported, -1 for failure. */
1557
1558extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1559
1560/* Remove a masked watchpoint at ADDR with the mask MASK.
1561 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1562 or hw_access for an access watchpoint. Returns 0 for success, non-zero
1563 for failure. */
1564
1565extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1566
0000e5cc
PA
1567/* Insert a hardware breakpoint at address BP_TGT->placed_address in
1568 the target machine. Returns 0 for success, and returns non-zero or
1569 throws an error (with a detailed failure reason error code and
1570 message) otherwise. */
1571
a6d9a66e
UW
1572#define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1573 (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
ccaa32c7 1574
a6d9a66e
UW
1575#define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1576 (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
c906108c 1577
f1310107
TJB
1578/* Return number of debug registers needed for a ranged breakpoint,
1579 or -1 if ranged breakpoints are not supported. */
1580
1581extern int target_ranged_break_num_registers (void);
1582
7f82dfc7
JK
1583/* Return non-zero if target knows the data address which triggered this
1584 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1585 INFERIOR_PTID task is being queried. */
1586#define target_stopped_data_address(target, addr_p) \
1587 (*target.to_stopped_data_address) (target, addr_p)
c906108c 1588
9b3e86b1
MR
1589/* Return non-zero if ADDR is within the range of a watchpoint spanning
1590 LENGTH bytes beginning at START. */
5009afc5
AS
1591#define target_watchpoint_addr_within_range(target, addr, start, length) \
1592 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1593
0cf6dd15
TJB
1594/* Return non-zero if the target is capable of using hardware to evaluate
1595 the condition expression. In this case, if the condition is false when
1596 the watched memory location changes, execution may continue without the
1597 debugger being notified.
1598
1599 Due to limitations in the hardware implementation, it may be capable of
1600 avoiding triggering the watchpoint in some cases where the condition
1601 expression is false, but may report some false positives as well.
1602 For this reason, GDB will still evaluate the condition expression when
1603 the watchpoint triggers. */
1604#define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1605 (*current_target.to_can_accel_watchpoint_condition) (addr, len, type, cond)
1606
9c06b0b4
TJB
1607/* Return number of debug registers needed for a masked watchpoint,
1608 -1 if masked watchpoints are not supported or -2 if the given address
1609 and mask combination cannot be used. */
1610
1611extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1612
b2175913
MS
1613/* Target can execute in reverse? */
1614#define target_can_execute_reverse \
1615 (current_target.to_can_execute_reverse ? \
1616 current_target.to_can_execute_reverse () : 0)
1617
424163ea
DJ
1618extern const struct target_desc *target_read_description (struct target_ops *);
1619
0ef643c8
JB
1620#define target_get_ada_task_ptid(lwp, tid) \
1621 (*current_target.to_get_ada_task_ptid) (lwp,tid)
1622
08388c79
DE
1623/* Utility implementation of searching memory. */
1624extern int simple_search_memory (struct target_ops* ops,
1625 CORE_ADDR start_addr,
1626 ULONGEST search_space_len,
1627 const gdb_byte *pattern,
1628 ULONGEST pattern_len,
1629 CORE_ADDR *found_addrp);
1630
1631/* Main entry point for searching memory. */
1632extern int target_search_memory (CORE_ADDR start_addr,
1633 ULONGEST search_space_len,
1634 const gdb_byte *pattern,
1635 ULONGEST pattern_len,
1636 CORE_ADDR *found_addrp);
1637
7313baad
UW
1638/* Target file operations. */
1639
1640/* Open FILENAME on the target, using FLAGS and MODE. Return a
1641 target file descriptor, or -1 if an error occurs (and set
1642 *TARGET_ERRNO). */
1643extern int target_fileio_open (const char *filename, int flags, int mode,
1644 int *target_errno);
1645
1646/* Write up to LEN bytes from WRITE_BUF to FD on the target.
1647 Return the number of bytes written, or -1 if an error occurs
1648 (and set *TARGET_ERRNO). */
1649extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1650 ULONGEST offset, int *target_errno);
1651
1652/* Read up to LEN bytes FD on the target into READ_BUF.
1653 Return the number of bytes read, or -1 if an error occurs
1654 (and set *TARGET_ERRNO). */
1655extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1656 ULONGEST offset, int *target_errno);
1657
1658/* Close FD on the target. Return 0, or -1 if an error occurs
1659 (and set *TARGET_ERRNO). */
1660extern int target_fileio_close (int fd, int *target_errno);
1661
1662/* Unlink FILENAME on the target. Return 0, or -1 if an error
1663 occurs (and set *TARGET_ERRNO). */
1664extern int target_fileio_unlink (const char *filename, int *target_errno);
1665
b9e7b9c3
UW
1666/* Read value of symbolic link FILENAME on the target. Return a
1667 null-terminated string allocated via xmalloc, or NULL if an error
1668 occurs (and set *TARGET_ERRNO). */
1669extern char *target_fileio_readlink (const char *filename, int *target_errno);
1670
7313baad
UW
1671/* Read target file FILENAME. The return value will be -1 if the transfer
1672 fails or is not supported; 0 if the object is empty; or the length
1673 of the object otherwise. If a positive value is returned, a
1674 sufficiently large buffer will be allocated using xmalloc and
1675 returned in *BUF_P containing the contents of the object.
1676
1677 This method should be used for objects sufficiently small to store
1678 in a single xmalloc'd buffer, when no fixed bound on the object's
1679 size is known in advance. */
1680extern LONGEST target_fileio_read_alloc (const char *filename,
1681 gdb_byte **buf_p);
1682
1683/* Read target file FILENAME. The result is NUL-terminated and
1684 returned as a string, allocated using xmalloc. If an error occurs
1685 or the transfer is unsupported, NULL is returned. Empty objects
1686 are returned as allocated but empty strings. A warning is issued
1687 if the result contains any embedded NUL bytes. */
1688extern char *target_fileio_read_stralloc (const char *filename);
1689
1690
35b1e5cc
SS
1691/* Tracepoint-related operations. */
1692
1693#define target_trace_init() \
1694 (*current_target.to_trace_init) ()
1695
1696#define target_download_tracepoint(t) \
1697 (*current_target.to_download_tracepoint) (t)
1698
1e4d1764
YQ
1699#define target_can_download_tracepoint() \
1700 (*current_target.to_can_download_tracepoint) ()
1701
35b1e5cc
SS
1702#define target_download_trace_state_variable(tsv) \
1703 (*current_target.to_download_trace_state_variable) (tsv)
1704
d248b706
KY
1705#define target_enable_tracepoint(loc) \
1706 (*current_target.to_enable_tracepoint) (loc)
1707
1708#define target_disable_tracepoint(loc) \
1709 (*current_target.to_disable_tracepoint) (loc)
1710
35b1e5cc
SS
1711#define target_trace_start() \
1712 (*current_target.to_trace_start) ()
1713
1714#define target_trace_set_readonly_regions() \
1715 (*current_target.to_trace_set_readonly_regions) ()
1716
00bf0b85
SS
1717#define target_get_trace_status(ts) \
1718 (*current_target.to_get_trace_status) (ts)
35b1e5cc 1719
f196051f
SS
1720#define target_get_tracepoint_status(tp,utp) \
1721 (*current_target.to_get_tracepoint_status) (tp, utp)
1722
35b1e5cc
SS
1723#define target_trace_stop() \
1724 (*current_target.to_trace_stop) ()
1725
1726#define target_trace_find(type,num,addr1,addr2,tpp) \
1727 (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1728
1729#define target_get_trace_state_variable_value(tsv,val) \
1730 (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1731
00bf0b85
SS
1732#define target_save_trace_data(filename) \
1733 (*current_target.to_save_trace_data) (filename)
1734
1735#define target_upload_tracepoints(utpp) \
1736 (*current_target.to_upload_tracepoints) (utpp)
1737
1738#define target_upload_trace_state_variables(utsvp) \
1739 (*current_target.to_upload_trace_state_variables) (utsvp)
1740
1741#define target_get_raw_trace_data(buf,offset,len) \
1742 (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1743
405f8e94
SS
1744#define target_get_min_fast_tracepoint_insn_len() \
1745 (*current_target.to_get_min_fast_tracepoint_insn_len) ()
1746
35b1e5cc
SS
1747#define target_set_disconnected_tracing(val) \
1748 (*current_target.to_set_disconnected_tracing) (val)
1749
4daf5ac0
SS
1750#define target_set_circular_trace_buffer(val) \
1751 (*current_target.to_set_circular_trace_buffer) (val)
1752
f6f899bf
HAQ
1753#define target_set_trace_buffer_size(val) \
1754 (*current_target.to_set_trace_buffer_size) (val)
1755
f196051f
SS
1756#define target_set_trace_notes(user,notes,stopnotes) \
1757 (*current_target.to_set_trace_notes) ((user), (notes), (stopnotes))
1758
711e434b
PM
1759#define target_get_tib_address(ptid, addr) \
1760 (*current_target.to_get_tib_address) ((ptid), (addr))
1761
d914c394
SS
1762#define target_set_permissions() \
1763 (*current_target.to_set_permissions) ()
1764
0fb4aa4b
PA
1765#define target_static_tracepoint_marker_at(addr, marker) \
1766 (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1767
1768#define target_static_tracepoint_markers_by_strid(marker_id) \
1769 (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1770
b3b9301e
PA
1771#define target_traceframe_info() \
1772 (*current_target.to_traceframe_info) ()
1773
d1feda86
YQ
1774#define target_use_agent(use) \
1775 (*current_target.to_use_agent) (use)
1776
1777#define target_can_use_agent() \
1778 (*current_target.to_can_use_agent) ()
1779
ced63ec0
GB
1780#define target_augmented_libraries_svr4_read() \
1781 (*current_target.to_augmented_libraries_svr4_read) ()
1782
49d03eab
MR
1783/* Command logging facility. */
1784
1785#define target_log_command(p) \
1786 do \
1787 if (current_target.to_log_command) \
1788 (*current_target.to_log_command) (p); \
1789 while (0)
1790
dc146f7c
VP
1791
1792extern int target_core_of_thread (ptid_t ptid);
1793
4a5e7a5b
PA
1794/* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1795 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1796 if there's a mismatch, and -1 if an error is encountered while
1797 reading memory. Throws an error if the functionality is found not
1798 to be supported by the current target. */
1799int target_verify_memory (const gdb_byte *data,
1800 CORE_ADDR memaddr, ULONGEST size);
1801
c906108c
SS
1802/* Routines for maintenance of the target structures...
1803
c22a2b88
TT
1804 complete_target_initialization: Finalize a target_ops by filling in
1805 any fields needed by the target implementation.
1806
c906108c
SS
1807 add_target: Add a target to the list of all possible targets.
1808
1809 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
1810 targets, within its particular stratum of the stack. Result
1811 is 0 if now atop the stack, nonzero if not on top (maybe
1812 should warn user).
c906108c
SS
1813
1814 unpush_target: Remove this from the stack of currently used targets,
c5aa993b 1815 no matter where it is on the list. Returns 0 if no
7fdc1521 1816 change, 1 if removed from stack. */
c906108c 1817
a14ed312 1818extern void add_target (struct target_ops *);
c906108c 1819
9852c492
YQ
1820extern void add_target_with_completer (struct target_ops *t,
1821 completer_ftype *completer);
1822
c22a2b88
TT
1823extern void complete_target_initialization (struct target_ops *t);
1824
b48d48eb
MM
1825/* Adds a command ALIAS for target T and marks it deprecated. This is useful
1826 for maintaining backwards compatibility when renaming targets. */
1827
1828extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
1829
b26a4dcb 1830extern void push_target (struct target_ops *);
c906108c 1831
a14ed312 1832extern int unpush_target (struct target_ops *);
c906108c 1833
fd79ecee
DJ
1834extern void target_pre_inferior (int);
1835
a14ed312 1836extern void target_preopen (int);
c906108c 1837
460014f5
JK
1838/* Does whatever cleanup is required to get rid of all pushed targets. */
1839extern void pop_all_targets (void);
aa76d38d 1840
87ab71f0
PA
1841/* Like pop_all_targets, but pops only targets whose stratum is
1842 strictly above ABOVE_STRATUM. */
460014f5 1843extern void pop_all_targets_above (enum strata above_stratum);
87ab71f0 1844
c0edd9ed
JK
1845extern int target_is_pushed (struct target_ops *t);
1846
9e35dae4
DJ
1847extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1848 CORE_ADDR offset);
1849
0542c86d 1850/* Struct target_section maps address ranges to file sections. It is
c906108c
SS
1851 mostly used with BFD files, but can be used without (e.g. for handling
1852 raw disks, or files not in formats handled by BFD). */
1853
0542c86d 1854struct target_section
c5aa993b
JM
1855 {
1856 CORE_ADDR addr; /* Lowest address in section */
1857 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 1858
7be0c536 1859 struct bfd_section *the_bfd_section;
c906108c 1860
046ac79f
JK
1861 /* The "owner" of the section.
1862 It can be any unique value. It is set by add_target_sections
1863 and used by remove_target_sections.
1864 For example, for executables it is a pointer to exec_bfd and
1865 for shlibs it is the so_list pointer. */
1866 void *owner;
c5aa993b 1867 };
c906108c 1868
07b82ea5
PA
1869/* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1870
1871struct target_section_table
1872{
1873 struct target_section *sections;
1874 struct target_section *sections_end;
1875};
1876
8db32d44 1877/* Return the "section" containing the specified address. */
0542c86d
PA
1878struct target_section *target_section_by_addr (struct target_ops *target,
1879 CORE_ADDR addr);
8db32d44 1880
07b82ea5
PA
1881/* Return the target section table this target (or the targets
1882 beneath) currently manipulate. */
1883
1884extern struct target_section_table *target_get_section_table
1885 (struct target_ops *target);
1886
c906108c
SS
1887/* From mem-break.c */
1888
3e43a32a
MS
1889extern int memory_remove_breakpoint (struct gdbarch *,
1890 struct bp_target_info *);
c906108c 1891
3e43a32a
MS
1892extern int memory_insert_breakpoint (struct gdbarch *,
1893 struct bp_target_info *);
c906108c 1894
3e43a32a
MS
1895extern int default_memory_remove_breakpoint (struct gdbarch *,
1896 struct bp_target_info *);
917317f4 1897
3e43a32a
MS
1898extern int default_memory_insert_breakpoint (struct gdbarch *,
1899 struct bp_target_info *);
917317f4 1900
c906108c
SS
1901
1902/* From target.c */
1903
a14ed312 1904extern void initialize_targets (void);
c906108c 1905
c25c4a8b 1906extern void noprocess (void) ATTRIBUTE_NORETURN;
c906108c 1907
8edfe269
DJ
1908extern void target_require_runnable (void);
1909
136d6dae 1910extern void find_default_attach (struct target_ops *, char *, int);
c906108c 1911
136d6dae
VP
1912extern void find_default_create_inferior (struct target_ops *,
1913 char *, char *, char **, int);
c906108c 1914
a14ed312 1915extern struct target_ops *find_target_beneath (struct target_ops *);
ed9a39eb 1916
e0665bc8
PA
1917/* Read OS data object of type TYPE from the target, and return it in
1918 XML format. The result is NUL-terminated and returned as a string,
1919 allocated using xmalloc. If an error occurs or the transfer is
1920 unsupported, NULL is returned. Empty objects are returned as
1921 allocated but empty strings. */
1922
07e059b5
VP
1923extern char *target_get_osdata (const char *type);
1924
c906108c
SS
1925\f
1926/* Stuff that should be shared among the various remote targets. */
1927
1928/* Debugging level. 0 is off, and non-zero values mean to print some debug
1929 information (higher values, more information). */
1930extern int remote_debug;
1931
1932/* Speed in bits per second, or -1 which means don't mess with the speed. */
1933extern int baud_rate;
c378eb4e 1934/* Timeout limit for response from target. */
c906108c
SS
1935extern int remote_timeout;
1936
c906108c 1937\f
c906108c 1938
8defab1a
DJ
1939/* Set the show memory breakpoints mode to show, and installs a cleanup
1940 to restore it back to the current value. */
1941extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1942
d914c394
SS
1943extern int may_write_registers;
1944extern int may_write_memory;
1945extern int may_insert_breakpoints;
1946extern int may_insert_tracepoints;
1947extern int may_insert_fast_tracepoints;
1948extern int may_stop;
1949
1950extern void update_target_permissions (void);
1951
c906108c 1952\f
c378eb4e 1953/* Imported from machine dependent code. */
c906108c 1954
c378eb4e 1955/* Blank target vector entries are initialized to target_ignore. */
a14ed312 1956void target_ignore (void);
c906108c 1957
02d27625
MM
1958/* See to_supports_btrace in struct target_ops. */
1959extern int target_supports_btrace (void);
1960
1961/* See to_enable_btrace in struct target_ops. */
1962extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
1963
1964/* See to_disable_btrace in struct target_ops. */
1965extern void target_disable_btrace (struct btrace_target_info *btinfo);
1966
1967/* See to_teardown_btrace in struct target_ops. */
1968extern void target_teardown_btrace (struct btrace_target_info *btinfo);
1969
1970/* See to_read_btrace in struct target_ops. */
1971extern VEC (btrace_block_s) *target_read_btrace (struct btrace_target_info *,
1972 enum btrace_read_type);
1973
7c1687a9
MM
1974/* See to_stop_recording in struct target_ops. */
1975extern void target_stop_recording (void);
1976
d02ed0bb
MM
1977/* See to_info_record in struct target_ops. */
1978extern void target_info_record (void);
1979
1980/* See to_save_record in struct target_ops. */
85e1311a 1981extern void target_save_record (const char *filename);
d02ed0bb
MM
1982
1983/* Query if the target supports deleting the execution log. */
1984extern int target_supports_delete_record (void);
1985
1986/* See to_delete_record in struct target_ops. */
1987extern void target_delete_record (void);
1988
1989/* See to_record_is_replaying in struct target_ops. */
1990extern int target_record_is_replaying (void);
1991
1992/* See to_goto_record_begin in struct target_ops. */
1993extern void target_goto_record_begin (void);
1994
1995/* See to_goto_record_end in struct target_ops. */
1996extern void target_goto_record_end (void);
1997
1998/* See to_goto_record in struct target_ops. */
1999extern void target_goto_record (ULONGEST insn);
02d27625 2000
67c86d06
MM
2001/* See to_insn_history. */
2002extern void target_insn_history (int size, int flags);
2003
2004/* See to_insn_history_from. */
2005extern void target_insn_history_from (ULONGEST from, int size, int flags);
2006
2007/* See to_insn_history_range. */
2008extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2009
15984c13
MM
2010/* See to_call_history. */
2011extern void target_call_history (int size, int flags);
2012
2013/* See to_call_history_from. */
2014extern void target_call_history_from (ULONGEST begin, int size, int flags);
2015
2016/* See to_call_history_range. */
2017extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2018
c5aa993b 2019#endif /* !defined (TARGET_H) */
This page took 1.634783 seconds and 4 git commands to generate.