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