gdb: add target_ops methods for displaced stepping
[deliverable/binutils-gdb.git] / gdb / target.h
CommitLineData
c906108c 1/* Interface between GDB and target environments, including files and processes
0088c768 2
b811d2c2 3 Copyright (C) 1990-2020 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;
07c138c8 41struct inferior;
0cf6dd15 42
68c14faa 43#include "infrun.h" /* For enum exec_direction_kind. */
f486487f 44#include "breakpoint.h" /* For enum bptype. */
268a13a5 45#include "gdbsupport/scoped_restore.h"
5b6d1e4f 46#include "gdbsupport/refcounted-object.h"
68c14faa 47
c906108c
SS
48/* This include file defines the interface between the main part
49 of the debugger, and the part which is target-specific, or
50 specific to the communications interface between us and the
51 target.
52
2146d243
RM
53 A TARGET is an interface between the debugger and a particular
54 kind of file or process. Targets can be STACKED in STRATA,
c906108c
SS
55 so that more than one target can potentially respond to a request.
56 In particular, memory accesses will walk down the stack of targets
57 until they find a target that is interested in handling that particular
58 address. STRATA are artificial boundaries on the stack, within
59 which particular kinds of targets live. Strata exist so that
60 people don't get confused by pushing e.g. a process target and then
61 a file target, and wondering why they can't see the current values
62 of variables any more (the file target is handling them and they
63 never get to the process target). So when you push a file target,
64 it goes into the file stratum, which is always below the process
a1740ee1
PA
65 stratum.
66
67 Note that rather than allow an empty stack, we always have the
68 dummy target at the bottom stratum, so we can call the target
69 methods without checking them. */
c906108c 70
721ec300 71#include "target/target.h"
33b60d58
LM
72#include "target/resume.h"
73#include "target/wait.h"
74#include "target/waitstatus.h"
c906108c
SS
75#include "bfd.h"
76#include "symtab.h"
29e57380 77#include "memattr.h"
268a13a5 78#include "gdbsupport/gdb_signals.h"
02d27625 79#include "btrace.h"
b158a20f 80#include "record.h"
9852c492 81#include "command.h"
9a24775b 82#include "disasm.h"
2098b393 83#include "tracepoint.h"
768e1fd2 84#include "displaced-stepping.h"
c906108c 85
268a13a5 86#include "gdbsupport/break-common.h" /* For enum target_hw_bp_type. */
f486487f 87
c5aa993b
JM
88enum strata
89 {
90 dummy_stratum, /* The lowest of the low */
91 file_stratum, /* Executable files, etc */
c0edd9ed 92 process_stratum, /* Executing processes or core dump files */
81e64f55 93 thread_stratum, /* Executing threads */
85e747d2 94 record_stratum, /* Support record debugging */
f6ac5f3d
PA
95 arch_stratum, /* Architecture overrides */
96 debug_stratum /* Target debug. Must be last. */
c5aa993b 97 };
c906108c 98
c5aa993b
JM
99enum thread_control_capabilities
100 {
0d06e24b
JM
101 tc_none = 0, /* Default: can't control thread execution. */
102 tc_schedlock = 1, /* Can lock the thread scheduler. */
c5aa993b 103 };
c906108c 104
a96d9b2e
SDJ
105/* The structure below stores information about a system call.
106 It is basically used in the "catch syscall" command, and in
107 every function that gives information about a system call.
108
109 It's also good to mention that its fields represent everything
110 that we currently know about a syscall in GDB. */
111struct syscall
112 {
113 /* The syscall number. */
114 int number;
115
116 /* The syscall name. */
117 const char *name;
118 };
119
09ce46f2
SM
120/* Return a pretty printed form of TARGET_OPTIONS. */
121extern std::string target_options_to_string (int target_options);
09826ec5 122
2acceee2 123/* Possible types of events that the inferior handler will have to
0d06e24b 124 deal with. */
2acceee2
JM
125enum inferior_event_type
126 {
2acceee2 127 /* Process a normal inferior event which will result in target_wait
0d06e24b 128 being called. */
2146d243 129 INF_REG_EVENT,
0d06e24b 130 /* We are called to do stuff after the inferior stops. */
c2d11a7d 131 INF_EXEC_COMPLETE,
2acceee2 132 };
c906108c 133\f
13547ab6
DJ
134/* Target objects which can be transfered using target_read,
135 target_write, et cetera. */
1e3ff5ad
AC
136
137enum target_object
138{
1e3ff5ad
AC
139 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
140 TARGET_OBJECT_AVR,
141 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
287a334e 142 TARGET_OBJECT_MEMORY,
cf7a04e8
DJ
143 /* Memory, avoiding GDB's data cache and trusting the executable.
144 Target implementations of to_xfer_partial never need to handle
145 this object, and most callers should not use it. */
146 TARGET_OBJECT_RAW_MEMORY,
4e5d721f
DE
147 /* Memory known to be part of the target's stack. This is cached even
148 if it is not in a region marked as such, since it is known to be
149 "normal" RAM. */
150 TARGET_OBJECT_STACK_MEMORY,
29453a14
YQ
151 /* Memory known to be part of the target code. This is cached even
152 if it is not in a region marked as such. */
153 TARGET_OBJECT_CODE_MEMORY,
287a334e
JJ
154 /* Kernel Unwind Table. See "ia64-tdep.c". */
155 TARGET_OBJECT_UNWIND_TABLE,
2146d243
RM
156 /* Transfer auxilliary vector. */
157 TARGET_OBJECT_AUXV,
baf92889 158 /* StackGhost cookie. See "sparc-tdep.c". */
fd79ecee
DJ
159 TARGET_OBJECT_WCOOKIE,
160 /* Target memory map in XML format. */
161 TARGET_OBJECT_MEMORY_MAP,
a76d924d
DJ
162 /* Flash memory. This object can be used to write contents to
163 a previously erased flash memory. Using it without erasing
164 flash can have unexpected results. Addresses are physical
165 address on target, and not relative to flash start. */
23181151
DJ
166 TARGET_OBJECT_FLASH,
167 /* Available target-specific features, e.g. registers and coprocessors.
168 See "target-descriptions.c". ANNEX should never be empty. */
cfa9d6d9
DJ
169 TARGET_OBJECT_AVAILABLE_FEATURES,
170 /* Currently loaded libraries, in XML format. */
07e059b5 171 TARGET_OBJECT_LIBRARIES,
2268b414
JK
172 /* Currently loaded libraries specific for SVR4 systems, in XML format. */
173 TARGET_OBJECT_LIBRARIES_SVR4,
4d1eb6b4 174 /* Currently loaded libraries specific to AIX systems, in XML format. */
ff99b71b 175 TARGET_OBJECT_LIBRARIES_AIX,
07e059b5 176 /* Get OS specific data. The ANNEX specifies the type (running
113a6f1e
JB
177 processes, etc.). The data being transfered is expected to follow
178 the DTD specified in features/osdata.dtd. */
4aa995e1
PA
179 TARGET_OBJECT_OSDATA,
180 /* Extra signal info. Usually the contents of `siginfo_t' on unix
181 platforms. */
182 TARGET_OBJECT_SIGNAL_INFO,
dc146f7c
VP
183 /* The list of threads that are being debugged. */
184 TARGET_OBJECT_THREADS,
0fb4aa4b
PA
185 /* Collected static trace data. */
186 TARGET_OBJECT_STATIC_TRACE_DATA,
b3b9301e
PA
187 /* Traceframe info, in XML format. */
188 TARGET_OBJECT_TRACEFRAME_INFO,
78d85199
YQ
189 /* Load maps for FDPIC systems. */
190 TARGET_OBJECT_FDPIC,
f00c55f8 191 /* Darwin dynamic linker info data. */
169081d0
TG
192 TARGET_OBJECT_DARWIN_DYLD_INFO,
193 /* OpenVMS Unwind Information Block. */
02d27625 194 TARGET_OBJECT_OPENVMS_UIB,
9accd112 195 /* Branch trace data, in XML format. */
f4abbc16
MM
196 TARGET_OBJECT_BTRACE,
197 /* Branch trace configuration, in XML format. */
c78fa86a
GB
198 TARGET_OBJECT_BTRACE_CONF,
199 /* The pathname of the executable file that was run to create
200 a specified process. ANNEX should be a string representation
201 of the process ID of the process in question, in hexadecimal
202 format. */
203 TARGET_OBJECT_EXEC_FILE,
739ab2e9
SS
204 /* FreeBSD virtual memory mappings. */
205 TARGET_OBJECT_FREEBSD_VMMAP,
206 /* FreeBSD process strings. */
207 TARGET_OBJECT_FREEBSD_PS_STRINGS,
c378eb4e 208 /* Possible future objects: TARGET_OBJECT_FILE, ... */
1e3ff5ad
AC
209};
210
9b409511 211/* Possible values returned by target_xfer_partial, etc. */
6be7b56e 212
9b409511 213enum target_xfer_status
6be7b56e 214{
9b409511
YQ
215 /* Some bytes are transferred. */
216 TARGET_XFER_OK = 1,
217
218 /* No further transfer is possible. */
219 TARGET_XFER_EOF = 0,
220
bc113b4e
YQ
221 /* The piece of the object requested is unavailable. */
222 TARGET_XFER_UNAVAILABLE = 2,
223
6be7b56e
PA
224 /* Generic I/O error. Note that it's important that this is '-1',
225 as we still have target_xfer-related code returning hardcoded
226 '-1' on error. */
227 TARGET_XFER_E_IO = -1,
228
01cb8804 229 /* Keep list in sync with target_xfer_status_to_string. */
6be7b56e
PA
230};
231
01cb8804 232/* Return the string form of STATUS. */
6be7b56e 233
01cb8804
YQ
234extern const char *
235 target_xfer_status_to_string (enum target_xfer_status status);
6be7b56e 236
9b409511 237typedef enum target_xfer_status
4ac248ca
YQ
238 target_xfer_partial_ftype (struct target_ops *ops,
239 enum target_object object,
240 const char *annex,
241 gdb_byte *readbuf,
242 const gdb_byte *writebuf,
243 ULONGEST offset,
9b409511
YQ
244 ULONGEST len,
245 ULONGEST *xfered_len);
4ac248ca 246
cc9f16aa
YQ
247enum target_xfer_status
248 raw_memory_xfer_partial (struct target_ops *ops, gdb_byte *readbuf,
249 const gdb_byte *writebuf, ULONGEST memaddr,
250 LONGEST len, ULONGEST *xfered_len);
251
d309493c
SM
252/* Request that OPS transfer up to LEN addressable units of the target's
253 OBJECT. When reading from a memory object, the size of an addressable unit
254 is architecture dependent and can be found using
255 gdbarch_addressable_memory_unit_size. Otherwise, an addressable unit is 1
256 byte long. BUF should point to a buffer large enough to hold the read data,
257 taking into account the addressable unit size. The OFFSET, for a seekable
258 object, specifies the starting point. The ANNEX can be used to provide
259 additional data-specific information to the target.
260
261 Return the number of addressable units actually transferred, or a negative
262 error code (an 'enum target_xfer_error' value) if the transfer is not
578d3588
PA
263 supported or otherwise fails. Return of a positive value less than
264 LEN indicates that no further transfer is possible. Unlike the raw
265 to_xfer_partial interface, callers of these functions do not need
266 to retry partial transfers. */
1e3ff5ad 267
1e3ff5ad
AC
268extern LONGEST target_read (struct target_ops *ops,
269 enum target_object object,
1b0ba102 270 const char *annex, gdb_byte *buf,
1e3ff5ad
AC
271 ULONGEST offset, LONGEST len);
272
8dedea02 273struct memory_read_result
386c8614
TT
274{
275 memory_read_result (ULONGEST begin_, ULONGEST end_,
276 gdb::unique_xmalloc_ptr<gdb_byte> &&data_)
277 : begin (begin_),
278 end (end_),
279 data (std::move (data_))
8dedea02 280 {
386c8614
TT
281 }
282
283 ~memory_read_result () = default;
8dedea02 284
386c8614
TT
285 memory_read_result (memory_read_result &&other) = default;
286
287 DISABLE_COPY_AND_ASSIGN (memory_read_result);
288
289 /* First address that was read. */
290 ULONGEST begin;
291 /* Past-the-end address. */
292 ULONGEST end;
293 /* The data. */
294 gdb::unique_xmalloc_ptr<gdb_byte> data;
295};
8dedea02 296
386c8614
TT
297extern std::vector<memory_read_result> read_memory_robust
298 (struct target_ops *ops, const ULONGEST offset, const LONGEST len);
279a6fed 299
d309493c
SM
300/* Request that OPS transfer up to LEN addressable units from BUF to the
301 target's OBJECT. When writing to a memory object, the addressable unit
302 size is architecture dependent and can be found using
303 gdbarch_addressable_memory_unit_size. Otherwise, an addressable unit is 1
304 byte long. The OFFSET, for a seekable object, specifies the starting point.
305 The ANNEX can be used to provide additional data-specific information to
306 the target.
307
308 Return the number of addressable units actually transferred, or a negative
309 error code (an 'enum target_xfer_status' value) if the transfer is not
310 supported or otherwise fails. Return of a positive value less than
311 LEN indicates that no further transfer is possible. Unlike the raw
312 to_xfer_partial interface, callers of these functions do not need to
313 retry partial transfers. */
314
1e3ff5ad
AC
315extern LONGEST target_write (struct target_ops *ops,
316 enum target_object object,
1b0ba102 317 const char *annex, const gdb_byte *buf,
1e3ff5ad 318 ULONGEST offset, LONGEST len);
b6591e8b 319
a76d924d
DJ
320/* Similar to target_write, except that it also calls PROGRESS with
321 the number of bytes written and the opaque BATON after every
322 successful partial write (and before the first write). This is
323 useful for progress reporting and user interaction while writing
324 data. To abort the transfer, the progress callback can throw an
325 exception. */
326
cf7a04e8
DJ
327LONGEST target_write_with_progress (struct target_ops *ops,
328 enum target_object object,
329 const char *annex, const gdb_byte *buf,
330 ULONGEST offset, LONGEST len,
331 void (*progress) (ULONGEST, void *),
332 void *baton);
333
9018be22
SM
334/* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will be read
335 using OPS. The return value will be uninstantiated if the transfer fails or
336 is not supported.
13547ab6
DJ
337
338 This method should be used for objects sufficiently small to store
339 in a single xmalloc'd buffer, when no fixed bound on the object's
340 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
341 through this function. */
342
9018be22
SM
343extern gdb::optional<gdb::byte_vector> target_read_alloc
344 (struct target_ops *ops, enum target_object object, const char *annex);
13547ab6 345
9018be22
SM
346/* Read OBJECT/ANNEX using OPS. The result is a NUL-terminated character vector
347 (therefore usable as a NUL-terminated string). If an error occurs or the
348 transfer is unsupported, the return value will be uninstantiated. Empty
349 objects are returned as allocated but empty strings. Therefore, on success,
350 the returned vector is guaranteed to have at least one element. A warning is
351 issued if the result contains any embedded NUL bytes. */
159f81f3 352
9018be22 353extern gdb::optional<gdb::char_vector> target_read_stralloc
b7b030ad 354 (struct target_ops *ops, enum target_object object, const char *annex);
159f81f3 355
6be7b56e 356/* See target_ops->to_xfer_partial. */
4ac248ca 357extern target_xfer_partial_ftype target_xfer_partial;
6be7b56e 358
b6591e8b
AC
359/* Wrappers to target read/write that perform memory transfers. They
360 throw an error if the memory transfer fails.
361
362 NOTE: cagney/2003-10-23: The naming schema is lifted from
363 "frame.h". The parameter order is lifted from get_frame_memory,
364 which in turn lifted it from read_memory. */
365
366extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
1b0ba102 367 gdb_byte *buf, LONGEST len);
b6591e8b 368extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
e17a4113
UW
369 CORE_ADDR addr, int len,
370 enum bfd_endian byte_order);
1e3ff5ad 371\f
0d06e24b
JM
372struct thread_info; /* fwd decl for parameter list below: */
373
b0a16e66
TT
374/* The type of the callback to the to_async method. */
375
376typedef void async_callback_ftype (enum inferior_event_type event_type,
377 void *context);
378
a7068b60
TT
379/* Normally target debug printing is purely type-based. However,
380 sometimes it is necessary to override the debug printing on a
381 per-argument basis. This macro can be used, attribute-style, to
382 name the target debug printing function for a particular method
383 argument. FUNC is the name of the function. The macro's
384 definition is empty because it is only used by the
385 make-target-delegates script. */
386
387#define TARGET_DEBUG_PRINTER(FUNC)
388
1101cb7b
TT
389/* These defines are used to mark target_ops methods. The script
390 make-target-delegates scans these and auto-generates the base
391 method implementations. There are four macros that can be used:
392
393 1. TARGET_DEFAULT_IGNORE. There is no argument. The base method
394 does nothing. This is only valid if the method return type is
395 'void'.
396
397 2. TARGET_DEFAULT_NORETURN. The argument is a function call, like
398 'tcomplain ()'. The base method simply makes this call, which is
399 assumed not to return.
400
401 3. TARGET_DEFAULT_RETURN. The argument is a C expression. The
402 base method returns this expression's value.
403
404 4. TARGET_DEFAULT_FUNC. The argument is the name of a function.
405 make-target-delegates does not generate a base method in this case,
406 but instead uses the argument function as the base method. */
407
408#define TARGET_DEFAULT_IGNORE()
409#define TARGET_DEFAULT_NORETURN(ARG)
410#define TARGET_DEFAULT_RETURN(ARG)
411#define TARGET_DEFAULT_FUNC(ARG)
412
d9f719f1
PA
413/* Each target that can be activated with "target TARGET_NAME" passes
414 the address of one of these objects to add_target, which uses the
415 object's address as unique identifier, and registers the "target
416 TARGET_NAME" command using SHORTNAME as target name. */
417
418struct target_info
419{
420 /* Name of this target. */
421 const char *shortname;
422
423 /* Name for printing. */
424 const char *longname;
425
426 /* Documentation. Does not include trailing newline, and starts
427 with a one-line description (probably similar to longname). */
428 const char *doc;
429};
430
c906108c 431struct target_ops
5b6d1e4f 432 : public refcounted_object
c5aa993b 433 {
66b4deae
PA
434 /* Return this target's stratum. */
435 virtual strata stratum () const = 0;
436
b6a8c27b 437 /* To the target under this one. */
b6a8c27b 438 target_ops *beneath () const;
f6ac5f3d 439
d9f719f1
PA
440 /* Free resources associated with the target. Note that singleton
441 targets, like e.g., native targets, are global objects, not
442 heap allocated, and are thus only deleted on GDB exit. The
443 main teardown entry point is the "close" method, below. */
f6ac5f3d
PA
444 virtual ~target_ops () {}
445
d9f719f1
PA
446 /* Return a reference to this target's unique target_info
447 object. */
448 virtual const target_info &info () const = 0;
f6ac5f3d 449
d9f719f1 450 /* Name this target type. */
5b6d1e4f 451 const char *shortname () const
d9f719f1 452 { return info ().shortname; }
f6ac5f3d 453
5b6d1e4f 454 const char *longname () const
d9f719f1 455 { return info ().longname; }
3fffc070
PA
456
457 /* Close the target. This is where the target can handle
458 teardown. Heap-allocated targets should delete themselves
459 before returning. */
f6ac5f3d 460 virtual void close ();
3fffc070 461
b3ccfe11
TT
462 /* Attaches to a process on the target side. Arguments are as
463 passed to the `attach' command by the user. This routine can
464 be called when the target is not on the target-stack, if the
f6ac5f3d 465 target_ops::can_run method returns 1; in that case, it must push
b3ccfe11
TT
466 itself onto the stack. Upon exit, the target should be ready
467 for normal operations, and should be ready to deliver the
468 status of the process immediately (without waiting) to an
469 upcoming target_wait call. */
f6ac5f3d
PA
470 virtual bool can_attach ();
471 virtual void attach (const char *, int);
472 virtual void post_attach (int)
bebd3233 473 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 474 virtual void detach (inferior *, int)
09da0d0a 475 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 476 virtual void disconnect (const char *, int)
86a0854a 477 TARGET_DEFAULT_NORETURN (tcomplain ());
f6ac5f3d
PA
478 virtual void resume (ptid_t,
479 int TARGET_DEBUG_PRINTER (target_debug_print_step),
480 enum gdb_signal)
6b84065d 481 TARGET_DEFAULT_NORETURN (noprocess ());
f6ac5f3d 482 virtual void commit_resume ()
85ad3aaf 483 TARGET_DEFAULT_IGNORE ();
ec506636
PA
484 /* See target_wait's description. Note that implementations of
485 this method must not assume that inferior_ptid on entry is
486 pointing at the thread or inferior that ends up reporting an
487 event. The reported event could be for some other thread in
488 the current inferior or even for a different process of the
489 current target. inferior_ptid may also be null_ptid on
490 entry. */
f6ac5f3d
PA
491 virtual ptid_t wait (ptid_t, struct target_waitstatus *,
492 int TARGET_DEBUG_PRINTER (target_debug_print_options))
0b333c5e 493 TARGET_DEFAULT_FUNC (default_target_wait);
f6ac5f3d 494 virtual void fetch_registers (struct regcache *, int)
ad5989bd 495 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 496 virtual void store_registers (struct regcache *, int)
6b84065d 497 TARGET_DEFAULT_NORETURN (noprocess ());
f6ac5f3d 498 virtual void prepare_to_store (struct regcache *)
6c628163 499 TARGET_DEFAULT_NORETURN (noprocess ());
c5aa993b 500
f6ac5f3d 501 virtual void files_info ()
f86e59b2 502 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 503 virtual int insert_breakpoint (struct gdbarch *,
6b84065d 504 struct bp_target_info *)
f6ac5f3d
PA
505 TARGET_DEFAULT_NORETURN (noprocess ());
506 virtual int remove_breakpoint (struct gdbarch *,
73971819
PA
507 struct bp_target_info *,
508 enum remove_bp_reason)
f6ac5f3d 509 TARGET_DEFAULT_NORETURN (noprocess ());
1cf4d951
PA
510
511 /* Returns true if the target stopped because it executed a
512 software breakpoint. This is necessary for correct background
513 execution / non-stop mode operation, and for correct PC
514 adjustment on targets where the PC needs to be adjusted when a
515 software breakpoint triggers. In these modes, by the time GDB
516 processes a breakpoint event, the breakpoint may already be
517 done from the target, so GDB needs to be able to tell whether
518 it should ignore the event and whether it should adjust the PC.
519 See adjust_pc_after_break. */
57810aa7
PA
520 virtual bool stopped_by_sw_breakpoint ()
521 TARGET_DEFAULT_RETURN (false);
1cf4d951 522 /* Returns true if the above method is supported. */
57810aa7
PA
523 virtual bool supports_stopped_by_sw_breakpoint ()
524 TARGET_DEFAULT_RETURN (false);
1cf4d951
PA
525
526 /* Returns true if the target stopped for a hardware breakpoint.
527 Likewise, if the target supports hardware breakpoints, this
528 method is necessary for correct background execution / non-stop
529 mode operation. Even though hardware breakpoints do not
530 require PC adjustment, GDB needs to be able to tell whether the
531 hardware breakpoint event is a delayed event for a breakpoint
532 that is already gone and should thus be ignored. */
57810aa7
PA
533 virtual bool stopped_by_hw_breakpoint ()
534 TARGET_DEFAULT_RETURN (false);
1cf4d951 535 /* Returns true if the above method is supported. */
57810aa7
PA
536 virtual bool supports_stopped_by_hw_breakpoint ()
537 TARGET_DEFAULT_RETURN (false);
1cf4d951 538
f6ac5f3d 539 virtual int can_use_hw_breakpoint (enum bptype, int, int)
52b51d06 540 TARGET_DEFAULT_RETURN (0);
f6ac5f3d 541 virtual int ranged_break_num_registers ()
a134316b 542 TARGET_DEFAULT_RETURN (-1);
f6ac5f3d
PA
543 virtual int insert_hw_breakpoint (struct gdbarch *,
544 struct bp_target_info *)
61b371f9 545 TARGET_DEFAULT_RETURN (-1);
f6ac5f3d
PA
546 virtual int remove_hw_breakpoint (struct gdbarch *,
547 struct bp_target_info *)
418dabac 548 TARGET_DEFAULT_RETURN (-1);
0cf6dd15
TJB
549
550 /* Documentation of what the two routines below are expected to do is
551 provided with the corresponding target_* macros. */
f6ac5f3d 552 virtual int remove_watchpoint (CORE_ADDR, int,
f486487f 553 enum target_hw_bp_type, struct expression *)
61dd109f 554 TARGET_DEFAULT_RETURN (-1);
f6ac5f3d 555 virtual int insert_watchpoint (CORE_ADDR, int,
f486487f 556 enum target_hw_bp_type, struct expression *)
016facd4 557 TARGET_DEFAULT_RETURN (-1);
0cf6dd15 558
f6ac5f3d
PA
559 virtual int insert_mask_watchpoint (CORE_ADDR, CORE_ADDR,
560 enum target_hw_bp_type)
cd4ae029 561 TARGET_DEFAULT_RETURN (1);
f6ac5f3d
PA
562 virtual int remove_mask_watchpoint (CORE_ADDR, CORE_ADDR,
563 enum target_hw_bp_type)
8b1c364c 564 TARGET_DEFAULT_RETURN (1);
57810aa7
PA
565 virtual bool stopped_by_watchpoint ()
566 TARGET_DEFAULT_RETURN (false);
c2a6c5da 567 virtual bool have_steppable_watchpoint ()
57810aa7 568 TARGET_DEFAULT_RETURN (false);
57810aa7
PA
569 virtual bool stopped_data_address (CORE_ADDR *)
570 TARGET_DEFAULT_RETURN (false);
571 virtual bool watchpoint_addr_within_range (CORE_ADDR, CORE_ADDR, int)
65f160a9 572 TARGET_DEFAULT_FUNC (default_watchpoint_addr_within_range);
e09342b5
TJB
573
574 /* Documentation of this routine is provided with the corresponding
575 target_* macro. */
f6ac5f3d 576 virtual int region_ok_for_hw_watchpoint (CORE_ADDR, int)
d03655e4 577 TARGET_DEFAULT_FUNC (default_region_ok_for_hw_watchpoint);
e09342b5 578
57810aa7
PA
579 virtual bool can_accel_watchpoint_condition (CORE_ADDR, int, int,
580 struct expression *)
581 TARGET_DEFAULT_RETURN (false);
f6ac5f3d 582 virtual int masked_watch_num_registers (CORE_ADDR, CORE_ADDR)
6c7e5e5c 583 TARGET_DEFAULT_RETURN (-1);
750ce8d1
YQ
584
585 /* Return 1 for sure target can do single step. Return -1 for
586 unknown. Return 0 for target can't do. */
f6ac5f3d 587 virtual int can_do_single_step ()
750ce8d1
YQ
588 TARGET_DEFAULT_RETURN (-1);
589
f6ac5f3d 590 virtual bool supports_terminal_ours ()
57810aa7 591 TARGET_DEFAULT_RETURN (false);
f6ac5f3d 592 virtual void terminal_init ()
0343661d 593 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 594 virtual void terminal_inferior ()
ddeaacc9 595 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 596 virtual void terminal_save_inferior ()
e671cd59 597 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 598 virtual void terminal_ours_for_output ()
74fcbef9 599 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 600 virtual void terminal_ours ()
e4a733f1 601 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 602 virtual void terminal_info (const char *, int)
e19e919f 603 TARGET_DEFAULT_FUNC (default_terminal_info);
f6ac5f3d 604 virtual void kill ()
423a4807 605 TARGET_DEFAULT_NORETURN (noprocess ());
f6ac5f3d 606 virtual void load (const char *, int)
7634da87 607 TARGET_DEFAULT_NORETURN (tcomplain ());
b3ccfe11
TT
608 /* Start an inferior process and set inferior_ptid to its pid.
609 EXEC_FILE is the file to run.
610 ALLARGS is a string containing the arguments to the program.
611 ENV is the environment vector to pass. Errors reported with error().
612 On VxWorks and various standalone systems, we ignore exec_file. */
f6ac5f3d
PA
613 virtual bool can_create_inferior ();
614 virtual void create_inferior (const char *, const std::string &,
615 char **, int);
616 virtual void post_startup_inferior (ptid_t)
340ba4bf 617 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 618 virtual int insert_fork_catchpoint (int)
5958ebeb 619 TARGET_DEFAULT_RETURN (1);
f6ac5f3d 620 virtual int remove_fork_catchpoint (int)
e1a21fb7 621 TARGET_DEFAULT_RETURN (1);
f6ac5f3d 622 virtual int insert_vfork_catchpoint (int)
7e18a8dc 623 TARGET_DEFAULT_RETURN (1);
f6ac5f3d 624 virtual int remove_vfork_catchpoint (int)
95c3375e 625 TARGET_DEFAULT_RETURN (1);
5ab2fbf1 626 virtual bool follow_fork (bool, bool)
098dba18 627 TARGET_DEFAULT_FUNC (default_follow_fork);
f6ac5f3d 628 virtual int insert_exec_catchpoint (int)
62f64d7a 629 TARGET_DEFAULT_RETURN (1);
f6ac5f3d 630 virtual int remove_exec_catchpoint (int)
cda0f38c 631 TARGET_DEFAULT_RETURN (1);
4ca51187 632 virtual void follow_exec (struct inferior *, const char *)
94585166 633 TARGET_DEFAULT_IGNORE ();
f6ac5f3d
PA
634 virtual int set_syscall_catchpoint (int, bool, int,
635 gdb::array_view<const int>)
6a9fa051 636 TARGET_DEFAULT_RETURN (1);
f6ac5f3d 637 virtual void mourn_inferior ()
8d657035 638 TARGET_DEFAULT_FUNC (default_mourn_inferior);
f6ac5f3d
PA
639
640 /* Note that can_run is special and can be invoked on an unpushed
641 target. Targets defining this method must also define
b3ccfe11 642 to_can_async_p and to_supports_non_stop. */
57810aa7 643 virtual bool can_run ();
2455069d
UW
644
645 /* Documentation of this routine is provided with the corresponding
646 target_* macro. */
adc6a863 647 virtual void pass_signals (gdb::array_view<const unsigned char> TARGET_DEBUG_PRINTER (target_debug_print_signals))
035cad7f 648 TARGET_DEFAULT_IGNORE ();
2455069d 649
9b224c5e
PA
650 /* Documentation of this routine is provided with the
651 corresponding target_* function. */
adc6a863 652 virtual void program_signals (gdb::array_view<const unsigned char> TARGET_DEBUG_PRINTER (target_debug_print_signals))
7d4f8efa 653 TARGET_DEFAULT_IGNORE ();
9b224c5e 654
57810aa7
PA
655 virtual bool thread_alive (ptid_t ptid)
656 TARGET_DEFAULT_RETURN (false);
f6ac5f3d 657 virtual void update_thread_list ()
09b0dc2b 658 TARGET_DEFAULT_IGNORE ();
a068643d 659 virtual std::string pid_to_str (ptid_t)
770234d3 660 TARGET_DEFAULT_FUNC (default_pid_to_str);
f6ac5f3d 661 virtual const char *extra_thread_info (thread_info *)
9b144037 662 TARGET_DEFAULT_RETURN (NULL);
f6ac5f3d 663 virtual const char *thread_name (thread_info *)
9b144037 664 TARGET_DEFAULT_RETURN (NULL);
f6ac5f3d
PA
665 virtual thread_info *thread_handle_to_thread_info (const gdb_byte *,
666 int,
667 inferior *inf)
e04ee09e 668 TARGET_DEFAULT_RETURN (NULL);
3d6c6204
KB
669 /* See target_thread_info_to_thread_handle. */
670 virtual gdb::byte_vector thread_info_to_thread_handle (struct thread_info *)
671 TARGET_DEFAULT_RETURN (gdb::byte_vector ());
f6ac5f3d 672 virtual void stop (ptid_t)
46ee7e8d 673 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 674 virtual void interrupt ()
bfedc46a 675 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 676 virtual void pass_ctrlc ()
93692b58 677 TARGET_DEFAULT_FUNC (default_target_pass_ctrlc);
f6ac5f3d 678 virtual void rcmd (const char *command, struct ui_file *output)
a53f3625 679 TARGET_DEFAULT_FUNC (default_rcmd);
f6ac5f3d 680 virtual char *pid_to_exec_file (int pid)
9b144037 681 TARGET_DEFAULT_RETURN (NULL);
f6ac5f3d 682 virtual void log_command (const char *)
d9cb0195 683 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 684 virtual struct target_section_table *get_section_table ()
9b144037 685 TARGET_DEFAULT_RETURN (NULL);
f6ac5f3d
PA
686
687 /* Provide default values for all "must have" methods. */
57810aa7
PA
688 virtual bool has_all_memory () { return false; }
689 virtual bool has_memory () { return false; }
690 virtual bool has_stack () { return false; }
691 virtual bool has_registers () { return false; }
5018ce90 692 virtual bool has_execution (inferior *inf) { return false; }
f6ac5f3d
PA
693
694 /* Control thread execution. */
695 virtual thread_control_capabilities get_thread_control_capabilities ()
696 TARGET_DEFAULT_RETURN (tc_none);
697 virtual bool attach_no_wait ()
698 TARGET_DEFAULT_RETURN (0);
b3ccfe11 699 /* This method must be implemented in some situations. See the
f6ac5f3d 700 comment on 'can_run'. */
57810aa7
PA
701 virtual bool can_async_p ()
702 TARGET_DEFAULT_RETURN (false);
703 virtual bool is_async_p ()
704 TARGET_DEFAULT_RETURN (false);
f6ac5f3d 705 virtual void async (int)
6b84065d 706 TARGET_DEFAULT_NORETURN (tcomplain ());
5b6d1e4f
PA
707 virtual int async_wait_fd ()
708 TARGET_DEFAULT_NORETURN (noprocess ());
f6ac5f3d 709 virtual void thread_events (int)
65706a29 710 TARGET_DEFAULT_IGNORE ();
b3ccfe11 711 /* This method must be implemented in some situations. See the
f6ac5f3d 712 comment on 'can_run'. */
57810aa7
PA
713 virtual bool supports_non_stop ()
714 TARGET_DEFAULT_RETURN (false);
fbea99ea
PA
715 /* Return true if the target operates in non-stop mode even with
716 "set non-stop off". */
57810aa7
PA
717 virtual bool always_non_stop_p ()
718 TARGET_DEFAULT_RETURN (false);
6b04bdb7 719 /* find_memory_regions support method for gcore */
f6ac5f3d 720 virtual int find_memory_regions (find_memory_region_ftype func, void *data)
0b5a2719 721 TARGET_DEFAULT_FUNC (dummy_find_memory_regions);
6b04bdb7 722 /* make_corefile_notes support method for gcore */
f6ac5f3d 723 virtual char *make_corefile_notes (bfd *, int *)
16f796b1 724 TARGET_DEFAULT_FUNC (dummy_make_corefile_notes);
6b04bdb7 725 /* get_bookmark support method for bookmarks */
f6ac5f3d 726 virtual gdb_byte *get_bookmark (const char *, int)
3dbafbbb 727 TARGET_DEFAULT_NORETURN (tcomplain ());
6b04bdb7 728 /* goto_bookmark support method for bookmarks */
f6ac5f3d 729 virtual void goto_bookmark (const gdb_byte *, int)
9bb9d61d 730 TARGET_DEFAULT_NORETURN (tcomplain ());
3f47be5c
EZ
731 /* Return the thread-local address at OFFSET in the
732 thread-local storage for the thread PTID and the shared library
cd250a18 733 or executable file given by LOAD_MODULE_ADDR. If that block of
3f47be5c 734 thread-local storage hasn't been allocated yet, this function
cd250a18 735 may throw an error. LOAD_MODULE_ADDR may be zero for statically
5876f503 736 linked multithreaded inferiors. */
f6ac5f3d
PA
737 virtual CORE_ADDR get_thread_local_address (ptid_t ptid,
738 CORE_ADDR load_module_addr,
739 CORE_ADDR offset)
f0f9ff95 740 TARGET_DEFAULT_NORETURN (generic_tls_error ());
3f47be5c 741
e4da2c61
SM
742 /* Request that OPS transfer up to LEN addressable units of the target's
743 OBJECT. When reading from a memory object, the size of an addressable
744 unit is architecture dependent and can be found using
745 gdbarch_addressable_memory_unit_size. Otherwise, an addressable unit is
746 1 byte long. The OFFSET, for a seekable object, specifies the
13547ab6
DJ
747 starting point. The ANNEX can be used to provide additional
748 data-specific information to the target.
749
9b409511 750 Return the transferred status, error or OK (an
e4da2c61 751 'enum target_xfer_status' value). Save the number of addressable units
9b409511 752 actually transferred in *XFERED_LEN if transfer is successful
e4da2c61 753 (TARGET_XFER_OK) or the number unavailable units if the requested
bc113b4e 754 data is unavailable (TARGET_XFER_UNAVAILABLE). *XFERED_LEN
9b409511
YQ
755 smaller than LEN does not indicate the end of the object, only
756 the end of the transfer; higher level code should continue
757 transferring if desired. This is handled in target.c.
13547ab6
DJ
758
759 The interface does not support a "retry" mechanism. Instead it
e4da2c61 760 assumes that at least one addressable unit will be transfered on each
13547ab6
DJ
761 successful call.
762
763 NOTE: cagney/2003-10-17: The current interface can lead to
764 fragmented transfers. Lower target levels should not implement
765 hacks, such as enlarging the transfer, in an attempt to
766 compensate for this. Instead, the target stack should be
767 extended so that it implements supply/collect methods and a
768 look-aside object cache. With that available, the lowest
769 target can safely and freely "push" data up the stack.
770
771 See target_read and target_write for more information. One,
772 and only one, of readbuf or writebuf must be non-NULL. */
773
f6ac5f3d
PA
774 virtual enum target_xfer_status xfer_partial (enum target_object object,
775 const char *annex,
776 gdb_byte *readbuf,
777 const gdb_byte *writebuf,
778 ULONGEST offset, ULONGEST len,
779 ULONGEST *xfered_len)
6b84065d 780 TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
1e3ff5ad 781
09c98b44
DB
782 /* Return the limit on the size of any single memory transfer
783 for the target. */
784
f6ac5f3d 785 virtual ULONGEST get_memory_xfer_limit ()
09c98b44
DB
786 TARGET_DEFAULT_RETURN (ULONGEST_MAX);
787
fd79ecee
DJ
788 /* Returns the memory map for the target. A return value of NULL
789 means that no memory map is available. If a memory address
790 does not fall within any returned regions, it's assumed to be
791 RAM. The returned memory regions should not overlap.
792
793 The order of regions does not matter; target_memory_map will
c378eb4e 794 sort regions by starting address. For that reason, this
fd79ecee
DJ
795 function should not be called directly except via
796 target_memory_map.
797
798 This method should not cache data; if the memory map could
799 change unexpectedly, it should be invalidated, and higher
800 layers will re-fetch it. */
f6ac5f3d 801 virtual std::vector<mem_region> memory_map ()
a664f67e 802 TARGET_DEFAULT_RETURN (std::vector<mem_region> ());
fd79ecee 803
a76d924d
DJ
804 /* Erases the region of flash memory starting at ADDRESS, of
805 length LENGTH.
806
807 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
808 on flash block boundaries, as reported by 'to_memory_map'. */
f6ac5f3d 809 virtual void flash_erase (ULONGEST address, LONGEST length)
e8a6c6ac 810 TARGET_DEFAULT_NORETURN (tcomplain ());
a76d924d
DJ
811
812 /* Finishes a flash memory write sequence. After this operation
813 all flash memory should be available for writing and the result
814 of reading from areas written by 'to_flash_write' should be
815 equal to what was written. */
f6ac5f3d 816 virtual void flash_done ()
f6fb2925 817 TARGET_DEFAULT_NORETURN (tcomplain ());
a76d924d 818
2117c711
TT
819 /* Describe the architecture-specific features of this target. If
820 OPS doesn't have a description, this should delegate to the
821 "beneath" target. Returns the description found, or NULL if no
822 description was available. */
f6ac5f3d 823 virtual const struct target_desc *read_description ()
9b144037 824 TARGET_DEFAULT_RETURN (NULL);
424163ea 825
0ef643c8
JB
826 /* Build the PTID of the thread on which a given task is running,
827 based on LWP and THREAD. These values are extracted from the
828 task Private_Data section of the Ada Task Control Block, and
829 their interpretation depends on the target. */
f6ac5f3d 830 virtual ptid_t get_ada_task_ptid (long lwp, long thread)
4229b31d 831 TARGET_DEFAULT_FUNC (default_get_ada_task_ptid);
0ef643c8 832
c47ffbe3
VP
833 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
834 Return 0 if *READPTR is already at the end of the buffer.
835 Return -1 if there is insufficient buffer for a whole entry.
836 Return 1 if an entry was read into *TYPEP and *VALP. */
f6ac5f3d
PA
837 virtual int auxv_parse (gdb_byte **readptr,
838 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
8de71aab 839 TARGET_DEFAULT_FUNC (default_auxv_parse);
c47ffbe3 840
08388c79
DE
841 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
842 sequence of bytes in PATTERN with length PATTERN_LEN.
843
844 The result is 1 if found, 0 if not found, and -1 if there was an error
845 requiring halting of the search (e.g. memory read error).
846 If the pattern is found the address is recorded in FOUND_ADDRP. */
f6ac5f3d
PA
847 virtual int search_memory (CORE_ADDR start_addr, ULONGEST search_space_len,
848 const gdb_byte *pattern, ULONGEST pattern_len,
849 CORE_ADDR *found_addrp)
58a5184e 850 TARGET_DEFAULT_FUNC (default_search_memory);
08388c79 851
b2175913 852 /* Can target execute in reverse? */
57810aa7
PA
853 virtual bool can_execute_reverse ()
854 TARGET_DEFAULT_RETURN (false);
b2175913 855
32231432
PA
856 /* The direction the target is currently executing. Must be
857 implemented on targets that support reverse execution and async
858 mode. The default simply returns forward execution. */
f6ac5f3d 859 virtual enum exec_direction_kind execution_direction ()
fe31bf5b 860 TARGET_DEFAULT_FUNC (default_execution_direction);
32231432 861
8a305172
PA
862 /* Does this target support debugging multiple processes
863 simultaneously? */
57810aa7
PA
864 virtual bool supports_multi_process ()
865 TARGET_DEFAULT_RETURN (false);
8a305172 866
d248b706
KY
867 /* Does this target support enabling and disabling tracepoints while a trace
868 experiment is running? */
57810aa7
PA
869 virtual bool supports_enable_disable_tracepoint ()
870 TARGET_DEFAULT_RETURN (false);
d248b706 871
03583c20 872 /* Does this target support disabling address space randomization? */
57810aa7 873 virtual bool supports_disable_randomization ()
f6ac5f3d 874 TARGET_DEFAULT_FUNC (find_default_supports_disable_randomization);
03583c20 875
3065dfb6 876 /* Does this target support the tracenz bytecode for string collection? */
57810aa7
PA
877 virtual bool supports_string_tracing ()
878 TARGET_DEFAULT_RETURN (false);
3065dfb6 879
b775012e
LM
880 /* Does this target support evaluation of breakpoint conditions on its
881 end? */
57810aa7
PA
882 virtual bool supports_evaluation_of_breakpoint_conditions ()
883 TARGET_DEFAULT_RETURN (false);
b775012e 884
d3ce09f5
SS
885 /* Does this target support evaluation of breakpoint commands on its
886 end? */
57810aa7
PA
887 virtual bool can_run_breakpoint_commands ()
888 TARGET_DEFAULT_RETURN (false);
d3ce09f5 889
3a8f7b07
JK
890 /* Determine current architecture of thread PTID.
891
892 The target is supposed to determine the architecture of the code where
8133c7dc
LM
893 the target is currently stopped at. The architecture information is
894 used to perform decr_pc_after_break adjustment, and also to determine
895 the frame architecture of the innermost frame. ptrace operations need to
896 operate according to target_gdbarch (). */
f6ac5f3d 897 virtual struct gdbarch *thread_architecture (ptid_t)
3b3dac9b 898 TARGET_DEFAULT_RETURN (NULL);
c0694254 899
3b3dac9b 900 /* Determine current address space of thread PTID. */
f6ac5f3d 901 virtual struct address_space *thread_address_space (ptid_t)
3b3dac9b 902 TARGET_DEFAULT_RETURN (NULL);
c0694254 903
7313baad
UW
904 /* Target file operations. */
905
07c138c8
GB
906 /* Return nonzero if the filesystem seen by the current inferior
907 is the local filesystem, zero otherwise. */
57810aa7
PA
908 virtual bool filesystem_is_local ()
909 TARGET_DEFAULT_RETURN (true);
4bd7dc42 910
07c138c8
GB
911 /* Open FILENAME on the target, in the filesystem as seen by INF,
912 using FLAGS and MODE. If INF is NULL, use the filesystem seen
913 by the debugger (GDB or, for remote targets, the remote stub).
4313b8c0
GB
914 If WARN_IF_SLOW is nonzero, print a warning message if the file
915 is being accessed over a link that may be slow. Return a
916 target file descriptor, or -1 if an error occurs (and set
917 *TARGET_ERRNO). */
f6ac5f3d
PA
918 virtual int fileio_open (struct inferior *inf, const char *filename,
919 int flags, int mode, int warn_if_slow,
920 int *target_errno);
7313baad
UW
921
922 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
923 Return the number of bytes written, or -1 if an error occurs
924 (and set *TARGET_ERRNO). */
f6ac5f3d
PA
925 virtual int fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
926 ULONGEST offset, int *target_errno);
7313baad
UW
927
928 /* Read up to LEN bytes FD on the target into READ_BUF.
929 Return the number of bytes read, or -1 if an error occurs
930 (and set *TARGET_ERRNO). */
f6ac5f3d
PA
931 virtual int fileio_pread (int fd, gdb_byte *read_buf, int len,
932 ULONGEST offset, int *target_errno);
7313baad 933
9b15c1f0
GB
934 /* Get information about the file opened as FD and put it in
935 SB. Return 0 on success, or -1 if an error occurs (and set
936 *TARGET_ERRNO). */
f6ac5f3d 937 virtual int fileio_fstat (int fd, struct stat *sb, int *target_errno);
9b15c1f0 938
7313baad
UW
939 /* Close FD on the target. Return 0, or -1 if an error occurs
940 (and set *TARGET_ERRNO). */
f6ac5f3d 941 virtual int fileio_close (int fd, int *target_errno);
7313baad 942
07c138c8
GB
943 /* Unlink FILENAME on the target, in the filesystem as seen by
944 INF. If INF is NULL, use the filesystem seen by the debugger
945 (GDB or, for remote targets, the remote stub). Return 0, or
946 -1 if an error occurs (and set *TARGET_ERRNO). */
f6ac5f3d
PA
947 virtual int fileio_unlink (struct inferior *inf,
948 const char *filename,
949 int *target_errno);
07c138c8
GB
950
951 /* Read value of symbolic link FILENAME on the target, in the
952 filesystem as seen by INF. If INF is NULL, use the filesystem
953 seen by the debugger (GDB or, for remote targets, the remote
e0d3522b
TT
954 stub). Return a string, or an empty optional if an error
955 occurs (and set *TARGET_ERRNO). */
f6ac5f3d
PA
956 virtual gdb::optional<std::string> fileio_readlink (struct inferior *inf,
957 const char *filename,
958 int *target_errno);
b9e7b9c3 959
f6ac5f3d
PA
960 /* Implement the "info proc" command. Returns true if the target
961 actually implemented the command, false otherwise. */
962 virtual bool info_proc (const char *, enum info_proc_what);
145b16a9 963
35b1e5cc
SS
964 /* Tracepoint-related operations. */
965
966 /* Prepare the target for a tracing run. */
f6ac5f3d 967 virtual void trace_init ()
5536135b 968 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc 969
e8ba3115 970 /* Send full details of a tracepoint location to the target. */
f6ac5f3d 971 virtual void download_tracepoint (struct bp_location *location)
9a980a22 972 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc 973
1e4d1764
YQ
974 /* Is the target able to download tracepoint locations in current
975 state? */
57810aa7
PA
976 virtual bool can_download_tracepoint ()
977 TARGET_DEFAULT_RETURN (false);
1e4d1764 978
35b1e5cc 979 /* Send full details of a trace state variable to the target. */
f6ac5f3d 980 virtual void download_trace_state_variable (const trace_state_variable &tsv)
94eb98b9 981 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc 982
d248b706 983 /* Enable a tracepoint on the target. */
f6ac5f3d 984 virtual void enable_tracepoint (struct bp_location *location)
151f70f1 985 TARGET_DEFAULT_NORETURN (tcomplain ());
d248b706
KY
986
987 /* Disable a tracepoint on the target. */
f6ac5f3d 988 virtual void disable_tracepoint (struct bp_location *location)
05c41993 989 TARGET_DEFAULT_NORETURN (tcomplain ());
d248b706 990
35b1e5cc
SS
991 /* Inform the target info of memory regions that are readonly
992 (such as text sections), and so it should return data from
993 those rather than look in the trace buffer. */
f6ac5f3d 994 virtual void trace_set_readonly_regions ()
86dd181d 995 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc
SS
996
997 /* Start a trace run. */
f6ac5f3d 998 virtual void trace_start ()
25da2e80 999 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc
SS
1000
1001 /* Get the current status of a tracing run. */
f6ac5f3d 1002 virtual int get_trace_status (struct trace_status *ts)
4072d4ff 1003 TARGET_DEFAULT_RETURN (-1);
35b1e5cc 1004
f6ac5f3d
PA
1005 virtual void get_tracepoint_status (struct breakpoint *tp,
1006 struct uploaded_tp *utp)
6fea14cd 1007 TARGET_DEFAULT_NORETURN (tcomplain ());
f196051f 1008
35b1e5cc 1009 /* Stop a trace run. */
f6ac5f3d 1010 virtual void trace_stop ()
e51c07ea 1011 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc
SS
1012
1013 /* Ask the target to find a trace frame of the given type TYPE,
1014 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
1015 number of the trace frame, and also the tracepoint number at
c378eb4e 1016 TPP. If no trace frame matches, return -1. May throw if the
f197e0f1 1017 operation fails. */
f6ac5f3d
PA
1018 virtual int trace_find (enum trace_find_type type, int num,
1019 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
afc94e66 1020 TARGET_DEFAULT_RETURN (-1);
35b1e5cc
SS
1021
1022 /* Get the value of the trace state variable number TSV, returning
1023 1 if the value is known and writing the value itself into the
1024 location pointed to by VAL, else returning 0. */
57810aa7
PA
1025 virtual bool get_trace_state_variable_value (int tsv, LONGEST *val)
1026 TARGET_DEFAULT_RETURN (false);
35b1e5cc 1027
f6ac5f3d 1028 virtual int save_trace_data (const char *filename)
a2e6c147 1029 TARGET_DEFAULT_NORETURN (tcomplain ());
00bf0b85 1030
f6ac5f3d 1031 virtual int upload_tracepoints (struct uploaded_tp **utpp)
1e949b00 1032 TARGET_DEFAULT_RETURN (0);
00bf0b85 1033
f6ac5f3d 1034 virtual int upload_trace_state_variables (struct uploaded_tsv **utsvp)
08120467 1035 TARGET_DEFAULT_RETURN (0);
00bf0b85 1036
f6ac5f3d
PA
1037 virtual LONGEST get_raw_trace_data (gdb_byte *buf,
1038 ULONGEST offset, LONGEST len)
ace92e7d 1039 TARGET_DEFAULT_NORETURN (tcomplain ());
00bf0b85 1040
405f8e94
SS
1041 /* Get the minimum length of instruction on which a fast tracepoint
1042 may be set on the target. If this operation is unsupported,
1043 return -1. If for some reason the minimum length cannot be
1044 determined, return 0. */
f6ac5f3d 1045 virtual int get_min_fast_tracepoint_insn_len ()
9249843f 1046 TARGET_DEFAULT_RETURN (-1);
405f8e94 1047
35b1e5cc
SS
1048 /* Set the target's tracing behavior in response to unexpected
1049 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
f6ac5f3d 1050 virtual void set_disconnected_tracing (int val)
0bcfeddf 1051 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 1052 virtual void set_circular_trace_buffer (int val)
8d526939 1053 TARGET_DEFAULT_IGNORE ();
f6f899bf 1054 /* Set the size of trace buffer in the target. */
f6ac5f3d 1055 virtual void set_trace_buffer_size (LONGEST val)
91df8d1d 1056 TARGET_DEFAULT_IGNORE ();
35b1e5cc 1057
f196051f
SS
1058 /* Add/change textual notes about the trace run, returning 1 if
1059 successful, 0 otherwise. */
57810aa7
PA
1060 virtual bool set_trace_notes (const char *user, const char *notes,
1061 const char *stopnotes)
1062 TARGET_DEFAULT_RETURN (false);
f196051f 1063
dc146f7c
VP
1064 /* Return the processor core that thread PTID was last seen on.
1065 This information is updated only when:
1066 - update_thread_list is called
1067 - thread stops
3e43a32a
MS
1068 If the core cannot be determined -- either for the specified
1069 thread, or right now, or in this debug session, or for this
1070 target -- return -1. */
f6ac5f3d 1071 virtual int core_of_thread (ptid_t ptid)
9e538d0d 1072 TARGET_DEFAULT_RETURN (-1);
dc146f7c 1073
4a5e7a5b
PA
1074 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
1075 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
1076 a match, 0 if there's a mismatch, and -1 if an error is
1077 encountered while reading memory. */
f6ac5f3d
PA
1078 virtual int verify_memory (const gdb_byte *data,
1079 CORE_ADDR memaddr, ULONGEST size)
936d2992 1080 TARGET_DEFAULT_FUNC (default_verify_memory);
4a5e7a5b 1081
711e434b
PM
1082 /* Return the address of the start of the Thread Information Block
1083 a Windows OS specific feature. */
57810aa7 1084 virtual bool get_tib_address (ptid_t ptid, CORE_ADDR *addr)
22bcceee 1085 TARGET_DEFAULT_NORETURN (tcomplain ());
711e434b 1086
d914c394 1087 /* Send the new settings of write permission variables. */
f6ac5f3d 1088 virtual void set_permissions ()
dcd6917f 1089 TARGET_DEFAULT_IGNORE ();
d914c394 1090
0fb4aa4b 1091 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
5d9310c4 1092 with its details. Return true on success, false on failure. */
f6ac5f3d
PA
1093 virtual bool static_tracepoint_marker_at (CORE_ADDR,
1094 static_tracepoint_marker *marker)
5d9310c4 1095 TARGET_DEFAULT_RETURN (false);
0fb4aa4b
PA
1096
1097 /* Return a vector of all tracepoints markers string id ID, or all
1098 markers if ID is NULL. */
ad6a4e2d
PA
1099 virtual std::vector<static_tracepoint_marker>
1100 static_tracepoint_markers_by_strid (const char *id)
d6522a22 1101 TARGET_DEFAULT_NORETURN (tcomplain ());
0fb4aa4b 1102
b3b9301e 1103 /* Return a traceframe info object describing the current
f73023dd
YQ
1104 traceframe's contents. This method should not cache data;
1105 higher layers take care of caching, invalidating, and
1106 re-fetching when necessary. */
f6ac5f3d 1107 virtual traceframe_info_up traceframe_info ()
2098b393 1108 TARGET_DEFAULT_NORETURN (tcomplain ());
b3b9301e 1109
57810aa7
PA
1110 /* Ask the target to use or not to use agent according to USE.
1111 Return true if successful, false otherwise. */
1112 virtual bool use_agent (bool use)
d9db5b21 1113 TARGET_DEFAULT_NORETURN (tcomplain ());
d1feda86
YQ
1114
1115 /* Is the target able to use agent in current state? */
57810aa7
PA
1116 virtual bool can_use_agent ()
1117 TARGET_DEFAULT_RETURN (false);
d1feda86 1118
f4abbc16
MM
1119 /* Enable branch tracing for PTID using CONF configuration.
1120 Return a branch trace target information struct for reading and for
1121 disabling branch trace. */
f6ac5f3d
PA
1122 virtual struct btrace_target_info *enable_btrace (ptid_t ptid,
1123 const struct btrace_config *conf)
6dc7fcf4 1124 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625
MM
1125
1126 /* Disable branch tracing and deallocate TINFO. */
f6ac5f3d 1127 virtual void disable_btrace (struct btrace_target_info *tinfo)
8dc292d3 1128 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625
MM
1129
1130 /* Disable branch tracing and deallocate TINFO. This function is similar
1131 to to_disable_btrace, except that it is called during teardown and is
1132 only allowed to perform actions that are safe. A counter-example would
1133 be attempting to talk to a remote target. */
f6ac5f3d 1134 virtual void teardown_btrace (struct btrace_target_info *tinfo)
9ace480d 1135 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625 1136
969c39fb 1137 /* Read branch trace data for the thread indicated by BTINFO into DATA.
734b0e4b 1138 DATA is cleared before new trace is added. */
f6ac5f3d
PA
1139 virtual enum btrace_error read_btrace (struct btrace_data *data,
1140 struct btrace_target_info *btinfo,
1141 enum btrace_read_type type)
eb5b20d4 1142 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625 1143
f4abbc16 1144 /* Get the branch trace configuration. */
f6ac5f3d 1145 virtual const struct btrace_config *btrace_conf (const struct btrace_target_info *)
f4abbc16
MM
1146 TARGET_DEFAULT_RETURN (NULL);
1147
b158a20f 1148 /* Current recording method. */
f6ac5f3d 1149 virtual enum record_method record_method (ptid_t ptid)
b158a20f
TW
1150 TARGET_DEFAULT_RETURN (RECORD_METHOD_NONE);
1151
7c1687a9 1152 /* Stop trace recording. */
f6ac5f3d 1153 virtual void stop_recording ()
ee97f592 1154 TARGET_DEFAULT_IGNORE ();
7c1687a9 1155
d02ed0bb 1156 /* Print information about the recording. */
f6ac5f3d 1157 virtual void info_record ()
38e229b2 1158 TARGET_DEFAULT_IGNORE ();
d02ed0bb
MM
1159
1160 /* Save the recorded execution trace into a file. */
f6ac5f3d 1161 virtual void save_record (const char *filename)
f09e2107 1162 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb 1163
252db1b5
TT
1164 /* Delete the recorded execution trace from the current position
1165 onwards. */
f6ac5f3d
PA
1166 virtual bool supports_delete_record ()
1167 TARGET_DEFAULT_RETURN (false);
1168 virtual void delete_record ()
07366925 1169 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb 1170
a52eab48 1171 /* Query if the record target is currently replaying PTID. */
57810aa7
PA
1172 virtual bool record_is_replaying (ptid_t ptid)
1173 TARGET_DEFAULT_RETURN (false);
d02ed0bb 1174
7ff27e9b
MM
1175 /* Query if the record target will replay PTID if it were resumed in
1176 execution direction DIR. */
57810aa7
PA
1177 virtual bool record_will_replay (ptid_t ptid, int dir)
1178 TARGET_DEFAULT_RETURN (false);
7ff27e9b 1179
797094dd 1180 /* Stop replaying. */
f6ac5f3d 1181 virtual void record_stop_replaying ()
797094dd
MM
1182 TARGET_DEFAULT_IGNORE ();
1183
d02ed0bb 1184 /* Go to the begin of the execution trace. */
f6ac5f3d 1185 virtual void goto_record_begin ()
671e76cc 1186 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb
MM
1187
1188 /* Go to the end of the execution trace. */
f6ac5f3d 1189 virtual void goto_record_end ()
e9179bb3 1190 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb
MM
1191
1192 /* Go to a specific location in the recorded execution trace. */
f6ac5f3d 1193 virtual void goto_record (ULONGEST insn)
05969c84 1194 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb 1195
67c86d06
MM
1196 /* Disassemble SIZE instructions in the recorded execution trace from
1197 the current position.
1198 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1199 disassemble SIZE succeeding instructions. */
f6ac5f3d 1200 virtual void insn_history (int size, gdb_disassembly_flags flags)
3679abfa 1201 TARGET_DEFAULT_NORETURN (tcomplain ());
67c86d06
MM
1202
1203 /* Disassemble SIZE instructions in the recorded execution trace around
1204 FROM.
1205 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1206 disassemble SIZE instructions after FROM. */
f6ac5f3d
PA
1207 virtual void insn_history_from (ULONGEST from, int size,
1208 gdb_disassembly_flags flags)
8444ab58 1209 TARGET_DEFAULT_NORETURN (tcomplain ());
67c86d06
MM
1210
1211 /* Disassemble a section of the recorded execution trace from instruction
0688d04e 1212 BEGIN (inclusive) to instruction END (inclusive). */
f6ac5f3d
PA
1213 virtual void insn_history_range (ULONGEST begin, ULONGEST end,
1214 gdb_disassembly_flags flags)
c29302cc 1215 TARGET_DEFAULT_NORETURN (tcomplain ());
67c86d06 1216
15984c13
MM
1217 /* Print a function trace of the recorded execution trace.
1218 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1219 succeeding functions. */
f6ac5f3d 1220 virtual void call_history (int size, record_print_flags flags)
170049d4 1221 TARGET_DEFAULT_NORETURN (tcomplain ());
15984c13
MM
1222
1223 /* Print a function trace of the recorded execution trace starting
1224 at function FROM.
1225 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1226 SIZE functions after FROM. */
f6ac5f3d 1227 virtual void call_history_from (ULONGEST begin, int size, record_print_flags flags)
16fc27d6 1228 TARGET_DEFAULT_NORETURN (tcomplain ());
15984c13
MM
1229
1230 /* Print a function trace of an execution trace section from function BEGIN
0688d04e 1231 (inclusive) to function END (inclusive). */
f6ac5f3d 1232 virtual void call_history_range (ULONGEST begin, ULONGEST end, record_print_flags flags)
115d9817 1233 TARGET_DEFAULT_NORETURN (tcomplain ());
15984c13 1234
57810aa7 1235 /* True if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
ced63ec0 1236 non-empty annex. */
57810aa7
PA
1237 virtual bool augmented_libraries_svr4_read ()
1238 TARGET_DEFAULT_RETURN (false);
ced63ec0 1239
ac01945b
TT
1240 /* Those unwinders are tried before any other arch unwinders. If
1241 SELF doesn't have unwinders, it should delegate to the
1242 "beneath" target. */
f6ac5f3d 1243 virtual const struct frame_unwind *get_unwinder ()
ac01945b
TT
1244 TARGET_DEFAULT_RETURN (NULL);
1245
f6ac5f3d 1246 virtual const struct frame_unwind *get_tailcall_unwinder ()
ac01945b 1247 TARGET_DEFAULT_RETURN (NULL);
ea001bdc 1248
5fff78c4 1249 /* Prepare to generate a core file. */
f6ac5f3d 1250 virtual void prepare_to_generate_core ()
5fff78c4
MM
1251 TARGET_DEFAULT_IGNORE ();
1252
1253 /* Cleanup after generating a core file. */
f6ac5f3d 1254 virtual void done_generating_core ()
5fff78c4 1255 TARGET_DEFAULT_IGNORE ();
768e1fd2
SM
1256
1257 virtual displaced_step_prepare_status displaced_step_prepare (thread_info *thread)
1258 TARGET_DEFAULT_FUNC (default_displaced_step_prepare);
1259
1260 virtual displaced_step_finish_status displaced_step_finish (thread_info *thread, gdb_signal sig)
1261 TARGET_DEFAULT_FUNC (default_displaced_step_finish);
c5aa993b 1262 };
c906108c 1263
15244507
PA
1264/* Deleter for std::unique_ptr. See comments in
1265 target_ops::~target_ops and target_ops::close about heap-allocated
1266 targets. */
1267struct target_ops_deleter
1268{
1269 void operator() (target_ops *target)
1270 {
1271 target->close ();
1272 }
1273};
1274
1275/* A unique pointer for target_ops. */
1276typedef std::unique_ptr<target_ops, target_ops_deleter> target_ops_up;
1277
5b6d1e4f
PA
1278/* Decref a target and close if, if there are no references left. */
1279extern void decref_target (target_ops *t);
1280
1281/* A policy class to interface gdb::ref_ptr with target_ops. */
1282
1283struct target_ops_ref_policy
1284{
1285 static void incref (target_ops *t)
1286 {
1287 t->incref ();
1288 }
1289
1290 static void decref (target_ops *t)
1291 {
1292 decref_target (t);
1293 }
1294};
1295
1296/* A gdb::ref_ptr pointer to a target_ops. */
1297typedef gdb::ref_ptr<target_ops, target_ops_ref_policy> target_ops_ref;
1298
d9f719f1
PA
1299/* Native target backends call this once at initialization time to
1300 inform the core about which is the target that can respond to "run"
1301 or "attach". Note: native targets are always singletons. */
1302extern void set_native_target (target_ops *target);
1303
1304/* Get the registered native target, if there's one. Otherwise return
1305 NULL. */
1306extern target_ops *get_native_target ();
1307
a1740ee1
PA
1308/* Type that manages a target stack. See description of target stacks
1309 and strata at the top of the file. */
1310
1311class target_stack
1312{
1313public:
1314 target_stack () = default;
1315 DISABLE_COPY_AND_ASSIGN (target_stack);
1316
1317 /* Push a new target into the stack of the existing target
1318 accessors, possibly superseding some existing accessor. */
1319 void push (target_ops *t);
1320
1321 /* Remove a target from the stack, wherever it may be. Return true
1322 if it was removed, false otherwise. */
1323 bool unpush (target_ops *t);
1324
1325 /* Returns true if T is pushed on the target stack. */
1326 bool is_pushed (target_ops *t) const
66b4deae 1327 { return at (t->stratum ()) == t; }
a1740ee1
PA
1328
1329 /* Return the target at STRATUM. */
1330 target_ops *at (strata stratum) const { return m_stack[stratum]; }
1331
1332 /* Return the target at the top of the stack. */
1333 target_ops *top () const { return at (m_top); }
1334
1335 /* Find the next target down the stack from the specified target. */
1336 target_ops *find_beneath (const target_ops *t) const;
1337
1338private:
1339 /* The stratum of the top target. */
1340 enum strata m_top {};
1341
1342 /* The stack, represented as an array, with one slot per stratum.
1343 If no target is pushed at some stratum, the corresponding slot is
1344 null. */
1345 target_ops *m_stack[(int) debug_stratum + 1] {};
1346};
1347
c906108c
SS
1348/* The ops structure for our "current" target process. This should
1349 never be NULL. If there is no target, it points to the dummy_target. */
1350
8b88a78e 1351extern target_ops *current_top_target ();
c906108c 1352
5b6d1e4f
PA
1353/* Return the dummy target. */
1354extern target_ops *get_dummy_target ();
1355
c906108c
SS
1356/* Define easy words for doing these operations on our current target. */
1357
8b88a78e
PA
1358#define target_shortname (current_top_target ()->shortname ())
1359#define target_longname (current_top_target ()->longname ())
c906108c 1360
f1c07ab0 1361/* Does whatever cleanup is required for a target that we are no
460014f5
JK
1362 longer going to be calling. This routine is automatically always
1363 called after popping the target off the target stack - the target's
1364 own methods are no longer available through the target vector.
1365 Closing file descriptors and freeing all memory allocated memory are
1366 typical things it should do. */
f1c07ab0 1367
460014f5 1368void target_close (struct target_ops *targ);
c906108c 1369
b3ccfe11
TT
1370/* Find the correct target to use for "attach". If a target on the
1371 current stack supports attaching, then it is returned. Otherwise,
1372 the default run target is returned. */
1373
1374extern struct target_ops *find_attach_target (void);
c906108c 1375
b3ccfe11
TT
1376/* Find the correct target to use for "run". If a target on the
1377 current stack supports creating a new inferior, then it is
1378 returned. Otherwise, the default run target is returned. */
1379
1380extern struct target_ops *find_run_target (void);
c906108c 1381
dc177b7a
PA
1382/* Some targets don't generate traps when attaching to the inferior,
1383 or their target_attach implementation takes care of the waiting.
1384 These targets must set to_attach_no_wait. */
1385
f6ac5f3d 1386#define target_attach_no_wait() \
8b88a78e 1387 (current_top_target ()->attach_no_wait ())
dc177b7a 1388
c906108c
SS
1389/* The target_attach operation places a process under debugger control,
1390 and stops the process.
1391
1392 This operation provides a target-specific hook that allows the
0d06e24b 1393 necessary bookkeeping to be performed after an attach completes. */
c906108c 1394#define target_post_attach(pid) \
8b88a78e 1395 (current_top_target ()->post_attach) (pid)
c906108c 1396
0f48b757
PA
1397/* Display a message indicating we're about to detach from the current
1398 inferior process. */
1399
1400extern void target_announce_detach (int from_tty);
1401
c906108c
SS
1402/* Takes a program previously attached to and detaches it.
1403 The program may resume execution (some targets do, some don't) and will
1404 no longer stop on signals, etc. We better not have left any breakpoints
6bd6f3b6
SM
1405 in the program or it'll die when it hits one. FROM_TTY says whether to be
1406 verbose or not. */
c906108c 1407
6e1e1966 1408extern void target_detach (inferior *inf, int from_tty);
c906108c 1409
6ad8ae5c
DJ
1410/* Disconnect from the current target without resuming it (leaving it
1411 waiting for a debugger). */
1412
fee354ee 1413extern void target_disconnect (const char *, int);
6ad8ae5c 1414
85ad3aaf
PA
1415/* Resume execution (or prepare for execution) of a target thread,
1416 process or all processes. STEP says whether to hardware
1417 single-step or to run free; SIGGNAL is the signal to be given to
1418 the target, or GDB_SIGNAL_0 for no signal. The caller may not pass
1419 GDB_SIGNAL_DEFAULT. A specific PTID means `step/resume only this
1420 process id'. A wildcard PTID (all threads, or all threads of
1421 process) means `step/resume INFERIOR_PTID, and let other threads
1422 (for which the wildcard PTID matches) resume with their
1423 'thread->suspend.stop_signal' signal (usually GDB_SIGNAL_0) if it
1424 is in "pass" state, or with no signal if in "no pass" state.
1425
1426 In order to efficiently handle batches of resumption requests,
1427 targets may implement this method such that it records the
1428 resumption request, but defers the actual resumption to the
1429 target_commit_resume method implementation. See
1430 target_commit_resume below. */
2ea28649 1431extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
c906108c 1432
85ad3aaf
PA
1433/* Commit a series of resumption requests previously prepared with
1434 target_resume calls.
1435
1436 GDB always calls target_commit_resume after calling target_resume
1437 one or more times. A target may thus use this method in
1438 coordination with the target_resume method to batch target-side
1439 resumption requests. In that case, the target doesn't actually
1440 resume in its target_resume implementation. Instead, it prepares
1441 the resumption in target_resume, and defers the actual resumption
1442 to target_commit_resume. E.g., the remote target uses this to
1443 coalesce multiple resumption requests in a single vCont packet. */
1444extern void target_commit_resume ();
1445
a9bc57b9
TT
1446/* Setup to defer target_commit_resume calls, and reactivate
1447 target_commit_resume on destruction, if it was previously
85ad3aaf 1448 active. */
a9bc57b9 1449extern scoped_restore_tmpl<int> make_scoped_defer_target_commit_resume ();
85ad3aaf 1450
f2b9e3df 1451/* For target_read_memory see target/target.h. */
c906108c 1452
0b333c5e
PA
1453/* The default target_ops::to_wait implementation. */
1454
1455extern ptid_t default_target_wait (struct target_ops *ops,
1456 ptid_t ptid,
1457 struct target_waitstatus *status,
1458 int options);
1459
17dee195 1460/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c 1461
28439f5e 1462extern void target_fetch_registers (struct regcache *regcache, int regno);
c906108c
SS
1463
1464/* Store at least register REGNO, or all regs if REGNO == -1.
1465 It can store as many registers as it wants to, so target_prepare_to_store
1466 must have been previously called. Calls error() if there are problems. */
1467
28439f5e 1468extern void target_store_registers (struct regcache *regcache, int regs);
c906108c
SS
1469
1470/* Get ready to modify the registers array. On machines which store
1471 individual registers, this doesn't need to do anything. On machines
1472 which store all the registers in one fell swoop, this makes sure
1473 that REGISTERS contains all the registers from the program being
1474 debugged. */
1475
316f2060 1476#define target_prepare_to_store(regcache) \
8b88a78e 1477 (current_top_target ()->prepare_to_store) (regcache)
c906108c 1478
6c95b8df
PA
1479/* Determine current address space of thread PTID. */
1480
1481struct address_space *target_thread_address_space (ptid_t);
1482
451b7c33
TT
1483/* Implement the "info proc" command. This returns one if the request
1484 was handled, and zero otherwise. It can also throw an exception if
1485 an error was encountered while attempting to handle the
1486 request. */
145b16a9 1487
7bc112c1 1488int target_info_proc (const char *, enum info_proc_what);
145b16a9 1489
03583c20
UW
1490/* Returns true if this target can disable address space randomization. */
1491
1492int target_supports_disable_randomization (void);
1493
d248b706
KY
1494/* Returns true if this target can enable and disable tracepoints
1495 while a trace experiment is running. */
1496
1497#define target_supports_enable_disable_tracepoint() \
8b88a78e 1498 (current_top_target ()->supports_enable_disable_tracepoint) ()
d248b706 1499
3065dfb6 1500#define target_supports_string_tracing() \
8b88a78e 1501 (current_top_target ()->supports_string_tracing) ()
3065dfb6 1502
b775012e
LM
1503/* Returns true if this target can handle breakpoint conditions
1504 on its end. */
1505
1506#define target_supports_evaluation_of_breakpoint_conditions() \
8b88a78e 1507 (current_top_target ()->supports_evaluation_of_breakpoint_conditions) ()
b775012e 1508
d3ce09f5
SS
1509/* Returns true if this target can handle breakpoint commands
1510 on its end. */
1511
1512#define target_can_run_breakpoint_commands() \
8b88a78e 1513 (current_top_target ()->can_run_breakpoint_commands) ()
d3ce09f5 1514
66920317
TT
1515/* Read a string from target memory at address MEMADDR. The string
1516 will be at most LEN bytes long (note that excess bytes may be read
1517 in some cases -- but these will not be returned). Returns nullptr
1518 on error. */
1519
1520extern gdb::unique_xmalloc_ptr<char> target_read_string
1521 (CORE_ADDR memaddr, int len, int *bytes_read = nullptr);
c906108c 1522
721ec300 1523/* For target_read_memory see target/target.h. */
c906108c 1524
aee4bf85
PA
1525extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1526 ssize_t len);
1527
45aa4659 1528extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
4e5d721f 1529
29453a14
YQ
1530extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1531
721ec300 1532/* For target_write_memory see target/target.h. */
c906108c 1533
f0ba3972 1534extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1535 ssize_t len);
f0ba3972 1536
fd79ecee
DJ
1537/* Fetches the target's memory map. If one is found it is sorted
1538 and returned, after some consistency checking. Otherwise, NULL
1539 is returned. */
a664f67e 1540std::vector<mem_region> target_memory_map (void);
fd79ecee 1541
78cbbba8 1542/* Erases all flash memory regions on the target. */
0b39b52e 1543void flash_erase_command (const char *cmd, int from_tty);
78cbbba8 1544
a76d924d
DJ
1545/* Erase the specified flash region. */
1546void target_flash_erase (ULONGEST address, LONGEST length);
1547
1548/* Finish a sequence of flash operations. */
1549void target_flash_done (void);
1550
1551/* Describes a request for a memory write operation. */
1552struct memory_write_request
55089490
TT
1553{
1554 memory_write_request (ULONGEST begin_, ULONGEST end_,
1555 gdb_byte *data_ = nullptr, void *baton_ = nullptr)
1556 : begin (begin_), end (end_), data (data_), baton (baton_)
1557 {}
1558
1559 /* Begining address that must be written. */
1560 ULONGEST begin;
1561 /* Past-the-end address. */
1562 ULONGEST end;
1563 /* The data to write. */
1564 gdb_byte *data;
1565 /* A callback baton for progress reporting for this request. */
1566 void *baton;
1567};
a76d924d
DJ
1568
1569/* Enumeration specifying different flash preservation behaviour. */
1570enum flash_preserve_mode
1571 {
1572 flash_preserve,
1573 flash_discard
1574 };
1575
1576/* Write several memory blocks at once. This version can be more
1577 efficient than making several calls to target_write_memory, in
1578 particular because it can optimize accesses to flash memory.
1579
1580 Moreover, this is currently the only memory access function in gdb
1581 that supports writing to flash memory, and it should be used for
1582 all cases where access to flash memory is desirable.
1583
791b7405 1584 REQUESTS is the vector of memory_write_request.
a76d924d
DJ
1585 PRESERVE_FLASH_P indicates what to do with blocks which must be
1586 erased, but not completely rewritten.
1587 PROGRESS_CB is a function that will be periodically called to provide
1588 feedback to user. It will be called with the baton corresponding
1589 to the request currently being written. It may also be called
1590 with a NULL baton, when preserved flash sectors are being rewritten.
1591
1592 The function returns 0 on success, and error otherwise. */
55089490
TT
1593int target_write_memory_blocks
1594 (const std::vector<memory_write_request> &requests,
1595 enum flash_preserve_mode preserve_flash_p,
1596 void (*progress_cb) (ULONGEST, void *));
a76d924d 1597
c906108c
SS
1598/* Print a line about the current target. */
1599
1600#define target_files_info() \
8b88a78e 1601 (current_top_target ()->files_info) ()
c906108c 1602
7d03f2eb 1603/* Insert a breakpoint at address BP_TGT->placed_address in
0000e5cc
PA
1604 the target machine. Returns 0 for success, and returns non-zero or
1605 throws an error (with a detailed failure reason error code and
1606 message) otherwise. */
c906108c 1607
d914c394
SS
1608extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1609 struct bp_target_info *bp_tgt);
c906108c 1610
8181d85f 1611/* Remove a breakpoint at address BP_TGT->placed_address in the target
578d3588 1612 machine. Result is 0 for success, non-zero for error. */
c906108c 1613
d914c394 1614extern int target_remove_breakpoint (struct gdbarch *gdbarch,
73971819
PA
1615 struct bp_target_info *bp_tgt,
1616 enum remove_bp_reason reason);
c906108c 1617
b0ed115f 1618/* Return true if the target stack has a non-default
f6ac5f3d 1619 "terminal_ours" method. */
b0ed115f 1620
20f0d60d 1621extern bool target_supports_terminal_ours (void);
b0ed115f 1622
c906108c
SS
1623/* Kill the inferior process. Make it go away. */
1624
7d85a9c0 1625extern void target_kill (void);
c906108c 1626
0d06e24b
JM
1627/* Load an executable file into the target process. This is expected
1628 to not only bring new code into the target process, but also to
1986bccd
AS
1629 update GDB's symbol tables to match.
1630
1631 ARG contains command-line arguments, to be broken down with
1632 buildargv (). The first non-switch argument is the filename to
1633 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1634 0)), which is an offset to apply to the load addresses of FILE's
1635 sections. The target may define switches, or other non-switch
1636 arguments, as it pleases. */
c906108c 1637
9cbe5fff 1638extern void target_load (const char *arg, int from_tty);
c906108c 1639
c906108c
SS
1640/* Some targets (such as ttrace-based HPUX) don't allow us to request
1641 notification of inferior events such as fork and vork immediately
1642 after the inferior is created. (This because of how gdb gets an
1643 inferior created via invoking a shell to do it. In such a scenario,
1644 if the shell init file has commands in it, the shell will fork and
1645 exec for each of those commands, and we will see each such fork
1646 event. Very bad.)
c5aa993b 1647
0d06e24b
JM
1648 Such targets will supply an appropriate definition for this function. */
1649
39f77062 1650#define target_post_startup_inferior(ptid) \
8b88a78e 1651 (current_top_target ()->post_startup_inferior) (ptid)
c906108c 1652
0d06e24b
JM
1653/* On some targets, we can catch an inferior fork or vfork event when
1654 it occurs. These functions insert/remove an already-created
77b06cd7
TJB
1655 catchpoint for such events. They return 0 for success, 1 if the
1656 catchpoint type is not supported and -1 for failure. */
c906108c 1657
c906108c 1658#define target_insert_fork_catchpoint(pid) \
8b88a78e 1659 (current_top_target ()->insert_fork_catchpoint) (pid)
c906108c
SS
1660
1661#define target_remove_fork_catchpoint(pid) \
8b88a78e 1662 (current_top_target ()->remove_fork_catchpoint) (pid)
c906108c
SS
1663
1664#define target_insert_vfork_catchpoint(pid) \
8b88a78e 1665 (current_top_target ()->insert_vfork_catchpoint) (pid)
c906108c
SS
1666
1667#define target_remove_vfork_catchpoint(pid) \
8b88a78e 1668 (current_top_target ()->remove_vfork_catchpoint) (pid)
c906108c 1669
6604731b
DJ
1670/* If the inferior forks or vforks, this function will be called at
1671 the next resume in order to perform any bookkeeping and fiddling
1672 necessary to continue debugging either the parent or child, as
1673 requested, and releasing the other. Information about the fork
1674 or vfork event is available via get_last_target_status ().
5ab2fbf1 1675 This function returns true if the inferior should not be resumed
6604731b 1676 (i.e. there is another event pending). */
0d06e24b 1677
5ab2fbf1 1678bool target_follow_fork (bool follow_child, bool detach_fork);
c906108c 1679
94585166
DB
1680/* Handle the target-specific bookkeeping required when the inferior
1681 makes an exec call. INF is the exec'd inferior. */
1682
4ca51187 1683void target_follow_exec (struct inferior *inf, const char *execd_pathname);
94585166 1684
c906108c 1685/* On some targets, we can catch an inferior exec event when it
0d06e24b 1686 occurs. These functions insert/remove an already-created
77b06cd7
TJB
1687 catchpoint for such events. They return 0 for success, 1 if the
1688 catchpoint type is not supported and -1 for failure. */
0d06e24b 1689
c906108c 1690#define target_insert_exec_catchpoint(pid) \
8b88a78e 1691 (current_top_target ()->insert_exec_catchpoint) (pid)
c5aa993b 1692
c906108c 1693#define target_remove_exec_catchpoint(pid) \
8b88a78e 1694 (current_top_target ()->remove_exec_catchpoint) (pid)
c906108c 1695
a96d9b2e
SDJ
1696/* Syscall catch.
1697
649a140c
PA
1698 NEEDED is true if any syscall catch (of any kind) is requested.
1699 If NEEDED is false, it means the target can disable the mechanism to
a96d9b2e
SDJ
1700 catch system calls because there are no more catchpoints of this type.
1701
1702 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
649a140c 1703 being requested. In this case, SYSCALL_COUNTS should be ignored.
a96d9b2e 1704
649a140c
PA
1705 SYSCALL_COUNTS is an array of ints, indexed by syscall number. An
1706 element in this array is nonzero if that syscall should be caught.
1707 This argument only matters if ANY_COUNT is zero.
77b06cd7
TJB
1708
1709 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1710 for failure. */
a96d9b2e 1711
649a140c 1712#define target_set_syscall_catchpoint(pid, needed, any_count, syscall_counts) \
8b88a78e 1713 (current_top_target ()->set_syscall_catchpoint) (pid, needed, any_count, \
f6ac5f3d 1714 syscall_counts)
a96d9b2e 1715
c906108c 1716/* The debugger has completed a blocking wait() call. There is now
2146d243 1717 some process event that must be processed. This function should
c906108c 1718 be defined by those targets that require the debugger to perform
0d06e24b 1719 cleanup or internal state changes in response to the process event. */
c906108c 1720
bc1e6c81 1721/* For target_mourn_inferior see target/target.h. */
c906108c 1722
f6ac5f3d 1723/* Does target have enough data to do a run or attach command? */
c906108c 1724
f6ac5f3d 1725extern int target_can_run ();
c906108c 1726
2455069d
UW
1727/* Set list of signals to be handled in the target.
1728
adc6a863 1729 PASS_SIGNALS is an array indexed by target signal number
2ea28649 1730 (enum gdb_signal). For every signal whose entry in this array is
2455069d
UW
1731 non-zero, the target is allowed -but not required- to skip reporting
1732 arrival of the signal to the GDB core by returning from target_wait,
1733 and to pass the signal directly to the inferior instead.
1734
1735 However, if the target is hardware single-stepping a thread that is
1736 about to receive a signal, it needs to be reported in any case, even
1737 if mentioned in a previous target_pass_signals call. */
c906108c 1738
adc6a863
PA
1739extern void target_pass_signals
1740 (gdb::array_view<const unsigned char> pass_signals);
c906108c 1741
9b224c5e
PA
1742/* Set list of signals the target may pass to the inferior. This
1743 directly maps to the "handle SIGNAL pass/nopass" setting.
1744
adc6a863 1745 PROGRAM_SIGNALS is an array indexed by target signal
2ea28649 1746 number (enum gdb_signal). For every signal whose entry in this
9b224c5e
PA
1747 array is non-zero, the target is allowed to pass the signal to the
1748 inferior. Signals not present in the array shall be silently
1749 discarded. This does not influence whether to pass signals to the
1750 inferior as a result of a target_resume call. This is useful in
1751 scenarios where the target needs to decide whether to pass or not a
1752 signal to the inferior without GDB core involvement, such as for
1753 example, when detaching (as threads may have been suspended with
1754 pending signals not reported to GDB). */
1755
adc6a863
PA
1756extern void target_program_signals
1757 (gdb::array_view<const unsigned char> program_signals);
9b224c5e 1758
c906108c
SS
1759/* Check to see if a thread is still alive. */
1760
28439f5e 1761extern int target_thread_alive (ptid_t ptid);
c906108c 1762
e8032dde 1763/* Sync the target's threads with GDB's thread list. */
b83266a0 1764
e8032dde 1765extern void target_update_thread_list (void);
b83266a0 1766
0d06e24b 1767/* Make target stop in a continuable fashion. (For instance, under
9a6cf368
GB
1768 Unix, this should act like SIGSTOP). Note that this function is
1769 asynchronous: it does not wait for the target to become stopped
1770 before returning. If this is the behavior you want please use
1771 target_stop_and_wait. */
c906108c 1772
d914c394 1773extern void target_stop (ptid_t ptid);
c906108c 1774
e671cd59
PA
1775/* Interrupt the target. Unlike target_stop, this does not specify
1776 which thread/process reports the stop. For most target this acts
1777 like raising a SIGINT, though that's not absolutely required. This
1778 function is asynchronous. */
bfedc46a 1779
e671cd59 1780extern void target_interrupt ();
bfedc46a 1781
93692b58 1782/* Pass a ^C, as determined to have been pressed by checking the quit
e671cd59
PA
1783 flag, to the target, as if the user had typed the ^C on the
1784 inferior's controlling terminal while the inferior was in the
1785 foreground. Remote targets may take the opportunity to detect the
1786 remote side is not responding and offer to disconnect. */
93692b58
PA
1787
1788extern void target_pass_ctrlc (void);
1789
1790/* The default target_ops::to_pass_ctrlc implementation. Simply calls
1791 target_interrupt. */
1792extern void default_target_pass_ctrlc (struct target_ops *ops);
1793
96baa820
JM
1794/* Send the specified COMMAND to the target's monitor
1795 (shell,interpreter) for execution. The result of the query is
0d06e24b 1796 placed in OUTBUF. */
96baa820
JM
1797
1798#define target_rcmd(command, outbuf) \
8b88a78e 1799 (current_top_target ()->rcmd) (command, outbuf)
96baa820
JM
1800
1801
c906108c
SS
1802/* Does the target include all of memory, or only part of it? This
1803 determines whether we look up the target chain for other parts of
1804 memory if this target can't satisfy a request. */
1805
c35b1492
PA
1806extern int target_has_all_memory_1 (void);
1807#define target_has_all_memory target_has_all_memory_1 ()
c906108c
SS
1808
1809/* Does the target include memory? (Dummy targets don't.) */
1810
c35b1492
PA
1811extern int target_has_memory_1 (void);
1812#define target_has_memory target_has_memory_1 ()
c906108c
SS
1813
1814/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1815 we start a process.) */
c5aa993b 1816
c35b1492
PA
1817extern int target_has_stack_1 (void);
1818#define target_has_stack target_has_stack_1 ()
c906108c
SS
1819
1820/* Does the target have registers? (Exec files don't.) */
1821
c35b1492
PA
1822extern int target_has_registers_1 (void);
1823#define target_has_registers target_has_registers_1 ()
c906108c
SS
1824
1825/* Does the target have execution? Can we make it jump (through
52bb452f
DJ
1826 hoops), or pop its stack a few times? This means that the current
1827 target is currently executing; for some targets, that's the same as
1828 whether or not the target is capable of execution, but there are
1829 also targets which can be current while not executing. In that
b3ccfe11
TT
1830 case this will become true after to_create_inferior or
1831 to_attach. */
c906108c 1832
5018ce90 1833extern bool target_has_execution_1 (inferior *inf);
aeaec162 1834
5018ce90
PA
1835/* Like target_has_execution_1, but always passes
1836 current_inferior(). */
aeaec162
TT
1837
1838extern int target_has_execution_current (void);
1839
1840#define target_has_execution target_has_execution_current ()
c35b1492 1841
c906108c 1842/* Can the target support the debugger control of thread execution?
d6350901 1843 Can it lock the thread scheduler? */
c906108c
SS
1844
1845#define target_can_lock_scheduler \
8b88a78e 1846 (current_top_target ()->get_thread_control_capabilities () & tc_schedlock)
c906108c 1847
329ea579 1848/* Controls whether async mode is permitted. */
491144b5 1849extern bool target_async_permitted;
c6ebd6cf 1850
c378eb4e 1851/* Can the target support asynchronous execution? */
8b88a78e 1852#define target_can_async_p() (current_top_target ()->can_async_p ())
6426a772 1853
c378eb4e 1854/* Is the target in asynchronous execution mode? */
8b88a78e 1855#define target_is_async_p() (current_top_target ()->is_async_p ())
6426a772 1856
6a3753b3 1857/* Enables/disabled async target events. */
372316f1 1858extern void target_async (int enable);
43ff13b4 1859
65706a29
PA
1860/* Enables/disables thread create and exit events. */
1861extern void target_thread_events (int enable);
1862
fbea99ea
PA
1863/* Whether support for controlling the target backends always in
1864 non-stop mode is enabled. */
1865extern enum auto_boolean target_non_stop_enabled;
1866
1867/* Is the target in non-stop mode? Some targets control the inferior
1868 in non-stop mode even with "set non-stop off". Always true if "set
1869 non-stop" is on. */
1870extern int target_is_non_stop_p (void);
1871
a0714d30
TBA
1872/* Return true if at least one inferior has a non-stop target. */
1873extern bool exists_non_stop_target ();
1874
32231432 1875#define target_execution_direction() \
8b88a78e 1876 (current_top_target ()->execution_direction ())
32231432 1877
c906108c
SS
1878/* Converts a process id to a string. Usually, the string just contains
1879 `process xyz', but on some systems it may contain
1880 `process xyz thread abc'. */
1881
a068643d 1882extern std::string target_pid_to_str (ptid_t ptid);
c906108c 1883
a068643d 1884extern std::string normal_pid_to_str (ptid_t ptid);
c5aa993b 1885
0d06e24b
JM
1886/* Return a short string describing extra information about PID,
1887 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1888 is okay. */
1889
1890#define target_extra_thread_info(TP) \
8b88a78e 1891 (current_top_target ()->extra_thread_info (TP))
ed9a39eb 1892
79efa585
SM
1893/* Return the thread's name, or NULL if the target is unable to determine it.
1894 The returned value must not be freed by the caller. */
4694da01 1895
73ede765 1896extern const char *target_thread_name (struct thread_info *);
4694da01 1897
e04ee09e
KB
1898/* Given a pointer to a thread library specific thread handle and
1899 its length, return a pointer to the corresponding thread_info struct. */
1900
1901extern struct thread_info *target_thread_handle_to_thread_info
1902 (const gdb_byte *thread_handle, int handle_len, struct inferior *inf);
1903
3d6c6204
KB
1904/* Given a thread, return the thread handle, a target-specific sequence of
1905 bytes which serves as a thread identifier within the program being
1906 debugged. */
1907extern gdb::byte_vector target_thread_info_to_thread_handle
1908 (struct thread_info *);
1909
c906108c
SS
1910/* Attempts to find the pathname of the executable file
1911 that was run to create a specified process.
1912
1913 The process PID must be stopped when this operation is used.
c5aa993b 1914
c906108c
SS
1915 If the executable file cannot be determined, NULL is returned.
1916
1917 Else, a pointer to a character string containing the pathname
1918 is returned. This string should be copied into a buffer by
1919 the client if the string will not be immediately used, or if
0d06e24b 1920 it must persist. */
c906108c
SS
1921
1922#define target_pid_to_exec_file(pid) \
8b88a78e 1923 (current_top_target ()->pid_to_exec_file) (pid)
c906108c 1924
3a8f7b07 1925/* See the to_thread_architecture description in struct target_ops. */
c2250ad1
UW
1926
1927#define target_thread_architecture(ptid) \
8b88a78e 1928 (current_top_target ()->thread_architecture (ptid))
c2250ad1 1929
be4d1333
MS
1930/*
1931 * Iterator function for target memory regions.
1932 * Calls a callback function once for each memory region 'mapped'
1933 * in the child process. Defined as a simple macro rather than
2146d243 1934 * as a function macro so that it can be tested for nullity.
be4d1333
MS
1935 */
1936
1937#define target_find_memory_regions(FUNC, DATA) \
8b88a78e 1938 (current_top_target ()->find_memory_regions) (FUNC, DATA)
be4d1333
MS
1939
1940/*
1941 * Compose corefile .note section.
1942 */
1943
1944#define target_make_corefile_notes(BFD, SIZE_P) \
8b88a78e 1945 (current_top_target ()->make_corefile_notes) (BFD, SIZE_P)
be4d1333 1946
6b04bdb7
MS
1947/* Bookmark interfaces. */
1948#define target_get_bookmark(ARGS, FROM_TTY) \
8b88a78e 1949 (current_top_target ()->get_bookmark) (ARGS, FROM_TTY)
6b04bdb7
MS
1950
1951#define target_goto_bookmark(ARG, FROM_TTY) \
8b88a78e 1952 (current_top_target ()->goto_bookmark) (ARG, FROM_TTY)
6b04bdb7 1953
c906108c
SS
1954/* Hardware watchpoint interfaces. */
1955
7ea65f08
PA
1956/* GDB's current model is that there are three "kinds" of watchpoints,
1957 with respect to when they trigger and how you can move past them.
1958
1959 Those are: continuable, steppable, and non-steppable.
1960
1961 Continuable watchpoints are like x86's -- those trigger after the
1962 memory access's side effects are fully committed to memory. I.e.,
1963 they trap with the PC pointing at the next instruction already.
1964 Continuing past such a watchpoint is doable by just normally
1965 continuing, hence the name.
1966
1967 Both steppable and non-steppable watchpoints trap before the memory
1968 access. I.e, the PC points at the instruction that is accessing
1969 the memory. So GDB needs to single-step once past the current
1970 instruction in order to make the access effective and check whether
1971 the instruction's side effects change the watched expression.
1972
1973 Now, in order to step past that instruction, depending on
1974 architecture and target, you can have two situations:
1975
1976 - steppable watchpoints: you can single-step with the watchpoint
1977 still armed, and the watchpoint won't trigger again.
1978
1979 - non-steppable watchpoints: if you try to single-step with the
1980 watchpoint still armed, you'd trap the watchpoint again and the
1981 thread wouldn't make any progress. So GDB needs to temporarily
1982 remove the watchpoint in order to step past it.
1983
1984 If your target/architecture does not signal that it has either
1985 steppable or non-steppable watchpoints via either
1986 target_have_steppable_watchpoint or
1987 gdbarch_have_nonsteppable_watchpoint, GDB assumes continuable
1988 watchpoints. */
1989
c906108c 1990/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
7f82dfc7 1991 write). Only the INFERIOR_PTID task is being queried. */
c906108c 1992
6a109b6b 1993#define target_stopped_by_watchpoint() \
8b88a78e 1994 ((current_top_target ()->stopped_by_watchpoint) ())
7df1a324 1995
1cf4d951
PA
1996/* Returns non-zero if the target stopped because it executed a
1997 software breakpoint instruction. */
1998
1999#define target_stopped_by_sw_breakpoint() \
8b88a78e 2000 ((current_top_target ()->stopped_by_sw_breakpoint) ())
1cf4d951
PA
2001
2002#define target_supports_stopped_by_sw_breakpoint() \
8b88a78e 2003 ((current_top_target ()->supports_stopped_by_sw_breakpoint) ())
1cf4d951
PA
2004
2005#define target_stopped_by_hw_breakpoint() \
8b88a78e 2006 ((current_top_target ()->stopped_by_hw_breakpoint) ())
1cf4d951
PA
2007
2008#define target_supports_stopped_by_hw_breakpoint() \
8b88a78e 2009 ((current_top_target ()->supports_stopped_by_hw_breakpoint) ())
1cf4d951 2010
74174d2e
UW
2011/* Non-zero if we have steppable watchpoints */
2012
d92524f1 2013#define target_have_steppable_watchpoint \
8b88a78e 2014 (current_top_target ()->have_steppable_watchpoint ())
74174d2e 2015
ccaa32c7 2016/* Provide defaults for hardware watchpoint functions. */
c906108c 2017
2146d243 2018/* If the *_hw_beakpoint functions have not been defined
ccaa32c7 2019 elsewhere use the definitions in the target vector. */
c906108c 2020
059790a0
YQ
2021/* Returns positive if we can set a hardware watchpoint of type TYPE.
2022 Returns negative if the target doesn't have enough hardware debug
2023 registers available. Return zero if hardware watchpoint of type
2024 TYPE isn't supported. TYPE is one of bp_hardware_watchpoint,
2025 bp_read_watchpoint, bp_write_watchpoint, or bp_hardware_breakpoint.
2026 CNT is the number of such watchpoints used so far, including this
2343b78a
JM
2027 one. OTHERTYPE is the number of watchpoints of other types than
2028 this one used so far. */
c906108c 2029
d92524f1 2030#define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
8b88a78e 2031 (current_top_target ()->can_use_hw_breakpoint) ( \
059790a0 2032 TYPE, CNT, OTHERTYPE)
c906108c 2033
e09342b5
TJB
2034/* Returns the number of debug registers needed to watch the given
2035 memory region, or zero if not supported. */
2036
d92524f1 2037#define target_region_ok_for_hw_watchpoint(addr, len) \
8b88a78e 2038 (current_top_target ()->region_ok_for_hw_watchpoint) (addr, len)
e0d24f8d 2039
c906108c 2040
750ce8d1 2041#define target_can_do_single_step() \
8b88a78e 2042 (current_top_target ()->can_do_single_step) ()
750ce8d1 2043
85d721b8
PA
2044/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
2045 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
0cf6dd15 2046 COND is the expression for its condition, or NULL if there's none.
85d721b8
PA
2047 Returns 0 for success, 1 if the watchpoint type is not supported,
2048 -1 for failure. */
c906108c 2049
0cf6dd15 2050#define target_insert_watchpoint(addr, len, type, cond) \
8b88a78e 2051 (current_top_target ()->insert_watchpoint) (addr, len, type, cond)
c906108c 2052
0cf6dd15 2053#define target_remove_watchpoint(addr, len, type, cond) \
8b88a78e 2054 (current_top_target ()->remove_watchpoint) (addr, len, type, cond)
c906108c 2055
9c06b0b4
TJB
2056/* Insert a new masked watchpoint at ADDR using the mask MASK.
2057 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
2058 or hw_access for an access watchpoint. Returns 0 for success, 1 if
2059 masked watchpoints are not supported, -1 for failure. */
2060
f4b0a671
SM
2061extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR,
2062 enum target_hw_bp_type);
9c06b0b4
TJB
2063
2064/* Remove a masked watchpoint at ADDR with the mask MASK.
2065 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
2066 or hw_access for an access watchpoint. Returns 0 for success, non-zero
2067 for failure. */
2068
f4b0a671
SM
2069extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR,
2070 enum target_hw_bp_type);
9c06b0b4 2071
0000e5cc
PA
2072/* Insert a hardware breakpoint at address BP_TGT->placed_address in
2073 the target machine. Returns 0 for success, and returns non-zero or
2074 throws an error (with a detailed failure reason error code and
2075 message) otherwise. */
2076
a6d9a66e 2077#define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
8b88a78e 2078 (current_top_target ()->insert_hw_breakpoint) (gdbarch, bp_tgt)
ccaa32c7 2079
a6d9a66e 2080#define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
8b88a78e 2081 (current_top_target ()->remove_hw_breakpoint) (gdbarch, bp_tgt)
c906108c 2082
f1310107
TJB
2083/* Return number of debug registers needed for a ranged breakpoint,
2084 or -1 if ranged breakpoints are not supported. */
2085
2086extern int target_ranged_break_num_registers (void);
2087
7f82dfc7
JK
2088/* Return non-zero if target knows the data address which triggered this
2089 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
2090 INFERIOR_PTID task is being queried. */
2091#define target_stopped_data_address(target, addr_p) \
f6ac5f3d 2092 (target)->stopped_data_address (addr_p)
c906108c 2093
9b3e86b1
MR
2094/* Return non-zero if ADDR is within the range of a watchpoint spanning
2095 LENGTH bytes beginning at START. */
5009afc5 2096#define target_watchpoint_addr_within_range(target, addr, start, length) \
f6ac5f3d 2097 (target)->watchpoint_addr_within_range (addr, start, length)
5009afc5 2098
0cf6dd15
TJB
2099/* Return non-zero if the target is capable of using hardware to evaluate
2100 the condition expression. In this case, if the condition is false when
2101 the watched memory location changes, execution may continue without the
2102 debugger being notified.
2103
2104 Due to limitations in the hardware implementation, it may be capable of
2105 avoiding triggering the watchpoint in some cases where the condition
2106 expression is false, but may report some false positives as well.
2107 For this reason, GDB will still evaluate the condition expression when
2108 the watchpoint triggers. */
2109#define target_can_accel_watchpoint_condition(addr, len, type, cond) \
8b88a78e 2110 (current_top_target ()->can_accel_watchpoint_condition) (addr, len, type, cond)
0cf6dd15 2111
9c06b0b4
TJB
2112/* Return number of debug registers needed for a masked watchpoint,
2113 -1 if masked watchpoints are not supported or -2 if the given address
2114 and mask combination cannot be used. */
2115
2116extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
2117
b2175913
MS
2118/* Target can execute in reverse? */
2119#define target_can_execute_reverse \
8b88a78e 2120 current_top_target ()->can_execute_reverse ()
b2175913 2121
424163ea
DJ
2122extern const struct target_desc *target_read_description (struct target_ops *);
2123
0ef643c8 2124#define target_get_ada_task_ptid(lwp, tid) \
8b88a78e 2125 (current_top_target ()->get_ada_task_ptid) (lwp,tid)
0ef643c8 2126
08388c79
DE
2127/* Utility implementation of searching memory. */
2128extern int simple_search_memory (struct target_ops* ops,
2129 CORE_ADDR start_addr,
2130 ULONGEST search_space_len,
2131 const gdb_byte *pattern,
2132 ULONGEST pattern_len,
2133 CORE_ADDR *found_addrp);
2134
2135/* Main entry point for searching memory. */
2136extern int target_search_memory (CORE_ADDR start_addr,
2137 ULONGEST search_space_len,
2138 const gdb_byte *pattern,
2139 ULONGEST pattern_len,
2140 CORE_ADDR *found_addrp);
2141
7313baad
UW
2142/* Target file operations. */
2143
07c138c8
GB
2144/* Return nonzero if the filesystem seen by the current inferior
2145 is the local filesystem, zero otherwise. */
4bd7dc42 2146#define target_filesystem_is_local() \
8b88a78e 2147 current_top_target ()->filesystem_is_local ()
4bd7dc42 2148
07c138c8 2149/* Open FILENAME on the target, in the filesystem as seen by INF,
4111f652
PA
2150 using FLAGS and MODE. If INF is NULL, use the filesystem seen by
2151 the debugger (GDB or, for remote targets, the remote stub). Return
2152 a target file descriptor, or -1 if an error occurs (and set
2153 *TARGET_ERRNO). If WARN_IF_SLOW is true, print a warning message
2154 if the file is being accessed over a link that may be slow. */
07c138c8
GB
2155extern int target_fileio_open (struct inferior *inf,
2156 const char *filename, int flags,
4111f652
PA
2157 int mode, bool warn_if_slow,
2158 int *target_errno);
4313b8c0 2159
7313baad
UW
2160/* Write up to LEN bytes from WRITE_BUF to FD on the target.
2161 Return the number of bytes written, or -1 if an error occurs
2162 (and set *TARGET_ERRNO). */
2163extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
2164 ULONGEST offset, int *target_errno);
2165
2166/* Read up to LEN bytes FD on the target into READ_BUF.
2167 Return the number of bytes read, or -1 if an error occurs
2168 (and set *TARGET_ERRNO). */
2169extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
2170 ULONGEST offset, int *target_errno);
2171
9b15c1f0
GB
2172/* Get information about the file opened as FD on the target
2173 and put it in SB. Return 0 on success, or -1 if an error
2174 occurs (and set *TARGET_ERRNO). */
2175extern int target_fileio_fstat (int fd, struct stat *sb,
2176 int *target_errno);
2177
7313baad
UW
2178/* Close FD on the target. Return 0, or -1 if an error occurs
2179 (and set *TARGET_ERRNO). */
2180extern int target_fileio_close (int fd, int *target_errno);
2181
07c138c8
GB
2182/* Unlink FILENAME on the target, in the filesystem as seen by INF.
2183 If INF is NULL, use the filesystem seen by the debugger (GDB or,
2184 for remote targets, the remote stub). Return 0, or -1 if an error
7313baad 2185 occurs (and set *TARGET_ERRNO). */
07c138c8
GB
2186extern int target_fileio_unlink (struct inferior *inf,
2187 const char *filename,
2188 int *target_errno);
2189
2190/* Read value of symbolic link FILENAME on the target, in the
2191 filesystem as seen by INF. If INF is NULL, use the filesystem seen
2192 by the debugger (GDB or, for remote targets, the remote stub).
2193 Return a null-terminated string allocated via xmalloc, or NULL if
2194 an error occurs (and set *TARGET_ERRNO). */
e0d3522b
TT
2195extern gdb::optional<std::string> target_fileio_readlink
2196 (struct inferior *inf, const char *filename, int *target_errno);
07c138c8
GB
2197
2198/* Read target file FILENAME, in the filesystem as seen by INF. If
2199 INF is NULL, use the filesystem seen by the debugger (GDB or, for
2200 remote targets, the remote stub). The return value will be -1 if
2201 the transfer fails or is not supported; 0 if the object is empty;
2202 or the length of the object otherwise. If a positive value is
2203 returned, a sufficiently large buffer will be allocated using
2204 xmalloc and returned in *BUF_P containing the contents of the
2205 object.
7313baad
UW
2206
2207 This method should be used for objects sufficiently small to store
2208 in a single xmalloc'd buffer, when no fixed bound on the object's
2209 size is known in advance. */
07c138c8
GB
2210extern LONGEST target_fileio_read_alloc (struct inferior *inf,
2211 const char *filename,
7313baad
UW
2212 gdb_byte **buf_p);
2213
db1ff28b
JK
2214/* Read target file FILENAME, in the filesystem as seen by INF. If
2215 INF is NULL, use the filesystem seen by the debugger (GDB or, for
2216 remote targets, the remote stub). The result is NUL-terminated and
2217 returned as a string, allocated using xmalloc. If an error occurs
2218 or the transfer is unsupported, NULL is returned. Empty objects
2219 are returned as allocated but empty strings. A warning is issued
2220 if the result contains any embedded NUL bytes. */
87028b87
TT
2221extern gdb::unique_xmalloc_ptr<char> target_fileio_read_stralloc
2222 (struct inferior *inf, const char *filename);
db1ff28b 2223
7313baad 2224
35b1e5cc
SS
2225/* Tracepoint-related operations. */
2226
2227#define target_trace_init() \
8b88a78e 2228 (current_top_target ()->trace_init) ()
35b1e5cc
SS
2229
2230#define target_download_tracepoint(t) \
8b88a78e 2231 (current_top_target ()->download_tracepoint) (t)
35b1e5cc 2232
1e4d1764 2233#define target_can_download_tracepoint() \
8b88a78e 2234 (current_top_target ()->can_download_tracepoint) ()
1e4d1764 2235
35b1e5cc 2236#define target_download_trace_state_variable(tsv) \
8b88a78e 2237 (current_top_target ()->download_trace_state_variable) (tsv)
35b1e5cc 2238
d248b706 2239#define target_enable_tracepoint(loc) \
8b88a78e 2240 (current_top_target ()->enable_tracepoint) (loc)
d248b706
KY
2241
2242#define target_disable_tracepoint(loc) \
8b88a78e 2243 (current_top_target ()->disable_tracepoint) (loc)
d248b706 2244
35b1e5cc 2245#define target_trace_start() \
8b88a78e 2246 (current_top_target ()->trace_start) ()
35b1e5cc
SS
2247
2248#define target_trace_set_readonly_regions() \
8b88a78e 2249 (current_top_target ()->trace_set_readonly_regions) ()
35b1e5cc 2250
00bf0b85 2251#define target_get_trace_status(ts) \
8b88a78e 2252 (current_top_target ()->get_trace_status) (ts)
35b1e5cc 2253
f196051f 2254#define target_get_tracepoint_status(tp,utp) \
8b88a78e 2255 (current_top_target ()->get_tracepoint_status) (tp, utp)
f196051f 2256
35b1e5cc 2257#define target_trace_stop() \
8b88a78e 2258 (current_top_target ()->trace_stop) ()
35b1e5cc
SS
2259
2260#define target_trace_find(type,num,addr1,addr2,tpp) \
8b88a78e 2261 (current_top_target ()->trace_find) (\
bd4c6793 2262 (type), (num), (addr1), (addr2), (tpp))
35b1e5cc
SS
2263
2264#define target_get_trace_state_variable_value(tsv,val) \
8b88a78e 2265 (current_top_target ()->get_trace_state_variable_value) ((tsv), (val))
35b1e5cc 2266
00bf0b85 2267#define target_save_trace_data(filename) \
8b88a78e 2268 (current_top_target ()->save_trace_data) (filename)
00bf0b85
SS
2269
2270#define target_upload_tracepoints(utpp) \
8b88a78e 2271 (current_top_target ()->upload_tracepoints) (utpp)
00bf0b85
SS
2272
2273#define target_upload_trace_state_variables(utsvp) \
8b88a78e 2274 (current_top_target ()->upload_trace_state_variables) (utsvp)
00bf0b85
SS
2275
2276#define target_get_raw_trace_data(buf,offset,len) \
8b88a78e 2277 (current_top_target ()->get_raw_trace_data) ((buf), (offset), (len))
00bf0b85 2278
405f8e94 2279#define target_get_min_fast_tracepoint_insn_len() \
8b88a78e 2280 (current_top_target ()->get_min_fast_tracepoint_insn_len) ()
405f8e94 2281
35b1e5cc 2282#define target_set_disconnected_tracing(val) \
8b88a78e 2283 (current_top_target ()->set_disconnected_tracing) (val)
35b1e5cc 2284
4daf5ac0 2285#define target_set_circular_trace_buffer(val) \
8b88a78e 2286 (current_top_target ()->set_circular_trace_buffer) (val)
4daf5ac0 2287
f6f899bf 2288#define target_set_trace_buffer_size(val) \
8b88a78e 2289 (current_top_target ()->set_trace_buffer_size) (val)
f6f899bf 2290
f196051f 2291#define target_set_trace_notes(user,notes,stopnotes) \
8b88a78e 2292 (current_top_target ()->set_trace_notes) ((user), (notes), (stopnotes))
f196051f 2293
711e434b 2294#define target_get_tib_address(ptid, addr) \
8b88a78e 2295 (current_top_target ()->get_tib_address) ((ptid), (addr))
711e434b 2296
d914c394 2297#define target_set_permissions() \
8b88a78e 2298 (current_top_target ()->set_permissions) ()
d914c394 2299
0fb4aa4b 2300#define target_static_tracepoint_marker_at(addr, marker) \
8b88a78e 2301 (current_top_target ()->static_tracepoint_marker_at) (addr, marker)
0fb4aa4b
PA
2302
2303#define target_static_tracepoint_markers_by_strid(marker_id) \
8b88a78e 2304 (current_top_target ()->static_tracepoint_markers_by_strid) (marker_id)
0fb4aa4b 2305
b3b9301e 2306#define target_traceframe_info() \
8b88a78e 2307 (current_top_target ()->traceframe_info) ()
b3b9301e 2308
d1feda86 2309#define target_use_agent(use) \
8b88a78e 2310 (current_top_target ()->use_agent) (use)
d1feda86
YQ
2311
2312#define target_can_use_agent() \
8b88a78e 2313 (current_top_target ()->can_use_agent) ()
d1feda86 2314
ced63ec0 2315#define target_augmented_libraries_svr4_read() \
8b88a78e 2316 (current_top_target ()->augmented_libraries_svr4_read) ()
ced63ec0 2317
49d03eab
MR
2318/* Command logging facility. */
2319
d9cb0195 2320#define target_log_command(p) \
8b88a78e 2321 (current_top_target ()->log_command) (p)
49d03eab 2322
dc146f7c
VP
2323
2324extern int target_core_of_thread (ptid_t ptid);
2325
ea001bdc
MM
2326/* See to_get_unwinder in struct target_ops. */
2327extern const struct frame_unwind *target_get_unwinder (void);
2328
2329/* See to_get_tailcall_unwinder in struct target_ops. */
2330extern const struct frame_unwind *target_get_tailcall_unwinder (void);
2331
936d2992
PA
2332/* This implements basic memory verification, reading target memory
2333 and performing the comparison here (as opposed to accelerated
2334 verification making use of the qCRC packet, for example). */
2335
2336extern int simple_verify_memory (struct target_ops* ops,
2337 const gdb_byte *data,
2338 CORE_ADDR memaddr, ULONGEST size);
2339
4a5e7a5b
PA
2340/* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2341 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2342 if there's a mismatch, and -1 if an error is encountered while
2343 reading memory. Throws an error if the functionality is found not
2344 to be supported by the current target. */
2345int target_verify_memory (const gdb_byte *data,
2346 CORE_ADDR memaddr, ULONGEST size);
2347
c906108c
SS
2348/* Routines for maintenance of the target structures...
2349
2350 add_target: Add a target to the list of all possible targets.
3156469c
JB
2351 This only makes sense for targets that should be activated using
2352 the "target TARGET_NAME ..." command.
c906108c
SS
2353
2354 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
2355 targets, within its particular stratum of the stack. Result
2356 is 0 if now atop the stack, nonzero if not on top (maybe
2357 should warn user).
c906108c
SS
2358
2359 unpush_target: Remove this from the stack of currently used targets,
c5aa993b 2360 no matter where it is on the list. Returns 0 if no
7fdc1521 2361 change, 1 if removed from stack. */
c906108c 2362
d9f719f1
PA
2363/* Type of callback called when the user activates a target with
2364 "target TARGET_NAME". The callback routine takes the rest of the
2365 parameters from the command, and (if successful) pushes a new
2366 target onto the stack. */
2367typedef void target_open_ftype (const char *args, int from_tty);
2368
2369/* Add the target described by INFO to the list of possible targets
2370 and add a new command 'target $(INFO->shortname)'. Set COMPLETER
2371 as the command's completer if not NULL. */
c906108c 2372
d9f719f1
PA
2373extern void add_target (const target_info &info,
2374 target_open_ftype *func,
2375 completer_ftype *completer = NULL);
9852c492 2376
d9f719f1
PA
2377/* Adds a command ALIAS for the target described by INFO and marks it
2378 deprecated. This is useful for maintaining backwards compatibility
2379 when renaming targets. */
b48d48eb 2380
d9f719f1 2381extern void add_deprecated_target_alias (const target_info &info,
a121b7c1 2382 const char *alias);
b48d48eb 2383
b26a4dcb 2384extern void push_target (struct target_ops *);
c906108c 2385
dea57a62
TT
2386/* An overload that deletes the target on failure. */
2387extern void push_target (target_ops_up &&);
2388
a14ed312 2389extern int unpush_target (struct target_ops *);
c906108c 2390
fd79ecee
DJ
2391extern void target_pre_inferior (int);
2392
a14ed312 2393extern void target_preopen (int);
c906108c 2394
460014f5
JK
2395/* Does whatever cleanup is required to get rid of all pushed targets. */
2396extern void pop_all_targets (void);
aa76d38d 2397
915ef8b1
PA
2398/* Like pop_all_targets, but pops only targets whose stratum is at or
2399 above STRATUM. */
2400extern void pop_all_targets_at_and_above (enum strata stratum);
2401
87ab71f0
PA
2402/* Like pop_all_targets, but pops only targets whose stratum is
2403 strictly above ABOVE_STRATUM. */
460014f5 2404extern void pop_all_targets_above (enum strata above_stratum);
87ab71f0 2405
5b6d1e4f 2406extern bool target_is_pushed (target_ops *t);
c0edd9ed 2407
9e35dae4
DJ
2408extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2409 CORE_ADDR offset);
2410
0542c86d 2411/* Struct target_section maps address ranges to file sections. It is
c906108c
SS
2412 mostly used with BFD files, but can be used without (e.g. for handling
2413 raw disks, or files not in formats handled by BFD). */
2414
0542c86d 2415struct target_section
c5aa993b
JM
2416 {
2417 CORE_ADDR addr; /* Lowest address in section */
2418 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 2419
7be0c536 2420 struct bfd_section *the_bfd_section;
c906108c 2421
046ac79f
JK
2422 /* The "owner" of the section.
2423 It can be any unique value. It is set by add_target_sections
2424 and used by remove_target_sections.
2425 For example, for executables it is a pointer to exec_bfd and
2426 for shlibs it is the so_list pointer. */
2427 void *owner;
c5aa993b 2428 };
c906108c 2429
07b82ea5
PA
2430/* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2431
2432struct target_section_table
2433{
2434 struct target_section *sections;
2435 struct target_section *sections_end;
2436};
2437
8db32d44 2438/* Return the "section" containing the specified address. */
0542c86d
PA
2439struct target_section *target_section_by_addr (struct target_ops *target,
2440 CORE_ADDR addr);
8db32d44 2441
07b82ea5
PA
2442/* Return the target section table this target (or the targets
2443 beneath) currently manipulate. */
2444
2445extern struct target_section_table *target_get_section_table
2446 (struct target_ops *target);
2447
c906108c
SS
2448/* From mem-break.c */
2449
f6ac5f3d
PA
2450extern int memory_remove_breakpoint (struct target_ops *,
2451 struct gdbarch *, struct bp_target_info *,
73971819 2452 enum remove_bp_reason);
c906108c 2453
f6ac5f3d
PA
2454extern int memory_insert_breakpoint (struct target_ops *,
2455 struct gdbarch *, struct bp_target_info *);
2456
2457/* Convenience template use to add memory breakpoints support to a
2458 target. */
2459
2460template <typename BaseTarget>
2461struct memory_breakpoint_target : public BaseTarget
2462{
2463 int insert_breakpoint (struct gdbarch *gdbarch,
2464 struct bp_target_info *bp_tgt) override
2465 { return memory_insert_breakpoint (this, gdbarch, bp_tgt); }
2466
2467 int remove_breakpoint (struct gdbarch *gdbarch,
2468 struct bp_target_info *bp_tgt,
2469 enum remove_bp_reason reason) override
2470 { return memory_remove_breakpoint (this, gdbarch, bp_tgt, reason); }
2471};
c906108c 2472
08351840
PA
2473/* Check whether the memory at the breakpoint's placed address still
2474 contains the expected breakpoint instruction. */
2475
2476extern int memory_validate_breakpoint (struct gdbarch *gdbarch,
2477 struct bp_target_info *bp_tgt);
2478
3e43a32a
MS
2479extern int default_memory_remove_breakpoint (struct gdbarch *,
2480 struct bp_target_info *);
917317f4 2481
3e43a32a
MS
2482extern int default_memory_insert_breakpoint (struct gdbarch *,
2483 struct bp_target_info *);
917317f4 2484
c906108c
SS
2485
2486/* From target.c */
2487
a14ed312 2488extern void initialize_targets (void);
c906108c 2489
c25c4a8b 2490extern void noprocess (void) ATTRIBUTE_NORETURN;
c906108c 2491
8edfe269
DJ
2492extern void target_require_runnable (void);
2493
8b06beed
TT
2494/* Find the target at STRATUM. If no target is at that stratum,
2495 return NULL. */
2496
2497struct target_ops *find_target_at (enum strata stratum);
2498
9018be22
SM
2499/* Read OS data object of type TYPE from the target, and return it in XML
2500 format. The return value follows the same rules as target_read_stralloc. */
e0665bc8 2501
9018be22 2502extern gdb::optional<gdb::char_vector> target_get_osdata (const char *type);
07e059b5 2503
c906108c
SS
2504/* Stuff that should be shared among the various remote targets. */
2505
2506/* Debugging level. 0 is off, and non-zero values mean to print some debug
2507 information (higher values, more information). */
2508extern int remote_debug;
2509
2510/* Speed in bits per second, or -1 which means don't mess with the speed. */
2511extern int baud_rate;
236af5e3
YG
2512
2513/* Parity for serial port */
2514extern int serial_parity;
2515
c378eb4e 2516/* Timeout limit for response from target. */
c906108c
SS
2517extern int remote_timeout;
2518
c906108c 2519\f
c906108c 2520
cb85b21b
TT
2521/* Set the show memory breakpoints mode to show, and return a
2522 scoped_restore to restore it back to the current value. */
2523extern scoped_restore_tmpl<int>
2524 make_scoped_restore_show_memory_breakpoints (int show);
8defab1a 2525
491144b5
CB
2526extern bool may_write_registers;
2527extern bool may_write_memory;
2528extern bool may_insert_breakpoints;
2529extern bool may_insert_tracepoints;
2530extern bool may_insert_fast_tracepoints;
2531extern bool may_stop;
d914c394
SS
2532
2533extern void update_target_permissions (void);
2534
c906108c 2535\f
c378eb4e 2536/* Imported from machine dependent code. */
c906108c 2537
02d27625 2538/* See to_enable_btrace in struct target_ops. */
f4abbc16
MM
2539extern struct btrace_target_info *
2540 target_enable_btrace (ptid_t ptid, const struct btrace_config *);
02d27625
MM
2541
2542/* See to_disable_btrace in struct target_ops. */
2543extern void target_disable_btrace (struct btrace_target_info *btinfo);
2544
2545/* See to_teardown_btrace in struct target_ops. */
2546extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2547
2548/* See to_read_btrace in struct target_ops. */
734b0e4b 2549extern enum btrace_error target_read_btrace (struct btrace_data *,
969c39fb
MM
2550 struct btrace_target_info *,
2551 enum btrace_read_type);
02d27625 2552
f4abbc16
MM
2553/* See to_btrace_conf in struct target_ops. */
2554extern const struct btrace_config *
2555 target_btrace_conf (const struct btrace_target_info *);
2556
7c1687a9
MM
2557/* See to_stop_recording in struct target_ops. */
2558extern void target_stop_recording (void);
2559
d02ed0bb 2560/* See to_save_record in struct target_ops. */
85e1311a 2561extern void target_save_record (const char *filename);
d02ed0bb
MM
2562
2563/* Query if the target supports deleting the execution log. */
2564extern int target_supports_delete_record (void);
2565
2566/* See to_delete_record in struct target_ops. */
2567extern void target_delete_record (void);
2568
b158a20f
TW
2569/* See to_record_method. */
2570extern enum record_method target_record_method (ptid_t ptid);
2571
d02ed0bb 2572/* See to_record_is_replaying in struct target_ops. */
a52eab48 2573extern int target_record_is_replaying (ptid_t ptid);
d02ed0bb 2574
7ff27e9b
MM
2575/* See to_record_will_replay in struct target_ops. */
2576extern int target_record_will_replay (ptid_t ptid, int dir);
2577
797094dd
MM
2578/* See to_record_stop_replaying in struct target_ops. */
2579extern void target_record_stop_replaying (void);
2580
d02ed0bb
MM
2581/* See to_goto_record_begin in struct target_ops. */
2582extern void target_goto_record_begin (void);
2583
2584/* See to_goto_record_end in struct target_ops. */
2585extern void target_goto_record_end (void);
2586
2587/* See to_goto_record in struct target_ops. */
2588extern void target_goto_record (ULONGEST insn);
02d27625 2589
67c86d06 2590/* See to_insn_history. */
9a24775b 2591extern void target_insn_history (int size, gdb_disassembly_flags flags);
67c86d06
MM
2592
2593/* See to_insn_history_from. */
9a24775b
PA
2594extern void target_insn_history_from (ULONGEST from, int size,
2595 gdb_disassembly_flags flags);
67c86d06
MM
2596
2597/* See to_insn_history_range. */
9a24775b
PA
2598extern void target_insn_history_range (ULONGEST begin, ULONGEST end,
2599 gdb_disassembly_flags flags);
67c86d06 2600
15984c13 2601/* See to_call_history. */
0cb7c7b0 2602extern void target_call_history (int size, record_print_flags flags);
15984c13
MM
2603
2604/* See to_call_history_from. */
0cb7c7b0
SM
2605extern void target_call_history_from (ULONGEST begin, int size,
2606 record_print_flags flags);
15984c13
MM
2607
2608/* See to_call_history_range. */
0cb7c7b0
SM
2609extern void target_call_history_range (ULONGEST begin, ULONGEST end,
2610 record_print_flags flags);
15984c13 2611
5fff78c4
MM
2612/* See to_prepare_to_generate_core. */
2613extern void target_prepare_to_generate_core (void);
2614
2615/* See to_done_generating_core. */
2616extern void target_done_generating_core (void);
2617
c5aa993b 2618#endif /* !defined (TARGET_H) */
This page took 2.41469 seconds and 4 git commands to generate.