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