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, Boston, MA 02111-1307, USA. */
21 #if !defined (INFERIOR_H)
25 #include "breakpoint.h"
27 /* For enum target_signal. */
30 /* Structure in which to save the status of the inferior. Create/Save
31 through "save_inferior_status", restore through
32 "restore_inferior_status".
34 This pair of routines should be called around any transfer of
35 control to the inferior which you don't want showing up in your
39 struct inferior_status
;
42 extern struct inferior_status
*save_inferior_status
PARAMS ((int));
44 extern void restore_inferior_status
PARAMS ((struct inferior_status
*));
46 extern void discard_inferior_status
PARAMS ((struct inferior_status
*));
48 extern void write_inferior_status_register
PARAMS ((struct inferior_status
*inf_status
, int regno
, LONGEST val
));
50 /* This macro gives the number of registers actually in use by the
51 inferior. This may be less than the total number of registers,
52 perhaps depending on the actual CPU in use or program being run. */
55 #define ARCH_NUM_REGS NUM_REGS
58 extern void set_sigint_trap
PARAMS ((void));
60 extern void clear_sigint_trap
PARAMS ((void));
62 extern void set_sigio_trap
PARAMS ((void));
64 extern void clear_sigio_trap
PARAMS ((void));
66 /* File name for default use for standard in/out in the inferior. */
68 extern char *inferior_io_terminal
;
70 /* Pid of our debugged inferior, or 0 if no inferior now. */
72 extern int inferior_pid
;
74 /* This is only valid when inferior_pid is non-zero.
76 If this is 0, then exec events should be noticed and responded to
77 by the debugger (i.e., be reported to the user).
79 If this is > 0, then that many subsequent exec events should be
80 ignored (i.e., not be reported to the user).
82 extern int inferior_ignoring_startup_exec_events
;
84 /* This is only valid when inferior_ignoring_startup_exec_events is
87 Some targets (stupidly) report more than one exec event per actual
88 call to an event() system call. If only the last such exec event
89 need actually be noticed and responded to by the debugger (i.e.,
90 be reported to the user), then this is the number of "leading"
91 exec events which should be ignored.
93 extern int inferior_ignoring_leading_exec_events
;
95 /* Inferior environment. */
97 extern struct environ
*inferior_environ
;
99 /* Character array containing an image of the inferior programs'
102 extern char *registers
;
104 /* Character array containing the current state of each register
105 (unavailable<0, valid=0, invalid>0). */
107 extern signed char *register_valid
;
109 extern void clear_proceed_status
PARAMS ((void));
111 extern void proceed
PARAMS ((CORE_ADDR
, enum target_signal
, int));
113 extern void kill_inferior
PARAMS ((void));
115 extern void generic_mourn_inferior
PARAMS ((void));
117 extern void terminal_ours
PARAMS ((void));
119 extern int run_stack_dummy
PARAMS ((CORE_ADDR
, char*));
121 extern CORE_ADDR read_pc
PARAMS ((void));
123 extern CORE_ADDR read_pc_pid
PARAMS ((int));
125 extern CORE_ADDR generic_target_read_pc
PARAMS ((int));
127 extern void write_pc
PARAMS ((CORE_ADDR
));
129 extern void write_pc_pid
PARAMS ((CORE_ADDR
, int));
131 extern void generic_target_write_pc
PARAMS ((CORE_ADDR
, int));
133 extern CORE_ADDR read_sp
PARAMS ((void));
135 extern CORE_ADDR generic_target_read_sp
PARAMS ((void));
137 extern void write_sp
PARAMS ((CORE_ADDR
));
139 extern void generic_target_write_sp
PARAMS ((CORE_ADDR
));
141 extern CORE_ADDR read_fp
PARAMS ((void));
143 extern CORE_ADDR generic_target_read_fp
PARAMS ((void));
145 extern void write_fp
PARAMS ((CORE_ADDR
));
147 extern void generic_target_write_fp
PARAMS ((CORE_ADDR
));
149 extern void wait_for_inferior
PARAMS ((void));
151 extern void init_wait_for_inferior
PARAMS ((void));
153 extern void close_exec_file
PARAMS ((void));
155 extern void reopen_exec_file
PARAMS ((void));
157 /* The `resume' routine should only be called in special circumstances.
158 Normally, use `proceed', which handles a lot of bookkeeping. */
160 extern void resume
PARAMS ((int, enum target_signal
));
162 /* From misc files */
164 extern void store_inferior_registers
PARAMS ((int));
166 extern void fetch_inferior_registers
PARAMS ((int));
168 extern void solib_create_inferior_hook
PARAMS ((void));
170 extern void child_terminal_info
PARAMS ((char *, int));
172 extern void term_info
PARAMS ((char *, int));
174 extern void terminal_ours_for_output
PARAMS ((void));
176 extern void terminal_inferior
PARAMS ((void));
178 extern void terminal_init_inferior
PARAMS ((void));
180 extern void terminal_init_inferior_with_pgrp
PARAMS ((int pgrp
));
182 /* From infptrace.c or infttrace.c */
184 extern int attach
PARAMS ((int));
186 #if !defined(REQUIRE_ATTACH)
187 #define REQUIRE_ATTACH attach
190 #if !defined(REQUIRE_DETACH)
191 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
194 extern void detach
PARAMS ((int));
196 /* PTRACE method of waiting for inferior process. */
197 int ptrace_wait
PARAMS ((int, int *));
199 extern void child_resume
PARAMS ((int, int, enum target_signal
));
201 #ifndef PTRACE_ARG3_TYPE
202 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
205 extern int call_ptrace
PARAMS ((int, int, PTRACE_ARG3_TYPE
, int));
207 extern void pre_fork_inferior
PARAMS ((void));
211 extern int proc_iterate_over_mappings
PARAMS ((int (*)(int, CORE_ADDR
)));
213 extern int procfs_first_available
PARAMS ((void));
215 extern int procfs_get_pid_fd
PARAMS ((int));
217 /* From fork-child.c */
219 extern void fork_inferior
PARAMS ((char *, char *, char **,
227 clone_and_follow_inferior
PARAMS ((int, int *));
229 extern void startup_inferior
PARAMS ((int));
233 extern void new_tty_prefork
PARAMS ((char *));
235 extern int gdb_has_a_terminal
PARAMS ((void));
239 extern void start_remote
PARAMS ((void));
241 extern void normal_stop
PARAMS ((void));
243 extern int signal_stop_state
PARAMS ((int));
245 extern int signal_print_state
PARAMS ((int));
247 extern int signal_pass_state
PARAMS ((int));
251 extern void tty_command
PARAMS ((char *, int));
253 extern void attach_command
PARAMS ((char *, int));
255 /* Last signal that the inferior received (why it stopped). */
257 extern enum target_signal stop_signal
;
259 /* Address at which inferior stopped. */
261 extern CORE_ADDR stop_pc
;
263 /* Chain containing status of breakpoint(s) that we have stopped at. */
265 extern bpstat stop_bpstat
;
267 /* Flag indicating that a command has proceeded the inferior past the
268 current breakpoint. */
270 extern int breakpoint_proceeded
;
272 /* Nonzero if stopped due to a step command. */
274 extern int stop_step
;
276 /* Nonzero if stopped due to completion of a stack dummy routine. */
278 extern int stop_stack_dummy
;
280 /* Nonzero if program stopped due to a random (unexpected) signal in
283 extern int stopped_by_random_signal
;
285 /* Range to single step within.
286 If this is nonzero, respond to a single-step signal
287 by continuing to step if the pc is in this range.
289 If step_range_start and step_range_end are both 1, it means to step for
290 a single instruction (FIXME: it might clean up wait_for_inferior in a
291 minor way if this were changed to the address of the instruction and
292 that address plus one. But maybe not.). */
294 extern CORE_ADDR step_range_start
; /* Inclusive */
295 extern CORE_ADDR step_range_end
;/* Exclusive */
297 /* Stack frame address as of when stepping command was issued.
298 This is how we know when we step into a subroutine call,
299 and how to set the frame for the breakpoint used to step out. */
301 extern CORE_ADDR step_frame_address
;
303 /* Our notion of the current stack pointer. */
305 extern CORE_ADDR step_sp
;
307 /* 1 means step over all subroutine calls.
308 -1 means step over calls to undebuggable functions. */
310 extern int step_over_calls
;
312 /* If stepping, nonzero means step count is > 1
313 so don't print frame next time inferior stops
314 if it stops due to stepping. */
316 extern int step_multi
;
318 /* Nonzero means expecting a trap and caller will handle it themselves.
319 It is used after attach, due to attaching to a process;
320 when running in the shell before the child program has been exec'd;
321 and when running some kinds of remote stuff (FIXME?). */
323 extern int stop_soon_quietly
;
325 /* Nonzero if proceed is being used for a "finish" command or a similar
326 situation when stop_registers should be saved. */
328 extern int proceed_to_finish
;
330 /* Save register contents here when about to pop a stack dummy frame,
331 if-and-only-if proceed_to_finish is set.
332 Thus this contains the return value from the called function (assuming
333 values are returned in a register). */
335 extern char *stop_registers
;
337 /* Nonzero if the child process in inferior_pid was attached rather
340 extern int attach_flag
;
342 /* Sigtramp is a routine that the kernel calls (which then calls the
343 signal handler). On most machines it is a library routine that
344 is linked into the executable.
346 This macro, given a program counter value and the name of the
347 function in which that PC resides (which can be null if the
348 name is not known), returns nonzero if the PC and name show
349 that we are in sigtramp.
351 On most machines just see if the name is sigtramp (and if we have
352 no name, assume we are not in sigtramp). */
353 #if !defined (IN_SIGTRAMP)
354 #if defined (SIGTRAMP_START)
355 #define IN_SIGTRAMP(pc, name) \
356 ((pc) >= SIGTRAMP_START(pc) \
357 && (pc) < SIGTRAMP_END(pc) \
360 #define IN_SIGTRAMP(pc, name) \
361 (name && STREQ ("_sigtramp", name))
365 /* Possible values for CALL_DUMMY_LOCATION. */
367 #define BEFORE_TEXT_END 2
368 #define AFTER_TEXT_END 3
369 #define AT_ENTRY_POINT 4
371 #if !defined (USE_GENERIC_DUMMY_FRAMES)
372 #define USE_GENERIC_DUMMY_FRAMES 0
375 #if !defined (CALL_DUMMY_LOCATION)
376 #define CALL_DUMMY_LOCATION ON_STACK
377 #endif /* No CALL_DUMMY_LOCATION. */
379 #if !defined (CALL_DUMMY_ADDRESS)
380 #define CALL_DUMMY_ADDRESS() (abort (), 0) /* anything to abort GDB */
382 #if !defined (CALL_DUMMY_START_OFFSET)
383 #define CALL_DUMMY_START_OFFSET (abort (), 0) /* anything to abort GDB */
385 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
386 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
387 #define CALL_DUMMY_BREAKPOINT_OFFSET (abort (), 0) /* anything to abort GDB */
389 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
390 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
392 #if !defined (CALL_DUMMY_LENGTH)
393 #define CALL_DUMMY_LENGTH (abort (), 0) /* anything to abort GDB */
396 #if defined (CALL_DUMMY_STACK_ADJUST)
397 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
398 #define CALL_DUMMY_STACK_ADJUST_P (1)
401 #if !defined (CALL_DUMMY_STACK_ADJUST)
402 #define CALL_DUMMY_STACK_ADJUST (abort (), 0)
404 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
405 #define CALL_DUMMY_STACK_ADJUST_P (0)
408 #if !defined (CALL_DUMMY_P)
409 #if defined (CALL_DUMMY)
410 #define CALL_DUMMY_P 1
412 #define CALL_DUMMY_P 0
416 #if !defined (CALL_DUMMY_WORDS)
417 #if defined (CALL_DUMMY)
418 extern LONGEST call_dummy_words
[];
419 #define CALL_DUMMY_WORDS (call_dummy_words)
421 #define CALL_DUMMY_WORDS (abort (), (void*) 0) /* anything to abort GDB */
425 #if !defined (SIZEOF_CALL_DUMMY_WORDS)
426 #if defined (CALL_DUMMY)
427 extern int sizeof_call_dummy_words
;
428 #define SIZEOF_CALL_DUMMY_WORDS (sizeof_call_dummy_words)
430 #define SIZEOF_CALL_DUMMY_WORDS (abort (), 0) /* anything to abort GDB */
434 #if !defined PUSH_DUMMY_FRAME
435 #define PUSH_DUMMY_FRAME (abort ())
438 #if !defined FIX_CALL_DUMMY
439 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (abort ())
442 #if !defined STORE_STRUCT_RETURN
443 #define STORE_STRUCT_RETURN(a1,a2) (abort ())
447 /* Are we in a call dummy? */
449 extern int pc_in_call_dummy_before_text_end
PARAMS ((CORE_ADDR pc
, CORE_ADDR sp
, CORE_ADDR frame_address
));
451 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
452 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
453 #endif /* Before text_end. */
456 extern int pc_in_call_dummy_after_text_end
PARAMS ((CORE_ADDR pc
, CORE_ADDR sp
, CORE_ADDR frame_address
));
458 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
459 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
463 extern int pc_in_call_dummy_on_stack
PARAMS ((CORE_ADDR pc
, CORE_ADDR sp
, CORE_ADDR frame_address
));
465 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
466 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
470 extern int pc_in_call_dummy_at_entry_point
PARAMS ((CORE_ADDR pc
, CORE_ADDR sp
, CORE_ADDR frame_address
));
472 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
473 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
477 /* It's often not enough for our clients to know whether the PC is merely
478 somewhere within the call dummy. They may need to know whether the
479 call dummy has actually completed. (For example, wait_for_inferior
480 wants to know when it should truly stop because the call dummy has
481 completed. If we're single-stepping because of slow watchpoints,
482 then we may find ourselves stopped at the entry of the call dummy,
483 and want to continue stepping until we reach the end.)
485 Note that this macro is intended for targets (like HP-UX) which
486 require more than a single breakpoint in their call dummies, and
487 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
489 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
490 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
491 Else, a target may wish to supply an implementation that works in
492 the presense of multiple breakpoints in its call dummy.
494 #if !defined(CALL_DUMMY_HAS_COMPLETED)
495 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
496 PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
499 /* If STARTUP_WITH_SHELL is set, GDB's "run"
500 will attempts to start up the debugee under a shell.
501 This is in order for argument-expansion to occur. E.g.,
503 The "*" gets expanded by the shell into a list of files.
504 While this is a nice feature, it turns out to interact badly
505 with some of the catch-fork/catch-exec features we have added.
506 In particular, if the shell does any fork/exec's before
507 the exec of the target program, that can confuse GDB.
508 To disable this feature, set STARTUP_WITH_SHELL to 0.
509 To enable this feature, set STARTUP_WITH_SHELL to 1.
510 The catch-exec traps expected during start-up will
511 be 1 if target is not started up with a shell, 2 if it is.
513 If you disable this, you need to decrement
514 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
515 #define STARTUP_WITH_SHELL 1
516 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
517 #define START_INFERIOR_TRAPS_EXPECTED 2
519 #endif /* !defined (INFERIOR_H) */