1 /* Variables that describe the inferior process running under GDB:
2 Where it is, why it stopped, and how to step it.
4 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
5 1996, 1998, 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 #if !defined (INFERIOR_H)
27 struct target_waitstatus;
35 #include "breakpoint.h"
37 /* For enum target_signal. */
40 /* For struct frame_id. */
43 /* Structure in which to save the status of the inferior. Create/Save
44 through "save_inferior_status", restore through
45 "restore_inferior_status".
47 This pair of routines should be called around any transfer of
48 control to the inferior which you don't want showing up in your
51 struct inferior_status;
53 extern struct inferior_status *save_inferior_status (int);
55 extern void restore_inferior_status (struct inferior_status *);
57 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
59 extern void discard_inferior_status (struct inferior_status *);
61 extern void write_inferior_status_register (struct inferior_status
62 *inf_status, int regno,
65 /* The -1 ptid, often used to indicate either an error condition
66 or a "don't care" condition, i.e, "run all threads." */
67 extern ptid_t minus_one_ptid;
69 /* The null or zero ptid, often used to indicate no process. */
70 extern ptid_t null_ptid;
72 /* Attempt to find and return an existing ptid with the given PID, LWP,
73 and TID components. If none exists, create a new one and return
75 ptid_t ptid_build (int pid, long lwp, long tid);
77 /* Find/Create a ptid from just a pid. */
78 ptid_t pid_to_ptid (int pid);
80 /* Fetch the pid (process id) component from a ptid. */
81 int ptid_get_pid (ptid_t ptid);
83 /* Fetch the lwp (lightweight process) component from a ptid. */
84 long ptid_get_lwp (ptid_t ptid);
86 /* Fetch the tid (thread id) component from a ptid. */
87 long ptid_get_tid (ptid_t ptid);
89 /* Compare two ptids to see if they are equal */
90 extern int ptid_equal (ptid_t p1, ptid_t p2);
92 /* Save value of inferior_ptid so that it may be restored by
93 a later call to do_cleanups(). Returns the struct cleanup
94 pointer needed for later doing the cleanup. */
95 extern struct cleanup * save_inferior_ptid (void);
97 extern void set_sigint_trap (void);
99 extern void clear_sigint_trap (void);
101 extern void set_sigio_trap (void);
103 extern void clear_sigio_trap (void);
105 /* File name for default use for standard in/out in the inferior. */
107 extern char *inferior_io_terminal;
109 /* Collected pid, tid, etc. of the debugged inferior. When there's
110 no inferior, PIDGET (inferior_ptid) will be 0. */
112 extern ptid_t inferior_ptid;
114 /* Is the inferior running right now, as a result of a 'run&',
115 'continue&' etc command? This is used in asycn gdb to determine
116 whether a command that the user enters while the target is running
117 is allowed or not. */
118 extern int target_executing;
120 /* Are we simulating synchronous execution? This is used in async gdb
121 to implement the 'run', 'continue' etc commands, which will not
122 redisplay the prompt until the execution is actually over. */
123 extern int sync_execution;
125 /* This is only valid when inferior_ptid is non-zero.
127 If this is 0, then exec events should be noticed and responded to
128 by the debugger (i.e., be reported to the user).
130 If this is > 0, then that many subsequent exec events should be
131 ignored (i.e., not be reported to the user).
133 extern int inferior_ignoring_startup_exec_events;
135 /* This is only valid when inferior_ignoring_startup_exec_events is
138 Some targets (stupidly) report more than one exec event per actual
139 call to an event() system call. If only the last such exec event
140 need actually be noticed and responded to by the debugger (i.e.,
141 be reported to the user), then this is the number of "leading"
142 exec events which should be ignored.
144 extern int inferior_ignoring_leading_exec_events;
146 /* Inferior environment. */
148 extern struct environ *inferior_environ;
150 extern void clear_proceed_status (void);
152 extern void proceed (CORE_ADDR, enum target_signal, int);
154 /* When set, stop the 'step' command if we enter a function which has
155 no line number information. The normal behavior is that we step
156 over such function. */
157 extern int step_stop_if_no_debug;
159 extern void kill_inferior (void);
161 extern void generic_mourn_inferior (void);
163 extern void terminal_save_ours (void);
165 extern void terminal_ours (void);
167 extern CORE_ADDR read_pc (void);
169 extern CORE_ADDR read_pc_pid (ptid_t);
171 extern void write_pc (CORE_ADDR);
173 extern void write_pc_pid (CORE_ADDR, ptid_t);
175 extern void generic_target_write_pc (CORE_ADDR, ptid_t);
177 extern CORE_ADDR read_sp (void);
179 extern void deprecated_write_sp (CORE_ADDR);
181 extern CORE_ADDR deprecated_read_fp (void);
183 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, const void *buf);
185 extern void unsigned_address_to_pointer (struct type *type, void *buf,
187 extern CORE_ADDR signed_pointer_to_address (struct type *type,
189 extern void address_to_signed_pointer (struct type *type, void *buf,
192 extern void wait_for_inferior (void);
194 extern void fetch_inferior_event (void *);
196 extern void init_wait_for_inferior (void);
198 extern void close_exec_file (void);
200 extern void reopen_exec_file (void);
202 /* The `resume' routine should only be called in special circumstances.
203 Normally, use `proceed', which handles a lot of bookkeeping. */
205 extern void resume (int, enum target_signal);
207 /* From misc files */
209 extern void default_print_registers_info (struct gdbarch *gdbarch,
210 struct ui_file *file,
211 struct frame_info *frame,
212 int regnum, int all);
214 extern void store_inferior_registers (int);
216 extern void fetch_inferior_registers (int);
218 extern void solib_create_inferior_hook (void);
220 extern void child_terminal_info (char *, int);
222 extern void term_info (char *, int);
224 extern void terminal_ours_for_output (void);
226 extern void terminal_inferior (void);
228 extern void terminal_init_inferior (void);
230 extern void terminal_init_inferior_with_pgrp (int pgrp);
232 /* From infptrace.c or infttrace.c */
234 extern int attach (int);
236 extern void detach (int);
238 /* PTRACE method of waiting for inferior process. */
239 int ptrace_wait (ptid_t, int *);
241 extern void child_resume (ptid_t, int, enum target_signal);
243 #ifndef PTRACE_ARG3_TYPE
244 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
247 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
249 extern void pre_fork_inferior (void);
253 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
255 extern ptid_t procfs_first_available (void);
257 /* From fork-child.c */
259 extern void fork_inferior (char *, char *, char **,
261 void (*)(int), void (*)(void), char *);
264 extern void startup_inferior (int);
266 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
270 extern void new_tty_prefork (char *);
272 extern int gdb_has_a_terminal (void);
276 extern void start_remote (void);
278 extern void normal_stop (void);
280 extern int signal_stop_state (int);
282 extern int signal_print_state (int);
284 extern int signal_pass_state (int);
286 extern int signal_stop_update (int, int);
288 extern int signal_print_update (int, int);
290 extern int signal_pass_update (int, int);
292 extern void get_last_target_status(ptid_t *ptid,
293 struct target_waitstatus *status);
295 extern void follow_inferior_reset_breakpoints (void);
299 extern void tty_command (char *, int);
301 extern void attach_command (char *, int);
303 extern char *get_inferior_args (void);
305 extern char *set_inferior_args (char *);
307 extern void set_inferior_args_vector (int, char **);
309 extern void registers_info (char *, int);
311 extern void nexti_command (char *, int);
313 extern void stepi_command (char *, int);
315 extern void continue_command (char *, int);
317 extern void interrupt_target_command (char *args, int from_tty);
319 /* Last signal that the inferior received (why it stopped). */
321 extern enum target_signal stop_signal;
323 /* Address at which inferior stopped. */
325 extern CORE_ADDR stop_pc;
327 /* Chain containing status of breakpoint(s) that we have stopped at. */
329 extern bpstat stop_bpstat;
331 /* Flag indicating that a command has proceeded the inferior past the
332 current breakpoint. */
334 extern int breakpoint_proceeded;
336 /* Nonzero if stopped due to a step command. */
338 extern int stop_step;
340 /* Nonzero if stopped due to completion of a stack dummy routine. */
342 extern int stop_stack_dummy;
344 /* Nonzero if program stopped due to a random (unexpected) signal in
347 extern int stopped_by_random_signal;
349 /* Range to single step within.
350 If this is nonzero, respond to a single-step signal
351 by continuing to step if the pc is in this range.
353 If step_range_start and step_range_end are both 1, it means to step for
354 a single instruction (FIXME: it might clean up wait_for_inferior in a
355 minor way if this were changed to the address of the instruction and
356 that address plus one. But maybe not.). */
358 extern CORE_ADDR step_range_start; /* Inclusive */
359 extern CORE_ADDR step_range_end; /* Exclusive */
361 /* Stack frame address as of when stepping command was issued.
362 This is how we know when we step into a subroutine call,
363 and how to set the frame for the breakpoint used to step out. */
365 extern struct frame_id step_frame_id;
367 /* Our notion of the current stack pointer. */
369 extern CORE_ADDR step_sp;
371 /* 1 means step over all subroutine calls.
372 -1 means step over calls to undebuggable functions. */
374 enum step_over_calls_kind
378 STEP_OVER_UNDEBUGGABLE
381 extern enum step_over_calls_kind step_over_calls;
383 /* If stepping, nonzero means step count is > 1
384 so don't print frame next time inferior stops
385 if it stops due to stepping. */
387 extern int step_multi;
389 /* Nonzero means expecting a trap and caller will handle it
390 themselves. It is used when running in the shell before the child
391 program has been exec'd; and when running some kinds of remote
394 /* It is also used after attach, due to attaching to a process. This
395 is a bit trickier. When doing an attach, the kernel stops the
396 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
397 the handling of SIGSTOP for a ptraced process has changed. Earlier
398 versions of the kernel would ignore these SIGSTOPs, while now
399 SIGSTOP is treated like any other signal, i.e. it is not muffled.
401 If the gdb user does a 'continue' after the 'attach', gdb passes
402 the global variable stop_signal (which stores the signal from the
403 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
404 problematic, because the kernel doesn't ignore such SIGSTOP
405 now. I.e. it is reported back to gdb, which in turn presents it
408 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
409 gdb to clear the value of stop_signal after the attach, so that it
410 is not passed back down to the kernel. */
416 STOP_QUIETLY_NO_SIGSTOP
419 extern enum stop_kind stop_soon;
421 /* Nonzero if proceed is being used for a "finish" command or a similar
422 situation when stop_registers should be saved. */
424 extern int proceed_to_finish;
426 /* Save register contents here when about to pop a stack dummy frame,
427 if-and-only-if proceed_to_finish is set.
428 Thus this contains the return value from the called function (assuming
429 values are returned in a register). */
431 extern struct regcache *stop_registers;
433 /* Nonzero if the child process in inferior_ptid was attached rather
436 extern int attach_flag;
438 /* Possible values for CALL_DUMMY_LOCATION. */
440 #define AT_ENTRY_POINT 4
443 /* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
444 shouldn't be necessary. */
446 #if !defined PUSH_DUMMY_FRAME
447 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
450 #if !defined STORE_STRUCT_RETURN
451 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
455 /* Are we in a call dummy? */
457 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
458 dummy frames, and use generic_pc_in_call_dummy(). The generic
459 version should be able to handle all cases since that code works by
460 saving the address of the dummy's breakpoint (where ever it is). */
462 extern int deprecated_pc_in_call_dummy_on_stack (CORE_ADDR pc,
464 CORE_ADDR frame_address);
466 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
467 dummy frames, and use generic_pc_in_call_dummy(). The generic
468 version should be able to handle all cases since that code works by
469 saving the address of the dummy's breakpoint (where ever it is). */
471 extern int deprecated_pc_in_call_dummy_at_entry_point (CORE_ADDR pc,
473 CORE_ADDR frame_address);
475 /* If STARTUP_WITH_SHELL is set, GDB's "run"
476 will attempts to start up the debugee under a shell.
477 This is in order for argument-expansion to occur. E.g.,
479 The "*" gets expanded by the shell into a list of files.
480 While this is a nice feature, it turns out to interact badly
481 with some of the catch-fork/catch-exec features we have added.
482 In particular, if the shell does any fork/exec's before
483 the exec of the target program, that can confuse GDB.
484 To disable this feature, set STARTUP_WITH_SHELL to 0.
485 To enable this feature, set STARTUP_WITH_SHELL to 1.
486 The catch-exec traps expected during start-up will
487 be 1 if target is not started up with a shell, 2 if it is.
489 If you disable this, you need to decrement
490 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
491 #define STARTUP_WITH_SHELL 1
492 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
493 #define START_INFERIOR_TRAPS_EXPECTED 2
495 #endif /* !defined (INFERIOR_H) */