]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/target.h
Automatic date update in version.in
[thirdparty/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
SM
119/* Return a pretty printed form of TARGET_OPTIONS. */
120extern std::string target_options_to_string (int 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
PA
490 virtual ptid_t wait (ptid_t, struct target_waitstatus *,
491 int TARGET_DEBUG_PRINTER (target_debug_print_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
d3ce09f5
SS
884 /* Does this target support evaluation of breakpoint commands on its
885 end? */
57810aa7
PA
886 virtual bool can_run_breakpoint_commands ()
887 TARGET_DEFAULT_RETURN (false);
d3ce09f5 888
3a8f7b07
JK
889 /* Determine current architecture of thread PTID.
890
891 The target is supposed to determine the architecture of the code where
8133c7dc
LM
892 the target is currently stopped at. The architecture information is
893 used to perform decr_pc_after_break adjustment, and also to determine
894 the frame architecture of the innermost frame. ptrace operations need to
895 operate according to target_gdbarch (). */
f6ac5f3d 896 virtual struct gdbarch *thread_architecture (ptid_t)
3b3dac9b 897 TARGET_DEFAULT_RETURN (NULL);
c0694254 898
3b3dac9b 899 /* Determine current address space of thread PTID. */
f6ac5f3d 900 virtual struct address_space *thread_address_space (ptid_t)
3b3dac9b 901 TARGET_DEFAULT_RETURN (NULL);
c0694254 902
7313baad
UW
903 /* Target file operations. */
904
07c138c8
GB
905 /* Return nonzero if the filesystem seen by the current inferior
906 is the local filesystem, zero otherwise. */
57810aa7
PA
907 virtual bool filesystem_is_local ()
908 TARGET_DEFAULT_RETURN (true);
4bd7dc42 909
07c138c8
GB
910 /* Open FILENAME on the target, in the filesystem as seen by INF,
911 using FLAGS and MODE. If INF is NULL, use the filesystem seen
912 by the debugger (GDB or, for remote targets, the remote stub).
4313b8c0
GB
913 If WARN_IF_SLOW is nonzero, print a warning message if the file
914 is being accessed over a link that may be slow. Return a
915 target file descriptor, or -1 if an error occurs (and set
916 *TARGET_ERRNO). */
f6ac5f3d
PA
917 virtual int fileio_open (struct inferior *inf, const char *filename,
918 int flags, int mode, int warn_if_slow,
919 int *target_errno);
7313baad
UW
920
921 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
922 Return the number of bytes written, or -1 if an error occurs
923 (and set *TARGET_ERRNO). */
f6ac5f3d
PA
924 virtual int fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
925 ULONGEST offset, int *target_errno);
7313baad
UW
926
927 /* Read up to LEN bytes FD on the target into READ_BUF.
928 Return the number of bytes read, or -1 if an error occurs
929 (and set *TARGET_ERRNO). */
f6ac5f3d
PA
930 virtual int fileio_pread (int fd, gdb_byte *read_buf, int len,
931 ULONGEST offset, int *target_errno);
7313baad 932
9b15c1f0
GB
933 /* Get information about the file opened as FD and put it in
934 SB. Return 0 on success, or -1 if an error occurs (and set
935 *TARGET_ERRNO). */
f6ac5f3d 936 virtual int fileio_fstat (int fd, struct stat *sb, int *target_errno);
9b15c1f0 937
7313baad
UW
938 /* Close FD on the target. Return 0, or -1 if an error occurs
939 (and set *TARGET_ERRNO). */
f6ac5f3d 940 virtual int fileio_close (int fd, int *target_errno);
7313baad 941
07c138c8
GB
942 /* Unlink FILENAME on the target, in the filesystem as seen by
943 INF. If INF is NULL, use the filesystem seen by the debugger
944 (GDB or, for remote targets, the remote stub). Return 0, or
945 -1 if an error occurs (and set *TARGET_ERRNO). */
f6ac5f3d
PA
946 virtual int fileio_unlink (struct inferior *inf,
947 const char *filename,
948 int *target_errno);
07c138c8
GB
949
950 /* Read value of symbolic link FILENAME on the target, in the
951 filesystem as seen by INF. If INF is NULL, use the filesystem
952 seen by the debugger (GDB or, for remote targets, the remote
e0d3522b
TT
953 stub). Return a string, or an empty optional if an error
954 occurs (and set *TARGET_ERRNO). */
f6ac5f3d
PA
955 virtual gdb::optional<std::string> fileio_readlink (struct inferior *inf,
956 const char *filename,
957 int *target_errno);
b9e7b9c3 958
f6ac5f3d
PA
959 /* Implement the "info proc" command. Returns true if the target
960 actually implemented the command, false otherwise. */
961 virtual bool info_proc (const char *, enum info_proc_what);
145b16a9 962
35b1e5cc
SS
963 /* Tracepoint-related operations. */
964
965 /* Prepare the target for a tracing run. */
f6ac5f3d 966 virtual void trace_init ()
5536135b 967 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc 968
e8ba3115 969 /* Send full details of a tracepoint location to the target. */
f6ac5f3d 970 virtual void download_tracepoint (struct bp_location *location)
9a980a22 971 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc 972
1e4d1764
YQ
973 /* Is the target able to download tracepoint locations in current
974 state? */
57810aa7
PA
975 virtual bool can_download_tracepoint ()
976 TARGET_DEFAULT_RETURN (false);
1e4d1764 977
35b1e5cc 978 /* Send full details of a trace state variable to the target. */
f6ac5f3d 979 virtual void download_trace_state_variable (const trace_state_variable &tsv)
94eb98b9 980 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc 981
d248b706 982 /* Enable a tracepoint on the target. */
f6ac5f3d 983 virtual void enable_tracepoint (struct bp_location *location)
151f70f1 984 TARGET_DEFAULT_NORETURN (tcomplain ());
d248b706
KY
985
986 /* Disable a tracepoint on the target. */
f6ac5f3d 987 virtual void disable_tracepoint (struct bp_location *location)
05c41993 988 TARGET_DEFAULT_NORETURN (tcomplain ());
d248b706 989
35b1e5cc
SS
990 /* Inform the target info of memory regions that are readonly
991 (such as text sections), and so it should return data from
992 those rather than look in the trace buffer. */
f6ac5f3d 993 virtual void trace_set_readonly_regions ()
86dd181d 994 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc
SS
995
996 /* Start a trace run. */
f6ac5f3d 997 virtual void trace_start ()
25da2e80 998 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc
SS
999
1000 /* Get the current status of a tracing run. */
f6ac5f3d 1001 virtual int get_trace_status (struct trace_status *ts)
4072d4ff 1002 TARGET_DEFAULT_RETURN (-1);
35b1e5cc 1003
f6ac5f3d
PA
1004 virtual void get_tracepoint_status (struct breakpoint *tp,
1005 struct uploaded_tp *utp)
6fea14cd 1006 TARGET_DEFAULT_NORETURN (tcomplain ());
f196051f 1007
35b1e5cc 1008 /* Stop a trace run. */
f6ac5f3d 1009 virtual void trace_stop ()
e51c07ea 1010 TARGET_DEFAULT_NORETURN (tcomplain ());
35b1e5cc
SS
1011
1012 /* Ask the target to find a trace frame of the given type TYPE,
1013 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
1014 number of the trace frame, and also the tracepoint number at
c378eb4e 1015 TPP. If no trace frame matches, return -1. May throw if the
f197e0f1 1016 operation fails. */
f6ac5f3d
PA
1017 virtual int trace_find (enum trace_find_type type, int num,
1018 CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
afc94e66 1019 TARGET_DEFAULT_RETURN (-1);
35b1e5cc
SS
1020
1021 /* Get the value of the trace state variable number TSV, returning
1022 1 if the value is known and writing the value itself into the
1023 location pointed to by VAL, else returning 0. */
57810aa7
PA
1024 virtual bool get_trace_state_variable_value (int tsv, LONGEST *val)
1025 TARGET_DEFAULT_RETURN (false);
35b1e5cc 1026
f6ac5f3d 1027 virtual int save_trace_data (const char *filename)
a2e6c147 1028 TARGET_DEFAULT_NORETURN (tcomplain ());
00bf0b85 1029
f6ac5f3d 1030 virtual int upload_tracepoints (struct uploaded_tp **utpp)
1e949b00 1031 TARGET_DEFAULT_RETURN (0);
00bf0b85 1032
f6ac5f3d 1033 virtual int upload_trace_state_variables (struct uploaded_tsv **utsvp)
08120467 1034 TARGET_DEFAULT_RETURN (0);
00bf0b85 1035
f6ac5f3d
PA
1036 virtual LONGEST get_raw_trace_data (gdb_byte *buf,
1037 ULONGEST offset, LONGEST len)
ace92e7d 1038 TARGET_DEFAULT_NORETURN (tcomplain ());
00bf0b85 1039
405f8e94
SS
1040 /* Get the minimum length of instruction on which a fast tracepoint
1041 may be set on the target. If this operation is unsupported,
1042 return -1. If for some reason the minimum length cannot be
1043 determined, return 0. */
f6ac5f3d 1044 virtual int get_min_fast_tracepoint_insn_len ()
9249843f 1045 TARGET_DEFAULT_RETURN (-1);
405f8e94 1046
35b1e5cc
SS
1047 /* Set the target's tracing behavior in response to unexpected
1048 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
f6ac5f3d 1049 virtual void set_disconnected_tracing (int val)
0bcfeddf 1050 TARGET_DEFAULT_IGNORE ();
f6ac5f3d 1051 virtual void set_circular_trace_buffer (int val)
8d526939 1052 TARGET_DEFAULT_IGNORE ();
f6f899bf 1053 /* Set the size of trace buffer in the target. */
f6ac5f3d 1054 virtual void set_trace_buffer_size (LONGEST val)
91df8d1d 1055 TARGET_DEFAULT_IGNORE ();
35b1e5cc 1056
f196051f
SS
1057 /* Add/change textual notes about the trace run, returning 1 if
1058 successful, 0 otherwise. */
57810aa7
PA
1059 virtual bool set_trace_notes (const char *user, const char *notes,
1060 const char *stopnotes)
1061 TARGET_DEFAULT_RETURN (false);
f196051f 1062
dc146f7c
VP
1063 /* Return the processor core that thread PTID was last seen on.
1064 This information is updated only when:
1065 - update_thread_list is called
1066 - thread stops
3e43a32a
MS
1067 If the core cannot be determined -- either for the specified
1068 thread, or right now, or in this debug session, or for this
1069 target -- return -1. */
f6ac5f3d 1070 virtual int core_of_thread (ptid_t ptid)
9e538d0d 1071 TARGET_DEFAULT_RETURN (-1);
dc146f7c 1072
4a5e7a5b
PA
1073 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
1074 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
1075 a match, 0 if there's a mismatch, and -1 if an error is
1076 encountered while reading memory. */
f6ac5f3d
PA
1077 virtual int verify_memory (const gdb_byte *data,
1078 CORE_ADDR memaddr, ULONGEST size)
936d2992 1079 TARGET_DEFAULT_FUNC (default_verify_memory);
4a5e7a5b 1080
711e434b
PM
1081 /* Return the address of the start of the Thread Information Block
1082 a Windows OS specific feature. */
57810aa7 1083 virtual bool get_tib_address (ptid_t ptid, CORE_ADDR *addr)
22bcceee 1084 TARGET_DEFAULT_NORETURN (tcomplain ());
711e434b 1085
d914c394 1086 /* Send the new settings of write permission variables. */
f6ac5f3d 1087 virtual void set_permissions ()
dcd6917f 1088 TARGET_DEFAULT_IGNORE ();
d914c394 1089
0fb4aa4b 1090 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
5d9310c4 1091 with its details. Return true on success, false on failure. */
f6ac5f3d
PA
1092 virtual bool static_tracepoint_marker_at (CORE_ADDR,
1093 static_tracepoint_marker *marker)
5d9310c4 1094 TARGET_DEFAULT_RETURN (false);
0fb4aa4b
PA
1095
1096 /* Return a vector of all tracepoints markers string id ID, or all
1097 markers if ID is NULL. */
ad6a4e2d
PA
1098 virtual std::vector<static_tracepoint_marker>
1099 static_tracepoint_markers_by_strid (const char *id)
d6522a22 1100 TARGET_DEFAULT_NORETURN (tcomplain ());
0fb4aa4b 1101
b3b9301e 1102 /* Return a traceframe info object describing the current
f73023dd
YQ
1103 traceframe's contents. This method should not cache data;
1104 higher layers take care of caching, invalidating, and
1105 re-fetching when necessary. */
f6ac5f3d 1106 virtual traceframe_info_up traceframe_info ()
2098b393 1107 TARGET_DEFAULT_NORETURN (tcomplain ());
b3b9301e 1108
57810aa7
PA
1109 /* Ask the target to use or not to use agent according to USE.
1110 Return true if successful, false otherwise. */
1111 virtual bool use_agent (bool use)
d9db5b21 1112 TARGET_DEFAULT_NORETURN (tcomplain ());
d1feda86
YQ
1113
1114 /* Is the target able to use agent in current state? */
57810aa7
PA
1115 virtual bool can_use_agent ()
1116 TARGET_DEFAULT_RETURN (false);
d1feda86 1117
f4abbc16
MM
1118 /* Enable branch tracing for PTID using CONF configuration.
1119 Return a branch trace target information struct for reading and for
1120 disabling branch trace. */
f6ac5f3d
PA
1121 virtual struct btrace_target_info *enable_btrace (ptid_t ptid,
1122 const struct btrace_config *conf)
6dc7fcf4 1123 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625
MM
1124
1125 /* Disable branch tracing and deallocate TINFO. */
f6ac5f3d 1126 virtual void disable_btrace (struct btrace_target_info *tinfo)
8dc292d3 1127 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625
MM
1128
1129 /* Disable branch tracing and deallocate TINFO. This function is similar
1130 to to_disable_btrace, except that it is called during teardown and is
1131 only allowed to perform actions that are safe. A counter-example would
1132 be attempting to talk to a remote target. */
f6ac5f3d 1133 virtual void teardown_btrace (struct btrace_target_info *tinfo)
9ace480d 1134 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625 1135
969c39fb 1136 /* Read branch trace data for the thread indicated by BTINFO into DATA.
734b0e4b 1137 DATA is cleared before new trace is added. */
f6ac5f3d
PA
1138 virtual enum btrace_error read_btrace (struct btrace_data *data,
1139 struct btrace_target_info *btinfo,
1140 enum btrace_read_type type)
eb5b20d4 1141 TARGET_DEFAULT_NORETURN (tcomplain ());
02d27625 1142
f4abbc16 1143 /* Get the branch trace configuration. */
f6ac5f3d 1144 virtual const struct btrace_config *btrace_conf (const struct btrace_target_info *)
f4abbc16
MM
1145 TARGET_DEFAULT_RETURN (NULL);
1146
b158a20f 1147 /* Current recording method. */
f6ac5f3d 1148 virtual enum record_method record_method (ptid_t ptid)
b158a20f
TW
1149 TARGET_DEFAULT_RETURN (RECORD_METHOD_NONE);
1150
7c1687a9 1151 /* Stop trace recording. */
f6ac5f3d 1152 virtual void stop_recording ()
ee97f592 1153 TARGET_DEFAULT_IGNORE ();
7c1687a9 1154
d02ed0bb 1155 /* Print information about the recording. */
f6ac5f3d 1156 virtual void info_record ()
38e229b2 1157 TARGET_DEFAULT_IGNORE ();
d02ed0bb
MM
1158
1159 /* Save the recorded execution trace into a file. */
f6ac5f3d 1160 virtual void save_record (const char *filename)
f09e2107 1161 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb 1162
252db1b5
TT
1163 /* Delete the recorded execution trace from the current position
1164 onwards. */
f6ac5f3d
PA
1165 virtual bool supports_delete_record ()
1166 TARGET_DEFAULT_RETURN (false);
1167 virtual void delete_record ()
07366925 1168 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb 1169
a52eab48 1170 /* Query if the record target is currently replaying PTID. */
57810aa7
PA
1171 virtual bool record_is_replaying (ptid_t ptid)
1172 TARGET_DEFAULT_RETURN (false);
d02ed0bb 1173
7ff27e9b
MM
1174 /* Query if the record target will replay PTID if it were resumed in
1175 execution direction DIR. */
57810aa7
PA
1176 virtual bool record_will_replay (ptid_t ptid, int dir)
1177 TARGET_DEFAULT_RETURN (false);
7ff27e9b 1178
797094dd 1179 /* Stop replaying. */
f6ac5f3d 1180 virtual void record_stop_replaying ()
797094dd
MM
1181 TARGET_DEFAULT_IGNORE ();
1182
d02ed0bb 1183 /* Go to the begin of the execution trace. */
f6ac5f3d 1184 virtual void goto_record_begin ()
671e76cc 1185 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb
MM
1186
1187 /* Go to the end of the execution trace. */
f6ac5f3d 1188 virtual void goto_record_end ()
e9179bb3 1189 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb
MM
1190
1191 /* Go to a specific location in the recorded execution trace. */
f6ac5f3d 1192 virtual void goto_record (ULONGEST insn)
05969c84 1193 TARGET_DEFAULT_NORETURN (tcomplain ());
d02ed0bb 1194
67c86d06
MM
1195 /* Disassemble SIZE instructions in the recorded execution trace from
1196 the current position.
1197 If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1198 disassemble SIZE succeeding instructions. */
f6ac5f3d 1199 virtual void insn_history (int size, gdb_disassembly_flags flags)
3679abfa 1200 TARGET_DEFAULT_NORETURN (tcomplain ());
67c86d06
MM
1201
1202 /* Disassemble SIZE instructions in the recorded execution trace around
1203 FROM.
1204 If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1205 disassemble SIZE instructions after FROM. */
f6ac5f3d
PA
1206 virtual void insn_history_from (ULONGEST from, int size,
1207 gdb_disassembly_flags flags)
8444ab58 1208 TARGET_DEFAULT_NORETURN (tcomplain ());
67c86d06
MM
1209
1210 /* Disassemble a section of the recorded execution trace from instruction
0688d04e 1211 BEGIN (inclusive) to instruction END (inclusive). */
f6ac5f3d
PA
1212 virtual void insn_history_range (ULONGEST begin, ULONGEST end,
1213 gdb_disassembly_flags flags)
c29302cc 1214 TARGET_DEFAULT_NORETURN (tcomplain ());
67c86d06 1215
15984c13
MM
1216 /* Print a function trace of the recorded execution trace.
1217 If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1218 succeeding functions. */
f6ac5f3d 1219 virtual void call_history (int size, record_print_flags flags)
170049d4 1220 TARGET_DEFAULT_NORETURN (tcomplain ());
15984c13
MM
1221
1222 /* Print a function trace of the recorded execution trace starting
1223 at function FROM.
1224 If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1225 SIZE functions after FROM. */
f6ac5f3d 1226 virtual void call_history_from (ULONGEST begin, int size, record_print_flags flags)
16fc27d6 1227 TARGET_DEFAULT_NORETURN (tcomplain ());
15984c13
MM
1228
1229 /* Print a function trace of an execution trace section from function BEGIN
0688d04e 1230 (inclusive) to function END (inclusive). */
f6ac5f3d 1231 virtual void call_history_range (ULONGEST begin, ULONGEST end, record_print_flags flags)
115d9817 1232 TARGET_DEFAULT_NORETURN (tcomplain ());
15984c13 1233
57810aa7 1234 /* True if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
ced63ec0 1235 non-empty annex. */
57810aa7
PA
1236 virtual bool augmented_libraries_svr4_read ()
1237 TARGET_DEFAULT_RETURN (false);
ced63ec0 1238
ac01945b
TT
1239 /* Those unwinders are tried before any other arch unwinders. If
1240 SELF doesn't have unwinders, it should delegate to the
1241 "beneath" target. */
f6ac5f3d 1242 virtual const struct frame_unwind *get_unwinder ()
ac01945b
TT
1243 TARGET_DEFAULT_RETURN (NULL);
1244
f6ac5f3d 1245 virtual const struct frame_unwind *get_tailcall_unwinder ()
ac01945b 1246 TARGET_DEFAULT_RETURN (NULL);
ea001bdc 1247
5fff78c4 1248 /* Prepare to generate a core file. */
f6ac5f3d 1249 virtual void prepare_to_generate_core ()
5fff78c4
MM
1250 TARGET_DEFAULT_IGNORE ();
1251
1252 /* Cleanup after generating a core file. */
f6ac5f3d 1253 virtual void done_generating_core ()
5fff78c4 1254 TARGET_DEFAULT_IGNORE ();
c5aa993b 1255 };
c906108c 1256
15244507
PA
1257/* Deleter for std::unique_ptr. See comments in
1258 target_ops::~target_ops and target_ops::close about heap-allocated
1259 targets. */
1260struct target_ops_deleter
1261{
1262 void operator() (target_ops *target)
1263 {
1264 target->close ();
1265 }
1266};
1267
1268/* A unique pointer for target_ops. */
1269typedef std::unique_ptr<target_ops, target_ops_deleter> target_ops_up;
1270
5b6d1e4f
PA
1271/* Decref a target and close if, if there are no references left. */
1272extern void decref_target (target_ops *t);
1273
1274/* A policy class to interface gdb::ref_ptr with target_ops. */
1275
1276struct target_ops_ref_policy
1277{
1278 static void incref (target_ops *t)
1279 {
1280 t->incref ();
1281 }
1282
1283 static void decref (target_ops *t)
1284 {
1285 decref_target (t);
1286 }
1287};
1288
1289/* A gdb::ref_ptr pointer to a target_ops. */
1290typedef gdb::ref_ptr<target_ops, target_ops_ref_policy> target_ops_ref;
1291
d9f719f1
PA
1292/* Native target backends call this once at initialization time to
1293 inform the core about which is the target that can respond to "run"
1294 or "attach". Note: native targets are always singletons. */
1295extern void set_native_target (target_ops *target);
1296
1297/* Get the registered native target, if there's one. Otherwise return
1298 NULL. */
1299extern target_ops *get_native_target ();
1300
a1740ee1
PA
1301/* Type that manages a target stack. See description of target stacks
1302 and strata at the top of the file. */
1303
1304class target_stack
1305{
1306public:
1307 target_stack () = default;
1308 DISABLE_COPY_AND_ASSIGN (target_stack);
1309
1310 /* Push a new target into the stack of the existing target
1311 accessors, possibly superseding some existing accessor. */
1312 void push (target_ops *t);
1313
1314 /* Remove a target from the stack, wherever it may be. Return true
1315 if it was removed, false otherwise. */
1316 bool unpush (target_ops *t);
1317
1318 /* Returns true if T is pushed on the target stack. */
1319 bool is_pushed (target_ops *t) const
66b4deae 1320 { return at (t->stratum ()) == t; }
a1740ee1
PA
1321
1322 /* Return the target at STRATUM. */
1323 target_ops *at (strata stratum) const { return m_stack[stratum]; }
1324
1325 /* Return the target at the top of the stack. */
1326 target_ops *top () const { return at (m_top); }
1327
1328 /* Find the next target down the stack from the specified target. */
1329 target_ops *find_beneath (const target_ops *t) const;
1330
1331private:
1332 /* The stratum of the top target. */
1333 enum strata m_top {};
1334
1335 /* The stack, represented as an array, with one slot per stratum.
1336 If no target is pushed at some stratum, the corresponding slot is
1337 null. */
1338 target_ops *m_stack[(int) debug_stratum + 1] {};
1339};
1340
c906108c
SS
1341/* The ops structure for our "current" target process. This should
1342 never be NULL. If there is no target, it points to the dummy_target. */
1343
8b88a78e 1344extern target_ops *current_top_target ();
c906108c 1345
5b6d1e4f
PA
1346/* Return the dummy target. */
1347extern target_ops *get_dummy_target ();
1348
c906108c
SS
1349/* Define easy words for doing these operations on our current target. */
1350
8b88a78e
PA
1351#define target_shortname (current_top_target ()->shortname ())
1352#define target_longname (current_top_target ()->longname ())
c906108c 1353
f1c07ab0 1354/* Does whatever cleanup is required for a target that we are no
460014f5
JK
1355 longer going to be calling. This routine is automatically always
1356 called after popping the target off the target stack - the target's
1357 own methods are no longer available through the target vector.
1358 Closing file descriptors and freeing all memory allocated memory are
1359 typical things it should do. */
f1c07ab0 1360
460014f5 1361void target_close (struct target_ops *targ);
c906108c 1362
b3ccfe11
TT
1363/* Find the correct target to use for "attach". If a target on the
1364 current stack supports attaching, then it is returned. Otherwise,
1365 the default run target is returned. */
1366
1367extern struct target_ops *find_attach_target (void);
c906108c 1368
b3ccfe11
TT
1369/* Find the correct target to use for "run". If a target on the
1370 current stack supports creating a new inferior, then it is
1371 returned. Otherwise, the default run target is returned. */
1372
1373extern struct target_ops *find_run_target (void);
c906108c 1374
dc177b7a
PA
1375/* Some targets don't generate traps when attaching to the inferior,
1376 or their target_attach implementation takes care of the waiting.
1377 These targets must set to_attach_no_wait. */
1378
f6ac5f3d 1379#define target_attach_no_wait() \
8b88a78e 1380 (current_top_target ()->attach_no_wait ())
dc177b7a 1381
c906108c
SS
1382/* The target_attach operation places a process under debugger control,
1383 and stops the process.
1384
1385 This operation provides a target-specific hook that allows the
0d06e24b 1386 necessary bookkeeping to be performed after an attach completes. */
c906108c 1387#define target_post_attach(pid) \
8b88a78e 1388 (current_top_target ()->post_attach) (pid)
c906108c 1389
0f48b757
PA
1390/* Display a message indicating we're about to detach from the current
1391 inferior process. */
1392
1393extern void target_announce_detach (int from_tty);
1394
c906108c
SS
1395/* Takes a program previously attached to and detaches it.
1396 The program may resume execution (some targets do, some don't) and will
1397 no longer stop on signals, etc. We better not have left any breakpoints
6bd6f3b6
SM
1398 in the program or it'll die when it hits one. FROM_TTY says whether to be
1399 verbose or not. */
c906108c 1400
6e1e1966 1401extern void target_detach (inferior *inf, int from_tty);
c906108c 1402
6ad8ae5c
DJ
1403/* Disconnect from the current target without resuming it (leaving it
1404 waiting for a debugger). */
1405
fee354ee 1406extern void target_disconnect (const char *, int);
6ad8ae5c 1407
85ad3aaf
PA
1408/* Resume execution (or prepare for execution) of a target thread,
1409 process or all processes. STEP says whether to hardware
1410 single-step or to run free; SIGGNAL is the signal to be given to
1411 the target, or GDB_SIGNAL_0 for no signal. The caller may not pass
1412 GDB_SIGNAL_DEFAULT. A specific PTID means `step/resume only this
1413 process id'. A wildcard PTID (all threads, or all threads of
1414 process) means `step/resume INFERIOR_PTID, and let other threads
1415 (for which the wildcard PTID matches) resume with their
1416 'thread->suspend.stop_signal' signal (usually GDB_SIGNAL_0) if it
1417 is in "pass" state, or with no signal if in "no pass" state.
1418
1419 In order to efficiently handle batches of resumption requests,
1420 targets may implement this method such that it records the
1421 resumption request, but defers the actual resumption to the
1422 target_commit_resume method implementation. See
1423 target_commit_resume below. */
2ea28649 1424extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
c906108c 1425
85ad3aaf
PA
1426/* Commit a series of resumption requests previously prepared with
1427 target_resume calls.
1428
1429 GDB always calls target_commit_resume after calling target_resume
1430 one or more times. A target may thus use this method in
1431 coordination with the target_resume method to batch target-side
1432 resumption requests. In that case, the target doesn't actually
1433 resume in its target_resume implementation. Instead, it prepares
1434 the resumption in target_resume, and defers the actual resumption
1435 to target_commit_resume. E.g., the remote target uses this to
1436 coalesce multiple resumption requests in a single vCont packet. */
1437extern void target_commit_resume ();
1438
a9bc57b9
TT
1439/* Setup to defer target_commit_resume calls, and reactivate
1440 target_commit_resume on destruction, if it was previously
85ad3aaf 1441 active. */
a9bc57b9 1442extern scoped_restore_tmpl<int> make_scoped_defer_target_commit_resume ();
85ad3aaf 1443
f2b9e3df 1444/* For target_read_memory see target/target.h. */
c906108c 1445
0b333c5e
PA
1446/* The default target_ops::to_wait implementation. */
1447
1448extern ptid_t default_target_wait (struct target_ops *ops,
1449 ptid_t ptid,
1450 struct target_waitstatus *status,
1451 int options);
1452
17dee195 1453/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c 1454
28439f5e 1455extern void target_fetch_registers (struct regcache *regcache, int regno);
c906108c
SS
1456
1457/* Store at least register REGNO, or all regs if REGNO == -1.
1458 It can store as many registers as it wants to, so target_prepare_to_store
1459 must have been previously called. Calls error() if there are problems. */
1460
28439f5e 1461extern void target_store_registers (struct regcache *regcache, int regs);
c906108c
SS
1462
1463/* Get ready to modify the registers array. On machines which store
1464 individual registers, this doesn't need to do anything. On machines
1465 which store all the registers in one fell swoop, this makes sure
1466 that REGISTERS contains all the registers from the program being
1467 debugged. */
1468
316f2060 1469#define target_prepare_to_store(regcache) \
8b88a78e 1470 (current_top_target ()->prepare_to_store) (regcache)
c906108c 1471
6c95b8df
PA
1472/* Determine current address space of thread PTID. */
1473
1474struct address_space *target_thread_address_space (ptid_t);
1475
451b7c33
TT
1476/* Implement the "info proc" command. This returns one if the request
1477 was handled, and zero otherwise. It can also throw an exception if
1478 an error was encountered while attempting to handle the
1479 request. */
145b16a9 1480
7bc112c1 1481int target_info_proc (const char *, enum info_proc_what);
145b16a9 1482
03583c20
UW
1483/* Returns true if this target can disable address space randomization. */
1484
1485int target_supports_disable_randomization (void);
1486
d248b706
KY
1487/* Returns true if this target can enable and disable tracepoints
1488 while a trace experiment is running. */
1489
1490#define target_supports_enable_disable_tracepoint() \
8b88a78e 1491 (current_top_target ()->supports_enable_disable_tracepoint) ()
d248b706 1492
3065dfb6 1493#define target_supports_string_tracing() \
8b88a78e 1494 (current_top_target ()->supports_string_tracing) ()
3065dfb6 1495
b775012e
LM
1496/* Returns true if this target can handle breakpoint conditions
1497 on its end. */
1498
1499#define target_supports_evaluation_of_breakpoint_conditions() \
8b88a78e 1500 (current_top_target ()->supports_evaluation_of_breakpoint_conditions) ()
b775012e 1501
d3ce09f5
SS
1502/* Returns true if this target can handle breakpoint commands
1503 on its end. */
1504
1505#define target_can_run_breakpoint_commands() \
8b88a78e 1506 (current_top_target ()->can_run_breakpoint_commands) ()
d3ce09f5 1507
e83e4e24
TT
1508extern int target_read_string (CORE_ADDR, gdb::unique_xmalloc_ptr<char> *,
1509 int, int *);
c906108c 1510
721ec300 1511/* For target_read_memory see target/target.h. */
c906108c 1512
aee4bf85
PA
1513extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1514 ssize_t len);
1515
45aa4659 1516extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
4e5d721f 1517
29453a14
YQ
1518extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1519
721ec300 1520/* For target_write_memory see target/target.h. */
c906108c 1521
f0ba3972 1522extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
45aa4659 1523 ssize_t len);
f0ba3972 1524
fd79ecee
DJ
1525/* Fetches the target's memory map. If one is found it is sorted
1526 and returned, after some consistency checking. Otherwise, NULL
1527 is returned. */
a664f67e 1528std::vector<mem_region> target_memory_map (void);
fd79ecee 1529
78cbbba8 1530/* Erases all flash memory regions on the target. */
0b39b52e 1531void flash_erase_command (const char *cmd, int from_tty);
78cbbba8 1532
a76d924d
DJ
1533/* Erase the specified flash region. */
1534void target_flash_erase (ULONGEST address, LONGEST length);
1535
1536/* Finish a sequence of flash operations. */
1537void target_flash_done (void);
1538
1539/* Describes a request for a memory write operation. */
1540struct memory_write_request
55089490
TT
1541{
1542 memory_write_request (ULONGEST begin_, ULONGEST end_,
1543 gdb_byte *data_ = nullptr, void *baton_ = nullptr)
1544 : begin (begin_), end (end_), data (data_), baton (baton_)
1545 {}
1546
1547 /* Begining address that must be written. */
1548 ULONGEST begin;
1549 /* Past-the-end address. */
1550 ULONGEST end;
1551 /* The data to write. */
1552 gdb_byte *data;
1553 /* A callback baton for progress reporting for this request. */
1554 void *baton;
1555};
a76d924d
DJ
1556
1557/* Enumeration specifying different flash preservation behaviour. */
1558enum flash_preserve_mode
1559 {
1560 flash_preserve,
1561 flash_discard
1562 };
1563
1564/* Write several memory blocks at once. This version can be more
1565 efficient than making several calls to target_write_memory, in
1566 particular because it can optimize accesses to flash memory.
1567
1568 Moreover, this is currently the only memory access function in gdb
1569 that supports writing to flash memory, and it should be used for
1570 all cases where access to flash memory is desirable.
1571
791b7405 1572 REQUESTS is the vector of memory_write_request.
a76d924d
DJ
1573 PRESERVE_FLASH_P indicates what to do with blocks which must be
1574 erased, but not completely rewritten.
1575 PROGRESS_CB is a function that will be periodically called to provide
1576 feedback to user. It will be called with the baton corresponding
1577 to the request currently being written. It may also be called
1578 with a NULL baton, when preserved flash sectors are being rewritten.
1579
1580 The function returns 0 on success, and error otherwise. */
55089490
TT
1581int target_write_memory_blocks
1582 (const std::vector<memory_write_request> &requests,
1583 enum flash_preserve_mode preserve_flash_p,
1584 void (*progress_cb) (ULONGEST, void *));
a76d924d 1585
c906108c
SS
1586/* Print a line about the current target. */
1587
1588#define target_files_info() \
8b88a78e 1589 (current_top_target ()->files_info) ()
c906108c 1590
7d03f2eb 1591/* Insert a breakpoint at address BP_TGT->placed_address in
0000e5cc
PA
1592 the target machine. Returns 0 for success, and returns non-zero or
1593 throws an error (with a detailed failure reason error code and
1594 message) otherwise. */
c906108c 1595
d914c394
SS
1596extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1597 struct bp_target_info *bp_tgt);
c906108c 1598
8181d85f 1599/* Remove a breakpoint at address BP_TGT->placed_address in the target
578d3588 1600 machine. Result is 0 for success, non-zero for error. */
c906108c 1601
d914c394 1602extern int target_remove_breakpoint (struct gdbarch *gdbarch,
73971819
PA
1603 struct bp_target_info *bp_tgt,
1604 enum remove_bp_reason reason);
c906108c 1605
b0ed115f 1606/* Return true if the target stack has a non-default
f6ac5f3d 1607 "terminal_ours" method. */
b0ed115f 1608
20f0d60d 1609extern bool target_supports_terminal_ours (void);
b0ed115f 1610
c906108c
SS
1611/* Kill the inferior process. Make it go away. */
1612
7d85a9c0 1613extern void target_kill (void);
c906108c 1614
0d06e24b
JM
1615/* Load an executable file into the target process. This is expected
1616 to not only bring new code into the target process, but also to
1986bccd
AS
1617 update GDB's symbol tables to match.
1618
1619 ARG contains command-line arguments, to be broken down with
1620 buildargv (). The first non-switch argument is the filename to
1621 load, FILE; the second is a number (as parsed by strtoul (..., ...,
1622 0)), which is an offset to apply to the load addresses of FILE's
1623 sections. The target may define switches, or other non-switch
1624 arguments, as it pleases. */
c906108c 1625
9cbe5fff 1626extern void target_load (const char *arg, int from_tty);
c906108c 1627
c906108c
SS
1628/* Some targets (such as ttrace-based HPUX) don't allow us to request
1629 notification of inferior events such as fork and vork immediately
1630 after the inferior is created. (This because of how gdb gets an
1631 inferior created via invoking a shell to do it. In such a scenario,
1632 if the shell init file has commands in it, the shell will fork and
1633 exec for each of those commands, and we will see each such fork
1634 event. Very bad.)
c5aa993b 1635
0d06e24b
JM
1636 Such targets will supply an appropriate definition for this function. */
1637
39f77062 1638#define target_post_startup_inferior(ptid) \
8b88a78e 1639 (current_top_target ()->post_startup_inferior) (ptid)
c906108c 1640
0d06e24b
JM
1641/* On some targets, we can catch an inferior fork or vfork event when
1642 it occurs. These functions insert/remove an already-created
77b06cd7
TJB
1643 catchpoint for such events. They return 0 for success, 1 if the
1644 catchpoint type is not supported and -1 for failure. */
c906108c 1645
c906108c 1646#define target_insert_fork_catchpoint(pid) \
8b88a78e 1647 (current_top_target ()->insert_fork_catchpoint) (pid)
c906108c
SS
1648
1649#define target_remove_fork_catchpoint(pid) \
8b88a78e 1650 (current_top_target ()->remove_fork_catchpoint) (pid)
c906108c
SS
1651
1652#define target_insert_vfork_catchpoint(pid) \
8b88a78e 1653 (current_top_target ()->insert_vfork_catchpoint) (pid)
c906108c
SS
1654
1655#define target_remove_vfork_catchpoint(pid) \
8b88a78e 1656 (current_top_target ()->remove_vfork_catchpoint) (pid)
c906108c 1657
6604731b
DJ
1658/* If the inferior forks or vforks, this function will be called at
1659 the next resume in order to perform any bookkeeping and fiddling
1660 necessary to continue debugging either the parent or child, as
1661 requested, and releasing the other. Information about the fork
1662 or vfork event is available via get_last_target_status ().
5ab2fbf1 1663 This function returns true if the inferior should not be resumed
6604731b 1664 (i.e. there is another event pending). */
0d06e24b 1665
5ab2fbf1 1666bool target_follow_fork (bool follow_child, bool detach_fork);
c906108c 1667
94585166
DB
1668/* Handle the target-specific bookkeeping required when the inferior
1669 makes an exec call. INF is the exec'd inferior. */
1670
4ca51187 1671void target_follow_exec (struct inferior *inf, const char *execd_pathname);
94585166 1672
c906108c 1673/* On some targets, we can catch an inferior exec event when it
0d06e24b 1674 occurs. These functions insert/remove an already-created
77b06cd7
TJB
1675 catchpoint for such events. They return 0 for success, 1 if the
1676 catchpoint type is not supported and -1 for failure. */
0d06e24b 1677
c906108c 1678#define target_insert_exec_catchpoint(pid) \
8b88a78e 1679 (current_top_target ()->insert_exec_catchpoint) (pid)
c5aa993b 1680
c906108c 1681#define target_remove_exec_catchpoint(pid) \
8b88a78e 1682 (current_top_target ()->remove_exec_catchpoint) (pid)
c906108c 1683
a96d9b2e
SDJ
1684/* Syscall catch.
1685
649a140c
PA
1686 NEEDED is true if any syscall catch (of any kind) is requested.
1687 If NEEDED is false, it means the target can disable the mechanism to
a96d9b2e
SDJ
1688 catch system calls because there are no more catchpoints of this type.
1689
1690 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
649a140c 1691 being requested. In this case, SYSCALL_COUNTS should be ignored.
a96d9b2e 1692
649a140c
PA
1693 SYSCALL_COUNTS is an array of ints, indexed by syscall number. An
1694 element in this array is nonzero if that syscall should be caught.
1695 This argument only matters if ANY_COUNT is zero.
77b06cd7
TJB
1696
1697 Return 0 for success, 1 if syscall catchpoints are not supported or -1
1698 for failure. */
a96d9b2e 1699
649a140c 1700#define target_set_syscall_catchpoint(pid, needed, any_count, syscall_counts) \
8b88a78e 1701 (current_top_target ()->set_syscall_catchpoint) (pid, needed, any_count, \
f6ac5f3d 1702 syscall_counts)
a96d9b2e 1703
c906108c 1704/* The debugger has completed a blocking wait() call. There is now
2146d243 1705 some process event that must be processed. This function should
c906108c 1706 be defined by those targets that require the debugger to perform
0d06e24b 1707 cleanup or internal state changes in response to the process event. */
c906108c 1708
bc1e6c81 1709/* For target_mourn_inferior see target/target.h. */
c906108c 1710
f6ac5f3d 1711/* Does target have enough data to do a run or attach command? */
c906108c 1712
f6ac5f3d 1713extern int target_can_run ();
c906108c 1714
2455069d
UW
1715/* Set list of signals to be handled in the target.
1716
adc6a863 1717 PASS_SIGNALS is an array indexed by target signal number
2ea28649 1718 (enum gdb_signal). For every signal whose entry in this array is
2455069d
UW
1719 non-zero, the target is allowed -but not required- to skip reporting
1720 arrival of the signal to the GDB core by returning from target_wait,
1721 and to pass the signal directly to the inferior instead.
1722
1723 However, if the target is hardware single-stepping a thread that is
1724 about to receive a signal, it needs to be reported in any case, even
1725 if mentioned in a previous target_pass_signals call. */
c906108c 1726
adc6a863
PA
1727extern void target_pass_signals
1728 (gdb::array_view<const unsigned char> pass_signals);
c906108c 1729
9b224c5e
PA
1730/* Set list of signals the target may pass to the inferior. This
1731 directly maps to the "handle SIGNAL pass/nopass" setting.
1732
adc6a863 1733 PROGRAM_SIGNALS is an array indexed by target signal
2ea28649 1734 number (enum gdb_signal). For every signal whose entry in this
9b224c5e
PA
1735 array is non-zero, the target is allowed to pass the signal to the
1736 inferior. Signals not present in the array shall be silently
1737 discarded. This does not influence whether to pass signals to the
1738 inferior as a result of a target_resume call. This is useful in
1739 scenarios where the target needs to decide whether to pass or not a
1740 signal to the inferior without GDB core involvement, such as for
1741 example, when detaching (as threads may have been suspended with
1742 pending signals not reported to GDB). */
1743
adc6a863
PA
1744extern void target_program_signals
1745 (gdb::array_view<const unsigned char> program_signals);
9b224c5e 1746
c906108c
SS
1747/* Check to see if a thread is still alive. */
1748
28439f5e 1749extern int target_thread_alive (ptid_t ptid);
c906108c 1750
e8032dde 1751/* Sync the target's threads with GDB's thread list. */
b83266a0 1752
e8032dde 1753extern void target_update_thread_list (void);
b83266a0 1754
0d06e24b 1755/* Make target stop in a continuable fashion. (For instance, under
9a6cf368
GB
1756 Unix, this should act like SIGSTOP). Note that this function is
1757 asynchronous: it does not wait for the target to become stopped
1758 before returning. If this is the behavior you want please use
1759 target_stop_and_wait. */
c906108c 1760
d914c394 1761extern void target_stop (ptid_t ptid);
c906108c 1762
e671cd59
PA
1763/* Interrupt the target. Unlike target_stop, this does not specify
1764 which thread/process reports the stop. For most target this acts
1765 like raising a SIGINT, though that's not absolutely required. This
1766 function is asynchronous. */
bfedc46a 1767
e671cd59 1768extern void target_interrupt ();
bfedc46a 1769
93692b58 1770/* Pass a ^C, as determined to have been pressed by checking the quit
e671cd59
PA
1771 flag, to the target, as if the user had typed the ^C on the
1772 inferior's controlling terminal while the inferior was in the
1773 foreground. Remote targets may take the opportunity to detect the
1774 remote side is not responding and offer to disconnect. */
93692b58
PA
1775
1776extern void target_pass_ctrlc (void);
1777
1778/* The default target_ops::to_pass_ctrlc implementation. Simply calls
1779 target_interrupt. */
1780extern void default_target_pass_ctrlc (struct target_ops *ops);
1781
96baa820
JM
1782/* Send the specified COMMAND to the target's monitor
1783 (shell,interpreter) for execution. The result of the query is
0d06e24b 1784 placed in OUTBUF. */
96baa820
JM
1785
1786#define target_rcmd(command, outbuf) \
8b88a78e 1787 (current_top_target ()->rcmd) (command, outbuf)
96baa820
JM
1788
1789
c906108c
SS
1790/* Does the target include all of memory, or only part of it? This
1791 determines whether we look up the target chain for other parts of
1792 memory if this target can't satisfy a request. */
1793
c35b1492
PA
1794extern int target_has_all_memory_1 (void);
1795#define target_has_all_memory target_has_all_memory_1 ()
c906108c
SS
1796
1797/* Does the target include memory? (Dummy targets don't.) */
1798
c35b1492
PA
1799extern int target_has_memory_1 (void);
1800#define target_has_memory target_has_memory_1 ()
c906108c
SS
1801
1802/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1803 we start a process.) */
c5aa993b 1804
c35b1492
PA
1805extern int target_has_stack_1 (void);
1806#define target_has_stack target_has_stack_1 ()
c906108c
SS
1807
1808/* Does the target have registers? (Exec files don't.) */
1809
c35b1492
PA
1810extern int target_has_registers_1 (void);
1811#define target_has_registers target_has_registers_1 ()
c906108c
SS
1812
1813/* Does the target have execution? Can we make it jump (through
52bb452f
DJ
1814 hoops), or pop its stack a few times? This means that the current
1815 target is currently executing; for some targets, that's the same as
1816 whether or not the target is capable of execution, but there are
1817 also targets which can be current while not executing. In that
b3ccfe11
TT
1818 case this will become true after to_create_inferior or
1819 to_attach. */
c906108c 1820
5018ce90 1821extern bool target_has_execution_1 (inferior *inf);
aeaec162 1822
5018ce90
PA
1823/* Like target_has_execution_1, but always passes
1824 current_inferior(). */
aeaec162
TT
1825
1826extern int target_has_execution_current (void);
1827
1828#define target_has_execution target_has_execution_current ()
c35b1492 1829
c906108c 1830/* Can the target support the debugger control of thread execution?
d6350901 1831 Can it lock the thread scheduler? */
c906108c
SS
1832
1833#define target_can_lock_scheduler \
8b88a78e 1834 (current_top_target ()->get_thread_control_capabilities () & tc_schedlock)
c906108c 1835
329ea579 1836/* Controls whether async mode is permitted. */
491144b5 1837extern bool target_async_permitted;
c6ebd6cf 1838
c378eb4e 1839/* Can the target support asynchronous execution? */
8b88a78e 1840#define target_can_async_p() (current_top_target ()->can_async_p ())
6426a772 1841
c378eb4e 1842/* Is the target in asynchronous execution mode? */
8b88a78e 1843#define target_is_async_p() (current_top_target ()->is_async_p ())
6426a772 1844
6a3753b3 1845/* Enables/disabled async target events. */
372316f1 1846extern void target_async (int enable);
43ff13b4 1847
65706a29
PA
1848/* Enables/disables thread create and exit events. */
1849extern void target_thread_events (int enable);
1850
fbea99ea
PA
1851/* Whether support for controlling the target backends always in
1852 non-stop mode is enabled. */
1853extern enum auto_boolean target_non_stop_enabled;
1854
1855/* Is the target in non-stop mode? Some targets control the inferior
1856 in non-stop mode even with "set non-stop off". Always true if "set
1857 non-stop" is on. */
1858extern int target_is_non_stop_p (void);
1859
a0714d30
TBA
1860/* Return true if at least one inferior has a non-stop target. */
1861extern bool exists_non_stop_target ();
1862
32231432 1863#define target_execution_direction() \
8b88a78e 1864 (current_top_target ()->execution_direction ())
32231432 1865
c906108c
SS
1866/* Converts a process id to a string. Usually, the string just contains
1867 `process xyz', but on some systems it may contain
1868 `process xyz thread abc'. */
1869
a068643d 1870extern std::string target_pid_to_str (ptid_t ptid);
c906108c 1871
a068643d 1872extern std::string normal_pid_to_str (ptid_t ptid);
c5aa993b 1873
0d06e24b
JM
1874/* Return a short string describing extra information about PID,
1875 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1876 is okay. */
1877
1878#define target_extra_thread_info(TP) \
8b88a78e 1879 (current_top_target ()->extra_thread_info (TP))
ed9a39eb 1880
79efa585
SM
1881/* Return the thread's name, or NULL if the target is unable to determine it.
1882 The returned value must not be freed by the caller. */
4694da01 1883
73ede765 1884extern const char *target_thread_name (struct thread_info *);
4694da01 1885
e04ee09e
KB
1886/* Given a pointer to a thread library specific thread handle and
1887 its length, return a pointer to the corresponding thread_info struct. */
1888
1889extern struct thread_info *target_thread_handle_to_thread_info
1890 (const gdb_byte *thread_handle, int handle_len, struct inferior *inf);
1891
3d6c6204
KB
1892/* Given a thread, return the thread handle, a target-specific sequence of
1893 bytes which serves as a thread identifier within the program being
1894 debugged. */
1895extern gdb::byte_vector target_thread_info_to_thread_handle
1896 (struct thread_info *);
1897
c906108c
SS
1898/* Attempts to find the pathname of the executable file
1899 that was run to create a specified process.
1900
1901 The process PID must be stopped when this operation is used.
c5aa993b 1902
c906108c
SS
1903 If the executable file cannot be determined, NULL is returned.
1904
1905 Else, a pointer to a character string containing the pathname
1906 is returned. This string should be copied into a buffer by
1907 the client if the string will not be immediately used, or if
0d06e24b 1908 it must persist. */
c906108c
SS
1909
1910#define target_pid_to_exec_file(pid) \
8b88a78e 1911 (current_top_target ()->pid_to_exec_file) (pid)
c906108c 1912
3a8f7b07 1913/* See the to_thread_architecture description in struct target_ops. */
c2250ad1
UW
1914
1915#define target_thread_architecture(ptid) \
8b88a78e 1916 (current_top_target ()->thread_architecture (ptid))
c2250ad1 1917
be4d1333
MS
1918/*
1919 * Iterator function for target memory regions.
1920 * Calls a callback function once for each memory region 'mapped'
1921 * in the child process. Defined as a simple macro rather than
2146d243 1922 * as a function macro so that it can be tested for nullity.
be4d1333
MS
1923 */
1924
1925#define target_find_memory_regions(FUNC, DATA) \
8b88a78e 1926 (current_top_target ()->find_memory_regions) (FUNC, DATA)
be4d1333
MS
1927
1928/*
1929 * Compose corefile .note section.
1930 */
1931
1932#define target_make_corefile_notes(BFD, SIZE_P) \
8b88a78e 1933 (current_top_target ()->make_corefile_notes) (BFD, SIZE_P)
be4d1333 1934
6b04bdb7
MS
1935/* Bookmark interfaces. */
1936#define target_get_bookmark(ARGS, FROM_TTY) \
8b88a78e 1937 (current_top_target ()->get_bookmark) (ARGS, FROM_TTY)
6b04bdb7
MS
1938
1939#define target_goto_bookmark(ARG, FROM_TTY) \
8b88a78e 1940 (current_top_target ()->goto_bookmark) (ARG, FROM_TTY)
6b04bdb7 1941
c906108c
SS
1942/* Hardware watchpoint interfaces. */
1943
7ea65f08
PA
1944/* GDB's current model is that there are three "kinds" of watchpoints,
1945 with respect to when they trigger and how you can move past them.
1946
1947 Those are: continuable, steppable, and non-steppable.
1948
1949 Continuable watchpoints are like x86's -- those trigger after the
1950 memory access's side effects are fully committed to memory. I.e.,
1951 they trap with the PC pointing at the next instruction already.
1952 Continuing past such a watchpoint is doable by just normally
1953 continuing, hence the name.
1954
1955 Both steppable and non-steppable watchpoints trap before the memory
1956 access. I.e, the PC points at the instruction that is accessing
1957 the memory. So GDB needs to single-step once past the current
1958 instruction in order to make the access effective and check whether
1959 the instruction's side effects change the watched expression.
1960
1961 Now, in order to step past that instruction, depending on
1962 architecture and target, you can have two situations:
1963
1964 - steppable watchpoints: you can single-step with the watchpoint
1965 still armed, and the watchpoint won't trigger again.
1966
1967 - non-steppable watchpoints: if you try to single-step with the
1968 watchpoint still armed, you'd trap the watchpoint again and the
1969 thread wouldn't make any progress. So GDB needs to temporarily
1970 remove the watchpoint in order to step past it.
1971
1972 If your target/architecture does not signal that it has either
1973 steppable or non-steppable watchpoints via either
1974 target_have_steppable_watchpoint or
1975 gdbarch_have_nonsteppable_watchpoint, GDB assumes continuable
1976 watchpoints. */
1977
c906108c 1978/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
7f82dfc7 1979 write). Only the INFERIOR_PTID task is being queried. */
c906108c 1980
6a109b6b 1981#define target_stopped_by_watchpoint() \
8b88a78e 1982 ((current_top_target ()->stopped_by_watchpoint) ())
7df1a324 1983
1cf4d951
PA
1984/* Returns non-zero if the target stopped because it executed a
1985 software breakpoint instruction. */
1986
1987#define target_stopped_by_sw_breakpoint() \
8b88a78e 1988 ((current_top_target ()->stopped_by_sw_breakpoint) ())
1cf4d951
PA
1989
1990#define target_supports_stopped_by_sw_breakpoint() \
8b88a78e 1991 ((current_top_target ()->supports_stopped_by_sw_breakpoint) ())
1cf4d951
PA
1992
1993#define target_stopped_by_hw_breakpoint() \
8b88a78e 1994 ((current_top_target ()->stopped_by_hw_breakpoint) ())
1cf4d951
PA
1995
1996#define target_supports_stopped_by_hw_breakpoint() \
8b88a78e 1997 ((current_top_target ()->supports_stopped_by_hw_breakpoint) ())
1cf4d951 1998
74174d2e
UW
1999/* Non-zero if we have steppable watchpoints */
2000
d92524f1 2001#define target_have_steppable_watchpoint \
8b88a78e 2002 (current_top_target ()->have_steppable_watchpoint ())
74174d2e 2003
ccaa32c7 2004/* Provide defaults for hardware watchpoint functions. */
c906108c 2005
2146d243 2006/* If the *_hw_beakpoint functions have not been defined
ccaa32c7 2007 elsewhere use the definitions in the target vector. */
c906108c 2008
059790a0
YQ
2009/* Returns positive if we can set a hardware watchpoint of type TYPE.
2010 Returns negative if the target doesn't have enough hardware debug
2011 registers available. Return zero if hardware watchpoint of type
2012 TYPE isn't supported. TYPE is one of bp_hardware_watchpoint,
2013 bp_read_watchpoint, bp_write_watchpoint, or bp_hardware_breakpoint.
2014 CNT is the number of such watchpoints used so far, including this
2343b78a
JM
2015 one. OTHERTYPE is the number of watchpoints of other types than
2016 this one used so far. */
c906108c 2017
d92524f1 2018#define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
8b88a78e 2019 (current_top_target ()->can_use_hw_breakpoint) ( \
059790a0 2020 TYPE, CNT, OTHERTYPE)
c906108c 2021
e09342b5
TJB
2022/* Returns the number of debug registers needed to watch the given
2023 memory region, or zero if not supported. */
2024
d92524f1 2025#define target_region_ok_for_hw_watchpoint(addr, len) \
8b88a78e 2026 (current_top_target ()->region_ok_for_hw_watchpoint) (addr, len)
e0d24f8d 2027
c906108c 2028
750ce8d1 2029#define target_can_do_single_step() \
8b88a78e 2030 (current_top_target ()->can_do_single_step) ()
750ce8d1 2031
85d721b8
PA
2032/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
2033 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
0cf6dd15 2034 COND is the expression for its condition, or NULL if there's none.
85d721b8
PA
2035 Returns 0 for success, 1 if the watchpoint type is not supported,
2036 -1 for failure. */
c906108c 2037
0cf6dd15 2038#define target_insert_watchpoint(addr, len, type, cond) \
8b88a78e 2039 (current_top_target ()->insert_watchpoint) (addr, len, type, cond)
c906108c 2040
0cf6dd15 2041#define target_remove_watchpoint(addr, len, type, cond) \
8b88a78e 2042 (current_top_target ()->remove_watchpoint) (addr, len, type, cond)
c906108c 2043
9c06b0b4
TJB
2044/* Insert a new masked watchpoint at ADDR using the mask MASK.
2045 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
2046 or hw_access for an access watchpoint. Returns 0 for success, 1 if
2047 masked watchpoints are not supported, -1 for failure. */
2048
f4b0a671
SM
2049extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR,
2050 enum target_hw_bp_type);
9c06b0b4
TJB
2051
2052/* Remove a masked watchpoint at ADDR with the mask MASK.
2053 RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
2054 or hw_access for an access watchpoint. Returns 0 for success, non-zero
2055 for failure. */
2056
f4b0a671
SM
2057extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR,
2058 enum target_hw_bp_type);
9c06b0b4 2059
0000e5cc
PA
2060/* Insert a hardware breakpoint at address BP_TGT->placed_address in
2061 the target machine. Returns 0 for success, and returns non-zero or
2062 throws an error (with a detailed failure reason error code and
2063 message) otherwise. */
2064
a6d9a66e 2065#define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
8b88a78e 2066 (current_top_target ()->insert_hw_breakpoint) (gdbarch, bp_tgt)
ccaa32c7 2067
a6d9a66e 2068#define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
8b88a78e 2069 (current_top_target ()->remove_hw_breakpoint) (gdbarch, bp_tgt)
c906108c 2070
f1310107
TJB
2071/* Return number of debug registers needed for a ranged breakpoint,
2072 or -1 if ranged breakpoints are not supported. */
2073
2074extern int target_ranged_break_num_registers (void);
2075
7f82dfc7
JK
2076/* Return non-zero if target knows the data address which triggered this
2077 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
2078 INFERIOR_PTID task is being queried. */
2079#define target_stopped_data_address(target, addr_p) \
f6ac5f3d 2080 (target)->stopped_data_address (addr_p)
c906108c 2081
9b3e86b1
MR
2082/* Return non-zero if ADDR is within the range of a watchpoint spanning
2083 LENGTH bytes beginning at START. */
5009afc5 2084#define target_watchpoint_addr_within_range(target, addr, start, length) \
f6ac5f3d 2085 (target)->watchpoint_addr_within_range (addr, start, length)
5009afc5 2086
0cf6dd15
TJB
2087/* Return non-zero if the target is capable of using hardware to evaluate
2088 the condition expression. In this case, if the condition is false when
2089 the watched memory location changes, execution may continue without the
2090 debugger being notified.
2091
2092 Due to limitations in the hardware implementation, it may be capable of
2093 avoiding triggering the watchpoint in some cases where the condition
2094 expression is false, but may report some false positives as well.
2095 For this reason, GDB will still evaluate the condition expression when
2096 the watchpoint triggers. */
2097#define target_can_accel_watchpoint_condition(addr, len, type, cond) \
8b88a78e 2098 (current_top_target ()->can_accel_watchpoint_condition) (addr, len, type, cond)
0cf6dd15 2099
9c06b0b4
TJB
2100/* Return number of debug registers needed for a masked watchpoint,
2101 -1 if masked watchpoints are not supported or -2 if the given address
2102 and mask combination cannot be used. */
2103
2104extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
2105
b2175913
MS
2106/* Target can execute in reverse? */
2107#define target_can_execute_reverse \
8b88a78e 2108 current_top_target ()->can_execute_reverse ()
b2175913 2109
424163ea
DJ
2110extern const struct target_desc *target_read_description (struct target_ops *);
2111
0ef643c8 2112#define target_get_ada_task_ptid(lwp, tid) \
8b88a78e 2113 (current_top_target ()->get_ada_task_ptid) (lwp,tid)
0ef643c8 2114
08388c79
DE
2115/* Utility implementation of searching memory. */
2116extern int simple_search_memory (struct target_ops* ops,
2117 CORE_ADDR start_addr,
2118 ULONGEST search_space_len,
2119 const gdb_byte *pattern,
2120 ULONGEST pattern_len,
2121 CORE_ADDR *found_addrp);
2122
2123/* Main entry point for searching memory. */
2124extern int target_search_memory (CORE_ADDR start_addr,
2125 ULONGEST search_space_len,
2126 const gdb_byte *pattern,
2127 ULONGEST pattern_len,
2128 CORE_ADDR *found_addrp);
2129
7313baad
UW
2130/* Target file operations. */
2131
07c138c8
GB
2132/* Return nonzero if the filesystem seen by the current inferior
2133 is the local filesystem, zero otherwise. */
4bd7dc42 2134#define target_filesystem_is_local() \
8b88a78e 2135 current_top_target ()->filesystem_is_local ()
4bd7dc42 2136
07c138c8 2137/* Open FILENAME on the target, in the filesystem as seen by INF,
4111f652
PA
2138 using FLAGS and MODE. If INF is NULL, use the filesystem seen by
2139 the debugger (GDB or, for remote targets, the remote stub). Return
2140 a target file descriptor, or -1 if an error occurs (and set
2141 *TARGET_ERRNO). If WARN_IF_SLOW is true, print a warning message
2142 if the file is being accessed over a link that may be slow. */
07c138c8
GB
2143extern int target_fileio_open (struct inferior *inf,
2144 const char *filename, int flags,
4111f652
PA
2145 int mode, bool warn_if_slow,
2146 int *target_errno);
4313b8c0 2147
7313baad
UW
2148/* Write up to LEN bytes from WRITE_BUF to FD on the target.
2149 Return the number of bytes written, or -1 if an error occurs
2150 (and set *TARGET_ERRNO). */
2151extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
2152 ULONGEST offset, int *target_errno);
2153
2154/* Read up to LEN bytes FD on the target into READ_BUF.
2155 Return the number of bytes read, or -1 if an error occurs
2156 (and set *TARGET_ERRNO). */
2157extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
2158 ULONGEST offset, int *target_errno);
2159
9b15c1f0
GB
2160/* Get information about the file opened as FD on the target
2161 and put it in SB. Return 0 on success, or -1 if an error
2162 occurs (and set *TARGET_ERRNO). */
2163extern int target_fileio_fstat (int fd, struct stat *sb,
2164 int *target_errno);
2165
7313baad
UW
2166/* Close FD on the target. Return 0, or -1 if an error occurs
2167 (and set *TARGET_ERRNO). */
2168extern int target_fileio_close (int fd, int *target_errno);
2169
07c138c8
GB
2170/* Unlink FILENAME on the target, in the filesystem as seen by INF.
2171 If INF is NULL, use the filesystem seen by the debugger (GDB or,
2172 for remote targets, the remote stub). Return 0, or -1 if an error
7313baad 2173 occurs (and set *TARGET_ERRNO). */
07c138c8
GB
2174extern int target_fileio_unlink (struct inferior *inf,
2175 const char *filename,
2176 int *target_errno);
2177
2178/* Read value of symbolic link FILENAME on the target, in the
2179 filesystem as seen by INF. If INF is NULL, use the filesystem seen
2180 by the debugger (GDB or, for remote targets, the remote stub).
2181 Return a null-terminated string allocated via xmalloc, or NULL if
2182 an error occurs (and set *TARGET_ERRNO). */
e0d3522b
TT
2183extern gdb::optional<std::string> target_fileio_readlink
2184 (struct inferior *inf, const char *filename, int *target_errno);
07c138c8
GB
2185
2186/* Read target file FILENAME, in the filesystem as seen by INF. If
2187 INF is NULL, use the filesystem seen by the debugger (GDB or, for
2188 remote targets, the remote stub). The return value will be -1 if
2189 the transfer fails or is not supported; 0 if the object is empty;
2190 or the length of the object otherwise. If a positive value is
2191 returned, a sufficiently large buffer will be allocated using
2192 xmalloc and returned in *BUF_P containing the contents of the
2193 object.
7313baad
UW
2194
2195 This method should be used for objects sufficiently small to store
2196 in a single xmalloc'd buffer, when no fixed bound on the object's
2197 size is known in advance. */
07c138c8
GB
2198extern LONGEST target_fileio_read_alloc (struct inferior *inf,
2199 const char *filename,
7313baad
UW
2200 gdb_byte **buf_p);
2201
db1ff28b
JK
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 result is NUL-terminated and
2205 returned as a string, allocated using xmalloc. If an error occurs
2206 or the transfer is unsupported, NULL is returned. Empty objects
2207 are returned as allocated but empty strings. A warning is issued
2208 if the result contains any embedded NUL bytes. */
87028b87
TT
2209extern gdb::unique_xmalloc_ptr<char> target_fileio_read_stralloc
2210 (struct inferior *inf, const char *filename);
db1ff28b 2211
7313baad 2212
35b1e5cc
SS
2213/* Tracepoint-related operations. */
2214
2215#define target_trace_init() \
8b88a78e 2216 (current_top_target ()->trace_init) ()
35b1e5cc
SS
2217
2218#define target_download_tracepoint(t) \
8b88a78e 2219 (current_top_target ()->download_tracepoint) (t)
35b1e5cc 2220
1e4d1764 2221#define target_can_download_tracepoint() \
8b88a78e 2222 (current_top_target ()->can_download_tracepoint) ()
1e4d1764 2223
35b1e5cc 2224#define target_download_trace_state_variable(tsv) \
8b88a78e 2225 (current_top_target ()->download_trace_state_variable) (tsv)
35b1e5cc 2226
d248b706 2227#define target_enable_tracepoint(loc) \
8b88a78e 2228 (current_top_target ()->enable_tracepoint) (loc)
d248b706
KY
2229
2230#define target_disable_tracepoint(loc) \
8b88a78e 2231 (current_top_target ()->disable_tracepoint) (loc)
d248b706 2232
35b1e5cc 2233#define target_trace_start() \
8b88a78e 2234 (current_top_target ()->trace_start) ()
35b1e5cc
SS
2235
2236#define target_trace_set_readonly_regions() \
8b88a78e 2237 (current_top_target ()->trace_set_readonly_regions) ()
35b1e5cc 2238
00bf0b85 2239#define target_get_trace_status(ts) \
8b88a78e 2240 (current_top_target ()->get_trace_status) (ts)
35b1e5cc 2241
f196051f 2242#define target_get_tracepoint_status(tp,utp) \
8b88a78e 2243 (current_top_target ()->get_tracepoint_status) (tp, utp)
f196051f 2244
35b1e5cc 2245#define target_trace_stop() \
8b88a78e 2246 (current_top_target ()->trace_stop) ()
35b1e5cc
SS
2247
2248#define target_trace_find(type,num,addr1,addr2,tpp) \
8b88a78e 2249 (current_top_target ()->trace_find) (\
bd4c6793 2250 (type), (num), (addr1), (addr2), (tpp))
35b1e5cc
SS
2251
2252#define target_get_trace_state_variable_value(tsv,val) \
8b88a78e 2253 (current_top_target ()->get_trace_state_variable_value) ((tsv), (val))
35b1e5cc 2254
00bf0b85 2255#define target_save_trace_data(filename) \
8b88a78e 2256 (current_top_target ()->save_trace_data) (filename)
00bf0b85
SS
2257
2258#define target_upload_tracepoints(utpp) \
8b88a78e 2259 (current_top_target ()->upload_tracepoints) (utpp)
00bf0b85
SS
2260
2261#define target_upload_trace_state_variables(utsvp) \
8b88a78e 2262 (current_top_target ()->upload_trace_state_variables) (utsvp)
00bf0b85
SS
2263
2264#define target_get_raw_trace_data(buf,offset,len) \
8b88a78e 2265 (current_top_target ()->get_raw_trace_data) ((buf), (offset), (len))
00bf0b85 2266
405f8e94 2267#define target_get_min_fast_tracepoint_insn_len() \
8b88a78e 2268 (current_top_target ()->get_min_fast_tracepoint_insn_len) ()
405f8e94 2269
35b1e5cc 2270#define target_set_disconnected_tracing(val) \
8b88a78e 2271 (current_top_target ()->set_disconnected_tracing) (val)
35b1e5cc 2272
4daf5ac0 2273#define target_set_circular_trace_buffer(val) \
8b88a78e 2274 (current_top_target ()->set_circular_trace_buffer) (val)
4daf5ac0 2275
f6f899bf 2276#define target_set_trace_buffer_size(val) \
8b88a78e 2277 (current_top_target ()->set_trace_buffer_size) (val)
f6f899bf 2278
f196051f 2279#define target_set_trace_notes(user,notes,stopnotes) \
8b88a78e 2280 (current_top_target ()->set_trace_notes) ((user), (notes), (stopnotes))
f196051f 2281
711e434b 2282#define target_get_tib_address(ptid, addr) \
8b88a78e 2283 (current_top_target ()->get_tib_address) ((ptid), (addr))
711e434b 2284
d914c394 2285#define target_set_permissions() \
8b88a78e 2286 (current_top_target ()->set_permissions) ()
d914c394 2287
0fb4aa4b 2288#define target_static_tracepoint_marker_at(addr, marker) \
8b88a78e 2289 (current_top_target ()->static_tracepoint_marker_at) (addr, marker)
0fb4aa4b
PA
2290
2291#define target_static_tracepoint_markers_by_strid(marker_id) \
8b88a78e 2292 (current_top_target ()->static_tracepoint_markers_by_strid) (marker_id)
0fb4aa4b 2293
b3b9301e 2294#define target_traceframe_info() \
8b88a78e 2295 (current_top_target ()->traceframe_info) ()
b3b9301e 2296
d1feda86 2297#define target_use_agent(use) \
8b88a78e 2298 (current_top_target ()->use_agent) (use)
d1feda86
YQ
2299
2300#define target_can_use_agent() \
8b88a78e 2301 (current_top_target ()->can_use_agent) ()
d1feda86 2302
ced63ec0 2303#define target_augmented_libraries_svr4_read() \
8b88a78e 2304 (current_top_target ()->augmented_libraries_svr4_read) ()
ced63ec0 2305
49d03eab
MR
2306/* Command logging facility. */
2307
d9cb0195 2308#define target_log_command(p) \
8b88a78e 2309 (current_top_target ()->log_command) (p)
49d03eab 2310
dc146f7c
VP
2311
2312extern int target_core_of_thread (ptid_t ptid);
2313
ea001bdc
MM
2314/* See to_get_unwinder in struct target_ops. */
2315extern const struct frame_unwind *target_get_unwinder (void);
2316
2317/* See to_get_tailcall_unwinder in struct target_ops. */
2318extern const struct frame_unwind *target_get_tailcall_unwinder (void);
2319
936d2992
PA
2320/* This implements basic memory verification, reading target memory
2321 and performing the comparison here (as opposed to accelerated
2322 verification making use of the qCRC packet, for example). */
2323
2324extern int simple_verify_memory (struct target_ops* ops,
2325 const gdb_byte *data,
2326 CORE_ADDR memaddr, ULONGEST size);
2327
4a5e7a5b
PA
2328/* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
2329 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
2330 if there's a mismatch, and -1 if an error is encountered while
2331 reading memory. Throws an error if the functionality is found not
2332 to be supported by the current target. */
2333int target_verify_memory (const gdb_byte *data,
2334 CORE_ADDR memaddr, ULONGEST size);
2335
c906108c
SS
2336/* Routines for maintenance of the target structures...
2337
2338 add_target: Add a target to the list of all possible targets.
3156469c
JB
2339 This only makes sense for targets that should be activated using
2340 the "target TARGET_NAME ..." command.
c906108c
SS
2341
2342 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
2343 targets, within its particular stratum of the stack. Result
2344 is 0 if now atop the stack, nonzero if not on top (maybe
2345 should warn user).
c906108c
SS
2346
2347 unpush_target: Remove this from the stack of currently used targets,
c5aa993b 2348 no matter where it is on the list. Returns 0 if no
7fdc1521 2349 change, 1 if removed from stack. */
c906108c 2350
d9f719f1
PA
2351/* Type of callback called when the user activates a target with
2352 "target TARGET_NAME". The callback routine takes the rest of the
2353 parameters from the command, and (if successful) pushes a new
2354 target onto the stack. */
2355typedef void target_open_ftype (const char *args, int from_tty);
2356
2357/* Add the target described by INFO to the list of possible targets
2358 and add a new command 'target $(INFO->shortname)'. Set COMPLETER
2359 as the command's completer if not NULL. */
c906108c 2360
d9f719f1
PA
2361extern void add_target (const target_info &info,
2362 target_open_ftype *func,
2363 completer_ftype *completer = NULL);
9852c492 2364
d9f719f1
PA
2365/* Adds a command ALIAS for the target described by INFO and marks it
2366 deprecated. This is useful for maintaining backwards compatibility
2367 when renaming targets. */
b48d48eb 2368
d9f719f1 2369extern void add_deprecated_target_alias (const target_info &info,
a121b7c1 2370 const char *alias);
b48d48eb 2371
b26a4dcb 2372extern void push_target (struct target_ops *);
c906108c 2373
dea57a62
TT
2374/* An overload that deletes the target on failure. */
2375extern void push_target (target_ops_up &&);
2376
a14ed312 2377extern int unpush_target (struct target_ops *);
c906108c 2378
fd79ecee
DJ
2379extern void target_pre_inferior (int);
2380
a14ed312 2381extern void target_preopen (int);
c906108c 2382
460014f5
JK
2383/* Does whatever cleanup is required to get rid of all pushed targets. */
2384extern void pop_all_targets (void);
aa76d38d 2385
915ef8b1
PA
2386/* Like pop_all_targets, but pops only targets whose stratum is at or
2387 above STRATUM. */
2388extern void pop_all_targets_at_and_above (enum strata stratum);
2389
87ab71f0
PA
2390/* Like pop_all_targets, but pops only targets whose stratum is
2391 strictly above ABOVE_STRATUM. */
460014f5 2392extern void pop_all_targets_above (enum strata above_stratum);
87ab71f0 2393
5b6d1e4f 2394extern bool target_is_pushed (target_ops *t);
c0edd9ed 2395
9e35dae4
DJ
2396extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2397 CORE_ADDR offset);
2398
0542c86d 2399/* Struct target_section maps address ranges to file sections. It is
c906108c
SS
2400 mostly used with BFD files, but can be used without (e.g. for handling
2401 raw disks, or files not in formats handled by BFD). */
2402
0542c86d 2403struct target_section
c5aa993b
JM
2404 {
2405 CORE_ADDR addr; /* Lowest address in section */
2406 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 2407
7be0c536 2408 struct bfd_section *the_bfd_section;
c906108c 2409
046ac79f
JK
2410 /* The "owner" of the section.
2411 It can be any unique value. It is set by add_target_sections
2412 and used by remove_target_sections.
2413 For example, for executables it is a pointer to exec_bfd and
2414 for shlibs it is the so_list pointer. */
2415 void *owner;
c5aa993b 2416 };
c906108c 2417
07b82ea5
PA
2418/* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
2419
2420struct target_section_table
2421{
2422 struct target_section *sections;
2423 struct target_section *sections_end;
2424};
2425
8db32d44 2426/* Return the "section" containing the specified address. */
0542c86d
PA
2427struct target_section *target_section_by_addr (struct target_ops *target,
2428 CORE_ADDR addr);
8db32d44 2429
07b82ea5
PA
2430/* Return the target section table this target (or the targets
2431 beneath) currently manipulate. */
2432
2433extern struct target_section_table *target_get_section_table
2434 (struct target_ops *target);
2435
c906108c
SS
2436/* From mem-break.c */
2437
f6ac5f3d
PA
2438extern int memory_remove_breakpoint (struct target_ops *,
2439 struct gdbarch *, struct bp_target_info *,
73971819 2440 enum remove_bp_reason);
c906108c 2441
f6ac5f3d
PA
2442extern int memory_insert_breakpoint (struct target_ops *,
2443 struct gdbarch *, struct bp_target_info *);
2444
2445/* Convenience template use to add memory breakpoints support to a
2446 target. */
2447
2448template <typename BaseTarget>
2449struct memory_breakpoint_target : public BaseTarget
2450{
2451 int insert_breakpoint (struct gdbarch *gdbarch,
2452 struct bp_target_info *bp_tgt) override
2453 { return memory_insert_breakpoint (this, gdbarch, bp_tgt); }
2454
2455 int remove_breakpoint (struct gdbarch *gdbarch,
2456 struct bp_target_info *bp_tgt,
2457 enum remove_bp_reason reason) override
2458 { return memory_remove_breakpoint (this, gdbarch, bp_tgt, reason); }
2459};
c906108c 2460
08351840
PA
2461/* Check whether the memory at the breakpoint's placed address still
2462 contains the expected breakpoint instruction. */
2463
2464extern int memory_validate_breakpoint (struct gdbarch *gdbarch,
2465 struct bp_target_info *bp_tgt);
2466
3e43a32a
MS
2467extern int default_memory_remove_breakpoint (struct gdbarch *,
2468 struct bp_target_info *);
917317f4 2469
3e43a32a
MS
2470extern int default_memory_insert_breakpoint (struct gdbarch *,
2471 struct bp_target_info *);
917317f4 2472
c906108c
SS
2473
2474/* From target.c */
2475
a14ed312 2476extern void initialize_targets (void);
c906108c 2477
c25c4a8b 2478extern void noprocess (void) ATTRIBUTE_NORETURN;
c906108c 2479
8edfe269
DJ
2480extern void target_require_runnable (void);
2481
8b06beed
TT
2482/* Find the target at STRATUM. If no target is at that stratum,
2483 return NULL. */
2484
2485struct target_ops *find_target_at (enum strata stratum);
2486
9018be22
SM
2487/* Read OS data object of type TYPE from the target, and return it in XML
2488 format. The return value follows the same rules as target_read_stralloc. */
e0665bc8 2489
9018be22 2490extern gdb::optional<gdb::char_vector> target_get_osdata (const char *type);
07e059b5 2491
c906108c
SS
2492/* Stuff that should be shared among the various remote targets. */
2493
2494/* Debugging level. 0 is off, and non-zero values mean to print some debug
2495 information (higher values, more information). */
2496extern int remote_debug;
2497
2498/* Speed in bits per second, or -1 which means don't mess with the speed. */
2499extern int baud_rate;
236af5e3
YG
2500
2501/* Parity for serial port */
2502extern int serial_parity;
2503
c378eb4e 2504/* Timeout limit for response from target. */
c906108c
SS
2505extern int remote_timeout;
2506
c906108c 2507\f
c906108c 2508
cb85b21b
TT
2509/* Set the show memory breakpoints mode to show, and return a
2510 scoped_restore to restore it back to the current value. */
2511extern scoped_restore_tmpl<int>
2512 make_scoped_restore_show_memory_breakpoints (int show);
8defab1a 2513
491144b5
CB
2514extern bool may_write_registers;
2515extern bool may_write_memory;
2516extern bool may_insert_breakpoints;
2517extern bool may_insert_tracepoints;
2518extern bool may_insert_fast_tracepoints;
2519extern bool may_stop;
d914c394
SS
2520
2521extern void update_target_permissions (void);
2522
c906108c 2523\f
c378eb4e 2524/* Imported from machine dependent code. */
c906108c 2525
02d27625 2526/* See to_enable_btrace in struct target_ops. */
f4abbc16
MM
2527extern struct btrace_target_info *
2528 target_enable_btrace (ptid_t ptid, const struct btrace_config *);
02d27625
MM
2529
2530/* See to_disable_btrace in struct target_ops. */
2531extern void target_disable_btrace (struct btrace_target_info *btinfo);
2532
2533/* See to_teardown_btrace in struct target_ops. */
2534extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2535
2536/* See to_read_btrace in struct target_ops. */
734b0e4b 2537extern enum btrace_error target_read_btrace (struct btrace_data *,
969c39fb
MM
2538 struct btrace_target_info *,
2539 enum btrace_read_type);
02d27625 2540
f4abbc16
MM
2541/* See to_btrace_conf in struct target_ops. */
2542extern const struct btrace_config *
2543 target_btrace_conf (const struct btrace_target_info *);
2544
7c1687a9
MM
2545/* See to_stop_recording in struct target_ops. */
2546extern void target_stop_recording (void);
2547
d02ed0bb 2548/* See to_save_record in struct target_ops. */
85e1311a 2549extern void target_save_record (const char *filename);
d02ed0bb
MM
2550
2551/* Query if the target supports deleting the execution log. */
2552extern int target_supports_delete_record (void);
2553
2554/* See to_delete_record in struct target_ops. */
2555extern void target_delete_record (void);
2556
b158a20f
TW
2557/* See to_record_method. */
2558extern enum record_method target_record_method (ptid_t ptid);
2559
d02ed0bb 2560/* See to_record_is_replaying in struct target_ops. */
a52eab48 2561extern int target_record_is_replaying (ptid_t ptid);
d02ed0bb 2562
7ff27e9b
MM
2563/* See to_record_will_replay in struct target_ops. */
2564extern int target_record_will_replay (ptid_t ptid, int dir);
2565
797094dd
MM
2566/* See to_record_stop_replaying in struct target_ops. */
2567extern void target_record_stop_replaying (void);
2568
d02ed0bb
MM
2569/* See to_goto_record_begin in struct target_ops. */
2570extern void target_goto_record_begin (void);
2571
2572/* See to_goto_record_end in struct target_ops. */
2573extern void target_goto_record_end (void);
2574
2575/* See to_goto_record in struct target_ops. */
2576extern void target_goto_record (ULONGEST insn);
02d27625 2577
67c86d06 2578/* See to_insn_history. */
9a24775b 2579extern void target_insn_history (int size, gdb_disassembly_flags flags);
67c86d06
MM
2580
2581/* See to_insn_history_from. */
9a24775b
PA
2582extern void target_insn_history_from (ULONGEST from, int size,
2583 gdb_disassembly_flags flags);
67c86d06
MM
2584
2585/* See to_insn_history_range. */
9a24775b
PA
2586extern void target_insn_history_range (ULONGEST begin, ULONGEST end,
2587 gdb_disassembly_flags flags);
67c86d06 2588
15984c13 2589/* See to_call_history. */
0cb7c7b0 2590extern void target_call_history (int size, record_print_flags flags);
15984c13
MM
2591
2592/* See to_call_history_from. */
0cb7c7b0
SM
2593extern void target_call_history_from (ULONGEST begin, int size,
2594 record_print_flags flags);
15984c13
MM
2595
2596/* See to_call_history_range. */
0cb7c7b0
SM
2597extern void target_call_history_range (ULONGEST begin, ULONGEST end,
2598 record_print_flags flags);
15984c13 2599
5fff78c4
MM
2600/* See to_prepare_to_generate_core. */
2601extern void target_prepare_to_generate_core (void);
2602
2603/* See to_done_generating_core. */
2604extern void target_done_generating_core (void);
2605
c5aa993b 2606#endif /* !defined (TARGET_H) */