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