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 target_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 target_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 close_exec_file (void);
159 extern void reopen_exec_file (void);
161 /* The `resume' routine should only be called in special circumstances.
162 Normally, use `proceed', which handles a lot of bookkeeping. */
164 extern void resume (int, enum target_signal);
166 extern ptid_t user_visible_resume_ptid (int step);
168 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
169 struct symtab_and_line ,
172 /* From misc files */
174 extern void default_print_registers_info (struct gdbarch *gdbarch,
175 struct ui_file *file,
176 struct frame_info *frame,
177 int regnum, int all);
179 extern void child_terminal_info (char *, int);
181 extern void term_info (char *, int);
183 extern void terminal_ours_for_output (void);
185 extern void terminal_inferior (void);
187 extern void terminal_init_inferior (void);
189 extern void terminal_init_inferior_with_pgrp (int pgrp);
191 /* From fork-child.c */
193 extern int fork_inferior (char *, char *, char **,
195 void (*)(int), void (*)(void), char *,
196 void (*)(const char *,
197 char * const *, char * const *));
200 extern void startup_inferior (int);
202 extern char *construct_inferior_arguments (int, char **);
206 extern int debug_infrun;
208 extern int stop_on_solib_events;
210 extern void start_remote (int from_tty);
212 extern void normal_stop (void);
214 extern int signal_stop_state (int);
216 extern int signal_print_state (int);
218 extern int signal_pass_state (int);
220 extern int signal_stop_update (int, int);
222 extern int signal_print_update (int, int);
224 extern int signal_pass_update (int, int);
226 extern void get_last_target_status(ptid_t *ptid,
227 struct target_waitstatus *status);
229 extern void follow_inferior_reset_breakpoints (void);
231 /* Throw an error indicating the current thread is running. */
232 extern void error_is_running (void);
234 /* Calls error_is_running if the current thread is running. */
235 extern void ensure_not_running (void);
237 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
241 extern void post_create_inferior (struct target_ops *, int);
243 extern void attach_command (char *, int);
245 extern char *get_inferior_args (void);
247 extern void set_inferior_args (char *);
249 extern void set_inferior_args_vector (int, char **);
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 type *func_type,
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
364 /* If STARTUP_WITH_SHELL is set, GDB's "run"
365 will attempts to start up the debugee under a shell.
366 This is in order for argument-expansion to occur. E.g.,
368 The "*" gets expanded by the shell into a list of files.
369 While this is a nice feature, it turns out to interact badly
370 with some of the catch-fork/catch-exec features we have added.
371 In particular, if the shell does any fork/exec's before
372 the exec of the target program, that can confuse GDB.
373 To disable this feature, set STARTUP_WITH_SHELL to 0.
374 To enable this feature, set STARTUP_WITH_SHELL to 1.
375 The catch-exec traps expected during start-up will
376 be 1 if target is not started up with a shell, 2 if it is.
378 If you disable this, you need to decrement
379 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
380 #define STARTUP_WITH_SHELL 1
381 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
382 #define START_INFERIOR_TRAPS_EXPECTED 2
385 struct private_inferior;
387 /* Inferior process specific part of `struct infcall_control_state'.
389 Inferior thread counterpart is `struct thread_control_state'. */
391 struct inferior_control_state
393 /* See the definition of stop_kind above. */
394 enum stop_kind stop_soon;
397 /* Inferior process specific part of `struct infcall_suspend_state'.
399 Inferior thread counterpart is `struct thread_suspend_state'. */
401 struct inferior_suspend_state
405 /* GDB represents the state of each program execution with an object
406 called an inferior. An inferior typically corresponds to a process
407 but is more general and applies also to targets that do not have a
408 notion of processes. Each run of an executable creates a new
409 inferior, as does each attachment to an existing process.
410 Inferiors have unique internal identifiers that are different from
411 target process ids. Each inferior may in turn have multiple
412 threads running in it. */
416 /* Pointer to next inferior in singly-linked list of inferiors. */
417 struct inferior *next;
419 /* Convenient handle (GDB inferior id). Unique across all
423 /* Actual target inferior id, usually, a process id. This matches
424 the ptid_t.pid member of threads of this inferior. */
427 /* State of GDB control of inferior process execution.
428 See `struct inferior_control_state'. */
429 struct inferior_control_state control;
431 /* State of inferior process to restore after GDB is done with an inferior
432 call. See `struct inferior_suspend_state'. */
433 struct inferior_suspend_state suspend;
435 /* True if this was an auto-created inferior, e.g. created from
436 following a fork; false, if this inferior was manually added by
437 the user, and we should not attempt to prune it
441 /* The address space bound to this inferior. */
442 struct address_space *aspace;
444 /* The program space bound to this inferior. */
445 struct program_space *pspace;
447 /* The arguments string to use when running. */
450 /* The size of elements in argv. */
453 /* The vector version of arguments. If ARGC is nonzero,
454 then we must compute ARGS from this (via the target).
455 This is always coming from main's argv and therefore
456 should never be freed. */
459 /* The name of terminal device to use for I/O. */
462 /* Environment to use for running inferior,
463 in format described in environ.h. */
464 struct gdb_environ *environment;
466 /* Nonzero if this child process was attached rather than
470 /* If this inferior is a vfork child, then this is the pointer to
471 its vfork parent, if GDB is still attached to it. */
472 struct inferior *vfork_parent;
474 /* If this process is a vfork parent, this is the pointer to the
475 child. Since a vfork parent is left frozen by the kernel until
476 the child execs or exits, a process can only have one vfork child
478 struct inferior *vfork_child;
480 /* True if this inferior should be detached when it's vfork sibling
484 /* True if this inferior is a vfork parent waiting for a vfork child
485 not under our control to be done with the shared memory region,
486 either by exiting or execing. */
487 int waiting_for_vfork_done;
489 /* True if we're in the process of detaching from this inferior. */
492 /* What is left to do for an execution command after any thread of
493 this inferior stops. For continuations associated with a
494 specific thread, see `struct thread_info'. */
495 struct continuation *continuations;
497 /* Private data used by the target vector implementation. */
498 struct private_inferior *private;
500 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
501 In this case, the EXIT_CODE field is also valid. */
505 /* We keep a count of the number of times the user has requested a
506 particular syscall to be tracked, and pass this information to the
507 target. This lets capable targets implement filtering directly. */
509 /* Number of times that "any" syscall is requested. */
510 int any_syscall_count;
512 /* Count of each system call. */
513 VEC(int) *syscalls_counts;
515 /* This counts all syscall catch requests, so we can readily determine
516 if any catching is necessary. */
517 int total_syscalls_count;
519 /* Per inferior data-pointers required by other GDB modules. */
524 /* Keep a registry of per-inferior data-pointers required by other GDB
527 extern const struct inferior_data *register_inferior_data (void);
528 extern const struct inferior_data *register_inferior_data_with_cleanup
529 (void (*cleanup) (struct inferior *, void *));
530 extern void clear_inferior_data (struct inferior *inf);
531 extern void set_inferior_data (struct inferior *inf,
532 const struct inferior_data *data, void *value);
533 extern void *inferior_data (struct inferior *inf,
534 const struct inferior_data *data);
536 /* Create an empty inferior list, or empty the existing one. */
537 extern void init_inferior_list (void);
539 /* Add an inferior to the inferior list, print a message that a new
540 inferior is found, and return the pointer to the new inferior.
541 Caller may use this pointer to initialize the private inferior
543 extern struct inferior *add_inferior (int pid);
545 /* Same as add_inferior, but don't print new inferior notifications to
547 extern struct inferior *add_inferior_silent (int pid);
549 /* Delete an existing inferior list entry, due to inferior exit. */
550 extern void delete_inferior (int pid);
552 extern void delete_inferior_1 (struct inferior *todel, int silent);
554 /* Same as delete_inferior, but don't print new inferior notifications
556 extern void delete_inferior_silent (int pid);
558 /* Delete an existing inferior list entry, due to inferior detaching. */
559 extern void detach_inferior (int pid);
561 extern void exit_inferior (int pid);
563 extern void exit_inferior_silent (int pid);
565 extern void exit_inferior_num_silent (int num);
567 extern void inferior_appeared (struct inferior *inf, int pid);
569 /* Get rid of all inferiors. */
570 extern void discard_all_inferiors (void);
572 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
573 into a "pid" (which may be overloaded with extra inferior information). */
574 extern int gdb_inferior_id_to_pid (int);
576 /* Translate a target 'pid' into the integer inferior id (GDB's
577 homegrown id, not the system's). */
578 extern int pid_to_gdb_inferior_id (int pid);
580 /* Boolean test for an already-known pid. */
581 extern int in_inferior_list (int pid);
583 /* Boolean test for an already-known inferior id (GDB's homegrown id,
584 not the system's). */
585 extern int valid_gdb_inferior_id (int num);
587 /* Search function to lookup an inferior by target 'pid'. */
588 extern struct inferior *find_inferior_pid (int pid);
590 /* Search function to lookup an inferior by GDB 'num'. */
591 extern struct inferior *find_inferior_id (int num);
593 /* Find an inferior bound to PSPACE. */
594 extern struct inferior *
595 find_inferior_for_program_space (struct program_space *pspace);
597 /* Inferior iterator function.
599 Calls a callback function once for each inferior, so long as the
600 callback function returns false. If the callback function returns
601 true, the iteration will end and the current inferior will be
602 returned. This can be useful for implementing a search for a
603 inferior with arbitrary attributes, or for applying some operation
606 It is safe to delete the iterated inferior from the callback. */
607 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
611 /* Returns true if the inferior list is not empty. */
612 extern int have_inferiors (void);
614 /* Returns true if there are any live inferiors in the inferior list
615 (not cores, not executables, real live processes). */
616 extern int have_live_inferiors (void);
618 /* Return a pointer to the current inferior. It is an error to call
619 this if there is no current inferior. */
620 extern struct inferior *current_inferior (void);
622 extern void set_current_inferior (struct inferior *);
624 extern struct cleanup *save_current_inferior (void);
626 /* Traverse all inferiors. */
628 #define ALL_INFERIORS(I) \
629 for ((I) = inferior_list; (I); (I) = (I)->next)
631 extern struct inferior *inferior_list;
633 /* Prune away automatically added inferiors that aren't required
635 extern void prune_inferiors (void);
637 extern int number_of_inferiors (void);
639 extern struct inferior *add_inferior_with_spaces (void);
641 extern void update_observer_mode (void);
643 #endif /* !defined (INFERIOR_H) */