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 /* Some targets (stupidly) report more than one exec event per actual
120 call to an event() system call. If only the last such exec event
121 need actually be noticed and responded to by the debugger (i.e.,
122 be reported to the user), then this is the number of "leading"
123 exec events which should be ignored.
125 extern int inferior_ignoring_leading_exec_events
;
127 /* Inferior environment. */
129 extern struct gdb_environ
*inferior_environ
;
131 extern void clear_proceed_status (void);
133 extern void proceed (CORE_ADDR
, enum target_signal
, int);
135 /* When set, stop the 'step' command if we enter a function which has
136 no line number information. The normal behavior is that we step
137 over such function. */
138 extern int step_stop_if_no_debug
;
140 /* If set, the inferior should be controlled in non-stop mode. In
141 this mode, each thread is controlled independently. Execution
142 commands apply only to the the selected thread by default, and stop
143 events stop only the thread that had the event -- the other threads
144 are kept running freely. */
147 extern void generic_mourn_inferior (void);
149 extern void terminal_save_ours (void);
151 extern void terminal_ours (void);
153 extern CORE_ADDR
read_pc (void);
155 extern void write_pc (CORE_ADDR
);
157 extern CORE_ADDR
unsigned_pointer_to_address (struct type
*type
,
158 const gdb_byte
*buf
);
159 extern void unsigned_address_to_pointer (struct type
*type
, gdb_byte
*buf
,
161 extern CORE_ADDR
signed_pointer_to_address (struct type
*type
,
162 const gdb_byte
*buf
);
163 extern void address_to_signed_pointer (struct type
*type
, gdb_byte
*buf
,
166 extern void wait_for_inferior (int treat_exec_as_sigtrap
);
168 extern void fetch_inferior_event (void *);
170 extern void init_wait_for_inferior (void);
172 extern void close_exec_file (void);
174 extern void reopen_exec_file (void);
176 /* The `resume' routine should only be called in special circumstances.
177 Normally, use `proceed', which handles a lot of bookkeeping. */
179 extern void resume (int, enum target_signal
);
181 /* From misc files */
183 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
184 struct ui_file
*file
,
185 struct frame_info
*frame
,
186 int regnum
, int all
);
188 extern void child_terminal_info (char *, int);
190 extern void term_info (char *, int);
192 extern void terminal_ours_for_output (void);
194 extern void terminal_inferior (void);
196 extern void terminal_init_inferior (void);
198 extern void terminal_init_inferior_with_pgrp (int pgrp
);
202 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR
));
204 extern ptid_t
procfs_first_available (void);
206 /* From fork-child.c */
208 extern void fork_inferior (char *, char *, char **,
210 void (*)(int), void (*)(void), char *);
213 extern void startup_inferior (int);
215 extern char *construct_inferior_arguments (struct gdbarch
*, int, char **);
219 extern void new_tty_prefork (const char *);
221 extern int gdb_has_a_terminal (void);
225 extern void start_remote (int from_tty
);
227 extern void normal_stop (void);
229 extern int signal_stop_state (int);
231 extern int signal_print_state (int);
233 extern int signal_pass_state (int);
235 extern int signal_stop_update (int, int);
237 extern int signal_print_update (int, int);
239 extern int signal_pass_update (int, int);
241 extern void get_last_target_status(ptid_t
*ptid
,
242 struct target_waitstatus
*status
);
244 extern void follow_inferior_reset_breakpoints (void);
246 /* Throw an error indicating the current thread is running. */
247 extern void error_is_running (void);
249 /* Calls error_is_running if the current thread is running. */
250 extern void ensure_not_running (void);
254 extern void tty_command (char *, int);
256 extern void post_create_inferior (struct target_ops
*, int);
258 extern void attach_command (char *, int);
260 extern char *get_inferior_args (void);
262 extern char *set_inferior_args (char *);
264 extern void set_inferior_args_vector (int, char **);
266 extern void registers_info (char *, int);
268 extern void nexti_command (char *, int);
270 extern void stepi_command (char *, int);
272 extern void continue_1 (int all_threads
);
274 extern void continue_command (char *, int);
276 extern void interrupt_target_command (char *args
, int from_tty
);
278 extern void interrupt_target_1 (int all_threads
);
280 /* Address at which inferior stopped. */
282 extern CORE_ADDR stop_pc
;
284 /* Flag indicating that a command has proceeded the inferior past the
285 current breakpoint. */
287 extern int breakpoint_proceeded
;
289 /* Nonzero if stopped due to completion of a stack dummy routine. */
291 extern int stop_stack_dummy
;
293 /* Nonzero if program stopped due to a random (unexpected) signal in
296 extern int stopped_by_random_signal
;
298 /* 1 means step over all subroutine calls.
299 -1 means step over calls to undebuggable functions. */
301 enum step_over_calls_kind
305 STEP_OVER_UNDEBUGGABLE
308 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
309 will handle it themselves. STOP_QUIETLY is used when running in
310 the shell before the child program has been exec'd and when running
311 through shared library loading. STOP_QUIETLY_REMOTE is used when
312 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
313 except that there is no need to hide a signal. */
315 /* It is also used after attach, due to attaching to a process. This
316 is a bit trickier. When doing an attach, the kernel stops the
317 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
318 the handling of SIGSTOP for a ptraced process has changed. Earlier
319 versions of the kernel would ignore these SIGSTOPs, while now
320 SIGSTOP is treated like any other signal, i.e. it is not muffled.
322 If the gdb user does a 'continue' after the 'attach', gdb passes
323 the global variable stop_signal (which stores the signal from the
324 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
325 problematic, because the kernel doesn't ignore such SIGSTOP
326 now. I.e. it is reported back to gdb, which in turn presents it
329 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
330 gdb to clear the value of stop_signal after the attach, so that it
331 is not passed back down to the kernel. */
338 STOP_QUIETLY_NO_SIGSTOP
341 /* Reverse execution. */
342 enum exec_direction_kind
349 extern enum exec_direction_kind execution_direction
;
351 /* Nonzero if proceed is being used for a "finish" command or a similar
352 situation when stop_registers should be saved. */
354 extern int proceed_to_finish
;
356 /* Save register contents here when about to pop a stack dummy frame,
357 if-and-only-if proceed_to_finish is set.
358 Thus this contains the return value from the called function (assuming
359 values are returned in a register). */
361 extern struct regcache
*stop_registers
;
363 /* True if we are debugging displaced stepping. */
364 extern int debug_displaced
;
366 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
367 void displaced_step_dump_bytes (struct ui_file
*file
,
368 const gdb_byte
*buf
, size_t len
);
371 /* When set, normal_stop will not call the normal_stop observer. */
372 extern int suppress_stop_observer
;
374 /* When set, no calls to target_resumed observer will be made. */
375 extern int suppress_resume_observer
;
378 /* Possible values for gdbarch_call_dummy_location. */
380 #define AT_ENTRY_POINT 4
383 /* If STARTUP_WITH_SHELL is set, GDB's "run"
384 will attempts to start up the debugee under a shell.
385 This is in order for argument-expansion to occur. E.g.,
387 The "*" gets expanded by the shell into a list of files.
388 While this is a nice feature, it turns out to interact badly
389 with some of the catch-fork/catch-exec features we have added.
390 In particular, if the shell does any fork/exec's before
391 the exec of the target program, that can confuse GDB.
392 To disable this feature, set STARTUP_WITH_SHELL to 0.
393 To enable this feature, set STARTUP_WITH_SHELL to 1.
394 The catch-exec traps expected during start-up will
395 be 1 if target is not started up with a shell, 2 if it is.
397 If you disable this, you need to decrement
398 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
399 #define STARTUP_WITH_SHELL 1
400 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
401 #define START_INFERIOR_TRAPS_EXPECTED 2
404 struct private_inferior
;
406 /* GDB represents the state of each program execution with an object
407 called an inferior. An inferior typically corresponds to a process
408 but is more general and applies also to targets that do not have a
409 notion of processes. Each run of an executable creates a new
410 inferior, as does each attachment to an existing process.
411 Inferiors have unique internal identifiers that are different from
412 target process ids. Each inferior may in turn have multiple
413 threads running in it. */
417 /* Pointer to next inferior in singly-linked list of inferiors. */
418 struct inferior
*next
;
420 /* Convenient handle (GDB inferior id). Unique across all
424 /* Actual target inferior id, usually, a process id. This matches
425 the ptid_t.pid member of threads of this inferior. */
428 /* See the definition of stop_kind above. */
429 enum stop_kind stop_soon
;
431 /* Nonzero if this child process was attached rather than
435 /* Private data used by the target vector implementation. */
436 struct private_inferior
*private;
439 /* Create an empty inferior list, or empty the existing one. */
440 extern void init_inferior_list (void);
442 /* Add an inferior to the inferior list, print a message that a new
443 inferior is found, and return the pointer to the new inferior.
444 Caller may use this pointer to initialize the private inferior
446 extern struct inferior
*add_inferior (int pid
);
448 /* Same as add_inferior, but don't print new inferior notifications to
450 extern struct inferior
*add_inferior_silent (int pid
);
452 /* Delete an existing inferior list entry, due to inferior exit. */
453 extern void delete_inferior (int pid
);
455 /* Same as delete_inferior, but don't print new inferior notifications
457 extern void delete_inferior_silent (int pid
);
459 /* Delete an existing inferior list entry, due to inferior detaching. */
460 extern void detach_inferior (int pid
);
462 /* Get rid of all inferiors. */
463 extern void discard_all_inferiors (void);
465 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
466 into a "pid" (which may be overloaded with extra inferior information). */
467 extern int gdb_inferior_id_to_pid (int);
469 /* Translate a target 'pid' into the integer inferior id (GDB's
470 homegrown id, not the system's). */
471 extern int pid_to_gdb_inferior_id (int pid
);
473 /* Boolean test for an already-known pid. */
474 extern int in_inferior_list (int pid
);
476 /* Boolean test for an already-known inferior id (GDB's homegrown id,
477 not the system's). */
478 extern int valid_inferior_id (int num
);
480 /* Search function to lookup a inferior by target 'pid'. */
481 extern struct inferior
*find_inferior_pid (int pid
);
483 /* Inferior iterator function.
485 Calls a callback function once for each inferior, so long as the
486 callback function returns false. If the callback function returns
487 true, the iteration will end and the current inferior will be
488 returned. This can be useful for implementing a search for a
489 inferior with arbitrary attributes, or for applying some operation
492 It is safe to delete the iterated inferior from the callback. */
493 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
497 /* Prints the list of inferiors and their details on UIOUT.
499 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
500 that should be printed. Otherwise, all inferiors are printed. */
501 extern void print_inferior (struct ui_out
*uiout
, int requested_inferior
);
503 /* Returns true if the inferior list is not empty. */
504 extern int have_inferiors (void);
506 /* Return a pointer to the current inferior. It is an error to call
507 this if there is no current inferior. */
508 extern struct inferior
*current_inferior (void);
510 #endif /* !defined (INFERIOR_H) */