]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/target.h
PR binutils/10802
[thirdparty/binutils-gdb.git] / gdb / target.h
CommitLineData
c906108c 1/* Interface between GDB and target environments, including files and processes
0088c768 2
6aba47ca 3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
0fb0cc75 4 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
f6519ebc 5 Free Software Foundation, Inc.
0088c768 6
c906108c
SS
7 Contributed by Cygnus Support. Written by John Gilmore.
8
c5aa993b 9 This file is part of GDB.
c906108c 10
c5aa993b
JM
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
a9762ec7 13 the Free Software Foundation; either version 3 of the License, or
c5aa993b 14 (at your option) any later version.
c906108c 15
c5aa993b
JM
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
c906108c 20
c5aa993b 21 You should have received a copy of the GNU General Public License
a9762ec7 22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
23
24#if !defined (TARGET_H)
25#define TARGET_H
26
da3331ec
AC
27struct objfile;
28struct ui_file;
29struct mem_attrib;
1e3ff5ad 30struct target_ops;
8181d85f 31struct bp_target_info;
56be3814 32struct regcache;
07b82ea5 33struct target_section_table;
da3331ec 34
c906108c
SS
35/* This include file defines the interface between the main part
36 of the debugger, and the part which is target-specific, or
37 specific to the communications interface between us and the
38 target.
39
2146d243
RM
40 A TARGET is an interface between the debugger and a particular
41 kind of file or process. Targets can be STACKED in STRATA,
c906108c
SS
42 so that more than one target can potentially respond to a request.
43 In particular, memory accesses will walk down the stack of targets
44 until they find a target that is interested in handling that particular
45 address. STRATA are artificial boundaries on the stack, within
46 which particular kinds of targets live. Strata exist so that
47 people don't get confused by pushing e.g. a process target and then
48 a file target, and wondering why they can't see the current values
49 of variables any more (the file target is handling them and they
50 never get to the process target). So when you push a file target,
51 it goes into the file stratum, which is always below the process
52 stratum. */
53
54#include "bfd.h"
55#include "symtab.h"
29e57380 56#include "memattr.h"
fd79ecee 57#include "vec.h"
2aecd87f 58#include "gdb_signals.h"
c906108c 59
c5aa993b
JM
60enum strata
61 {
62 dummy_stratum, /* The lowest of the low */
63 file_stratum, /* Executable files, etc */
4d8ac244 64 core_stratum, /* Core dump files */
d4f3574e 65 process_stratum, /* Executing processes */
81e64f55 66 thread_stratum, /* Executing threads */
85e747d2
UW
67 record_stratum, /* Support record debugging */
68 arch_stratum /* Architecture overrides */
c5aa993b 69 };
c906108c 70
c5aa993b
JM
71enum thread_control_capabilities
72 {
0d06e24b
JM
73 tc_none = 0, /* Default: can't control thread execution. */
74 tc_schedlock = 1, /* Can lock the thread scheduler. */
c5aa993b 75 };
c906108c
SS
76
77/* Stuff for target_wait. */
78
79/* Generally, what has the program done? */
c5aa993b
JM
80enum target_waitkind
81 {
82 /* The program has exited. The exit status is in value.integer. */
83 TARGET_WAITKIND_EXITED,
c906108c 84
0d06e24b
JM
85 /* The program has stopped with a signal. Which signal is in
86 value.sig. */
c5aa993b 87 TARGET_WAITKIND_STOPPED,
c906108c 88
c5aa993b
JM
89 /* The program has terminated with a signal. Which signal is in
90 value.sig. */
91 TARGET_WAITKIND_SIGNALLED,
c906108c 92
c5aa993b
JM
93 /* The program is letting us know that it dynamically loaded something
94 (e.g. it called load(2) on AIX). */
95 TARGET_WAITKIND_LOADED,
c906108c 96
3a3e9ee3 97 /* The program has forked. A "related" process' PTID is in
0d06e24b
JM
98 value.related_pid. I.e., if the child forks, value.related_pid
99 is the parent's ID. */
100
c5aa993b 101 TARGET_WAITKIND_FORKED,
c906108c 102
3a3e9ee3 103 /* The program has vforked. A "related" process's PTID is in
0d06e24b
JM
104 value.related_pid. */
105
c5aa993b 106 TARGET_WAITKIND_VFORKED,
c906108c 107
0d06e24b
JM
108 /* The program has exec'ed a new executable file. The new file's
109 pathname is pointed to by value.execd_pathname. */
110
c5aa993b 111 TARGET_WAITKIND_EXECD,
c906108c 112
6c95b8df
PA
113 /* The program had previously vforked, and now the child is done
114 with the shared memory region, because it exec'ed or exited.
115 Note that the event is reported to the vfork parent. This is
116 only used if GDB did not stay attached to the vfork child,
117 otherwise, a TARGET_WAITKIND_EXECD or
118 TARGET_WAITKIND_EXIT|SIGNALLED event associated with the child
119 has the same effect. */
120 TARGET_WAITKIND_VFORK_DONE,
121
0d06e24b
JM
122 /* The program has entered or returned from a system call. On
123 HP-UX, this is used in the hardware watchpoint implementation.
124 The syscall's unique integer ID number is in value.syscall_id */
125
c5aa993b
JM
126 TARGET_WAITKIND_SYSCALL_ENTRY,
127 TARGET_WAITKIND_SYSCALL_RETURN,
c906108c 128
c5aa993b
JM
129 /* Nothing happened, but we stopped anyway. This perhaps should be handled
130 within target_wait, but I'm not sure target_wait should be resuming the
131 inferior. */
c4093a6a
JM
132 TARGET_WAITKIND_SPURIOUS,
133
8e7d2c16
DJ
134 /* An event has occured, but we should wait again.
135 Remote_async_wait() returns this when there is an event
c4093a6a
JM
136 on the inferior, but the rest of the world is not interested in
137 it. The inferior has not stopped, but has just sent some output
138 to the console, for instance. In this case, we want to go back
139 to the event loop and wait there for another event from the
140 inferior, rather than being stuck in the remote_async_wait()
141 function. This way the event loop is responsive to other events,
0d06e24b 142 like for instance the user typing. */
b2175913
MS
143 TARGET_WAITKIND_IGNORE,
144
145 /* The target has run out of history information,
146 and cannot run backward any further. */
147 TARGET_WAITKIND_NO_HISTORY
c906108c
SS
148 };
149
c5aa993b
JM
150struct target_waitstatus
151 {
152 enum target_waitkind kind;
153
a96d9b2e
SDJ
154 /* Forked child pid, execd pathname, exit status, signal number or
155 syscall number. */
c5aa993b
JM
156 union
157 {
158 int integer;
159 enum target_signal sig;
3a3e9ee3 160 ptid_t related_pid;
c5aa993b 161 char *execd_pathname;
a96d9b2e 162 int syscall_number;
c5aa993b
JM
163 }
164 value;
165 };
c906108c 166
47608cb1
PA
167/* Options that can be passed to target_wait. */
168
169/* Return immediately if there's no event already queued. If this
170 options is not requested, target_wait blocks waiting for an
171 event. */
172#define TARGET_WNOHANG 1
173
a96d9b2e
SDJ
174/* The structure below stores information about a system call.
175 It is basically used in the "catch syscall" command, and in
176 every function that gives information about a system call.
177
178 It's also good to mention that its fields represent everything
179 that we currently know about a syscall in GDB. */
180struct syscall
181 {
182 /* The syscall number. */
183 int number;
184
185 /* The syscall name. */
186 const char *name;
187 };
188
f00150c9
DE
189/* Return a pretty printed form of target_waitstatus.
190 Space for the result is malloc'd, caller must free. */
191extern char *target_waitstatus_to_string (const struct target_waitstatus *);
192
2acceee2 193/* Possible types of events that the inferior handler will have to
0d06e24b 194 deal with. */
2acceee2
JM
195enum inferior_event_type
196 {
0d06e24b 197 /* There is a request to quit the inferior, abandon it. */
2acceee2
JM
198 INF_QUIT_REQ,
199 /* Process a normal inferior event which will result in target_wait
0d06e24b 200 being called. */
2146d243 201 INF_REG_EVENT,
0d06e24b 202 /* Deal with an error on the inferior. */
2acceee2 203 INF_ERROR,
0d06e24b 204 /* We are called because a timer went off. */
2acceee2 205 INF_TIMER,
0d06e24b 206 /* We are called to do stuff after the inferior stops. */
c2d11a7d
JM
207 INF_EXEC_COMPLETE,
208 /* We are called to do some stuff after the inferior stops, but we
209 are expected to reenter the proceed() and
210 handle_inferior_event() functions. This is used only in case of
0d06e24b 211 'step n' like commands. */
c2d11a7d 212 INF_EXEC_CONTINUE
2acceee2 213 };
c906108c 214\f
13547ab6
DJ
215/* Target objects which can be transfered using target_read,
216 target_write, et cetera. */
1e3ff5ad
AC
217
218enum target_object
219{
1e3ff5ad
AC
220 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
221 TARGET_OBJECT_AVR,
23d964e7
UW
222 /* SPU target specific transfer. See "spu-tdep.c". */
223 TARGET_OBJECT_SPU,
1e3ff5ad 224 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
287a334e 225 TARGET_OBJECT_MEMORY,
cf7a04e8
DJ
226 /* Memory, avoiding GDB's data cache and trusting the executable.
227 Target implementations of to_xfer_partial never need to handle
228 this object, and most callers should not use it. */
229 TARGET_OBJECT_RAW_MEMORY,
4e5d721f
DE
230 /* Memory known to be part of the target's stack. This is cached even
231 if it is not in a region marked as such, since it is known to be
232 "normal" RAM. */
233 TARGET_OBJECT_STACK_MEMORY,
287a334e
JJ
234 /* Kernel Unwind Table. See "ia64-tdep.c". */
235 TARGET_OBJECT_UNWIND_TABLE,
2146d243
RM
236 /* Transfer auxilliary vector. */
237 TARGET_OBJECT_AUXV,
baf92889 238 /* StackGhost cookie. See "sparc-tdep.c". */
fd79ecee
DJ
239 TARGET_OBJECT_WCOOKIE,
240 /* Target memory map in XML format. */
241 TARGET_OBJECT_MEMORY_MAP,
a76d924d
DJ
242 /* Flash memory. This object can be used to write contents to
243 a previously erased flash memory. Using it without erasing
244 flash can have unexpected results. Addresses are physical
245 address on target, and not relative to flash start. */
23181151
DJ
246 TARGET_OBJECT_FLASH,
247 /* Available target-specific features, e.g. registers and coprocessors.
248 See "target-descriptions.c". ANNEX should never be empty. */
cfa9d6d9
DJ
249 TARGET_OBJECT_AVAILABLE_FEATURES,
250 /* Currently loaded libraries, in XML format. */
07e059b5
VP
251 TARGET_OBJECT_LIBRARIES,
252 /* Get OS specific data. The ANNEX specifies the type (running
253 processes, etc.). */
4aa995e1
PA
254 TARGET_OBJECT_OSDATA,
255 /* Extra signal info. Usually the contents of `siginfo_t' on unix
256 platforms. */
257 TARGET_OBJECT_SIGNAL_INFO,
07e059b5 258 /* Possible future objects: TARGET_OBJECT_FILE, ... */
1e3ff5ad
AC
259};
260
13547ab6
DJ
261/* Request that OPS transfer up to LEN 8-bit bytes of the target's
262 OBJECT. The OFFSET, for a seekable object, specifies the
263 starting point. The ANNEX can be used to provide additional
264 data-specific information to the target.
1e3ff5ad 265
13547ab6
DJ
266 Return the number of bytes actually transfered, or -1 if the
267 transfer is not supported or otherwise fails. Return of a positive
268 value less than LEN indicates that no further transfer is possible.
269 Unlike the raw to_xfer_partial interface, callers of these
270 functions do not need to retry partial transfers. */
1e3ff5ad 271
1e3ff5ad
AC
272extern LONGEST target_read (struct target_ops *ops,
273 enum target_object object,
1b0ba102 274 const char *annex, gdb_byte *buf,
1e3ff5ad
AC
275 ULONGEST offset, LONGEST len);
276
d5086790
VP
277extern LONGEST target_read_until_error (struct target_ops *ops,
278 enum target_object object,
279 const char *annex, gdb_byte *buf,
280 ULONGEST offset, LONGEST len);
281
1e3ff5ad
AC
282extern LONGEST target_write (struct target_ops *ops,
283 enum target_object object,
1b0ba102 284 const char *annex, const gdb_byte *buf,
1e3ff5ad 285 ULONGEST offset, LONGEST len);
b6591e8b 286
a76d924d
DJ
287/* Similar to target_write, except that it also calls PROGRESS with
288 the number of bytes written and the opaque BATON after every
289 successful partial write (and before the first write). This is
290 useful for progress reporting and user interaction while writing
291 data. To abort the transfer, the progress callback can throw an
292 exception. */
293
cf7a04e8
DJ
294LONGEST target_write_with_progress (struct target_ops *ops,
295 enum target_object object,
296 const char *annex, const gdb_byte *buf,
297 ULONGEST offset, LONGEST len,
298 void (*progress) (ULONGEST, void *),
299 void *baton);
300
13547ab6
DJ
301/* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
302 be read using OPS. The return value will be -1 if the transfer
303 fails or is not supported; 0 if the object is empty; or the length
304 of the object otherwise. If a positive value is returned, a
305 sufficiently large buffer will be allocated using xmalloc and
306 returned in *BUF_P containing the contents of the object.
307
308 This method should be used for objects sufficiently small to store
309 in a single xmalloc'd buffer, when no fixed bound on the object's
310 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
311 through this function. */
312
313extern LONGEST target_read_alloc (struct target_ops *ops,
314 enum target_object object,
315 const char *annex, gdb_byte **buf_p);
316
159f81f3
DJ
317/* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
318 returned as a string, allocated using xmalloc. If an error occurs
319 or the transfer is unsupported, NULL is returned. Empty objects
320 are returned as allocated but empty strings. A warning is issued
321 if the result contains any embedded NUL bytes. */
322
323extern char *target_read_stralloc (struct target_ops *ops,
324 enum target_object object,
325 const char *annex);
326
b6591e8b
AC
327/* Wrappers to target read/write that perform memory transfers. They
328 throw an error if the memory transfer fails.
329
330 NOTE: cagney/2003-10-23: The naming schema is lifted from
331 "frame.h". The parameter order is lifted from get_frame_memory,
332 which in turn lifted it from read_memory. */
333
334extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
1b0ba102 335 gdb_byte *buf, LONGEST len);
b6591e8b 336extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
e17a4113
UW
337 CORE_ADDR addr, int len,
338 enum bfd_endian byte_order);
1e3ff5ad 339\f
0d06e24b
JM
340struct thread_info; /* fwd decl for parameter list below: */
341
c906108c 342struct target_ops
c5aa993b 343 {
258b763a 344 struct target_ops *beneath; /* To the target under this one. */
c5aa993b
JM
345 char *to_shortname; /* Name this target type */
346 char *to_longname; /* Name for printing */
347 char *to_doc; /* Documentation. Does not include trailing
c906108c 348 newline, and starts with a one-line descrip-
0d06e24b 349 tion (probably similar to to_longname). */
bba2d28d
AC
350 /* Per-target scratch pad. */
351 void *to_data;
f1c07ab0
AC
352 /* The open routine takes the rest of the parameters from the
353 command, and (if successful) pushes a new target onto the
354 stack. Targets should supply this routine, if only to provide
355 an error message. */
507f3c78 356 void (*to_open) (char *, int);
f1c07ab0
AC
357 /* Old targets with a static target vector provide "to_close".
358 New re-entrant targets provide "to_xclose" and that is expected
359 to xfree everything (including the "struct target_ops"). */
360 void (*to_xclose) (struct target_ops *targ, int quitting);
507f3c78 361 void (*to_close) (int);
136d6dae 362 void (*to_attach) (struct target_ops *ops, char *, int);
507f3c78 363 void (*to_post_attach) (int);
136d6dae 364 void (*to_detach) (struct target_ops *ops, char *, int);
597320e7 365 void (*to_disconnect) (struct target_ops *, char *, int);
28439f5e 366 void (*to_resume) (struct target_ops *, ptid_t, int, enum target_signal);
117de6a9 367 ptid_t (*to_wait) (struct target_ops *,
47608cb1 368 ptid_t, struct target_waitstatus *, int);
28439f5e
PA
369 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
370 void (*to_store_registers) (struct target_ops *, struct regcache *, int);
316f2060 371 void (*to_prepare_to_store) (struct regcache *);
c5aa993b
JM
372
373 /* Transfer LEN bytes of memory between GDB address MYADDR and
374 target address MEMADDR. If WRITE, transfer them to the target, else
375 transfer them from the target. TARGET is the target from which we
376 get this function.
377
378 Return value, N, is one of the following:
379
380 0 means that we can't handle this. If errno has been set, it is the
381 error which prevented us from doing it (FIXME: What about bfd_error?).
382
383 positive (call it N) means that we have transferred N bytes
384 starting at MEMADDR. We might be able to handle more bytes
385 beyond this length, but no promises.
386
387 negative (call its absolute value N) means that we cannot
388 transfer right at MEMADDR, but we could transfer at least
c8e73a31 389 something at MEMADDR + N.
c5aa993b 390
c8e73a31
AC
391 NOTE: cagney/2004-10-01: This has been entirely superseeded by
392 to_xfer_partial and inferior inheritance. */
393
1b0ba102 394 int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
c8e73a31
AC
395 int len, int write,
396 struct mem_attrib *attrib,
397 struct target_ops *target);
c906108c 398
507f3c78 399 void (*to_files_info) (struct target_ops *);
a6d9a66e
UW
400 int (*to_insert_breakpoint) (struct gdbarch *, struct bp_target_info *);
401 int (*to_remove_breakpoint) (struct gdbarch *, struct bp_target_info *);
ccaa32c7 402 int (*to_can_use_hw_breakpoint) (int, int, int);
a6d9a66e
UW
403 int (*to_insert_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
404 int (*to_remove_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
ccaa32c7
GS
405 int (*to_remove_watchpoint) (CORE_ADDR, int, int);
406 int (*to_insert_watchpoint) (CORE_ADDR, int, int);
407 int (*to_stopped_by_watchpoint) (void);
74174d2e 408 int to_have_steppable_watchpoint;
7df1a324 409 int to_have_continuable_watchpoint;
4aa7a7f5 410 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
5009afc5
AS
411 int (*to_watchpoint_addr_within_range) (struct target_ops *,
412 CORE_ADDR, CORE_ADDR, int);
e0d24f8d 413 int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
507f3c78
KB
414 void (*to_terminal_init) (void);
415 void (*to_terminal_inferior) (void);
416 void (*to_terminal_ours_for_output) (void);
417 void (*to_terminal_ours) (void);
a790ad35 418 void (*to_terminal_save_ours) (void);
507f3c78 419 void (*to_terminal_info) (char *, int);
7d85a9c0 420 void (*to_kill) (struct target_ops *);
507f3c78
KB
421 void (*to_load) (char *, int);
422 int (*to_lookup_symbol) (char *, CORE_ADDR *);
136d6dae
VP
423 void (*to_create_inferior) (struct target_ops *,
424 char *, char *, char **, int);
39f77062 425 void (*to_post_startup_inferior) (ptid_t);
507f3c78 426 void (*to_acknowledge_created_inferior) (int);
fa113d1a 427 void (*to_insert_fork_catchpoint) (int);
507f3c78 428 int (*to_remove_fork_catchpoint) (int);
fa113d1a 429 void (*to_insert_vfork_catchpoint) (int);
507f3c78 430 int (*to_remove_vfork_catchpoint) (int);
ee057212 431 int (*to_follow_fork) (struct target_ops *, int);
fa113d1a 432 void (*to_insert_exec_catchpoint) (int);
507f3c78 433 int (*to_remove_exec_catchpoint) (int);
a96d9b2e 434 int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
507f3c78 435 int (*to_has_exited) (int, int, int *);
136d6dae 436 void (*to_mourn_inferior) (struct target_ops *);
507f3c78 437 int (*to_can_run) (void);
39f77062 438 void (*to_notice_signals) (ptid_t ptid);
28439f5e
PA
439 int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
440 void (*to_find_new_threads) (struct target_ops *);
117de6a9 441 char *(*to_pid_to_str) (struct target_ops *, ptid_t);
507f3c78 442 char *(*to_extra_thread_info) (struct thread_info *);
94cc34af 443 void (*to_stop) (ptid_t);
d9fcf2fb 444 void (*to_rcmd) (char *command, struct ui_file *output);
507f3c78 445 char *(*to_pid_to_exec_file) (int pid);
49d03eab 446 void (*to_log_command) (const char *);
07b82ea5 447 struct target_section_table *(*to_get_section_table) (struct target_ops *);
c5aa993b 448 enum strata to_stratum;
c35b1492
PA
449 int (*to_has_all_memory) (struct target_ops *);
450 int (*to_has_memory) (struct target_ops *);
451 int (*to_has_stack) (struct target_ops *);
452 int (*to_has_registers) (struct target_ops *);
453 int (*to_has_execution) (struct target_ops *);
c5aa993b 454 int to_has_thread_control; /* control thread execution */
dc177b7a 455 int to_attach_no_wait;
6426a772
JM
456 /* ASYNC target controls */
457 int (*to_can_async_p) (void);
458 int (*to_is_async_p) (void);
b84876c2
PA
459 void (*to_async) (void (*) (enum inferior_event_type, void *), void *);
460 int (*to_async_mask) (int);
9908b566 461 int (*to_supports_non_stop) (void);
2146d243
RM
462 int (*to_find_memory_regions) (int (*) (CORE_ADDR,
463 unsigned long,
464 int, int, int,
465 void *),
be4d1333
MS
466 void *);
467 char * (*to_make_corefile_notes) (bfd *, int *);
3f47be5c
EZ
468
469 /* Return the thread-local address at OFFSET in the
470 thread-local storage for the thread PTID and the shared library
471 or executable file given by OBJFILE. If that block of
472 thread-local storage hasn't been allocated yet, this function
473 may return an error. */
117de6a9
PA
474 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
475 ptid_t ptid,
b2756930 476 CORE_ADDR load_module_addr,
3f47be5c
EZ
477 CORE_ADDR offset);
478
13547ab6
DJ
479 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
480 OBJECT. The OFFSET, for a seekable object, specifies the
481 starting point. The ANNEX can be used to provide additional
482 data-specific information to the target.
483
484 Return the number of bytes actually transfered, zero when no
485 further transfer is possible, and -1 when the transfer is not
486 supported. Return of a positive value smaller than LEN does
487 not indicate the end of the object, only the end of the
488 transfer; higher level code should continue transferring if
489 desired. This is handled in target.c.
490
491 The interface does not support a "retry" mechanism. Instead it
492 assumes that at least one byte will be transfered on each
493 successful call.
494
495 NOTE: cagney/2003-10-17: The current interface can lead to
496 fragmented transfers. Lower target levels should not implement
497 hacks, such as enlarging the transfer, in an attempt to
498 compensate for this. Instead, the target stack should be
499 extended so that it implements supply/collect methods and a
500 look-aside object cache. With that available, the lowest
501 target can safely and freely "push" data up the stack.
502
503 See target_read and target_write for more information. One,
504 and only one, of readbuf or writebuf must be non-NULL. */
505
4b8a223f 506 LONGEST (*to_xfer_partial) (struct target_ops *ops,
8aa91c1e 507 enum target_object object, const char *annex,
1b0ba102 508 gdb_byte *readbuf, const gdb_byte *writebuf,
8aa91c1e 509 ULONGEST offset, LONGEST len);
1e3ff5ad 510
fd79ecee
DJ
511 /* Returns the memory map for the target. A return value of NULL
512 means that no memory map is available. If a memory address
513 does not fall within any returned regions, it's assumed to be
514 RAM. The returned memory regions should not overlap.
515
516 The order of regions does not matter; target_memory_map will
517 sort regions by starting address. For that reason, this
518 function should not be called directly except via
519 target_memory_map.
520
521 This method should not cache data; if the memory map could
522 change unexpectedly, it should be invalidated, and higher
523 layers will re-fetch it. */
524 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
525
a76d924d
DJ
526 /* Erases the region of flash memory starting at ADDRESS, of
527 length LENGTH.
528
529 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
530 on flash block boundaries, as reported by 'to_memory_map'. */
531 void (*to_flash_erase) (struct target_ops *,
532 ULONGEST address, LONGEST length);
533
534 /* Finishes a flash memory write sequence. After this operation
535 all flash memory should be available for writing and the result
536 of reading from areas written by 'to_flash_write' should be
537 equal to what was written. */
538 void (*to_flash_done) (struct target_ops *);
539
424163ea
DJ
540 /* Describe the architecture-specific features of this target.
541 Returns the description found, or NULL if no description
542 was available. */
543 const struct target_desc *(*to_read_description) (struct target_ops *ops);
544
0ef643c8
JB
545 /* Build the PTID of the thread on which a given task is running,
546 based on LWP and THREAD. These values are extracted from the
547 task Private_Data section of the Ada Task Control Block, and
548 their interpretation depends on the target. */
549 ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
550
c47ffbe3
VP
551 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
552 Return 0 if *READPTR is already at the end of the buffer.
553 Return -1 if there is insufficient buffer for a whole entry.
554 Return 1 if an entry was read into *TYPEP and *VALP. */
555 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
556 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
557
08388c79
DE
558 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
559 sequence of bytes in PATTERN with length PATTERN_LEN.
560
561 The result is 1 if found, 0 if not found, and -1 if there was an error
562 requiring halting of the search (e.g. memory read error).
563 If the pattern is found the address is recorded in FOUND_ADDRP. */
564 int (*to_search_memory) (struct target_ops *ops,
565 CORE_ADDR start_addr, ULONGEST search_space_len,
566 const gdb_byte *pattern, ULONGEST pattern_len,
567 CORE_ADDR *found_addrp);
568
b2175913 569 /* Can target execute in reverse? */
2c0b251b 570 int (*to_can_execute_reverse) (void);
b2175913 571
8a305172
PA
572 /* Does this target support debugging multiple processes
573 simultaneously? */
574 int (*to_supports_multi_process) (void);
575
3a8f7b07
JK
576 /* Determine current architecture of thread PTID.
577
578 The target is supposed to determine the architecture of the code where
579 the target is currently stopped at (on Cell, if a target is in spu_run,
580 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
581 This is architecture used to perform decr_pc_after_break adjustment,
582 and also determines the frame architecture of the innermost frame.
583 ptrace operations need to operate according to target_gdbarch.
584
585 The default implementation always returns target_gdbarch. */
c2250ad1
UW
586 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
587
c5aa993b 588 int to_magic;
0d06e24b
JM
589 /* Need sub-structure for target machine related rather than comm related?
590 */
c5aa993b 591 };
c906108c
SS
592
593/* Magic number for checking ops size. If a struct doesn't end with this
594 number, somebody changed the declaration but didn't change all the
595 places that initialize one. */
596
597#define OPS_MAGIC 3840
598
599/* The ops structure for our "current" target process. This should
600 never be NULL. If there is no target, it points to the dummy_target. */
601
c5aa993b 602extern struct target_ops current_target;
c906108c 603
c906108c
SS
604/* Define easy words for doing these operations on our current target. */
605
606#define target_shortname (current_target.to_shortname)
607#define target_longname (current_target.to_longname)
608
f1c07ab0
AC
609/* Does whatever cleanup is required for a target that we are no
610 longer going to be calling. QUITTING indicates that GDB is exiting
611 and should not get hung on an error (otherwise it is important to
612 perform clean termination, even if it takes a while). This routine
613 is automatically always called when popping the target off the
614 target stack (to_beneath is undefined). Closing file descriptors
615 and freeing all memory allocated memory are typical things it
616 should do. */
617
618void target_close (struct target_ops *targ, int quitting);
c906108c
SS
619
620/* Attaches to a process on the target side. Arguments are as passed
621 to the `attach' command by the user. This routine can be called
622 when the target is not on the target-stack, if the target_can_run
2146d243 623 routine returns 1; in that case, it must push itself onto the stack.
c906108c 624 Upon exit, the target should be ready for normal operations, and
2146d243 625 should be ready to deliver the status of the process immediately
c906108c
SS
626 (without waiting) to an upcoming target_wait call. */
627
136d6dae 628void target_attach (char *, int);
c906108c 629
dc177b7a
PA
630/* Some targets don't generate traps when attaching to the inferior,
631 or their target_attach implementation takes care of the waiting.
632 These targets must set to_attach_no_wait. */
633
634#define target_attach_no_wait \
635 (current_target.to_attach_no_wait)
636
c906108c
SS
637/* The target_attach operation places a process under debugger control,
638 and stops the process.
639
640 This operation provides a target-specific hook that allows the
0d06e24b 641 necessary bookkeeping to be performed after an attach completes. */
c906108c 642#define target_post_attach(pid) \
0d06e24b 643 (*current_target.to_post_attach) (pid)
c906108c 644
c906108c
SS
645/* Takes a program previously attached to and detaches it.
646 The program may resume execution (some targets do, some don't) and will
647 no longer stop on signals, etc. We better not have left any breakpoints
648 in the program or it'll die when it hits one. ARGS is arguments
649 typed by the user (e.g. a signal to send the process). FROM_TTY
650 says whether to be verbose or not. */
651
a14ed312 652extern void target_detach (char *, int);
c906108c 653
6ad8ae5c
DJ
654/* Disconnect from the current target without resuming it (leaving it
655 waiting for a debugger). */
656
657extern void target_disconnect (char *, int);
658
39f77062 659/* Resume execution of the target process PTID. STEP says whether to
c906108c
SS
660 single-step or to run free; SIGGNAL is the signal to be given to
661 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
662 pass TARGET_SIGNAL_DEFAULT. */
663
e1ac3328 664extern void target_resume (ptid_t ptid, int step, enum target_signal signal);
c906108c 665
b5a2688f
AC
666/* Wait for process pid to do something. PTID = -1 to wait for any
667 pid to do something. Return pid of child, or -1 in case of error;
c906108c 668 store status through argument pointer STATUS. Note that it is
b5a2688f 669 _NOT_ OK to throw_exception() out of target_wait() without popping
c906108c
SS
670 the debugging target from the stack; GDB isn't prepared to get back
671 to the prompt with a debugging target but without the frame cache,
47608cb1
PA
672 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
673 options. */
c906108c 674
47608cb1
PA
675extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
676 int options);
c906108c 677
17dee195 678/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c 679
28439f5e 680extern void target_fetch_registers (struct regcache *regcache, int regno);
c906108c
SS
681
682/* Store at least register REGNO, or all regs if REGNO == -1.
683 It can store as many registers as it wants to, so target_prepare_to_store
684 must have been previously called. Calls error() if there are problems. */
685
28439f5e 686extern void target_store_registers (struct regcache *regcache, int regs);
c906108c
SS
687
688/* Get ready to modify the registers array. On machines which store
689 individual registers, this doesn't need to do anything. On machines
690 which store all the registers in one fell swoop, this makes sure
691 that REGISTERS contains all the registers from the program being
692 debugged. */
693
316f2060
UW
694#define target_prepare_to_store(regcache) \
695 (*current_target.to_prepare_to_store) (regcache)
c906108c 696
6c95b8df
PA
697/* Determine current address space of thread PTID. */
698
699struct address_space *target_thread_address_space (ptid_t);
700
8a305172
PA
701/* Returns true if this target can debug multiple processes
702 simultaneously. */
703
704#define target_supports_multi_process() \
705 (*current_target.to_supports_multi_process) ()
706
4e5d721f
DE
707/* Invalidate all target dcaches. */
708extern void target_dcache_invalidate (void);
4930751a 709
a14ed312 710extern int target_read_string (CORE_ADDR, char **, int, int *);
c906108c 711
fc1a4b47 712extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
c906108c 713
4e5d721f
DE
714extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
715
fc1a4b47 716extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
10e2d419 717 int len);
c906108c 718
fd79ecee
DJ
719/* Fetches the target's memory map. If one is found it is sorted
720 and returned, after some consistency checking. Otherwise, NULL
721 is returned. */
722VEC(mem_region_s) *target_memory_map (void);
723
a76d924d
DJ
724/* Erase the specified flash region. */
725void target_flash_erase (ULONGEST address, LONGEST length);
726
727/* Finish a sequence of flash operations. */
728void target_flash_done (void);
729
730/* Describes a request for a memory write operation. */
731struct memory_write_request
732 {
733 /* Begining address that must be written. */
734 ULONGEST begin;
735 /* Past-the-end address. */
736 ULONGEST end;
737 /* The data to write. */
738 gdb_byte *data;
739 /* A callback baton for progress reporting for this request. */
740 void *baton;
741 };
742typedef struct memory_write_request memory_write_request_s;
743DEF_VEC_O(memory_write_request_s);
744
745/* Enumeration specifying different flash preservation behaviour. */
746enum flash_preserve_mode
747 {
748 flash_preserve,
749 flash_discard
750 };
751
752/* Write several memory blocks at once. This version can be more
753 efficient than making several calls to target_write_memory, in
754 particular because it can optimize accesses to flash memory.
755
756 Moreover, this is currently the only memory access function in gdb
757 that supports writing to flash memory, and it should be used for
758 all cases where access to flash memory is desirable.
759
760 REQUESTS is the vector (see vec.h) of memory_write_request.
761 PRESERVE_FLASH_P indicates what to do with blocks which must be
762 erased, but not completely rewritten.
763 PROGRESS_CB is a function that will be periodically called to provide
764 feedback to user. It will be called with the baton corresponding
765 to the request currently being written. It may also be called
766 with a NULL baton, when preserved flash sectors are being rewritten.
767
768 The function returns 0 on success, and error otherwise. */
769int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
770 enum flash_preserve_mode preserve_flash_p,
771 void (*progress_cb) (ULONGEST, void *));
772
47932f85
DJ
773/* From infrun.c. */
774
3a3e9ee3 775extern int inferior_has_forked (ptid_t pid, ptid_t *child_pid);
47932f85 776
3a3e9ee3 777extern int inferior_has_vforked (ptid_t pid, ptid_t *child_pid);
47932f85 778
3a3e9ee3 779extern int inferior_has_execd (ptid_t pid, char **execd_pathname);
47932f85 780
a96d9b2e
SDJ
781extern int inferior_has_called_syscall (ptid_t pid, int *syscall_number);
782
c906108c
SS
783/* Print a line about the current target. */
784
785#define target_files_info() \
0d06e24b 786 (*current_target.to_files_info) (&current_target)
c906108c 787
8181d85f
DJ
788/* Insert a breakpoint at address BP_TGT->placed_address in the target
789 machine. Result is 0 for success, or an errno value. */
c906108c 790
a6d9a66e
UW
791#define target_insert_breakpoint(gdbarch, bp_tgt) \
792 (*current_target.to_insert_breakpoint) (gdbarch, bp_tgt)
c906108c 793
8181d85f
DJ
794/* Remove a breakpoint at address BP_TGT->placed_address in the target
795 machine. Result is 0 for success, or an errno value. */
c906108c 796
a6d9a66e
UW
797#define target_remove_breakpoint(gdbarch, bp_tgt) \
798 (*current_target.to_remove_breakpoint) (gdbarch, bp_tgt)
c906108c
SS
799
800/* Initialize the terminal settings we record for the inferior,
801 before we actually run the inferior. */
802
803#define target_terminal_init() \
0d06e24b 804 (*current_target.to_terminal_init) ()
c906108c
SS
805
806/* Put the inferior's terminal settings into effect.
807 This is preparation for starting or resuming the inferior. */
808
d9d2d8b6 809extern void target_terminal_inferior (void);
c906108c
SS
810
811/* Put some of our terminal settings into effect,
812 enough to get proper results from our output,
813 but do not change into or out of RAW mode
814 so that no input is discarded.
815
816 After doing this, either terminal_ours or terminal_inferior
817 should be called to get back to a normal state of affairs. */
818
819#define target_terminal_ours_for_output() \
0d06e24b 820 (*current_target.to_terminal_ours_for_output) ()
c906108c
SS
821
822/* Put our terminal settings into effect.
823 First record the inferior's terminal settings
824 so they can be restored properly later. */
825
826#define target_terminal_ours() \
0d06e24b 827 (*current_target.to_terminal_ours) ()
c906108c 828
a790ad35
SC
829/* Save our terminal settings.
830 This is called from TUI after entering or leaving the curses
831 mode. Since curses modifies our terminal this call is here
832 to take this change into account. */
833
834#define target_terminal_save_ours() \
835 (*current_target.to_terminal_save_ours) ()
836
c906108c
SS
837/* Print useful information about our terminal status, if such a thing
838 exists. */
839
840#define target_terminal_info(arg, from_tty) \
0d06e24b 841 (*current_target.to_terminal_info) (arg, from_tty)
c906108c
SS
842
843/* Kill the inferior process. Make it go away. */
844
7d85a9c0 845extern void target_kill (void);
c906108c 846
0d06e24b
JM
847/* Load an executable file into the target process. This is expected
848 to not only bring new code into the target process, but also to
1986bccd
AS
849 update GDB's symbol tables to match.
850
851 ARG contains command-line arguments, to be broken down with
852 buildargv (). The first non-switch argument is the filename to
853 load, FILE; the second is a number (as parsed by strtoul (..., ...,
854 0)), which is an offset to apply to the load addresses of FILE's
855 sections. The target may define switches, or other non-switch
856 arguments, as it pleases. */
c906108c 857
11cf8741 858extern void target_load (char *arg, int from_tty);
c906108c
SS
859
860/* Look up a symbol in the target's symbol table. NAME is the symbol
0d06e24b
JM
861 name. ADDRP is a CORE_ADDR * pointing to where the value of the
862 symbol should be returned. The result is 0 if successful, nonzero
863 if the symbol does not exist in the target environment. This
864 function should not call error() if communication with the target
865 is interrupted, since it is called from symbol reading, but should
866 return nonzero, possibly doing a complain(). */
c906108c 867
0d06e24b
JM
868#define target_lookup_symbol(name, addrp) \
869 (*current_target.to_lookup_symbol) (name, addrp)
c906108c 870
39f77062 871/* Start an inferior process and set inferior_ptid to its pid.
c906108c
SS
872 EXEC_FILE is the file to run.
873 ALLARGS is a string containing the arguments to the program.
874 ENV is the environment vector to pass. Errors reported with error().
875 On VxWorks and various standalone systems, we ignore exec_file. */
c5aa993b 876
136d6dae
VP
877void target_create_inferior (char *exec_file, char *args,
878 char **env, int from_tty);
c906108c
SS
879
880/* Some targets (such as ttrace-based HPUX) don't allow us to request
881 notification of inferior events such as fork and vork immediately
882 after the inferior is created. (This because of how gdb gets an
883 inferior created via invoking a shell to do it. In such a scenario,
884 if the shell init file has commands in it, the shell will fork and
885 exec for each of those commands, and we will see each such fork
886 event. Very bad.)
c5aa993b 887
0d06e24b
JM
888 Such targets will supply an appropriate definition for this function. */
889
39f77062
KB
890#define target_post_startup_inferior(ptid) \
891 (*current_target.to_post_startup_inferior) (ptid)
c906108c
SS
892
893/* On some targets, the sequence of starting up an inferior requires
0d06e24b
JM
894 some synchronization between gdb and the new inferior process, PID. */
895
c906108c 896#define target_acknowledge_created_inferior(pid) \
0d06e24b 897 (*current_target.to_acknowledge_created_inferior) (pid)
c906108c 898
0d06e24b
JM
899/* On some targets, we can catch an inferior fork or vfork event when
900 it occurs. These functions insert/remove an already-created
901 catchpoint for such events. */
c906108c 902
c906108c 903#define target_insert_fork_catchpoint(pid) \
0d06e24b 904 (*current_target.to_insert_fork_catchpoint) (pid)
c906108c
SS
905
906#define target_remove_fork_catchpoint(pid) \
0d06e24b 907 (*current_target.to_remove_fork_catchpoint) (pid)
c906108c
SS
908
909#define target_insert_vfork_catchpoint(pid) \
0d06e24b 910 (*current_target.to_insert_vfork_catchpoint) (pid)
c906108c
SS
911
912#define target_remove_vfork_catchpoint(pid) \
0d06e24b 913 (*current_target.to_remove_vfork_catchpoint) (pid)
c906108c 914
6604731b
DJ
915/* If the inferior forks or vforks, this function will be called at
916 the next resume in order to perform any bookkeeping and fiddling
917 necessary to continue debugging either the parent or child, as
918 requested, and releasing the other. Information about the fork
919 or vfork event is available via get_last_target_status ().
920 This function returns 1 if the inferior should not be resumed
921 (i.e. there is another event pending). */
0d06e24b 922
ee057212 923int target_follow_fork (int follow_child);
c906108c
SS
924
925/* On some targets, we can catch an inferior exec event when it
0d06e24b
JM
926 occurs. These functions insert/remove an already-created
927 catchpoint for such events. */
928
c906108c 929#define target_insert_exec_catchpoint(pid) \
0d06e24b 930 (*current_target.to_insert_exec_catchpoint) (pid)
c5aa993b 931
c906108c 932#define target_remove_exec_catchpoint(pid) \
0d06e24b 933 (*current_target.to_remove_exec_catchpoint) (pid)
c906108c 934
a96d9b2e
SDJ
935/* Syscall catch.
936
937 NEEDED is nonzero if any syscall catch (of any kind) is requested.
938 If NEEDED is zero, it means the target can disable the mechanism to
939 catch system calls because there are no more catchpoints of this type.
940
941 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
942 being requested. In this case, both TABLE_SIZE and TABLE should
943 be ignored.
944
945 TABLE_SIZE is the number of elements in TABLE. It only matters if
946 ANY_COUNT is zero.
947
948 TABLE is an array of ints, indexed by syscall number. An element in
949 this array is nonzero if that syscall should be caught. This argument
950 only matters if ANY_COUNT is zero. */
951
952#define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
953 (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
954 table_size, table)
955
c906108c 956/* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
0d06e24b
JM
957 exit code of PID, if any. */
958
c906108c 959#define target_has_exited(pid,wait_status,exit_status) \
0d06e24b 960 (*current_target.to_has_exited) (pid,wait_status,exit_status)
c906108c
SS
961
962/* The debugger has completed a blocking wait() call. There is now
2146d243 963 some process event that must be processed. This function should
c906108c 964 be defined by those targets that require the debugger to perform
0d06e24b 965 cleanup or internal state changes in response to the process event. */
c906108c
SS
966
967/* The inferior process has died. Do what is right. */
968
136d6dae 969void target_mourn_inferior (void);
c906108c
SS
970
971/* Does target have enough data to do a run or attach command? */
972
973#define target_can_run(t) \
0d06e24b 974 ((t)->to_can_run) ()
c906108c
SS
975
976/* post process changes to signal handling in the inferior. */
977
39f77062
KB
978#define target_notice_signals(ptid) \
979 (*current_target.to_notice_signals) (ptid)
c906108c
SS
980
981/* Check to see if a thread is still alive. */
982
28439f5e 983extern int target_thread_alive (ptid_t ptid);
c906108c 984
b83266a0
SS
985/* Query for new threads and add them to the thread list. */
986
28439f5e 987extern void target_find_new_threads (void);
b83266a0 988
0d06e24b
JM
989/* Make target stop in a continuable fashion. (For instance, under
990 Unix, this should act like SIGSTOP). This function is normally
991 used by GUIs to implement a stop button. */
c906108c 992
94cc34af 993#define target_stop(ptid) (*current_target.to_stop) (ptid)
c906108c 994
96baa820
JM
995/* Send the specified COMMAND to the target's monitor
996 (shell,interpreter) for execution. The result of the query is
0d06e24b 997 placed in OUTBUF. */
96baa820
JM
998
999#define target_rcmd(command, outbuf) \
1000 (*current_target.to_rcmd) (command, outbuf)
1001
1002
c906108c
SS
1003/* Does the target include all of memory, or only part of it? This
1004 determines whether we look up the target chain for other parts of
1005 memory if this target can't satisfy a request. */
1006
c35b1492
PA
1007extern int target_has_all_memory_1 (void);
1008#define target_has_all_memory target_has_all_memory_1 ()
c906108c
SS
1009
1010/* Does the target include memory? (Dummy targets don't.) */
1011
c35b1492
PA
1012extern int target_has_memory_1 (void);
1013#define target_has_memory target_has_memory_1 ()
c906108c
SS
1014
1015/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1016 we start a process.) */
c5aa993b 1017
c35b1492
PA
1018extern int target_has_stack_1 (void);
1019#define target_has_stack target_has_stack_1 ()
c906108c
SS
1020
1021/* Does the target have registers? (Exec files don't.) */
1022
c35b1492
PA
1023extern int target_has_registers_1 (void);
1024#define target_has_registers target_has_registers_1 ()
c906108c
SS
1025
1026/* Does the target have execution? Can we make it jump (through
52bb452f
DJ
1027 hoops), or pop its stack a few times? This means that the current
1028 target is currently executing; for some targets, that's the same as
1029 whether or not the target is capable of execution, but there are
1030 also targets which can be current while not executing. In that
1031 case this will become true after target_create_inferior or
1032 target_attach. */
c906108c 1033
c35b1492
PA
1034extern int target_has_execution_1 (void);
1035#define target_has_execution target_has_execution_1 ()
1036
1037/* Default implementations for process_stratum targets. Return true
1038 if there's a selected inferior, false otherwise. */
1039
1040extern int default_child_has_all_memory (struct target_ops *ops);
1041extern int default_child_has_memory (struct target_ops *ops);
1042extern int default_child_has_stack (struct target_ops *ops);
1043extern int default_child_has_registers (struct target_ops *ops);
1044extern int default_child_has_execution (struct target_ops *ops);
c906108c
SS
1045
1046/* Can the target support the debugger control of thread execution?
d6350901 1047 Can it lock the thread scheduler? */
c906108c
SS
1048
1049#define target_can_lock_scheduler \
0d06e24b 1050 (current_target.to_has_thread_control & tc_schedlock)
c906108c 1051
c6ebd6cf
VP
1052/* Should the target enable async mode if it is supported? Temporary
1053 cludge until async mode is a strict superset of sync mode. */
1054extern int target_async_permitted;
1055
6426a772
JM
1056/* Can the target support asynchronous execution? */
1057#define target_can_async_p() (current_target.to_can_async_p ())
1058
1059/* Is the target in asynchronous execution mode? */
b84876c2 1060#define target_is_async_p() (current_target.to_is_async_p ())
6426a772 1061
9908b566
VP
1062int target_supports_non_stop (void);
1063
6426a772 1064/* Put the target in async mode with the specified callback function. */
0d06e24b 1065#define target_async(CALLBACK,CONTEXT) \
b84876c2 1066 (current_target.to_async ((CALLBACK), (CONTEXT)))
43ff13b4 1067
04714b91
AC
1068/* This is to be used ONLY within call_function_by_hand(). It provides
1069 a workaround, to have inferior function calls done in sychronous
1070 mode, even though the target is asynchronous. After
ed9a39eb
JM
1071 target_async_mask(0) is called, calls to target_can_async_p() will
1072 return FALSE , so that target_resume() will not try to start the
1073 target asynchronously. After the inferior stops, we IMMEDIATELY
1074 restore the previous nature of the target, by calling
1075 target_async_mask(1). After that, target_can_async_p() will return
04714b91 1076 TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
ed9a39eb
JM
1077
1078 FIXME ezannoni 1999-12-13: we won't need this once we move
1079 the turning async on and off to the single execution commands,
0d06e24b 1080 from where it is done currently, in remote_resume(). */
ed9a39eb 1081
b84876c2
PA
1082#define target_async_mask(MASK) \
1083 (current_target.to_async_mask (MASK))
ed9a39eb 1084
c906108c
SS
1085/* Converts a process id to a string. Usually, the string just contains
1086 `process xyz', but on some systems it may contain
1087 `process xyz thread abc'. */
1088
117de6a9 1089extern char *target_pid_to_str (ptid_t ptid);
c906108c 1090
39f77062 1091extern char *normal_pid_to_str (ptid_t ptid);
c5aa993b 1092
0d06e24b
JM
1093/* Return a short string describing extra information about PID,
1094 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1095 is okay. */
1096
1097#define target_extra_thread_info(TP) \
1098 (current_target.to_extra_thread_info (TP))
ed9a39eb 1099
c906108c
SS
1100/* Attempts to find the pathname of the executable file
1101 that was run to create a specified process.
1102
1103 The process PID must be stopped when this operation is used.
c5aa993b 1104
c906108c
SS
1105 If the executable file cannot be determined, NULL is returned.
1106
1107 Else, a pointer to a character string containing the pathname
1108 is returned. This string should be copied into a buffer by
1109 the client if the string will not be immediately used, or if
0d06e24b 1110 it must persist. */
c906108c
SS
1111
1112#define target_pid_to_exec_file(pid) \
0d06e24b 1113 (current_target.to_pid_to_exec_file) (pid)
c906108c 1114
3a8f7b07 1115/* See the to_thread_architecture description in struct target_ops. */
c2250ad1
UW
1116
1117#define target_thread_architecture(ptid) \
1118 (current_target.to_thread_architecture (&current_target, ptid))
1119
be4d1333
MS
1120/*
1121 * Iterator function for target memory regions.
1122 * Calls a callback function once for each memory region 'mapped'
1123 * in the child process. Defined as a simple macro rather than
2146d243 1124 * as a function macro so that it can be tested for nullity.
be4d1333
MS
1125 */
1126
1127#define target_find_memory_regions(FUNC, DATA) \
1128 (current_target.to_find_memory_regions) (FUNC, DATA)
1129
1130/*
1131 * Compose corefile .note section.
1132 */
1133
1134#define target_make_corefile_notes(BFD, SIZE_P) \
1135 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1136
c906108c
SS
1137/* Hardware watchpoint interfaces. */
1138
1139/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1140 write). */
1141
d92524f1
PM
1142#define target_stopped_by_watchpoint \
1143 (*current_target.to_stopped_by_watchpoint)
7df1a324 1144
74174d2e
UW
1145/* Non-zero if we have steppable watchpoints */
1146
d92524f1 1147#define target_have_steppable_watchpoint \
74174d2e 1148 (current_target.to_have_steppable_watchpoint)
74174d2e 1149
7df1a324
KW
1150/* Non-zero if we have continuable watchpoints */
1151
d92524f1 1152#define target_have_continuable_watchpoint \
7df1a324 1153 (current_target.to_have_continuable_watchpoint)
c906108c 1154
ccaa32c7 1155/* Provide defaults for hardware watchpoint functions. */
c906108c 1156
2146d243 1157/* If the *_hw_beakpoint functions have not been defined
ccaa32c7 1158 elsewhere use the definitions in the target vector. */
c906108c
SS
1159
1160/* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1161 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1162 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1163 (including this one?). OTHERTYPE is who knows what... */
1164
d92524f1 1165#define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
ccaa32c7 1166 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
c906108c 1167
d92524f1 1168#define target_region_ok_for_hw_watchpoint(addr, len) \
e0d24f8d 1169 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
e0d24f8d 1170
c906108c
SS
1171
1172/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes. TYPE is 0
1173 for write, 1 for read, and 2 for read/write accesses. Returns 0 for
1174 success, non-zero for failure. */
1175
ccaa32c7
GS
1176#define target_insert_watchpoint(addr, len, type) \
1177 (*current_target.to_insert_watchpoint) (addr, len, type)
c906108c 1178
ccaa32c7
GS
1179#define target_remove_watchpoint(addr, len, type) \
1180 (*current_target.to_remove_watchpoint) (addr, len, type)
c906108c 1181
a6d9a66e
UW
1182#define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1183 (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
ccaa32c7 1184
a6d9a66e
UW
1185#define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1186 (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
c906108c 1187
4aa7a7f5
JJ
1188#define target_stopped_data_address(target, x) \
1189 (*target.to_stopped_data_address) (target, x)
c906108c 1190
5009afc5
AS
1191#define target_watchpoint_addr_within_range(target, addr, start, length) \
1192 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1193
b2175913
MS
1194/* Target can execute in reverse? */
1195#define target_can_execute_reverse \
1196 (current_target.to_can_execute_reverse ? \
1197 current_target.to_can_execute_reverse () : 0)
1198
424163ea
DJ
1199extern const struct target_desc *target_read_description (struct target_ops *);
1200
0ef643c8
JB
1201#define target_get_ada_task_ptid(lwp, tid) \
1202 (*current_target.to_get_ada_task_ptid) (lwp,tid)
1203
08388c79
DE
1204/* Utility implementation of searching memory. */
1205extern int simple_search_memory (struct target_ops* ops,
1206 CORE_ADDR start_addr,
1207 ULONGEST search_space_len,
1208 const gdb_byte *pattern,
1209 ULONGEST pattern_len,
1210 CORE_ADDR *found_addrp);
1211
1212/* Main entry point for searching memory. */
1213extern int target_search_memory (CORE_ADDR start_addr,
1214 ULONGEST search_space_len,
1215 const gdb_byte *pattern,
1216 ULONGEST pattern_len,
1217 CORE_ADDR *found_addrp);
1218
49d03eab
MR
1219/* Command logging facility. */
1220
1221#define target_log_command(p) \
1222 do \
1223 if (current_target.to_log_command) \
1224 (*current_target.to_log_command) (p); \
1225 while (0)
1226
c906108c
SS
1227/* Routines for maintenance of the target structures...
1228
1229 add_target: Add a target to the list of all possible targets.
1230
1231 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
1232 targets, within its particular stratum of the stack. Result
1233 is 0 if now atop the stack, nonzero if not on top (maybe
1234 should warn user).
c906108c
SS
1235
1236 unpush_target: Remove this from the stack of currently used targets,
c5aa993b
JM
1237 no matter where it is on the list. Returns 0 if no
1238 change, 1 if removed from stack.
c906108c 1239
c5aa993b 1240 pop_target: Remove the top thing on the stack of current targets. */
c906108c 1241
a14ed312 1242extern void add_target (struct target_ops *);
c906108c 1243
a14ed312 1244extern int push_target (struct target_ops *);
c906108c 1245
a14ed312 1246extern int unpush_target (struct target_ops *);
c906108c 1247
fd79ecee
DJ
1248extern void target_pre_inferior (int);
1249
a14ed312 1250extern void target_preopen (int);
c906108c 1251
a14ed312 1252extern void pop_target (void);
c906108c 1253
aa76d38d
PA
1254/* Does whatever cleanup is required to get rid of all pushed targets.
1255 QUITTING is propagated to target_close; it indicates that GDB is
1256 exiting and should not get hung on an error (otherwise it is
1257 important to perform clean termination, even if it takes a
1258 while). */
1259extern void pop_all_targets (int quitting);
1260
87ab71f0
PA
1261/* Like pop_all_targets, but pops only targets whose stratum is
1262 strictly above ABOVE_STRATUM. */
1263extern void pop_all_targets_above (enum strata above_stratum, int quitting);
1264
9e35dae4
DJ
1265extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1266 CORE_ADDR offset);
1267
0542c86d 1268/* Struct target_section maps address ranges to file sections. It is
c906108c
SS
1269 mostly used with BFD files, but can be used without (e.g. for handling
1270 raw disks, or files not in formats handled by BFD). */
1271
0542c86d 1272struct target_section
c5aa993b
JM
1273 {
1274 CORE_ADDR addr; /* Lowest address in section */
1275 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 1276
7be0c536 1277 struct bfd_section *the_bfd_section;
c906108c 1278
c5aa993b
JM
1279 bfd *bfd; /* BFD file pointer */
1280 };
c906108c 1281
07b82ea5
PA
1282/* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1283
1284struct target_section_table
1285{
1286 struct target_section *sections;
1287 struct target_section *sections_end;
1288};
1289
8db32d44 1290/* Return the "section" containing the specified address. */
0542c86d
PA
1291struct target_section *target_section_by_addr (struct target_ops *target,
1292 CORE_ADDR addr);
8db32d44 1293
07b82ea5
PA
1294/* Return the target section table this target (or the targets
1295 beneath) currently manipulate. */
1296
1297extern struct target_section_table *target_get_section_table
1298 (struct target_ops *target);
1299
c906108c
SS
1300/* From mem-break.c */
1301
a6d9a66e 1302extern int memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
c906108c 1303
a6d9a66e 1304extern int memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
c906108c 1305
ae4b2284 1306extern int default_memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
917317f4 1307
ae4b2284 1308extern int default_memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
917317f4 1309
c906108c
SS
1310
1311/* From target.c */
1312
a14ed312 1313extern void initialize_targets (void);
c906108c 1314
117de6a9 1315extern NORETURN void noprocess (void) ATTR_NORETURN;
c906108c 1316
8edfe269
DJ
1317extern void target_require_runnable (void);
1318
136d6dae 1319extern void find_default_attach (struct target_ops *, char *, int);
c906108c 1320
136d6dae
VP
1321extern void find_default_create_inferior (struct target_ops *,
1322 char *, char *, char **, int);
c906108c 1323
a14ed312 1324extern struct target_ops *find_run_target (void);
7a292a7a 1325
a14ed312 1326extern struct target_ops *find_core_target (void);
6426a772 1327
a14ed312 1328extern struct target_ops *find_target_beneath (struct target_ops *);
ed9a39eb 1329
e0665bc8
PA
1330/* Read OS data object of type TYPE from the target, and return it in
1331 XML format. The result is NUL-terminated and returned as a string,
1332 allocated using xmalloc. If an error occurs or the transfer is
1333 unsupported, NULL is returned. Empty objects are returned as
1334 allocated but empty strings. */
1335
07e059b5
VP
1336extern char *target_get_osdata (const char *type);
1337
c906108c
SS
1338\f
1339/* Stuff that should be shared among the various remote targets. */
1340
1341/* Debugging level. 0 is off, and non-zero values mean to print some debug
1342 information (higher values, more information). */
1343extern int remote_debug;
1344
1345/* Speed in bits per second, or -1 which means don't mess with the speed. */
1346extern int baud_rate;
1347/* Timeout limit for response from target. */
1348extern int remote_timeout;
1349
c906108c
SS
1350\f
1351/* Functions for helping to write a native target. */
1352
1353/* This is for native targets which use a unix/POSIX-style waitstatus. */
a14ed312 1354extern void store_waitstatus (struct target_waitstatus *, int);
c906108c 1355
2aecd87f 1356/* These are in common/signals.c, but they're only used by gdb. */
1cded358
AR
1357extern enum target_signal default_target_signal_from_host (struct gdbarch *,
1358 int);
1359extern int default_target_signal_to_host (struct gdbarch *,
1360 enum target_signal);
1361
c906108c 1362/* Convert from a number used in a GDB command to an enum target_signal. */
a14ed312 1363extern enum target_signal target_signal_from_command (int);
2aecd87f 1364/* End of files in common/signals.c. */
c906108c 1365
8defab1a
DJ
1366/* Set the show memory breakpoints mode to show, and installs a cleanup
1367 to restore it back to the current value. */
1368extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1369
c906108c
SS
1370\f
1371/* Imported from machine dependent code */
1372
c906108c 1373/* Blank target vector entries are initialized to target_ignore. */
a14ed312 1374void target_ignore (void);
c906108c 1375
1df84f13 1376extern struct target_ops deprecated_child_ops;
5ac10fd1 1377
c5aa993b 1378#endif /* !defined (TARGET_H) */