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