1 /* Interface between GDB and target environments, including files and processes
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
5 Free Software Foundation, Inc.
7 Contributed by Cygnus Support. Written by John Gilmore.
9 This file is part of GDB.
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 2 of the License, or
14 (at your option) any later version.
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.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 Boston, MA 02110-1301, USA. */
26 #if !defined (TARGET_H)
33 struct bp_target_info
;
35 /* This include file defines the interface between the main part
36 of the debugger, and the part which is target-specific, or
37 specific to the communications interface between us and the
40 A TARGET is an interface between the debugger and a particular
41 kind of file or process. Targets can be STACKED in STRATA,
42 so that more than one target can potentially respond to a request.
43 In particular, memory accesses will walk down the stack of targets
44 until they find a target that is interested in handling that particular
45 address. STRATA are artificial boundaries on the stack, within
46 which particular kinds of targets live. Strata exist so that
47 people don't get confused by pushing e.g. a process target and then
48 a file target, and wondering why they can't see the current values
49 of variables any more (the file target is handling them and they
50 never get to the process target). So when you push a file target,
51 it goes into the file stratum, which is always below the process
62 dummy_stratum
, /* The lowest of the low */
63 file_stratum
, /* Executable files, etc */
64 core_stratum
, /* Core dump files */
65 download_stratum
, /* Downloading of remote targets */
66 process_stratum
, /* Executing processes */
67 thread_stratum
/* Executing threads */
70 enum thread_control_capabilities
72 tc_none
= 0, /* Default: can't control thread execution. */
73 tc_schedlock
= 1, /* Can lock the thread scheduler. */
74 tc_switch
= 2 /* Can switch the running thread on demand. */
77 /* Stuff for target_wait. */
79 /* Generally, what has the program done? */
82 /* The program has exited. The exit status is in value.integer. */
83 TARGET_WAITKIND_EXITED
,
85 /* The program has stopped with a signal. Which signal is in
87 TARGET_WAITKIND_STOPPED
,
89 /* The program has terminated with a signal. Which signal is in
91 TARGET_WAITKIND_SIGNALLED
,
93 /* The program is letting us know that it dynamically loaded something
94 (e.g. it called load(2) on AIX). */
95 TARGET_WAITKIND_LOADED
,
97 /* The program has forked. A "related" process' ID is in
98 value.related_pid. I.e., if the child forks, value.related_pid
99 is the parent's ID. */
101 TARGET_WAITKIND_FORKED
,
103 /* The program has vforked. A "related" process's ID is in
104 value.related_pid. */
106 TARGET_WAITKIND_VFORKED
,
108 /* The program has exec'ed a new executable file. The new file's
109 pathname is pointed to by value.execd_pathname. */
111 TARGET_WAITKIND_EXECD
,
113 /* The program has entered or returned from a system call. On
114 HP-UX, this is used in the hardware watchpoint implementation.
115 The syscall's unique integer ID number is in value.syscall_id */
117 TARGET_WAITKIND_SYSCALL_ENTRY
,
118 TARGET_WAITKIND_SYSCALL_RETURN
,
120 /* Nothing happened, but we stopped anyway. This perhaps should be handled
121 within target_wait, but I'm not sure target_wait should be resuming the
123 TARGET_WAITKIND_SPURIOUS
,
125 /* An event has occured, but we should wait again.
126 Remote_async_wait() returns this when there is an event
127 on the inferior, but the rest of the world is not interested in
128 it. The inferior has not stopped, but has just sent some output
129 to the console, for instance. In this case, we want to go back
130 to the event loop and wait there for another event from the
131 inferior, rather than being stuck in the remote_async_wait()
132 function. This way the event loop is responsive to other events,
133 like for instance the user typing. */
134 TARGET_WAITKIND_IGNORE
137 struct target_waitstatus
139 enum target_waitkind kind
;
141 /* Forked child pid, execd pathname, exit status or signal number. */
145 enum target_signal sig
;
147 char *execd_pathname
;
153 /* Possible types of events that the inferior handler will have to
155 enum inferior_event_type
157 /* There is a request to quit the inferior, abandon it. */
159 /* Process a normal inferior event which will result in target_wait
162 /* Deal with an error on the inferior. */
164 /* We are called because a timer went off. */
166 /* We are called to do stuff after the inferior stops. */
168 /* We are called to do some stuff after the inferior stops, but we
169 are expected to reenter the proceed() and
170 handle_inferior_event() functions. This is used only in case of
171 'step n' like commands. */
175 /* Return the string for a signal. */
176 extern char *target_signal_to_string (enum target_signal
);
178 /* Return the name (SIGHUP, etc.) for a signal. */
179 extern char *target_signal_to_name (enum target_signal
);
181 /* Given a name (SIGHUP, etc.), return its signal. */
182 enum target_signal
target_signal_from_name (char *);
184 /* Target objects which can be transfered using target_read,
185 target_write, et cetera. */
189 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
191 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
192 TARGET_OBJECT_MEMORY
,
193 /* Memory, avoiding GDB's data cache and trusting the executable.
194 Target implementations of to_xfer_partial never need to handle
195 this object, and most callers should not use it. */
196 TARGET_OBJECT_RAW_MEMORY
,
197 /* Kernel Unwind Table. See "ia64-tdep.c". */
198 TARGET_OBJECT_UNWIND_TABLE
,
199 /* Transfer auxilliary vector. */
201 /* StackGhost cookie. See "sparc-tdep.c". */
202 TARGET_OBJECT_WCOOKIE
,
203 /* Target memory map in XML format. */
204 TARGET_OBJECT_MEMORY_MAP
,
205 /* Flash memory. This object can be used to write contents to
206 a previously erased flash memory. Using it without erasing
207 flash can have unexpected results. Addresses are physical
208 address on target, and not relative to flash start. */
210 /* Available target-specific features, e.g. registers and coprocessors.
211 See "target-descriptions.c". ANNEX should never be empty. */
212 TARGET_OBJECT_AVAILABLE_FEATURES
213 /* Possible future objects: TARGET_OBJECT_FILE, TARGET_OBJECT_PROC, ... */
216 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
217 OBJECT. The OFFSET, for a seekable object, specifies the
218 starting point. The ANNEX can be used to provide additional
219 data-specific information to the target.
221 Return the number of bytes actually transfered, or -1 if the
222 transfer is not supported or otherwise fails. Return of a positive
223 value less than LEN indicates that no further transfer is possible.
224 Unlike the raw to_xfer_partial interface, callers of these
225 functions do not need to retry partial transfers. */
227 extern LONGEST
target_read (struct target_ops
*ops
,
228 enum target_object object
,
229 const char *annex
, gdb_byte
*buf
,
230 ULONGEST offset
, LONGEST len
);
232 extern LONGEST
target_write (struct target_ops
*ops
,
233 enum target_object object
,
234 const char *annex
, const gdb_byte
*buf
,
235 ULONGEST offset
, LONGEST len
);
237 /* Similar to target_write, except that it also calls PROGRESS with
238 the number of bytes written and the opaque BATON after every
239 successful partial write (and before the first write). This is
240 useful for progress reporting and user interaction while writing
241 data. To abort the transfer, the progress callback can throw an
244 LONGEST
target_write_with_progress (struct target_ops
*ops
,
245 enum target_object object
,
246 const char *annex
, const gdb_byte
*buf
,
247 ULONGEST offset
, LONGEST len
,
248 void (*progress
) (ULONGEST
, void *),
251 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
252 be read using OPS. The return value will be -1 if the transfer
253 fails or is not supported; 0 if the object is empty; or the length
254 of the object otherwise. If a positive value is returned, a
255 sufficiently large buffer will be allocated using xmalloc and
256 returned in *BUF_P containing the contents of the object.
258 This method should be used for objects sufficiently small to store
259 in a single xmalloc'd buffer, when no fixed bound on the object's
260 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
261 through this function. */
263 extern LONGEST
target_read_alloc (struct target_ops
*ops
,
264 enum target_object object
,
265 const char *annex
, gdb_byte
**buf_p
);
267 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
268 returned as a string, allocated using xmalloc. If an error occurs
269 or the transfer is unsupported, NULL is returned. Empty objects
270 are returned as allocated but empty strings. A warning is issued
271 if the result contains any embedded NUL bytes. */
273 extern char *target_read_stralloc (struct target_ops
*ops
,
274 enum target_object object
,
277 /* Wrappers to target read/write that perform memory transfers. They
278 throw an error if the memory transfer fails.
280 NOTE: cagney/2003-10-23: The naming schema is lifted from
281 "frame.h". The parameter order is lifted from get_frame_memory,
282 which in turn lifted it from read_memory. */
284 extern void get_target_memory (struct target_ops
*ops
, CORE_ADDR addr
,
285 gdb_byte
*buf
, LONGEST len
);
286 extern ULONGEST
get_target_memory_unsigned (struct target_ops
*ops
,
287 CORE_ADDR addr
, int len
);
290 /* If certain kinds of activity happen, target_wait should perform
292 /* Right now we just call (*TARGET_ACTIVITY_FUNCTION) if I/O is possible
293 on TARGET_ACTIVITY_FD. */
294 extern int target_activity_fd
;
295 /* Returns zero to leave the inferior alone, one to interrupt it. */
296 extern int (*target_activity_function
) (void);
298 struct thread_info
; /* fwd decl for parameter list below: */
302 struct target_ops
*beneath
; /* To the target under this one. */
303 char *to_shortname
; /* Name this target type */
304 char *to_longname
; /* Name for printing */
305 char *to_doc
; /* Documentation. Does not include trailing
306 newline, and starts with a one-line descrip-
307 tion (probably similar to to_longname). */
308 /* Per-target scratch pad. */
310 /* The open routine takes the rest of the parameters from the
311 command, and (if successful) pushes a new target onto the
312 stack. Targets should supply this routine, if only to provide
314 void (*to_open
) (char *, int);
315 /* Old targets with a static target vector provide "to_close".
316 New re-entrant targets provide "to_xclose" and that is expected
317 to xfree everything (including the "struct target_ops"). */
318 void (*to_xclose
) (struct target_ops
*targ
, int quitting
);
319 void (*to_close
) (int);
320 void (*to_attach
) (char *, int);
321 void (*to_post_attach
) (int);
322 void (*to_detach
) (char *, int);
323 void (*to_disconnect
) (struct target_ops
*, char *, int);
324 void (*to_resume
) (ptid_t
, int, enum target_signal
);
325 ptid_t (*to_wait
) (ptid_t
, struct target_waitstatus
*);
326 void (*to_fetch_registers
) (int);
327 void (*to_store_registers
) (int);
328 void (*to_prepare_to_store
) (void);
330 /* Transfer LEN bytes of memory between GDB address MYADDR and
331 target address MEMADDR. If WRITE, transfer them to the target, else
332 transfer them from the target. TARGET is the target from which we
335 Return value, N, is one of the following:
337 0 means that we can't handle this. If errno has been set, it is the
338 error which prevented us from doing it (FIXME: What about bfd_error?).
340 positive (call it N) means that we have transferred N bytes
341 starting at MEMADDR. We might be able to handle more bytes
342 beyond this length, but no promises.
344 negative (call its absolute value N) means that we cannot
345 transfer right at MEMADDR, but we could transfer at least
346 something at MEMADDR + N.
348 NOTE: cagney/2004-10-01: This has been entirely superseeded by
349 to_xfer_partial and inferior inheritance. */
351 int (*deprecated_xfer_memory
) (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
353 struct mem_attrib
*attrib
,
354 struct target_ops
*target
);
356 void (*to_files_info
) (struct target_ops
*);
357 int (*to_insert_breakpoint
) (struct bp_target_info
*);
358 int (*to_remove_breakpoint
) (struct bp_target_info
*);
359 int (*to_can_use_hw_breakpoint
) (int, int, int);
360 int (*to_insert_hw_breakpoint
) (struct bp_target_info
*);
361 int (*to_remove_hw_breakpoint
) (struct bp_target_info
*);
362 int (*to_remove_watchpoint
) (CORE_ADDR
, int, int);
363 int (*to_insert_watchpoint
) (CORE_ADDR
, int, int);
364 int (*to_stopped_by_watchpoint
) (void);
365 int to_have_continuable_watchpoint
;
366 int (*to_stopped_data_address
) (struct target_ops
*, CORE_ADDR
*);
367 int (*to_region_ok_for_hw_watchpoint
) (CORE_ADDR
, int);
368 void (*to_terminal_init
) (void);
369 void (*to_terminal_inferior
) (void);
370 void (*to_terminal_ours_for_output
) (void);
371 void (*to_terminal_ours
) (void);
372 void (*to_terminal_save_ours
) (void);
373 void (*to_terminal_info
) (char *, int);
374 void (*to_kill
) (void);
375 void (*to_load
) (char *, int);
376 int (*to_lookup_symbol
) (char *, CORE_ADDR
*);
377 void (*to_create_inferior
) (char *, char *, char **, int);
378 void (*to_post_startup_inferior
) (ptid_t
);
379 void (*to_acknowledge_created_inferior
) (int);
380 void (*to_insert_fork_catchpoint
) (int);
381 int (*to_remove_fork_catchpoint
) (int);
382 void (*to_insert_vfork_catchpoint
) (int);
383 int (*to_remove_vfork_catchpoint
) (int);
384 int (*to_follow_fork
) (struct target_ops
*, int);
385 void (*to_insert_exec_catchpoint
) (int);
386 int (*to_remove_exec_catchpoint
) (int);
387 int (*to_reported_exec_events_per_exec_call
) (void);
388 int (*to_has_exited
) (int, int, int *);
389 void (*to_mourn_inferior
) (void);
390 int (*to_can_run
) (void);
391 void (*to_notice_signals
) (ptid_t ptid
);
392 int (*to_thread_alive
) (ptid_t ptid
);
393 void (*to_find_new_threads
) (void);
394 char *(*to_pid_to_str
) (ptid_t
);
395 char *(*to_extra_thread_info
) (struct thread_info
*);
396 void (*to_stop
) (void);
397 void (*to_rcmd
) (char *command
, struct ui_file
*output
);
398 struct symtab_and_line
*(*to_enable_exception_callback
) (enum
399 exception_event_kind
,
401 struct exception_event_record
*(*to_get_current_exception_event
) (void);
402 char *(*to_pid_to_exec_file
) (int pid
);
403 enum strata to_stratum
;
404 int to_has_all_memory
;
407 int to_has_registers
;
408 int to_has_execution
;
409 int to_has_thread_control
; /* control thread execution */
414 /* ASYNC target controls */
415 int (*to_can_async_p
) (void);
416 int (*to_is_async_p
) (void);
417 void (*to_async
) (void (*cb
) (enum inferior_event_type
, void *context
),
419 int to_async_mask_value
;
420 int (*to_find_memory_regions
) (int (*) (CORE_ADDR
,
425 char * (*to_make_corefile_notes
) (bfd
*, int *);
427 /* Return the thread-local address at OFFSET in the
428 thread-local storage for the thread PTID and the shared library
429 or executable file given by OBJFILE. If that block of
430 thread-local storage hasn't been allocated yet, this function
431 may return an error. */
432 CORE_ADDR (*to_get_thread_local_address
) (ptid_t ptid
,
433 CORE_ADDR load_module_addr
,
436 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
437 OBJECT. The OFFSET, for a seekable object, specifies the
438 starting point. The ANNEX can be used to provide additional
439 data-specific information to the target.
441 Return the number of bytes actually transfered, zero when no
442 further transfer is possible, and -1 when the transfer is not
443 supported. Return of a positive value smaller than LEN does
444 not indicate the end of the object, only the end of the
445 transfer; higher level code should continue transferring if
446 desired. This is handled in target.c.
448 The interface does not support a "retry" mechanism. Instead it
449 assumes that at least one byte will be transfered on each
452 NOTE: cagney/2003-10-17: The current interface can lead to
453 fragmented transfers. Lower target levels should not implement
454 hacks, such as enlarging the transfer, in an attempt to
455 compensate for this. Instead, the target stack should be
456 extended so that it implements supply/collect methods and a
457 look-aside object cache. With that available, the lowest
458 target can safely and freely "push" data up the stack.
460 See target_read and target_write for more information. One,
461 and only one, of readbuf or writebuf must be non-NULL. */
463 LONGEST (*to_xfer_partial
) (struct target_ops
*ops
,
464 enum target_object object
, const char *annex
,
465 gdb_byte
*readbuf
, const gdb_byte
*writebuf
,
466 ULONGEST offset
, LONGEST len
);
468 /* Returns the memory map for the target. A return value of NULL
469 means that no memory map is available. If a memory address
470 does not fall within any returned regions, it's assumed to be
471 RAM. The returned memory regions should not overlap.
473 The order of regions does not matter; target_memory_map will
474 sort regions by starting address. For that reason, this
475 function should not be called directly except via
478 This method should not cache data; if the memory map could
479 change unexpectedly, it should be invalidated, and higher
480 layers will re-fetch it. */
481 VEC(mem_region_s
) *(*to_memory_map
) (struct target_ops
*);
483 /* Erases the region of flash memory starting at ADDRESS, of
486 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
487 on flash block boundaries, as reported by 'to_memory_map'. */
488 void (*to_flash_erase
) (struct target_ops
*,
489 ULONGEST address
, LONGEST length
);
491 /* Finishes a flash memory write sequence. After this operation
492 all flash memory should be available for writing and the result
493 of reading from areas written by 'to_flash_write' should be
494 equal to what was written. */
495 void (*to_flash_done
) (struct target_ops
*);
497 /* Describe the architecture-specific features of this target.
498 Returns the description found, or NULL if no description
500 const struct target_desc
*(*to_read_description
) (struct target_ops
*ops
);
503 /* Need sub-structure for target machine related rather than comm related?
507 /* Magic number for checking ops size. If a struct doesn't end with this
508 number, somebody changed the declaration but didn't change all the
509 places that initialize one. */
511 #define OPS_MAGIC 3840
513 /* The ops structure for our "current" target process. This should
514 never be NULL. If there is no target, it points to the dummy_target. */
516 extern struct target_ops current_target
;
518 /* Define easy words for doing these operations on our current target. */
520 #define target_shortname (current_target.to_shortname)
521 #define target_longname (current_target.to_longname)
523 /* Does whatever cleanup is required for a target that we are no
524 longer going to be calling. QUITTING indicates that GDB is exiting
525 and should not get hung on an error (otherwise it is important to
526 perform clean termination, even if it takes a while). This routine
527 is automatically always called when popping the target off the
528 target stack (to_beneath is undefined). Closing file descriptors
529 and freeing all memory allocated memory are typical things it
532 void target_close (struct target_ops
*targ
, int quitting
);
534 /* Attaches to a process on the target side. Arguments are as passed
535 to the `attach' command by the user. This routine can be called
536 when the target is not on the target-stack, if the target_can_run
537 routine returns 1; in that case, it must push itself onto the stack.
538 Upon exit, the target should be ready for normal operations, and
539 should be ready to deliver the status of the process immediately
540 (without waiting) to an upcoming target_wait call. */
542 #define target_attach(args, from_tty) \
543 (*current_target.to_attach) (args, from_tty)
545 /* The target_attach operation places a process under debugger control,
546 and stops the process.
548 This operation provides a target-specific hook that allows the
549 necessary bookkeeping to be performed after an attach completes. */
550 #define target_post_attach(pid) \
551 (*current_target.to_post_attach) (pid)
553 /* Takes a program previously attached to and detaches it.
554 The program may resume execution (some targets do, some don't) and will
555 no longer stop on signals, etc. We better not have left any breakpoints
556 in the program or it'll die when it hits one. ARGS is arguments
557 typed by the user (e.g. a signal to send the process). FROM_TTY
558 says whether to be verbose or not. */
560 extern void target_detach (char *, int);
562 /* Disconnect from the current target without resuming it (leaving it
563 waiting for a debugger). */
565 extern void target_disconnect (char *, int);
567 /* Resume execution of the target process PTID. STEP says whether to
568 single-step or to run free; SIGGNAL is the signal to be given to
569 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
570 pass TARGET_SIGNAL_DEFAULT. */
572 #define target_resume(ptid, step, siggnal) \
574 dcache_invalidate(target_dcache); \
575 (*current_target.to_resume) (ptid, step, siggnal); \
578 /* Wait for process pid to do something. PTID = -1 to wait for any
579 pid to do something. Return pid of child, or -1 in case of error;
580 store status through argument pointer STATUS. Note that it is
581 _NOT_ OK to throw_exception() out of target_wait() without popping
582 the debugging target from the stack; GDB isn't prepared to get back
583 to the prompt with a debugging target but without the frame cache,
584 stop_pc, etc., set up. */
586 #define target_wait(ptid, status) \
587 (*current_target.to_wait) (ptid, status)
589 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
591 #define target_fetch_registers(regno) \
592 (*current_target.to_fetch_registers) (regno)
594 /* Store at least register REGNO, or all regs if REGNO == -1.
595 It can store as many registers as it wants to, so target_prepare_to_store
596 must have been previously called. Calls error() if there are problems. */
598 #define target_store_registers(regs) \
599 (*current_target.to_store_registers) (regs)
601 /* Get ready to modify the registers array. On machines which store
602 individual registers, this doesn't need to do anything. On machines
603 which store all the registers in one fell swoop, this makes sure
604 that REGISTERS contains all the registers from the program being
607 #define target_prepare_to_store() \
608 (*current_target.to_prepare_to_store) ()
610 extern DCACHE
*target_dcache
;
612 extern int target_read_string (CORE_ADDR
, char **, int, int *);
614 extern int target_read_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
, int len
);
616 extern int target_write_memory (CORE_ADDR memaddr
, const gdb_byte
*myaddr
,
619 extern int xfer_memory (CORE_ADDR
, gdb_byte
*, int, int,
620 struct mem_attrib
*, struct target_ops
*);
622 extern int child_xfer_memory (CORE_ADDR
, gdb_byte
*, int, int,
623 struct mem_attrib
*, struct target_ops
*);
625 /* Fetches the target's memory map. If one is found it is sorted
626 and returned, after some consistency checking. Otherwise, NULL
628 VEC(mem_region_s
) *target_memory_map (void);
630 /* Erase the specified flash region. */
631 void target_flash_erase (ULONGEST address
, LONGEST length
);
633 /* Finish a sequence of flash operations. */
634 void target_flash_done (void);
636 /* Describes a request for a memory write operation. */
637 struct memory_write_request
639 /* Begining address that must be written. */
641 /* Past-the-end address. */
643 /* The data to write. */
645 /* A callback baton for progress reporting for this request. */
648 typedef struct memory_write_request memory_write_request_s
;
649 DEF_VEC_O(memory_write_request_s
);
651 /* Enumeration specifying different flash preservation behaviour. */
652 enum flash_preserve_mode
658 /* Write several memory blocks at once. This version can be more
659 efficient than making several calls to target_write_memory, in
660 particular because it can optimize accesses to flash memory.
662 Moreover, this is currently the only memory access function in gdb
663 that supports writing to flash memory, and it should be used for
664 all cases where access to flash memory is desirable.
666 REQUESTS is the vector (see vec.h) of memory_write_request.
667 PRESERVE_FLASH_P indicates what to do with blocks which must be
668 erased, but not completely rewritten.
669 PROGRESS_CB is a function that will be periodically called to provide
670 feedback to user. It will be called with the baton corresponding
671 to the request currently being written. It may also be called
672 with a NULL baton, when preserved flash sectors are being rewritten.
674 The function returns 0 on success, and error otherwise. */
675 int target_write_memory_blocks (VEC(memory_write_request_s
) *requests
,
676 enum flash_preserve_mode preserve_flash_p
,
677 void (*progress_cb
) (ULONGEST
, void *));
680 extern char *child_pid_to_exec_file (int);
682 extern char *child_core_file_to_sym_file (char *);
684 #if defined(CHILD_POST_ATTACH)
685 extern void child_post_attach (int);
688 extern void child_post_startup_inferior (ptid_t
);
690 extern void child_acknowledge_created_inferior (int);
692 extern void child_insert_fork_catchpoint (int);
694 extern int child_remove_fork_catchpoint (int);
696 extern void child_insert_vfork_catchpoint (int);
698 extern int child_remove_vfork_catchpoint (int);
700 extern void child_acknowledge_created_inferior (int);
702 extern int child_follow_fork (struct target_ops
*, int);
704 extern void child_insert_exec_catchpoint (int);
706 extern int child_remove_exec_catchpoint (int);
708 extern int child_reported_exec_events_per_exec_call (void);
710 extern int child_has_exited (int, int, int *);
712 extern int child_thread_alive (ptid_t
);
716 extern int inferior_has_forked (int pid
, int *child_pid
);
718 extern int inferior_has_vforked (int pid
, int *child_pid
);
720 extern int inferior_has_execd (int pid
, char **execd_pathname
);
724 extern void print_section_info (struct target_ops
*, bfd
*);
726 /* Print a line about the current target. */
728 #define target_files_info() \
729 (*current_target.to_files_info) (¤t_target)
731 /* Insert a breakpoint at address BP_TGT->placed_address in the target
732 machine. Result is 0 for success, or an errno value. */
734 #define target_insert_breakpoint(bp_tgt) \
735 (*current_target.to_insert_breakpoint) (bp_tgt)
737 /* Remove a breakpoint at address BP_TGT->placed_address in the target
738 machine. Result is 0 for success, or an errno value. */
740 #define target_remove_breakpoint(bp_tgt) \
741 (*current_target.to_remove_breakpoint) (bp_tgt)
743 /* Initialize the terminal settings we record for the inferior,
744 before we actually run the inferior. */
746 #define target_terminal_init() \
747 (*current_target.to_terminal_init) ()
749 /* Put the inferior's terminal settings into effect.
750 This is preparation for starting or resuming the inferior. */
752 #define target_terminal_inferior() \
753 (*current_target.to_terminal_inferior) ()
755 /* Put some of our terminal settings into effect,
756 enough to get proper results from our output,
757 but do not change into or out of RAW mode
758 so that no input is discarded.
760 After doing this, either terminal_ours or terminal_inferior
761 should be called to get back to a normal state of affairs. */
763 #define target_terminal_ours_for_output() \
764 (*current_target.to_terminal_ours_for_output) ()
766 /* Put our terminal settings into effect.
767 First record the inferior's terminal settings
768 so they can be restored properly later. */
770 #define target_terminal_ours() \
771 (*current_target.to_terminal_ours) ()
773 /* Save our terminal settings.
774 This is called from TUI after entering or leaving the curses
775 mode. Since curses modifies our terminal this call is here
776 to take this change into account. */
778 #define target_terminal_save_ours() \
779 (*current_target.to_terminal_save_ours) ()
781 /* Print useful information about our terminal status, if such a thing
784 #define target_terminal_info(arg, from_tty) \
785 (*current_target.to_terminal_info) (arg, from_tty)
787 /* Kill the inferior process. Make it go away. */
789 #define target_kill() \
790 (*current_target.to_kill) ()
792 /* Load an executable file into the target process. This is expected
793 to not only bring new code into the target process, but also to
794 update GDB's symbol tables to match.
796 ARG contains command-line arguments, to be broken down with
797 buildargv (). The first non-switch argument is the filename to
798 load, FILE; the second is a number (as parsed by strtoul (..., ...,
799 0)), which is an offset to apply to the load addresses of FILE's
800 sections. The target may define switches, or other non-switch
801 arguments, as it pleases. */
803 extern void target_load (char *arg
, int from_tty
);
805 /* Look up a symbol in the target's symbol table. NAME is the symbol
806 name. ADDRP is a CORE_ADDR * pointing to where the value of the
807 symbol should be returned. The result is 0 if successful, nonzero
808 if the symbol does not exist in the target environment. This
809 function should not call error() if communication with the target
810 is interrupted, since it is called from symbol reading, but should
811 return nonzero, possibly doing a complain(). */
813 #define target_lookup_symbol(name, addrp) \
814 (*current_target.to_lookup_symbol) (name, addrp)
816 /* Start an inferior process and set inferior_ptid to its pid.
817 EXEC_FILE is the file to run.
818 ALLARGS is a string containing the arguments to the program.
819 ENV is the environment vector to pass. Errors reported with error().
820 On VxWorks and various standalone systems, we ignore exec_file. */
822 #define target_create_inferior(exec_file, args, env, FROM_TTY) \
823 (*current_target.to_create_inferior) (exec_file, args, env, (FROM_TTY))
826 /* Some targets (such as ttrace-based HPUX) don't allow us to request
827 notification of inferior events such as fork and vork immediately
828 after the inferior is created. (This because of how gdb gets an
829 inferior created via invoking a shell to do it. In such a scenario,
830 if the shell init file has commands in it, the shell will fork and
831 exec for each of those commands, and we will see each such fork
834 Such targets will supply an appropriate definition for this function. */
836 #define target_post_startup_inferior(ptid) \
837 (*current_target.to_post_startup_inferior) (ptid)
839 /* On some targets, the sequence of starting up an inferior requires
840 some synchronization between gdb and the new inferior process, PID. */
842 #define target_acknowledge_created_inferior(pid) \
843 (*current_target.to_acknowledge_created_inferior) (pid)
845 /* On some targets, we can catch an inferior fork or vfork event when
846 it occurs. These functions insert/remove an already-created
847 catchpoint for such events. */
849 #define target_insert_fork_catchpoint(pid) \
850 (*current_target.to_insert_fork_catchpoint) (pid)
852 #define target_remove_fork_catchpoint(pid) \
853 (*current_target.to_remove_fork_catchpoint) (pid)
855 #define target_insert_vfork_catchpoint(pid) \
856 (*current_target.to_insert_vfork_catchpoint) (pid)
858 #define target_remove_vfork_catchpoint(pid) \
859 (*current_target.to_remove_vfork_catchpoint) (pid)
861 /* If the inferior forks or vforks, this function will be called at
862 the next resume in order to perform any bookkeeping and fiddling
863 necessary to continue debugging either the parent or child, as
864 requested, and releasing the other. Information about the fork
865 or vfork event is available via get_last_target_status ().
866 This function returns 1 if the inferior should not be resumed
867 (i.e. there is another event pending). */
869 int target_follow_fork (int follow_child
);
871 /* On some targets, we can catch an inferior exec event when it
872 occurs. These functions insert/remove an already-created
873 catchpoint for such events. */
875 #define target_insert_exec_catchpoint(pid) \
876 (*current_target.to_insert_exec_catchpoint) (pid)
878 #define target_remove_exec_catchpoint(pid) \
879 (*current_target.to_remove_exec_catchpoint) (pid)
881 /* Returns the number of exec events that are reported when a process
882 invokes a flavor of the exec() system call on this target, if exec
883 events are being reported. */
885 #define target_reported_exec_events_per_exec_call() \
886 (*current_target.to_reported_exec_events_per_exec_call) ()
888 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
889 exit code of PID, if any. */
891 #define target_has_exited(pid,wait_status,exit_status) \
892 (*current_target.to_has_exited) (pid,wait_status,exit_status)
894 /* The debugger has completed a blocking wait() call. There is now
895 some process event that must be processed. This function should
896 be defined by those targets that require the debugger to perform
897 cleanup or internal state changes in response to the process event. */
899 /* The inferior process has died. Do what is right. */
901 #define target_mourn_inferior() \
902 (*current_target.to_mourn_inferior) ()
904 /* Does target have enough data to do a run or attach command? */
906 #define target_can_run(t) \
909 /* post process changes to signal handling in the inferior. */
911 #define target_notice_signals(ptid) \
912 (*current_target.to_notice_signals) (ptid)
914 /* Check to see if a thread is still alive. */
916 #define target_thread_alive(ptid) \
917 (*current_target.to_thread_alive) (ptid)
919 /* Query for new threads and add them to the thread list. */
921 #define target_find_new_threads() \
922 (*current_target.to_find_new_threads) (); \
924 /* Make target stop in a continuable fashion. (For instance, under
925 Unix, this should act like SIGSTOP). This function is normally
926 used by GUIs to implement a stop button. */
928 #define target_stop current_target.to_stop
930 /* Send the specified COMMAND to the target's monitor
931 (shell,interpreter) for execution. The result of the query is
934 #define target_rcmd(command, outbuf) \
935 (*current_target.to_rcmd) (command, outbuf)
938 /* Get the symbol information for a breakpointable routine called when
939 an exception event occurs.
940 Intended mainly for C++, and for those
941 platforms/implementations where such a callback mechanism is available,
942 e.g. HP-UX with ANSI C++ (aCC). Some compilers (e.g. g++) support
943 different mechanisms for debugging exceptions. */
945 #define target_enable_exception_callback(kind, enable) \
946 (*current_target.to_enable_exception_callback) (kind, enable)
948 /* Get the current exception event kind -- throw or catch, etc. */
950 #define target_get_current_exception_event() \
951 (*current_target.to_get_current_exception_event) ()
953 /* Does the target include all of memory, or only part of it? This
954 determines whether we look up the target chain for other parts of
955 memory if this target can't satisfy a request. */
957 #define target_has_all_memory \
958 (current_target.to_has_all_memory)
960 /* Does the target include memory? (Dummy targets don't.) */
962 #define target_has_memory \
963 (current_target.to_has_memory)
965 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
966 we start a process.) */
968 #define target_has_stack \
969 (current_target.to_has_stack)
971 /* Does the target have registers? (Exec files don't.) */
973 #define target_has_registers \
974 (current_target.to_has_registers)
976 /* Does the target have execution? Can we make it jump (through
977 hoops), or pop its stack a few times? This means that the current
978 target is currently executing; for some targets, that's the same as
979 whether or not the target is capable of execution, but there are
980 also targets which can be current while not executing. In that
981 case this will become true after target_create_inferior or
984 #define target_has_execution \
985 (current_target.to_has_execution)
987 /* Can the target support the debugger control of thread execution?
988 a) Can it lock the thread scheduler?
989 b) Can it switch the currently running thread? */
991 #define target_can_lock_scheduler \
992 (current_target.to_has_thread_control & tc_schedlock)
994 #define target_can_switch_threads \
995 (current_target.to_has_thread_control & tc_switch)
997 /* Can the target support asynchronous execution? */
998 #define target_can_async_p() (current_target.to_can_async_p ())
1000 /* Is the target in asynchronous execution mode? */
1001 #define target_is_async_p() (current_target.to_is_async_p())
1003 /* Put the target in async mode with the specified callback function. */
1004 #define target_async(CALLBACK,CONTEXT) \
1005 (current_target.to_async((CALLBACK), (CONTEXT)))
1007 /* This is to be used ONLY within call_function_by_hand(). It provides
1008 a workaround, to have inferior function calls done in sychronous
1009 mode, even though the target is asynchronous. After
1010 target_async_mask(0) is called, calls to target_can_async_p() will
1011 return FALSE , so that target_resume() will not try to start the
1012 target asynchronously. After the inferior stops, we IMMEDIATELY
1013 restore the previous nature of the target, by calling
1014 target_async_mask(1). After that, target_can_async_p() will return
1015 TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
1017 FIXME ezannoni 1999-12-13: we won't need this once we move
1018 the turning async on and off to the single execution commands,
1019 from where it is done currently, in remote_resume(). */
1021 #define target_async_mask_value \
1022 (current_target.to_async_mask_value)
1024 extern int target_async_mask (int mask
);
1026 /* Converts a process id to a string. Usually, the string just contains
1027 `process xyz', but on some systems it may contain
1028 `process xyz thread abc'. */
1030 #undef target_pid_to_str
1031 #define target_pid_to_str(PID) current_target.to_pid_to_str (PID)
1033 #ifndef target_tid_to_str
1034 #define target_tid_to_str(PID) \
1035 target_pid_to_str (PID)
1036 extern char *normal_pid_to_str (ptid_t ptid
);
1039 /* Return a short string describing extra information about PID,
1040 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1043 #define target_extra_thread_info(TP) \
1044 (current_target.to_extra_thread_info (TP))
1047 * New Objfile Event Hook:
1049 * Sometimes a GDB component wants to get notified whenever a new
1050 * objfile is loaded. Mainly this is used by thread-debugging
1051 * implementations that need to know when symbols for the target
1052 * thread implemenation are available.
1054 * The old way of doing this is to define a macro 'target_new_objfile'
1055 * that points to the function that you want to be called on every
1056 * objfile/shlib load.
1058 The new way is to grab the function pointer,
1059 'deprecated_target_new_objfile_hook', and point it to the function
1060 that you want to be called on every objfile/shlib load.
1062 If multiple clients are willing to be cooperative, they can each
1063 save a pointer to the previous value of
1064 deprecated_target_new_objfile_hook before modifying it, and arrange
1065 for their function to call the previous function in the chain. In
1066 that way, multiple clients can receive this notification (something
1067 like with signal handlers). */
1069 extern void (*deprecated_target_new_objfile_hook
) (struct objfile
*);
1071 #ifndef target_pid_or_tid_to_str
1072 #define target_pid_or_tid_to_str(ID) \
1073 target_pid_to_str (ID)
1076 /* Attempts to find the pathname of the executable file
1077 that was run to create a specified process.
1079 The process PID must be stopped when this operation is used.
1081 If the executable file cannot be determined, NULL is returned.
1083 Else, a pointer to a character string containing the pathname
1084 is returned. This string should be copied into a buffer by
1085 the client if the string will not be immediately used, or if
1088 #define target_pid_to_exec_file(pid) \
1089 (current_target.to_pid_to_exec_file) (pid)
1092 * Iterator function for target memory regions.
1093 * Calls a callback function once for each memory region 'mapped'
1094 * in the child process. Defined as a simple macro rather than
1095 * as a function macro so that it can be tested for nullity.
1098 #define target_find_memory_regions(FUNC, DATA) \
1099 (current_target.to_find_memory_regions) (FUNC, DATA)
1102 * Compose corefile .note section.
1105 #define target_make_corefile_notes(BFD, SIZE_P) \
1106 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1108 /* Thread-local values. */
1109 #define target_get_thread_local_address \
1110 (current_target.to_get_thread_local_address)
1111 #define target_get_thread_local_address_p() \
1112 (target_get_thread_local_address != NULL)
1114 /* Hook to call target dependent code just after inferior target process has
1117 #ifndef TARGET_CREATE_INFERIOR_HOOK
1118 #define TARGET_CREATE_INFERIOR_HOOK(PID)
1121 /* Hardware watchpoint interfaces. */
1123 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1126 #ifndef STOPPED_BY_WATCHPOINT
1127 #define STOPPED_BY_WATCHPOINT(w) \
1128 (*current_target.to_stopped_by_watchpoint) ()
1131 /* Non-zero if we have continuable watchpoints */
1133 #ifndef HAVE_CONTINUABLE_WATCHPOINT
1134 #define HAVE_CONTINUABLE_WATCHPOINT \
1135 (current_target.to_have_continuable_watchpoint)
1138 /* Provide defaults for hardware watchpoint functions. */
1140 /* If the *_hw_beakpoint functions have not been defined
1141 elsewhere use the definitions in the target vector. */
1143 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1144 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1145 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1146 (including this one?). OTHERTYPE is who knows what... */
1148 #ifndef TARGET_CAN_USE_HARDWARE_WATCHPOINT
1149 #define TARGET_CAN_USE_HARDWARE_WATCHPOINT(TYPE,CNT,OTHERTYPE) \
1150 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
1153 #ifndef TARGET_REGION_OK_FOR_HW_WATCHPOINT
1154 #define TARGET_REGION_OK_FOR_HW_WATCHPOINT(addr, len) \
1155 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
1159 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes. TYPE is 0
1160 for write, 1 for read, and 2 for read/write accesses. Returns 0 for
1161 success, non-zero for failure. */
1163 #ifndef target_insert_watchpoint
1164 #define target_insert_watchpoint(addr, len, type) \
1165 (*current_target.to_insert_watchpoint) (addr, len, type)
1167 #define target_remove_watchpoint(addr, len, type) \
1168 (*current_target.to_remove_watchpoint) (addr, len, type)
1171 #ifndef target_insert_hw_breakpoint
1172 #define target_insert_hw_breakpoint(bp_tgt) \
1173 (*current_target.to_insert_hw_breakpoint) (bp_tgt)
1175 #define target_remove_hw_breakpoint(bp_tgt) \
1176 (*current_target.to_remove_hw_breakpoint) (bp_tgt)
1179 extern int target_stopped_data_address_p (struct target_ops
*);
1181 #ifndef target_stopped_data_address
1182 #define target_stopped_data_address(target, x) \
1183 (*target.to_stopped_data_address) (target, x)
1185 /* Horrible hack to get around existing macros :-(. */
1186 #define target_stopped_data_address_p(CURRENT_TARGET) (1)
1189 extern const struct target_desc
*target_read_description (struct target_ops
*);
1191 /* Routines for maintenance of the target structures...
1193 add_target: Add a target to the list of all possible targets.
1195 push_target: Make this target the top of the stack of currently used
1196 targets, within its particular stratum of the stack. Result
1197 is 0 if now atop the stack, nonzero if not on top (maybe
1200 unpush_target: Remove this from the stack of currently used targets,
1201 no matter where it is on the list. Returns 0 if no
1202 change, 1 if removed from stack.
1204 pop_target: Remove the top thing on the stack of current targets. */
1206 extern void add_target (struct target_ops
*);
1208 extern int push_target (struct target_ops
*);
1210 extern int unpush_target (struct target_ops
*);
1212 extern void target_pre_inferior (int);
1214 extern void target_preopen (int);
1216 extern void pop_target (void);
1218 extern CORE_ADDR
target_translate_tls_address (struct objfile
*objfile
,
1221 /* Mark a pushed target as running or exited, for targets which do not
1222 automatically pop when not active. */
1224 void target_mark_running (struct target_ops
*);
1226 void target_mark_exited (struct target_ops
*);
1228 /* Struct section_table maps address ranges to file sections. It is
1229 mostly used with BFD files, but can be used without (e.g. for handling
1230 raw disks, or files not in formats handled by BFD). */
1232 struct section_table
1234 CORE_ADDR addr
; /* Lowest address in section */
1235 CORE_ADDR endaddr
; /* 1+highest address in section */
1237 struct bfd_section
*the_bfd_section
;
1239 bfd
*bfd
; /* BFD file pointer */
1242 /* Return the "section" containing the specified address. */
1243 struct section_table
*target_section_by_addr (struct target_ops
*target
,
1247 /* From mem-break.c */
1249 extern int memory_remove_breakpoint (struct bp_target_info
*);
1251 extern int memory_insert_breakpoint (struct bp_target_info
*);
1253 extern int default_memory_remove_breakpoint (struct bp_target_info
*);
1255 extern int default_memory_insert_breakpoint (struct bp_target_info
*);
1260 extern void initialize_targets (void);
1262 extern void noprocess (void);
1264 extern void find_default_attach (char *, int);
1266 extern void find_default_create_inferior (char *, char *, char **, int);
1268 extern struct target_ops
*find_run_target (void);
1270 extern struct target_ops
*find_core_target (void);
1272 extern struct target_ops
*find_target_beneath (struct target_ops
*);
1274 extern int target_resize_to_sections (struct target_ops
*target
,
1277 extern void remove_target_sections (bfd
*abfd
);
1280 /* Stuff that should be shared among the various remote targets. */
1282 /* Debugging level. 0 is off, and non-zero values mean to print some debug
1283 information (higher values, more information). */
1284 extern int remote_debug
;
1286 /* Speed in bits per second, or -1 which means don't mess with the speed. */
1287 extern int baud_rate
;
1288 /* Timeout limit for response from target. */
1289 extern int remote_timeout
;
1292 /* Functions for helping to write a native target. */
1294 /* This is for native targets which use a unix/POSIX-style waitstatus. */
1295 extern void store_waitstatus (struct target_waitstatus
*, int);
1297 /* Predicate to target_signal_to_host(). Return non-zero if the enum
1298 targ_signal SIGNO has an equivalent ``host'' representation. */
1299 /* FIXME: cagney/1999-11-22: The name below was chosen in preference
1300 to the shorter target_signal_p() because it is far less ambigious.
1301 In this context ``target_signal'' refers to GDB's internal
1302 representation of the target's set of signals while ``host signal''
1303 refers to the target operating system's signal. Confused? */
1305 extern int target_signal_to_host_p (enum target_signal signo
);
1307 /* Convert between host signal numbers and enum target_signal's.
1308 target_signal_to_host() returns 0 and prints a warning() on GDB's
1309 console if SIGNO has no equivalent host representation. */
1310 /* FIXME: cagney/1999-11-22: Here ``host'' is used incorrectly, it is
1311 refering to the target operating system's signal numbering.
1312 Similarly, ``enum target_signal'' is named incorrectly, ``enum
1313 gdb_signal'' would probably be better as it is refering to GDB's
1314 internal representation of a target operating system's signal. */
1316 extern enum target_signal
target_signal_from_host (int);
1317 extern int target_signal_to_host (enum target_signal
);
1319 /* Convert from a number used in a GDB command to an enum target_signal. */
1320 extern enum target_signal
target_signal_from_command (int);
1322 /* Any target can call this to switch to remote protocol (in remote.c). */
1323 extern void push_remote_target (char *name
, int from_tty
);
1325 /* Imported from machine dependent code */
1327 /* Blank target vector entries are initialized to target_ignore. */
1328 void target_ignore (void);
1330 extern struct target_ops deprecated_child_ops
;
1332 #endif /* !defined (TARGET_H) */