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 /* When set, stop the 'step' command if we enter a function which has
129 no line number information. The normal behavior is that we step
130 over such function. */
131 extern int step_stop_if_no_debug;
133 extern void kill_inferior (void);
135 extern void generic_mourn_inferior (void);
137 extern void terminal_ours (void);
139 extern int run_stack_dummy (CORE_ADDR, char *);
141 extern CORE_ADDR read_pc (void);
143 extern CORE_ADDR read_pc_pid (int);
145 extern CORE_ADDR generic_target_read_pc (int);
147 extern void write_pc (CORE_ADDR);
149 extern void write_pc_pid (CORE_ADDR, int);
151 extern void generic_target_write_pc (CORE_ADDR, int);
153 extern CORE_ADDR read_sp (void);
155 extern CORE_ADDR generic_target_read_sp (void);
157 extern void write_sp (CORE_ADDR);
159 extern void generic_target_write_sp (CORE_ADDR);
161 extern CORE_ADDR read_fp (void);
163 extern CORE_ADDR generic_target_read_fp (void);
165 extern void write_fp (CORE_ADDR);
167 extern void generic_target_write_fp (CORE_ADDR);
169 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, void *buf);
171 extern void unsigned_address_to_pointer (struct type *type, void *buf,
173 extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
174 extern void address_to_signed_pointer (struct type *type, void *buf,
177 extern void wait_for_inferior (void);
179 extern void fetch_inferior_event (void *);
181 extern void init_wait_for_inferior (void);
183 extern void close_exec_file (void);
185 extern void reopen_exec_file (void);
187 /* The `resume' routine should only be called in special circumstances.
188 Normally, use `proceed', which handles a lot of bookkeeping. */
190 extern void resume (int, enum target_signal);
192 /* From misc files */
194 extern void do_registers_info (int, int);
196 extern void store_inferior_registers (int);
198 extern void fetch_inferior_registers (int);
200 extern void solib_create_inferior_hook (void);
202 extern void child_terminal_info (char *, int);
204 extern void term_info (char *, int);
206 extern void terminal_ours_for_output (void);
208 extern void terminal_inferior (void);
210 extern void terminal_init_inferior (void);
212 extern void terminal_init_inferior_with_pgrp (int pgrp);
214 /* From infptrace.c or infttrace.c */
216 extern int attach (int);
218 #if !defined(REQUIRE_ATTACH)
219 #define REQUIRE_ATTACH attach
222 #if !defined(REQUIRE_DETACH)
223 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
226 extern void detach (int);
228 /* PTRACE method of waiting for inferior process. */
229 int ptrace_wait (int, int *);
231 extern void child_resume (int, int, enum target_signal);
233 #ifndef PTRACE_ARG3_TYPE
234 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
237 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
239 extern void pre_fork_inferior (void);
243 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
245 extern int procfs_first_available (void);
247 /* From fork-child.c */
249 extern void fork_inferior (char *, char *, char **,
251 void (*)(int), void (*)(void), char *);
254 extern void clone_and_follow_inferior (int, int *);
256 extern void startup_inferior (int);
260 extern void new_tty_prefork (char *);
262 extern int gdb_has_a_terminal (void);
266 extern void start_remote (void);
268 extern void normal_stop (void);
270 extern int signal_stop_state (int);
272 extern int signal_print_state (int);
274 extern int signal_pass_state (int);
276 extern int signal_stop_update (int, int);
278 extern int signal_print_update (int, int);
280 extern int signal_pass_update (int, int);
284 extern void tty_command (char *, int);
286 extern void attach_command (char *, int);
288 extern char *get_inferior_arg (void);
290 extern char *set_inferior_arg (char *);
292 /* Last signal that the inferior received (why it stopped). */
294 extern enum target_signal stop_signal;
296 /* Address at which inferior stopped. */
298 extern CORE_ADDR stop_pc;
300 /* Chain containing status of breakpoint(s) that we have stopped at. */
302 extern bpstat stop_bpstat;
304 /* Flag indicating that a command has proceeded the inferior past the
305 current breakpoint. */
307 extern int breakpoint_proceeded;
309 /* Nonzero if stopped due to a step command. */
311 extern int stop_step;
313 /* Nonzero if stopped due to completion of a stack dummy routine. */
315 extern int stop_stack_dummy;
317 /* Nonzero if program stopped due to a random (unexpected) signal in
320 extern int stopped_by_random_signal;
322 /* Range to single step within.
323 If this is nonzero, respond to a single-step signal
324 by continuing to step if the pc is in this range.
326 If step_range_start and step_range_end are both 1, it means to step for
327 a single instruction (FIXME: it might clean up wait_for_inferior in a
328 minor way if this were changed to the address of the instruction and
329 that address plus one. But maybe not.). */
331 extern CORE_ADDR step_range_start; /* Inclusive */
332 extern CORE_ADDR step_range_end; /* Exclusive */
334 /* Stack frame address as of when stepping command was issued.
335 This is how we know when we step into a subroutine call,
336 and how to set the frame for the breakpoint used to step out. */
338 extern CORE_ADDR step_frame_address;
340 /* Our notion of the current stack pointer. */
342 extern CORE_ADDR step_sp;
344 /* 1 means step over all subroutine calls.
345 -1 means step over calls to undebuggable functions. */
347 enum step_over_calls_kind
351 STEP_OVER_UNDEBUGGABLE
354 extern enum step_over_calls_kind step_over_calls;
356 /* If stepping, nonzero means step count is > 1
357 so don't print frame next time inferior stops
358 if it stops due to stepping. */
360 extern int step_multi;
362 /* Nonzero means expecting a trap and caller will handle it themselves.
363 It is used after attach, due to attaching to a process;
364 when running in the shell before the child program has been exec'd;
365 and when running some kinds of remote stuff (FIXME?). */
367 extern int stop_soon_quietly;
369 /* Nonzero if proceed is being used for a "finish" command or a similar
370 situation when stop_registers should be saved. */
372 extern int proceed_to_finish;
374 /* Save register contents here when about to pop a stack dummy frame,
375 if-and-only-if proceed_to_finish is set.
376 Thus this contains the return value from the called function (assuming
377 values are returned in a register). */
379 extern char *stop_registers;
381 /* Nonzero if the child process in inferior_pid was attached rather
384 extern int attach_flag;
386 /* Sigtramp is a routine that the kernel calls (which then calls the
387 signal handler). On most machines it is a library routine that
388 is linked into the executable.
390 This macro, given a program counter value and the name of the
391 function in which that PC resides (which can be null if the
392 name is not known), returns nonzero if the PC and name show
393 that we are in sigtramp.
395 On most machines just see if the name is sigtramp (and if we have
396 no name, assume we are not in sigtramp). */
397 #if !defined (IN_SIGTRAMP)
398 #if defined (SIGTRAMP_START)
399 #define IN_SIGTRAMP(pc, name) \
400 ((pc) >= SIGTRAMP_START(pc) \
401 && (pc) < SIGTRAMP_END(pc) \
404 #define IN_SIGTRAMP(pc, name) \
405 (name && STREQ ("_sigtramp", name))
409 /* Possible values for CALL_DUMMY_LOCATION. */
411 #define BEFORE_TEXT_END 2
412 #define AFTER_TEXT_END 3
413 #define AT_ENTRY_POINT 4
415 #if !defined (USE_GENERIC_DUMMY_FRAMES)
416 #define USE_GENERIC_DUMMY_FRAMES 0
419 #if !defined (CALL_DUMMY_LOCATION)
420 #define CALL_DUMMY_LOCATION ON_STACK
421 #endif /* No CALL_DUMMY_LOCATION. */
423 #if !defined (CALL_DUMMY_ADDRESS)
424 #define CALL_DUMMY_ADDRESS() (internal_error ("CALL_DUMMY_ADDRESS"), 0)
426 #if !defined (CALL_DUMMY_START_OFFSET)
427 #define CALL_DUMMY_START_OFFSET (internal_error ("CALL_DUMMY_START_OFFSET"), 0)
429 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
430 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
431 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error ("CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
433 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
434 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
436 #if !defined (CALL_DUMMY_LENGTH)
437 #define CALL_DUMMY_LENGTH (internal_error ("CALL_DUMMY_LENGTH"), 0)
440 #if defined (CALL_DUMMY_STACK_ADJUST)
441 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
442 #define CALL_DUMMY_STACK_ADJUST_P (1)
445 #if !defined (CALL_DUMMY_STACK_ADJUST)
446 #define CALL_DUMMY_STACK_ADJUST (internal_error ("CALL_DUMMY_STACK_ADJUST"), 0)
448 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
449 #define CALL_DUMMY_STACK_ADJUST_P (0)
452 /* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
453 shouldn't be necessary. */
455 #if !defined (CALL_DUMMY_P)
456 #if defined (CALL_DUMMY)
457 #define CALL_DUMMY_P 1
459 #define CALL_DUMMY_P 0
463 #if !defined PUSH_DUMMY_FRAME
464 #define PUSH_DUMMY_FRAME (internal_error ("PUSH_DUMMY_FRAME"), 0)
467 #if !defined FIX_CALL_DUMMY
468 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error ("FIX_CALL_DUMMY"), 0)
471 #if !defined STORE_STRUCT_RETURN
472 #define STORE_STRUCT_RETURN(a1,a2) (internal_error ("STORE_STRUCT_RETURN"), 0)
476 /* Are we in a call dummy? */
478 extern int pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
479 CORE_ADDR frame_address);
481 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
482 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
483 #endif /* Before text_end. */
486 extern int pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
487 CORE_ADDR frame_address);
489 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
490 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
494 extern int pc_in_call_dummy_on_stack (CORE_ADDR pc, CORE_ADDR sp,
495 CORE_ADDR frame_address);
497 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
498 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
502 extern int pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
503 CORE_ADDR frame_address);
505 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
506 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
510 /* It's often not enough for our clients to know whether the PC is merely
511 somewhere within the call dummy. They may need to know whether the
512 call dummy has actually completed. (For example, wait_for_inferior
513 wants to know when it should truly stop because the call dummy has
514 completed. If we're single-stepping because of slow watchpoints,
515 then we may find ourselves stopped at the entry of the call dummy,
516 and want to continue stepping until we reach the end.)
518 Note that this macro is intended for targets (like HP-UX) which
519 require more than a single breakpoint in their call dummies, and
520 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
522 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
523 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
524 Else, a target may wish to supply an implementation that works in
525 the presense of multiple breakpoints in its call dummy.
527 #if !defined(CALL_DUMMY_HAS_COMPLETED)
528 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
529 PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
532 /* If STARTUP_WITH_SHELL is set, GDB's "run"
533 will attempts to start up the debugee under a shell.
534 This is in order for argument-expansion to occur. E.g.,
536 The "*" gets expanded by the shell into a list of files.
537 While this is a nice feature, it turns out to interact badly
538 with some of the catch-fork/catch-exec features we have added.
539 In particular, if the shell does any fork/exec's before
540 the exec of the target program, that can confuse GDB.
541 To disable this feature, set STARTUP_WITH_SHELL to 0.
542 To enable this feature, set STARTUP_WITH_SHELL to 1.
543 The catch-exec traps expected during start-up will
544 be 1 if target is not started up with a shell, 2 if it is.
546 If you disable this, you need to decrement
547 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
548 #define STARTUP_WITH_SHELL 1
549 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
550 #define START_INFERIOR_TRAPS_EXPECTED 2
552 #endif /* !defined (INFERIOR_H) */