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