1 /* Variables that describe the inferior process running under GDB:
2 Where it is, why it stopped, and how to step it.
4 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
5 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006, 2007
6 Free Software Foundation, Inc.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA. */
25 #if !defined (INFERIOR_H)
28 struct target_waitstatus;
36 #include "breakpoint.h"
38 /* For enum target_signal. */
41 /* For struct frame_id. */
44 /* Structure in which to save the status of the inferior. Create/Save
45 through "save_inferior_status", restore through
46 "restore_inferior_status".
48 This pair of routines should be called around any transfer of
49 control to the inferior which you don't want showing up in your
52 struct inferior_status;
54 extern struct inferior_status *save_inferior_status (int);
56 extern void restore_inferior_status (struct inferior_status *);
58 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
60 extern void discard_inferior_status (struct inferior_status *);
62 extern void write_inferior_status_register (struct inferior_status
63 *inf_status, int regno,
66 /* The -1 ptid, often used to indicate either an error condition
67 or a "don't care" condition, i.e, "run all threads." */
68 extern ptid_t minus_one_ptid;
70 /* The null or zero ptid, often used to indicate no process. */
71 extern ptid_t null_ptid;
73 /* Attempt to find and return an existing ptid with the given PID, LWP,
74 and TID components. If none exists, create a new one and return
76 ptid_t ptid_build (int pid, long lwp, long tid);
78 /* Find/Create a ptid from just a pid. */
79 ptid_t pid_to_ptid (int pid);
81 /* Fetch the pid (process id) component from a ptid. */
82 int ptid_get_pid (ptid_t ptid);
84 /* Fetch the lwp (lightweight process) component from a ptid. */
85 long ptid_get_lwp (ptid_t ptid);
87 /* Fetch the tid (thread id) component from a ptid. */
88 long ptid_get_tid (ptid_t ptid);
90 /* Compare two ptids to see if they are equal */
91 extern int ptid_equal (ptid_t p1, ptid_t p2);
93 /* Save value of inferior_ptid so that it may be restored by
94 a later call to do_cleanups(). Returns the struct cleanup
95 pointer needed for later doing the cleanup. */
96 extern struct cleanup * save_inferior_ptid (void);
98 extern void set_sigint_trap (void);
100 extern void clear_sigint_trap (void);
102 extern void set_sigio_trap (void);
104 extern void clear_sigio_trap (void);
106 /* Set/get file name for default use for standard in/out in the inferior. */
108 extern void set_inferior_io_terminal (const char *terminal_name);
109 extern const char *get_inferior_io_terminal (void);
111 /* Collected pid, tid, etc. of the debugged inferior. When there's
112 no inferior, PIDGET (inferior_ptid) will be 0. */
114 extern ptid_t inferior_ptid;
116 /* Is the inferior running right now, as a result of a 'run&',
117 'continue&' etc command? This is used in asycn gdb to determine
118 whether a command that the user enters while the target is running
119 is allowed or not. */
120 extern int target_executing;
122 /* Are we simulating synchronous execution? This is used in async gdb
123 to implement the 'run', 'continue' etc commands, which will not
124 redisplay the prompt until the execution is actually over. */
125 extern int sync_execution;
127 /* This is only valid when inferior_ptid is non-zero.
129 If this is 0, then exec events should be noticed and responded to
130 by the debugger (i.e., be reported to the user).
132 If this is > 0, then that many subsequent exec events should be
133 ignored (i.e., not be reported to the user).
135 extern int inferior_ignoring_startup_exec_events;
137 /* This is only valid when inferior_ignoring_startup_exec_events is
140 Some targets (stupidly) report more than one exec event per actual
141 call to an event() system call. If only the last such exec event
142 need actually be noticed and responded to by the debugger (i.e.,
143 be reported to the user), then this is the number of "leading"
144 exec events which should be ignored.
146 extern int inferior_ignoring_leading_exec_events;
148 /* Inferior environment. */
150 extern struct gdb_environ *inferior_environ;
152 extern void clear_proceed_status (void);
154 extern void proceed (CORE_ADDR, enum target_signal, int);
156 /* When set, stop the 'step' command if we enter a function which has
157 no line number information. The normal behavior is that we step
158 over such function. */
159 extern int step_stop_if_no_debug;
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 CORE_ADDR unsigned_pointer_to_address (struct type *type,
180 const gdb_byte *buf);
181 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
183 extern CORE_ADDR signed_pointer_to_address (struct type *type,
184 const gdb_byte *buf);
185 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
188 extern void wait_for_inferior (void);
190 extern void fetch_inferior_event (void *);
192 extern void init_wait_for_inferior (void);
194 extern void close_exec_file (void);
196 extern void reopen_exec_file (void);
198 /* The `resume' routine should only be called in special circumstances.
199 Normally, use `proceed', which handles a lot of bookkeeping. */
201 extern void resume (int, enum target_signal);
203 /* From misc files */
205 extern void default_print_registers_info (struct gdbarch *gdbarch,
206 struct ui_file *file,
207 struct frame_info *frame,
208 int regnum, int all);
210 extern void child_terminal_info (char *, int);
212 extern void term_info (char *, int);
214 extern void terminal_ours_for_output (void);
216 extern void terminal_inferior (void);
218 extern void terminal_init_inferior (void);
220 extern void terminal_init_inferior_with_pgrp (int pgrp);
224 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
226 extern ptid_t procfs_first_available (void);
228 /* From fork-child.c */
230 extern void fork_inferior (char *, char *, char **,
232 void (*)(int), void (*)(void), char *);
235 extern void startup_inferior (int);
237 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
241 extern void new_tty_prefork (const char *);
243 extern int gdb_has_a_terminal (void);
247 extern void start_remote (int from_tty);
249 extern void normal_stop (void);
251 extern int signal_stop_state (int);
253 extern int signal_print_state (int);
255 extern int signal_pass_state (int);
257 extern int signal_stop_update (int, int);
259 extern int signal_print_update (int, int);
261 extern int signal_pass_update (int, int);
263 extern void get_last_target_status(ptid_t *ptid,
264 struct target_waitstatus *status);
266 extern void follow_inferior_reset_breakpoints (void);
270 extern void tty_command (char *, int);
272 extern void post_create_inferior (struct target_ops *, int);
274 extern void attach_command (char *, int);
276 extern char *get_inferior_args (void);
278 extern char *set_inferior_args (char *);
280 extern void set_inferior_args_vector (int, char **);
282 extern void registers_info (char *, int);
284 extern void nexti_command (char *, int);
286 extern void stepi_command (char *, int);
288 extern void continue_command (char *, int);
290 extern void interrupt_target_command (char *args, int from_tty);
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 struct frame_id step_frame_id;
340 /* 1 means step over all subroutine calls.
341 -1 means step over calls to undebuggable functions. */
343 enum step_over_calls_kind
347 STEP_OVER_UNDEBUGGABLE
350 extern enum step_over_calls_kind step_over_calls;
352 /* If stepping, nonzero means step count is > 1
353 so don't print frame next time inferior stops
354 if it stops due to stepping. */
356 extern int step_multi;
358 /* Nonzero means expecting a trap and caller will handle it
359 themselves. It is used when running in the shell before the child
360 program has been exec'd; and when running some kinds of remote
363 /* It is also used after attach, due to attaching to a process. This
364 is a bit trickier. When doing an attach, the kernel stops the
365 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
366 the handling of SIGSTOP for a ptraced process has changed. Earlier
367 versions of the kernel would ignore these SIGSTOPs, while now
368 SIGSTOP is treated like any other signal, i.e. it is not muffled.
370 If the gdb user does a 'continue' after the 'attach', gdb passes
371 the global variable stop_signal (which stores the signal from the
372 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
373 problematic, because the kernel doesn't ignore such SIGSTOP
374 now. I.e. it is reported back to gdb, which in turn presents it
377 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
378 gdb to clear the value of stop_signal after the attach, so that it
379 is not passed back down to the kernel. */
385 STOP_QUIETLY_NO_SIGSTOP
388 extern enum stop_kind stop_soon;
390 /* Nonzero if proceed is being used for a "finish" command or a similar
391 situation when stop_registers should be saved. */
393 extern int proceed_to_finish;
395 /* Save register contents here when about to pop a stack dummy frame,
396 if-and-only-if proceed_to_finish is set.
397 Thus this contains the return value from the called function (assuming
398 values are returned in a register). */
400 extern struct regcache *stop_registers;
402 /* Nonzero if the child process in inferior_ptid was attached rather
405 extern int attach_flag;
407 /* Possible values for CALL_DUMMY_LOCATION. */
409 #define AT_ENTRY_POINT 4
412 /* If STARTUP_WITH_SHELL is set, GDB's "run"
413 will attempts to start up the debugee under a shell.
414 This is in order for argument-expansion to occur. E.g.,
416 The "*" gets expanded by the shell into a list of files.
417 While this is a nice feature, it turns out to interact badly
418 with some of the catch-fork/catch-exec features we have added.
419 In particular, if the shell does any fork/exec's before
420 the exec of the target program, that can confuse GDB.
421 To disable this feature, set STARTUP_WITH_SHELL to 0.
422 To enable this feature, set STARTUP_WITH_SHELL to 1.
423 The catch-exec traps expected during start-up will
424 be 1 if target is not started up with a shell, 2 if it is.
426 If you disable this, you need to decrement
427 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
428 #define STARTUP_WITH_SHELL 1
429 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
430 #define START_INFERIOR_TRAPS_EXPECTED 2
432 #endif /* !defined (INFERIOR_H) */