1 /* Interface between GDB and target environments, including files and processes
2 Copyright 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
3 Contributed by Cygnus Support. Written by John Gilmore.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
21 #if !defined (TARGET_H)
24 /* This include file defines the interface between the main part
25 of the debugger, and the part which is target-specific, or
26 specific to the communications interface between us and the
29 A TARGET is an interface between the debugger and a particular
30 kind of file or process. Targets can be STACKED in STRATA,
31 so that more than one target can potentially respond to a request.
32 In particular, memory accesses will walk down the stack of targets
33 until they find a target that is interested in handling that particular
34 address. STRATA are artificial boundaries on the stack, within
35 which particular kinds of targets live. Strata exist so that
36 people don't get confused by pushing e.g. a process target and then
37 a file target, and wondering why they can't see the current values
38 of variables any more (the file target is handling them and they
39 never get to the process target). So when you push a file target,
40 it goes into the file stratum, which is always below the process
46 dummy_stratum, /* The lowest of the low */
47 file_stratum, /* Executable files, etc */
48 core_stratum, /* Core dump files */
49 process_stratum /* Executing processes */
52 /* Stuff for target_wait. */
54 /* Generally, what has the program done? */
55 enum target_waitkind {
56 /* The program has exited. The exit status is in value.integer. */
57 TARGET_WAITKIND_EXITED,
59 /* The program has stopped with a signal. Which signal is in value.sig. */
60 TARGET_WAITKIND_STOPPED,
62 /* The program has terminated with a signal. Which signal is in
64 TARGET_WAITKIND_SIGNALLED,
66 /* The program is letting us know that it dynamically loaded something
67 (e.g. it called load(2) on AIX). */
68 TARGET_WAITKIND_LOADED,
70 /* Nothing happened, but we stopped anyway. This perhaps should be handled
71 within target_wait, but I'm not sure target_wait should be resuming the
73 TARGET_WAITKIND_SPURIOUS
76 /* The numbering of these signals is chosen to match traditional unix
77 signals (insofar as various unices use the same numbers, anyway).
78 It is also the numbering of the GDB remote protocol. Other remote
79 protocols, if they use a different numbering, should make sure to
80 translate appropriately. */
82 /* This is based strongly on Unix/POSIX signals for several reasons:
83 (1) This set of signals represents a widely-accepted attempt to
84 represent events of this sort in a portable fashion, (2) we want a
85 signal to make it from wait to child_wait to the user intact, (3) many
86 remote protocols use a similar encoding. However, it is
87 recognized that this set of signals has limitations (such as not
88 distinguishing between various kinds of SIGSEGV, or not
89 distinguishing hitting a breakpoint from finishing a single step).
90 So in the future we may get around this either by adding additional
91 signals for breakpoint, single-step, etc., or by adding signal
92 codes; the latter seems more in the spirit of what BSD, System V,
93 etc. are doing to address these issues. */
95 /* For an explanation of what each signal means, see
96 target_signal_to_string. */
99 /* Used some places (e.g. stop_signal) to record the concept that
100 there is no signal. */
102 TARGET_SIGNAL_HUP = 1,
103 TARGET_SIGNAL_INT = 2,
104 TARGET_SIGNAL_QUIT = 3,
105 TARGET_SIGNAL_ILL = 4,
106 TARGET_SIGNAL_TRAP = 5,
107 TARGET_SIGNAL_ABRT = 6,
108 TARGET_SIGNAL_EMT = 7,
109 TARGET_SIGNAL_FPE = 8,
110 TARGET_SIGNAL_KILL = 9,
111 TARGET_SIGNAL_BUS = 10,
112 TARGET_SIGNAL_SEGV = 11,
113 TARGET_SIGNAL_SYS = 12,
114 TARGET_SIGNAL_PIPE = 13,
115 TARGET_SIGNAL_ALRM = 14,
116 TARGET_SIGNAL_TERM = 15,
117 TARGET_SIGNAL_URG = 16,
118 TARGET_SIGNAL_STOP = 17,
119 TARGET_SIGNAL_TSTP = 18,
120 TARGET_SIGNAL_CONT = 19,
121 TARGET_SIGNAL_CHLD = 20,
122 TARGET_SIGNAL_TTIN = 21,
123 TARGET_SIGNAL_TTOU = 22,
124 TARGET_SIGNAL_IO = 23,
125 TARGET_SIGNAL_XCPU = 24,
126 TARGET_SIGNAL_XFSZ = 25,
127 TARGET_SIGNAL_VTALRM = 26,
128 TARGET_SIGNAL_PROF = 27,
129 TARGET_SIGNAL_WINCH = 28,
130 TARGET_SIGNAL_LOST = 29,
131 TARGET_SIGNAL_USR1 = 30,
132 TARGET_SIGNAL_USR2 = 31,
133 TARGET_SIGNAL_PWR = 32,
134 /* Similar to SIGIO. Perhaps they should have the same number. */
135 TARGET_SIGNAL_POLL = 33,
136 TARGET_SIGNAL_WIND = 34,
137 TARGET_SIGNAL_PHONE = 35,
138 TARGET_SIGNAL_WAITING = 36,
139 TARGET_SIGNAL_LWP = 37,
140 TARGET_SIGNAL_DANGER = 38,
141 TARGET_SIGNAL_GRANT = 39,
142 TARGET_SIGNAL_RETRACT = 40,
143 TARGET_SIGNAL_MSG = 41,
144 TARGET_SIGNAL_SOUND = 42,
145 TARGET_SIGNAL_SAK = 43,
147 /* Some signal we don't know about. */
148 TARGET_SIGNAL_UNKNOWN,
150 /* Use whatever signal we use when one is not specifically specified
151 (for passing to proceed and so on). */
152 TARGET_SIGNAL_DEFAULT,
154 /* Last and unused enum value, for sizing arrays, etc. */
158 struct target_waitstatus {
159 enum target_waitkind kind;
161 /* Exit status or signal number. */
164 enum target_signal sig;
168 /* Return the string for a signal. */
169 extern char *target_signal_to_string PARAMS ((enum target_signal));
171 /* Return the name (SIGHUP, etc.) for a signal. */
172 extern char *target_signal_to_name PARAMS ((enum target_signal));
174 /* Given a name (SIGHUP, etc.), return its signal. */
175 enum target_signal target_signal_from_name PARAMS ((char *));
179 char *to_shortname; /* Name this target type */
180 char *to_longname; /* Name for printing */
181 char *to_doc; /* Documentation. Does not include trailing
182 newline, and starts with a one-line descrip-
183 tion (probably similar to to_longname). */
184 void (*to_open) PARAMS ((char *, int));
185 void (*to_close) PARAMS ((int));
186 void (*to_attach) PARAMS ((char *, int));
187 void (*to_detach) PARAMS ((char *, int));
188 void (*to_resume) PARAMS ((int, int, enum target_signal));
189 int (*to_wait) PARAMS ((int, struct target_waitstatus *));
190 void (*to_fetch_registers) PARAMS ((int));
191 void (*to_store_registers) PARAMS ((int));
192 void (*to_prepare_to_store) PARAMS ((void));
194 /* Transfer LEN bytes of memory between GDB address MYADDR and
195 target address MEMADDR. If WRITE, transfer them to the target, else
196 transfer them from the target. TARGET is the target from which we
199 Return value, N, is one of the following:
201 0 means that we can't handle this. If errno has been set, it is the
202 error which prevented us from doing it (FIXME: What about bfd_error?).
204 positive (call it N) means that we have transferred N bytes
205 starting at MEMADDR. We might be able to handle more bytes
206 beyond this length, but no promises.
208 negative (call its absolute value N) means that we cannot
209 transfer right at MEMADDR, but we could transfer at least
210 something at MEMADDR + N. */
212 int (*to_xfer_memory) PARAMS ((CORE_ADDR memaddr, char *myaddr,
214 struct target_ops * target));
217 /* Enable this after 4.12. */
219 /* Search target memory. Start at STARTADDR and take LEN bytes of
220 target memory, and them with MASK, and compare to DATA. If they
221 match, set *ADDR_FOUND to the address we found it at, store the data
222 we found at LEN bytes starting at DATA_FOUND, and return. If
223 not, add INCREMENT to the search address and keep trying until
224 the search address is outside of the range [LORANGE,HIRANGE).
226 If we don't find anything, set *ADDR_FOUND to (CORE_ADDR)0 and return. */
227 void (*to_search) PARAMS ((int len, char *data, char *mask,
228 CORE_ADDR startaddr, int increment,
229 CORE_ADDR lorange, CORE_ADDR hirange,
230 CORE_ADDR *addr_found, char *data_found));
232 #define target_search(len, data, mask, startaddr, increment, lorange, hirange, addr_found, data_found) \
233 (*current_target->to_search) (len, data, mask, startaddr, increment, \
234 lorange, hirange, addr_found, data_found)
237 void (*to_files_info) PARAMS ((struct target_ops *));
238 int (*to_insert_breakpoint) PARAMS ((CORE_ADDR, char *));
239 int (*to_remove_breakpoint) PARAMS ((CORE_ADDR, char *));
240 void (*to_terminal_init) PARAMS ((void));
241 void (*to_terminal_inferior) PARAMS ((void));
242 void (*to_terminal_ours_for_output) PARAMS ((void));
243 void (*to_terminal_ours) PARAMS ((void));
244 void (*to_terminal_info) PARAMS ((char *, int));
245 void (*to_kill) PARAMS ((void));
246 void (*to_load) PARAMS ((char *, int));
247 int (*to_lookup_symbol) PARAMS ((char *, CORE_ADDR *));
248 void (*to_create_inferior) PARAMS ((char *, char *, char **));
249 void (*to_mourn_inferior) PARAMS ((void));
250 int (*to_can_run) PARAMS ((void));
251 void (*to_notice_signals) PARAMS ((int pid));
252 enum strata to_stratum;
255 int to_has_all_memory;
258 int to_has_registers;
259 int to_has_execution;
265 /* Need sub-structure for target machine related rather than comm related? */
268 /* Magic number for checking ops size. If a struct doesn't end with this
269 number, somebody changed the declaration but didn't change all the
270 places that initialize one. */
272 #define OPS_MAGIC 3840
274 /* The ops structure for our "current" target process. This should
275 never be NULL. If there is no target, it points to the dummy_target. */
277 extern struct target_ops *current_target;
279 /* Define easy words for doing these operations on our current target. */
281 #define target_shortname (current_target->to_shortname)
282 #define target_longname (current_target->to_longname)
284 /* The open routine takes the rest of the parameters from the command,
285 and (if successful) pushes a new target onto the stack.
286 Targets should supply this routine, if only to provide an error message. */
287 #define target_open(name, from_tty) \
288 (*current_target->to_open) (name, from_tty)
290 /* Does whatever cleanup is required for a target that we are no longer
291 going to be calling. Argument says whether we are quitting gdb and
292 should not get hung in case of errors, or whether we want a clean
293 termination even if it takes a while. This routine is automatically
294 always called just before a routine is popped off the target stack.
295 Closing file descriptors and freeing memory are typical things it should
298 #define target_close(quitting) \
299 (*current_target->to_close) (quitting)
301 /* Attaches to a process on the target side. Arguments are as passed
302 to the `attach' command by the user. This routine can be called
303 when the target is not on the target-stack, if the target_can_run
304 routine returns 1; in that case, it must push itself onto the stack.
305 Upon exit, the target should be ready for normal operations, and
306 should be ready to deliver the status of the process immediately
307 (without waiting) to an upcoming target_wait call. */
309 #define target_attach(args, from_tty) \
310 (*current_target->to_attach) (args, from_tty)
312 /* Takes a program previously attached to and detaches it.
313 The program may resume execution (some targets do, some don't) and will
314 no longer stop on signals, etc. We better not have left any breakpoints
315 in the program or it'll die when it hits one. ARGS is arguments
316 typed by the user (e.g. a signal to send the process). FROM_TTY
317 says whether to be verbose or not. */
320 target_detach PARAMS ((char *, int));
322 /* Resume execution of the target process PID. STEP says whether to
323 single-step or to run free; SIGGNAL is the signal to be given to
324 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
325 pass TARGET_SIGNAL_DEFAULT. */
327 #define target_resume(pid, step, siggnal) \
328 (*current_target->to_resume) (pid, step, siggnal)
330 /* Wait for process pid to do something. Pid = -1 to wait for any pid
331 to do something. Return pid of child, or -1 in case of error;
332 store status through argument pointer STATUS. Note that it is
333 *not* OK to return_to_top_level out of target_wait without popping
334 the debugging target from the stack; GDB isn't prepared to get back
335 to the prompt with a debugging target but without the frame cache,
336 stop_pc, etc., set up. */
338 #define target_wait(pid, status) \
339 (*current_target->to_wait) (pid, status)
341 /* Fetch register REGNO, or all regs if regno == -1. No result. */
343 #define target_fetch_registers(regno) \
344 (*current_target->to_fetch_registers) (regno)
346 /* Store at least register REGNO, or all regs if REGNO == -1.
347 It can store as many registers as it wants to, so target_prepare_to_store
348 must have been previously called. Calls error() if there are problems. */
350 #define target_store_registers(regs) \
351 (*current_target->to_store_registers) (regs)
353 /* Get ready to modify the registers array. On machines which store
354 individual registers, this doesn't need to do anything. On machines
355 which store all the registers in one fell swoop, this makes sure
356 that REGISTERS contains all the registers from the program being
359 #define target_prepare_to_store() \
360 (*current_target->to_prepare_to_store) ()
362 extern int target_read_string PARAMS ((CORE_ADDR, char **, int, int *));
365 target_read_memory PARAMS ((CORE_ADDR, char *, int));
368 target_read_memory_partial PARAMS ((CORE_ADDR, char *, int, int *));
371 target_write_memory PARAMS ((CORE_ADDR, char *, int));
374 xfer_memory PARAMS ((CORE_ADDR, char *, int, int, struct target_ops *));
377 child_xfer_memory PARAMS ((CORE_ADDR, char *, int, int, struct target_ops *));
379 /* Transfer LEN bytes between target address MEMADDR and GDB address MYADDR.
380 Returns 0 for success, errno code for failure (which includes partial
381 transfers--if you want a more useful response to partial transfers, try
382 target_read_memory_partial). */
384 extern int target_xfer_memory PARAMS ((CORE_ADDR memaddr, char *myaddr,
385 int len, int write));
390 print_section_info PARAMS ((struct target_ops *, bfd *));
392 /* Print a line about the current target. */
394 #define target_files_info() \
395 (*current_target->to_files_info) (current_target)
397 /* Insert a breakpoint at address ADDR in the target machine.
398 SAVE is a pointer to memory allocated for saving the
399 target contents. It is guaranteed by the caller to be long enough
400 to save "sizeof BREAKPOINT" bytes. Result is 0 for success, or
403 #define target_insert_breakpoint(addr, save) \
404 (*current_target->to_insert_breakpoint) (addr, save)
406 /* Remove a breakpoint at address ADDR in the target machine.
407 SAVE is a pointer to the same save area
408 that was previously passed to target_insert_breakpoint.
409 Result is 0 for success, or an errno value. */
411 #define target_remove_breakpoint(addr, save) \
412 (*current_target->to_remove_breakpoint) (addr, save)
414 /* Initialize the terminal settings we record for the inferior,
415 before we actually run the inferior. */
417 #define target_terminal_init() \
418 (*current_target->to_terminal_init) ()
420 /* Put the inferior's terminal settings into effect.
421 This is preparation for starting or resuming the inferior. */
423 #define target_terminal_inferior() \
424 (*current_target->to_terminal_inferior) ()
426 /* Put some of our terminal settings into effect,
427 enough to get proper results from our output,
428 but do not change into or out of RAW mode
429 so that no input is discarded.
431 After doing this, either terminal_ours or terminal_inferior
432 should be called to get back to a normal state of affairs. */
434 #define target_terminal_ours_for_output() \
435 (*current_target->to_terminal_ours_for_output) ()
437 /* Put our terminal settings into effect.
438 First record the inferior's terminal settings
439 so they can be restored properly later. */
441 #define target_terminal_ours() \
442 (*current_target->to_terminal_ours) ()
444 /* Print useful information about our terminal status, if such a thing
447 #define target_terminal_info(arg, from_tty) \
448 (*current_target->to_terminal_info) (arg, from_tty)
450 /* Kill the inferior process. Make it go away. */
452 #define target_kill() \
453 (*current_target->to_kill) ()
455 /* Load an executable file into the target process. This is expected to
456 not only bring new code into the target process, but also to update
457 GDB's symbol tables to match. */
459 #define target_load(arg, from_tty) \
460 (*current_target->to_load) (arg, from_tty)
462 /* Look up a symbol in the target's symbol table. NAME is the symbol
463 name. ADDRP is a CORE_ADDR * pointing to where the value of the symbol
464 should be returned. The result is 0 if successful, nonzero if the
465 symbol does not exist in the target environment. This function should
466 not call error() if communication with the target is interrupted, since
467 it is called from symbol reading, but should return nonzero, possibly
468 doing a complain(). */
470 #define target_lookup_symbol(name, addrp) \
471 (*current_target->to_lookup_symbol) (name, addrp)
473 /* Start an inferior process and set inferior_pid to its pid.
474 EXEC_FILE is the file to run.
475 ALLARGS is a string containing the arguments to the program.
476 ENV is the environment vector to pass. Errors reported with error().
477 On VxWorks and various standalone systems, we ignore exec_file. */
479 #define target_create_inferior(exec_file, args, env) \
480 (*current_target->to_create_inferior) (exec_file, args, env)
482 /* The inferior process has died. Do what is right. */
484 #define target_mourn_inferior() \
485 (*current_target->to_mourn_inferior) ()
487 /* Does target have enough data to do a run or attach command? */
489 #define target_can_run(t) \
492 /* post process changes to signal handling in the inferior. */
494 #define target_notice_signals(pid) \
495 (*current_target->to_notice_signals) (pid)
497 /* Pointer to next target in the chain, e.g. a core file and an exec file. */
499 #define target_next \
500 (current_target->to_next)
502 /* Does the target include all of memory, or only part of it? This
503 determines whether we look up the target chain for other parts of
504 memory if this target can't satisfy a request. */
506 #define target_has_all_memory \
507 (current_target->to_has_all_memory)
509 /* Does the target include memory? (Dummy targets don't.) */
511 #define target_has_memory \
512 (current_target->to_has_memory)
514 /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
515 we start a process.) */
517 #define target_has_stack \
518 (current_target->to_has_stack)
520 /* Does the target have registers? (Exec files don't.) */
522 #define target_has_registers \
523 (current_target->to_has_registers)
525 /* Does the target have execution? Can we make it jump (through
526 hoops), or pop its stack a few times? FIXME: If this is to work that
527 way, it needs to check whether an inferior actually exists.
528 remote-udi.c and probably other targets can be the current target
529 when the inferior doesn't actually exist at the moment. Right now
530 this just tells us whether this target is *capable* of execution. */
532 #define target_has_execution \
533 (current_target->to_has_execution)
535 /* Converts a process id to a string. Usually, the string just contains
536 `process xyz', but on some systems it may contain
537 `process xyz thread abc'. */
539 #ifndef target_pid_to_str
540 #define target_pid_to_str(PID) \
541 normal_pid_to_str (PID)
542 extern char *normal_pid_to_str PARAMS ((int pid));
545 /* Routines for maintenance of the target structures...
547 add_target: Add a target to the list of all possible targets.
549 push_target: Make this target the top of the stack of currently used
550 targets, within its particular stratum of the stack. Result
551 is 0 if now atop the stack, nonzero if not on top (maybe
554 unpush_target: Remove this from the stack of currently used targets,
555 no matter where it is on the list. Returns 0 if no
556 change, 1 if removed from stack.
558 pop_target: Remove the top thing on the stack of current targets. */
561 add_target PARAMS ((struct target_ops *));
564 push_target PARAMS ((struct target_ops *));
567 unpush_target PARAMS ((struct target_ops *));
570 target_preopen PARAMS ((int));
573 pop_target PARAMS ((void));
575 /* Struct section_table maps address ranges to file sections. It is
576 mostly used with BFD files, but can be used without (e.g. for handling
577 raw disks, or files not in formats handled by BFD). */
579 struct section_table {
580 CORE_ADDR addr; /* Lowest address in section */
581 CORE_ADDR endaddr; /* 1+highest address in section */
583 /* For the ptx compiler, we can't use the sec_ptr typedef when the field's
584 name is sec_ptr. We really should rename the field (or better yet,
585 the typedef should be bfd_sec_ptr). */
586 struct sec *sec_ptr; /* BFD section pointer */
588 bfd *bfd; /* BFD file pointer */
591 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
592 Returns 0 if OK, 1 on error. */
595 build_section_table PARAMS ((bfd *, struct section_table **,
596 struct section_table **));
598 /* From mem-break.c */
601 memory_remove_breakpoint PARAMS ((CORE_ADDR, char *));
604 memory_insert_breakpoint PARAMS ((CORE_ADDR, char *));
609 noprocess PARAMS ((void));
612 find_default_attach PARAMS ((char *, int));
615 find_default_create_inferior PARAMS ((char *, char *, char **));
618 find_core_target PARAMS ((void));
620 /* Stuff that should be shared among the various remote targets. */
622 /* Debugging level. 0 is off, and non-zero values mean to print some debug
623 information (higher values, more information). */
624 extern int remote_debug;
626 /* Speed in bits per second, or -1 which means don't mess with the speed. */
627 extern int baud_rate;
629 /* Functions for helping to write a native target. */
631 /* This is for native targets which use a unix/POSIX-style waitstatus. */
632 extern void store_waitstatus PARAMS ((struct target_waitstatus *, int));
634 /* Convert between host signal numbers and enum target_signal's. */
635 extern enum target_signal target_signal_from_host PARAMS ((int));
636 extern int target_signal_to_host PARAMS ((enum target_signal));
638 #endif /* !defined (TARGET_H) */