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, 2010,
6 2011 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
;
36 #include "breakpoint.h"
38 /* For enum target_signal. */
41 /* For struct frame_id. */
44 #include "progspace.h"
46 struct infcall_suspend_state
;
47 struct infcall_control_state
;
49 extern struct infcall_suspend_state
*save_infcall_suspend_state (void);
50 extern struct infcall_control_state
*save_infcall_control_state (void);
52 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
53 extern void restore_infcall_control_state (struct infcall_control_state
*);
55 extern struct cleanup
*make_cleanup_restore_infcall_suspend_state
56 (struct infcall_suspend_state
*);
57 extern struct cleanup
*make_cleanup_restore_infcall_control_state
58 (struct infcall_control_state
*);
60 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
61 extern void discard_infcall_control_state (struct infcall_control_state
*);
63 extern struct regcache
*
64 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
66 /* The -1 ptid, often used to indicate either an error condition
67 or a "don't care" condition, i.e, "run all threads." */
68 extern ptid_t minus_one_ptid
;
70 /* The null or zero ptid, often used to indicate no process. */
71 extern ptid_t null_ptid
;
73 /* Attempt to find and return an existing ptid with the given PID, LWP,
74 and TID components. If none exists, create a new one and return
76 ptid_t
ptid_build (int pid
, long lwp
, long tid
);
78 /* Find/Create a ptid from just a pid. */
79 ptid_t
pid_to_ptid (int pid
);
81 /* Fetch the pid (process id) component from a ptid. */
82 int ptid_get_pid (ptid_t ptid
);
84 /* Fetch the lwp (lightweight process) component from a ptid. */
85 long ptid_get_lwp (ptid_t ptid
);
87 /* Fetch the tid (thread id) component from a ptid. */
88 long ptid_get_tid (ptid_t ptid
);
90 /* Compare two ptids to see if they are equal */
91 extern int ptid_equal (ptid_t p1
, ptid_t p2
);
93 /* Return true if PTID represents a process id. */
94 extern int ptid_is_pid (ptid_t ptid
);
96 /* Returns true if PTID matches filter FILTER. FILTER can be the wild
97 card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
98 a process (ptid_is_pid returns true), in which case, all lwps and
99 threads of that given process match, lwps and threads of other
100 processes do not; or, it can represent a specific thread, in which
101 case, only that thread will match true. PTID must represent a
102 specific LWP or THREAD, it can never be a wild card. */
104 extern int ptid_match (ptid_t ptid
, ptid_t filter
);
106 /* Save value of inferior_ptid so that it may be restored by
107 a later call to do_cleanups(). Returns the struct cleanup
108 pointer needed for later doing the cleanup. */
109 extern struct cleanup
* save_inferior_ptid (void);
111 extern void set_sigint_trap (void);
113 extern void clear_sigint_trap (void);
115 /* Set/get file name for default use for standard in/out in the inferior. */
117 extern void set_inferior_io_terminal (const char *terminal_name
);
118 extern const char *get_inferior_io_terminal (void);
120 /* Collected pid, tid, etc. of the debugged inferior. When there's
121 no inferior, PIDGET (inferior_ptid) will be 0. */
123 extern ptid_t inferior_ptid
;
125 /* Are we simulating synchronous execution? This is used in async gdb
126 to implement the 'run', 'continue' etc commands, which will not
127 redisplay the prompt until the execution is actually over. */
128 extern int sync_execution
;
130 /* Inferior environment. */
132 extern void clear_proceed_status (void);
134 extern void proceed (CORE_ADDR
, enum target_signal
, int);
136 extern int sched_multi
;
138 /* When set, stop the 'step' command if we enter a function which has
139 no line number information. The normal behavior is that we step
140 over such function. */
141 extern int step_stop_if_no_debug
;
143 /* If set, the inferior should be controlled in non-stop mode. In
144 this mode, each thread is controlled independently. Execution
145 commands apply only to the the selected thread by default, and stop
146 events stop only the thread that had the event -- the other threads
147 are kept running freely. */
150 /* If set (default), when following a fork, GDB will detach from one
151 the fork branches, child or parent. Exactly which branch is
152 detached depends on 'set follow-fork-mode' setting. */
153 extern int detach_fork
;
155 extern void generic_mourn_inferior (void);
157 extern void terminal_save_ours (void);
159 extern void terminal_ours (void);
161 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
163 const gdb_byte
*buf
);
164 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
165 struct type
*type
, gdb_byte
*buf
,
167 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
169 const gdb_byte
*buf
);
170 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
171 struct type
*type
, gdb_byte
*buf
,
174 extern void wait_for_inferior (int treat_exec_as_sigtrap
);
176 extern void prepare_for_detach (void);
178 extern void fetch_inferior_event (void *);
180 extern void init_wait_for_inferior (void);
182 extern void close_exec_file (void);
184 extern void reopen_exec_file (void);
186 /* The `resume' routine should only be called in special circumstances.
187 Normally, use `proceed', which handles a lot of bookkeeping. */
189 extern void resume (int, enum target_signal
);
191 /* From misc files */
193 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
194 struct ui_file
*file
,
195 struct frame_info
*frame
,
196 int regnum
, int all
);
198 extern void child_terminal_info (char *, int);
200 extern void term_info (char *, int);
202 extern void terminal_ours_for_output (void);
204 extern void terminal_inferior (void);
206 extern void terminal_init_inferior (void);
208 extern void terminal_init_inferior_with_pgrp (int pgrp
);
210 /* From fork-child.c */
212 extern int fork_inferior (char *, char *, char **,
214 void (*)(int), void (*)(void), char *);
217 extern void startup_inferior (int);
219 extern char *construct_inferior_arguments (int, char **);
223 extern int debug_infrun
;
225 extern int stop_on_solib_events
;
227 extern void start_remote (int from_tty
);
229 extern void normal_stop (void);
231 extern int signal_stop_state (int);
233 extern int signal_print_state (int);
235 extern int signal_pass_state (int);
237 extern int signal_stop_update (int, int);
239 extern int signal_print_update (int, int);
241 extern int signal_pass_update (int, int);
243 extern void get_last_target_status(ptid_t
*ptid
,
244 struct target_waitstatus
*status
);
246 extern void follow_inferior_reset_breakpoints (void);
248 /* Throw an error indicating the current thread is running. */
249 extern void error_is_running (void);
251 /* Calls error_is_running if the current thread is running. */
252 extern void ensure_not_running (void);
254 void set_step_info (struct frame_info
*frame
, struct symtab_and_line sal
);
258 extern void post_create_inferior (struct target_ops
*, int);
260 extern void attach_command (char *, int);
262 extern char *get_inferior_args (void);
264 extern void set_inferior_args (char *);
266 extern void set_inferior_args_vector (int, char **);
268 extern void registers_info (char *, int);
270 extern void nexti_command (char *, int);
272 extern void stepi_command (char *, int);
274 extern void continue_1 (int all_threads
);
276 extern void continue_command (char *, int);
278 extern void interrupt_target_command (char *args
, int from_tty
);
280 extern void interrupt_target_1 (int all_threads
);
282 extern void delete_longjmp_breakpoint_cleanup (void *arg
);
284 extern void detach_command (char *, int);
286 extern void notice_new_inferior (ptid_t
, int, int);
288 /* Address at which inferior stopped. */
290 extern CORE_ADDR stop_pc
;
292 /* Nonzero if stopped due to completion of a stack dummy routine. */
294 extern enum stop_stack_kind stop_stack_dummy
;
296 /* Nonzero if program stopped due to a random (unexpected) signal in
299 extern int stopped_by_random_signal
;
301 /* STEP_OVER_ALL means step over all subroutine calls.
302 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
303 STEP_OVER_NONE means don't step over any subroutine calls. */
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 /* Save register contents here when executing a "finish" command or are
356 about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
357 Thus this contains the return value from the called function (assuming
358 values are returned in a register). */
360 extern struct regcache
*stop_registers
;
362 /* True if we are debugging displaced stepping. */
363 extern int debug_displaced
;
365 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
366 void displaced_step_dump_bytes (struct ui_file
*file
,
367 const gdb_byte
*buf
, size_t len
);
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 /* Inferior process specific part of `struct infcall_control_state'.
400 Inferior thread counterpart is `struct thread_control_state'. */
402 struct inferior_control_state
404 /* See the definition of stop_kind above. */
405 enum stop_kind stop_soon
;
408 /* Inferior process specific part of `struct infcall_suspend_state'.
410 Inferior thread counterpart is `struct thread_suspend_state'. */
412 struct inferior_suspend_state
416 /* GDB represents the state of each program execution with an object
417 called an inferior. An inferior typically corresponds to a process
418 but is more general and applies also to targets that do not have a
419 notion of processes. Each run of an executable creates a new
420 inferior, as does each attachment to an existing process.
421 Inferiors have unique internal identifiers that are different from
422 target process ids. Each inferior may in turn have multiple
423 threads running in it. */
427 /* Pointer to next inferior in singly-linked list of inferiors. */
428 struct inferior
*next
;
430 /* Convenient handle (GDB inferior id). Unique across all
434 /* Actual target inferior id, usually, a process id. This matches
435 the ptid_t.pid member of threads of this inferior. */
438 /* State of GDB control of inferior process execution.
439 See `struct inferior_control_state'. */
440 struct inferior_control_state control
;
442 /* State of inferior process to restore after GDB is done with an inferior
443 call. See `struct inferior_suspend_state'. */
444 struct inferior_suspend_state suspend
;
446 /* True if this was an auto-created inferior, e.g. created from
447 following a fork; false, if this inferior was manually added by
448 the user, and we should not attempt to prune it
452 /* The address space bound to this inferior. */
453 struct address_space
*aspace
;
455 /* The program space bound to this inferior. */
456 struct program_space
*pspace
;
458 /* The arguments string to use when running. */
461 /* The size of elements in argv. */
464 /* The vector version of arguments. If ARGC is nonzero,
465 then we must compute ARGS from this (via the target).
466 This is always coming from main's argv and therefore
467 should never be freed. */
470 /* The name of terminal device to use for I/O. */
473 /* Environment to use for running inferior,
474 in format described in environ.h. */
475 struct gdb_environ
*environment
;
477 /* Nonzero if this child process was attached rather than
481 /* If this inferior is a vfork child, then this is the pointer to
482 its vfork parent, if GDB is still attached to it. */
483 struct inferior
*vfork_parent
;
485 /* If this process is a vfork parent, this is the pointer to the
486 child. Since a vfork parent is left frozen by the kernel until
487 the child execs or exits, a process can only have one vfork child
489 struct inferior
*vfork_child
;
491 /* True if this inferior should be detached when it's vfork sibling
495 /* True if this inferior is a vfork parent waiting for a vfork child
496 not under our control to be done with the shared memory region,
497 either by exiting or execing. */
498 int waiting_for_vfork_done
;
500 /* True if we're in the process of detaching from this inferior. */
503 /* What is left to do for an execution command after any thread of
504 this inferior stops. For continuations associated with a
505 specific thread, see `struct thread_info'. */
506 struct continuation
*continuations
;
508 /* Private data used by the target vector implementation. */
509 struct private_inferior
*private;
511 /* We keep a count of the number of times the user has requested a
512 particular syscall to be tracked, and pass this information to the
513 target. This lets capable targets implement filtering directly. */
515 /* Number of times that "any" syscall is requested. */
516 int any_syscall_count
;
518 /* Count of each system call. */
519 VEC(int) *syscalls_counts
;
521 /* This counts all syscall catch requests, so we can readily determine
522 if any catching is necessary. */
523 int total_syscalls_count
;
525 /* Per inferior data-pointers required by other GDB modules. */
530 /* Keep a registry of per-inferior data-pointers required by other GDB
533 extern const struct inferior_data
*register_inferior_data (void);
534 extern const struct inferior_data
*register_inferior_data_with_cleanup
535 (void (*cleanup
) (struct inferior
*, void *));
536 extern void clear_inferior_data (struct inferior
*inf
);
537 extern void set_inferior_data (struct inferior
*inf
,
538 const struct inferior_data
*data
, void *value
);
539 extern void *inferior_data (struct inferior
*inf
,
540 const struct inferior_data
*data
);
542 /* Create an empty inferior list, or empty the existing one. */
543 extern void init_inferior_list (void);
545 /* Add an inferior to the inferior list, print a message that a new
546 inferior is found, and return the pointer to the new inferior.
547 Caller may use this pointer to initialize the private inferior
549 extern struct inferior
*add_inferior (int pid
);
551 /* Same as add_inferior, but don't print new inferior notifications to
553 extern struct inferior
*add_inferior_silent (int pid
);
555 /* Delete an existing inferior list entry, due to inferior exit. */
556 extern void delete_inferior (int pid
);
558 extern void delete_inferior_1 (struct inferior
*todel
, int silent
);
560 /* Same as delete_inferior, but don't print new inferior notifications
562 extern void delete_inferior_silent (int pid
);
564 /* Delete an existing inferior list entry, due to inferior detaching. */
565 extern void detach_inferior (int pid
);
567 extern void exit_inferior (int pid
);
569 extern void exit_inferior_silent (int pid
);
571 extern void exit_inferior_num_silent (int num
);
573 extern void inferior_appeared (struct inferior
*inf
, int pid
);
575 /* Get rid of all inferiors. */
576 extern void discard_all_inferiors (void);
578 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
579 into a "pid" (which may be overloaded with extra inferior information). */
580 extern int gdb_inferior_id_to_pid (int);
582 /* Translate a target 'pid' into the integer inferior id (GDB's
583 homegrown id, not the system's). */
584 extern int pid_to_gdb_inferior_id (int pid
);
586 /* Boolean test for an already-known pid. */
587 extern int in_inferior_list (int pid
);
589 /* Boolean test for an already-known inferior id (GDB's homegrown id,
590 not the system's). */
591 extern int valid_gdb_inferior_id (int num
);
593 /* Search function to lookup an inferior by target 'pid'. */
594 extern struct inferior
*find_inferior_pid (int pid
);
596 /* Search function to lookup an inferior by GDB 'num'. */
597 extern struct inferior
*find_inferior_id (int num
);
599 /* Find an inferior bound to PSPACE. */
600 extern struct inferior
*
601 find_inferior_for_program_space (struct program_space
*pspace
);
603 /* Inferior iterator function.
605 Calls a callback function once for each inferior, so long as the
606 callback function returns false. If the callback function returns
607 true, the iteration will end and the current inferior will be
608 returned. This can be useful for implementing a search for a
609 inferior with arbitrary attributes, or for applying some operation
612 It is safe to delete the iterated inferior from the callback. */
613 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
617 /* Prints the list of inferiors and their details on UIOUT.
619 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
620 that should be printed. Otherwise, all inferiors are printed. */
621 extern void print_inferior (struct ui_out
*uiout
, int requested_inferior
);
623 /* Returns true if the inferior list is not empty. */
624 extern int have_inferiors (void);
626 /* Returns true if there are any live inferiors in the inferior list
627 (not cores, not executables, real live processes). */
628 extern int have_live_inferiors (void);
630 /* Return a pointer to the current inferior. It is an error to call
631 this if there is no current inferior. */
632 extern struct inferior
*current_inferior (void);
634 extern void set_current_inferior (struct inferior
*);
636 extern struct cleanup
*save_current_inferior (void);
638 extern struct inferior
*inferior_list
;
640 /* Prune away automatically added inferiors that aren't required
642 extern void prune_inferiors (void);
644 extern int number_of_inferiors (void);
646 extern struct inferior
*add_inferior_with_spaces (void);
648 extern void update_observer_mode (void);
650 #endif /* !defined (INFERIOR_H) */