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