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