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