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