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