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, 2008
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 3 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, see <http://www.gnu.org/licenses/>. */
23 #if !defined (INFERIOR_H)
26 struct target_waitstatus;
34 #include "breakpoint.h"
36 /* For enum target_signal. */
39 /* For struct frame_id. */
42 /* Structure in which to save the status of the inferior. Create/Save
43 through "save_inferior_status", restore through
44 "restore_inferior_status".
46 This pair of routines should be called around any transfer of
47 control to the inferior which you don't want showing up in your
50 struct inferior_status;
52 extern struct inferior_status *save_inferior_status (int);
54 extern void restore_inferior_status (struct inferior_status *);
56 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
58 extern void discard_inferior_status (struct inferior_status *);
60 extern void write_inferior_status_register (struct inferior_status
61 *inf_status, int regno,
64 /* The -1 ptid, often used to indicate either an error condition
65 or a "don't care" condition, i.e, "run all threads." */
66 extern ptid_t minus_one_ptid;
68 /* The null or zero ptid, often used to indicate no process. */
69 extern ptid_t null_ptid;
71 /* Attempt to find and return an existing ptid with the given PID, LWP,
72 and TID components. If none exists, create a new one and return
74 ptid_t ptid_build (int pid, long lwp, long tid);
76 /* Find/Create a ptid from just a pid. */
77 ptid_t pid_to_ptid (int pid);
79 /* Fetch the pid (process id) component from a ptid. */
80 int ptid_get_pid (ptid_t ptid);
82 /* Fetch the lwp (lightweight process) component from a ptid. */
83 long ptid_get_lwp (ptid_t ptid);
85 /* Fetch the tid (thread id) component from a ptid. */
86 long ptid_get_tid (ptid_t ptid);
88 /* Compare two ptids to see if they are equal */
89 extern int ptid_equal (ptid_t p1, ptid_t p2);
91 /* Save value of inferior_ptid so that it may be restored by
92 a later call to do_cleanups(). Returns the struct cleanup
93 pointer needed for later doing the cleanup. */
94 extern struct cleanup * save_inferior_ptid (void);
96 extern void set_sigint_trap (void);
98 extern void clear_sigint_trap (void);
100 extern void set_sigio_trap (void);
102 extern void clear_sigio_trap (void);
104 /* Set/get file name for default use for standard in/out in the inferior. */
106 extern void set_inferior_io_terminal (const char *terminal_name);
107 extern const char *get_inferior_io_terminal (void);
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 /* Are we simulating synchronous execution? This is used in async gdb
115 to implement the 'run', 'continue' etc commands, which will not
116 redisplay the prompt until the execution is actually over. */
117 extern int sync_execution;
119 /* Some targets (stupidly) report more than one exec event per actual
120 call to an event() system call. If only the last such exec event
121 need actually be noticed and responded to by the debugger (i.e.,
122 be reported to the user), then this is the number of "leading"
123 exec events which should be ignored.
125 extern int inferior_ignoring_leading_exec_events;
127 /* Inferior environment. */
129 extern struct gdb_environ *inferior_environ;
131 extern void clear_proceed_status (void);
133 extern void proceed (CORE_ADDR, enum target_signal, int);
135 /* When set, stop the 'step' command if we enter a function which has
136 no line number information. The normal behavior is that we step
137 over such function. */
138 extern int step_stop_if_no_debug;
140 /* If set, the inferior should be controlled in non-stop mode. In
141 this mode, each thread is controlled independently. Execution
142 commands apply only to the the selected thread by default, and stop
143 events stop only the thread that had the event -- the other threads
144 are kept running freely. */
147 extern void generic_mourn_inferior (void);
149 extern void terminal_save_ours (void);
151 extern void terminal_ours (void);
153 extern CORE_ADDR read_pc (void);
155 extern void write_pc (CORE_ADDR);
157 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
158 const gdb_byte *buf);
159 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
161 extern CORE_ADDR signed_pointer_to_address (struct type *type,
162 const gdb_byte *buf);
163 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
166 extern void wait_for_inferior (int treat_exec_as_sigtrap);
168 extern void fetch_inferior_event (void *);
170 extern void init_wait_for_inferior (void);
172 extern void close_exec_file (void);
174 extern void reopen_exec_file (void);
176 /* The `resume' routine should only be called in special circumstances.
177 Normally, use `proceed', which handles a lot of bookkeeping. */
179 extern void resume (int, enum target_signal);
181 /* From misc files */
183 extern void default_print_registers_info (struct gdbarch *gdbarch,
184 struct ui_file *file,
185 struct frame_info *frame,
186 int regnum, int all);
188 extern void child_terminal_info (char *, int);
190 extern void term_info (char *, int);
192 extern void terminal_ours_for_output (void);
194 extern void terminal_inferior (void);
196 extern void terminal_init_inferior (void);
198 extern void terminal_init_inferior_with_pgrp (int pgrp);
202 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
204 extern ptid_t procfs_first_available (void);
206 /* From fork-child.c */
208 extern void fork_inferior (char *, char *, char **,
210 void (*)(int), void (*)(void), char *);
213 extern void startup_inferior (int);
215 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
219 extern void new_tty_prefork (const char *);
221 extern int gdb_has_a_terminal (void);
225 extern void start_remote (int from_tty);
227 extern void normal_stop (void);
229 extern int signal_stop_state (int);
231 extern int signal_print_state (int);
233 extern int signal_pass_state (int);
235 extern int signal_stop_update (int, int);
237 extern int signal_print_update (int, int);
239 extern int signal_pass_update (int, int);
241 extern void get_last_target_status(ptid_t *ptid,
242 struct target_waitstatus *status);
244 extern void follow_inferior_reset_breakpoints (void);
248 extern void tty_command (char *, int);
250 extern void post_create_inferior (struct target_ops *, int);
252 extern void attach_command (char *, int);
254 extern char *get_inferior_args (void);
256 extern char *set_inferior_args (char *);
258 extern void set_inferior_args_vector (int, char **);
260 extern void registers_info (char *, int);
262 extern void nexti_command (char *, int);
264 extern void stepi_command (char *, int);
266 extern void continue_command (char *, int);
268 extern void interrupt_target_command (char *args, int from_tty);
270 /* Last signal that the inferior received (why it stopped). */
272 extern enum target_signal stop_signal;
274 /* Address at which inferior stopped. */
276 extern CORE_ADDR stop_pc;
278 /* Chain containing status of breakpoint(s) that we have stopped at. */
280 extern bpstat stop_bpstat;
282 /* Flag indicating that a command has proceeded the inferior past the
283 current breakpoint. */
285 extern int breakpoint_proceeded;
287 /* Nonzero if stopped due to a step command. */
289 extern int stop_step;
291 /* Nonzero if stopped due to completion of a stack dummy routine. */
293 extern int stop_stack_dummy;
295 /* Nonzero if program stopped due to a random (unexpected) signal in
298 extern int stopped_by_random_signal;
300 /* Range to single step within.
301 If this is nonzero, respond to a single-step signal
302 by continuing to step if the pc is in this range.
304 If step_range_start and step_range_end are both 1, it means to step for
305 a single instruction (FIXME: it might clean up wait_for_inferior in a
306 minor way if this were changed to the address of the instruction and
307 that address plus one. But maybe not.). */
309 extern CORE_ADDR step_range_start; /* Inclusive */
310 extern CORE_ADDR step_range_end; /* Exclusive */
312 /* Stack frame address as of when stepping command was issued.
313 This is how we know when we step into a subroutine call,
314 and how to set the frame for the breakpoint used to step out. */
316 extern struct frame_id step_frame_id;
318 /* 1 means step over all subroutine calls.
319 -1 means step over calls to undebuggable functions. */
321 enum step_over_calls_kind
325 STEP_OVER_UNDEBUGGABLE
328 extern enum step_over_calls_kind step_over_calls;
330 /* If stepping, nonzero means step count is > 1
331 so don't print frame next time inferior stops
332 if it stops due to stepping. */
334 extern int step_multi;
336 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
337 will handle it themselves. STOP_QUIETLY is used when running in
338 the shell before the child program has been exec'd and when running
339 through shared library loading. STOP_QUIETLY_REMOTE is used when
340 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
341 except that there is no need to hide a signal. */
343 /* It is also used after attach, due to attaching to a process. This
344 is a bit trickier. When doing an attach, the kernel stops the
345 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
346 the handling of SIGSTOP for a ptraced process has changed. Earlier
347 versions of the kernel would ignore these SIGSTOPs, while now
348 SIGSTOP is treated like any other signal, i.e. it is not muffled.
350 If the gdb user does a 'continue' after the 'attach', gdb passes
351 the global variable stop_signal (which stores the signal from the
352 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
353 problematic, because the kernel doesn't ignore such SIGSTOP
354 now. I.e. it is reported back to gdb, which in turn presents it
357 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
358 gdb to clear the value of stop_signal after the attach, so that it
359 is not passed back down to the kernel. */
366 STOP_QUIETLY_NO_SIGSTOP
369 extern enum stop_kind stop_soon;
371 /* Nonzero if proceed is being used for a "finish" command or a similar
372 situation when stop_registers should be saved. */
374 extern int proceed_to_finish;
376 /* Save register contents here when about to pop a stack dummy frame,
377 if-and-only-if proceed_to_finish is set.
378 Thus this contains the return value from the called function (assuming
379 values are returned in a register). */
381 extern struct regcache *stop_registers;
383 /* Nonzero if the child process in inferior_ptid was attached rather
386 extern int attach_flag;
388 /* True if we are debugging displaced stepping. */
389 extern int debug_displaced;
391 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
392 void displaced_step_dump_bytes (struct ui_file *file,
393 const gdb_byte *buf, size_t len);
396 /* When set, normal_stop will not call the normal_stop observer. */
397 extern int suppress_stop_observer;
399 /* When set, no calls to target_resumed observer will be made. */
400 extern int suppress_resume_observer;
403 /* Possible values for gdbarch_call_dummy_location. */
405 #define AT_ENTRY_POINT 4
408 /* If STARTUP_WITH_SHELL is set, GDB's "run"
409 will attempts to start up the debugee under a shell.
410 This is in order for argument-expansion to occur. E.g.,
412 The "*" gets expanded by the shell into a list of files.
413 While this is a nice feature, it turns out to interact badly
414 with some of the catch-fork/catch-exec features we have added.
415 In particular, if the shell does any fork/exec's before
416 the exec of the target program, that can confuse GDB.
417 To disable this feature, set STARTUP_WITH_SHELL to 0.
418 To enable this feature, set STARTUP_WITH_SHELL to 1.
419 The catch-exec traps expected during start-up will
420 be 1 if target is not started up with a shell, 2 if it is.
422 If you disable this, you need to decrement
423 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
424 #define STARTUP_WITH_SHELL 1
425 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
426 #define START_INFERIOR_TRAPS_EXPECTED 2
428 #endif /* !defined (INFERIOR_H) */