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