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