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;
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 /* Set/get file name for default use for standard in/out in the inferior. */
107 extern void set_inferior_io_terminal (const char *terminal_name);
108 extern const char *get_inferior_io_terminal (void);
110 /* Collected pid, tid, etc. of the debugged inferior. When there's
111 no inferior, PIDGET (inferior_ptid) will be 0. */
113 extern ptid_t inferior_ptid;
115 /* Are we simulating synchronous execution? This is used in async gdb
116 to implement the 'run', 'continue' etc commands, which will not
117 redisplay the prompt until the execution is actually over. */
118 extern int sync_execution;
120 /* Some targets (stupidly) report more than one exec event per actual
121 call to an event() system call. If only the last such exec event
122 need actually be noticed and responded to by the debugger (i.e.,
123 be reported to the user), then this is the number of "leading"
124 exec events which should be ignored.
126 extern int inferior_ignoring_leading_exec_events;
128 /* Inferior environment. */
130 extern struct gdb_environ *inferior_environ;
132 extern void clear_proceed_status (void);
134 extern void proceed (CORE_ADDR, enum target_signal, int);
136 /* When set, stop the 'step' command if we enter a function which has
137 no line number information. The normal behavior is that we step
138 over such function. */
139 extern int step_stop_if_no_debug;
141 /* If set, the inferior should be controlled in non-stop mode. In
142 this mode, each thread is controlled independently. Execution
143 commands apply only to the the selected thread by default, and stop
144 events stop only the thread that had the event -- the other threads
145 are kept running freely. */
148 extern void generic_mourn_inferior (void);
150 extern void terminal_save_ours (void);
152 extern void terminal_ours (void);
154 extern CORE_ADDR read_pc (void);
156 extern void write_pc (CORE_ADDR);
158 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
159 const gdb_byte *buf);
160 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
162 extern CORE_ADDR signed_pointer_to_address (struct type *type,
163 const gdb_byte *buf);
164 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
167 extern void wait_for_inferior (int treat_exec_as_sigtrap);
169 extern void fetch_inferior_event (void *);
171 extern void init_wait_for_inferior (void);
173 extern void close_exec_file (void);
175 extern void reopen_exec_file (void);
177 /* The `resume' routine should only be called in special circumstances.
178 Normally, use `proceed', which handles a lot of bookkeeping. */
180 extern void resume (int, enum target_signal);
182 /* From misc files */
184 extern void default_print_registers_info (struct gdbarch *gdbarch,
185 struct ui_file *file,
186 struct frame_info *frame,
187 int regnum, int all);
189 extern void child_terminal_info (char *, int);
191 extern void term_info (char *, int);
193 extern void terminal_ours_for_output (void);
195 extern void terminal_inferior (void);
197 extern void terminal_init_inferior (void);
199 extern void terminal_init_inferior_with_pgrp (int pgrp);
203 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
205 extern ptid_t procfs_first_available (void);
207 /* From fork-child.c */
209 extern void fork_inferior (char *, char *, char **,
211 void (*)(int), void (*)(void), char *);
214 extern void startup_inferior (int);
216 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
220 extern void new_tty_prefork (const char *);
222 extern int gdb_has_a_terminal (void);
226 extern void start_remote (int from_tty);
228 extern void normal_stop (void);
230 extern int signal_stop_state (int);
232 extern int signal_print_state (int);
234 extern int signal_pass_state (int);
236 extern int signal_stop_update (int, int);
238 extern int signal_print_update (int, int);
240 extern int signal_pass_update (int, int);
242 extern void get_last_target_status(ptid_t *ptid,
243 struct target_waitstatus *status);
245 extern void follow_inferior_reset_breakpoints (void);
247 /* Throw an error indicating the current thread is running. */
248 extern void error_is_running (void);
250 /* Calls error_is_running if the current thread is running. */
251 extern void ensure_not_running (void);
255 extern void tty_command (char *, int);
257 extern void post_create_inferior (struct target_ops *, int);
259 extern void attach_command (char *, int);
261 extern char *get_inferior_args (void);
263 extern char *set_inferior_args (char *);
265 extern void set_inferior_args_vector (int, char **);
267 extern void registers_info (char *, int);
269 extern void nexti_command (char *, int);
271 extern void stepi_command (char *, int);
273 extern void continue_1 (int all_threads);
275 extern void continue_command (char *, int);
277 extern void interrupt_target_command (char *args, int from_tty);
279 extern void interrupt_target_1 (int all_threads);
281 /* Address at which inferior stopped. */
283 extern CORE_ADDR stop_pc;
285 /* Flag indicating that a command has proceeded the inferior past the
286 current breakpoint. */
288 extern int breakpoint_proceeded;
290 /* Nonzero if stopped due to completion of a stack dummy routine. */
292 extern int stop_stack_dummy;
294 /* Nonzero if program stopped due to a random (unexpected) signal in
297 extern int stopped_by_random_signal;
299 /* 1 means step over all subroutine calls.
300 -1 means step over calls to undebuggable functions. */
302 enum step_over_calls_kind
306 STEP_OVER_UNDEBUGGABLE
309 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
310 will handle it themselves. STOP_QUIETLY is used when running in
311 the shell before the child program has been exec'd and when running
312 through shared library loading. STOP_QUIETLY_REMOTE is used when
313 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
314 except that there is no need to hide a signal. */
316 /* It is also used after attach, due to attaching to a process. This
317 is a bit trickier. When doing an attach, the kernel stops the
318 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
319 the handling of SIGSTOP for a ptraced process has changed. Earlier
320 versions of the kernel would ignore these SIGSTOPs, while now
321 SIGSTOP is treated like any other signal, i.e. it is not muffled.
323 If the gdb user does a 'continue' after the 'attach', gdb passes
324 the global variable stop_signal (which stores the signal from the
325 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
326 problematic, because the kernel doesn't ignore such SIGSTOP
327 now. I.e. it is reported back to gdb, which in turn presents it
330 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
331 gdb to clear the value of stop_signal after the attach, so that it
332 is not passed back down to the kernel. */
339 STOP_QUIETLY_NO_SIGSTOP
342 extern enum stop_kind stop_soon;
344 /* Nonzero if proceed is being used for a "finish" command or a similar
345 situation when stop_registers should be saved. */
347 extern int proceed_to_finish;
349 /* Save register contents here when about to pop a stack dummy frame,
350 if-and-only-if proceed_to_finish is set.
351 Thus this contains the return value from the called function (assuming
352 values are returned in a register). */
354 extern struct regcache *stop_registers;
356 /* Nonzero if the child process in inferior_ptid was attached rather
359 extern int attach_flag;
361 /* True if we are debugging displaced stepping. */
362 extern int debug_displaced;
364 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
365 void displaced_step_dump_bytes (struct ui_file *file,
366 const gdb_byte *buf, size_t len);
369 /* When set, normal_stop will not call the normal_stop observer. */
370 extern int suppress_stop_observer;
372 /* When set, no calls to target_resumed observer will be made. */
373 extern int suppress_resume_observer;
376 /* Possible values for gdbarch_call_dummy_location. */
378 #define AT_ENTRY_POINT 4
381 /* If STARTUP_WITH_SHELL is set, GDB's "run"
382 will attempts to start up the debugee under a shell.
383 This is in order for argument-expansion to occur. E.g.,
385 The "*" gets expanded by the shell into a list of files.
386 While this is a nice feature, it turns out to interact badly
387 with some of the catch-fork/catch-exec features we have added.
388 In particular, if the shell does any fork/exec's before
389 the exec of the target program, that can confuse GDB.
390 To disable this feature, set STARTUP_WITH_SHELL to 0.
391 To enable this feature, set STARTUP_WITH_SHELL to 1.
392 The catch-exec traps expected during start-up will
393 be 1 if target is not started up with a shell, 2 if it is.
395 If you disable this, you need to decrement
396 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
397 #define STARTUP_WITH_SHELL 1
398 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
399 #define START_INFERIOR_TRAPS_EXPECTED 2
402 struct private_inferior;
404 /* GDB represents the state of each program execution with an object
405 called an inferior. An inferior typically corresponds to a process
406 but is more general and applies also to targets that do not have a
407 notion of processes. Each run of an executable creates a new
408 inferior, as does each attachment to an existing process.
409 Inferiors have unique internal identifiers that are different from
410 target process ids. Each inferior may in turn have multiple
411 threads running in it. */
415 /* Pointer to next inferior in singly-linked list of inferiors. */
416 struct inferior *next;
418 /* Convenient handle (GDB inferior id). Unique across all
422 /* Actual target inferior id, usually, a process id. This matches
423 the ptid_t.pid member of threads of this inferior. */
426 /* Private data used by the target vector implementation. */
427 struct private_inferior *private;
430 /* Create an empty inferior list, or empty the existing one. */
431 extern void init_inferior_list (void);
433 /* Add an inferior to the inferior list, print a message that a new
434 inferior is found, and return the pointer to the new inferior.
435 Caller may use this pointer to initialize the private inferior
437 extern struct inferior *add_inferior (int pid);
439 /* Same as add_inferior, but don't print new inferior notifications to
441 extern struct inferior *add_inferior_silent (int pid);
443 /* Delete an existing inferior list entry, due to inferior exit. */
444 extern void delete_inferior (int pid);
446 /* Same as delete_inferior, but don't print new inferior notifications
448 extern void delete_inferior_silent (int pid);
450 /* Delete an existing inferior list entry, due to inferior detaching. */
451 extern void detach_inferior (int pid);
453 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
454 into a "pid" (which may be overloaded with extra inferior information). */
455 extern int gdb_inferior_id_to_pid (int);
457 /* Translate a target 'pid' into the integer inferior id (GDB's
458 homegrown id, not the system's). */
459 extern int pid_to_gdb_inferior_id (int pid);
461 /* Boolean test for an already-known pid. */
462 extern int in_inferior_list (int pid);
464 /* Boolean test for an already-known inferior id (GDB's homegrown id,
465 not the system's). */
466 extern int valid_inferior_id (int num);
468 /* Search function to lookup a inferior by target 'pid'. */
469 extern struct inferior *find_inferior_pid (int pid);
471 /* Inferior iterator function.
473 Calls a callback function once for each inferior, so long as the
474 callback function returns false. If the callback function returns
475 true, the iteration will end and the current inferior will be
476 returned. This can be useful for implementing a search for a
477 inferior with arbitrary attributes, or for applying some operation
480 It is safe to delete the iterated inferior from the callback. */
481 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
485 /* Prints the list of inferiors and their details on UIOUT.
487 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
488 that should be printed. Otherwise, all inferiors are printed. */
489 extern void print_inferior (struct ui_out *uiout, int requested_inferior);
491 /* Returns true if the inferior list is not empty. */
492 extern int have_inferiors (void);
494 /* Return a pointer to the current inferior. It is an error to call
495 this if there is no current inferior. */
496 extern struct inferior *current_inferior (void);
498 #endif /* !defined (INFERIOR_H) */