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;
33 struct target_desc_info;
38 #include "breakpoint.h"
40 /* For enum gdb_signal. */
43 /* For struct frame_id. */
46 #include "progspace.h"
49 struct infcall_suspend_state;
50 struct infcall_control_state;
52 extern struct infcall_suspend_state *save_infcall_suspend_state (void);
53 extern struct infcall_control_state *save_infcall_control_state (void);
55 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
56 extern void restore_infcall_control_state (struct infcall_control_state *);
58 extern struct cleanup *make_cleanup_restore_infcall_suspend_state
59 (struct infcall_suspend_state *);
60 extern struct cleanup *make_cleanup_restore_infcall_control_state
61 (struct infcall_control_state *);
63 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
64 extern void discard_infcall_control_state (struct infcall_control_state *);
66 extern struct regcache *
67 get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
69 /* Returns true if PTID matches filter FILTER. FILTER can be the wild
70 card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
71 a process (ptid_is_pid returns true), in which case, all lwps and
72 threads of that given process match, lwps and threads of other
73 processes do not; or, it can represent a specific thread, in which
74 case, only that thread will match true. PTID must represent a
75 specific LWP or THREAD, it can never be a wild card. */
77 extern int ptid_match (ptid_t ptid, ptid_t filter);
79 /* Save value of inferior_ptid so that it may be restored by
80 a later call to do_cleanups(). Returns the struct cleanup
81 pointer needed for later doing the cleanup. */
82 extern struct cleanup * save_inferior_ptid (void);
84 extern void set_sigint_trap (void);
86 extern void clear_sigint_trap (void);
88 /* Set/get file name for default use for standard in/out in the inferior. */
90 extern void set_inferior_io_terminal (const char *terminal_name);
91 extern const char *get_inferior_io_terminal (void);
93 /* Collected pid, tid, etc. of the debugged inferior. When there's
94 no inferior, PIDGET (inferior_ptid) will be 0. */
96 extern ptid_t inferior_ptid;
98 /* Are we simulating synchronous execution? This is used in async gdb
99 to implement the 'run', 'continue' etc commands, which will not
100 redisplay the prompt until the execution is actually over. */
101 extern int sync_execution;
103 /* Inferior environment. */
105 extern void clear_proceed_status (void);
107 extern void proceed (CORE_ADDR, enum gdb_signal, int);
109 extern int sched_multi;
111 /* When set, stop the 'step' command if we enter a function which has
112 no line number information. The normal behavior is that we step
113 over such function. */
114 extern int step_stop_if_no_debug;
116 /* If set, the inferior should be controlled in non-stop mode. In
117 this mode, each thread is controlled independently. Execution
118 commands apply only to the selected thread by default, and stop
119 events stop only the thread that had the event -- the other threads
120 are kept running freely. */
123 /* If set (default), when following a fork, GDB will detach from one
124 the fork branches, child or parent. Exactly which branch is
125 detached depends on 'set follow-fork-mode' setting. */
126 extern int detach_fork;
128 /* When set (default), the target should attempt to disable the operating
129 system's address space randomization feature when starting an inferior. */
130 extern int disable_randomization;
132 extern void generic_mourn_inferior (void);
134 extern void terminal_save_ours (void);
136 extern void terminal_ours (void);
138 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
140 const gdb_byte *buf);
141 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
142 struct type *type, gdb_byte *buf,
144 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
146 const gdb_byte *buf);
147 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
148 struct type *type, gdb_byte *buf,
151 extern void wait_for_inferior (void);
153 extern void prepare_for_detach (void);
155 extern void fetch_inferior_event (void *);
157 extern void init_wait_for_inferior (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 gdb_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 unsigned 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 all_registers_info (char *, int);
253 extern void registers_info (char *, int);
255 extern void nexti_command (char *, int);
257 extern void stepi_command (char *, int);
259 extern void continue_1 (int all_threads);
261 extern void continue_command (char *, int);
263 extern void interrupt_target_command (char *args, int from_tty);
265 extern void interrupt_target_1 (int all_threads);
267 extern void delete_longjmp_breakpoint_cleanup (void *arg);
269 extern void detach_command (char *, int);
271 extern void notice_new_inferior (ptid_t, int, int);
273 extern struct value *get_return_value (struct value *function,
274 struct type *value_type);
276 /* Address at which inferior stopped. */
278 extern CORE_ADDR stop_pc;
280 /* Nonzero if stopped due to completion of a stack dummy routine. */
282 extern enum stop_stack_kind stop_stack_dummy;
284 /* Nonzero if program stopped due to a random (unexpected) signal in
287 extern int stopped_by_random_signal;
289 /* STEP_OVER_ALL means step over all subroutine calls.
290 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
291 STEP_OVER_NONE means don't step over any subroutine calls. */
293 enum step_over_calls_kind
297 STEP_OVER_UNDEBUGGABLE
300 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
301 will handle it themselves. STOP_QUIETLY is used when running in
302 the shell before the child program has been exec'd and when running
303 through shared library loading. STOP_QUIETLY_REMOTE is used when
304 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
305 except that there is no need to hide a signal. */
307 /* It is also used after attach, due to attaching to a process. This
308 is a bit trickier. When doing an attach, the kernel stops the
309 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61)
310 the handling of SIGSTOP for a ptraced process has changed. Earlier
311 versions of the kernel would ignore these SIGSTOPs, while now
312 SIGSTOP is treated like any other signal, i.e. it is not muffled.
314 If the gdb user does a 'continue' after the 'attach', gdb passes
315 the global variable stop_signal (which stores the signal from the
316 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
317 problematic, because the kernel doesn't ignore such SIGSTOP
318 now. I.e. it is reported back to gdb, which in turn presents it
321 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
322 gdb to clear the value of stop_signal after the attach, so that it
323 is not passed back down to the kernel. */
330 STOP_QUIETLY_NO_SIGSTOP
333 /* Reverse execution. */
334 enum exec_direction_kind
340 /* The current execution direction. This should only be set to enum
341 exec_direction_kind values. It is only an int to make it
342 compatible with make_cleanup_restore_integer. */
343 extern int execution_direction;
345 /* Save register contents here when executing a "finish" command or are
346 about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
347 Thus this contains the return value from the called function (assuming
348 values are returned in a register). */
350 extern struct regcache *stop_registers;
352 /* True if we are debugging displaced stepping. */
353 extern int debug_displaced;
355 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */
356 void displaced_step_dump_bytes (struct ui_file *file,
357 const gdb_byte *buf, size_t len);
359 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
361 /* Possible values for gdbarch_call_dummy_location. */
363 #define AT_ENTRY_POINT 4
365 /* If STARTUP_WITH_SHELL is set, GDB's "run"
366 will attempts to start up the debugee under a shell.
367 This is in order for argument-expansion to occur. E.g.,
369 The "*" gets expanded by the shell into a list of files.
370 While this is a nice feature, it turns out to interact badly
371 with some of the catch-fork/catch-exec features we have added.
372 In particular, if the shell does any fork/exec's before
373 the exec of the target program, that can confuse GDB.
374 To disable this feature, set STARTUP_WITH_SHELL to 0.
375 To enable this feature, set STARTUP_WITH_SHELL to 1.
376 The catch-exec traps expected during start-up will
377 be 1 if target is not started up with a shell, 2 if it is.
379 If you disable this, you need to decrement
380 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
381 #define STARTUP_WITH_SHELL 1
382 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
383 #define START_INFERIOR_TRAPS_EXPECTED 2
386 struct private_inferior;
388 /* Inferior process specific part of `struct infcall_control_state'.
390 Inferior thread counterpart is `struct thread_control_state'. */
392 struct inferior_control_state
394 /* See the definition of stop_kind above. */
395 enum stop_kind stop_soon;
398 /* Inferior process specific part of `struct infcall_suspend_state'.
400 Inferior thread counterpart is `struct thread_suspend_state'. */
402 #if 0 /* Currently unused and empty structures are not valid C. */
403 struct inferior_suspend_state
408 /* GDB represents the state of each program execution with an object
409 called an inferior. An inferior typically corresponds to a process
410 but is more general and applies also to targets that do not have a
411 notion of processes. Each run of an executable creates a new
412 inferior, as does each attachment to an existing process.
413 Inferiors have unique internal identifiers that are different from
414 target process ids. Each inferior may in turn have multiple
415 threads running in it. */
419 /* Pointer to next inferior in singly-linked list of inferiors. */
420 struct inferior *next;
422 /* Convenient handle (GDB inferior id). Unique across all
426 /* Actual target inferior id, usually, a process id. This matches
427 the ptid_t.pid member of threads of this inferior. */
429 /* True if the PID was actually faked by GDB. */
432 /* State of GDB control of inferior process execution.
433 See `struct inferior_control_state'. */
434 struct inferior_control_state control;
436 /* State of inferior process to restore after GDB is done with an inferior
437 call. See `struct inferior_suspend_state'. */
438 #if 0 /* Currently unused and empty structures are not valid C. */
439 struct inferior_suspend_state suspend;
442 /* True if this was an auto-created inferior, e.g. created from
443 following a fork; false, if this inferior was manually added by
444 the user, and we should not attempt to prune it
448 /* The address space bound to this inferior. */
449 struct address_space *aspace;
451 /* The program space bound to this inferior. */
452 struct program_space *pspace;
454 /* The arguments string to use when running. */
457 /* The size of elements in argv. */
460 /* The vector version of arguments. If ARGC is nonzero,
461 then we must compute ARGS from this (via the target).
462 This is always coming from main's argv and therefore
463 should never be freed. */
466 /* The name of terminal device to use for I/O. */
469 /* Environment to use for running inferior,
470 in format described in environ.h. */
471 struct gdb_environ *environment;
473 /* Nonzero if this child process was attached rather than
477 /* If this inferior is a vfork child, then this is the pointer to
478 its vfork parent, if GDB is still attached to it. */
479 struct inferior *vfork_parent;
481 /* If this process is a vfork parent, this is the pointer to the
482 child. Since a vfork parent is left frozen by the kernel until
483 the child execs or exits, a process can only have one vfork child
485 struct inferior *vfork_child;
487 /* True if this inferior should be detached when it's vfork sibling
491 /* True if this inferior is a vfork parent waiting for a vfork child
492 not under our control to be done with the shared memory region,
493 either by exiting or execing. */
494 int waiting_for_vfork_done;
496 /* True if we're in the process of detaching from this inferior. */
499 /* What is left to do for an execution command after any thread of
500 this inferior stops. For continuations associated with a
501 specific thread, see `struct thread_info'. */
502 struct continuation *continuations;
504 /* Private data used by the target vector implementation. */
505 struct private_inferior *private;
507 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
508 In this case, the EXIT_CODE field is also valid. */
512 /* Default flags to pass to the symbol reading functions. These are
513 used whenever a new objfile is created. The valid values come
514 from enum symfile_add_flags. */
517 /* Info about an inferior's target description (if it's fetched; the
518 user supplied description's filename, if any; etc.). */
519 struct target_desc_info *tdesc_info;
521 /* The architecture associated with the inferior through the
522 connection to the target.
524 The architecture vector provides some information that is really
525 a property of the inferior, accessed through a particular target:
526 ptrace operations; the layout of certain RSP packets; the
527 solib_ops vector; etc. To differentiate architecture accesses to
528 per-inferior/target properties from
529 per-thread/per-frame/per-objfile properties, accesses to
530 per-inferior/target properties should be made through
532 struct gdbarch *gdbarch;
534 /* Per inferior data-pointers required by other GDB modules. */
538 /* Keep a registry of per-inferior data-pointers required by other GDB
541 DECLARE_REGISTRY (inferior);
543 /* Create an empty inferior list, or empty the existing one. */
544 extern void init_inferior_list (void);
546 /* Add an inferior to the inferior list, print a message that a new
547 inferior is found, and return the pointer to the new inferior.
548 Caller may use this pointer to initialize the private inferior
550 extern struct inferior *add_inferior (int pid);
552 /* Same as add_inferior, but don't print new inferior notifications to
554 extern struct inferior *add_inferior_silent (int pid);
556 /* Delete an existing inferior list entry, due to inferior exit. */
557 extern void delete_inferior (int pid);
559 extern void delete_inferior_1 (struct inferior *todel, int silent);
561 /* Same as delete_inferior, but don't print new inferior notifications
563 extern void delete_inferior_silent (int pid);
565 /* Delete an existing inferior list entry, due to inferior detaching. */
566 extern void detach_inferior (int pid);
568 extern void exit_inferior (int pid);
570 extern void exit_inferior_silent (int pid);
572 extern void exit_inferior_num_silent (int num);
574 extern void inferior_appeared (struct inferior *inf, int pid);
576 /* Get rid of all inferiors. */
577 extern void discard_all_inferiors (void);
579 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
580 into a "pid" (which may be overloaded with extra inferior information). */
581 extern int gdb_inferior_id_to_pid (int);
583 /* Translate a target 'pid' into the integer inferior id (GDB's
584 homegrown id, not the system's). */
585 extern int pid_to_gdb_inferior_id (int pid);
587 /* Boolean test for an already-known pid. */
588 extern int in_inferior_list (int pid);
590 /* Boolean test for an already-known inferior id (GDB's homegrown id,
591 not the system's). */
592 extern int valid_gdb_inferior_id (int num);
594 /* Search function to lookup an inferior by target 'pid'. */
595 extern struct inferior *find_inferior_pid (int pid);
597 /* Search function to lookup an inferior by GDB 'num'. */
598 extern struct inferior *find_inferior_id (int num);
600 /* Find an inferior bound to PSPACE. */
601 extern struct inferior *
602 find_inferior_for_program_space (struct program_space *pspace);
604 /* Inferior iterator function.
606 Calls a callback function once for each inferior, so long as the
607 callback function returns false. If the callback function returns
608 true, the iteration will end and the current inferior will be
609 returned. This can be useful for implementing a search for a
610 inferior with arbitrary attributes, or for applying some operation
613 It is safe to delete the iterated inferior from the callback. */
614 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
618 /* Returns true if the inferior list is not empty. */
619 extern int have_inferiors (void);
621 /* Returns true if there are any live inferiors in the inferior list
622 (not cores, not executables, real live processes). */
623 extern int have_live_inferiors (void);
625 /* Return a pointer to the current inferior. It is an error to call
626 this if there is no current inferior. */
627 extern struct inferior *current_inferior (void);
629 extern void set_current_inferior (struct inferior *);
631 extern struct cleanup *save_current_inferior (void);
633 /* Traverse all inferiors. */
635 #define ALL_INFERIORS(I) \
636 for ((I) = inferior_list; (I); (I) = (I)->next)
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 extern void update_signals_program_target (void);
652 /* In some circumstances we allow a command to specify a numeric
653 signal. The idea is to keep these circumstances limited so that
654 users (and scripts) develop portable habits. For comparison,
655 POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
656 numeric signal at all is obsolescent. We are slightly more lenient
657 and allow 1-15 which should match host signal numbers on most
658 systems. Use of symbolic signal names is strongly encouraged. */
660 enum gdb_signal gdb_signal_from_command (int num);
662 #endif /* !defined (INFERIOR_H) */