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-1996, 1998-2001, 2003-2012 Free Software
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #if !defined (INFERIOR_H)
25 struct target_waitstatus;
37 #include "breakpoint.h"
39 /* For enum gdb_signal. */
42 /* For struct frame_id. */
45 #include "progspace.h"
47 struct infcall_suspend_state;
48 struct infcall_control_state;
50 extern struct infcall_suspend_state *save_infcall_suspend_state (void);
51 extern struct infcall_control_state *save_infcall_control_state (void);
53 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
54 extern void restore_infcall_control_state (struct infcall_control_state *);
56 extern struct cleanup *make_cleanup_restore_infcall_suspend_state
57 (struct infcall_suspend_state *);
58 extern struct cleanup *make_cleanup_restore_infcall_control_state
59 (struct infcall_control_state *);
61 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
62 extern void discard_infcall_control_state (struct infcall_control_state *);
64 extern struct regcache *
65 get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
67 /* Returns true if PTID matches filter FILTER. FILTER can be the wild
68 card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
69 a process (ptid_is_pid returns true), in which case, all lwps and
70 threads of that given process match, lwps and threads of other
71 processes do not; or, it can represent a specific thread, in which
72 case, only that thread will match true. PTID must represent a
73 specific LWP or THREAD, it can never be a wild card. */
75 extern int ptid_match (ptid_t ptid, ptid_t filter);
77 /* Save value of inferior_ptid so that it may be restored by
78 a later call to do_cleanups(). Returns the struct cleanup
79 pointer needed for later doing the cleanup. */
80 extern struct cleanup * save_inferior_ptid (void);
82 extern void set_sigint_trap (void);
84 extern void clear_sigint_trap (void);
86 /* Set/get file name for default use for standard in/out in the inferior. */
88 extern void set_inferior_io_terminal (const char *terminal_name);
89 extern const char *get_inferior_io_terminal (void);
91 /* Collected pid, tid, etc. of the debugged inferior. When there's
92 no inferior, PIDGET (inferior_ptid) will be 0. */
94 extern ptid_t inferior_ptid;
96 /* Are we simulating synchronous execution? This is used in async gdb
97 to implement the 'run', 'continue' etc commands, which will not
98 redisplay the prompt until the execution is actually over. */
99 extern int sync_execution;
101 /* Inferior environment. */
103 extern void clear_proceed_status (void);
105 extern void proceed (CORE_ADDR, enum gdb_signal, int);
107 extern int sched_multi;
109 /* When set, stop the 'step' command if we enter a function which has
110 no line number information. The normal behavior is that we step
111 over such function. */
112 extern int step_stop_if_no_debug;
114 /* If set, the inferior should be controlled in non-stop mode. In
115 this mode, each thread is controlled independently. Execution
116 commands apply only to the selected thread by default, and stop
117 events stop only the thread that had the event -- the other threads
118 are kept running freely. */
121 /* If set (default), when following a fork, GDB will detach from one
122 the fork branches, child or parent. Exactly which branch is
123 detached depends on 'set follow-fork-mode' setting. */
124 extern int detach_fork;
126 /* When set (default), the target should attempt to disable the operating
127 system's address space randomization feature when starting an inferior. */
128 extern int disable_randomization;
130 extern void generic_mourn_inferior (void);
132 extern void terminal_save_ours (void);
134 extern void terminal_ours (void);
136 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
138 const gdb_byte *buf);
139 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
140 struct type *type, gdb_byte *buf,
142 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
144 const gdb_byte *buf);
145 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
146 struct type *type, gdb_byte *buf,
149 extern void wait_for_inferior (void);
151 extern void prepare_for_detach (void);
153 extern void fetch_inferior_event (void *);
155 extern void init_wait_for_inferior (void);
157 extern void reopen_exec_file (void);
159 /* The `resume' routine should only be called in special circumstances.
160 Normally, use `proceed', which handles a lot of bookkeeping. */
162 extern void resume (int, enum gdb_signal);
164 extern ptid_t user_visible_resume_ptid (int step);
166 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
167 struct symtab_and_line ,
170 /* From misc files */
172 extern void default_print_registers_info (struct gdbarch *gdbarch,
173 struct ui_file *file,
174 struct frame_info *frame,
175 int regnum, int all);
177 extern void child_terminal_info (char *, int);
179 extern void term_info (char *, int);
181 extern void terminal_ours_for_output (void);
183 extern void terminal_inferior (void);
185 extern void terminal_init_inferior (void);
187 extern void terminal_init_inferior_with_pgrp (int pgrp);
189 /* From fork-child.c */
191 extern int fork_inferior (char *, char *, char **,
193 void (*)(int), void (*)(void), char *,
194 void (*)(const char *,
195 char * const *, char * const *));
198 extern void startup_inferior (int);
200 extern char *construct_inferior_arguments (int, char **);
204 extern int debug_infrun;
206 extern int stop_on_solib_events;
208 extern void start_remote (int from_tty);
210 extern void normal_stop (void);
212 extern int signal_stop_state (int);
214 extern int signal_print_state (int);
216 extern int signal_pass_state (int);
218 extern int signal_stop_update (int, int);
220 extern int signal_print_update (int, int);
222 extern int signal_pass_update (int, int);
224 extern void get_last_target_status(ptid_t *ptid,
225 struct target_waitstatus *status);
227 extern void follow_inferior_reset_breakpoints (void);
229 /* Throw an error indicating the current thread is running. */
230 extern void error_is_running (void);
232 /* Calls error_is_running if the current thread is running. */
233 extern void ensure_not_running (void);
235 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
239 extern void post_create_inferior (struct target_ops *, int);
241 extern void attach_command (char *, int);
243 extern char *get_inferior_args (void);
245 extern void set_inferior_args (char *);
247 extern void set_inferior_args_vector (int, char **);
249 extern void all_registers_info (char *, int);
251 extern void registers_info (char *, int);
253 extern void nexti_command (char *, int);
255 extern void stepi_command (char *, int);
257 extern void continue_1 (int all_threads);
259 extern void continue_command (char *, int);
261 extern void interrupt_target_command (char *args, int from_tty);
263 extern void interrupt_target_1 (int all_threads);
265 extern void delete_longjmp_breakpoint_cleanup (void *arg);
267 extern void detach_command (char *, int);
269 extern void notice_new_inferior (ptid_t, int, int);
271 extern struct value *get_return_value (struct value *function,
272 struct type *value_type);
274 /* Address at which inferior stopped. */
276 extern CORE_ADDR stop_pc;
278 /* Nonzero if stopped due to completion of a stack dummy routine. */
280 extern enum stop_stack_kind stop_stack_dummy;
282 /* Nonzero if program stopped due to a random (unexpected) signal in
285 extern int stopped_by_random_signal;
287 /* STEP_OVER_ALL means step over all subroutine calls.
288 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
289 STEP_OVER_NONE means don't step over any subroutine calls. */
291 enum step_over_calls_kind
295 STEP_OVER_UNDEBUGGABLE
298 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
299 will handle it themselves. STOP_QUIETLY is used when running in
300 the shell before the child program has been exec'd and when running
301 through shared library loading. STOP_QUIETLY_REMOTE is used when
302 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
303 except that there is no need to hide a signal. */
305 /* It is also used after attach, due to attaching to a process. This
306 is a bit trickier. When doing an attach, the kernel stops the
307 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
308 the handling of SIGSTOP for a ptraced process has changed. Earlier
309 versions of the kernel would ignore these SIGSTOPs, while now
310 SIGSTOP is treated like any other signal, i.e. it is not muffled.
312 If the gdb user does a 'continue' after the 'attach', gdb passes
313 the global variable stop_signal (which stores the signal from the
314 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
315 problematic, because the kernel doesn't ignore such SIGSTOP
316 now. I.e. it is reported back to gdb, which in turn presents it
319 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
320 gdb to clear the value of stop_signal after the attach, so that it
321 is not passed back down to the kernel. */
328 STOP_QUIETLY_NO_SIGSTOP
331 /* Reverse execution. */
332 enum exec_direction_kind
338 /* The current execution direction. This should only be set to enum
339 exec_direction_kind values. It is only an int to make it
340 compatible with make_cleanup_restore_integer. */
341 extern int execution_direction;
343 /* Save register contents here when executing a "finish" command or are
344 about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
345 Thus this contains the return value from the called function (assuming
346 values are returned in a register). */
348 extern struct regcache *stop_registers;
350 /* True if we are debugging displaced stepping. */
351 extern int debug_displaced;
353 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
354 void displaced_step_dump_bytes (struct ui_file *file,
355 const gdb_byte *buf, size_t len);
357 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
359 /* Possible values for gdbarch_call_dummy_location. */
361 #define AT_ENTRY_POINT 4
363 /* If STARTUP_WITH_SHELL is set, GDB's "run"
364 will attempts to start up the debugee under a shell.
365 This is in order for argument-expansion to occur. E.g.,
367 The "*" gets expanded by the shell into a list of files.
368 While this is a nice feature, it turns out to interact badly
369 with some of the catch-fork/catch-exec features we have added.
370 In particular, if the shell does any fork/exec's before
371 the exec of the target program, that can confuse GDB.
372 To disable this feature, set STARTUP_WITH_SHELL to 0.
373 To enable this feature, set STARTUP_WITH_SHELL to 1.
374 The catch-exec traps expected during start-up will
375 be 1 if target is not started up with a shell, 2 if it is.
377 If you disable this, you need to decrement
378 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
379 #define STARTUP_WITH_SHELL 1
380 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
381 #define START_INFERIOR_TRAPS_EXPECTED 2
384 struct private_inferior;
386 /* Inferior process specific part of `struct infcall_control_state'.
388 Inferior thread counterpart is `struct thread_control_state'. */
390 struct inferior_control_state
392 /* See the definition of stop_kind above. */
393 enum stop_kind stop_soon;
396 /* Inferior process specific part of `struct infcall_suspend_state'.
398 Inferior thread counterpart is `struct thread_suspend_state'. */
400 struct inferior_suspend_state
404 /* GDB represents the state of each program execution with an object
405 called an inferior. An inferior typically corresponds to a process
406 but is more general and applies also to targets that do not have a
407 notion of processes. Each run of an executable creates a new
408 inferior, as does each attachment to an existing process.
409 Inferiors have unique internal identifiers that are different from
410 target process ids. Each inferior may in turn have multiple
411 threads running in it. */
415 /* Pointer to next inferior in singly-linked list of inferiors. */
416 struct inferior *next;
418 /* Convenient handle (GDB inferior id). Unique across all
422 /* Actual target inferior id, usually, a process id. This matches
423 the ptid_t.pid member of threads of this inferior. */
425 /* True if the PID was actually faked by GDB. */
428 /* State of GDB control of inferior process execution.
429 See `struct inferior_control_state'. */
430 struct inferior_control_state control;
432 /* State of inferior process to restore after GDB is done with an inferior
433 call. See `struct inferior_suspend_state'. */
434 struct inferior_suspend_state suspend;
436 /* True if this was an auto-created inferior, e.g. created from
437 following a fork; false, if this inferior was manually added by
438 the user, and we should not attempt to prune it
442 /* The address space bound to this inferior. */
443 struct address_space *aspace;
445 /* The program space bound to this inferior. */
446 struct program_space *pspace;
448 /* The arguments string to use when running. */
451 /* The size of elements in argv. */
454 /* The vector version of arguments. If ARGC is nonzero,
455 then we must compute ARGS from this (via the target).
456 This is always coming from main's argv and therefore
457 should never be freed. */
460 /* The name of terminal device to use for I/O. */
463 /* Environment to use for running inferior,
464 in format described in environ.h. */
465 struct gdb_environ *environment;
467 /* Nonzero if this child process was attached rather than
471 /* If this inferior is a vfork child, then this is the pointer to
472 its vfork parent, if GDB is still attached to it. */
473 struct inferior *vfork_parent;
475 /* If this process is a vfork parent, this is the pointer to the
476 child. Since a vfork parent is left frozen by the kernel until
477 the child execs or exits, a process can only have one vfork child
479 struct inferior *vfork_child;
481 /* True if this inferior should be detached when it's vfork sibling
485 /* True if this inferior is a vfork parent waiting for a vfork child
486 not under our control to be done with the shared memory region,
487 either by exiting or execing. */
488 int waiting_for_vfork_done;
490 /* True if we're in the process of detaching from this inferior. */
493 /* What is left to do for an execution command after any thread of
494 this inferior stops. For continuations associated with a
495 specific thread, see `struct thread_info'. */
496 struct continuation *continuations;
498 /* Private data used by the target vector implementation. */
499 struct private_inferior *private;
501 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
502 In this case, the EXIT_CODE field is also valid. */
506 /* Default flags to pass to the symbol reading functions. These are
507 used whenever a new objfile is created. The valid values come
508 from enum symfile_add_flags. */
511 /* Per inferior data-pointers required by other GDB modules. */
516 /* Keep a registry of per-inferior data-pointers required by other GDB
519 extern const struct inferior_data *register_inferior_data (void);
520 extern const struct inferior_data *register_inferior_data_with_cleanup
521 (void (*cleanup) (struct inferior *, void *));
522 extern void clear_inferior_data (struct inferior *inf);
523 extern void set_inferior_data (struct inferior *inf,
524 const struct inferior_data *data, void *value);
525 extern void *inferior_data (struct inferior *inf,
526 const struct inferior_data *data);
528 /* Create an empty inferior list, or empty the existing one. */
529 extern void init_inferior_list (void);
531 /* Add an inferior to the inferior list, print a message that a new
532 inferior is found, and return the pointer to the new inferior.
533 Caller may use this pointer to initialize the private inferior
535 extern struct inferior *add_inferior (int pid);
537 /* Same as add_inferior, but don't print new inferior notifications to
539 extern struct inferior *add_inferior_silent (int pid);
541 /* Delete an existing inferior list entry, due to inferior exit. */
542 extern void delete_inferior (int pid);
544 extern void delete_inferior_1 (struct inferior *todel, int silent);
546 /* Same as delete_inferior, but don't print new inferior notifications
548 extern void delete_inferior_silent (int pid);
550 /* Delete an existing inferior list entry, due to inferior detaching. */
551 extern void detach_inferior (int pid);
553 extern void exit_inferior (int pid);
555 extern void exit_inferior_silent (int pid);
557 extern void exit_inferior_num_silent (int num);
559 extern void inferior_appeared (struct inferior *inf, int pid);
561 /* Get rid of all inferiors. */
562 extern void discard_all_inferiors (void);
564 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
565 into a "pid" (which may be overloaded with extra inferior information). */
566 extern int gdb_inferior_id_to_pid (int);
568 /* Translate a target 'pid' into the integer inferior id (GDB's
569 homegrown id, not the system's). */
570 extern int pid_to_gdb_inferior_id (int pid);
572 /* Boolean test for an already-known pid. */
573 extern int in_inferior_list (int pid);
575 /* Boolean test for an already-known inferior id (GDB's homegrown id,
576 not the system's). */
577 extern int valid_gdb_inferior_id (int num);
579 /* Search function to lookup an inferior by target 'pid'. */
580 extern struct inferior *find_inferior_pid (int pid);
582 /* Search function to lookup an inferior by GDB 'num'. */
583 extern struct inferior *find_inferior_id (int num);
585 /* Find an inferior bound to PSPACE. */
586 extern struct inferior *
587 find_inferior_for_program_space (struct program_space *pspace);
589 /* Inferior iterator function.
591 Calls a callback function once for each inferior, so long as the
592 callback function returns false. If the callback function returns
593 true, the iteration will end and the current inferior will be
594 returned. This can be useful for implementing a search for a
595 inferior with arbitrary attributes, or for applying some operation
598 It is safe to delete the iterated inferior from the callback. */
599 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
603 /* Returns true if the inferior list is not empty. */
604 extern int have_inferiors (void);
606 /* Returns true if there are any live inferiors in the inferior list
607 (not cores, not executables, real live processes). */
608 extern int have_live_inferiors (void);
610 /* Return a pointer to the current inferior. It is an error to call
611 this if there is no current inferior. */
612 extern struct inferior *current_inferior (void);
614 extern void set_current_inferior (struct inferior *);
616 extern struct cleanup *save_current_inferior (void);
618 /* Traverse all inferiors. */
620 #define ALL_INFERIORS(I) \
621 for ((I) = inferior_list; (I); (I) = (I)->next)
623 extern struct inferior *inferior_list;
625 /* Prune away automatically added inferiors that aren't required
627 extern void prune_inferiors (void);
629 extern int number_of_inferiors (void);
631 extern struct inferior *add_inferior_with_spaces (void);
633 extern void update_observer_mode (void);
635 extern void update_signals_program_target (void);
637 /* In some circumstances we allow a command to specify a numeric
638 signal. The idea is to keep these circumstances limited so that
639 users (and scripts) develop portable habits. For comparison,
640 POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
641 numeric signal at all is obsolescent. We are slightly more lenient
642 and allow 1-15 which should match host signal numbers on most
643 systems. Use of symbolic signal names is strongly encouraged. */
645 enum gdb_signal gdb_signal_from_command (int num);
647 #endif /* !defined (INFERIOR_H) */