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