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