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