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-2019 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;
38 #include "breakpoint.h"
40 /* For enum gdb_signal. */
43 /* For struct frame_id. */
46 /* For gdb_environ. */
47 #include "common/environ.h"
49 #include "progspace.h"
52 #include "symfile-add-flags.h"
53 #include "common/refcounted-object.h"
54 #include "common/forward-scope-exit.h"
56 #include "common/common-inferior.h"
57 #include "gdbthread.h"
59 struct infcall_suspend_state;
60 struct infcall_control_state;
62 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
63 extern void restore_infcall_control_state (struct infcall_control_state *);
65 /* A deleter for infcall_suspend_state that calls
66 restore_infcall_suspend_state. */
67 struct infcall_suspend_state_deleter
69 void operator() (struct infcall_suspend_state *state) const
71 restore_infcall_suspend_state (state);
75 /* A unique_ptr specialization for infcall_suspend_state. */
76 typedef std::unique_ptr<infcall_suspend_state, infcall_suspend_state_deleter>
77 infcall_suspend_state_up;
79 extern infcall_suspend_state_up save_infcall_suspend_state ();
81 /* A deleter for infcall_control_state that calls
82 restore_infcall_control_state. */
83 struct infcall_control_state_deleter
85 void operator() (struct infcall_control_state *state) const
87 restore_infcall_control_state (state);
91 /* A unique_ptr specialization for infcall_control_state. */
92 typedef std::unique_ptr<infcall_control_state, infcall_control_state_deleter>
93 infcall_control_state_up;
95 extern infcall_control_state_up save_infcall_control_state ();
97 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
98 extern void discard_infcall_control_state (struct infcall_control_state *);
100 extern readonly_detached_regcache *
101 get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
103 extern void set_sigint_trap (void);
105 extern void clear_sigint_trap (void);
107 /* Set/get file name for default use for standard in/out in the inferior. */
109 extern void set_inferior_io_terminal (const char *terminal_name);
110 extern const char *get_inferior_io_terminal (void);
112 /* Collected pid, tid, etc. of the debugged inferior. When there's
113 no inferior, inferior_ptid.pid () will be 0. */
115 extern ptid_t inferior_ptid;
117 extern void generic_mourn_inferior (void);
119 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
121 const gdb_byte *buf);
122 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
123 struct type *type, gdb_byte *buf,
125 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
127 const gdb_byte *buf);
128 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
129 struct type *type, gdb_byte *buf,
132 extern void reopen_exec_file (void);
134 /* From misc files */
136 extern void default_print_registers_info (struct gdbarch *gdbarch,
137 struct ui_file *file,
138 struct frame_info *frame,
139 int regnum, int all);
141 /* Default implementation of gdbarch_print_float_info. Print
142 the values of all floating point registers. */
144 extern void default_print_float_info (struct gdbarch *gdbarch,
145 struct ui_file *file,
146 struct frame_info *frame,
149 extern void child_terminal_info (struct target_ops *self, const char *, int);
151 extern void info_terminal_command (char *, int);
153 extern void child_terminal_ours (struct target_ops *self);
155 extern void child_terminal_ours_for_output (struct target_ops *self);
157 extern void child_terminal_inferior (struct target_ops *self);
159 extern void child_terminal_save_inferior (struct target_ops *self);
161 extern void child_terminal_init (struct target_ops *self);
163 extern void child_terminal_init_with_pgrp (int pgrp);
165 extern void child_pass_ctrlc (struct target_ops *self);
167 extern void child_interrupt (struct target_ops *self);
169 /* From fork-child.c */
171 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
172 This function already calls set_executing. Return the ptid_t from
174 extern ptid_t gdb_startup_inferior (pid_t pid, int num_traps);
176 extern char *construct_inferior_arguments (int, char **);
180 /* Initial inferior setup. Determines the exec file is not yet known,
181 takes any necessary post-attaching actions, fetches the target
182 description and syncs the shared library list. */
184 extern void setup_inferior (int from_tty);
186 extern void post_create_inferior (struct target_ops *, int);
188 extern void attach_command (const char *, int);
190 extern const char *get_inferior_args (void);
192 extern void set_inferior_args (const char *);
194 extern void set_inferior_args_vector (int, char **);
196 extern void registers_info (const char *, int);
198 extern void continue_1 (int all_threads);
200 extern void interrupt_target_1 (int all_threads);
202 using delete_longjmp_breakpoint_cleanup
203 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint);
205 extern void detach_command (const char *, int);
207 extern void notice_new_inferior (struct thread_info *, int, int);
209 extern struct value *get_return_value (struct value *function,
210 struct type *value_type);
212 /* Prepare for execution command. TARGET is the target that will run
213 the command. BACKGROUND determines whether this is a foreground
214 (synchronous) or background (asynchronous) command. */
216 extern void prepare_execution_command (struct target_ops *target,
219 /* Whether to start up the debuggee under a shell.
221 If startup-with-shell is set, GDB's "run" will attempt to start up
222 the debuggee under a shell.
224 This is in order for argument-expansion to occur. E.g.,
228 The "*" gets expanded by the shell into a list of files.
230 While this is a nice feature, it may be handy to bypass the shell
231 in some cases. To disable this feature, do "set startup-with-shell
234 The catch-exec traps expected during start-up will be one more if
235 the target is started up with a shell. */
236 extern int startup_with_shell;
238 /* Nonzero if stopped due to completion of a stack dummy routine. */
240 extern enum stop_stack_kind stop_stack_dummy;
242 /* Nonzero if program stopped due to a random (unexpected) signal in
245 extern int stopped_by_random_signal;
247 /* Print notices on inferior events (attach, detach, etc.), set with
248 `set print inferior-events'. */
249 extern int print_inferior_events;
251 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
252 will handle it themselves. STOP_QUIETLY is used when running in
253 the shell before the child program has been exec'd and when running
254 through shared library loading. STOP_QUIETLY_REMOTE is used when
255 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
256 except that there is no need to hide a signal. */
258 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
259 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
260 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
261 a ptraced process has changed. Earlier versions of the kernel
262 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
263 other signal, i.e. it is not muffled.
265 If the gdb user does a 'continue' after the 'attach', gdb passes
266 the global variable stop_signal (which stores the signal from the
267 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
268 problematic, because the kernel doesn't ignore such SIGSTOP
269 now. I.e. it is reported back to gdb, which in turn presents it
272 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
273 gdb to clear the value of stop_signal after the attach, so that it
274 is not passed back down to the kernel. */
281 STOP_QUIETLY_NO_SIGSTOP
285 /* Possible values for gdbarch_call_dummy_location. */
287 #define AT_ENTRY_POINT 4
289 /* Base class for target-specific inferior data. */
291 struct private_inferior
293 virtual ~private_inferior () = 0;
296 /* Inferior process specific part of `struct infcall_control_state'.
298 Inferior thread counterpart is `struct thread_control_state'. */
300 struct inferior_control_state
302 inferior_control_state ()
303 : stop_soon (NO_STOP_QUIETLY)
307 explicit inferior_control_state (enum stop_kind when)
312 /* See the definition of stop_kind above. */
313 enum stop_kind stop_soon;
316 /* Return a pointer to the current inferior. */
317 extern inferior *current_inferior ();
319 extern void set_current_inferior (inferior *);
321 /* GDB represents the state of each program execution with an object
322 called an inferior. An inferior typically corresponds to a process
323 but is more general and applies also to targets that do not have a
324 notion of processes. Each run of an executable creates a new
325 inferior, as does each attachment to an existing process.
326 Inferiors have unique internal identifiers that are different from
327 target process ids. Each inferior may in turn have multiple
328 threads running in it.
330 Inferiors are intrusively refcounted objects. Unlike thread
331 objects, being the user-selected inferior is considered a strong
332 reference and is thus accounted for in the inferior object's
333 refcount (see set_current_inferior). When GDB needs to remember
334 the selected inferior to later restore it, GDB temporarily bumps
335 the inferior object's refcount, to prevent something deleting the
336 inferior object before reverting back (e.g., due to a
337 "remove-inferiors" command (see
338 scoped_restore_current_inferior). All other inferior
339 references are considered weak references. Inferiors are always
340 listed exactly once in the inferior list, so placing an inferior in
341 the inferior list is an implicit, not counted strong reference. */
343 class inferior : public refcounted_object
346 explicit inferior (int pid);
349 /* Returns true if we can delete this inferior. */
350 bool deletable () const { return refcount () == 0; }
352 /* Pointer to next inferior in singly-linked list of inferiors. */
353 struct inferior *next = NULL;
355 /* This inferior's thread list. */
356 thread_info *thread_list = nullptr;
358 /* Returns a range adapter covering the inferior's threads,
359 including exited threads. Used like this:
361 for (thread_info *thr : inf->threads ())
364 inf_threads_range threads ()
365 { return inf_threads_range (this->thread_list); }
367 /* Returns a range adapter covering the inferior's non-exited
368 threads. Used like this:
370 for (thread_info *thr : inf->non_exited_threads ())
373 inf_non_exited_threads_range non_exited_threads ()
374 { return inf_non_exited_threads_range (this->thread_list); }
376 /* Like inferior::threads(), but returns a range adapter that can be
377 used with range-for, safely. I.e., it is safe to delete the
378 currently-iterated thread, like this:
380 for (thread_info *t : inf->threads_safe ())
381 if (some_condition ())
384 inline safe_inf_threads_range threads_safe ()
385 { return safe_inf_threads_range (this->thread_list); }
387 /* Convenient handle (GDB inferior id). Unique across all
391 /* Actual target inferior id, usually, a process id. This matches
392 the ptid_t.pid member of threads of this inferior. */
394 /* True if the PID was actually faked by GDB. */
395 bool fake_pid_p = false;
397 /* The highest thread number this inferior ever had. */
398 int highest_thread_num = 0;
400 /* State of GDB control of inferior process execution.
401 See `struct inferior_control_state'. */
402 inferior_control_state control;
404 /* True if this was an auto-created inferior, e.g. created from
405 following a fork; false, if this inferior was manually added by
406 the user, and we should not attempt to prune it
408 bool removable = false;
410 /* The address space bound to this inferior. */
411 struct address_space *aspace = NULL;
413 /* The program space bound to this inferior. */
414 struct program_space *pspace = NULL;
416 /* The arguments string to use when running. */
419 /* The size of elements in argv. */
422 /* The vector version of arguments. If ARGC is nonzero,
423 then we must compute ARGS from this (via the target).
424 This is always coming from main's argv and therefore
425 should never be freed. */
428 /* The current working directory that will be used when starting
430 gdb::unique_xmalloc_ptr<char> cwd;
432 /* The name of terminal device to use for I/O. */
433 char *terminal = NULL;
435 /* The terminal state as set by the last target_terminal::terminal_*
437 target_terminal_state terminal_state = target_terminal_state::is_ours;
439 /* Environment to use for running inferior,
440 in format described in environ.h. */
441 gdb_environ environment;
443 /* True if this child process was attached rather than forked. */
444 bool attach_flag = false;
446 /* If this inferior is a vfork child, then this is the pointer to
447 its vfork parent, if GDB is still attached to it. */
448 inferior *vfork_parent = NULL;
450 /* If this process is a vfork parent, this is the pointer to the
451 child. Since a vfork parent is left frozen by the kernel until
452 the child execs or exits, a process can only have one vfork child
454 inferior *vfork_child = NULL;
456 /* True if this inferior should be detached when it's vfork sibling
458 bool pending_detach = false;
460 /* True if this inferior is a vfork parent waiting for a vfork child
461 not under our control to be done with the shared memory region,
462 either by exiting or execing. */
463 bool waiting_for_vfork_done = false;
465 /* True if we're in the process of detaching from this inferior. */
466 bool detaching = false;
468 /* What is left to do for an execution command after any thread of
469 this inferior stops. For continuations associated with a
470 specific thread, see `struct thread_info'. */
471 continuation *continuations = NULL;
473 /* True if setup_inferior wasn't called for this inferior yet.
474 Until that is done, we must not access inferior memory or
475 registers, as we haven't determined the target
476 architecture/description. */
477 bool needs_setup = false;
479 /* Private data used by the target vector implementation. */
480 std::unique_ptr<private_inferior> priv;
482 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
483 In this case, the EXIT_CODE field is also valid. */
484 bool has_exit_code = false;
485 LONGEST exit_code = 0;
487 /* Default flags to pass to the symbol reading functions. These are
488 used whenever a new objfile is created. */
489 symfile_add_flags symfile_flags = 0;
491 /* Info about an inferior's target description (if it's fetched; the
492 user supplied description's filename, if any; etc.). */
493 target_desc_info *tdesc_info = NULL;
495 /* The architecture associated with the inferior through the
496 connection to the target.
498 The architecture vector provides some information that is really
499 a property of the inferior, accessed through a particular target:
500 ptrace operations; the layout of certain RSP packets; the
501 solib_ops vector; etc. To differentiate architecture accesses to
502 per-inferior/target properties from
503 per-thread/per-frame/per-objfile properties, accesses to
504 per-inferior/target properties should be made through
506 struct gdbarch *gdbarch = NULL;
508 /* Data related to displaced stepping. */
509 displaced_step_inferior_state displaced_step_state;
511 /* Per inferior data-pointers required by other GDB modules. */
515 /* Keep a registry of per-inferior data-pointers required by other GDB
518 DECLARE_REGISTRY (inferior);
520 /* Add an inferior to the inferior list, print a message that a new
521 inferior is found, and return the pointer to the new inferior.
522 Caller may use this pointer to initialize the private inferior
524 extern struct inferior *add_inferior (int pid);
526 /* Same as add_inferior, but don't print new inferior notifications to
528 extern struct inferior *add_inferior_silent (int pid);
530 extern void delete_inferior (struct inferior *todel);
532 /* Delete an existing inferior list entry, due to inferior detaching. */
533 extern void detach_inferior (inferior *inf);
535 extern void exit_inferior (inferior *inf);
537 extern void exit_inferior_silent (inferior *inf);
539 extern void exit_inferior_num_silent (int num);
541 extern void inferior_appeared (struct inferior *inf, int pid);
543 /* Get rid of all inferiors. */
544 extern void discard_all_inferiors (void);
546 /* Search function to lookup an inferior by target 'pid'. */
547 extern struct inferior *find_inferior_pid (int pid);
549 /* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */
550 extern struct inferior *find_inferior_ptid (ptid_t ptid);
552 /* Search function to lookup an inferior by GDB 'num'. */
553 extern struct inferior *find_inferior_id (int num);
555 /* Find an inferior bound to PSPACE, giving preference to the current
557 extern struct inferior *
558 find_inferior_for_program_space (struct program_space *pspace);
560 /* Inferior iterator function.
562 Calls a callback function once for each inferior, so long as the
563 callback function returns false. If the callback function returns
564 true, the iteration will end and the current inferior will be
565 returned. This can be useful for implementing a search for a
566 inferior with arbitrary attributes, or for applying some operation
569 It is safe to delete the iterated inferior from the callback. */
570 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
574 /* Returns true if the inferior list is not empty. */
575 extern int have_inferiors (void);
577 /* Returns the number of live inferiors (real live processes). */
578 extern int number_of_live_inferiors (void);
580 /* Returns true if there are any live inferiors in the inferior list
581 (not cores, not executables, real live processes). */
582 extern int have_live_inferiors (void);
584 /* Save/restore the current inferior. */
586 class scoped_restore_current_inferior
589 scoped_restore_current_inferior ()
590 : m_saved_inf (current_inferior ())
593 ~scoped_restore_current_inferior ()
594 { set_current_inferior (m_saved_inf); }
596 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior);
599 inferior *m_saved_inf;
603 /* Traverse all inferiors. */
605 extern struct inferior *inferior_list;
607 /* Pull in the internals of the inferiors ranges and iterators. Must
608 be done after struct inferior is defined. */
609 #include "inferior-iter.h"
611 /* Return a range that can be used to walk over all inferiors
612 inferiors, with range-for, safely. I.e., it is safe to delete the
613 currently-iterated inferior. When combined with range-for, this
614 allow convenient patterns like this:
616 for (inferior *inf : all_inferiors_safe ())
617 if (some_condition ())
621 inline all_inferiors_safe_range
622 all_inferiors_safe ()
627 /* Returns a range representing all inferiors, suitable to use with
628 range-for, like this:
630 for (inferior *inf : all_inferiors ())
634 inline all_inferiors_range
640 /* Return a range that can be used to walk over all inferiors with PID
641 not zero, with range-for. */
643 inline all_non_exited_inferiors_range
644 all_non_exited_inferiors ()
649 /* Prune away automatically added inferiors that aren't required
651 extern void prune_inferiors (void);
653 extern int number_of_inferiors (void);
655 extern struct inferior *add_inferior_with_spaces (void);
657 /* Print the current selected inferior. */
658 extern void print_selected_inferior (struct ui_out *uiout);
660 #endif /* !defined (INFERIOR_H) */