3c8a6161225a4bebc0297b44c30db23604aee036
[deliverable/binutils-gdb.git] / gdb / target.h
1 /* Interface between GDB and target environments, including files and processes
2
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
6
7 Contributed by Cygnus Support. Written by John Gilmore.
8
9 This file is part of GDB.
10
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23
24 #if !defined (TARGET_H)
25 #define TARGET_H
26
27 struct objfile;
28 struct ui_file;
29 struct mem_attrib;
30 struct target_ops;
31 struct bp_target_info;
32 struct regcache;
33 struct target_section_table;
34 struct trace_state_variable;
35 struct trace_status;
36 struct uploaded_tsv;
37 struct uploaded_tp;
38 struct static_tracepoint_marker;
39
40 /* This include file defines the interface between the main part
41 of the debugger, and the part which is target-specific, or
42 specific to the communications interface between us and the
43 target.
44
45 A TARGET is an interface between the debugger and a particular
46 kind of file or process. Targets can be STACKED in STRATA,
47 so that more than one target can potentially respond to a request.
48 In particular, memory accesses will walk down the stack of targets
49 until they find a target that is interested in handling that particular
50 address. STRATA are artificial boundaries on the stack, within
51 which particular kinds of targets live. Strata exist so that
52 people don't get confused by pushing e.g. a process target and then
53 a file target, and wondering why they can't see the current values
54 of variables any more (the file target is handling them and they
55 never get to the process target). So when you push a file target,
56 it goes into the file stratum, which is always below the process
57 stratum. */
58
59 #include "bfd.h"
60 #include "symtab.h"
61 #include "memattr.h"
62 #include "vec.h"
63 #include "gdb_signals.h"
64
65 enum strata
66 {
67 dummy_stratum, /* The lowest of the low */
68 file_stratum, /* Executable files, etc */
69 core_stratum, /* Core dump files */
70 process_stratum, /* Executing processes */
71 thread_stratum, /* Executing threads */
72 record_stratum, /* Support record debugging */
73 arch_stratum /* Architecture overrides */
74 };
75
76 enum thread_control_capabilities
77 {
78 tc_none = 0, /* Default: can't control thread execution. */
79 tc_schedlock = 1, /* Can lock the thread scheduler. */
80 };
81
82 /* Stuff for target_wait. */
83
84 /* Generally, what has the program done? */
85 enum target_waitkind
86 {
87 /* The program has exited. The exit status is in value.integer. */
88 TARGET_WAITKIND_EXITED,
89
90 /* The program has stopped with a signal. Which signal is in
91 value.sig. */
92 TARGET_WAITKIND_STOPPED,
93
94 /* The program has terminated with a signal. Which signal is in
95 value.sig. */
96 TARGET_WAITKIND_SIGNALLED,
97
98 /* The program is letting us know that it dynamically loaded something
99 (e.g. it called load(2) on AIX). */
100 TARGET_WAITKIND_LOADED,
101
102 /* The program has forked. A "related" process' PTID is in
103 value.related_pid. I.e., if the child forks, value.related_pid
104 is the parent's ID. */
105
106 TARGET_WAITKIND_FORKED,
107
108 /* The program has vforked. A "related" process's PTID is in
109 value.related_pid. */
110
111 TARGET_WAITKIND_VFORKED,
112
113 /* The program has exec'ed a new executable file. The new file's
114 pathname is pointed to by value.execd_pathname. */
115
116 TARGET_WAITKIND_EXECD,
117
118 /* The program had previously vforked, and now the child is done
119 with the shared memory region, because it exec'ed or exited.
120 Note that the event is reported to the vfork parent. This is
121 only used if GDB did not stay attached to the vfork child,
122 otherwise, a TARGET_WAITKIND_EXECD or
123 TARGET_WAITKIND_EXIT|SIGNALLED event associated with the child
124 has the same effect. */
125 TARGET_WAITKIND_VFORK_DONE,
126
127 /* The program has entered or returned from a system call. On
128 HP-UX, this is used in the hardware watchpoint implementation.
129 The syscall's unique integer ID number is in value.syscall_id */
130
131 TARGET_WAITKIND_SYSCALL_ENTRY,
132 TARGET_WAITKIND_SYSCALL_RETURN,
133
134 /* Nothing happened, but we stopped anyway. This perhaps should be handled
135 within target_wait, but I'm not sure target_wait should be resuming the
136 inferior. */
137 TARGET_WAITKIND_SPURIOUS,
138
139 /* An event has occured, but we should wait again.
140 Remote_async_wait() returns this when there is an event
141 on the inferior, but the rest of the world is not interested in
142 it. The inferior has not stopped, but has just sent some output
143 to the console, for instance. In this case, we want to go back
144 to the event loop and wait there for another event from the
145 inferior, rather than being stuck in the remote_async_wait()
146 function. This way the event loop is responsive to other events,
147 like for instance the user typing. */
148 TARGET_WAITKIND_IGNORE,
149
150 /* The target has run out of history information,
151 and cannot run backward any further. */
152 TARGET_WAITKIND_NO_HISTORY
153 };
154
155 struct target_waitstatus
156 {
157 enum target_waitkind kind;
158
159 /* Forked child pid, execd pathname, exit status, signal number or
160 syscall number. */
161 union
162 {
163 int integer;
164 enum target_signal sig;
165 ptid_t related_pid;
166 char *execd_pathname;
167 int syscall_number;
168 }
169 value;
170 };
171
172 /* Options that can be passed to target_wait. */
173
174 /* Return immediately if there's no event already queued. If this
175 options is not requested, target_wait blocks waiting for an
176 event. */
177 #define TARGET_WNOHANG 1
178
179 /* The structure below stores information about a system call.
180 It is basically used in the "catch syscall" command, and in
181 every function that gives information about a system call.
182
183 It's also good to mention that its fields represent everything
184 that we currently know about a syscall in GDB. */
185 struct syscall
186 {
187 /* The syscall number. */
188 int number;
189
190 /* The syscall name. */
191 const char *name;
192 };
193
194 /* Return a pretty printed form of target_waitstatus.
195 Space for the result is malloc'd, caller must free. */
196 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
197
198 /* Possible types of events that the inferior handler will have to
199 deal with. */
200 enum inferior_event_type
201 {
202 /* There is a request to quit the inferior, abandon it. */
203 INF_QUIT_REQ,
204 /* Process a normal inferior event which will result in target_wait
205 being called. */
206 INF_REG_EVENT,
207 /* Deal with an error on the inferior. */
208 INF_ERROR,
209 /* We are called because a timer went off. */
210 INF_TIMER,
211 /* We are called to do stuff after the inferior stops. */
212 INF_EXEC_COMPLETE,
213 /* We are called to do some stuff after the inferior stops, but we
214 are expected to reenter the proceed() and
215 handle_inferior_event() functions. This is used only in case of
216 'step n' like commands. */
217 INF_EXEC_CONTINUE
218 };
219 \f
220 /* Target objects which can be transfered using target_read,
221 target_write, et cetera. */
222
223 enum target_object
224 {
225 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
226 TARGET_OBJECT_AVR,
227 /* SPU target specific transfer. See "spu-tdep.c". */
228 TARGET_OBJECT_SPU,
229 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
230 TARGET_OBJECT_MEMORY,
231 /* Memory, avoiding GDB's data cache and trusting the executable.
232 Target implementations of to_xfer_partial never need to handle
233 this object, and most callers should not use it. */
234 TARGET_OBJECT_RAW_MEMORY,
235 /* Memory known to be part of the target's stack. This is cached even
236 if it is not in a region marked as such, since it is known to be
237 "normal" RAM. */
238 TARGET_OBJECT_STACK_MEMORY,
239 /* Kernel Unwind Table. See "ia64-tdep.c". */
240 TARGET_OBJECT_UNWIND_TABLE,
241 /* Transfer auxilliary vector. */
242 TARGET_OBJECT_AUXV,
243 /* StackGhost cookie. See "sparc-tdep.c". */
244 TARGET_OBJECT_WCOOKIE,
245 /* Target memory map in XML format. */
246 TARGET_OBJECT_MEMORY_MAP,
247 /* Flash memory. This object can be used to write contents to
248 a previously erased flash memory. Using it without erasing
249 flash can have unexpected results. Addresses are physical
250 address on target, and not relative to flash start. */
251 TARGET_OBJECT_FLASH,
252 /* Available target-specific features, e.g. registers and coprocessors.
253 See "target-descriptions.c". ANNEX should never be empty. */
254 TARGET_OBJECT_AVAILABLE_FEATURES,
255 /* Currently loaded libraries, in XML format. */
256 TARGET_OBJECT_LIBRARIES,
257 /* Get OS specific data. The ANNEX specifies the type (running
258 processes, etc.). */
259 TARGET_OBJECT_OSDATA,
260 /* Extra signal info. Usually the contents of `siginfo_t' on unix
261 platforms. */
262 TARGET_OBJECT_SIGNAL_INFO,
263 /* The list of threads that are being debugged. */
264 TARGET_OBJECT_THREADS,
265 /* Collected static trace data. */
266 TARGET_OBJECT_STATIC_TRACE_DATA,
267 /* Possible future objects: TARGET_OBJECT_FILE, ... */
268 };
269
270 /* Enumeration of the kinds of traceframe searches that a target may
271 be able to perform. */
272
273 enum trace_find_type
274 {
275 tfind_number,
276 tfind_pc,
277 tfind_tp,
278 tfind_range,
279 tfind_outside,
280 };
281
282 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
283 DEF_VEC_P(static_tracepoint_marker_p);
284
285 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
286 OBJECT. The OFFSET, for a seekable object, specifies the
287 starting point. The ANNEX can be used to provide additional
288 data-specific information to the target.
289
290 Return the number of bytes actually transfered, or -1 if the
291 transfer is not supported or otherwise fails. Return of a positive
292 value less than LEN indicates that no further transfer is possible.
293 Unlike the raw to_xfer_partial interface, callers of these
294 functions do not need to retry partial transfers. */
295
296 extern LONGEST target_read (struct target_ops *ops,
297 enum target_object object,
298 const char *annex, gdb_byte *buf,
299 ULONGEST offset, LONGEST len);
300
301 extern LONGEST target_read_until_error (struct target_ops *ops,
302 enum target_object object,
303 const char *annex, gdb_byte *buf,
304 ULONGEST offset, LONGEST len);
305
306 extern LONGEST target_write (struct target_ops *ops,
307 enum target_object object,
308 const char *annex, const gdb_byte *buf,
309 ULONGEST offset, LONGEST len);
310
311 /* Similar to target_write, except that it also calls PROGRESS with
312 the number of bytes written and the opaque BATON after every
313 successful partial write (and before the first write). This is
314 useful for progress reporting and user interaction while writing
315 data. To abort the transfer, the progress callback can throw an
316 exception. */
317
318 LONGEST target_write_with_progress (struct target_ops *ops,
319 enum target_object object,
320 const char *annex, const gdb_byte *buf,
321 ULONGEST offset, LONGEST len,
322 void (*progress) (ULONGEST, void *),
323 void *baton);
324
325 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
326 be read using OPS. The return value will be -1 if the transfer
327 fails or is not supported; 0 if the object is empty; or the length
328 of the object otherwise. If a positive value is returned, a
329 sufficiently large buffer will be allocated using xmalloc and
330 returned in *BUF_P containing the contents of the object.
331
332 This method should be used for objects sufficiently small to store
333 in a single xmalloc'd buffer, when no fixed bound on the object's
334 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
335 through this function. */
336
337 extern LONGEST target_read_alloc (struct target_ops *ops,
338 enum target_object object,
339 const char *annex, gdb_byte **buf_p);
340
341 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
342 returned as a string, allocated using xmalloc. If an error occurs
343 or the transfer is unsupported, NULL is returned. Empty objects
344 are returned as allocated but empty strings. A warning is issued
345 if the result contains any embedded NUL bytes. */
346
347 extern char *target_read_stralloc (struct target_ops *ops,
348 enum target_object object,
349 const char *annex);
350
351 /* Wrappers to target read/write that perform memory transfers. They
352 throw an error if the memory transfer fails.
353
354 NOTE: cagney/2003-10-23: The naming schema is lifted from
355 "frame.h". The parameter order is lifted from get_frame_memory,
356 which in turn lifted it from read_memory. */
357
358 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
359 gdb_byte *buf, LONGEST len);
360 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
361 CORE_ADDR addr, int len,
362 enum bfd_endian byte_order);
363 \f
364 struct thread_info; /* fwd decl for parameter list below: */
365
366 struct target_ops
367 {
368 struct target_ops *beneath; /* To the target under this one. */
369 char *to_shortname; /* Name this target type */
370 char *to_longname; /* Name for printing */
371 char *to_doc; /* Documentation. Does not include trailing
372 newline, and starts with a one-line descrip-
373 tion (probably similar to to_longname). */
374 /* Per-target scratch pad. */
375 void *to_data;
376 /* The open routine takes the rest of the parameters from the
377 command, and (if successful) pushes a new target onto the
378 stack. Targets should supply this routine, if only to provide
379 an error message. */
380 void (*to_open) (char *, int);
381 /* Old targets with a static target vector provide "to_close".
382 New re-entrant targets provide "to_xclose" and that is expected
383 to xfree everything (including the "struct target_ops"). */
384 void (*to_xclose) (struct target_ops *targ, int quitting);
385 void (*to_close) (int);
386 void (*to_attach) (struct target_ops *ops, char *, int);
387 void (*to_post_attach) (int);
388 void (*to_detach) (struct target_ops *ops, char *, int);
389 void (*to_disconnect) (struct target_ops *, char *, int);
390 void (*to_resume) (struct target_ops *, ptid_t, int, enum target_signal);
391 ptid_t (*to_wait) (struct target_ops *,
392 ptid_t, struct target_waitstatus *, int);
393 void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
394 void (*to_store_registers) (struct target_ops *, struct regcache *, int);
395 void (*to_prepare_to_store) (struct regcache *);
396
397 /* Transfer LEN bytes of memory between GDB address MYADDR and
398 target address MEMADDR. If WRITE, transfer them to the target, else
399 transfer them from the target. TARGET is the target from which we
400 get this function.
401
402 Return value, N, is one of the following:
403
404 0 means that we can't handle this. If errno has been set, it is the
405 error which prevented us from doing it (FIXME: What about bfd_error?).
406
407 positive (call it N) means that we have transferred N bytes
408 starting at MEMADDR. We might be able to handle more bytes
409 beyond this length, but no promises.
410
411 negative (call its absolute value N) means that we cannot
412 transfer right at MEMADDR, but we could transfer at least
413 something at MEMADDR + N.
414
415 NOTE: cagney/2004-10-01: This has been entirely superseeded by
416 to_xfer_partial and inferior inheritance. */
417
418 int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
419 int len, int write,
420 struct mem_attrib *attrib,
421 struct target_ops *target);
422
423 void (*to_files_info) (struct target_ops *);
424 int (*to_insert_breakpoint) (struct gdbarch *, struct bp_target_info *);
425 int (*to_remove_breakpoint) (struct gdbarch *, struct bp_target_info *);
426 int (*to_can_use_hw_breakpoint) (int, int, int);
427 int (*to_insert_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
428 int (*to_remove_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
429 int (*to_remove_watchpoint) (CORE_ADDR, int, int);
430 int (*to_insert_watchpoint) (CORE_ADDR, int, int);
431 int (*to_stopped_by_watchpoint) (void);
432 int to_have_steppable_watchpoint;
433 int to_have_continuable_watchpoint;
434 int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
435 int (*to_watchpoint_addr_within_range) (struct target_ops *,
436 CORE_ADDR, CORE_ADDR, int);
437 int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
438 void (*to_terminal_init) (void);
439 void (*to_terminal_inferior) (void);
440 void (*to_terminal_ours_for_output) (void);
441 void (*to_terminal_ours) (void);
442 void (*to_terminal_save_ours) (void);
443 void (*to_terminal_info) (char *, int);
444 void (*to_kill) (struct target_ops *);
445 void (*to_load) (char *, int);
446 int (*to_lookup_symbol) (char *, CORE_ADDR *);
447 void (*to_create_inferior) (struct target_ops *,
448 char *, char *, char **, int);
449 void (*to_post_startup_inferior) (ptid_t);
450 void (*to_acknowledge_created_inferior) (int);
451 void (*to_insert_fork_catchpoint) (int);
452 int (*to_remove_fork_catchpoint) (int);
453 void (*to_insert_vfork_catchpoint) (int);
454 int (*to_remove_vfork_catchpoint) (int);
455 int (*to_follow_fork) (struct target_ops *, int);
456 void (*to_insert_exec_catchpoint) (int);
457 int (*to_remove_exec_catchpoint) (int);
458 int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
459 int (*to_has_exited) (int, int, int *);
460 void (*to_mourn_inferior) (struct target_ops *);
461 int (*to_can_run) (void);
462 void (*to_notice_signals) (ptid_t ptid);
463 int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
464 void (*to_find_new_threads) (struct target_ops *);
465 char *(*to_pid_to_str) (struct target_ops *, ptid_t);
466 char *(*to_extra_thread_info) (struct thread_info *);
467 void (*to_stop) (ptid_t);
468 void (*to_rcmd) (char *command, struct ui_file *output);
469 char *(*to_pid_to_exec_file) (int pid);
470 void (*to_log_command) (const char *);
471 struct target_section_table *(*to_get_section_table) (struct target_ops *);
472 enum strata to_stratum;
473 int (*to_has_all_memory) (struct target_ops *);
474 int (*to_has_memory) (struct target_ops *);
475 int (*to_has_stack) (struct target_ops *);
476 int (*to_has_registers) (struct target_ops *);
477 int (*to_has_execution) (struct target_ops *);
478 int to_has_thread_control; /* control thread execution */
479 int to_attach_no_wait;
480 /* ASYNC target controls */
481 int (*to_can_async_p) (void);
482 int (*to_is_async_p) (void);
483 void (*to_async) (void (*) (enum inferior_event_type, void *), void *);
484 int (*to_async_mask) (int);
485 int (*to_supports_non_stop) (void);
486 /* find_memory_regions support method for gcore */
487 int (*to_find_memory_regions) (int (*) (CORE_ADDR,
488 unsigned long,
489 int, int, int,
490 void *),
491 void *);
492 /* make_corefile_notes support method for gcore */
493 char * (*to_make_corefile_notes) (bfd *, int *);
494 /* get_bookmark support method for bookmarks */
495 gdb_byte * (*to_get_bookmark) (char *, int);
496 /* goto_bookmark support method for bookmarks */
497 void (*to_goto_bookmark) (gdb_byte *, int);
498 /* Return the thread-local address at OFFSET in the
499 thread-local storage for the thread PTID and the shared library
500 or executable file given by OBJFILE. If that block of
501 thread-local storage hasn't been allocated yet, this function
502 may return an error. */
503 CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
504 ptid_t ptid,
505 CORE_ADDR load_module_addr,
506 CORE_ADDR offset);
507
508 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
509 OBJECT. The OFFSET, for a seekable object, specifies the
510 starting point. The ANNEX can be used to provide additional
511 data-specific information to the target.
512
513 Return the number of bytes actually transfered, zero when no
514 further transfer is possible, and -1 when the transfer is not
515 supported. Return of a positive value smaller than LEN does
516 not indicate the end of the object, only the end of the
517 transfer; higher level code should continue transferring if
518 desired. This is handled in target.c.
519
520 The interface does not support a "retry" mechanism. Instead it
521 assumes that at least one byte will be transfered on each
522 successful call.
523
524 NOTE: cagney/2003-10-17: The current interface can lead to
525 fragmented transfers. Lower target levels should not implement
526 hacks, such as enlarging the transfer, in an attempt to
527 compensate for this. Instead, the target stack should be
528 extended so that it implements supply/collect methods and a
529 look-aside object cache. With that available, the lowest
530 target can safely and freely "push" data up the stack.
531
532 See target_read and target_write for more information. One,
533 and only one, of readbuf or writebuf must be non-NULL. */
534
535 LONGEST (*to_xfer_partial) (struct target_ops *ops,
536 enum target_object object, const char *annex,
537 gdb_byte *readbuf, const gdb_byte *writebuf,
538 ULONGEST offset, LONGEST len);
539
540 /* Returns the memory map for the target. A return value of NULL
541 means that no memory map is available. If a memory address
542 does not fall within any returned regions, it's assumed to be
543 RAM. The returned memory regions should not overlap.
544
545 The order of regions does not matter; target_memory_map will
546 sort regions by starting address. For that reason, this
547 function should not be called directly except via
548 target_memory_map.
549
550 This method should not cache data; if the memory map could
551 change unexpectedly, it should be invalidated, and higher
552 layers will re-fetch it. */
553 VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
554
555 /* Erases the region of flash memory starting at ADDRESS, of
556 length LENGTH.
557
558 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
559 on flash block boundaries, as reported by 'to_memory_map'. */
560 void (*to_flash_erase) (struct target_ops *,
561 ULONGEST address, LONGEST length);
562
563 /* Finishes a flash memory write sequence. After this operation
564 all flash memory should be available for writing and the result
565 of reading from areas written by 'to_flash_write' should be
566 equal to what was written. */
567 void (*to_flash_done) (struct target_ops *);
568
569 /* Describe the architecture-specific features of this target.
570 Returns the description found, or NULL if no description
571 was available. */
572 const struct target_desc *(*to_read_description) (struct target_ops *ops);
573
574 /* Build the PTID of the thread on which a given task is running,
575 based on LWP and THREAD. These values are extracted from the
576 task Private_Data section of the Ada Task Control Block, and
577 their interpretation depends on the target. */
578 ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
579
580 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
581 Return 0 if *READPTR is already at the end of the buffer.
582 Return -1 if there is insufficient buffer for a whole entry.
583 Return 1 if an entry was read into *TYPEP and *VALP. */
584 int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
585 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
586
587 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
588 sequence of bytes in PATTERN with length PATTERN_LEN.
589
590 The result is 1 if found, 0 if not found, and -1 if there was an error
591 requiring halting of the search (e.g. memory read error).
592 If the pattern is found the address is recorded in FOUND_ADDRP. */
593 int (*to_search_memory) (struct target_ops *ops,
594 CORE_ADDR start_addr, ULONGEST search_space_len,
595 const gdb_byte *pattern, ULONGEST pattern_len,
596 CORE_ADDR *found_addrp);
597
598 /* Can target execute in reverse? */
599 int (*to_can_execute_reverse) (void);
600
601 /* Does this target support debugging multiple processes
602 simultaneously? */
603 int (*to_supports_multi_process) (void);
604
605 /* Determine current architecture of thread PTID.
606
607 The target is supposed to determine the architecture of the code where
608 the target is currently stopped at (on Cell, if a target is in spu_run,
609 to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
610 This is architecture used to perform decr_pc_after_break adjustment,
611 and also determines the frame architecture of the innermost frame.
612 ptrace operations need to operate according to target_gdbarch.
613
614 The default implementation always returns target_gdbarch. */
615 struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
616
617 /* Determine current address space of thread PTID.
618
619 The default implementation always returns the inferior's
620 address space. */
621 struct address_space *(*to_thread_address_space) (struct target_ops *,
622 ptid_t);
623
624 /* Tracepoint-related operations. */
625
626 /* Prepare the target for a tracing run. */
627 void (*to_trace_init) (void);
628
629 /* Send full details of a tracepoint to the target. */
630 void (*to_download_tracepoint) (struct breakpoint *t);
631
632 /* Send full details of a trace state variable to the target. */
633 void (*to_download_trace_state_variable) (struct trace_state_variable *tsv);
634
635 /* Inform the target info of memory regions that are readonly
636 (such as text sections), and so it should return data from
637 those rather than look in the trace buffer. */
638 void (*to_trace_set_readonly_regions) (void);
639
640 /* Start a trace run. */
641 void (*to_trace_start) (void);
642
643 /* Get the current status of a tracing run. */
644 int (*to_get_trace_status) (struct trace_status *ts);
645
646 /* Stop a trace run. */
647 void (*to_trace_stop) (void);
648
649 /* Ask the target to find a trace frame of the given type TYPE,
650 using NUM, ADDR1, and ADDR2 as search parameters. Returns the
651 number of the trace frame, and also the tracepoint number at
652 TPP. If no trace frame matches, return -1. May throw if the
653 operation fails. */
654 int (*to_trace_find) (enum trace_find_type type, int num,
655 ULONGEST addr1, ULONGEST addr2, int *tpp);
656
657 /* Get the value of the trace state variable number TSV, returning
658 1 if the value is known and writing the value itself into the
659 location pointed to by VAL, else returning 0. */
660 int (*to_get_trace_state_variable_value) (int tsv, LONGEST *val);
661
662 int (*to_save_trace_data) (const char *filename);
663
664 int (*to_upload_tracepoints) (struct uploaded_tp **utpp);
665
666 int (*to_upload_trace_state_variables) (struct uploaded_tsv **utsvp);
667
668 LONGEST (*to_get_raw_trace_data) (gdb_byte *buf,
669 ULONGEST offset, LONGEST len);
670
671 /* Set the target's tracing behavior in response to unexpected
672 disconnection - set VAL to 1 to keep tracing, 0 to stop. */
673 void (*to_set_disconnected_tracing) (int val);
674 void (*to_set_circular_trace_buffer) (int val);
675
676 /* Return the processor core that thread PTID was last seen on.
677 This information is updated only when:
678 - update_thread_list is called
679 - thread stops
680 If the core cannot be determined -- either for the specified thread, or
681 right now, or in this debug session, or for this target -- return -1. */
682 int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
683
684 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
685 matches the contents of [DATA,DATA+SIZE). Returns 1 if there's
686 a match, 0 if there's a mismatch, and -1 if an error is
687 encountered while reading memory. */
688 int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
689 CORE_ADDR memaddr, ULONGEST size);
690
691 /* Return the address of the start of the Thread Information Block
692 a Windows OS specific feature. */
693 int (*to_get_tib_address) (ptid_t ptid, CORE_ADDR *addr);
694
695 /* Send the new settings of write permission variables. */
696 void (*to_set_permissions) (void);
697
698 /* Look for a static tracepoint marker at ADDR, and fill in MARKER
699 with its details. Return 1 on success, 0 on failure. */
700 int (*to_static_tracepoint_marker_at) (CORE_ADDR,
701 struct static_tracepoint_marker *marker);
702
703 /* Return a vector of all tracepoints markers string id ID, or all
704 markers if ID is NULL. */
705 VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid)
706 (const char *id);
707
708 int to_magic;
709 /* Need sub-structure for target machine related rather than comm related?
710 */
711 };
712
713 /* Magic number for checking ops size. If a struct doesn't end with this
714 number, somebody changed the declaration but didn't change all the
715 places that initialize one. */
716
717 #define OPS_MAGIC 3840
718
719 /* The ops structure for our "current" target process. This should
720 never be NULL. If there is no target, it points to the dummy_target. */
721
722 extern struct target_ops current_target;
723
724 /* Define easy words for doing these operations on our current target. */
725
726 #define target_shortname (current_target.to_shortname)
727 #define target_longname (current_target.to_longname)
728
729 /* Does whatever cleanup is required for a target that we are no
730 longer going to be calling. QUITTING indicates that GDB is exiting
731 and should not get hung on an error (otherwise it is important to
732 perform clean termination, even if it takes a while). This routine
733 is automatically always called when popping the target off the
734 target stack (to_beneath is undefined). Closing file descriptors
735 and freeing all memory allocated memory are typical things it
736 should do. */
737
738 void target_close (struct target_ops *targ, int quitting);
739
740 /* Attaches to a process on the target side. Arguments are as passed
741 to the `attach' command by the user. This routine can be called
742 when the target is not on the target-stack, if the target_can_run
743 routine returns 1; in that case, it must push itself onto the stack.
744 Upon exit, the target should be ready for normal operations, and
745 should be ready to deliver the status of the process immediately
746 (without waiting) to an upcoming target_wait call. */
747
748 void target_attach (char *, int);
749
750 /* Some targets don't generate traps when attaching to the inferior,
751 or their target_attach implementation takes care of the waiting.
752 These targets must set to_attach_no_wait. */
753
754 #define target_attach_no_wait \
755 (current_target.to_attach_no_wait)
756
757 /* The target_attach operation places a process under debugger control,
758 and stops the process.
759
760 This operation provides a target-specific hook that allows the
761 necessary bookkeeping to be performed after an attach completes. */
762 #define target_post_attach(pid) \
763 (*current_target.to_post_attach) (pid)
764
765 /* Takes a program previously attached to and detaches it.
766 The program may resume execution (some targets do, some don't) and will
767 no longer stop on signals, etc. We better not have left any breakpoints
768 in the program or it'll die when it hits one. ARGS is arguments
769 typed by the user (e.g. a signal to send the process). FROM_TTY
770 says whether to be verbose or not. */
771
772 extern void target_detach (char *, int);
773
774 /* Disconnect from the current target without resuming it (leaving it
775 waiting for a debugger). */
776
777 extern void target_disconnect (char *, int);
778
779 /* Resume execution of the target process PTID. STEP says whether to
780 single-step or to run free; SIGGNAL is the signal to be given to
781 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
782 pass TARGET_SIGNAL_DEFAULT. */
783
784 extern void target_resume (ptid_t ptid, int step, enum target_signal signal);
785
786 /* Wait for process pid to do something. PTID = -1 to wait for any
787 pid to do something. Return pid of child, or -1 in case of error;
788 store status through argument pointer STATUS. Note that it is
789 _NOT_ OK to throw_exception() out of target_wait() without popping
790 the debugging target from the stack; GDB isn't prepared to get back
791 to the prompt with a debugging target but without the frame cache,
792 stop_pc, etc., set up. OPTIONS is a bitwise OR of TARGET_W*
793 options. */
794
795 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
796 int options);
797
798 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
799
800 extern void target_fetch_registers (struct regcache *regcache, int regno);
801
802 /* Store at least register REGNO, or all regs if REGNO == -1.
803 It can store as many registers as it wants to, so target_prepare_to_store
804 must have been previously called. Calls error() if there are problems. */
805
806 extern void target_store_registers (struct regcache *regcache, int regs);
807
808 /* Get ready to modify the registers array. On machines which store
809 individual registers, this doesn't need to do anything. On machines
810 which store all the registers in one fell swoop, this makes sure
811 that REGISTERS contains all the registers from the program being
812 debugged. */
813
814 #define target_prepare_to_store(regcache) \
815 (*current_target.to_prepare_to_store) (regcache)
816
817 /* Determine current address space of thread PTID. */
818
819 struct address_space *target_thread_address_space (ptid_t);
820
821 /* Returns true if this target can debug multiple processes
822 simultaneously. */
823
824 #define target_supports_multi_process() \
825 (*current_target.to_supports_multi_process) ()
826
827 /* Invalidate all target dcaches. */
828 extern void target_dcache_invalidate (void);
829
830 extern int target_read_string (CORE_ADDR, char **, int, int *);
831
832 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
833
834 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
835
836 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
837 int len);
838
839 /* Fetches the target's memory map. If one is found it is sorted
840 and returned, after some consistency checking. Otherwise, NULL
841 is returned. */
842 VEC(mem_region_s) *target_memory_map (void);
843
844 /* Erase the specified flash region. */
845 void target_flash_erase (ULONGEST address, LONGEST length);
846
847 /* Finish a sequence of flash operations. */
848 void target_flash_done (void);
849
850 /* Describes a request for a memory write operation. */
851 struct memory_write_request
852 {
853 /* Begining address that must be written. */
854 ULONGEST begin;
855 /* Past-the-end address. */
856 ULONGEST end;
857 /* The data to write. */
858 gdb_byte *data;
859 /* A callback baton for progress reporting for this request. */
860 void *baton;
861 };
862 typedef struct memory_write_request memory_write_request_s;
863 DEF_VEC_O(memory_write_request_s);
864
865 /* Enumeration specifying different flash preservation behaviour. */
866 enum flash_preserve_mode
867 {
868 flash_preserve,
869 flash_discard
870 };
871
872 /* Write several memory blocks at once. This version can be more
873 efficient than making several calls to target_write_memory, in
874 particular because it can optimize accesses to flash memory.
875
876 Moreover, this is currently the only memory access function in gdb
877 that supports writing to flash memory, and it should be used for
878 all cases where access to flash memory is desirable.
879
880 REQUESTS is the vector (see vec.h) of memory_write_request.
881 PRESERVE_FLASH_P indicates what to do with blocks which must be
882 erased, but not completely rewritten.
883 PROGRESS_CB is a function that will be periodically called to provide
884 feedback to user. It will be called with the baton corresponding
885 to the request currently being written. It may also be called
886 with a NULL baton, when preserved flash sectors are being rewritten.
887
888 The function returns 0 on success, and error otherwise. */
889 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
890 enum flash_preserve_mode preserve_flash_p,
891 void (*progress_cb) (ULONGEST, void *));
892
893 /* From infrun.c. */
894
895 extern int inferior_has_forked (ptid_t pid, ptid_t *child_pid);
896
897 extern int inferior_has_vforked (ptid_t pid, ptid_t *child_pid);
898
899 extern int inferior_has_execd (ptid_t pid, char **execd_pathname);
900
901 extern int inferior_has_called_syscall (ptid_t pid, int *syscall_number);
902
903 /* Print a line about the current target. */
904
905 #define target_files_info() \
906 (*current_target.to_files_info) (&current_target)
907
908 /* Insert a breakpoint at address BP_TGT->placed_address in the target
909 machine. Result is 0 for success, or an errno value. */
910
911 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
912 struct bp_target_info *bp_tgt);
913
914 /* Remove a breakpoint at address BP_TGT->placed_address in the target
915 machine. Result is 0 for success, or an errno value. */
916
917 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
918 struct bp_target_info *bp_tgt);
919
920 /* Initialize the terminal settings we record for the inferior,
921 before we actually run the inferior. */
922
923 #define target_terminal_init() \
924 (*current_target.to_terminal_init) ()
925
926 /* Put the inferior's terminal settings into effect.
927 This is preparation for starting or resuming the inferior. */
928
929 extern void target_terminal_inferior (void);
930
931 /* Put some of our terminal settings into effect,
932 enough to get proper results from our output,
933 but do not change into or out of RAW mode
934 so that no input is discarded.
935
936 After doing this, either terminal_ours or terminal_inferior
937 should be called to get back to a normal state of affairs. */
938
939 #define target_terminal_ours_for_output() \
940 (*current_target.to_terminal_ours_for_output) ()
941
942 /* Put our terminal settings into effect.
943 First record the inferior's terminal settings
944 so they can be restored properly later. */
945
946 #define target_terminal_ours() \
947 (*current_target.to_terminal_ours) ()
948
949 /* Save our terminal settings.
950 This is called from TUI after entering or leaving the curses
951 mode. Since curses modifies our terminal this call is here
952 to take this change into account. */
953
954 #define target_terminal_save_ours() \
955 (*current_target.to_terminal_save_ours) ()
956
957 /* Print useful information about our terminal status, if such a thing
958 exists. */
959
960 #define target_terminal_info(arg, from_tty) \
961 (*current_target.to_terminal_info) (arg, from_tty)
962
963 /* Kill the inferior process. Make it go away. */
964
965 extern void target_kill (void);
966
967 /* Load an executable file into the target process. This is expected
968 to not only bring new code into the target process, but also to
969 update GDB's symbol tables to match.
970
971 ARG contains command-line arguments, to be broken down with
972 buildargv (). The first non-switch argument is the filename to
973 load, FILE; the second is a number (as parsed by strtoul (..., ...,
974 0)), which is an offset to apply to the load addresses of FILE's
975 sections. The target may define switches, or other non-switch
976 arguments, as it pleases. */
977
978 extern void target_load (char *arg, int from_tty);
979
980 /* Look up a symbol in the target's symbol table. NAME is the symbol
981 name. ADDRP is a CORE_ADDR * pointing to where the value of the
982 symbol should be returned. The result is 0 if successful, nonzero
983 if the symbol does not exist in the target environment. This
984 function should not call error() if communication with the target
985 is interrupted, since it is called from symbol reading, but should
986 return nonzero, possibly doing a complain(). */
987
988 #define target_lookup_symbol(name, addrp) \
989 (*current_target.to_lookup_symbol) (name, addrp)
990
991 /* Start an inferior process and set inferior_ptid to its pid.
992 EXEC_FILE is the file to run.
993 ALLARGS is a string containing the arguments to the program.
994 ENV is the environment vector to pass. Errors reported with error().
995 On VxWorks and various standalone systems, we ignore exec_file. */
996
997 void target_create_inferior (char *exec_file, char *args,
998 char **env, int from_tty);
999
1000 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1001 notification of inferior events such as fork and vork immediately
1002 after the inferior is created. (This because of how gdb gets an
1003 inferior created via invoking a shell to do it. In such a scenario,
1004 if the shell init file has commands in it, the shell will fork and
1005 exec for each of those commands, and we will see each such fork
1006 event. Very bad.)
1007
1008 Such targets will supply an appropriate definition for this function. */
1009
1010 #define target_post_startup_inferior(ptid) \
1011 (*current_target.to_post_startup_inferior) (ptid)
1012
1013 /* On some targets, the sequence of starting up an inferior requires
1014 some synchronization between gdb and the new inferior process, PID. */
1015
1016 #define target_acknowledge_created_inferior(pid) \
1017 (*current_target.to_acknowledge_created_inferior) (pid)
1018
1019 /* On some targets, we can catch an inferior fork or vfork event when
1020 it occurs. These functions insert/remove an already-created
1021 catchpoint for such events. */
1022
1023 #define target_insert_fork_catchpoint(pid) \
1024 (*current_target.to_insert_fork_catchpoint) (pid)
1025
1026 #define target_remove_fork_catchpoint(pid) \
1027 (*current_target.to_remove_fork_catchpoint) (pid)
1028
1029 #define target_insert_vfork_catchpoint(pid) \
1030 (*current_target.to_insert_vfork_catchpoint) (pid)
1031
1032 #define target_remove_vfork_catchpoint(pid) \
1033 (*current_target.to_remove_vfork_catchpoint) (pid)
1034
1035 /* If the inferior forks or vforks, this function will be called at
1036 the next resume in order to perform any bookkeeping and fiddling
1037 necessary to continue debugging either the parent or child, as
1038 requested, and releasing the other. Information about the fork
1039 or vfork event is available via get_last_target_status ().
1040 This function returns 1 if the inferior should not be resumed
1041 (i.e. there is another event pending). */
1042
1043 int target_follow_fork (int follow_child);
1044
1045 /* On some targets, we can catch an inferior exec event when it
1046 occurs. These functions insert/remove an already-created
1047 catchpoint for such events. */
1048
1049 #define target_insert_exec_catchpoint(pid) \
1050 (*current_target.to_insert_exec_catchpoint) (pid)
1051
1052 #define target_remove_exec_catchpoint(pid) \
1053 (*current_target.to_remove_exec_catchpoint) (pid)
1054
1055 /* Syscall catch.
1056
1057 NEEDED is nonzero if any syscall catch (of any kind) is requested.
1058 If NEEDED is zero, it means the target can disable the mechanism to
1059 catch system calls because there are no more catchpoints of this type.
1060
1061 ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1062 being requested. In this case, both TABLE_SIZE and TABLE should
1063 be ignored.
1064
1065 TABLE_SIZE is the number of elements in TABLE. It only matters if
1066 ANY_COUNT is zero.
1067
1068 TABLE is an array of ints, indexed by syscall number. An element in
1069 this array is nonzero if that syscall should be caught. This argument
1070 only matters if ANY_COUNT is zero. */
1071
1072 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1073 (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
1074 table_size, table)
1075
1076 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
1077 exit code of PID, if any. */
1078
1079 #define target_has_exited(pid,wait_status,exit_status) \
1080 (*current_target.to_has_exited) (pid,wait_status,exit_status)
1081
1082 /* The debugger has completed a blocking wait() call. There is now
1083 some process event that must be processed. This function should
1084 be defined by those targets that require the debugger to perform
1085 cleanup or internal state changes in response to the process event. */
1086
1087 /* The inferior process has died. Do what is right. */
1088
1089 void target_mourn_inferior (void);
1090
1091 /* Does target have enough data to do a run or attach command? */
1092
1093 #define target_can_run(t) \
1094 ((t)->to_can_run) ()
1095
1096 /* post process changes to signal handling in the inferior. */
1097
1098 #define target_notice_signals(ptid) \
1099 (*current_target.to_notice_signals) (ptid)
1100
1101 /* Check to see if a thread is still alive. */
1102
1103 extern int target_thread_alive (ptid_t ptid);
1104
1105 /* Query for new threads and add them to the thread list. */
1106
1107 extern void target_find_new_threads (void);
1108
1109 /* Make target stop in a continuable fashion. (For instance, under
1110 Unix, this should act like SIGSTOP). This function is normally
1111 used by GUIs to implement a stop button. */
1112
1113 extern void target_stop (ptid_t ptid);
1114
1115 /* Send the specified COMMAND to the target's monitor
1116 (shell,interpreter) for execution. The result of the query is
1117 placed in OUTBUF. */
1118
1119 #define target_rcmd(command, outbuf) \
1120 (*current_target.to_rcmd) (command, outbuf)
1121
1122
1123 /* Does the target include all of memory, or only part of it? This
1124 determines whether we look up the target chain for other parts of
1125 memory if this target can't satisfy a request. */
1126
1127 extern int target_has_all_memory_1 (void);
1128 #define target_has_all_memory target_has_all_memory_1 ()
1129
1130 /* Does the target include memory? (Dummy targets don't.) */
1131
1132 extern int target_has_memory_1 (void);
1133 #define target_has_memory target_has_memory_1 ()
1134
1135 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1136 we start a process.) */
1137
1138 extern int target_has_stack_1 (void);
1139 #define target_has_stack target_has_stack_1 ()
1140
1141 /* Does the target have registers? (Exec files don't.) */
1142
1143 extern int target_has_registers_1 (void);
1144 #define target_has_registers target_has_registers_1 ()
1145
1146 /* Does the target have execution? Can we make it jump (through
1147 hoops), or pop its stack a few times? This means that the current
1148 target is currently executing; for some targets, that's the same as
1149 whether or not the target is capable of execution, but there are
1150 also targets which can be current while not executing. In that
1151 case this will become true after target_create_inferior or
1152 target_attach. */
1153
1154 extern int target_has_execution_1 (void);
1155 #define target_has_execution target_has_execution_1 ()
1156
1157 /* Default implementations for process_stratum targets. Return true
1158 if there's a selected inferior, false otherwise. */
1159
1160 extern int default_child_has_all_memory (struct target_ops *ops);
1161 extern int default_child_has_memory (struct target_ops *ops);
1162 extern int default_child_has_stack (struct target_ops *ops);
1163 extern int default_child_has_registers (struct target_ops *ops);
1164 extern int default_child_has_execution (struct target_ops *ops);
1165
1166 /* Can the target support the debugger control of thread execution?
1167 Can it lock the thread scheduler? */
1168
1169 #define target_can_lock_scheduler \
1170 (current_target.to_has_thread_control & tc_schedlock)
1171
1172 /* Should the target enable async mode if it is supported? Temporary
1173 cludge until async mode is a strict superset of sync mode. */
1174 extern int target_async_permitted;
1175
1176 /* Can the target support asynchronous execution? */
1177 #define target_can_async_p() (current_target.to_can_async_p ())
1178
1179 /* Is the target in asynchronous execution mode? */
1180 #define target_is_async_p() (current_target.to_is_async_p ())
1181
1182 int target_supports_non_stop (void);
1183
1184 /* Put the target in async mode with the specified callback function. */
1185 #define target_async(CALLBACK,CONTEXT) \
1186 (current_target.to_async ((CALLBACK), (CONTEXT)))
1187
1188 /* This is to be used ONLY within call_function_by_hand(). It provides
1189 a workaround, to have inferior function calls done in sychronous
1190 mode, even though the target is asynchronous. After
1191 target_async_mask(0) is called, calls to target_can_async_p() will
1192 return FALSE , so that target_resume() will not try to start the
1193 target asynchronously. After the inferior stops, we IMMEDIATELY
1194 restore the previous nature of the target, by calling
1195 target_async_mask(1). After that, target_can_async_p() will return
1196 TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
1197
1198 FIXME ezannoni 1999-12-13: we won't need this once we move
1199 the turning async on and off to the single execution commands,
1200 from where it is done currently, in remote_resume(). */
1201
1202 #define target_async_mask(MASK) \
1203 (current_target.to_async_mask (MASK))
1204
1205 /* Converts a process id to a string. Usually, the string just contains
1206 `process xyz', but on some systems it may contain
1207 `process xyz thread abc'. */
1208
1209 extern char *target_pid_to_str (ptid_t ptid);
1210
1211 extern char *normal_pid_to_str (ptid_t ptid);
1212
1213 /* Return a short string describing extra information about PID,
1214 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1215 is okay. */
1216
1217 #define target_extra_thread_info(TP) \
1218 (current_target.to_extra_thread_info (TP))
1219
1220 /* Attempts to find the pathname of the executable file
1221 that was run to create a specified process.
1222
1223 The process PID must be stopped when this operation is used.
1224
1225 If the executable file cannot be determined, NULL is returned.
1226
1227 Else, a pointer to a character string containing the pathname
1228 is returned. This string should be copied into a buffer by
1229 the client if the string will not be immediately used, or if
1230 it must persist. */
1231
1232 #define target_pid_to_exec_file(pid) \
1233 (current_target.to_pid_to_exec_file) (pid)
1234
1235 /* See the to_thread_architecture description in struct target_ops. */
1236
1237 #define target_thread_architecture(ptid) \
1238 (current_target.to_thread_architecture (&current_target, ptid))
1239
1240 /*
1241 * Iterator function for target memory regions.
1242 * Calls a callback function once for each memory region 'mapped'
1243 * in the child process. Defined as a simple macro rather than
1244 * as a function macro so that it can be tested for nullity.
1245 */
1246
1247 #define target_find_memory_regions(FUNC, DATA) \
1248 (current_target.to_find_memory_regions) (FUNC, DATA)
1249
1250 /*
1251 * Compose corefile .note section.
1252 */
1253
1254 #define target_make_corefile_notes(BFD, SIZE_P) \
1255 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1256
1257 /* Bookmark interfaces. */
1258 #define target_get_bookmark(ARGS, FROM_TTY) \
1259 (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1260
1261 #define target_goto_bookmark(ARG, FROM_TTY) \
1262 (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1263
1264 /* Hardware watchpoint interfaces. */
1265
1266 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1267 write). Only the INFERIOR_PTID task is being queried. */
1268
1269 #define target_stopped_by_watchpoint \
1270 (*current_target.to_stopped_by_watchpoint)
1271
1272 /* Non-zero if we have steppable watchpoints */
1273
1274 #define target_have_steppable_watchpoint \
1275 (current_target.to_have_steppable_watchpoint)
1276
1277 /* Non-zero if we have continuable watchpoints */
1278
1279 #define target_have_continuable_watchpoint \
1280 (current_target.to_have_continuable_watchpoint)
1281
1282 /* Provide defaults for hardware watchpoint functions. */
1283
1284 /* If the *_hw_beakpoint functions have not been defined
1285 elsewhere use the definitions in the target vector. */
1286
1287 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1288 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1289 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1290 (including this one?). OTHERTYPE is who knows what... */
1291
1292 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1293 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
1294
1295 #define target_region_ok_for_hw_watchpoint(addr, len) \
1296 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
1297
1298
1299 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1300 TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1301 Returns 0 for success, 1 if the watchpoint type is not supported,
1302 -1 for failure. */
1303
1304 #define target_insert_watchpoint(addr, len, type) \
1305 (*current_target.to_insert_watchpoint) (addr, len, type)
1306
1307 #define target_remove_watchpoint(addr, len, type) \
1308 (*current_target.to_remove_watchpoint) (addr, len, type)
1309
1310 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1311 (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
1312
1313 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1314 (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
1315
1316 /* Return non-zero if target knows the data address which triggered this
1317 target_stopped_by_watchpoint, in such case place it to *ADDR_P. Only the
1318 INFERIOR_PTID task is being queried. */
1319 #define target_stopped_data_address(target, addr_p) \
1320 (*target.to_stopped_data_address) (target, addr_p)
1321
1322 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1323 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1324
1325 /* Target can execute in reverse? */
1326 #define target_can_execute_reverse \
1327 (current_target.to_can_execute_reverse ? \
1328 current_target.to_can_execute_reverse () : 0)
1329
1330 extern const struct target_desc *target_read_description (struct target_ops *);
1331
1332 #define target_get_ada_task_ptid(lwp, tid) \
1333 (*current_target.to_get_ada_task_ptid) (lwp,tid)
1334
1335 /* Utility implementation of searching memory. */
1336 extern int simple_search_memory (struct target_ops* ops,
1337 CORE_ADDR start_addr,
1338 ULONGEST search_space_len,
1339 const gdb_byte *pattern,
1340 ULONGEST pattern_len,
1341 CORE_ADDR *found_addrp);
1342
1343 /* Main entry point for searching memory. */
1344 extern int target_search_memory (CORE_ADDR start_addr,
1345 ULONGEST search_space_len,
1346 const gdb_byte *pattern,
1347 ULONGEST pattern_len,
1348 CORE_ADDR *found_addrp);
1349
1350 /* Tracepoint-related operations. */
1351
1352 #define target_trace_init() \
1353 (*current_target.to_trace_init) ()
1354
1355 #define target_download_tracepoint(t) \
1356 (*current_target.to_download_tracepoint) (t)
1357
1358 #define target_download_trace_state_variable(tsv) \
1359 (*current_target.to_download_trace_state_variable) (tsv)
1360
1361 #define target_trace_start() \
1362 (*current_target.to_trace_start) ()
1363
1364 #define target_trace_set_readonly_regions() \
1365 (*current_target.to_trace_set_readonly_regions) ()
1366
1367 #define target_get_trace_status(ts) \
1368 (*current_target.to_get_trace_status) (ts)
1369
1370 #define target_trace_stop() \
1371 (*current_target.to_trace_stop) ()
1372
1373 #define target_trace_find(type,num,addr1,addr2,tpp) \
1374 (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1375
1376 #define target_get_trace_state_variable_value(tsv,val) \
1377 (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1378
1379 #define target_save_trace_data(filename) \
1380 (*current_target.to_save_trace_data) (filename)
1381
1382 #define target_upload_tracepoints(utpp) \
1383 (*current_target.to_upload_tracepoints) (utpp)
1384
1385 #define target_upload_trace_state_variables(utsvp) \
1386 (*current_target.to_upload_trace_state_variables) (utsvp)
1387
1388 #define target_get_raw_trace_data(buf,offset,len) \
1389 (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1390
1391 #define target_set_disconnected_tracing(val) \
1392 (*current_target.to_set_disconnected_tracing) (val)
1393
1394 #define target_set_circular_trace_buffer(val) \
1395 (*current_target.to_set_circular_trace_buffer) (val)
1396
1397 #define target_get_tib_address(ptid, addr) \
1398 (*current_target.to_get_tib_address) ((ptid), (addr))
1399
1400 #define target_set_permissions() \
1401 (*current_target.to_set_permissions) ()
1402
1403 #define target_static_tracepoint_marker_at(addr, marker) \
1404 (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1405
1406 #define target_static_tracepoint_markers_by_strid(marker_id) \
1407 (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1408
1409 /* Command logging facility. */
1410
1411 #define target_log_command(p) \
1412 do \
1413 if (current_target.to_log_command) \
1414 (*current_target.to_log_command) (p); \
1415 while (0)
1416
1417
1418 extern int target_core_of_thread (ptid_t ptid);
1419
1420 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1421 the contents of [DATA,DATA+SIZE). Returns 1 if there's a match, 0
1422 if there's a mismatch, and -1 if an error is encountered while
1423 reading memory. Throws an error if the functionality is found not
1424 to be supported by the current target. */
1425 int target_verify_memory (const gdb_byte *data,
1426 CORE_ADDR memaddr, ULONGEST size);
1427
1428 /* Routines for maintenance of the target structures...
1429
1430 add_target: Add a target to the list of all possible targets.
1431
1432 push_target: Make this target the top of the stack of currently used
1433 targets, within its particular stratum of the stack. Result
1434 is 0 if now atop the stack, nonzero if not on top (maybe
1435 should warn user).
1436
1437 unpush_target: Remove this from the stack of currently used targets,
1438 no matter where it is on the list. Returns 0 if no
1439 change, 1 if removed from stack.
1440
1441 pop_target: Remove the top thing on the stack of current targets. */
1442
1443 extern void add_target (struct target_ops *);
1444
1445 extern void push_target (struct target_ops *);
1446
1447 extern int unpush_target (struct target_ops *);
1448
1449 extern void target_pre_inferior (int);
1450
1451 extern void target_preopen (int);
1452
1453 extern void pop_target (void);
1454
1455 /* Does whatever cleanup is required to get rid of all pushed targets.
1456 QUITTING is propagated to target_close; it indicates that GDB is
1457 exiting and should not get hung on an error (otherwise it is
1458 important to perform clean termination, even if it takes a
1459 while). */
1460 extern void pop_all_targets (int quitting);
1461
1462 /* Like pop_all_targets, but pops only targets whose stratum is
1463 strictly above ABOVE_STRATUM. */
1464 extern void pop_all_targets_above (enum strata above_stratum, int quitting);
1465
1466 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1467 CORE_ADDR offset);
1468
1469 /* Struct target_section maps address ranges to file sections. It is
1470 mostly used with BFD files, but can be used without (e.g. for handling
1471 raw disks, or files not in formats handled by BFD). */
1472
1473 struct target_section
1474 {
1475 CORE_ADDR addr; /* Lowest address in section */
1476 CORE_ADDR endaddr; /* 1+highest address in section */
1477
1478 struct bfd_section *the_bfd_section;
1479
1480 bfd *bfd; /* BFD file pointer */
1481 };
1482
1483 /* Holds an array of target sections. Defined by [SECTIONS..SECTIONS_END[. */
1484
1485 struct target_section_table
1486 {
1487 struct target_section *sections;
1488 struct target_section *sections_end;
1489 };
1490
1491 /* Return the "section" containing the specified address. */
1492 struct target_section *target_section_by_addr (struct target_ops *target,
1493 CORE_ADDR addr);
1494
1495 /* Return the target section table this target (or the targets
1496 beneath) currently manipulate. */
1497
1498 extern struct target_section_table *target_get_section_table
1499 (struct target_ops *target);
1500
1501 /* From mem-break.c */
1502
1503 extern int memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
1504
1505 extern int memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
1506
1507 extern int default_memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
1508
1509 extern int default_memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
1510
1511
1512 /* From target.c */
1513
1514 extern void initialize_targets (void);
1515
1516 extern void noprocess (void) ATTRIBUTE_NORETURN;
1517
1518 extern void target_require_runnable (void);
1519
1520 extern void find_default_attach (struct target_ops *, char *, int);
1521
1522 extern void find_default_create_inferior (struct target_ops *,
1523 char *, char *, char **, int);
1524
1525 extern struct target_ops *find_run_target (void);
1526
1527 extern struct target_ops *find_core_target (void);
1528
1529 extern struct target_ops *find_target_beneath (struct target_ops *);
1530
1531 /* Read OS data object of type TYPE from the target, and return it in
1532 XML format. The result is NUL-terminated and returned as a string,
1533 allocated using xmalloc. If an error occurs or the transfer is
1534 unsupported, NULL is returned. Empty objects are returned as
1535 allocated but empty strings. */
1536
1537 extern char *target_get_osdata (const char *type);
1538
1539 \f
1540 /* Stuff that should be shared among the various remote targets. */
1541
1542 /* Debugging level. 0 is off, and non-zero values mean to print some debug
1543 information (higher values, more information). */
1544 extern int remote_debug;
1545
1546 /* Speed in bits per second, or -1 which means don't mess with the speed. */
1547 extern int baud_rate;
1548 /* Timeout limit for response from target. */
1549 extern int remote_timeout;
1550
1551 \f
1552 /* Functions for helping to write a native target. */
1553
1554 /* This is for native targets which use a unix/POSIX-style waitstatus. */
1555 extern void store_waitstatus (struct target_waitstatus *, int);
1556
1557 /* These are in common/signals.c, but they're only used by gdb. */
1558 extern enum target_signal default_target_signal_from_host (struct gdbarch *,
1559 int);
1560 extern int default_target_signal_to_host (struct gdbarch *,
1561 enum target_signal);
1562
1563 /* Convert from a number used in a GDB command to an enum target_signal. */
1564 extern enum target_signal target_signal_from_command (int);
1565 /* End of files in common/signals.c. */
1566
1567 /* Set the show memory breakpoints mode to show, and installs a cleanup
1568 to restore it back to the current value. */
1569 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1570
1571 extern int may_write_registers;
1572 extern int may_write_memory;
1573 extern int may_insert_breakpoints;
1574 extern int may_insert_tracepoints;
1575 extern int may_insert_fast_tracepoints;
1576 extern int may_stop;
1577
1578 extern void update_target_permissions (void);
1579
1580 \f
1581 /* Imported from machine dependent code */
1582
1583 /* Blank target vector entries are initialized to target_ignore. */
1584 void target_ignore (void);
1585
1586 extern struct target_ops deprecated_child_ops;
1587
1588 #endif /* !defined (TARGET_H) */
This page took 0.063555 seconds and 4 git commands to generate.