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 /* Return true if PTID represents a process id. */
93 extern int ptid_is_pid (ptid_t ptid);
95 /* Save value of inferior_ptid so that it may be restored by
96 a later call to do_cleanups(). Returns the struct cleanup
97 pointer needed for later doing the cleanup. */
98 extern struct cleanup * save_inferior_ptid (void);
100 extern void set_sigint_trap (void);
102 extern void clear_sigint_trap (void);
104 extern void set_sigio_trap (void);
106 extern void clear_sigio_trap (void);
108 /* Set/get file name for default use for standard in/out in the inferior. */
110 extern void set_inferior_io_terminal (const char *terminal_name);
111 extern const char *get_inferior_io_terminal (void);
113 /* Collected pid, tid, etc. of the debugged inferior. When there's
114 no inferior, PIDGET (inferior_ptid) will be 0. */
116 extern ptid_t inferior_ptid;
118 /* Are we simulating synchronous execution? This is used in async gdb
119 to implement the 'run', 'continue' etc commands, which will not
120 redisplay the prompt until the execution is actually over. */
121 extern int sync_execution;
123 /* Some targets (stupidly) report more than one exec event per actual
124 call to an event() system call. If only the last such exec event
125 need actually be noticed and responded to by the debugger (i.e.,
126 be reported to the user), then this is the number of "leading"
127 exec events which should be ignored.
129 extern int inferior_ignoring_leading_exec_events;
131 /* Inferior environment. */
133 extern struct gdb_environ *inferior_environ;
135 extern void clear_proceed_status (void);
137 extern void proceed (CORE_ADDR, enum target_signal, int);
139 /* When set, stop the 'step' command if we enter a function which has
140 no line number information. The normal behavior is that we step
141 over such function. */
142 extern int step_stop_if_no_debug;
144 /* If set, the inferior should be controlled in non-stop mode. In
145 this mode, each thread is controlled independently. Execution
146 commands apply only to the the selected thread by default, and stop
147 events stop only the thread that had the event -- the other threads
148 are kept running freely. */
151 extern void generic_mourn_inferior (void);
153 extern void terminal_save_ours (void);
155 extern void terminal_ours (void);
157 extern CORE_ADDR read_pc (void);
159 extern void write_pc (CORE_ADDR);
161 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
162 const gdb_byte *buf);
163 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
165 extern CORE_ADDR signed_pointer_to_address (struct type *type,
166 const gdb_byte *buf);
167 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
170 extern void wait_for_inferior (int treat_exec_as_sigtrap);
172 extern void fetch_inferior_event (void *);
174 extern void init_wait_for_inferior (void);
176 extern void close_exec_file (void);
178 extern void reopen_exec_file (void);
180 /* The `resume' routine should only be called in special circumstances.
181 Normally, use `proceed', which handles a lot of bookkeeping. */
183 extern void resume (int, enum target_signal);
185 /* From misc files */
187 extern void default_print_registers_info (struct gdbarch *gdbarch,
188 struct ui_file *file,
189 struct frame_info *frame,
190 int regnum, int all);
192 extern void child_terminal_info (char *, int);
194 extern void term_info (char *, int);
196 extern void terminal_ours_for_output (void);
198 extern void terminal_inferior (void);
200 extern void terminal_init_inferior (void);
202 extern void terminal_init_inferior_with_pgrp (int pgrp);
206 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
208 extern ptid_t procfs_first_available (void);
210 /* From fork-child.c */
212 extern void fork_inferior (char *, char *, char **,
214 void (*)(int), void (*)(void), char *);
217 extern void startup_inferior (int);
219 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
223 extern void new_tty_prefork (const char *);
225 extern int gdb_has_a_terminal (void);
229 extern void start_remote (int from_tty);
231 extern void normal_stop (void);
233 extern int signal_stop_state (int);
235 extern int signal_print_state (int);
237 extern int signal_pass_state (int);
239 extern int signal_stop_update (int, int);
241 extern int signal_print_update (int, int);
243 extern int signal_pass_update (int, int);
245 extern void get_last_target_status(ptid_t *ptid,
246 struct target_waitstatus *status);
248 extern void follow_inferior_reset_breakpoints (void);
250 /* Throw an error indicating the current thread is running. */
251 extern void error_is_running (void);
253 /* Calls error_is_running if the current thread is running. */
254 extern void ensure_not_running (void);
258 extern void tty_command (char *, int);
260 extern void post_create_inferior (struct target_ops *, int);
262 extern void attach_command (char *, int);
264 extern char *get_inferior_args (void);
266 extern char *set_inferior_args (char *);
268 extern void set_inferior_args_vector (int, char **);
270 extern void registers_info (char *, int);
272 extern void nexti_command (char *, int);
274 extern void stepi_command (char *, int);
276 extern void continue_1 (int all_threads);
278 extern void continue_command (char *, int);
280 extern void interrupt_target_command (char *args, int from_tty);
282 extern void interrupt_target_1 (int all_threads);
284 /* Address at which inferior stopped. */
286 extern CORE_ADDR stop_pc;
288 /* Flag indicating that a command has proceeded the inferior past the
289 current breakpoint. */
291 extern int breakpoint_proceeded;
293 /* Nonzero if stopped due to completion of a stack dummy routine. */
295 extern int stop_stack_dummy;
297 /* Nonzero if program stopped due to a random (unexpected) signal in
300 extern int stopped_by_random_signal;
302 /* 1 means step over all subroutine calls.
303 -1 means step over calls to undebuggable functions. */
305 enum step_over_calls_kind
309 STEP_OVER_UNDEBUGGABLE
312 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
313 will handle it themselves. STOP_QUIETLY is used when running in
314 the shell before the child program has been exec'd and when running
315 through shared library loading. STOP_QUIETLY_REMOTE is used when
316 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
317 except that there is no need to hide a signal. */
319 /* It is also used after attach, due to attaching to a process. This
320 is a bit trickier. When doing an attach, the kernel stops the
321 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
322 the handling of SIGSTOP for a ptraced process has changed. Earlier
323 versions of the kernel would ignore these SIGSTOPs, while now
324 SIGSTOP is treated like any other signal, i.e. it is not muffled.
326 If the gdb user does a 'continue' after the 'attach', gdb passes
327 the global variable stop_signal (which stores the signal from the
328 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
329 problematic, because the kernel doesn't ignore such SIGSTOP
330 now. I.e. it is reported back to gdb, which in turn presents it
333 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
334 gdb to clear the value of stop_signal after the attach, so that it
335 is not passed back down to the kernel. */
342 STOP_QUIETLY_NO_SIGSTOP
345 /* Reverse execution. */
346 enum exec_direction_kind
353 extern enum exec_direction_kind execution_direction;
355 /* Nonzero if proceed is being used for a "finish" command or a similar
356 situation when stop_registers should be saved. */
358 extern int proceed_to_finish;
360 /* Save register contents here when about to pop a stack dummy frame,
361 if-and-only-if proceed_to_finish is set.
362 Thus this contains the return value from the called function (assuming
363 values are returned in a register). */
365 extern struct regcache *stop_registers;
367 /* True if we are debugging displaced stepping. */
368 extern int debug_displaced;
370 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
371 void displaced_step_dump_bytes (struct ui_file *file,
372 const gdb_byte *buf, size_t len);
375 /* When set, normal_stop will not call the normal_stop observer. */
376 extern int suppress_stop_observer;
378 /* When set, no calls to target_resumed observer will be made. */
379 extern int suppress_resume_observer;
382 /* Possible values for gdbarch_call_dummy_location. */
384 #define AT_ENTRY_POINT 4
387 /* If STARTUP_WITH_SHELL is set, GDB's "run"
388 will attempts to start up the debugee under a shell.
389 This is in order for argument-expansion to occur. E.g.,
391 The "*" gets expanded by the shell into a list of files.
392 While this is a nice feature, it turns out to interact badly
393 with some of the catch-fork/catch-exec features we have added.
394 In particular, if the shell does any fork/exec's before
395 the exec of the target program, that can confuse GDB.
396 To disable this feature, set STARTUP_WITH_SHELL to 0.
397 To enable this feature, set STARTUP_WITH_SHELL to 1.
398 The catch-exec traps expected during start-up will
399 be 1 if target is not started up with a shell, 2 if it is.
401 If you disable this, you need to decrement
402 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
403 #define STARTUP_WITH_SHELL 1
404 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
405 #define START_INFERIOR_TRAPS_EXPECTED 2
408 struct private_inferior;
410 /* GDB represents the state of each program execution with an object
411 called an inferior. An inferior typically corresponds to a process
412 but is more general and applies also to targets that do not have a
413 notion of processes. Each run of an executable creates a new
414 inferior, as does each attachment to an existing process.
415 Inferiors have unique internal identifiers that are different from
416 target process ids. Each inferior may in turn have multiple
417 threads running in it. */
421 /* Pointer to next inferior in singly-linked list of inferiors. */
422 struct inferior *next;
424 /* Convenient handle (GDB inferior id). Unique across all
428 /* Actual target inferior id, usually, a process id. This matches
429 the ptid_t.pid member of threads of this inferior. */
432 /* See the definition of stop_kind above. */
433 enum stop_kind stop_soon;
435 /* Nonzero if this child process was attached rather than
439 /* Private data used by the target vector implementation. */
440 struct private_inferior *private;
443 /* Create an empty inferior list, or empty the existing one. */
444 extern void init_inferior_list (void);
446 /* Add an inferior to the inferior list, print a message that a new
447 inferior is found, and return the pointer to the new inferior.
448 Caller may use this pointer to initialize the private inferior
450 extern struct inferior *add_inferior (int pid);
452 /* Same as add_inferior, but don't print new inferior notifications to
454 extern struct inferior *add_inferior_silent (int pid);
456 /* Delete an existing inferior list entry, due to inferior exit. */
457 extern void delete_inferior (int pid);
459 /* Same as delete_inferior, but don't print new inferior notifications
461 extern void delete_inferior_silent (int pid);
463 /* Delete an existing inferior list entry, due to inferior detaching. */
464 extern void detach_inferior (int pid);
466 /* Get rid of all inferiors. */
467 extern void discard_all_inferiors (void);
469 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
470 into a "pid" (which may be overloaded with extra inferior information). */
471 extern int gdb_inferior_id_to_pid (int);
473 /* Translate a target 'pid' into the integer inferior id (GDB's
474 homegrown id, not the system's). */
475 extern int pid_to_gdb_inferior_id (int pid);
477 /* Boolean test for an already-known pid. */
478 extern int in_inferior_list (int pid);
480 /* Boolean test for an already-known inferior id (GDB's homegrown id,
481 not the system's). */
482 extern int valid_inferior_id (int num);
484 /* Search function to lookup a inferior by target 'pid'. */
485 extern struct inferior *find_inferior_pid (int pid);
487 /* Inferior iterator function.
489 Calls a callback function once for each inferior, so long as the
490 callback function returns false. If the callback function returns
491 true, the iteration will end and the current inferior will be
492 returned. This can be useful for implementing a search for a
493 inferior with arbitrary attributes, or for applying some operation
496 It is safe to delete the iterated inferior from the callback. */
497 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
501 /* Prints the list of inferiors and their details on UIOUT.
503 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
504 that should be printed. Otherwise, all inferiors are printed. */
505 extern void print_inferior (struct ui_out *uiout, int requested_inferior);
507 /* Returns true if the inferior list is not empty. */
508 extern int have_inferiors (void);
510 /* Return a pointer to the current inferior. It is an error to call
511 this if there is no current inferior. */
512 extern struct inferior *current_inferior (void);
514 #endif /* !defined (INFERIOR_H) */