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