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 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 (void);
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 extern ptid_t user_visible_resume_ptid (int step);
193 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
194 struct symtab_and_line ,
197 /* From misc files */
199 extern void default_print_registers_info (struct gdbarch *gdbarch,
200 struct ui_file *file,
201 struct frame_info *frame,
202 int regnum, int all);
204 extern void child_terminal_info (char *, int);
206 extern void term_info (char *, int);
208 extern void terminal_ours_for_output (void);
210 extern void terminal_inferior (void);
212 extern void terminal_init_inferior (void);
214 extern void terminal_init_inferior_with_pgrp (int pgrp);
216 /* From fork-child.c */
218 extern int fork_inferior (char *, char *, char **,
220 void (*)(int), void (*)(void), char *);
223 extern void startup_inferior (int);
225 extern char *construct_inferior_arguments (int, char **);
229 extern int debug_infrun;
231 extern int stop_on_solib_events;
233 extern void start_remote (int from_tty);
235 extern void normal_stop (void);
237 extern int signal_stop_state (int);
239 extern int signal_print_state (int);
241 extern int signal_pass_state (int);
243 extern int signal_stop_update (int, int);
245 extern int signal_print_update (int, int);
247 extern int signal_pass_update (int, int);
249 extern void get_last_target_status(ptid_t *ptid,
250 struct target_waitstatus *status);
252 extern void follow_inferior_reset_breakpoints (void);
254 /* Throw an error indicating the current thread is running. */
255 extern void error_is_running (void);
257 /* Calls error_is_running if the current thread is running. */
258 extern void ensure_not_running (void);
260 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
264 extern void post_create_inferior (struct target_ops *, int);
266 extern void attach_command (char *, int);
268 extern char *get_inferior_args (void);
270 extern void set_inferior_args (char *);
272 extern void set_inferior_args_vector (int, char **);
274 extern void registers_info (char *, int);
276 extern void nexti_command (char *, int);
278 extern void stepi_command (char *, int);
280 extern void continue_1 (int all_threads);
282 extern void continue_command (char *, int);
284 extern void interrupt_target_command (char *args, int from_tty);
286 extern void interrupt_target_1 (int all_threads);
288 extern void delete_longjmp_breakpoint_cleanup (void *arg);
290 extern void detach_command (char *, int);
292 extern void notice_new_inferior (ptid_t, int, int);
294 /* Address at which inferior stopped. */
296 extern CORE_ADDR stop_pc;
298 /* Nonzero if stopped due to completion of a stack dummy routine. */
300 extern enum stop_stack_kind stop_stack_dummy;
302 /* Nonzero if program stopped due to a random (unexpected) signal in
305 extern int stopped_by_random_signal;
307 /* STEP_OVER_ALL means step over all subroutine calls.
308 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
309 STEP_OVER_NONE means don't step over any subroutine calls. */
311 enum step_over_calls_kind
315 STEP_OVER_UNDEBUGGABLE
318 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
319 will handle it themselves. STOP_QUIETLY is used when running in
320 the shell before the child program has been exec'd and when running
321 through shared library loading. STOP_QUIETLY_REMOTE is used when
322 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
323 except that there is no need to hide a signal. */
325 /* It is also used after attach, due to attaching to a process. This
326 is a bit trickier. When doing an attach, the kernel stops the
327 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
328 the handling of SIGSTOP for a ptraced process has changed. Earlier
329 versions of the kernel would ignore these SIGSTOPs, while now
330 SIGSTOP is treated like any other signal, i.e. it is not muffled.
332 If the gdb user does a 'continue' after the 'attach', gdb passes
333 the global variable stop_signal (which stores the signal from the
334 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
335 problematic, because the kernel doesn't ignore such SIGSTOP
336 now. I.e. it is reported back to gdb, which in turn presents it
339 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
340 gdb to clear the value of stop_signal after the attach, so that it
341 is not passed back down to the kernel. */
348 STOP_QUIETLY_NO_SIGSTOP
351 /* Reverse execution. */
352 enum exec_direction_kind
359 extern enum exec_direction_kind execution_direction;
361 /* Save register contents here when executing a "finish" command or are
362 about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
363 Thus this contains the return value from the called function (assuming
364 values are returned in a register). */
366 extern struct regcache *stop_registers;
368 /* True if we are debugging displaced stepping. */
369 extern int debug_displaced;
371 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
372 void displaced_step_dump_bytes (struct ui_file *file,
373 const gdb_byte *buf, size_t len);
375 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
377 /* Possible values for gdbarch_call_dummy_location. */
379 #define AT_ENTRY_POINT 4
382 /* If STARTUP_WITH_SHELL is set, GDB's "run"
383 will attempts to start up the debugee under a shell.
384 This is in order for argument-expansion to occur. E.g.,
386 The "*" gets expanded by the shell into a list of files.
387 While this is a nice feature, it turns out to interact badly
388 with some of the catch-fork/catch-exec features we have added.
389 In particular, if the shell does any fork/exec's before
390 the exec of the target program, that can confuse GDB.
391 To disable this feature, set STARTUP_WITH_SHELL to 0.
392 To enable this feature, set STARTUP_WITH_SHELL to 1.
393 The catch-exec traps expected during start-up will
394 be 1 if target is not started up with a shell, 2 if it is.
396 If you disable this, you need to decrement
397 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
398 #define STARTUP_WITH_SHELL 1
399 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
400 #define START_INFERIOR_TRAPS_EXPECTED 2
403 struct private_inferior;
405 /* Inferior process specific part of `struct infcall_control_state'.
407 Inferior thread counterpart is `struct thread_control_state'. */
409 struct inferior_control_state
411 /* See the definition of stop_kind above. */
412 enum stop_kind stop_soon;
415 /* Inferior process specific part of `struct infcall_suspend_state'.
417 Inferior thread counterpart is `struct thread_suspend_state'. */
419 struct inferior_suspend_state
423 /* GDB represents the state of each program execution with an object
424 called an inferior. An inferior typically corresponds to a process
425 but is more general and applies also to targets that do not have a
426 notion of processes. Each run of an executable creates a new
427 inferior, as does each attachment to an existing process.
428 Inferiors have unique internal identifiers that are different from
429 target process ids. Each inferior may in turn have multiple
430 threads running in it. */
434 /* Pointer to next inferior in singly-linked list of inferiors. */
435 struct inferior *next;
437 /* Convenient handle (GDB inferior id). Unique across all
441 /* Actual target inferior id, usually, a process id. This matches
442 the ptid_t.pid member of threads of this inferior. */
445 /* State of GDB control of inferior process execution.
446 See `struct inferior_control_state'. */
447 struct inferior_control_state control;
449 /* State of inferior process to restore after GDB is done with an inferior
450 call. See `struct inferior_suspend_state'. */
451 struct inferior_suspend_state suspend;
453 /* True if this was an auto-created inferior, e.g. created from
454 following a fork; false, if this inferior was manually added by
455 the user, and we should not attempt to prune it
459 /* The address space bound to this inferior. */
460 struct address_space *aspace;
462 /* The program space bound to this inferior. */
463 struct program_space *pspace;
465 /* The arguments string to use when running. */
468 /* The size of elements in argv. */
471 /* The vector version of arguments. If ARGC is nonzero,
472 then we must compute ARGS from this (via the target).
473 This is always coming from main's argv and therefore
474 should never be freed. */
477 /* The name of terminal device to use for I/O. */
480 /* Environment to use for running inferior,
481 in format described in environ.h. */
482 struct gdb_environ *environment;
484 /* Nonzero if this child process was attached rather than
488 /* If this inferior is a vfork child, then this is the pointer to
489 its vfork parent, if GDB is still attached to it. */
490 struct inferior *vfork_parent;
492 /* If this process is a vfork parent, this is the pointer to the
493 child. Since a vfork parent is left frozen by the kernel until
494 the child execs or exits, a process can only have one vfork child
496 struct inferior *vfork_child;
498 /* True if this inferior should be detached when it's vfork sibling
502 /* True if this inferior is a vfork parent waiting for a vfork child
503 not under our control to be done with the shared memory region,
504 either by exiting or execing. */
505 int waiting_for_vfork_done;
507 /* True if we're in the process of detaching from this inferior. */
510 /* What is left to do for an execution command after any thread of
511 this inferior stops. For continuations associated with a
512 specific thread, see `struct thread_info'. */
513 struct continuation *continuations;
515 /* Private data used by the target vector implementation. */
516 struct private_inferior *private;
518 /* We keep a count of the number of times the user has requested a
519 particular syscall to be tracked, and pass this information to the
520 target. This lets capable targets implement filtering directly. */
522 /* Number of times that "any" syscall is requested. */
523 int any_syscall_count;
525 /* Count of each system call. */
526 VEC(int) *syscalls_counts;
528 /* This counts all syscall catch requests, so we can readily determine
529 if any catching is necessary. */
530 int total_syscalls_count;
532 /* Per inferior data-pointers required by other GDB modules. */
537 /* Keep a registry of per-inferior data-pointers required by other GDB
540 extern const struct inferior_data *register_inferior_data (void);
541 extern const struct inferior_data *register_inferior_data_with_cleanup
542 (void (*cleanup) (struct inferior *, void *));
543 extern void clear_inferior_data (struct inferior *inf);
544 extern void set_inferior_data (struct inferior *inf,
545 const struct inferior_data *data, void *value);
546 extern void *inferior_data (struct inferior *inf,
547 const struct inferior_data *data);
549 /* Create an empty inferior list, or empty the existing one. */
550 extern void init_inferior_list (void);
552 /* Add an inferior to the inferior list, print a message that a new
553 inferior is found, and return the pointer to the new inferior.
554 Caller may use this pointer to initialize the private inferior
556 extern struct inferior *add_inferior (int pid);
558 /* Same as add_inferior, but don't print new inferior notifications to
560 extern struct inferior *add_inferior_silent (int pid);
562 /* Delete an existing inferior list entry, due to inferior exit. */
563 extern void delete_inferior (int pid);
565 extern void delete_inferior_1 (struct inferior *todel, int silent);
567 /* Same as delete_inferior, but don't print new inferior notifications
569 extern void delete_inferior_silent (int pid);
571 /* Delete an existing inferior list entry, due to inferior detaching. */
572 extern void detach_inferior (int pid);
574 extern void exit_inferior (int pid);
576 extern void exit_inferior_silent (int pid);
578 extern void exit_inferior_num_silent (int num);
580 extern void inferior_appeared (struct inferior *inf, int pid);
582 /* Get rid of all inferiors. */
583 extern void discard_all_inferiors (void);
585 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
586 into a "pid" (which may be overloaded with extra inferior information). */
587 extern int gdb_inferior_id_to_pid (int);
589 /* Translate a target 'pid' into the integer inferior id (GDB's
590 homegrown id, not the system's). */
591 extern int pid_to_gdb_inferior_id (int pid);
593 /* Boolean test for an already-known pid. */
594 extern int in_inferior_list (int pid);
596 /* Boolean test for an already-known inferior id (GDB's homegrown id,
597 not the system's). */
598 extern int valid_gdb_inferior_id (int num);
600 /* Search function to lookup an inferior by target 'pid'. */
601 extern struct inferior *find_inferior_pid (int pid);
603 /* Search function to lookup an inferior by GDB 'num'. */
604 extern struct inferior *find_inferior_id (int num);
606 /* Find an inferior bound to PSPACE. */
607 extern struct inferior *
608 find_inferior_for_program_space (struct program_space *pspace);
610 /* Inferior iterator function.
612 Calls a callback function once for each inferior, so long as the
613 callback function returns false. If the callback function returns
614 true, the iteration will end and the current inferior will be
615 returned. This can be useful for implementing a search for a
616 inferior with arbitrary attributes, or for applying some operation
619 It is safe to delete the iterated inferior from the callback. */
620 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
624 /* Returns true if the inferior list is not empty. */
625 extern int have_inferiors (void);
627 /* Returns true if there are any live inferiors in the inferior list
628 (not cores, not executables, real live processes). */
629 extern int have_live_inferiors (void);
631 /* Return a pointer to the current inferior. It is an error to call
632 this if there is no current inferior. */
633 extern struct inferior *current_inferior (void);
635 extern void set_current_inferior (struct inferior *);
637 extern struct cleanup *save_current_inferior (void);
639 extern struct inferior *inferior_list;
641 /* Prune away automatically added inferiors that aren't required
643 extern void prune_inferiors (void);
645 extern int number_of_inferiors (void);
647 extern struct inferior *add_inferior_with_spaces (void);
649 extern void update_observer_mode (void);
651 #endif /* !defined (INFERIOR_H) */