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
;
38 #include "breakpoint.h"
40 /* For enum target_signal. */
43 /* For struct frame_id. */
46 #include "progspace.h"
48 struct infcall_suspend_state
;
49 struct infcall_control_state
;
51 extern struct infcall_suspend_state
*save_infcall_suspend_state (void);
52 extern struct infcall_control_state
*save_infcall_control_state (void);
54 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
55 extern void restore_infcall_control_state (struct infcall_control_state
*);
57 extern struct cleanup
*make_cleanup_restore_infcall_suspend_state
58 (struct infcall_suspend_state
*);
59 extern struct cleanup
*make_cleanup_restore_infcall_control_state
60 (struct infcall_control_state
*);
62 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
63 extern void discard_infcall_control_state (struct infcall_control_state
*);
65 extern struct regcache
*
66 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
68 /* Returns true if PTID matches filter FILTER. FILTER can be the wild
69 card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
70 a process (ptid_is_pid returns true), in which case, all lwps and
71 threads of that given process match, lwps and threads of other
72 processes do not; or, it can represent a specific thread, in which
73 case, only that thread will match true. PTID must represent a
74 specific LWP or THREAD, it can never be a wild card. */
76 extern int ptid_match (ptid_t ptid
, ptid_t filter
);
78 /* Save value of inferior_ptid so that it may be restored by
79 a later call to do_cleanups(). Returns the struct cleanup
80 pointer needed for later doing the cleanup. */
81 extern struct cleanup
* save_inferior_ptid (void);
83 extern void set_sigint_trap (void);
85 extern void clear_sigint_trap (void);
87 /* Set/get file name for default use for standard in/out in the inferior. */
89 extern void set_inferior_io_terminal (const char *terminal_name
);
90 extern const char *get_inferior_io_terminal (void);
92 /* Collected pid, tid, etc. of the debugged inferior. When there's
93 no inferior, PIDGET (inferior_ptid) will be 0. */
95 extern ptid_t inferior_ptid
;
97 /* Are we simulating synchronous execution? This is used in async gdb
98 to implement the 'run', 'continue' etc commands, which will not
99 redisplay the prompt until the execution is actually over. */
100 extern int sync_execution
;
102 /* Inferior environment. */
104 extern void clear_proceed_status (void);
106 extern void proceed (CORE_ADDR
, enum target_signal
, int);
108 extern int sched_multi
;
110 /* When set, stop the 'step' command if we enter a function which has
111 no line number information. The normal behavior is that we step
112 over such function. */
113 extern int step_stop_if_no_debug
;
115 /* If set, the inferior should be controlled in non-stop mode. In
116 this mode, each thread is controlled independently. Execution
117 commands apply only to the selected thread by default, and stop
118 events stop only the thread that had the event -- the other threads
119 are kept running freely. */
122 /* If set (default), when following a fork, GDB will detach from one
123 the fork branches, child or parent. Exactly which branch is
124 detached depends on 'set follow-fork-mode' setting. */
125 extern int detach_fork
;
127 /* When set (default), the target should attempt to disable the operating
128 system's address space randomization feature when starting an inferior. */
129 extern int disable_randomization
;
131 extern void generic_mourn_inferior (void);
133 extern void terminal_save_ours (void);
135 extern void terminal_ours (void);
137 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
139 const gdb_byte
*buf
);
140 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
141 struct type
*type
, gdb_byte
*buf
,
143 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
145 const gdb_byte
*buf
);
146 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
147 struct type
*type
, gdb_byte
*buf
,
150 extern void wait_for_inferior (void);
152 extern void prepare_for_detach (void);
154 extern void fetch_inferior_event (void *);
156 extern void init_wait_for_inferior (void);
158 extern void close_exec_file (void);
160 extern void reopen_exec_file (void);
162 /* The `resume' routine should only be called in special circumstances.
163 Normally, use `proceed', which handles a lot of bookkeeping. */
165 extern void resume (int, enum target_signal
);
167 extern ptid_t
user_visible_resume_ptid (int step
);
169 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch
*,
170 struct symtab_and_line
,
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
);
192 /* From fork-child.c */
194 extern int fork_inferior (char *, char *, char **,
196 void (*)(int), void (*)(void), char *,
197 void (*)(const char *,
198 char * const *, char * const *));
201 extern void startup_inferior (int);
203 extern char *construct_inferior_arguments (int, char **);
207 extern int debug_infrun
;
209 extern int stop_on_solib_events
;
211 extern void start_remote (int from_tty
);
213 extern void normal_stop (void);
215 extern int signal_stop_state (int);
217 extern int signal_print_state (int);
219 extern int signal_pass_state (int);
221 extern int signal_stop_update (int, int);
223 extern int signal_print_update (int, int);
225 extern int signal_pass_update (int, int);
227 extern void get_last_target_status(ptid_t
*ptid
,
228 struct target_waitstatus
*status
);
230 extern void follow_inferior_reset_breakpoints (void);
232 /* Throw an error indicating the current thread is running. */
233 extern void error_is_running (void);
235 /* Calls error_is_running if the current thread is running. */
236 extern void ensure_not_running (void);
238 void set_step_info (struct frame_info
*frame
, struct symtab_and_line sal
);
242 extern void post_create_inferior (struct target_ops
*, int);
244 extern void attach_command (char *, int);
246 extern char *get_inferior_args (void);
248 extern void set_inferior_args (char *);
250 extern void set_inferior_args_vector (int, char **);
252 extern void registers_info (char *, int);
254 extern void nexti_command (char *, int);
256 extern void stepi_command (char *, int);
258 extern void continue_1 (int all_threads
);
260 extern void continue_command (char *, int);
262 extern void interrupt_target_command (char *args
, int from_tty
);
264 extern void interrupt_target_1 (int all_threads
);
266 extern void delete_longjmp_breakpoint_cleanup (void *arg
);
268 extern void detach_command (char *, int);
270 extern void notice_new_inferior (ptid_t
, int, int);
272 /* Address at which inferior stopped. */
274 extern CORE_ADDR stop_pc
;
276 /* Nonzero if stopped due to completion of a stack dummy routine. */
278 extern enum stop_stack_kind stop_stack_dummy
;
280 /* Nonzero if program stopped due to a random (unexpected) signal in
283 extern int stopped_by_random_signal
;
285 /* STEP_OVER_ALL means step over all subroutine calls.
286 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
287 STEP_OVER_NONE means don't step over any subroutine calls. */
289 enum step_over_calls_kind
293 STEP_OVER_UNDEBUGGABLE
296 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
297 will handle it themselves. STOP_QUIETLY is used when running in
298 the shell before the child program has been exec'd and when running
299 through shared library loading. STOP_QUIETLY_REMOTE is used when
300 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
301 except that there is no need to hide a signal. */
303 /* It is also used after attach, due to attaching to a process. This
304 is a bit trickier. When doing an attach, the kernel stops the
305 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
306 the handling of SIGSTOP for a ptraced process has changed. Earlier
307 versions of the kernel would ignore these SIGSTOPs, while now
308 SIGSTOP is treated like any other signal, i.e. it is not muffled.
310 If the gdb user does a 'continue' after the 'attach', gdb passes
311 the global variable stop_signal (which stores the signal from the
312 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
313 problematic, because the kernel doesn't ignore such SIGSTOP
314 now. I.e. it is reported back to gdb, which in turn presents it
317 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
318 gdb to clear the value of stop_signal after the attach, so that it
319 is not passed back down to the kernel. */
326 STOP_QUIETLY_NO_SIGSTOP
329 /* Reverse execution. */
330 enum exec_direction_kind
336 /* The current execution direction. This should only be set to enum
337 exec_direction_kind values. It is only an int to make it
338 compatible with make_cleanup_restore_integer. */
339 extern int 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
);
355 struct displaced_step_closure
*get_displaced_step_closure_by_addr (CORE_ADDR addr
);
357 /* Possible values for gdbarch_call_dummy_location. */
359 #define AT_ENTRY_POINT 4
362 /* If STARTUP_WITH_SHELL is set, GDB's "run"
363 will attempts to start up the debugee under a shell.
364 This is in order for argument-expansion to occur. E.g.,
366 The "*" gets expanded by the shell into a list of files.
367 While this is a nice feature, it turns out to interact badly
368 with some of the catch-fork/catch-exec features we have added.
369 In particular, if the shell does any fork/exec's before
370 the exec of the target program, that can confuse GDB.
371 To disable this feature, set STARTUP_WITH_SHELL to 0.
372 To enable this feature, set STARTUP_WITH_SHELL to 1.
373 The catch-exec traps expected during start-up will
374 be 1 if target is not started up with a shell, 2 if it is.
376 If you disable this, you need to decrement
377 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
378 #define STARTUP_WITH_SHELL 1
379 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
380 #define START_INFERIOR_TRAPS_EXPECTED 2
383 struct private_inferior
;
385 /* Inferior process specific part of `struct infcall_control_state'.
387 Inferior thread counterpart is `struct thread_control_state'. */
389 struct inferior_control_state
391 /* See the definition of stop_kind above. */
392 enum stop_kind stop_soon
;
395 /* Inferior process specific part of `struct infcall_suspend_state'.
397 Inferior thread counterpart is `struct thread_suspend_state'. */
399 struct inferior_suspend_state
403 /* GDB represents the state of each program execution with an object
404 called an inferior. An inferior typically corresponds to a process
405 but is more general and applies also to targets that do not have a
406 notion of processes. Each run of an executable creates a new
407 inferior, as does each attachment to an existing process.
408 Inferiors have unique internal identifiers that are different from
409 target process ids. Each inferior may in turn have multiple
410 threads running in it. */
414 /* Pointer to next inferior in singly-linked list of inferiors. */
415 struct inferior
*next
;
417 /* Convenient handle (GDB inferior id). Unique across all
421 /* Actual target inferior id, usually, a process id. This matches
422 the ptid_t.pid member of threads of this inferior. */
425 /* State of GDB control of inferior process execution.
426 See `struct inferior_control_state'. */
427 struct inferior_control_state control
;
429 /* State of inferior process to restore after GDB is done with an inferior
430 call. See `struct inferior_suspend_state'. */
431 struct inferior_suspend_state suspend
;
433 /* True if this was an auto-created inferior, e.g. created from
434 following a fork; false, if this inferior was manually added by
435 the user, and we should not attempt to prune it
439 /* The address space bound to this inferior. */
440 struct address_space
*aspace
;
442 /* The program space bound to this inferior. */
443 struct program_space
*pspace
;
445 /* The arguments string to use when running. */
448 /* The size of elements in argv. */
451 /* The vector version of arguments. If ARGC is nonzero,
452 then we must compute ARGS from this (via the target).
453 This is always coming from main's argv and therefore
454 should never be freed. */
457 /* The name of terminal device to use for I/O. */
460 /* Environment to use for running inferior,
461 in format described in environ.h. */
462 struct gdb_environ
*environment
;
464 /* Nonzero if this child process was attached rather than
468 /* If this inferior is a vfork child, then this is the pointer to
469 its vfork parent, if GDB is still attached to it. */
470 struct inferior
*vfork_parent
;
472 /* If this process is a vfork parent, this is the pointer to the
473 child. Since a vfork parent is left frozen by the kernel until
474 the child execs or exits, a process can only have one vfork child
476 struct inferior
*vfork_child
;
478 /* True if this inferior should be detached when it's vfork sibling
482 /* True if this inferior is a vfork parent waiting for a vfork child
483 not under our control to be done with the shared memory region,
484 either by exiting or execing. */
485 int waiting_for_vfork_done
;
487 /* True if we're in the process of detaching from this inferior. */
490 /* What is left to do for an execution command after any thread of
491 this inferior stops. For continuations associated with a
492 specific thread, see `struct thread_info'. */
493 struct continuation
*continuations
;
495 /* Private data used by the target vector implementation. */
496 struct private_inferior
*private;
498 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
499 In this case, the EXIT_CODE field is also valid. */
503 /* We keep a count of the number of times the user has requested a
504 particular syscall to be tracked, and pass this information to the
505 target. This lets capable targets implement filtering directly. */
507 /* Number of times that "any" syscall is requested. */
508 int any_syscall_count
;
510 /* Count of each system call. */
511 VEC(int) *syscalls_counts
;
513 /* This counts all syscall catch requests, so we can readily determine
514 if any catching is necessary. */
515 int total_syscalls_count
;
517 /* Per inferior data-pointers required by other GDB modules. */
522 /* Keep a registry of per-inferior data-pointers required by other GDB
525 extern const struct inferior_data
*register_inferior_data (void);
526 extern const struct inferior_data
*register_inferior_data_with_cleanup
527 (void (*cleanup
) (struct inferior
*, void *));
528 extern void clear_inferior_data (struct inferior
*inf
);
529 extern void set_inferior_data (struct inferior
*inf
,
530 const struct inferior_data
*data
, void *value
);
531 extern void *inferior_data (struct inferior
*inf
,
532 const struct inferior_data
*data
);
534 /* Create an empty inferior list, or empty the existing one. */
535 extern void init_inferior_list (void);
537 /* Add an inferior to the inferior list, print a message that a new
538 inferior is found, and return the pointer to the new inferior.
539 Caller may use this pointer to initialize the private inferior
541 extern struct inferior
*add_inferior (int pid
);
543 /* Same as add_inferior, but don't print new inferior notifications to
545 extern struct inferior
*add_inferior_silent (int pid
);
547 /* Delete an existing inferior list entry, due to inferior exit. */
548 extern void delete_inferior (int pid
);
550 extern void delete_inferior_1 (struct inferior
*todel
, int silent
);
552 /* Same as delete_inferior, but don't print new inferior notifications
554 extern void delete_inferior_silent (int pid
);
556 /* Delete an existing inferior list entry, due to inferior detaching. */
557 extern void detach_inferior (int pid
);
559 extern void exit_inferior (int pid
);
561 extern void exit_inferior_silent (int pid
);
563 extern void exit_inferior_num_silent (int num
);
565 extern void inferior_appeared (struct inferior
*inf
, int pid
);
567 /* Get rid of all inferiors. */
568 extern void discard_all_inferiors (void);
570 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
571 into a "pid" (which may be overloaded with extra inferior information). */
572 extern int gdb_inferior_id_to_pid (int);
574 /* Translate a target 'pid' into the integer inferior id (GDB's
575 homegrown id, not the system's). */
576 extern int pid_to_gdb_inferior_id (int pid
);
578 /* Boolean test for an already-known pid. */
579 extern int in_inferior_list (int pid
);
581 /* Boolean test for an already-known inferior id (GDB's homegrown id,
582 not the system's). */
583 extern int valid_gdb_inferior_id (int num
);
585 /* Search function to lookup an inferior by target 'pid'. */
586 extern struct inferior
*find_inferior_pid (int pid
);
588 /* Search function to lookup an inferior by GDB 'num'. */
589 extern struct inferior
*find_inferior_id (int num
);
591 /* Find an inferior bound to PSPACE. */
592 extern struct inferior
*
593 find_inferior_for_program_space (struct program_space
*pspace
);
595 /* Inferior iterator function.
597 Calls a callback function once for each inferior, so long as the
598 callback function returns false. If the callback function returns
599 true, the iteration will end and the current inferior will be
600 returned. This can be useful for implementing a search for a
601 inferior with arbitrary attributes, or for applying some operation
604 It is safe to delete the iterated inferior from the callback. */
605 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
609 /* Returns true if the inferior list is not empty. */
610 extern int have_inferiors (void);
612 /* Returns true if there are any live inferiors in the inferior list
613 (not cores, not executables, real live processes). */
614 extern int have_live_inferiors (void);
616 /* Return a pointer to the current inferior. It is an error to call
617 this if there is no current inferior. */
618 extern struct inferior
*current_inferior (void);
620 extern void set_current_inferior (struct inferior
*);
622 extern struct cleanup
*save_current_inferior (void);
624 /* Traverse all inferiors. */
626 #define ALL_INFERIORS(I) \
627 for ((I) = inferior_list; (I); (I) = (I)->next)
629 extern struct inferior
*inferior_list
;
631 /* Prune away automatically added inferiors that aren't required
633 extern void prune_inferiors (void);
635 extern int number_of_inferiors (void);
637 extern struct inferior
*add_inferior_with_spaces (void);
639 extern void update_observer_mode (void);
641 #endif /* !defined (INFERIOR_H) */