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, 2008
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 3 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, see <http://www.gnu.org/licenses/>. */
24 #if !defined (TARGET_H)
31 struct bp_target_info
;
34 /* This include file defines the interface between the main part
35 of the debugger, and the part which is target-specific, or
36 specific to the communications interface between us and the
39 A TARGET is an interface between the debugger and a particular
40 kind of file or process. Targets can be STACKED in STRATA,
41 so that more than one target can potentially respond to a request.
42 In particular, memory accesses will walk down the stack of targets
43 until they find a target that is interested in handling that particular
44 address. STRATA are artificial boundaries on the stack, within
45 which particular kinds of targets live. Strata exist so that
46 people don't get confused by pushing e.g. a process target and then
47 a file target, and wondering why they can't see the current values
48 of variables any more (the file target is handling them and they
49 never get to the process target). So when you push a file target,
50 it goes into the file stratum, which is always below the process
61 dummy_stratum
, /* The lowest of the low */
62 file_stratum
, /* Executable files, etc */
63 core_stratum
, /* Core dump files */
64 process_stratum
, /* Executing processes */
65 thread_stratum
/* Executing threads */
68 enum thread_control_capabilities
70 tc_none
= 0, /* Default: can't control thread execution. */
71 tc_schedlock
= 1, /* Can lock the thread scheduler. */
74 /* Stuff for target_wait. */
76 /* Generally, what has the program done? */
79 /* The program has exited. The exit status is in value.integer. */
80 TARGET_WAITKIND_EXITED
,
82 /* The program has stopped with a signal. Which signal is in
84 TARGET_WAITKIND_STOPPED
,
86 /* The program has terminated with a signal. Which signal is in
88 TARGET_WAITKIND_SIGNALLED
,
90 /* The program is letting us know that it dynamically loaded something
91 (e.g. it called load(2) on AIX). */
92 TARGET_WAITKIND_LOADED
,
94 /* The program has forked. A "related" process' ID is in
95 value.related_pid. I.e., if the child forks, value.related_pid
96 is the parent's ID. */
98 TARGET_WAITKIND_FORKED
,
100 /* The program has vforked. A "related" process's ID is in
101 value.related_pid. */
103 TARGET_WAITKIND_VFORKED
,
105 /* The program has exec'ed a new executable file. The new file's
106 pathname is pointed to by value.execd_pathname. */
108 TARGET_WAITKIND_EXECD
,
110 /* The program has entered or returned from a system call. On
111 HP-UX, this is used in the hardware watchpoint implementation.
112 The syscall's unique integer ID number is in value.syscall_id */
114 TARGET_WAITKIND_SYSCALL_ENTRY
,
115 TARGET_WAITKIND_SYSCALL_RETURN
,
117 /* Nothing happened, but we stopped anyway. This perhaps should be handled
118 within target_wait, but I'm not sure target_wait should be resuming the
120 TARGET_WAITKIND_SPURIOUS
,
122 /* An event has occured, but we should wait again.
123 Remote_async_wait() returns this when there is an event
124 on the inferior, but the rest of the world is not interested in
125 it. The inferior has not stopped, but has just sent some output
126 to the console, for instance. In this case, we want to go back
127 to the event loop and wait there for another event from the
128 inferior, rather than being stuck in the remote_async_wait()
129 function. This way the event loop is responsive to other events,
130 like for instance the user typing. */
131 TARGET_WAITKIND_IGNORE
134 struct target_waitstatus
136 enum target_waitkind kind
;
138 /* Forked child pid, execd pathname, exit status or signal number. */
142 enum target_signal sig
;
144 char *execd_pathname
;
150 /* Possible types of events that the inferior handler will have to
152 enum inferior_event_type
154 /* There is a request to quit the inferior, abandon it. */
156 /* Process a normal inferior event which will result in target_wait
159 /* Deal with an error on the inferior. */
161 /* We are called because a timer went off. */
163 /* We are called to do stuff after the inferior stops. */
165 /* We are called to do some stuff after the inferior stops, but we
166 are expected to reenter the proceed() and
167 handle_inferior_event() functions. This is used only in case of
168 'step n' like commands. */
172 /* Return the string for a signal. */
173 extern char *target_signal_to_string (enum target_signal
);
175 /* Return the name (SIGHUP, etc.) for a signal. */
176 extern char *target_signal_to_name (enum target_signal
);
178 /* Given a name (SIGHUP, etc.), return its signal. */
179 enum target_signal
target_signal_from_name (char *);
181 /* Target objects which can be transfered using target_read,
182 target_write, et cetera. */
186 /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */
188 /* SPU target specific transfer. See "spu-tdep.c". */
190 /* Transfer up-to LEN bytes of memory starting at OFFSET. */
191 TARGET_OBJECT_MEMORY
,
192 /* Memory, avoiding GDB's data cache and trusting the executable.
193 Target implementations of to_xfer_partial never need to handle
194 this object, and most callers should not use it. */
195 TARGET_OBJECT_RAW_MEMORY
,
196 /* Kernel Unwind Table. See "ia64-tdep.c". */
197 TARGET_OBJECT_UNWIND_TABLE
,
198 /* Transfer auxilliary vector. */
200 /* StackGhost cookie. See "sparc-tdep.c". */
201 TARGET_OBJECT_WCOOKIE
,
202 /* Target memory map in XML format. */
203 TARGET_OBJECT_MEMORY_MAP
,
204 /* Flash memory. This object can be used to write contents to
205 a previously erased flash memory. Using it without erasing
206 flash can have unexpected results. Addresses are physical
207 address on target, and not relative to flash start. */
209 /* Available target-specific features, e.g. registers and coprocessors.
210 See "target-descriptions.c". ANNEX should never be empty. */
211 TARGET_OBJECT_AVAILABLE_FEATURES
,
212 /* Currently loaded libraries, in XML format. */
213 TARGET_OBJECT_LIBRARIES
214 /* Possible future objects: TARGET_OBJECT_FILE, TARGET_OBJECT_PROC, ... */
217 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
218 OBJECT. The OFFSET, for a seekable object, specifies the
219 starting point. The ANNEX can be used to provide additional
220 data-specific information to the target.
222 Return the number of bytes actually transfered, or -1 if the
223 transfer is not supported or otherwise fails. Return of a positive
224 value less than LEN indicates that no further transfer is possible.
225 Unlike the raw to_xfer_partial interface, callers of these
226 functions do not need to retry partial transfers. */
228 extern LONGEST
target_read (struct target_ops
*ops
,
229 enum target_object object
,
230 const char *annex
, gdb_byte
*buf
,
231 ULONGEST offset
, LONGEST len
);
233 extern LONGEST
target_write (struct target_ops
*ops
,
234 enum target_object object
,
235 const char *annex
, const gdb_byte
*buf
,
236 ULONGEST offset
, LONGEST len
);
238 /* Similar to target_write, except that it also calls PROGRESS with
239 the number of bytes written and the opaque BATON after every
240 successful partial write (and before the first write). This is
241 useful for progress reporting and user interaction while writing
242 data. To abort the transfer, the progress callback can throw an
245 LONGEST
target_write_with_progress (struct target_ops
*ops
,
246 enum target_object object
,
247 const char *annex
, const gdb_byte
*buf
,
248 ULONGEST offset
, LONGEST len
,
249 void (*progress
) (ULONGEST
, void *),
252 /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will
253 be read using OPS. The return value will be -1 if the transfer
254 fails or is not supported; 0 if the object is empty; or the length
255 of the object otherwise. If a positive value is returned, a
256 sufficiently large buffer will be allocated using xmalloc and
257 returned in *BUF_P containing the contents of the object.
259 This method should be used for objects sufficiently small to store
260 in a single xmalloc'd buffer, when no fixed bound on the object's
261 size is known in advance. Don't try to read TARGET_OBJECT_MEMORY
262 through this function. */
264 extern LONGEST
target_read_alloc (struct target_ops
*ops
,
265 enum target_object object
,
266 const char *annex
, gdb_byte
**buf_p
);
268 /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and
269 returned as a string, allocated using xmalloc. If an error occurs
270 or the transfer is unsupported, NULL is returned. Empty objects
271 are returned as allocated but empty strings. A warning is issued
272 if the result contains any embedded NUL bytes. */
274 extern char *target_read_stralloc (struct target_ops
*ops
,
275 enum target_object object
,
278 /* Wrappers to target read/write that perform memory transfers. They
279 throw an error if the memory transfer fails.
281 NOTE: cagney/2003-10-23: The naming schema is lifted from
282 "frame.h". The parameter order is lifted from get_frame_memory,
283 which in turn lifted it from read_memory. */
285 extern void get_target_memory (struct target_ops
*ops
, CORE_ADDR addr
,
286 gdb_byte
*buf
, LONGEST len
);
287 extern ULONGEST
get_target_memory_unsigned (struct target_ops
*ops
,
288 CORE_ADDR addr
, int len
);
291 /* If certain kinds of activity happen, target_wait should perform
293 /* Right now we just call (*TARGET_ACTIVITY_FUNCTION) if I/O is possible
294 on TARGET_ACTIVITY_FD. */
295 extern int target_activity_fd
;
296 /* Returns zero to leave the inferior alone, one to interrupt it. */
297 extern int (*target_activity_function
) (void);
299 struct thread_info
; /* fwd decl for parameter list below: */
303 struct target_ops
*beneath
; /* To the target under this one. */
304 char *to_shortname
; /* Name this target type */
305 char *to_longname
; /* Name for printing */
306 char *to_doc
; /* Documentation. Does not include trailing
307 newline, and starts with a one-line descrip-
308 tion (probably similar to to_longname). */
309 /* Per-target scratch pad. */
311 /* The open routine takes the rest of the parameters from the
312 command, and (if successful) pushes a new target onto the
313 stack. Targets should supply this routine, if only to provide
315 void (*to_open
) (char *, int);
316 /* Old targets with a static target vector provide "to_close".
317 New re-entrant targets provide "to_xclose" and that is expected
318 to xfree everything (including the "struct target_ops"). */
319 void (*to_xclose
) (struct target_ops
*targ
, int quitting
);
320 void (*to_close
) (int);
321 void (*to_attach
) (char *, int);
322 void (*to_post_attach
) (int);
323 void (*to_detach
) (char *, int);
324 void (*to_disconnect
) (struct target_ops
*, char *, int);
325 void (*to_resume
) (ptid_t
, int, enum target_signal
);
326 ptid_t (*to_wait
) (ptid_t
, struct target_waitstatus
*);
327 void (*to_fetch_registers
) (struct regcache
*, int);
328 void (*to_store_registers
) (struct regcache
*, int);
329 void (*to_prepare_to_store
) (struct regcache
*);
331 /* Transfer LEN bytes of memory between GDB address MYADDR and
332 target address MEMADDR. If WRITE, transfer them to the target, else
333 transfer them from the target. TARGET is the target from which we
336 Return value, N, is one of the following:
338 0 means that we can't handle this. If errno has been set, it is the
339 error which prevented us from doing it (FIXME: What about bfd_error?).
341 positive (call it N) means that we have transferred N bytes
342 starting at MEMADDR. We might be able to handle more bytes
343 beyond this length, but no promises.
345 negative (call its absolute value N) means that we cannot
346 transfer right at MEMADDR, but we could transfer at least
347 something at MEMADDR + N.
349 NOTE: cagney/2004-10-01: This has been entirely superseeded by
350 to_xfer_partial and inferior inheritance. */
352 int (*deprecated_xfer_memory
) (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
354 struct mem_attrib
*attrib
,
355 struct target_ops
*target
);
357 void (*to_files_info
) (struct target_ops
*);
358 int (*to_insert_breakpoint
) (struct bp_target_info
*);
359 int (*to_remove_breakpoint
) (struct bp_target_info
*);
360 int (*to_can_use_hw_breakpoint
) (int, int, int);
361 int (*to_insert_hw_breakpoint
) (struct bp_target_info
*);
362 int (*to_remove_hw_breakpoint
) (struct bp_target_info
*);
363 int (*to_remove_watchpoint
) (CORE_ADDR
, int, int);
364 int (*to_insert_watchpoint
) (CORE_ADDR
, int, int);
365 int (*to_stopped_by_watchpoint
) (void);
366 int to_have_steppable_watchpoint
;
367 int to_have_continuable_watchpoint
;
368 int (*to_stopped_data_address
) (struct target_ops
*, CORE_ADDR
*);
369 int (*to_watchpoint_addr_within_range
) (struct target_ops
*,
370 CORE_ADDR
, CORE_ADDR
, int);
371 int (*to_region_ok_for_hw_watchpoint
) (CORE_ADDR
, int);
372 void (*to_terminal_init
) (void);
373 void (*to_terminal_inferior
) (void);
374 void (*to_terminal_ours_for_output
) (void);
375 void (*to_terminal_ours
) (void);
376 void (*to_terminal_save_ours
) (void);
377 void (*to_terminal_info
) (char *, int);
378 void (*to_kill
) (void);
379 void (*to_load
) (char *, int);
380 int (*to_lookup_symbol
) (char *, CORE_ADDR
*);
381 void (*to_create_inferior
) (char *, char *, char **, int);
382 void (*to_post_startup_inferior
) (ptid_t
);
383 void (*to_acknowledge_created_inferior
) (int);
384 void (*to_insert_fork_catchpoint
) (int);
385 int (*to_remove_fork_catchpoint
) (int);
386 void (*to_insert_vfork_catchpoint
) (int);
387 int (*to_remove_vfork_catchpoint
) (int);
388 int (*to_follow_fork
) (struct target_ops
*, int);
389 void (*to_insert_exec_catchpoint
) (int);
390 int (*to_remove_exec_catchpoint
) (int);
391 int (*to_has_exited
) (int, int, int *);
392 void (*to_mourn_inferior
) (void);
393 int (*to_can_run
) (void);
394 void (*to_notice_signals
) (ptid_t ptid
);
395 int (*to_thread_alive
) (ptid_t ptid
);
396 void (*to_find_new_threads
) (void);
397 char *(*to_pid_to_str
) (ptid_t
);
398 char *(*to_extra_thread_info
) (struct thread_info
*);
399 void (*to_stop
) (void);
400 void (*to_rcmd
) (char *command
, struct ui_file
*output
);
401 char *(*to_pid_to_exec_file
) (int pid
);
402 void (*to_log_command
) (const char *);
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 (*) (enum inferior_event_type
, void *), void *);
418 int (*to_async_mask
) (int);
419 int (*to_find_memory_regions
) (int (*) (CORE_ADDR
,
424 char * (*to_make_corefile_notes
) (bfd
*, int *);
426 /* Return the thread-local address at OFFSET in the
427 thread-local storage for the thread PTID and the shared library
428 or executable file given by OBJFILE. If that block of
429 thread-local storage hasn't been allocated yet, this function
430 may return an error. */
431 CORE_ADDR (*to_get_thread_local_address
) (ptid_t ptid
,
432 CORE_ADDR load_module_addr
,
435 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
436 OBJECT. The OFFSET, for a seekable object, specifies the
437 starting point. The ANNEX can be used to provide additional
438 data-specific information to the target.
440 Return the number of bytes actually transfered, zero when no
441 further transfer is possible, and -1 when the transfer is not
442 supported. Return of a positive value smaller than LEN does
443 not indicate the end of the object, only the end of the
444 transfer; higher level code should continue transferring if
445 desired. This is handled in target.c.
447 The interface does not support a "retry" mechanism. Instead it
448 assumes that at least one byte will be transfered on each
451 NOTE: cagney/2003-10-17: The current interface can lead to
452 fragmented transfers. Lower target levels should not implement
453 hacks, such as enlarging the transfer, in an attempt to
454 compensate for this. Instead, the target stack should be
455 extended so that it implements supply/collect methods and a
456 look-aside object cache. With that available, the lowest
457 target can safely and freely "push" data up the stack.
459 See target_read and target_write for more information. One,
460 and only one, of readbuf or writebuf must be non-NULL. */
462 LONGEST (*to_xfer_partial
) (struct target_ops
*ops
,
463 enum target_object object
, const char *annex
,
464 gdb_byte
*readbuf
, const gdb_byte
*writebuf
,
465 ULONGEST offset
, LONGEST len
);
467 /* Returns the memory map for the target. A return value of NULL
468 means that no memory map is available. If a memory address
469 does not fall within any returned regions, it's assumed to be
470 RAM. The returned memory regions should not overlap.
472 The order of regions does not matter; target_memory_map will
473 sort regions by starting address. For that reason, this
474 function should not be called directly except via
477 This method should not cache data; if the memory map could
478 change unexpectedly, it should be invalidated, and higher
479 layers will re-fetch it. */
480 VEC(mem_region_s
) *(*to_memory_map
) (struct target_ops
*);
482 /* Erases the region of flash memory starting at ADDRESS, of
485 Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
486 on flash block boundaries, as reported by 'to_memory_map'. */
487 void (*to_flash_erase
) (struct target_ops
*,
488 ULONGEST address
, LONGEST length
);
490 /* Finishes a flash memory write sequence. After this operation
491 all flash memory should be available for writing and the result
492 of reading from areas written by 'to_flash_write' should be
493 equal to what was written. */
494 void (*to_flash_done
) (struct target_ops
*);
496 /* Describe the architecture-specific features of this target.
497 Returns the description found, or NULL if no description
499 const struct target_desc
*(*to_read_description
) (struct target_ops
*ops
);
501 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
502 Return 0 if *READPTR is already at the end of the buffer.
503 Return -1 if there is insufficient buffer for a whole entry.
504 Return 1 if an entry was read into *TYPEP and *VALP. */
505 int (*to_auxv_parse
) (struct target_ops
*ops
, gdb_byte
**readptr
,
506 gdb_byte
*endptr
, CORE_ADDR
*typep
, CORE_ADDR
*valp
);
508 /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
509 sequence of bytes in PATTERN with length PATTERN_LEN.
511 The result is 1 if found, 0 if not found, and -1 if there was an error
512 requiring halting of the search (e.g. memory read error).
513 If the pattern is found the address is recorded in FOUND_ADDRP. */
514 int (*to_search_memory
) (struct target_ops
*ops
,
515 CORE_ADDR start_addr
, ULONGEST search_space_len
,
516 const gdb_byte
*pattern
, ULONGEST pattern_len
,
517 CORE_ADDR
*found_addrp
);
520 /* Need sub-structure for target machine related rather than comm related?
524 /* Magic number for checking ops size. If a struct doesn't end with this
525 number, somebody changed the declaration but didn't change all the
526 places that initialize one. */
528 #define OPS_MAGIC 3840
530 /* The ops structure for our "current" target process. This should
531 never be NULL. If there is no target, it points to the dummy_target. */
533 extern struct target_ops current_target
;
535 /* Define easy words for doing these operations on our current target. */
537 #define target_shortname (current_target.to_shortname)
538 #define target_longname (current_target.to_longname)
540 /* Does whatever cleanup is required for a target that we are no
541 longer going to be calling. QUITTING indicates that GDB is exiting
542 and should not get hung on an error (otherwise it is important to
543 perform clean termination, even if it takes a while). This routine
544 is automatically always called when popping the target off the
545 target stack (to_beneath is undefined). Closing file descriptors
546 and freeing all memory allocated memory are typical things it
549 void target_close (struct target_ops
*targ
, int quitting
);
551 /* Attaches to a process on the target side. Arguments are as passed
552 to the `attach' command by the user. This routine can be called
553 when the target is not on the target-stack, if the target_can_run
554 routine returns 1; in that case, it must push itself onto the stack.
555 Upon exit, the target should be ready for normal operations, and
556 should be ready to deliver the status of the process immediately
557 (without waiting) to an upcoming target_wait call. */
559 #define target_attach(args, from_tty) \
560 (*current_target.to_attach) (args, from_tty)
562 /* The target_attach operation places a process under debugger control,
563 and stops the process.
565 This operation provides a target-specific hook that allows the
566 necessary bookkeeping to be performed after an attach completes. */
567 #define target_post_attach(pid) \
568 (*current_target.to_post_attach) (pid)
570 /* Takes a program previously attached to and detaches it.
571 The program may resume execution (some targets do, some don't) and will
572 no longer stop on signals, etc. We better not have left any breakpoints
573 in the program or it'll die when it hits one. ARGS is arguments
574 typed by the user (e.g. a signal to send the process). FROM_TTY
575 says whether to be verbose or not. */
577 extern void target_detach (char *, int);
579 /* Disconnect from the current target without resuming it (leaving it
580 waiting for a debugger). */
582 extern void target_disconnect (char *, int);
584 /* Resume execution of the target process PTID. STEP says whether to
585 single-step or to run free; SIGGNAL is the signal to be given to
586 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
587 pass TARGET_SIGNAL_DEFAULT. */
589 extern void target_resume (ptid_t ptid
, int step
, enum target_signal signal
);
591 /* Wait for process pid to do something. PTID = -1 to wait for any
592 pid to do something. Return pid of child, or -1 in case of error;
593 store status through argument pointer STATUS. Note that it is
594 _NOT_ OK to throw_exception() out of target_wait() without popping
595 the debugging target from the stack; GDB isn't prepared to get back
596 to the prompt with a debugging target but without the frame cache,
597 stop_pc, etc., set up. */
599 #define target_wait(ptid, status) \
600 (*current_target.to_wait) (ptid, status)
602 /* Fetch at least register REGNO, or all regs if regno == -1. No result. */
604 #define target_fetch_registers(regcache, regno) \
605 (*current_target.to_fetch_registers) (regcache, regno)
607 /* Store at least register REGNO, or all regs if REGNO == -1.
608 It can store as many registers as it wants to, so target_prepare_to_store
609 must have been previously called. Calls error() if there are problems. */
611 #define target_store_registers(regcache, regs) \
612 (*current_target.to_store_registers) (regcache, regs)
614 /* Get ready to modify the registers array. On machines which store
615 individual registers, this doesn't need to do anything. On machines
616 which store all the registers in one fell swoop, this makes sure
617 that REGISTERS contains all the registers from the program being
620 #define target_prepare_to_store(regcache) \
621 (*current_target.to_prepare_to_store) (regcache)
623 extern DCACHE
*target_dcache
;
625 extern int target_read_string (CORE_ADDR
, char **, int, int *);
627 extern int target_read_memory (CORE_ADDR memaddr
, gdb_byte
*myaddr
, int len
);
629 extern int target_write_memory (CORE_ADDR memaddr
, const gdb_byte
*myaddr
,
632 extern int xfer_memory (CORE_ADDR
, gdb_byte
*, int, int,
633 struct mem_attrib
*, struct target_ops
*);
635 /* Fetches the target's memory map. If one is found it is sorted
636 and returned, after some consistency checking. Otherwise, NULL
638 VEC(mem_region_s
) *target_memory_map (void);
640 /* Erase the specified flash region. */
641 void target_flash_erase (ULONGEST address
, LONGEST length
);
643 /* Finish a sequence of flash operations. */
644 void target_flash_done (void);
646 /* Describes a request for a memory write operation. */
647 struct memory_write_request
649 /* Begining address that must be written. */
651 /* Past-the-end address. */
653 /* The data to write. */
655 /* A callback baton for progress reporting for this request. */
658 typedef struct memory_write_request memory_write_request_s
;
659 DEF_VEC_O(memory_write_request_s
);
661 /* Enumeration specifying different flash preservation behaviour. */
662 enum flash_preserve_mode
668 /* Write several memory blocks at once. This version can be more
669 efficient than making several calls to target_write_memory, in
670 particular because it can optimize accesses to flash memory.
672 Moreover, this is currently the only memory access function in gdb
673 that supports writing to flash memory, and it should be used for
674 all cases where access to flash memory is desirable.
676 REQUESTS is the vector (see vec.h) of memory_write_request.
677 PRESERVE_FLASH_P indicates what to do with blocks which must be
678 erased, but not completely rewritten.
679 PROGRESS_CB is a function that will be periodically called to provide
680 feedback to user. It will be called with the baton corresponding
681 to the request currently being written. It may also be called
682 with a NULL baton, when preserved flash sectors are being rewritten.
684 The function returns 0 on success, and error otherwise. */
685 int target_write_memory_blocks (VEC(memory_write_request_s
) *requests
,
686 enum flash_preserve_mode preserve_flash_p
,
687 void (*progress_cb
) (ULONGEST
, void *));
691 extern int inferior_has_forked (int pid
, int *child_pid
);
693 extern int inferior_has_vforked (int pid
, int *child_pid
);
695 extern int inferior_has_execd (int pid
, char **execd_pathname
);
699 extern void print_section_info (struct target_ops
*, bfd
*);
701 /* Print a line about the current target. */
703 #define target_files_info() \
704 (*current_target.to_files_info) (¤t_target)
706 /* Insert a breakpoint at address BP_TGT->placed_address in the target
707 machine. Result is 0 for success, or an errno value. */
709 #define target_insert_breakpoint(bp_tgt) \
710 (*current_target.to_insert_breakpoint) (bp_tgt)
712 /* Remove a breakpoint at address BP_TGT->placed_address in the target
713 machine. Result is 0 for success, or an errno value. */
715 #define target_remove_breakpoint(bp_tgt) \
716 (*current_target.to_remove_breakpoint) (bp_tgt)
718 /* Initialize the terminal settings we record for the inferior,
719 before we actually run the inferior. */
721 #define target_terminal_init() \
722 (*current_target.to_terminal_init) ()
724 /* Put the inferior's terminal settings into effect.
725 This is preparation for starting or resuming the inferior. */
727 #define target_terminal_inferior() \
728 (*current_target.to_terminal_inferior) ()
730 /* Put some of our terminal settings into effect,
731 enough to get proper results from our output,
732 but do not change into or out of RAW mode
733 so that no input is discarded.
735 After doing this, either terminal_ours or terminal_inferior
736 should be called to get back to a normal state of affairs. */
738 #define target_terminal_ours_for_output() \
739 (*current_target.to_terminal_ours_for_output) ()
741 /* Put our terminal settings into effect.
742 First record the inferior's terminal settings
743 so they can be restored properly later. */
745 #define target_terminal_ours() \
746 (*current_target.to_terminal_ours) ()
748 /* Save our terminal settings.
749 This is called from TUI after entering or leaving the curses
750 mode. Since curses modifies our terminal this call is here
751 to take this change into account. */
753 #define target_terminal_save_ours() \
754 (*current_target.to_terminal_save_ours) ()
756 /* Print useful information about our terminal status, if such a thing
759 #define target_terminal_info(arg, from_tty) \
760 (*current_target.to_terminal_info) (arg, from_tty)
762 /* Kill the inferior process. Make it go away. */
764 #define target_kill() \
765 (*current_target.to_kill) ()
767 /* Load an executable file into the target process. This is expected
768 to not only bring new code into the target process, but also to
769 update GDB's symbol tables to match.
771 ARG contains command-line arguments, to be broken down with
772 buildargv (). The first non-switch argument is the filename to
773 load, FILE; the second is a number (as parsed by strtoul (..., ...,
774 0)), which is an offset to apply to the load addresses of FILE's
775 sections. The target may define switches, or other non-switch
776 arguments, as it pleases. */
778 extern void target_load (char *arg
, int from_tty
);
780 /* Look up a symbol in the target's symbol table. NAME is the symbol
781 name. ADDRP is a CORE_ADDR * pointing to where the value of the
782 symbol should be returned. The result is 0 if successful, nonzero
783 if the symbol does not exist in the target environment. This
784 function should not call error() if communication with the target
785 is interrupted, since it is called from symbol reading, but should
786 return nonzero, possibly doing a complain(). */
788 #define target_lookup_symbol(name, addrp) \
789 (*current_target.to_lookup_symbol) (name, addrp)
791 /* Start an inferior process and set inferior_ptid to its pid.
792 EXEC_FILE is the file to run.
793 ALLARGS is a string containing the arguments to the program.
794 ENV is the environment vector to pass. Errors reported with error().
795 On VxWorks and various standalone systems, we ignore exec_file. */
797 #define target_create_inferior(exec_file, args, env, FROM_TTY) \
798 (*current_target.to_create_inferior) (exec_file, args, env, (FROM_TTY))
801 /* Some targets (such as ttrace-based HPUX) don't allow us to request
802 notification of inferior events such as fork and vork immediately
803 after the inferior is created. (This because of how gdb gets an
804 inferior created via invoking a shell to do it. In such a scenario,
805 if the shell init file has commands in it, the shell will fork and
806 exec for each of those commands, and we will see each such fork
809 Such targets will supply an appropriate definition for this function. */
811 #define target_post_startup_inferior(ptid) \
812 (*current_target.to_post_startup_inferior) (ptid)
814 /* On some targets, the sequence of starting up an inferior requires
815 some synchronization between gdb and the new inferior process, PID. */
817 #define target_acknowledge_created_inferior(pid) \
818 (*current_target.to_acknowledge_created_inferior) (pid)
820 /* On some targets, we can catch an inferior fork or vfork event when
821 it occurs. These functions insert/remove an already-created
822 catchpoint for such events. */
824 #define target_insert_fork_catchpoint(pid) \
825 (*current_target.to_insert_fork_catchpoint) (pid)
827 #define target_remove_fork_catchpoint(pid) \
828 (*current_target.to_remove_fork_catchpoint) (pid)
830 #define target_insert_vfork_catchpoint(pid) \
831 (*current_target.to_insert_vfork_catchpoint) (pid)
833 #define target_remove_vfork_catchpoint(pid) \
834 (*current_target.to_remove_vfork_catchpoint) (pid)
836 /* If the inferior forks or vforks, this function will be called at
837 the next resume in order to perform any bookkeeping and fiddling
838 necessary to continue debugging either the parent or child, as
839 requested, and releasing the other. Information about the fork
840 or vfork event is available via get_last_target_status ().
841 This function returns 1 if the inferior should not be resumed
842 (i.e. there is another event pending). */
844 int target_follow_fork (int follow_child
);
846 /* On some targets, we can catch an inferior exec event when it
847 occurs. These functions insert/remove an already-created
848 catchpoint for such events. */
850 #define target_insert_exec_catchpoint(pid) \
851 (*current_target.to_insert_exec_catchpoint) (pid)
853 #define target_remove_exec_catchpoint(pid) \
854 (*current_target.to_remove_exec_catchpoint) (pid)
856 /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
857 exit code of PID, if any. */
859 #define target_has_exited(pid,wait_status,exit_status) \
860 (*current_target.to_has_exited) (pid,wait_status,exit_status)
862 /* The debugger has completed a blocking wait() call. There is now
863 some process event that must be processed. This function should
864 be defined by those targets that require the debugger to perform
865 cleanup or internal state changes in response to the process event. */
867 /* The inferior process has died. Do what is right. */
869 #define target_mourn_inferior() \
870 (*current_target.to_mourn_inferior) ()
872 /* Does target have enough data to do a run or attach command? */
874 #define target_can_run(t) \
877 /* post process changes to signal handling in the inferior. */
879 #define target_notice_signals(ptid) \
880 (*current_target.to_notice_signals) (ptid)
882 /* Check to see if a thread is still alive. */
884 #define target_thread_alive(ptid) \
885 (*current_target.to_thread_alive) (ptid)
887 /* Query for new threads and add them to the thread list. */
889 #define target_find_new_threads() \
890 (*current_target.to_find_new_threads) ()
892 /* Make target stop in a continuable fashion. (For instance, under
893 Unix, this should act like SIGSTOP). This function is normally
894 used by GUIs to implement a stop button. */
896 #define target_stop current_target.to_stop
898 /* Send the specified COMMAND to the target's monitor
899 (shell,interpreter) for execution. The result of the query is
902 #define target_rcmd(command, outbuf) \
903 (*current_target.to_rcmd) (command, outbuf)
906 /* Does the target include all of memory, or only part of it? This
907 determines whether we look up the target chain for other parts of
908 memory if this target can't satisfy a request. */
910 #define target_has_all_memory \
911 (current_target.to_has_all_memory)
913 /* Does the target include memory? (Dummy targets don't.) */
915 #define target_has_memory \
916 (current_target.to_has_memory)
918 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
919 we start a process.) */
921 #define target_has_stack \
922 (current_target.to_has_stack)
924 /* Does the target have registers? (Exec files don't.) */
926 #define target_has_registers \
927 (current_target.to_has_registers)
929 /* Does the target have execution? Can we make it jump (through
930 hoops), or pop its stack a few times? This means that the current
931 target is currently executing; for some targets, that's the same as
932 whether or not the target is capable of execution, but there are
933 also targets which can be current while not executing. In that
934 case this will become true after target_create_inferior or
937 #define target_has_execution \
938 (current_target.to_has_execution)
940 /* Can the target support the debugger control of thread execution?
941 Can it lock the thread scheduler? */
943 #define target_can_lock_scheduler \
944 (current_target.to_has_thread_control & tc_schedlock)
946 /* Can the target support asynchronous execution? */
947 #define target_can_async_p() (current_target.to_can_async_p ())
949 /* Is the target in asynchronous execution mode? */
950 #define target_is_async_p() (current_target.to_is_async_p ())
952 /* Put the target in async mode with the specified callback function. */
953 #define target_async(CALLBACK,CONTEXT) \
954 (current_target.to_async ((CALLBACK), (CONTEXT)))
956 /* This is to be used ONLY within call_function_by_hand(). It provides
957 a workaround, to have inferior function calls done in sychronous
958 mode, even though the target is asynchronous. After
959 target_async_mask(0) is called, calls to target_can_async_p() will
960 return FALSE , so that target_resume() will not try to start the
961 target asynchronously. After the inferior stops, we IMMEDIATELY
962 restore the previous nature of the target, by calling
963 target_async_mask(1). After that, target_can_async_p() will return
964 TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
966 FIXME ezannoni 1999-12-13: we won't need this once we move
967 the turning async on and off to the single execution commands,
968 from where it is done currently, in remote_resume(). */
970 #define target_async_mask(MASK) \
971 (current_target.to_async_mask (MASK))
973 /* Converts a process id to a string. Usually, the string just contains
974 `process xyz', but on some systems it may contain
975 `process xyz thread abc'. */
977 #undef target_pid_to_str
978 #define target_pid_to_str(PID) current_target.to_pid_to_str (PID)
980 #ifndef target_tid_to_str
981 #define target_tid_to_str(PID) \
982 target_pid_to_str (PID)
983 extern char *normal_pid_to_str (ptid_t ptid
);
986 /* Return a short string describing extra information about PID,
987 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
990 #define target_extra_thread_info(TP) \
991 (current_target.to_extra_thread_info (TP))
993 /* Attempts to find the pathname of the executable file
994 that was run to create a specified process.
996 The process PID must be stopped when this operation is used.
998 If the executable file cannot be determined, NULL is returned.
1000 Else, a pointer to a character string containing the pathname
1001 is returned. This string should be copied into a buffer by
1002 the client if the string will not be immediately used, or if
1005 #define target_pid_to_exec_file(pid) \
1006 (current_target.to_pid_to_exec_file) (pid)
1009 * Iterator function for target memory regions.
1010 * Calls a callback function once for each memory region 'mapped'
1011 * in the child process. Defined as a simple macro rather than
1012 * as a function macro so that it can be tested for nullity.
1015 #define target_find_memory_regions(FUNC, DATA) \
1016 (current_target.to_find_memory_regions) (FUNC, DATA)
1019 * Compose corefile .note section.
1022 #define target_make_corefile_notes(BFD, SIZE_P) \
1023 (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1025 /* Thread-local values. */
1026 #define target_get_thread_local_address \
1027 (current_target.to_get_thread_local_address)
1028 #define target_get_thread_local_address_p() \
1029 (target_get_thread_local_address != NULL)
1032 /* Hardware watchpoint interfaces. */
1034 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1037 #ifndef STOPPED_BY_WATCHPOINT
1038 #define STOPPED_BY_WATCHPOINT(w) \
1039 (*current_target.to_stopped_by_watchpoint) ()
1042 /* Non-zero if we have steppable watchpoints */
1044 #ifndef HAVE_STEPPABLE_WATCHPOINT
1045 #define HAVE_STEPPABLE_WATCHPOINT \
1046 (current_target.to_have_steppable_watchpoint)
1049 /* Non-zero if we have continuable watchpoints */
1051 #ifndef HAVE_CONTINUABLE_WATCHPOINT
1052 #define HAVE_CONTINUABLE_WATCHPOINT \
1053 (current_target.to_have_continuable_watchpoint)
1056 /* Provide defaults for hardware watchpoint functions. */
1058 /* If the *_hw_beakpoint functions have not been defined
1059 elsewhere use the definitions in the target vector. */
1061 /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1062 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1063 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1064 (including this one?). OTHERTYPE is who knows what... */
1066 #ifndef TARGET_CAN_USE_HARDWARE_WATCHPOINT
1067 #define TARGET_CAN_USE_HARDWARE_WATCHPOINT(TYPE,CNT,OTHERTYPE) \
1068 (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
1071 #ifndef TARGET_REGION_OK_FOR_HW_WATCHPOINT
1072 #define TARGET_REGION_OK_FOR_HW_WATCHPOINT(addr, len) \
1073 (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
1077 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes. TYPE is 0
1078 for write, 1 for read, and 2 for read/write accesses. Returns 0 for
1079 success, non-zero for failure. */
1081 #ifndef target_insert_watchpoint
1082 #define target_insert_watchpoint(addr, len, type) \
1083 (*current_target.to_insert_watchpoint) (addr, len, type)
1085 #define target_remove_watchpoint(addr, len, type) \
1086 (*current_target.to_remove_watchpoint) (addr, len, type)
1089 #ifndef target_insert_hw_breakpoint
1090 #define target_insert_hw_breakpoint(bp_tgt) \
1091 (*current_target.to_insert_hw_breakpoint) (bp_tgt)
1093 #define target_remove_hw_breakpoint(bp_tgt) \
1094 (*current_target.to_remove_hw_breakpoint) (bp_tgt)
1097 extern int target_stopped_data_address_p (struct target_ops
*);
1099 #ifndef target_stopped_data_address
1100 #define target_stopped_data_address(target, x) \
1101 (*target.to_stopped_data_address) (target, x)
1103 /* Horrible hack to get around existing macros :-(. */
1104 #define target_stopped_data_address_p(CURRENT_TARGET) (1)
1107 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1108 (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1110 extern const struct target_desc
*target_read_description (struct target_ops
*);
1112 /* Utility implementation of searching memory. */
1113 extern int simple_search_memory (struct target_ops
* ops
,
1114 CORE_ADDR start_addr
,
1115 ULONGEST search_space_len
,
1116 const gdb_byte
*pattern
,
1117 ULONGEST pattern_len
,
1118 CORE_ADDR
*found_addrp
);
1120 /* Main entry point for searching memory. */
1121 extern int target_search_memory (CORE_ADDR start_addr
,
1122 ULONGEST search_space_len
,
1123 const gdb_byte
*pattern
,
1124 ULONGEST pattern_len
,
1125 CORE_ADDR
*found_addrp
);
1127 /* Command logging facility. */
1129 #define target_log_command(p) \
1131 if (current_target.to_log_command) \
1132 (*current_target.to_log_command) (p); \
1135 /* Routines for maintenance of the target structures...
1137 add_target: Add a target to the list of all possible targets.
1139 push_target: Make this target the top of the stack of currently used
1140 targets, within its particular stratum of the stack. Result
1141 is 0 if now atop the stack, nonzero if not on top (maybe
1144 unpush_target: Remove this from the stack of currently used targets,
1145 no matter where it is on the list. Returns 0 if no
1146 change, 1 if removed from stack.
1148 pop_target: Remove the top thing on the stack of current targets. */
1150 extern void add_target (struct target_ops
*);
1152 extern int push_target (struct target_ops
*);
1154 extern int unpush_target (struct target_ops
*);
1156 extern void target_pre_inferior (int);
1158 extern void target_preopen (int);
1160 extern void pop_target (void);
1162 extern CORE_ADDR
target_translate_tls_address (struct objfile
*objfile
,
1165 /* Mark a pushed target as running or exited, for targets which do not
1166 automatically pop when not active. */
1168 void target_mark_running (struct target_ops
*);
1170 void target_mark_exited (struct target_ops
*);
1172 /* Struct section_table maps address ranges to file sections. It is
1173 mostly used with BFD files, but can be used without (e.g. for handling
1174 raw disks, or files not in formats handled by BFD). */
1176 struct section_table
1178 CORE_ADDR addr
; /* Lowest address in section */
1179 CORE_ADDR endaddr
; /* 1+highest address in section */
1181 struct bfd_section
*the_bfd_section
;
1183 bfd
*bfd
; /* BFD file pointer */
1186 /* Return the "section" containing the specified address. */
1187 struct section_table
*target_section_by_addr (struct target_ops
*target
,
1191 /* From mem-break.c */
1193 extern int memory_remove_breakpoint (struct bp_target_info
*);
1195 extern int memory_insert_breakpoint (struct bp_target_info
*);
1197 extern int default_memory_remove_breakpoint (struct gdbarch
*, struct bp_target_info
*);
1199 extern int default_memory_insert_breakpoint (struct gdbarch
*, struct bp_target_info
*);
1204 extern void initialize_targets (void);
1206 extern void noprocess (void);
1208 extern void target_require_runnable (void);
1210 extern void find_default_attach (char *, int);
1212 extern void find_default_create_inferior (char *, char *, char **, int);
1214 extern struct target_ops
*find_run_target (void);
1216 extern struct target_ops
*find_core_target (void);
1218 extern struct target_ops
*find_target_beneath (struct target_ops
*);
1220 extern int target_resize_to_sections (struct target_ops
*target
,
1223 extern void remove_target_sections (bfd
*abfd
);
1226 /* Stuff that should be shared among the various remote targets. */
1228 /* Debugging level. 0 is off, and non-zero values mean to print some debug
1229 information (higher values, more information). */
1230 extern int remote_debug
;
1232 /* Speed in bits per second, or -1 which means don't mess with the speed. */
1233 extern int baud_rate
;
1234 /* Timeout limit for response from target. */
1235 extern int remote_timeout
;
1238 /* Functions for helping to write a native target. */
1240 /* This is for native targets which use a unix/POSIX-style waitstatus. */
1241 extern void store_waitstatus (struct target_waitstatus
*, int);
1243 /* Predicate to target_signal_to_host(). Return non-zero if the enum
1244 targ_signal SIGNO has an equivalent ``host'' representation. */
1245 /* FIXME: cagney/1999-11-22: The name below was chosen in preference
1246 to the shorter target_signal_p() because it is far less ambigious.
1247 In this context ``target_signal'' refers to GDB's internal
1248 representation of the target's set of signals while ``host signal''
1249 refers to the target operating system's signal. Confused? */
1251 extern int target_signal_to_host_p (enum target_signal signo
);
1253 /* Convert between host signal numbers and enum target_signal's.
1254 target_signal_to_host() returns 0 and prints a warning() on GDB's
1255 console if SIGNO has no equivalent host representation. */
1256 /* FIXME: cagney/1999-11-22: Here ``host'' is used incorrectly, it is
1257 refering to the target operating system's signal numbering.
1258 Similarly, ``enum target_signal'' is named incorrectly, ``enum
1259 gdb_signal'' would probably be better as it is refering to GDB's
1260 internal representation of a target operating system's signal. */
1262 extern enum target_signal
target_signal_from_host (int);
1263 extern int target_signal_to_host (enum target_signal
);
1265 extern enum target_signal
default_target_signal_from_host (struct gdbarch
*,
1267 extern int default_target_signal_to_host (struct gdbarch
*,
1268 enum target_signal
);
1270 /* Convert from a number used in a GDB command to an enum target_signal. */
1271 extern enum target_signal
target_signal_from_command (int);
1273 /* Any target can call this to switch to remote protocol (in remote.c). */
1274 extern void push_remote_target (char *name
, int from_tty
);
1276 /* Set the show memory breakpoints mode to show, and installs a cleanup
1277 to restore it back to the current value. */
1278 extern struct cleanup
*make_show_memory_breakpoints_cleanup (int show
);
1281 /* Imported from machine dependent code */
1283 /* Blank target vector entries are initialized to target_ignore. */
1284 void target_ignore (void);
1286 extern struct target_ops deprecated_child_ops
;
1288 #endif /* !defined (TARGET_H) */