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-2020 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 "gdbsupport/environ.h"
49 #include "progspace.h"
52 #include "symfile-add-flags.h"
53 #include "gdbsupport/refcounted-object.h"
54 #include "gdbsupport/forward-scope-exit.h"
56 #include "gdbsupport/common-inferior.h"
57 #include "gdbthread.h"
58 #include "thread-map.h"
60 #include "process-stratum-target.h"
62 struct infcall_suspend_state
;
63 struct infcall_control_state
;
65 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
66 extern void restore_infcall_control_state (struct infcall_control_state
*);
68 /* A deleter for infcall_suspend_state that calls
69 restore_infcall_suspend_state. */
70 struct infcall_suspend_state_deleter
72 void operator() (struct infcall_suspend_state
*state
) const
76 restore_infcall_suspend_state (state
);
78 catch (const gdb_exception_error
&e
)
80 /* If we are restoring the inferior state due to an exception,
81 some error message will be printed. So, only warn the user
82 when we cannot restore during normal execution. */
83 if (!std::uncaught_exception ())
84 warning (_("Failed to restore inferior state: %s"), e
.what ());
89 /* A unique_ptr specialization for infcall_suspend_state. */
90 typedef std::unique_ptr
<infcall_suspend_state
, infcall_suspend_state_deleter
>
91 infcall_suspend_state_up
;
93 extern infcall_suspend_state_up
save_infcall_suspend_state ();
95 /* A deleter for infcall_control_state that calls
96 restore_infcall_control_state. */
97 struct infcall_control_state_deleter
99 void operator() (struct infcall_control_state
*state
) const
101 restore_infcall_control_state (state
);
105 /* A unique_ptr specialization for infcall_control_state. */
106 typedef std::unique_ptr
<infcall_control_state
, infcall_control_state_deleter
>
107 infcall_control_state_up
;
109 extern infcall_control_state_up
save_infcall_control_state ();
111 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
112 extern void discard_infcall_control_state (struct infcall_control_state
*);
114 extern readonly_detached_regcache
*
115 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
117 extern void set_sigint_trap (void);
119 extern void clear_sigint_trap (void);
121 /* Set/get file name for default use for standard in/out in the inferior. */
123 extern void set_inferior_io_terminal (const char *terminal_name
);
124 extern const char *get_inferior_io_terminal (void);
126 /* Collected pid, tid, etc. of the debugged inferior. When there's
127 no inferior, inferior_ptid.pid () will be 0. */
129 extern ptid_t inferior_ptid
;
131 extern void generic_mourn_inferior (void);
133 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
135 const gdb_byte
*buf
);
136 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
137 struct type
*type
, gdb_byte
*buf
,
139 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
141 const gdb_byte
*buf
);
142 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
143 struct type
*type
, gdb_byte
*buf
,
146 extern void reopen_exec_file (void);
148 /* From misc files */
150 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
151 struct ui_file
*file
,
152 struct frame_info
*frame
,
153 int regnum
, int all
);
155 /* Default implementation of gdbarch_print_float_info. Print
156 the values of all floating point registers. */
158 extern void default_print_float_info (struct gdbarch
*gdbarch
,
159 struct ui_file
*file
,
160 struct frame_info
*frame
,
163 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
165 extern void child_terminal_ours (struct target_ops
*self
);
167 extern void child_terminal_ours_for_output (struct target_ops
*self
);
169 extern void child_terminal_inferior (struct target_ops
*self
);
171 extern void child_terminal_save_inferior (struct target_ops
*self
);
173 extern void child_terminal_init (struct target_ops
*self
);
175 extern void child_terminal_init_with_pgrp (int pgrp
);
177 extern void child_pass_ctrlc (struct target_ops
*self
);
179 extern void child_interrupt (struct target_ops
*self
);
181 /* From fork-child.c */
183 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
184 This function already calls set_executing. Return the ptid_t from
186 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
188 extern char *construct_inferior_arguments (int, char **);
192 /* Initial inferior setup. Determines the exec file is not yet known,
193 takes any necessary post-attaching actions, fetches the target
194 description and syncs the shared library list. */
196 extern void setup_inferior (int from_tty
);
198 extern void post_create_inferior (struct target_ops
*, int);
200 extern void attach_command (const char *, int);
202 extern const char *get_inferior_args (void);
204 extern void set_inferior_args (const char *);
206 extern void set_inferior_args_vector (int, char **);
208 extern void registers_info (const char *, int);
210 extern void continue_1 (int all_threads
);
212 extern void interrupt_target_1 (bool all_threads
);
214 using delete_longjmp_breakpoint_cleanup
215 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint
);
217 extern void detach_command (const char *, int);
219 extern void notice_new_inferior (struct thread_info
*, int, int);
221 extern struct value
*get_return_value (struct value
*function
,
222 struct type
*value_type
);
224 /* Prepare for execution command. TARGET is the target that will run
225 the command. BACKGROUND determines whether this is a foreground
226 (synchronous) or background (asynchronous) command. */
228 extern void prepare_execution_command (struct target_ops
*target
,
231 /* Nonzero if stopped due to completion of a stack dummy routine. */
233 extern enum stop_stack_kind stop_stack_dummy
;
235 /* Nonzero if program stopped due to a random (unexpected) signal in
238 extern int stopped_by_random_signal
;
240 /* Print notices on inferior events (attach, detach, etc.), set with
241 `set print inferior-events'. */
242 extern bool print_inferior_events
;
244 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
245 will handle it themselves. STOP_QUIETLY is used when running in
246 the shell before the child program has been exec'd and when running
247 through shared library loading. STOP_QUIETLY_REMOTE is used when
248 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
249 except that there is no need to hide a signal. */
251 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
252 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
253 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
254 a ptraced process has changed. Earlier versions of the kernel
255 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
256 other signal, i.e. it is not muffled.
258 If the gdb user does a 'continue' after the 'attach', gdb passes
259 the global variable stop_signal (which stores the signal from the
260 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
261 problematic, because the kernel doesn't ignore such SIGSTOP
262 now. I.e. it is reported back to gdb, which in turn presents it
265 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
266 gdb to clear the value of stop_signal after the attach, so that it
267 is not passed back down to the kernel. */
274 STOP_QUIETLY_NO_SIGSTOP
278 /* Possible values for gdbarch_call_dummy_location. */
280 #define AT_ENTRY_POINT 4
282 /* Base class for target-specific inferior data. */
284 struct private_inferior
286 virtual ~private_inferior () = 0;
289 /* Inferior process specific part of `struct infcall_control_state'.
291 Inferior thread counterpart is `struct thread_control_state'. */
293 struct inferior_control_state
295 inferior_control_state ()
296 : stop_soon (NO_STOP_QUIETLY
)
300 explicit inferior_control_state (enum stop_kind when
)
305 /* See the definition of stop_kind above. */
306 enum stop_kind stop_soon
;
309 /* Return a pointer to the current inferior. */
310 extern inferior
*current_inferior ();
312 extern void set_current_inferior (inferior
*);
314 /* Switch inferior (and program space) to INF, and switch to no thread
316 extern void switch_to_inferior_no_thread (inferior
*inf
);
318 /* GDB represents the state of each program execution with an object
319 called an inferior. An inferior typically corresponds to a process
320 but is more general and applies also to targets that do not have a
321 notion of processes. Each run of an executable creates a new
322 inferior, as does each attachment to an existing process.
323 Inferiors have unique internal identifiers that are different from
324 target process ids. Each inferior may in turn have multiple
325 threads running in it.
327 Inferiors are intrusively refcounted objects. Unlike thread
328 objects, being the user-selected inferior is considered a strong
329 reference and is thus accounted for in the inferior object's
330 refcount (see set_current_inferior). When GDB needs to remember
331 the selected inferior to later restore it, GDB temporarily bumps
332 the inferior object's refcount, to prevent something deleting the
333 inferior object before reverting back (e.g., due to a
334 "remove-inferiors" command (see
335 scoped_restore_current_inferior). All other inferior
336 references are considered weak references. Inferiors are always
337 listed exactly once in the inferior list, so placing an inferior in
338 the inferior list is an implicit, not counted strong reference. */
340 class inferior
: public refcounted_object
343 explicit inferior (int pid
);
346 /* Returns true if we can delete this inferior. */
347 bool deletable () const { return refcount () == 0; }
349 /* Push T in this inferior's target stack. */
350 void push_target (struct target_ops
*t
)
351 { m_target_stack
.push (t
); }
353 /* Unpush T from this inferior's target stack. */
354 int unpush_target (struct target_ops
*t
)
355 { return m_target_stack
.unpush (t
); }
357 /* Returns true if T is pushed in this inferior's target stack. */
358 bool target_is_pushed (target_ops
*t
)
359 { return m_target_stack
.is_pushed (t
); }
361 /* Find the target beneath T in this inferior's target stack. */
362 target_ops
*find_target_beneath (const target_ops
*t
)
363 { return m_target_stack
.find_beneath (t
); }
365 /* Return the target at the top of this inferior's target stack. */
366 target_ops
*top_target ()
367 { return m_target_stack
.top (); }
369 /* Return the target at process_stratum level in this inferior's
371 struct process_stratum_target
*process_target ()
372 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
374 /* Return the target at STRATUM in this inferior's target stack. */
375 target_ops
*target_at (enum strata stratum
)
376 { return m_target_stack
.at (stratum
); }
378 bool has_execution ()
379 { return target_has_execution_1 (this); }
381 /* Pointer to next inferior in singly-linked list of inferiors. */
382 struct inferior
*next
= NULL
;
384 /* This inferior's thread list. */
385 ptid_thread_map thread_map
;
387 /* Returns a range adapter covering the inferior's threads,
388 including exited threads. Used like this:
390 for (thread_info *thr : inf->threads ())
393 all_thread_map_range
threads ()
394 { return all_thread_map_range (this->thread_map
); }
396 /* Returns a range adapter covering the inferior's non-exited
397 threads. Used like this:
399 for (thread_info *thr : inf->non_exited_threads ())
402 non_exited_thread_map_range
non_exited_threads ()
403 { return non_exited_thread_map_range (this->thread_map
); }
405 /* Convenient handle (GDB inferior id). Unique across all
409 /* Actual target inferior id, usually, a process id. This matches
410 the ptid_t.pid member of threads of this inferior. */
412 /* True if the PID was actually faked by GDB. */
413 bool fake_pid_p
= false;
415 /* The highest thread number this inferior ever had. */
416 int highest_thread_num
= 0;
418 /* State of GDB control of inferior process execution.
419 See `struct inferior_control_state'. */
420 inferior_control_state control
;
422 /* True if this was an auto-created inferior, e.g. created from
423 following a fork; false, if this inferior was manually added by
424 the user, and we should not attempt to prune it
426 bool removable
= false;
428 /* The address space bound to this inferior. */
429 struct address_space
*aspace
= NULL
;
431 /* The program space bound to this inferior. */
432 struct program_space
*pspace
= NULL
;
434 /* The arguments string to use when running. */
437 /* The size of elements in argv. */
440 /* The vector version of arguments. If ARGC is nonzero,
441 then we must compute ARGS from this (via the target).
442 This is always coming from main's argv and therefore
443 should never be freed. */
446 /* The current working directory that will be used when starting
448 gdb::unique_xmalloc_ptr
<char> cwd
;
450 /* The name of terminal device to use for I/O. */
451 char *terminal
= NULL
;
453 /* The terminal state as set by the last target_terminal::terminal_*
455 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
457 /* Environment to use for running inferior,
458 in format described in environ.h. */
459 gdb_environ environment
;
461 /* True if this child process was attached rather than forked. */
462 bool attach_flag
= false;
464 /* If this inferior is a vfork child, then this is the pointer to
465 its vfork parent, if GDB is still attached to it. */
466 inferior
*vfork_parent
= NULL
;
468 /* If this process is a vfork parent, this is the pointer to the
469 child. Since a vfork parent is left frozen by the kernel until
470 the child execs or exits, a process can only have one vfork child
472 inferior
*vfork_child
= NULL
;
474 /* True if this inferior should be detached when it's vfork sibling
476 bool pending_detach
= false;
478 /* True if this inferior is a vfork parent waiting for a vfork child
479 not under our control to be done with the shared memory region,
480 either by exiting or execing. */
481 bool waiting_for_vfork_done
= false;
483 /* True if we're in the process of detaching from this inferior. */
484 bool detaching
= false;
486 /* What is left to do for an execution command after any thread of
487 this inferior stops. For continuations associated with a
488 specific thread, see `struct thread_info'. */
489 continuation
*continuations
= NULL
;
491 /* True if setup_inferior wasn't called for this inferior yet.
492 Until that is done, we must not access inferior memory or
493 registers, as we haven't determined the target
494 architecture/description. */
495 bool needs_setup
= false;
497 /* Private data used by the target vector implementation. */
498 std::unique_ptr
<private_inferior
> priv
;
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. */
502 bool has_exit_code
= false;
503 LONGEST exit_code
= 0;
505 /* Default flags to pass to the symbol reading functions. These are
506 used whenever a new objfile is created. */
507 symfile_add_flags symfile_flags
= 0;
509 /* Info about an inferior's target description (if it's fetched; the
510 user supplied description's filename, if any; etc.). */
511 target_desc_info
*tdesc_info
= NULL
;
513 /* The architecture associated with the inferior through the
514 connection to the target.
516 The architecture vector provides some information that is really
517 a property of the inferior, accessed through a particular target:
518 ptrace operations; the layout of certain RSP packets; the
519 solib_ops vector; etc. To differentiate architecture accesses to
520 per-inferior/target properties from
521 per-thread/per-frame/per-objfile properties, accesses to
522 per-inferior/target properties should be made through
524 struct gdbarch
*gdbarch
= NULL
;
526 /* Data related to displaced stepping. */
527 displaced_step_inferior_state displaced_step_state
;
529 /* Per inferior data-pointers required by other GDB modules. */
533 /* The inferior's target stack. */
534 target_stack m_target_stack
;
537 /* Keep a registry of per-inferior data-pointers required by other GDB
540 DECLARE_REGISTRY (inferior
);
542 /* Add an inferior to the inferior list, print a message that a new
543 inferior is found, and return the pointer to the new inferior.
544 Caller may use this pointer to initialize the private inferior
546 extern struct inferior
*add_inferior (int pid
);
548 /* Same as add_inferior, but don't print new inferior notifications to
550 extern struct inferior
*add_inferior_silent (int pid
);
552 extern void delete_inferior (struct inferior
*todel
);
554 /* Delete an existing inferior list entry, due to inferior detaching. */
555 extern void detach_inferior (inferior
*inf
);
557 extern void exit_inferior (inferior
*inf
);
559 extern void exit_inferior_silent (inferior
*inf
);
561 extern void exit_inferior_num_silent (int num
);
563 extern void inferior_appeared (struct inferior
*inf
, int pid
);
565 /* Search function to lookup an inferior of TARG by target 'pid'. */
566 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
569 /* Search function to lookup an inferior of TARG whose pid is equal to
571 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
574 /* Search function to lookup an inferior by GDB 'num'. */
575 extern struct inferior
*find_inferior_id (int num
);
577 /* Find an inferior bound to PSPACE, giving preference to the current
579 extern struct inferior
*
580 find_inferior_for_program_space (struct program_space
*pspace
);
582 /* Inferior iterator function.
584 Calls a callback function once for each inferior, so long as the
585 callback function returns false. If the callback function returns
586 true, the iteration will end and the current inferior will be
587 returned. This can be useful for implementing a search for a
588 inferior with arbitrary attributes, or for applying some operation
591 It is safe to delete the iterated inferior from the callback. */
592 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
596 /* Returns true if the inferior list is not empty. */
597 extern int have_inferiors (void);
599 /* Returns the number of live inferiors running on PROC_TARGET (real
600 live processes with execution). */
601 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
603 /* Returns true if there are any live inferiors in the inferior list
604 (not cores, not executables, real live processes). */
605 extern int have_live_inferiors (void);
607 /* Save/restore the current inferior. */
609 class scoped_restore_current_inferior
612 scoped_restore_current_inferior ()
613 : m_saved_inf (current_inferior ())
616 ~scoped_restore_current_inferior ()
617 { set_current_inferior (m_saved_inf
); }
619 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
622 inferior
*m_saved_inf
;
626 /* Traverse all inferiors. */
628 extern struct inferior
*inferior_list
;
630 /* Pull in the internals of the inferiors ranges and iterators. Must
631 be done after struct inferior is defined. */
632 #include "inferior-iter.h"
634 /* Return a range that can be used to walk over all inferiors
635 inferiors, with range-for, safely. I.e., it is safe to delete the
636 currently-iterated inferior. When combined with range-for, this
637 allow convenient patterns like this:
639 for (inferior *inf : all_inferiors_safe ())
640 if (some_condition ())
644 inline all_inferiors_safe_range
645 all_inferiors_safe ()
650 /* Returns a range representing all inferiors, suitable to use with
651 range-for, like this:
653 for (inferior *inf : all_inferiors ())
657 inline all_inferiors_range
658 all_inferiors (process_stratum_target
*proc_target
= nullptr)
660 return all_inferiors_range (proc_target
);
663 /* Return a range that can be used to walk over all inferiors with PID
664 not zero, with range-for. */
666 inline all_non_exited_inferiors_range
667 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
669 return all_non_exited_inferiors_range (proc_target
);
672 /* Prune away automatically added inferiors that aren't required
674 extern void prune_inferiors (void);
676 extern int number_of_inferiors (void);
678 extern struct inferior
*add_inferior_with_spaces (void);
680 /* Print the current selected inferior. */
681 extern void print_selected_inferior (struct ui_out
*uiout
);
683 #endif /* !defined (INFERIOR_H) */