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, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (INFERIOR_H)
27 #include "breakpoint.h"
29 /* For enum target_signal. */
32 /* Structure in which to save the status of the inferior. Create/Save
33 through "save_inferior_status", restore through
34 "restore_inferior_status".
36 This pair of routines should be called around any transfer of
37 control to the inferior which you don't want showing up in your
40 struct inferior_status;
42 extern struct inferior_status *save_inferior_status (int);
44 extern void restore_inferior_status (struct inferior_status *);
46 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
48 extern void discard_inferior_status (struct inferior_status *);
50 extern void write_inferior_status_register (struct inferior_status
51 *inf_status, int regno,
54 extern void set_sigint_trap (void);
56 extern void clear_sigint_trap (void);
58 extern void set_sigio_trap (void);
60 extern void clear_sigio_trap (void);
62 /* File name for default use for standard in/out in the inferior. */
64 extern char *inferior_io_terminal;
66 /* Collected pid, tid, etc. of the debugged inferior. When there's
67 no inferior, PIDGET (inferior_ptid) will be 0. */
69 extern ptid_t inferior_ptid;
71 /* Is the inferior running right now, as a result of a 'run&',
72 'continue&' etc command? This is used in asycn gdb to determine
73 whether a command that the user enters while the target is running
75 extern int target_executing;
77 /* Are we simulating synchronous execution? This is used in async gdb
78 to implement the 'run', 'continue' etc commands, which will not
79 redisplay the prompt until the execution is actually over. */
80 extern int sync_execution;
82 /* This is only valid when inferior_ptid is non-zero.
84 If this is 0, then exec events should be noticed and responded to
85 by the debugger (i.e., be reported to the user).
87 If this is > 0, then that many subsequent exec events should be
88 ignored (i.e., not be reported to the user).
90 extern int inferior_ignoring_startup_exec_events;
92 /* This is only valid when inferior_ignoring_startup_exec_events is
95 Some targets (stupidly) report more than one exec event per actual
96 call to an event() system call. If only the last such exec event
97 need actually be noticed and responded to by the debugger (i.e.,
98 be reported to the user), then this is the number of "leading"
99 exec events which should be ignored.
101 extern int inferior_ignoring_leading_exec_events;
103 /* Inferior environment. */
105 extern struct environ *inferior_environ;
107 extern void clear_proceed_status (void);
109 extern void proceed (CORE_ADDR, enum target_signal, int);
111 /* When set, stop the 'step' command if we enter a function which has
112 no line number information. The normal behavior is that we step
113 over such function. */
114 extern int step_stop_if_no_debug;
116 extern void kill_inferior (void);
118 extern void generic_mourn_inferior (void);
120 extern void terminal_ours (void);
122 extern int run_stack_dummy (CORE_ADDR, char *);
124 extern CORE_ADDR read_pc (void);
126 extern CORE_ADDR read_pc_pid (ptid_t);
128 extern CORE_ADDR generic_target_read_pc (ptid_t);
130 extern void write_pc (CORE_ADDR);
132 extern void write_pc_pid (CORE_ADDR, ptid_t);
134 extern void generic_target_write_pc (CORE_ADDR, ptid_t);
136 extern CORE_ADDR read_sp (void);
138 extern CORE_ADDR generic_target_read_sp (void);
140 extern void write_sp (CORE_ADDR);
142 extern void generic_target_write_sp (CORE_ADDR);
144 extern CORE_ADDR read_fp (void);
146 extern CORE_ADDR generic_target_read_fp (void);
148 extern void write_fp (CORE_ADDR);
150 extern void generic_target_write_fp (CORE_ADDR);
152 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, void *buf);
154 extern void unsigned_address_to_pointer (struct type *type, void *buf,
156 extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
157 extern void address_to_signed_pointer (struct type *type, void *buf,
160 extern void wait_for_inferior (void);
162 extern void fetch_inferior_event (void *);
164 extern void init_wait_for_inferior (void);
166 extern void close_exec_file (void);
168 extern void reopen_exec_file (void);
170 /* The `resume' routine should only be called in special circumstances.
171 Normally, use `proceed', which handles a lot of bookkeeping. */
173 extern void resume (int, enum target_signal);
175 /* From misc files */
177 extern void do_registers_info (int, int);
179 extern void store_inferior_registers (int);
181 extern void fetch_inferior_registers (int);
183 extern void solib_create_inferior_hook (void);
185 extern void child_terminal_info (char *, int);
187 extern void term_info (char *, int);
189 extern void terminal_ours_for_output (void);
191 extern void terminal_inferior (void);
193 extern void terminal_init_inferior (void);
195 extern void terminal_init_inferior_with_pgrp (int pgrp);
197 /* From infptrace.c or infttrace.c */
199 extern int attach (int);
201 #if !defined(REQUIRE_ATTACH)
202 #define REQUIRE_ATTACH attach
205 #if !defined(REQUIRE_DETACH)
206 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
209 extern void detach (int);
211 /* PTRACE method of waiting for inferior process. */
212 int ptrace_wait (ptid_t, int *);
214 extern void child_resume (ptid_t, int, enum target_signal);
216 #ifndef PTRACE_ARG3_TYPE
217 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
220 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
222 extern void pre_fork_inferior (void);
226 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
228 extern ptid_t procfs_first_available (void);
230 /* From fork-child.c */
232 extern void fork_inferior (char *, char *, char **,
234 void (*)(int), void (*)(void), char *);
237 extern void clone_and_follow_inferior (int, int *);
239 extern void startup_inferior (int);
243 extern void new_tty_prefork (char *);
245 extern int gdb_has_a_terminal (void);
249 extern void start_remote (void);
251 extern void normal_stop (void);
253 extern int signal_stop_state (int);
255 extern int signal_print_state (int);
257 extern int signal_pass_state (int);
259 extern int signal_stop_update (int, int);
261 extern int signal_print_update (int, int);
263 extern int signal_pass_update (int, int);
265 extern void get_last_target_status(ptid_t *ptid,
266 struct target_waitstatus *status);
270 extern void tty_command (char *, int);
272 extern void attach_command (char *, int);
274 extern char *get_inferior_args (void);
276 extern char *set_inferior_args (char *);
278 /* Last signal that the inferior received (why it stopped). */
280 extern enum target_signal stop_signal;
282 /* Address at which inferior stopped. */
284 extern CORE_ADDR stop_pc;
286 /* Chain containing status of breakpoint(s) that we have stopped at. */
288 extern bpstat stop_bpstat;
290 /* Flag indicating that a command has proceeded the inferior past the
291 current breakpoint. */
293 extern int breakpoint_proceeded;
295 /* Nonzero if stopped due to a step command. */
297 extern int stop_step;
299 /* Nonzero if stopped due to completion of a stack dummy routine. */
301 extern int stop_stack_dummy;
303 /* Nonzero if program stopped due to a random (unexpected) signal in
306 extern int stopped_by_random_signal;
308 /* Range to single step within.
309 If this is nonzero, respond to a single-step signal
310 by continuing to step if the pc is in this range.
312 If step_range_start and step_range_end are both 1, it means to step for
313 a single instruction (FIXME: it might clean up wait_for_inferior in a
314 minor way if this were changed to the address of the instruction and
315 that address plus one. But maybe not.). */
317 extern CORE_ADDR step_range_start; /* Inclusive */
318 extern CORE_ADDR step_range_end; /* Exclusive */
320 /* Stack frame address as of when stepping command was issued.
321 This is how we know when we step into a subroutine call,
322 and how to set the frame for the breakpoint used to step out. */
324 extern CORE_ADDR step_frame_address;
326 /* Our notion of the current stack pointer. */
328 extern CORE_ADDR step_sp;
330 /* 1 means step over all subroutine calls.
331 -1 means step over calls to undebuggable functions. */
333 enum step_over_calls_kind
337 STEP_OVER_UNDEBUGGABLE
340 extern enum step_over_calls_kind step_over_calls;
342 /* If stepping, nonzero means step count is > 1
343 so don't print frame next time inferior stops
344 if it stops due to stepping. */
346 extern int step_multi;
348 /* Nonzero means expecting a trap and caller will handle it themselves.
349 It is used after attach, due to attaching to a process;
350 when running in the shell before the child program has been exec'd;
351 and when running some kinds of remote stuff (FIXME?). */
353 extern int stop_soon_quietly;
355 /* Nonzero if proceed is being used for a "finish" command or a similar
356 situation when stop_registers should be saved. */
358 extern int proceed_to_finish;
360 /* Save register contents here when about to pop a stack dummy frame,
361 if-and-only-if proceed_to_finish is set.
362 Thus this contains the return value from the called function (assuming
363 values are returned in a register). */
365 extern char *stop_registers;
367 /* Nonzero if the child process in inferior_ptid was attached rather
370 extern int attach_flag;
372 /* Sigtramp is a routine that the kernel calls (which then calls the
373 signal handler). On most machines it is a library routine that
374 is linked into the executable.
376 This macro, given a program counter value and the name of the
377 function in which that PC resides (which can be null if the
378 name is not known), returns nonzero if the PC and name show
379 that we are in sigtramp.
381 On most machines just see if the name is sigtramp (and if we have
382 no name, assume we are not in sigtramp). */
383 #if !defined (IN_SIGTRAMP)
384 #if defined (SIGTRAMP_START)
385 #define IN_SIGTRAMP(pc, name) \
386 ((pc) >= SIGTRAMP_START(pc) \
387 && (pc) < SIGTRAMP_END(pc) \
390 #define IN_SIGTRAMP(pc, name) \
391 (name && STREQ ("_sigtramp", name))
395 /* Possible values for CALL_DUMMY_LOCATION. */
397 #define BEFORE_TEXT_END 2
398 #define AFTER_TEXT_END 3
399 #define AT_ENTRY_POINT 4
401 #if !defined (USE_GENERIC_DUMMY_FRAMES)
402 #define USE_GENERIC_DUMMY_FRAMES 0
405 #if !defined (CALL_DUMMY_LOCATION)
406 #define CALL_DUMMY_LOCATION ON_STACK
407 #endif /* No CALL_DUMMY_LOCATION. */
409 #if !defined (CALL_DUMMY_ADDRESS)
410 #define CALL_DUMMY_ADDRESS() (internal_error (__FILE__, __LINE__, "CALL_DUMMY_ADDRESS"), 0)
412 #if !defined (CALL_DUMMY_START_OFFSET)
413 #define CALL_DUMMY_START_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_START_OFFSET"), 0)
415 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
416 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
417 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
419 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
420 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
422 #if !defined (CALL_DUMMY_LENGTH)
423 #define CALL_DUMMY_LENGTH (internal_error (__FILE__, __LINE__, "CALL_DUMMY_LENGTH"), 0)
426 #if defined (CALL_DUMMY_STACK_ADJUST)
427 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
428 #define CALL_DUMMY_STACK_ADJUST_P (1)
431 #if !defined (CALL_DUMMY_STACK_ADJUST)
432 #define CALL_DUMMY_STACK_ADJUST (internal_error (__FILE__, __LINE__, "CALL_DUMMY_STACK_ADJUST"), 0)
434 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
435 #define CALL_DUMMY_STACK_ADJUST_P (0)
438 /* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
439 shouldn't be necessary. */
441 #if !defined (CALL_DUMMY_P)
442 #if defined (CALL_DUMMY)
443 #define CALL_DUMMY_P 1
445 #define CALL_DUMMY_P 0
449 #if !defined PUSH_DUMMY_FRAME
450 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
453 #if !defined FIX_CALL_DUMMY
454 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error (__FILE__, __LINE__, "FIX_CALL_DUMMY"), 0)
457 #if !defined STORE_STRUCT_RETURN
458 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
462 /* Are we in a call dummy? */
464 extern int pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
465 CORE_ADDR frame_address);
467 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
468 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
469 #endif /* Before text_end. */
472 extern int pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
473 CORE_ADDR frame_address);
475 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
476 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
480 extern int pc_in_call_dummy_on_stack (CORE_ADDR pc, CORE_ADDR sp,
481 CORE_ADDR frame_address);
483 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
484 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
488 extern int pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
489 CORE_ADDR frame_address);
491 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
492 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
496 /* It's often not enough for our clients to know whether the PC is merely
497 somewhere within the call dummy. They may need to know whether the
498 call dummy has actually completed. (For example, wait_for_inferior
499 wants to know when it should truly stop because the call dummy has
500 completed. If we're single-stepping because of slow watchpoints,
501 then we may find ourselves stopped at the entry of the call dummy,
502 and want to continue stepping until we reach the end.)
504 Note that this macro is intended for targets (like HP-UX) which
505 require more than a single breakpoint in their call dummies, and
506 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
508 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
509 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
510 Else, a target may wish to supply an implementation that works in
511 the presense of multiple breakpoints in its call dummy.
513 #if !defined(CALL_DUMMY_HAS_COMPLETED)
514 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
515 PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
518 /* If STARTUP_WITH_SHELL is set, GDB's "run"
519 will attempts to start up the debugee under a shell.
520 This is in order for argument-expansion to occur. E.g.,
522 The "*" gets expanded by the shell into a list of files.
523 While this is a nice feature, it turns out to interact badly
524 with some of the catch-fork/catch-exec features we have added.
525 In particular, if the shell does any fork/exec's before
526 the exec of the target program, that can confuse GDB.
527 To disable this feature, set STARTUP_WITH_SHELL to 0.
528 To enable this feature, set STARTUP_WITH_SHELL to 1.
529 The catch-exec traps expected during start-up will
530 be 1 if target is not started up with a shell, 2 if it is.
532 If you disable this, you need to decrement
533 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
534 #define STARTUP_WITH_SHELL 1
535 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
536 #define START_INFERIOR_TRAPS_EXPECTED 2
538 #endif /* !defined (INFERIOR_H) */