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