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-2022 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)
27 struct target_waitstatus
;
35 struct target_desc_info
;
40 #include "breakpoint.h"
42 /* For enum gdb_signal. */
45 /* For struct frame_id. */
48 /* For gdb_environ. */
49 #include "gdbsupport/environ.h"
51 #include "progspace.h"
54 #include "symfile-add-flags.h"
55 #include "gdbsupport/refcounted-object.h"
56 #include "gdbsupport/forward-scope-exit.h"
57 #include "gdbsupport/gdb_unique_ptr.h"
58 #include "gdbsupport/intrusive_list.h"
60 #include "gdbsupport/common-inferior.h"
61 #include "gdbthread.h"
63 #include "process-stratum-target.h"
64 #include "displaced-stepping.h"
66 #include <unordered_map>
68 struct infcall_suspend_state
;
69 struct infcall_control_state
;
71 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
72 extern void restore_infcall_control_state (struct infcall_control_state
*);
74 /* A deleter for infcall_suspend_state that calls
75 restore_infcall_suspend_state. */
76 struct infcall_suspend_state_deleter
78 void operator() (struct infcall_suspend_state
*state
) const
82 restore_infcall_suspend_state (state
);
84 catch (const gdb_exception_error
&e
)
86 /* If we are restoring the inferior state due to an exception,
87 some error message will be printed. So, only warn the user
88 when we cannot restore during normal execution. */
90 #if __cpp_lib_uncaught_exceptions
91 unwinding
= std::uncaught_exceptions () > 0;
93 unwinding
= std::uncaught_exception ();
96 warning (_("Failed to restore inferior state: %s"), e
.what ());
101 /* A unique_ptr specialization for infcall_suspend_state. */
102 typedef std::unique_ptr
<infcall_suspend_state
, infcall_suspend_state_deleter
>
103 infcall_suspend_state_up
;
105 extern infcall_suspend_state_up
save_infcall_suspend_state ();
107 /* A deleter for infcall_control_state that calls
108 restore_infcall_control_state. */
109 struct infcall_control_state_deleter
111 void operator() (struct infcall_control_state
*state
) const
113 restore_infcall_control_state (state
);
117 /* A unique_ptr specialization for infcall_control_state. */
118 typedef std::unique_ptr
<infcall_control_state
, infcall_control_state_deleter
>
119 infcall_control_state_up
;
121 extern infcall_control_state_up
save_infcall_control_state ();
123 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
124 extern void discard_infcall_control_state (struct infcall_control_state
*);
126 extern readonly_detached_regcache
*
127 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
129 extern void set_sigint_trap (void);
131 extern void clear_sigint_trap (void);
133 /* Collected pid, tid, etc. of the debugged inferior. When there's
134 no inferior, inferior_ptid.pid () will be 0. */
136 extern ptid_t inferior_ptid
;
138 extern void generic_mourn_inferior (void);
140 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
142 const gdb_byte
*buf
);
143 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
144 struct type
*type
, gdb_byte
*buf
,
146 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
148 const gdb_byte
*buf
);
149 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
150 struct type
*type
, gdb_byte
*buf
,
153 extern void reopen_exec_file (void);
155 /* From misc files */
157 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
158 struct ui_file
*file
,
159 frame_info_ptr frame
,
160 int regnum
, int all
);
162 /* Default implementation of gdbarch_print_float_info. Print
163 the values of all floating point registers. */
165 extern void default_print_float_info (struct gdbarch
*gdbarch
,
166 struct ui_file
*file
,
167 frame_info_ptr frame
,
170 /* Try to determine whether TTY is GDB's input terminal. Returns
171 TRIBOOL_UNKNOWN if we can't tell. */
173 extern tribool
is_gdb_terminal (const char *tty
);
175 /* Helper for sharing_input_terminal. Try to determine whether pid
176 PID is using the same TTY for input as GDB is. Returns
177 TRIBOOL_UNKNOWN if we can't tell. */
179 extern tribool
sharing_input_terminal (int pid
);
181 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
183 extern void child_terminal_ours (struct target_ops
*self
);
185 extern void child_terminal_ours_for_output (struct target_ops
*self
);
187 extern void child_terminal_inferior (struct target_ops
*self
);
189 extern void child_terminal_save_inferior (struct target_ops
*self
);
191 extern void child_terminal_init (struct target_ops
*self
);
193 extern void child_terminal_init_with_pgrp (int pgrp
);
195 extern void child_pass_ctrlc (struct target_ops
*self
);
197 extern void child_interrupt (struct target_ops
*self
);
199 /* From fork-child.c */
201 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
202 This function already calls set_executing. Return the ptid_t from
204 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
208 /* Initial inferior setup. Determines the exec file is not yet known,
209 takes any necessary post-attaching actions, fetches the target
210 description and syncs the shared library list. */
212 extern void setup_inferior (int from_tty
);
214 extern void post_create_inferior (int from_tty
);
216 extern void attach_command (const char *, int);
218 extern void set_inferior_args_vector (int, char **);
220 extern void registers_info (const char *, int);
222 extern void continue_1 (int all_threads
);
224 extern void interrupt_target_1 (bool all_threads
);
226 using delete_longjmp_breakpoint_cleanup
227 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint
);
229 extern void detach_command (const char *, int);
231 extern void notice_new_inferior (struct thread_info
*, bool, int);
233 /* Return the value of the result of a function at the end of a 'finish'
234 command/BP. If the result's value cannot be retrieved, return NULL.
236 FUNC_SYMBOL is the symbol of the function being returned from. FUNCTION is
237 a value containing the address of the function. */
239 extern struct value
*get_return_value (struct symbol
*func_symbol
,
240 struct value
*function
);
242 /* Prepare for execution command. TARGET is the target that will run
243 the command. BACKGROUND determines whether this is a foreground
244 (synchronous) or background (asynchronous) command. */
246 extern void prepare_execution_command (struct target_ops
*target
,
249 /* Nonzero if stopped due to completion of a stack dummy routine. */
251 extern enum stop_stack_kind stop_stack_dummy
;
253 /* Nonzero if program stopped due to a random (unexpected) signal in
256 extern int stopped_by_random_signal
;
258 /* Print notices on inferior events (attach, detach, etc.), set with
259 `set print inferior-events'. */
260 extern bool print_inferior_events
;
262 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
263 will handle it themselves. STOP_QUIETLY is used when running in
264 the shell before the child program has been exec'd and when running
265 through shared library loading. STOP_QUIETLY_REMOTE is used when
266 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
267 except that there is no need to hide a signal. */
269 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
270 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
271 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
272 a ptraced process has changed. Earlier versions of the kernel
273 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
274 other signal, i.e. it is not muffled.
276 If the gdb user does a 'continue' after the 'attach', gdb passes
277 the global variable stop_signal (which stores the signal from the
278 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
279 problematic, because the kernel doesn't ignore such SIGSTOP
280 now. I.e. it is reported back to gdb, which in turn presents it
283 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
284 gdb to clear the value of stop_signal after the attach, so that it
285 is not passed back down to the kernel. */
292 STOP_QUIETLY_NO_SIGSTOP
297 /* Base class for target-specific inferior data. */
299 struct private_inferior
301 virtual ~private_inferior () = 0;
304 /* Inferior process specific part of `struct infcall_control_state'.
306 Inferior thread counterpart is `struct thread_control_state'. */
308 struct inferior_control_state
310 inferior_control_state ()
311 : stop_soon (NO_STOP_QUIETLY
)
315 explicit inferior_control_state (enum stop_kind when
)
320 /* See the definition of stop_kind above. */
321 enum stop_kind stop_soon
;
324 /* Return a pointer to the current inferior. */
325 extern inferior
*current_inferior ();
327 extern void set_current_inferior (inferior
*);
329 /* Switch inferior (and program space) to INF, and switch to no thread
331 extern void switch_to_inferior_no_thread (inferior
*inf
);
333 /* GDB represents the state of each program execution with an object
334 called an inferior. An inferior typically corresponds to a process
335 but is more general and applies also to targets that do not have a
336 notion of processes. Each run of an executable creates a new
337 inferior, as does each attachment to an existing process.
338 Inferiors have unique internal identifiers that are different from
339 target process ids. Each inferior may in turn have multiple
340 threads running in it.
342 Inferiors are intrusively refcounted objects. Unlike thread
343 objects, being the user-selected inferior is considered a strong
344 reference and is thus accounted for in the inferior object's
345 refcount (see set_current_inferior). When GDB needs to remember
346 the selected inferior to later restore it, GDB temporarily bumps
347 the inferior object's refcount, to prevent something deleting the
348 inferior object before reverting back (e.g., due to a
349 "remove-inferiors" command (see
350 scoped_restore_current_inferior). All other inferior
351 references are considered weak references. Inferiors are always
352 listed exactly once in the inferior list, so placing an inferior in
353 the inferior list is an implicit, not counted strong reference. */
355 class inferior
: public refcounted_object
,
356 public intrusive_list_node
<inferior
>
359 explicit inferior (int pid
);
362 /* Returns true if we can delete this inferior. */
363 bool deletable () const { return refcount () == 0; }
365 /* Push T in this inferior's target stack. */
366 void push_target (struct target_ops
*t
)
367 { m_target_stack
.push (t
); }
369 /* An overload that deletes the target on failure. */
370 void push_target (target_ops_up
&&t
)
372 m_target_stack
.push (t
.get ());
376 /* Unpush T from this inferior's target stack. */
377 int unpush_target (struct target_ops
*t
);
379 /* Returns true if T is pushed in this inferior's target stack. */
380 bool target_is_pushed (const target_ops
*t
) const
381 { return m_target_stack
.is_pushed (t
); }
383 /* Find the target beneath T in this inferior's target stack. */
384 target_ops
*find_target_beneath (const target_ops
*t
)
385 { return m_target_stack
.find_beneath (t
); }
387 /* Return the target at the top of this inferior's target stack. */
388 target_ops
*top_target ()
389 { return m_target_stack
.top (); }
391 /* Return the target at process_stratum level in this inferior's
393 struct process_stratum_target
*process_target ()
394 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
396 /* Return the target at STRATUM in this inferior's target stack. */
397 target_ops
*target_at (enum strata stratum
)
398 { return m_target_stack
.at (stratum
); }
400 bool has_execution ()
401 { return target_has_execution (this); }
403 /* This inferior's thread list, sorted by creation order. */
404 intrusive_list
<thread_info
> thread_list
;
406 /* A map of ptid_t to thread_info*, for average O(1) ptid_t lookup.
407 Exited threads do not appear in the map. */
408 std::unordered_map
<ptid_t
, thread_info
*, hash_ptid
> ptid_thread_map
;
410 /* Returns a range adapter covering the inferior's threads,
411 including exited threads. Used like this:
413 for (thread_info *thr : inf->threads ())
416 inf_threads_range
threads ()
417 { return inf_threads_range (this->thread_list
.begin ()); }
419 /* Returns a range adapter covering the inferior's non-exited
420 threads. Used like this:
422 for (thread_info *thr : inf->non_exited_threads ())
425 inf_non_exited_threads_range
non_exited_threads ()
426 { return inf_non_exited_threads_range (this->thread_list
.begin ()); }
428 /* Like inferior::threads(), but returns a range adapter that can be
429 used with range-for, safely. I.e., it is safe to delete the
430 currently-iterated thread, like this:
432 for (thread_info *t : inf->threads_safe ())
433 if (some_condition ())
436 inline safe_inf_threads_range
threads_safe ()
437 { return safe_inf_threads_range (this->thread_list
.begin ()); }
439 /* Delete all threads in the thread list. If SILENT, exit threads
441 void clear_thread_list (bool silent
);
443 /* Continuations-related methods. A continuation is an std::function
444 to be called to finish the execution of a command when running
445 GDB asynchronously. A continuation is executed after any thread
446 of this inferior stops. Continuations are used by the attach
447 command and the remote target when a new inferior is detected. */
448 void add_continuation (std::function
<void ()> &&cont
);
449 void do_all_continuations ();
451 /* Set/get file name for default use for standard in/out in the inferior.
453 On Unix systems, we try to make TERMINAL_NAME the inferior's controlling
456 If TERMINAL_NAME is the empty string, then the inferior inherits GDB's
457 terminal (or GDBserver's if spawning a remote process). */
458 void set_tty (std::string terminal_name
);
459 const std::string
&tty ();
461 /* Set the argument string to use when running this inferior.
463 An empty string can be used to represent "no arguments". */
464 void set_args (std::string args
)
466 m_args
= std::move (args
);
469 /* Get the argument string to use when running this inferior.
471 No arguments is represented by an empty string. */
472 const std::string
&args () const
477 /* Set the inferior current working directory.
479 If CWD is empty, unset the directory. */
480 void set_cwd (std::string cwd
)
482 m_cwd
= std::move (cwd
);
485 /* Get the inferior current working directory.
487 Return an empty string if the current working directory is not
489 const std::string
&cwd () const
494 /* Convenient handle (GDB inferior id). Unique across all
498 /* Actual target inferior id, usually, a process id. This matches
499 the ptid_t.pid member of threads of this inferior. */
501 /* True if the PID was actually faked by GDB. */
502 bool fake_pid_p
= false;
504 /* The highest thread number this inferior ever had. */
505 int highest_thread_num
= 0;
507 /* State of GDB control of inferior process execution.
508 See `struct inferior_control_state'. */
509 inferior_control_state control
;
511 /* True if this was an auto-created inferior, e.g. created from
512 following a fork; false, if this inferior was manually added by
513 the user, and we should not attempt to prune it
515 bool removable
= false;
517 /* The address space bound to this inferior. */
518 struct address_space
*aspace
= NULL
;
520 /* The program space bound to this inferior. */
521 struct program_space
*pspace
= NULL
;
523 /* The terminal state as set by the last target_terminal::terminal_*
525 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
527 /* Environment to use for running inferior,
528 in format described in environ.h. */
529 gdb_environ environment
;
531 /* True if this child process was attached rather than forked. */
532 bool attach_flag
= false;
534 /* If this inferior is a vfork child, then this is the pointer to
535 its vfork parent, if GDB is still attached to it. */
536 inferior
*vfork_parent
= NULL
;
538 /* If this process is a vfork parent, this is the pointer to the
539 child. Since a vfork parent is left frozen by the kernel until
540 the child execs or exits, a process can only have one vfork child
542 inferior
*vfork_child
= NULL
;
544 /* True if this inferior should be detached when it's vfork sibling
546 bool pending_detach
= false;
548 /* If non-nullptr, points to a thread that called vfork and is now waiting
549 for a vfork child not under our control to be done with the shared memory
550 region, either by exiting or execing. */
551 thread_info
*thread_waiting_for_vfork_done
= nullptr;
553 /* True if we're in the process of detaching from this inferior. */
554 bool detaching
= false;
556 /* True if setup_inferior wasn't called for this inferior yet.
557 Until that is done, we must not access inferior memory or
558 registers, as we haven't determined the target
559 architecture/description. */
560 bool needs_setup
= false;
562 /* True if the inferior is starting up (inside startup_inferior),
563 and we're nursing it along (through the shell) until it is ready
564 to execute its first instruction. Until that is done, we must
565 not access inferior memory or registers, as we haven't determined
566 the target architecture/description. */
567 bool starting_up
= false;
569 /* True when we are reading the library list of the inferior during an
570 attach or handling a fork child. */
571 bool in_initial_library_scan
= false;
573 /* Private data used by the target vector implementation. */
574 std::unique_ptr
<private_inferior
> priv
;
576 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
577 In this case, the EXIT_CODE field is also valid. */
578 bool has_exit_code
= false;
579 LONGEST exit_code
= 0;
581 /* Default flags to pass to the symbol reading functions. These are
582 used whenever a new objfile is created. */
583 symfile_add_flags symfile_flags
= 0;
585 /* Info about an inferior's target description (if it's fetched; the
586 user supplied description's filename, if any; etc.). */
587 target_desc_info
*tdesc_info
= NULL
;
589 /* The architecture associated with the inferior through the
590 connection to the target.
592 The architecture vector provides some information that is really
593 a property of the inferior, accessed through a particular target:
594 ptrace operations; the layout of certain RSP packets; the
595 solib_ops vector; etc. To differentiate architecture accesses to
596 per-inferior/target properties from
597 per-thread/per-frame/per-objfile properties, accesses to
598 per-inferior/target properties should be made through
600 struct gdbarch
*gdbarch
= NULL
;
602 /* Data related to displaced stepping. */
603 displaced_step_inferior_state displaced_step_state
;
605 /* Per inferior data-pointers required by other GDB modules. */
606 registry
<inferior
> registry_fields
;
609 /* The inferior's target stack. */
610 target_stack m_target_stack
;
612 /* The name of terminal device to use for I/O. */
613 std::string m_terminal
;
615 /* The list of continuations. */
616 std::list
<std::function
<void ()>> m_continuations
;
618 /* The arguments string to use when running. */
621 /* The current working directory that will be used when starting
626 /* Add an inferior to the inferior list, print a message that a new
627 inferior is found, and return the pointer to the new inferior.
628 Caller may use this pointer to initialize the private inferior
630 extern struct inferior
*add_inferior (int pid
);
632 /* Same as add_inferior, but don't print new inferior notifications to
634 extern struct inferior
*add_inferior_silent (int pid
);
636 extern void delete_inferior (struct inferior
*todel
);
638 /* Delete an existing inferior list entry, due to inferior detaching. */
639 extern void detach_inferior (inferior
*inf
);
641 extern void exit_inferior (inferior
*inf
);
643 extern void exit_inferior_silent (inferior
*inf
);
645 extern void exit_inferior_num_silent (int num
);
647 extern void inferior_appeared (struct inferior
*inf
, int pid
);
649 /* Search function to lookup an inferior of TARG by target 'pid'. */
650 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
653 /* Search function to lookup an inferior of TARG whose pid is equal to
655 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
658 /* Search function to lookup an inferior by GDB 'num'. */
659 extern struct inferior
*find_inferior_id (int num
);
661 /* Find an inferior bound to PSPACE, giving preference to the current
663 extern struct inferior
*
664 find_inferior_for_program_space (struct program_space
*pspace
);
666 /* Returns true if the inferior list is not empty. */
667 extern int have_inferiors (void);
669 /* Returns the number of live inferiors running on PROC_TARGET (real
670 live processes with execution). */
671 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
673 /* Returns true if there are any live inferiors in the inferior list
674 (not cores, not executables, real live processes). */
675 extern int have_live_inferiors (void);
677 /* Save/restore the current inferior. */
679 class scoped_restore_current_inferior
682 scoped_restore_current_inferior ()
683 : m_saved_inf (current_inferior ())
686 ~scoped_restore_current_inferior ()
687 { set_current_inferior (m_saved_inf
); }
689 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
692 inferior
*m_saved_inf
;
696 /* Traverse all inferiors. */
698 extern intrusive_list
<inferior
> inferior_list
;
700 /* Pull in the internals of the inferiors ranges and iterators. Must
701 be done after struct inferior is defined. */
702 #include "inferior-iter.h"
704 /* Return a range that can be used to walk over all inferiors
705 inferiors, with range-for, safely. I.e., it is safe to delete the
706 currently-iterated inferior. When combined with range-for, this
707 allow convenient patterns like this:
709 for (inferior *inf : all_inferiors_safe ())
710 if (some_condition ())
714 inline all_inferiors_safe_range
715 all_inferiors_safe ()
717 return all_inferiors_safe_range (nullptr, inferior_list
);
720 /* Returns a range representing all inferiors, suitable to use with
721 range-for, like this:
723 for (inferior *inf : all_inferiors ())
727 inline all_inferiors_range
728 all_inferiors (process_stratum_target
*proc_target
= nullptr)
730 return all_inferiors_range (proc_target
, inferior_list
);
733 /* Return a range that can be used to walk over all inferiors with PID
734 not zero, with range-for. */
736 inline all_non_exited_inferiors_range
737 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
739 return all_non_exited_inferiors_range (proc_target
, inferior_list
);
742 /* Prune away automatically added inferiors that aren't required
744 extern void prune_inferiors (void);
746 extern int number_of_inferiors (void);
748 extern struct inferior
*add_inferior_with_spaces (void);
750 /* Print the current selected inferior. */
751 extern void print_selected_inferior (struct ui_out
*uiout
);
753 /* Switch to inferior NEW_INF, a new inferior, and unless
754 NO_CONNECTION is true, push the process_stratum_target of ORG_INF
757 extern void switch_to_inferior_and_push_target
758 (inferior
*new_inf
, bool no_connection
, inferior
*org_inf
);
760 #endif /* !defined (INFERIOR_H) */