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