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