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-2014 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (INFERIOR_H)
24 struct target_waitstatus;
32 struct target_desc_info;
35 #include "breakpoint.h"
37 /* For enum gdb_signal. */
40 /* For struct frame_id. */
43 #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 /* Save value of inferior_ptid so that it may be restored by
67 a later call to do_cleanups(). Returns the struct cleanup
68 pointer needed for later doing the cleanup. */
69 extern struct cleanup * save_inferior_ptid (void);
71 extern void set_sigint_trap (void);
73 extern void clear_sigint_trap (void);
75 /* Set/get file name for default use for standard in/out in the inferior. */
77 extern void set_inferior_io_terminal (const char *terminal_name);
78 extern const char *get_inferior_io_terminal (void);
80 /* Collected pid, tid, etc. of the debugged inferior. When there's
81 no inferior, ptid_get_pid (inferior_ptid) will be 0. */
83 extern ptid_t inferior_ptid;
85 extern void generic_mourn_inferior (void);
87 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
90 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
91 struct type *type, gdb_byte *buf,
93 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
96 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
97 struct type *type, gdb_byte *buf,
100 extern void reopen_exec_file (void);
102 /* From misc files */
104 extern void default_print_registers_info (struct gdbarch *gdbarch,
105 struct ui_file *file,
106 struct frame_info *frame,
107 int regnum, int all);
109 extern void child_terminal_info (struct target_ops *self, const char *, int);
111 extern void term_info (char *, int);
113 extern void child_terminal_ours (struct target_ops *self);
115 extern void child_terminal_ours_for_output (struct target_ops *self);
117 extern void child_terminal_inferior (struct target_ops *self);
119 extern void child_terminal_init (struct target_ops *self);
121 extern void child_terminal_init_with_pgrp (int pgrp);
123 /* From fork-child.c */
125 extern int fork_inferior (char *, char *, char **,
127 void (*)(int), void (*)(void), char *,
128 void (*)(const char *,
129 char * const *, char * const *));
132 extern void startup_inferior (int);
134 extern char *construct_inferior_arguments (int, char **);
138 extern void post_create_inferior (struct target_ops *, int);
140 extern void attach_command (char *, int);
142 extern char *get_inferior_args (void);
144 extern void set_inferior_args (char *);
146 extern void set_inferior_args_vector (int, char **);
148 extern void registers_info (char *, int);
150 extern void continue_1 (int all_threads);
152 extern void interrupt_target_1 (int all_threads);
154 extern void delete_longjmp_breakpoint_cleanup (void *arg);
156 extern void detach_command (char *, int);
158 extern void notice_new_inferior (ptid_t, int, int);
160 extern struct value *get_return_value (struct value *function,
161 struct type *value_type);
163 /* Prepare for execution command. TARGET is the target that will run
164 the command. BACKGROUND determines whether this is a foreground
165 (synchronous) or background (asynchronous) command. */
167 extern void prepare_execution_command (struct target_ops *target,
170 /* Whether to start up the debuggee under a shell.
172 If startup-with-shell is set, GDB's "run" will attempt to start up
173 the debuggee under a shell.
175 This is in order for argument-expansion to occur. E.g.,
179 The "*" gets expanded by the shell into a list of files.
181 While this is a nice feature, it may be handy to bypass the shell
182 in some cases. To disable this feature, do "set startup-with-shell
185 The catch-exec traps expected during start-up will be one more if
186 the target is started up with a shell. */
187 extern int startup_with_shell;
189 /* Address at which inferior stopped. */
191 extern CORE_ADDR stop_pc;
193 /* Nonzero if stopped due to completion of a stack dummy routine. */
195 extern enum stop_stack_kind stop_stack_dummy;
197 /* Nonzero if program stopped due to a random (unexpected) signal in
200 extern int stopped_by_random_signal;
202 /* STEP_OVER_ALL means step over all subroutine calls.
203 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
204 STEP_OVER_NONE means don't step over any subroutine calls. */
206 enum step_over_calls_kind
210 STEP_OVER_UNDEBUGGABLE
213 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
214 will handle it themselves. STOP_QUIETLY is used when running in
215 the shell before the child program has been exec'd and when running
216 through shared library loading. STOP_QUIETLY_REMOTE is used when
217 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
218 except that there is no need to hide a signal. */
220 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
221 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
222 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
223 a ptraced process has changed. Earlier versions of the kernel
224 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
225 other signal, i.e. it is not muffled.
227 If the gdb user does a 'continue' after the 'attach', gdb passes
228 the global variable stop_signal (which stores the signal from the
229 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
230 problematic, because the kernel doesn't ignore such SIGSTOP
231 now. I.e. it is reported back to gdb, which in turn presents it
234 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
235 gdb to clear the value of stop_signal after the attach, so that it
236 is not passed back down to the kernel. */
243 STOP_QUIETLY_NO_SIGSTOP
247 /* Possible values for gdbarch_call_dummy_location. */
249 #define AT_ENTRY_POINT 4
251 /* Number of traps that happen between exec'ing the shell to run an
252 inferior and when we finally get to the inferior code, not counting
253 the exec for the shell. This is 1 on most implementations.
254 Overridden in nm.h files. */
255 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
256 #define START_INFERIOR_TRAPS_EXPECTED 1
259 struct private_inferior;
261 /* Inferior process specific part of `struct infcall_control_state'.
263 Inferior thread counterpart is `struct thread_control_state'. */
265 struct inferior_control_state
267 /* See the definition of stop_kind above. */
268 enum stop_kind stop_soon;
271 /* Inferior process specific part of `struct infcall_suspend_state'.
273 Inferior thread counterpart is `struct thread_suspend_state'. */
275 #if 0 /* Currently unused and empty structures are not valid C. */
276 struct inferior_suspend_state
281 /* GDB represents the state of each program execution with an object
282 called an inferior. An inferior typically corresponds to a process
283 but is more general and applies also to targets that do not have a
284 notion of processes. Each run of an executable creates a new
285 inferior, as does each attachment to an existing process.
286 Inferiors have unique internal identifiers that are different from
287 target process ids. Each inferior may in turn have multiple
288 threads running in it. */
292 /* Pointer to next inferior in singly-linked list of inferiors. */
293 struct inferior *next;
295 /* Convenient handle (GDB inferior id). Unique across all
299 /* Actual target inferior id, usually, a process id. This matches
300 the ptid_t.pid member of threads of this inferior. */
302 /* True if the PID was actually faked by GDB. */
305 /* State of GDB control of inferior process execution.
306 See `struct inferior_control_state'. */
307 struct inferior_control_state control;
309 /* State of inferior process to restore after GDB is done with an inferior
310 call. See `struct inferior_suspend_state'. */
311 #if 0 /* Currently unused and empty structures are not valid C. */
312 struct inferior_suspend_state suspend;
315 /* True if this was an auto-created inferior, e.g. created from
316 following a fork; false, if this inferior was manually added by
317 the user, and we should not attempt to prune it
321 /* The address space bound to this inferior. */
322 struct address_space *aspace;
324 /* The program space bound to this inferior. */
325 struct program_space *pspace;
327 /* The arguments string to use when running. */
330 /* The size of elements in argv. */
333 /* The vector version of arguments. If ARGC is nonzero,
334 then we must compute ARGS from this (via the target).
335 This is always coming from main's argv and therefore
336 should never be freed. */
339 /* The name of terminal device to use for I/O. */
342 /* Environment to use for running inferior,
343 in format described in environ.h. */
344 struct gdb_environ *environment;
346 /* Nonzero if this child process was attached rather than
350 /* If this inferior is a vfork child, then this is the pointer to
351 its vfork parent, if GDB is still attached to it. */
352 struct inferior *vfork_parent;
354 /* If this process is a vfork parent, this is the pointer to the
355 child. Since a vfork parent is left frozen by the kernel until
356 the child execs or exits, a process can only have one vfork child
358 struct inferior *vfork_child;
360 /* True if this inferior should be detached when it's vfork sibling
364 /* True if this inferior is a vfork parent waiting for a vfork child
365 not under our control to be done with the shared memory region,
366 either by exiting or execing. */
367 int waiting_for_vfork_done;
369 /* True if we're in the process of detaching from this inferior. */
372 /* What is left to do for an execution command after any thread of
373 this inferior stops. For continuations associated with a
374 specific thread, see `struct thread_info'. */
375 struct continuation *continuations;
377 /* Private data used by the target vector implementation. */
378 struct private_inferior *private;
380 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
381 In this case, the EXIT_CODE field is also valid. */
385 /* Default flags to pass to the symbol reading functions. These are
386 used whenever a new objfile is created. The valid values come
387 from enum symfile_add_flags. */
390 /* Info about an inferior's target description (if it's fetched; the
391 user supplied description's filename, if any; etc.). */
392 struct target_desc_info *tdesc_info;
394 /* The architecture associated with the inferior through the
395 connection to the target.
397 The architecture vector provides some information that is really
398 a property of the inferior, accessed through a particular target:
399 ptrace operations; the layout of certain RSP packets; the
400 solib_ops vector; etc. To differentiate architecture accesses to
401 per-inferior/target properties from
402 per-thread/per-frame/per-objfile properties, accesses to
403 per-inferior/target properties should be made through
405 struct gdbarch *gdbarch;
407 /* Per inferior data-pointers required by other GDB modules. */
411 /* Keep a registry of per-inferior data-pointers required by other GDB
414 DECLARE_REGISTRY (inferior);
416 /* Create an empty inferior list, or empty the existing one. */
417 extern void init_inferior_list (void);
419 /* Add an inferior to the inferior list, print a message that a new
420 inferior is found, and return the pointer to the new inferior.
421 Caller may use this pointer to initialize the private inferior
423 extern struct inferior *add_inferior (int pid);
425 /* Same as add_inferior, but don't print new inferior notifications to
427 extern struct inferior *add_inferior_silent (int pid);
429 /* Delete an existing inferior list entry, due to inferior exit. */
430 extern void delete_inferior (int pid);
432 extern void delete_inferior_1 (struct inferior *todel, int silent);
434 /* Same as delete_inferior, but don't print new inferior notifications
436 extern void delete_inferior_silent (int pid);
438 /* Delete an existing inferior list entry, due to inferior detaching. */
439 extern void detach_inferior (int pid);
441 extern void exit_inferior (int pid);
443 extern void exit_inferior_silent (int pid);
445 extern void exit_inferior_num_silent (int num);
447 extern void inferior_appeared (struct inferior *inf, int pid);
449 /* Get rid of all inferiors. */
450 extern void discard_all_inferiors (void);
452 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
453 into a "pid" (which may be overloaded with extra inferior information). */
454 extern int gdb_inferior_id_to_pid (int);
456 /* Translate a target 'pid' into the integer inferior id (GDB's
457 homegrown id, not the system's). */
458 extern int pid_to_gdb_inferior_id (int pid);
460 /* Boolean test for an already-known pid. */
461 extern int in_inferior_list (int pid);
463 /* Boolean test for an already-known inferior id (GDB's homegrown id,
464 not the system's). */
465 extern int valid_gdb_inferior_id (int num);
467 /* Search function to lookup an inferior by target 'pid'. */
468 extern struct inferior *find_inferior_pid (int pid);
470 /* Search function to lookup an inferior by GDB 'num'. */
471 extern struct inferior *find_inferior_id (int num);
473 /* Find an inferior bound to PSPACE. */
474 extern struct inferior *
475 find_inferior_for_program_space (struct program_space *pspace);
477 /* Inferior iterator function.
479 Calls a callback function once for each inferior, so long as the
480 callback function returns false. If the callback function returns
481 true, the iteration will end and the current inferior will be
482 returned. This can be useful for implementing a search for a
483 inferior with arbitrary attributes, or for applying some operation
486 It is safe to delete the iterated inferior from the callback. */
487 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
491 /* Returns true if the inferior list is not empty. */
492 extern int have_inferiors (void);
494 /* Returns true if there are any live inferiors in the inferior list
495 (not cores, not executables, real live processes). */
496 extern int have_live_inferiors (void);
498 /* Return a pointer to the current inferior. It is an error to call
499 this if there is no current inferior. */
500 extern struct inferior *current_inferior (void);
502 extern void set_current_inferior (struct inferior *);
504 extern struct cleanup *save_current_inferior (void);
506 /* Traverse all inferiors. */
508 #define ALL_INFERIORS(I) \
509 for ((I) = inferior_list; (I); (I) = (I)->next)
511 extern struct inferior *inferior_list;
513 /* Prune away automatically added inferiors that aren't required
515 extern void prune_inferiors (void);
517 extern int number_of_inferiors (void);
519 extern struct inferior *add_inferior_with_spaces (void);
521 #endif /* !defined (INFERIOR_H) */