1 /* Variables that describe the inferior process running under GDB:
2 Where it is, why it stopped, and how to step it.
3 Copyright 1986, 1989, 1992, 1996, 1998 Free Software Foundation, Inc.
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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #if !defined (INFERIOR_H)
26 #include "breakpoint.h"
28 /* For enum target_signal. */
31 /* Structure in which to save the status of the inferior. Create/Save
32 through "save_inferior_status", restore through
33 "restore_inferior_status".
35 This pair of routines should be called around any transfer of
36 control to the inferior which you don't want showing up in your
39 struct inferior_status;
41 extern struct inferior_status *save_inferior_status (int);
43 extern void restore_inferior_status (struct inferior_status *);
45 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
47 extern void discard_inferior_status (struct inferior_status *);
49 extern void write_inferior_status_register (struct inferior_status
50 *inf_status, int regno,
53 /* This macro gives the number of registers actually in use by the
54 inferior. This may be less than the total number of registers,
55 perhaps depending on the actual CPU in use or program being run.
56 FIXME: This could be replaced by the new MULTI_ARCH capability. */
59 #define ARCH_NUM_REGS NUM_REGS
62 extern void set_sigint_trap (void);
64 extern void clear_sigint_trap (void);
66 extern void set_sigio_trap (void);
68 extern void clear_sigio_trap (void);
70 /* File name for default use for standard in/out in the inferior. */
72 extern char *inferior_io_terminal;
74 /* Pid of our debugged inferior, or 0 if no inferior now. */
76 extern int inferior_pid;
78 /* Is the inferior running right now, as a result of a 'run&',
79 'continue&' etc command? This is used in asycn gdb to determine
80 whether a command that the user enters while the target is running
82 extern int target_executing;
84 /* Are we simulating synchronous execution? This is used in async gdb
85 to implement the 'run', 'continue' etc commands, which will not
86 redisplay the prompt until the execution is actually over. */
87 extern int sync_execution;
89 /* This is only valid when inferior_pid is non-zero.
91 If this is 0, then exec events should be noticed and responded to
92 by the debugger (i.e., be reported to the user).
94 If this is > 0, then that many subsequent exec events should be
95 ignored (i.e., not be reported to the user).
97 extern int inferior_ignoring_startup_exec_events;
99 /* This is only valid when inferior_ignoring_startup_exec_events is
102 Some targets (stupidly) report more than one exec event per actual
103 call to an event() system call. If only the last such exec event
104 need actually be noticed and responded to by the debugger (i.e.,
105 be reported to the user), then this is the number of "leading"
106 exec events which should be ignored.
108 extern int inferior_ignoring_leading_exec_events;
110 /* Inferior environment. */
112 extern struct environ *inferior_environ;
114 /* Character array containing an image of the inferior programs'
117 extern char *registers;
119 /* Character array containing the current state of each register
120 (unavailable<0, valid=0, invalid>0). */
122 extern signed char *register_valid;
124 extern void clear_proceed_status (void);
126 extern void proceed (CORE_ADDR, enum target_signal, int);
128 extern void kill_inferior (void);
130 extern void generic_mourn_inferior (void);
132 extern void terminal_ours (void);
134 extern int run_stack_dummy (CORE_ADDR, char *);
136 extern CORE_ADDR read_pc (void);
138 extern CORE_ADDR read_pc_pid (int);
140 extern CORE_ADDR generic_target_read_pc (int);
142 extern void write_pc (CORE_ADDR);
144 extern void write_pc_pid (CORE_ADDR, int);
146 extern void generic_target_write_pc (CORE_ADDR, int);
148 extern CORE_ADDR read_sp (void);
150 extern CORE_ADDR generic_target_read_sp (void);
152 extern void write_sp (CORE_ADDR);
154 extern void generic_target_write_sp (CORE_ADDR);
156 extern CORE_ADDR read_fp (void);
158 extern CORE_ADDR generic_target_read_fp (void);
160 extern void write_fp (CORE_ADDR);
162 extern void generic_target_write_fp (CORE_ADDR);
164 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, void *buf);
166 extern void unsigned_address_to_pointer (struct type *type, void *buf,
168 extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
169 extern void address_to_signed_pointer (struct type *type, void *buf,
172 extern void wait_for_inferior (void);
174 extern void fetch_inferior_event (void *);
176 extern void init_wait_for_inferior (void);
178 extern void close_exec_file (void);
180 extern void reopen_exec_file (void);
182 /* The `resume' routine should only be called in special circumstances.
183 Normally, use `proceed', which handles a lot of bookkeeping. */
185 extern void resume (int, enum target_signal);
187 /* From misc files */
189 extern void store_inferior_registers (int);
191 extern void fetch_inferior_registers (int);
193 extern void solib_create_inferior_hook (void);
195 extern void child_terminal_info (char *, int);
197 extern void term_info (char *, int);
199 extern void terminal_ours_for_output (void);
201 extern void terminal_inferior (void);
203 extern void terminal_init_inferior (void);
205 extern void terminal_init_inferior_with_pgrp (int pgrp);
207 /* From infptrace.c or infttrace.c */
209 extern int attach (int);
211 #if !defined(REQUIRE_ATTACH)
212 #define REQUIRE_ATTACH attach
215 #if !defined(REQUIRE_DETACH)
216 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
219 extern void detach (int);
221 /* PTRACE method of waiting for inferior process. */
222 int ptrace_wait (int, int *);
224 extern void child_resume (int, int, enum target_signal);
226 #ifndef PTRACE_ARG3_TYPE
227 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
230 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
232 extern void pre_fork_inferior (void);
236 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
238 extern int procfs_first_available (void);
240 /* From fork-child.c */
242 extern void fork_inferior (char *, char *, char **,
244 void (*)(int), void (*)(void), char *);
247 extern void clone_and_follow_inferior (int, int *);
249 extern void startup_inferior (int);
253 extern void new_tty_prefork (char *);
255 extern int gdb_has_a_terminal (void);
259 extern void start_remote (void);
261 extern void normal_stop (void);
263 extern int signal_stop_state (int);
265 extern int signal_print_state (int);
267 extern int signal_pass_state (int);
269 extern int signal_stop_update (int, int);
271 extern int signal_print_update (int, int);
273 extern int signal_pass_update (int, int);
277 extern void tty_command (char *, int);
279 extern void attach_command (char *, int);
281 /* Last signal that the inferior received (why it stopped). */
283 extern enum target_signal stop_signal;
285 /* Address at which inferior stopped. */
287 extern CORE_ADDR stop_pc;
289 /* Chain containing status of breakpoint(s) that we have stopped at. */
291 extern bpstat stop_bpstat;
293 /* Flag indicating that a command has proceeded the inferior past the
294 current breakpoint. */
296 extern int breakpoint_proceeded;
298 /* Nonzero if stopped due to a step command. */
300 extern int stop_step;
302 /* Nonzero if stopped due to completion of a stack dummy routine. */
304 extern int stop_stack_dummy;
306 /* Nonzero if program stopped due to a random (unexpected) signal in
309 extern int stopped_by_random_signal;
311 /* Range to single step within.
312 If this is nonzero, respond to a single-step signal
313 by continuing to step if the pc is in this range.
315 If step_range_start and step_range_end are both 1, it means to step for
316 a single instruction (FIXME: it might clean up wait_for_inferior in a
317 minor way if this were changed to the address of the instruction and
318 that address plus one. But maybe not.). */
320 extern CORE_ADDR step_range_start; /* Inclusive */
321 extern CORE_ADDR step_range_end; /* Exclusive */
323 /* Stack frame address as of when stepping command was issued.
324 This is how we know when we step into a subroutine call,
325 and how to set the frame for the breakpoint used to step out. */
327 extern CORE_ADDR step_frame_address;
329 /* Our notion of the current stack pointer. */
331 extern CORE_ADDR step_sp;
333 /* 1 means step over all subroutine calls.
334 -1 means step over calls to undebuggable functions. */
336 extern int step_over_calls;
338 /* If stepping, nonzero means step count is > 1
339 so don't print frame next time inferior stops
340 if it stops due to stepping. */
342 extern int step_multi;
344 /* Nonzero means expecting a trap and caller will handle it themselves.
345 It is used after attach, due to attaching to a process;
346 when running in the shell before the child program has been exec'd;
347 and when running some kinds of remote stuff (FIXME?). */
349 extern int stop_soon_quietly;
351 /* Nonzero if proceed is being used for a "finish" command or a similar
352 situation when stop_registers should be saved. */
354 extern int proceed_to_finish;
356 /* Save register contents here when about to pop a stack dummy frame,
357 if-and-only-if proceed_to_finish is set.
358 Thus this contains the return value from the called function (assuming
359 values are returned in a register). */
361 extern char *stop_registers;
363 /* Nonzero if the child process in inferior_pid was attached rather
366 extern int attach_flag;
368 /* Sigtramp is a routine that the kernel calls (which then calls the
369 signal handler). On most machines it is a library routine that
370 is linked into the executable.
372 This macro, given a program counter value and the name of the
373 function in which that PC resides (which can be null if the
374 name is not known), returns nonzero if the PC and name show
375 that we are in sigtramp.
377 On most machines just see if the name is sigtramp (and if we have
378 no name, assume we are not in sigtramp). */
379 #if !defined (IN_SIGTRAMP)
380 #if defined (SIGTRAMP_START)
381 #define IN_SIGTRAMP(pc, name) \
382 ((pc) >= SIGTRAMP_START(pc) \
383 && (pc) < SIGTRAMP_END(pc) \
386 #define IN_SIGTRAMP(pc, name) \
387 (name && STREQ ("_sigtramp", name))
391 /* Possible values for CALL_DUMMY_LOCATION. */
393 #define BEFORE_TEXT_END 2
394 #define AFTER_TEXT_END 3
395 #define AT_ENTRY_POINT 4
397 #if !defined (USE_GENERIC_DUMMY_FRAMES)
398 #define USE_GENERIC_DUMMY_FRAMES 0
401 #if !defined (CALL_DUMMY_LOCATION)
402 #define CALL_DUMMY_LOCATION ON_STACK
403 #endif /* No CALL_DUMMY_LOCATION. */
405 #if !defined (CALL_DUMMY_ADDRESS)
406 #define CALL_DUMMY_ADDRESS() (internal_error ("CALL_DUMMY_ADDRESS"), 0)
408 #if !defined (CALL_DUMMY_START_OFFSET)
409 #define CALL_DUMMY_START_OFFSET (internal_error ("CALL_DUMMY_START_OFFSET"), 0)
411 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
412 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
413 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error ("CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
415 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
416 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
418 #if !defined (CALL_DUMMY_LENGTH)
419 #define CALL_DUMMY_LENGTH (internal_error ("CALL_DUMMY_LENGTH"), 0)
422 #if defined (CALL_DUMMY_STACK_ADJUST)
423 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
424 #define CALL_DUMMY_STACK_ADJUST_P (1)
427 #if !defined (CALL_DUMMY_STACK_ADJUST)
428 #define CALL_DUMMY_STACK_ADJUST (internal_error ("CALL_DUMMY_STACK_ADJUST"), 0)
430 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
431 #define CALL_DUMMY_STACK_ADJUST_P (0)
434 /* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
435 shouldn't be necessary. */
437 #if !defined (CALL_DUMMY_P)
438 #if defined (CALL_DUMMY)
439 #define CALL_DUMMY_P 1
441 #define CALL_DUMMY_P 0
445 #if !defined PUSH_DUMMY_FRAME
446 #define PUSH_DUMMY_FRAME (internal_error ("PUSH_DUMMY_FRAME"), 0)
449 #if !defined FIX_CALL_DUMMY
450 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error ("FIX_CALL_DUMMY"), 0)
453 #if !defined STORE_STRUCT_RETURN
454 #define STORE_STRUCT_RETURN(a1,a2) (internal_error ("STORE_STRUCT_RETURN"), 0)
458 /* Are we in a call dummy? */
460 extern int pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
461 CORE_ADDR frame_address);
463 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
464 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
465 #endif /* Before text_end. */
468 extern int pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
469 CORE_ADDR frame_address);
471 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
472 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
476 extern int pc_in_call_dummy_on_stack (CORE_ADDR pc, CORE_ADDR sp,
477 CORE_ADDR frame_address);
479 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
480 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
484 extern int pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
485 CORE_ADDR frame_address);
487 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
488 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
492 /* It's often not enough for our clients to know whether the PC is merely
493 somewhere within the call dummy. They may need to know whether the
494 call dummy has actually completed. (For example, wait_for_inferior
495 wants to know when it should truly stop because the call dummy has
496 completed. If we're single-stepping because of slow watchpoints,
497 then we may find ourselves stopped at the entry of the call dummy,
498 and want to continue stepping until we reach the end.)
500 Note that this macro is intended for targets (like HP-UX) which
501 require more than a single breakpoint in their call dummies, and
502 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
504 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
505 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
506 Else, a target may wish to supply an implementation that works in
507 the presense of multiple breakpoints in its call dummy.
509 #if !defined(CALL_DUMMY_HAS_COMPLETED)
510 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
511 PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
514 /* If STARTUP_WITH_SHELL is set, GDB's "run"
515 will attempts to start up the debugee under a shell.
516 This is in order for argument-expansion to occur. E.g.,
518 The "*" gets expanded by the shell into a list of files.
519 While this is a nice feature, it turns out to interact badly
520 with some of the catch-fork/catch-exec features we have added.
521 In particular, if the shell does any fork/exec's before
522 the exec of the target program, that can confuse GDB.
523 To disable this feature, set STARTUP_WITH_SHELL to 0.
524 To enable this feature, set STARTUP_WITH_SHELL to 1.
525 The catch-exec traps expected during start-up will
526 be 1 if target is not started up with a shell, 2 if it is.
528 If you disable this, you need to decrement
529 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
530 #define STARTUP_WITH_SHELL 1
531 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
532 #define START_INFERIOR_TRAPS_EXPECTED 2
534 #endif /* !defined (INFERIOR_H) */