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