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