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, 2009
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;
36 #include "breakpoint.h"
38 /* For enum target_signal. */
41 /* For struct frame_id. */
44 /* Two structures are used to record inferior state.
46 inferior_thread_state contains state about the program itself like its
47 registers and any signal it received when it last stopped.
48 This state must be restored regardless of how the inferior function call
49 ends (either successfully, or after it hits a breakpoint or signal)
50 if the program is to properly continue where it left off.
52 inferior_status contains state regarding gdb's control of the inferior
53 itself like stepping control. It also contains session state like the
54 user's currently selected frame.
56 Call these routines around hand called functions, including function calls
57 in conditional breakpoints for example. */
59 struct inferior_thread_state;
60 struct inferior_status;
62 extern struct inferior_thread_state *save_inferior_thread_state (void);
63 extern struct inferior_status *save_inferior_status (void);
65 extern void restore_inferior_thread_state (struct inferior_thread_state *);
66 extern void restore_inferior_status (struct inferior_status *);
68 extern struct cleanup *make_cleanup_restore_inferior_thread_state (struct inferior_thread_state *);
69 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
71 extern void discard_inferior_thread_state (struct inferior_thread_state *);
72 extern void discard_inferior_status (struct inferior_status *);
74 extern struct regcache *get_inferior_thread_state_regcache (struct inferior_thread_state *);
76 /* The -1 ptid, often used to indicate either an error condition
77 or a "don't care" condition, i.e, "run all threads." */
78 extern ptid_t minus_one_ptid;
80 /* The null or zero ptid, often used to indicate no process. */
81 extern ptid_t null_ptid;
83 /* Attempt to find and return an existing ptid with the given PID, LWP,
84 and TID components. If none exists, create a new one and return
86 ptid_t ptid_build (int pid, long lwp, long tid);
88 /* Find/Create a ptid from just a pid. */
89 ptid_t pid_to_ptid (int pid);
91 /* Fetch the pid (process id) component from a ptid. */
92 int ptid_get_pid (ptid_t ptid);
94 /* Fetch the lwp (lightweight process) component from a ptid. */
95 long ptid_get_lwp (ptid_t ptid);
97 /* Fetch the tid (thread id) component from a ptid. */
98 long ptid_get_tid (ptid_t ptid);
100 /* Compare two ptids to see if they are equal */
101 extern int ptid_equal (ptid_t p1, ptid_t p2);
103 /* Return true if PTID represents a process id. */
104 extern int ptid_is_pid (ptid_t ptid);
106 /* Save value of inferior_ptid so that it may be restored by
107 a later call to do_cleanups(). Returns the struct cleanup
108 pointer needed for later doing the cleanup. */
109 extern struct cleanup * save_inferior_ptid (void);
111 extern void set_sigint_trap (void);
113 extern void clear_sigint_trap (void);
115 /* Set/get file name for default use for standard in/out in the inferior. */
117 extern void set_inferior_io_terminal (const char *terminal_name);
118 extern const char *get_inferior_io_terminal (void);
120 /* Collected pid, tid, etc. of the debugged inferior. When there's
121 no inferior, PIDGET (inferior_ptid) will be 0. */
123 extern ptid_t inferior_ptid;
125 /* Are we simulating synchronous execution? This is used in async gdb
126 to implement the 'run', 'continue' etc commands, which will not
127 redisplay the prompt until the execution is actually over. */
128 extern int sync_execution;
130 /* Inferior environment. */
132 extern struct gdb_environ *inferior_environ;
134 extern void clear_proceed_status (void);
136 extern void proceed (CORE_ADDR, enum target_signal, int);
138 /* When set, stop the 'step' command if we enter a function which has
139 no line number information. The normal behavior is that we step
140 over such function. */
141 extern int step_stop_if_no_debug;
143 /* If set, the inferior should be controlled in non-stop mode. In
144 this mode, each thread is controlled independently. Execution
145 commands apply only to the the selected thread by default, and stop
146 events stop only the thread that had the event -- the other threads
147 are kept running freely. */
150 extern void generic_mourn_inferior (void);
152 extern void terminal_save_ours (void);
154 extern void terminal_ours (void);
156 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
157 const gdb_byte *buf);
158 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
160 extern CORE_ADDR signed_pointer_to_address (struct type *type,
161 const gdb_byte *buf);
162 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
165 extern void wait_for_inferior (int treat_exec_as_sigtrap);
167 extern void fetch_inferior_event (void *);
169 extern void init_wait_for_inferior (void);
171 extern void close_exec_file (void);
173 extern void reopen_exec_file (void);
175 /* The `resume' routine should only be called in special circumstances.
176 Normally, use `proceed', which handles a lot of bookkeeping. */
178 extern void resume (int, enum target_signal);
180 /* From misc files */
182 extern void default_print_registers_info (struct gdbarch *gdbarch,
183 struct ui_file *file,
184 struct frame_info *frame,
185 int regnum, int all);
187 extern void child_terminal_info (char *, int);
189 extern void term_info (char *, int);
191 extern void terminal_ours_for_output (void);
193 extern void terminal_inferior (void);
195 extern void terminal_init_inferior (void);
197 extern void terminal_init_inferior_with_pgrp (int pgrp);
201 extern ptid_t procfs_first_available (void);
203 /* From fork-child.c */
205 extern int fork_inferior (char *, char *, char **,
207 void (*)(int), void (*)(void), char *);
210 extern void startup_inferior (int);
212 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
216 extern void start_remote (int from_tty);
218 extern void normal_stop (void);
220 extern int signal_stop_state (int);
222 extern int signal_print_state (int);
224 extern int signal_pass_state (int);
226 extern int signal_stop_update (int, int);
228 extern int signal_print_update (int, int);
230 extern int signal_pass_update (int, int);
232 extern void get_last_target_status(ptid_t *ptid,
233 struct target_waitstatus *status);
235 extern void follow_inferior_reset_breakpoints (void);
237 /* Throw an error indicating the current thread is running. */
238 extern void error_is_running (void);
240 /* Calls error_is_running if the current thread is running. */
241 extern void ensure_not_running (void);
245 extern void tty_command (char *, int);
247 extern void post_create_inferior (struct target_ops *, int);
249 extern void attach_command (char *, int);
251 extern char *get_inferior_args (void);
253 extern char *set_inferior_args (char *);
255 extern void set_inferior_args_vector (int, char **);
257 extern void registers_info (char *, int);
259 extern void nexti_command (char *, int);
261 extern void stepi_command (char *, int);
263 extern void continue_1 (int all_threads);
265 extern void continue_command (char *, int);
267 extern void interrupt_target_command (char *args, int from_tty);
269 extern void interrupt_target_1 (int all_threads);
271 extern void detach_command (char *, int);
273 extern void notice_new_inferior (ptid_t, int, int);
275 /* Address at which inferior stopped. */
277 extern CORE_ADDR stop_pc;
279 /* Nonzero if stopped due to completion of a stack dummy routine. */
281 extern int stop_stack_dummy;
283 /* Nonzero if program stopped due to a random (unexpected) signal in
286 extern int stopped_by_random_signal;
288 /* 1 means step over all subroutine calls.
289 -1 means step over calls to undebuggable functions. */
291 enum step_over_calls_kind
295 STEP_OVER_UNDEBUGGABLE
298 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
299 will handle it themselves. STOP_QUIETLY is used when running in
300 the shell before the child program has been exec'd and when running
301 through shared library loading. STOP_QUIETLY_REMOTE is used when
302 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
303 except that there is no need to hide a signal. */
305 /* It is also used after attach, due to attaching to a process. This
306 is a bit trickier. When doing an attach, the kernel stops the
307 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
308 the handling of SIGSTOP for a ptraced process has changed. Earlier
309 versions of the kernel would ignore these SIGSTOPs, while now
310 SIGSTOP is treated like any other signal, i.e. it is not muffled.
312 If the gdb user does a 'continue' after the 'attach', gdb passes
313 the global variable stop_signal (which stores the signal from the
314 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
315 problematic, because the kernel doesn't ignore such SIGSTOP
316 now. I.e. it is reported back to gdb, which in turn presents it
319 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
320 gdb to clear the value of stop_signal after the attach, so that it
321 is not passed back down to the kernel. */
328 STOP_QUIETLY_NO_SIGSTOP
331 /* Reverse execution. */
332 enum exec_direction_kind
339 extern enum exec_direction_kind execution_direction;
341 /* Save register contents here when executing a "finish" command or are
342 about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
343 Thus this contains the return value from the called function (assuming
344 values are returned in a register). */
346 extern struct regcache *stop_registers;
348 /* True if we are debugging displaced stepping. */
349 extern int debug_displaced;
351 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
352 void displaced_step_dump_bytes (struct ui_file *file,
353 const gdb_byte *buf, size_t len);
356 /* Possible values for gdbarch_call_dummy_location. */
358 #define AT_ENTRY_POINT 4
361 /* If STARTUP_WITH_SHELL is set, GDB's "run"
362 will attempts to start up the debugee under a shell.
363 This is in order for argument-expansion to occur. E.g.,
365 The "*" gets expanded by the shell into a list of files.
366 While this is a nice feature, it turns out to interact badly
367 with some of the catch-fork/catch-exec features we have added.
368 In particular, if the shell does any fork/exec's before
369 the exec of the target program, that can confuse GDB.
370 To disable this feature, set STARTUP_WITH_SHELL to 0.
371 To enable this feature, set STARTUP_WITH_SHELL to 1.
372 The catch-exec traps expected during start-up will
373 be 1 if target is not started up with a shell, 2 if it is.
375 If you disable this, you need to decrement
376 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
377 #define STARTUP_WITH_SHELL 1
378 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
379 #define START_INFERIOR_TRAPS_EXPECTED 2
382 struct private_inferior;
384 /* GDB represents the state of each program execution with an object
385 called an inferior. An inferior typically corresponds to a process
386 but is more general and applies also to targets that do not have a
387 notion of processes. Each run of an executable creates a new
388 inferior, as does each attachment to an existing process.
389 Inferiors have unique internal identifiers that are different from
390 target process ids. Each inferior may in turn have multiple
391 threads running in it. */
395 /* Pointer to next inferior in singly-linked list of inferiors. */
396 struct inferior *next;
398 /* Convenient handle (GDB inferior id). Unique across all
402 /* Actual target inferior id, usually, a process id. This matches
403 the ptid_t.pid member of threads of this inferior. */
406 /* See the definition of stop_kind above. */
407 enum stop_kind stop_soon;
409 /* Nonzero if this child process was attached rather than
413 /* What is left to do for an execution command after any thread of
414 this inferior stops. For continuations associated with a
415 specific thread, see `struct thread_info'. */
416 struct continuation *continuations;
418 /* Terminal info and state managed by inflow.c. */
419 struct terminal_info *terminal_info;
421 /* Private data used by the target vector implementation. */
422 struct private_inferior *private;
425 /* Create an empty inferior list, or empty the existing one. */
426 extern void init_inferior_list (void);
428 /* Add an inferior to the inferior list, print a message that a new
429 inferior is found, and return the pointer to the new inferior.
430 Caller may use this pointer to initialize the private inferior
432 extern struct inferior *add_inferior (int pid);
434 /* Same as add_inferior, but don't print new inferior notifications to
436 extern struct inferior *add_inferior_silent (int pid);
438 /* Delete an existing inferior list entry, due to inferior exit. */
439 extern void delete_inferior (int pid);
441 /* Same as delete_inferior, but don't print new inferior notifications
443 extern void delete_inferior_silent (int pid);
445 /* Delete an existing inferior list entry, due to inferior detaching. */
446 extern void detach_inferior (int pid);
448 /* Get rid of all inferiors. */
449 extern void discard_all_inferiors (void);
451 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
452 into a "pid" (which may be overloaded with extra inferior information). */
453 extern int gdb_inferior_id_to_pid (int);
455 /* Translate a target 'pid' into the integer inferior id (GDB's
456 homegrown id, not the system's). */
457 extern int pid_to_gdb_inferior_id (int pid);
459 /* Boolean test for an already-known pid. */
460 extern int in_inferior_list (int pid);
462 /* Boolean test for an already-known inferior id (GDB's homegrown id,
463 not the system's). */
464 extern int valid_gdb_inferior_id (int num);
466 /* Search function to lookup a inferior by target 'pid'. */
467 extern struct inferior *find_inferior_pid (int pid);
469 /* Inferior iterator function.
471 Calls a callback function once for each inferior, so long as the
472 callback function returns false. If the callback function returns
473 true, the iteration will end and the current inferior will be
474 returned. This can be useful for implementing a search for a
475 inferior with arbitrary attributes, or for applying some operation
478 It is safe to delete the iterated inferior from the callback. */
479 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
483 /* Prints the list of inferiors and their details on UIOUT.
485 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
486 that should be printed. Otherwise, all inferiors are printed. */
487 extern void print_inferior (struct ui_out *uiout, int requested_inferior);
489 /* Returns true if the inferior list is not empty. */
490 extern int have_inferiors (void);
492 /* Returns true if there are any live inferiors in the inferior list
493 (not cores, not executables, real live processes). */
494 extern int have_live_inferiors (void);
496 /* Return a pointer to the current inferior. It is an error to call
497 this if there is no current inferior. */
498 extern struct inferior *current_inferior (void);
500 #endif /* !defined (INFERIOR_H) */