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
;
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 /* The -1 ptid, often used to indicate either an error condition
62 or a "don't care" condition, i.e, "run all threads." */
63 extern ptid_t minus_one_ptid
;
65 /* The null or zero ptid, often used to indicate no process. */
66 extern ptid_t null_ptid
;
68 /* Attempt to find and return an existing ptid with the given PID, LWP,
69 and TID components. If none exists, create a new one and return
71 ptid_t
ptid_build (int pid
, long lwp
, long tid
);
73 /* Find/Create a ptid from just a pid. */
74 ptid_t
pid_to_ptid (int pid
);
76 /* Fetch the pid (process id) component from a ptid. */
77 int ptid_get_pid (ptid_t ptid
);
79 /* Fetch the lwp (lightweight process) component from a ptid. */
80 long ptid_get_lwp (ptid_t ptid
);
82 /* Fetch the tid (thread id) component from a ptid. */
83 long ptid_get_tid (ptid_t ptid
);
85 /* Compare two ptids to see if they are equal */
86 extern int ptid_equal (ptid_t p1
, ptid_t p2
);
88 /* Return true if PTID represents a process id. */
89 extern int ptid_is_pid (ptid_t ptid
);
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 /* Set/get file name for default use for standard in/out in the inferior. */
102 extern void set_inferior_io_terminal (const char *terminal_name
);
103 extern const char *get_inferior_io_terminal (void);
105 /* Collected pid, tid, etc. of the debugged inferior. When there's
106 no inferior, PIDGET (inferior_ptid) will be 0. */
108 extern ptid_t inferior_ptid
;
110 /* Are we simulating synchronous execution? This is used in async gdb
111 to implement the 'run', 'continue' etc commands, which will not
112 redisplay the prompt until the execution is actually over. */
113 extern int sync_execution
;
115 /* Inferior environment. */
117 extern struct gdb_environ
*inferior_environ
;
119 extern void clear_proceed_status (void);
121 extern void proceed (CORE_ADDR
, enum target_signal
, int);
123 /* When set, stop the 'step' command if we enter a function which has
124 no line number information. The normal behavior is that we step
125 over such function. */
126 extern int step_stop_if_no_debug
;
128 /* If set, the inferior should be controlled in non-stop mode. In
129 this mode, each thread is controlled independently. Execution
130 commands apply only to the the selected thread by default, and stop
131 events stop only the thread that had the event -- the other threads
132 are kept running freely. */
135 extern void generic_mourn_inferior (void);
137 extern void terminal_save_ours (void);
139 extern void terminal_ours (void);
141 extern CORE_ADDR
read_pc (void);
143 extern void write_pc (CORE_ADDR
);
145 extern CORE_ADDR
unsigned_pointer_to_address (struct type
*type
,
146 const gdb_byte
*buf
);
147 extern void unsigned_address_to_pointer (struct type
*type
, gdb_byte
*buf
,
149 extern CORE_ADDR
signed_pointer_to_address (struct type
*type
,
150 const gdb_byte
*buf
);
151 extern void address_to_signed_pointer (struct type
*type
, gdb_byte
*buf
,
154 extern void wait_for_inferior (int treat_exec_as_sigtrap
);
156 extern void fetch_inferior_event (void *);
158 extern void init_wait_for_inferior (void);
160 extern void close_exec_file (void);
162 extern void reopen_exec_file (void);
164 /* The `resume' routine should only be called in special circumstances.
165 Normally, use `proceed', which handles a lot of bookkeeping. */
167 extern void resume (int, enum target_signal
);
169 /* From misc files */
171 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
172 struct ui_file
*file
,
173 struct frame_info
*frame
,
174 int regnum
, int all
);
176 extern void child_terminal_info (char *, int);
178 extern void term_info (char *, int);
180 extern void terminal_ours_for_output (void);
182 extern void terminal_inferior (void);
184 extern void terminal_init_inferior (void);
186 extern void terminal_init_inferior_with_pgrp (int pgrp
);
190 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR
));
192 extern ptid_t
procfs_first_available (void);
194 /* From fork-child.c */
196 extern int fork_inferior (char *, char *, char **,
198 void (*)(int), void (*)(void), char *);
201 extern void startup_inferior (int);
203 extern char *construct_inferior_arguments (struct gdbarch
*, int, char **);
207 extern void new_tty_prefork (const char *);
209 extern int gdb_has_a_terminal (void);
213 extern void start_remote (int from_tty
);
215 extern void normal_stop (void);
217 extern int signal_stop_state (int);
219 extern int signal_print_state (int);
221 extern int signal_pass_state (int);
223 extern int signal_stop_update (int, int);
225 extern int signal_print_update (int, int);
227 extern int signal_pass_update (int, int);
229 extern void get_last_target_status(ptid_t
*ptid
,
230 struct target_waitstatus
*status
);
232 extern void follow_inferior_reset_breakpoints (void);
234 /* Throw an error indicating the current thread is running. */
235 extern void error_is_running (void);
237 /* Calls error_is_running if the current thread is running. */
238 extern void ensure_not_running (void);
242 extern void tty_command (char *, int);
244 extern void post_create_inferior (struct target_ops
*, int);
246 extern void attach_command (char *, int);
248 extern char *get_inferior_args (void);
250 extern char *set_inferior_args (char *);
252 extern void set_inferior_args_vector (int, char **);
254 extern void registers_info (char *, int);
256 extern void nexti_command (char *, int);
258 extern void stepi_command (char *, int);
260 extern void continue_1 (int all_threads
);
262 extern void continue_command (char *, int);
264 extern void interrupt_target_command (char *args
, int from_tty
);
266 extern void interrupt_target_1 (int all_threads
);
268 extern void detach_command (char *, int);
270 /* Address at which inferior stopped. */
272 extern CORE_ADDR stop_pc
;
274 /* Flag indicating that a command has proceeded the inferior past the
275 current breakpoint. */
277 extern int breakpoint_proceeded
;
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 /* When set, normal_stop will not call the normal_stop observer. */
357 extern int suppress_stop_observer
;
359 /* When set, no calls to target_resumed observer will be made. */
360 extern int suppress_resume_observer
;
363 /* Possible values for gdbarch_call_dummy_location. */
365 #define AT_ENTRY_POINT 4
368 /* If STARTUP_WITH_SHELL is set, GDB's "run"
369 will attempts to start up the debugee under a shell.
370 This is in order for argument-expansion to occur. E.g.,
372 The "*" gets expanded by the shell into a list of files.
373 While this is a nice feature, it turns out to interact badly
374 with some of the catch-fork/catch-exec features we have added.
375 In particular, if the shell does any fork/exec's before
376 the exec of the target program, that can confuse GDB.
377 To disable this feature, set STARTUP_WITH_SHELL to 0.
378 To enable this feature, set STARTUP_WITH_SHELL to 1.
379 The catch-exec traps expected during start-up will
380 be 1 if target is not started up with a shell, 2 if it is.
382 If you disable this, you need to decrement
383 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
384 #define STARTUP_WITH_SHELL 1
385 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
386 #define START_INFERIOR_TRAPS_EXPECTED 2
389 struct private_inferior
;
391 /* GDB represents the state of each program execution with an object
392 called an inferior. An inferior typically corresponds to a process
393 but is more general and applies also to targets that do not have a
394 notion of processes. Each run of an executable creates a new
395 inferior, as does each attachment to an existing process.
396 Inferiors have unique internal identifiers that are different from
397 target process ids. Each inferior may in turn have multiple
398 threads running in it. */
402 /* Pointer to next inferior in singly-linked list of inferiors. */
403 struct inferior
*next
;
405 /* Convenient handle (GDB inferior id). Unique across all
409 /* Actual target inferior id, usually, a process id. This matches
410 the ptid_t.pid member of threads of this inferior. */
413 /* See the definition of stop_kind above. */
414 enum stop_kind stop_soon
;
416 /* Nonzero if this child process was attached rather than
420 /* What is left to do for an execution command after any thread of
421 this inferior stops. For continuations associated with a
422 specific thread, see `struct thread_info'. */
423 struct continuation
*continuations
;
425 /* Private data used by the target vector implementation. */
426 struct private_inferior
*private;
429 /* Create an empty inferior list, or empty the existing one. */
430 extern void init_inferior_list (void);
432 /* Add an inferior to the inferior list, print a message that a new
433 inferior is found, and return the pointer to the new inferior.
434 Caller may use this pointer to initialize the private inferior
436 extern struct inferior
*add_inferior (int pid
);
438 /* Same as add_inferior, but don't print new inferior notifications to
440 extern struct inferior
*add_inferior_silent (int pid
);
442 /* Delete an existing inferior list entry, due to inferior exit. */
443 extern void delete_inferior (int pid
);
445 /* Same as delete_inferior, but don't print new inferior notifications
447 extern void delete_inferior_silent (int pid
);
449 /* Delete an existing inferior list entry, due to inferior detaching. */
450 extern void detach_inferior (int pid
);
452 /* Get rid of all inferiors. */
453 extern void discard_all_inferiors (void);
455 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
456 into a "pid" (which may be overloaded with extra inferior information). */
457 extern int gdb_inferior_id_to_pid (int);
459 /* Translate a target 'pid' into the integer inferior id (GDB's
460 homegrown id, not the system's). */
461 extern int pid_to_gdb_inferior_id (int pid
);
463 /* Boolean test for an already-known pid. */
464 extern int in_inferior_list (int pid
);
466 /* Boolean test for an already-known inferior id (GDB's homegrown id,
467 not the system's). */
468 extern int valid_inferior_id (int num
);
470 /* Search function to lookup a inferior by target 'pid'. */
471 extern struct inferior
*find_inferior_pid (int pid
);
473 /* Inferior iterator function.
475 Calls a callback function once for each inferior, so long as the
476 callback function returns false. If the callback function returns
477 true, the iteration will end and the current inferior will be
478 returned. This can be useful for implementing a search for a
479 inferior with arbitrary attributes, or for applying some operation
482 It is safe to delete the iterated inferior from the callback. */
483 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
487 /* Prints the list of inferiors and their details on UIOUT.
489 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
490 that should be printed. Otherwise, all inferiors are printed. */
491 extern void print_inferior (struct ui_out
*uiout
, int requested_inferior
);
493 /* Returns true if the inferior list is not empty. */
494 extern int have_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) */