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-2016 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 /* Default implementation of gdbarch_print_float_info. Print
110 the values of all floating point registers. */
112 extern void default_print_float_info (struct gdbarch
*gdbarch
,
113 struct ui_file
*file
,
114 struct frame_info
*frame
,
117 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
119 extern void term_info (char *, int);
121 extern void child_terminal_ours (struct target_ops
*self
);
123 extern void child_terminal_ours_for_output (struct target_ops
*self
);
125 extern void child_terminal_inferior (struct target_ops
*self
);
127 extern void child_terminal_init (struct target_ops
*self
);
129 extern void child_terminal_init_with_pgrp (int pgrp
);
131 /* From fork-child.c */
133 extern int fork_inferior (char *, char *, char **,
135 void (*)(int), void (*)(void), char *,
136 void (*)(const char *,
137 char * const *, char * const *));
140 extern void startup_inferior (int);
142 extern char *construct_inferior_arguments (int, char **);
146 /* Initial inferior setup. Determines the exec file is not yet known,
147 takes any necessary post-attaching actions, fetches the target
148 description and syncs the shared library list. */
150 extern void setup_inferior (int from_tty
);
152 extern void post_create_inferior (struct target_ops
*, int);
154 extern void attach_command (char *, int);
156 extern char *get_inferior_args (void);
158 extern void set_inferior_args (char *);
160 extern void set_inferior_args_vector (int, char **);
162 extern void registers_info (char *, int);
164 extern void continue_1 (int all_threads
);
166 extern void interrupt_target_1 (int all_threads
);
168 extern void delete_longjmp_breakpoint_cleanup (void *arg
);
170 extern void detach_command (char *, int);
172 extern void notice_new_inferior (ptid_t
, int, int);
174 extern struct value
*get_return_value (struct value
*function
,
175 struct type
*value_type
);
177 /* Prepare for execution command. TARGET is the target that will run
178 the command. BACKGROUND determines whether this is a foreground
179 (synchronous) or background (asynchronous) command. */
181 extern void prepare_execution_command (struct target_ops
*target
,
184 /* Whether to start up the debuggee under a shell.
186 If startup-with-shell is set, GDB's "run" will attempt to start up
187 the debuggee under a shell.
189 This is in order for argument-expansion to occur. E.g.,
193 The "*" gets expanded by the shell into a list of files.
195 While this is a nice feature, it may be handy to bypass the shell
196 in some cases. To disable this feature, do "set startup-with-shell
199 The catch-exec traps expected during start-up will be one more if
200 the target is started up with a shell. */
201 extern int startup_with_shell
;
203 /* Address at which inferior stopped. */
205 extern CORE_ADDR stop_pc
;
207 /* Nonzero if stopped due to completion of a stack dummy routine. */
209 extern enum stop_stack_kind stop_stack_dummy
;
211 /* Nonzero if program stopped due to a random (unexpected) signal in
214 extern int stopped_by_random_signal
;
216 /* STEP_OVER_ALL means step over all subroutine calls.
217 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
218 STEP_OVER_NONE means don't step over any subroutine calls. */
220 enum step_over_calls_kind
224 STEP_OVER_UNDEBUGGABLE
227 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
228 will handle it themselves. STOP_QUIETLY is used when running in
229 the shell before the child program has been exec'd and when running
230 through shared library loading. STOP_QUIETLY_REMOTE is used when
231 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
232 except that there is no need to hide a signal. */
234 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
235 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
236 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
237 a ptraced process has changed. Earlier versions of the kernel
238 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
239 other signal, i.e. it is not muffled.
241 If the gdb user does a 'continue' after the 'attach', gdb passes
242 the global variable stop_signal (which stores the signal from the
243 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
244 problematic, because the kernel doesn't ignore such SIGSTOP
245 now. I.e. it is reported back to gdb, which in turn presents it
248 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
249 gdb to clear the value of stop_signal after the attach, so that it
250 is not passed back down to the kernel. */
257 STOP_QUIETLY_NO_SIGSTOP
261 /* Possible values for gdbarch_call_dummy_location. */
263 #define AT_ENTRY_POINT 4
265 /* Number of traps that happen between exec'ing the shell to run an
266 inferior and when we finally get to the inferior code, not counting
267 the exec for the shell. This is 1 on all supported
269 #define START_INFERIOR_TRAPS_EXPECTED 1
271 struct private_inferior
;
273 /* Inferior process specific part of `struct infcall_control_state'.
275 Inferior thread counterpart is `struct thread_control_state'. */
277 struct inferior_control_state
279 /* See the definition of stop_kind above. */
280 enum stop_kind stop_soon
;
283 /* GDB represents the state of each program execution with an object
284 called an inferior. An inferior typically corresponds to a process
285 but is more general and applies also to targets that do not have a
286 notion of processes. Each run of an executable creates a new
287 inferior, as does each attachment to an existing process.
288 Inferiors have unique internal identifiers that are different from
289 target process ids. Each inferior may in turn have multiple
290 threads running in it. */
294 /* Pointer to next inferior in singly-linked list of inferiors. */
295 struct inferior
*next
;
297 /* Convenient handle (GDB inferior id). Unique across all
301 /* Actual target inferior id, usually, a process id. This matches
302 the ptid_t.pid member of threads of this inferior. */
304 /* True if the PID was actually faked by GDB. */
307 /* State of GDB control of inferior process execution.
308 See `struct inferior_control_state'. */
309 struct inferior_control_state control
;
311 /* True if this was an auto-created inferior, e.g. created from
312 following a fork; false, if this inferior was manually added by
313 the user, and we should not attempt to prune it
317 /* The address space bound to this inferior. */
318 struct address_space
*aspace
;
320 /* The program space bound to this inferior. */
321 struct program_space
*pspace
;
323 /* The arguments string to use when running. */
326 /* The size of elements in argv. */
329 /* The vector version of arguments. If ARGC is nonzero,
330 then we must compute ARGS from this (via the target).
331 This is always coming from main's argv and therefore
332 should never be freed. */
335 /* The name of terminal device to use for I/O. */
338 /* Environment to use for running inferior,
339 in format described in environ.h. */
340 struct gdb_environ
*environment
;
342 /* Nonzero if this child process was attached rather than
346 /* If this inferior is a vfork child, then this is the pointer to
347 its vfork parent, if GDB is still attached to it. */
348 struct inferior
*vfork_parent
;
350 /* If this process is a vfork parent, this is the pointer to the
351 child. Since a vfork parent is left frozen by the kernel until
352 the child execs or exits, a process can only have one vfork child
354 struct inferior
*vfork_child
;
356 /* True if this inferior should be detached when it's vfork sibling
360 /* True if this inferior is a vfork parent waiting for a vfork child
361 not under our control to be done with the shared memory region,
362 either by exiting or execing. */
363 int waiting_for_vfork_done
;
365 /* True if we're in the process of detaching from this inferior. */
368 /* What is left to do for an execution command after any thread of
369 this inferior stops. For continuations associated with a
370 specific thread, see `struct thread_info'. */
371 struct continuation
*continuations
;
373 /* True if setup_inferior wasn't called for this inferior yet.
374 Until that is done, we must not access inferior memory or
375 registers, as we haven't determined the target
376 architecture/description. */
379 /* Private data used by the target vector implementation. */
380 struct private_inferior
*priv
;
382 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
383 In this case, the EXIT_CODE field is also valid. */
387 /* Default flags to pass to the symbol reading functions. These are
388 used whenever a new objfile is created. The valid values come
389 from enum symfile_add_flags. */
392 /* Info about an inferior's target description (if it's fetched; the
393 user supplied description's filename, if any; etc.). */
394 struct target_desc_info
*tdesc_info
;
396 /* The architecture associated with the inferior through the
397 connection to the target.
399 The architecture vector provides some information that is really
400 a property of the inferior, accessed through a particular target:
401 ptrace operations; the layout of certain RSP packets; the
402 solib_ops vector; etc. To differentiate architecture accesses to
403 per-inferior/target properties from
404 per-thread/per-frame/per-objfile properties, accesses to
405 per-inferior/target properties should be made through
407 struct gdbarch
*gdbarch
;
409 /* Per inferior data-pointers required by other GDB modules. */
413 /* Keep a registry of per-inferior data-pointers required by other GDB
416 DECLARE_REGISTRY (inferior
);
418 /* Create an empty inferior list, or empty the existing one. */
419 extern void init_inferior_list (void);
421 /* Add an inferior to the inferior list, print a message that a new
422 inferior is found, and return the pointer to the new inferior.
423 Caller may use this pointer to initialize the private inferior
425 extern struct inferior
*add_inferior (int pid
);
427 /* Same as add_inferior, but don't print new inferior notifications to
429 extern struct inferior
*add_inferior_silent (int pid
);
431 extern void delete_inferior (struct inferior
*todel
);
433 /* Delete an existing inferior list entry, due to inferior detaching. */
434 extern void detach_inferior (int pid
);
436 extern void exit_inferior (int pid
);
438 extern void exit_inferior_silent (int pid
);
440 extern void exit_inferior_num_silent (int num
);
442 extern void inferior_appeared (struct inferior
*inf
, int pid
);
444 /* Get rid of all inferiors. */
445 extern void discard_all_inferiors (void);
447 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
448 into a "pid" (which may be overloaded with extra inferior information). */
449 extern int gdb_inferior_id_to_pid (int);
451 /* Translate a target 'pid' into the integer inferior id (GDB's
452 homegrown id, not the system's). */
453 extern int pid_to_gdb_inferior_id (int pid
);
455 /* Boolean test for an already-known pid. */
456 extern int in_inferior_list (int pid
);
458 /* Boolean test for an already-known inferior id (GDB's homegrown id,
459 not the system's). */
460 extern int valid_gdb_inferior_id (int num
);
462 /* Search function to lookup an inferior by target 'pid'. */
463 extern struct inferior
*find_inferior_pid (int pid
);
465 /* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */
466 extern struct inferior
*find_inferior_ptid (ptid_t ptid
);
468 /* Search function to lookup an inferior by GDB 'num'. */
469 extern struct inferior
*find_inferior_id (int num
);
471 /* Find an inferior bound to PSPACE, giving preference to the current
473 extern struct inferior
*
474 find_inferior_for_program_space (struct program_space
*pspace
);
476 /* Inferior iterator function.
478 Calls a callback function once for each inferior, so long as the
479 callback function returns false. If the callback function returns
480 true, the iteration will end and the current inferior will be
481 returned. This can be useful for implementing a search for a
482 inferior with arbitrary attributes, or for applying some operation
485 It is safe to delete the iterated inferior from the callback. */
486 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
490 /* Returns true if the inferior list is not empty. */
491 extern int have_inferiors (void);
493 /* Returns the number of live inferiors (real live processes). */
494 extern int number_of_live_inferiors (void);
496 /* Returns true if there are any live inferiors in the inferior list
497 (not cores, not executables, real live processes). */
498 extern int have_live_inferiors (void);
500 /* Return a pointer to the current inferior. It is an error to call
501 this if there is no current inferior. */
502 extern struct inferior
*current_inferior (void);
504 extern void set_current_inferior (struct inferior
*);
506 extern struct cleanup
*save_current_inferior (void);
508 /* Traverse all inferiors. */
510 #define ALL_INFERIORS(I) \
511 for ((I) = inferior_list; (I); (I) = (I)->next)
513 extern struct inferior
*inferior_list
;
515 /* Prune away automatically added inferiors that aren't required
517 extern void prune_inferiors (void);
519 extern int number_of_inferiors (void);
521 extern struct inferior
*add_inferior_with_spaces (void);
523 #endif /* !defined (INFERIOR_H) */