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