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 /* 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 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 /* Inferior environment. */
121 extern struct gdb_environ
*inferior_environ
;
123 extern void clear_proceed_status (void);
125 extern void proceed (CORE_ADDR
, enum target_signal
, int);
127 /* When set, stop the 'step' command if we enter a function which has
128 no line number information. The normal behavior is that we step
129 over such function. */
130 extern int step_stop_if_no_debug
;
132 /* If set, the inferior should be controlled in non-stop mode. In
133 this mode, each thread is controlled independently. Execution
134 commands apply only to the the selected thread by default, and stop
135 events stop only the thread that had the event -- the other threads
136 are kept running freely. */
139 extern void generic_mourn_inferior (void);
141 extern void terminal_save_ours (void);
143 extern void terminal_ours (void);
145 extern CORE_ADDR
read_pc (void);
147 extern void write_pc (CORE_ADDR
);
149 extern CORE_ADDR
unsigned_pointer_to_address (struct type
*type
,
150 const gdb_byte
*buf
);
151 extern void unsigned_address_to_pointer (struct type
*type
, gdb_byte
*buf
,
153 extern CORE_ADDR
signed_pointer_to_address (struct type
*type
,
154 const gdb_byte
*buf
);
155 extern void address_to_signed_pointer (struct type
*type
, gdb_byte
*buf
,
158 extern void wait_for_inferior (int treat_exec_as_sigtrap
);
160 extern void fetch_inferior_event (void *);
162 extern void init_wait_for_inferior (void);
164 extern void close_exec_file (void);
166 extern void reopen_exec_file (void);
168 /* The `resume' routine should only be called in special circumstances.
169 Normally, use `proceed', which handles a lot of bookkeeping. */
171 extern void resume (int, enum target_signal
);
173 /* From misc files */
175 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
176 struct ui_file
*file
,
177 struct frame_info
*frame
,
178 int regnum
, int all
);
180 extern void child_terminal_info (char *, int);
182 extern void term_info (char *, int);
184 extern void terminal_ours_for_output (void);
186 extern void terminal_inferior (void);
188 extern void terminal_init_inferior (void);
190 extern void terminal_init_inferior_with_pgrp (int pgrp
);
194 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR
));
196 extern ptid_t
procfs_first_available (void);
198 /* From fork-child.c */
200 extern void fork_inferior (char *, char *, char **,
202 void (*)(int), void (*)(void), char *);
205 extern void startup_inferior (int);
207 extern char *construct_inferior_arguments (struct gdbarch
*, int, char **);
211 extern void new_tty_prefork (const char *);
213 extern int gdb_has_a_terminal (void);
217 extern void start_remote (int from_tty
);
219 extern void normal_stop (void);
221 extern int signal_stop_state (int);
223 extern int signal_print_state (int);
225 extern int signal_pass_state (int);
227 extern int signal_stop_update (int, int);
229 extern int signal_print_update (int, int);
231 extern int signal_pass_update (int, int);
233 extern void get_last_target_status(ptid_t
*ptid
,
234 struct target_waitstatus
*status
);
236 extern void follow_inferior_reset_breakpoints (void);
238 /* Throw an error indicating the current thread is running. */
239 extern void error_is_running (void);
241 /* Calls error_is_running if the current thread is running. */
242 extern void ensure_not_running (void);
246 extern void tty_command (char *, int);
248 extern void post_create_inferior (struct target_ops
*, int);
250 extern void attach_command (char *, int);
252 extern char *get_inferior_args (void);
254 extern char *set_inferior_args (char *);
256 extern void set_inferior_args_vector (int, char **);
258 extern void registers_info (char *, int);
260 extern void nexti_command (char *, int);
262 extern void stepi_command (char *, int);
264 extern void continue_1 (int all_threads
);
266 extern void continue_command (char *, int);
268 extern void interrupt_target_command (char *args
, int from_tty
);
270 extern void interrupt_target_1 (int all_threads
);
272 /* Address at which inferior stopped. */
274 extern CORE_ADDR stop_pc
;
276 /* Flag indicating that a command has proceeded the inferior past the
277 current breakpoint. */
279 extern int breakpoint_proceeded
;
281 /* Nonzero if stopped due to completion of a stack dummy routine. */
283 extern int stop_stack_dummy
;
285 /* Nonzero if program stopped due to a random (unexpected) signal in
288 extern int stopped_by_random_signal
;
290 /* 1 means step over all subroutine calls.
291 -1 means step over calls to undebuggable functions. */
293 enum step_over_calls_kind
297 STEP_OVER_UNDEBUGGABLE
300 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
301 will handle it themselves. STOP_QUIETLY is used when running in
302 the shell before the child program has been exec'd and when running
303 through shared library loading. STOP_QUIETLY_REMOTE is used when
304 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
305 except that there is no need to hide a signal. */
307 /* It is also used after attach, due to attaching to a process. This
308 is a bit trickier. When doing an attach, the kernel stops the
309 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
310 the handling of SIGSTOP for a ptraced process has changed. Earlier
311 versions of the kernel would ignore these SIGSTOPs, while now
312 SIGSTOP is treated like any other signal, i.e. it is not muffled.
314 If the gdb user does a 'continue' after the 'attach', gdb passes
315 the global variable stop_signal (which stores the signal from the
316 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
317 problematic, because the kernel doesn't ignore such SIGSTOP
318 now. I.e. it is reported back to gdb, which in turn presents it
321 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
322 gdb to clear the value of stop_signal after the attach, so that it
323 is not passed back down to the kernel. */
330 STOP_QUIETLY_NO_SIGSTOP
333 /* Reverse execution. */
334 enum exec_direction_kind
341 extern enum exec_direction_kind execution_direction
;
343 /* Nonzero if proceed is being used for a "finish" command or a similar
344 situation when stop_registers should be saved. */
346 extern int proceed_to_finish
;
348 /* Save register contents here when about to pop a stack dummy frame,
349 if-and-only-if proceed_to_finish is set.
350 Thus this contains the return value from the called function (assuming
351 values are returned in a register). */
353 extern struct regcache
*stop_registers
;
355 /* True if we are debugging displaced stepping. */
356 extern int debug_displaced
;
358 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
359 void displaced_step_dump_bytes (struct ui_file
*file
,
360 const gdb_byte
*buf
, size_t len
);
363 /* When set, normal_stop will not call the normal_stop observer. */
364 extern int suppress_stop_observer
;
366 /* When set, no calls to target_resumed observer will be made. */
367 extern int suppress_resume_observer
;
370 /* Possible values for gdbarch_call_dummy_location. */
372 #define AT_ENTRY_POINT 4
375 /* If STARTUP_WITH_SHELL is set, GDB's "run"
376 will attempts to start up the debugee under a shell.
377 This is in order for argument-expansion to occur. E.g.,
379 The "*" gets expanded by the shell into a list of files.
380 While this is a nice feature, it turns out to interact badly
381 with some of the catch-fork/catch-exec features we have added.
382 In particular, if the shell does any fork/exec's before
383 the exec of the target program, that can confuse GDB.
384 To disable this feature, set STARTUP_WITH_SHELL to 0.
385 To enable this feature, set STARTUP_WITH_SHELL to 1.
386 The catch-exec traps expected during start-up will
387 be 1 if target is not started up with a shell, 2 if it is.
389 If you disable this, you need to decrement
390 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
391 #define STARTUP_WITH_SHELL 1
392 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
393 #define START_INFERIOR_TRAPS_EXPECTED 2
396 struct private_inferior
;
398 /* GDB represents the state of each program execution with an object
399 called an inferior. An inferior typically corresponds to a process
400 but is more general and applies also to targets that do not have a
401 notion of processes. Each run of an executable creates a new
402 inferior, as does each attachment to an existing process.
403 Inferiors have unique internal identifiers that are different from
404 target process ids. Each inferior may in turn have multiple
405 threads running in it. */
409 /* Pointer to next inferior in singly-linked list of inferiors. */
410 struct inferior
*next
;
412 /* Convenient handle (GDB inferior id). Unique across all
416 /* Actual target inferior id, usually, a process id. This matches
417 the ptid_t.pid member of threads of this inferior. */
420 /* See the definition of stop_kind above. */
421 enum stop_kind stop_soon
;
423 /* Nonzero if this child process was attached rather than
427 /* Private data used by the target vector implementation. */
428 struct private_inferior
*private;
431 /* Create an empty inferior list, or empty the existing one. */
432 extern void init_inferior_list (void);
434 /* Add an inferior to the inferior list, print a message that a new
435 inferior is found, and return the pointer to the new inferior.
436 Caller may use this pointer to initialize the private inferior
438 extern struct inferior
*add_inferior (int pid
);
440 /* Same as add_inferior, but don't print new inferior notifications to
442 extern struct inferior
*add_inferior_silent (int pid
);
444 /* Delete an existing inferior list entry, due to inferior exit. */
445 extern void delete_inferior (int pid
);
447 /* Same as delete_inferior, but don't print new inferior notifications
449 extern void delete_inferior_silent (int pid
);
451 /* Delete an existing inferior list entry, due to inferior detaching. */
452 extern void detach_inferior (int pid
);
454 /* Get rid of all inferiors. */
455 extern void discard_all_inferiors (void);
457 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
458 into a "pid" (which may be overloaded with extra inferior information). */
459 extern int gdb_inferior_id_to_pid (int);
461 /* Translate a target 'pid' into the integer inferior id (GDB's
462 homegrown id, not the system's). */
463 extern int pid_to_gdb_inferior_id (int pid
);
465 /* Boolean test for an already-known pid. */
466 extern int in_inferior_list (int pid
);
468 /* Boolean test for an already-known inferior id (GDB's homegrown id,
469 not the system's). */
470 extern int valid_inferior_id (int num
);
472 /* Search function to lookup a inferior by target 'pid'. */
473 extern struct inferior
*find_inferior_pid (int pid
);
475 /* Inferior iterator function.
477 Calls a callback function once for each inferior, so long as the
478 callback function returns false. If the callback function returns
479 true, the iteration will end and the current inferior will be
480 returned. This can be useful for implementing a search for a
481 inferior with arbitrary attributes, or for applying some operation
484 It is safe to delete the iterated inferior from the callback. */
485 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
489 /* Prints the list of inferiors and their details on UIOUT.
491 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
492 that should be printed. Otherwise, all inferiors are printed. */
493 extern void print_inferior (struct ui_out
*uiout
, int requested_inferior
);
495 /* Returns true if the inferior list is not empty. */
496 extern int have_inferiors (void);
498 /* Return a pointer to the current inferior. It is an error to call
499 this if there is no current inferior. */
500 extern struct inferior
*current_inferior (void);
502 #endif /* !defined (INFERIOR_H) */