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