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-2021 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 struct frame_info
*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 struct frame_info
*frame
,
170 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
172 extern void child_terminal_ours (struct target_ops
*self
);
174 extern void child_terminal_ours_for_output (struct target_ops
*self
);
176 extern void child_terminal_inferior (struct target_ops
*self
);
178 extern void child_terminal_save_inferior (struct target_ops
*self
);
180 extern void child_terminal_init (struct target_ops
*self
);
182 extern void child_terminal_init_with_pgrp (int pgrp
);
184 extern void child_pass_ctrlc (struct target_ops
*self
);
186 extern void child_interrupt (struct target_ops
*self
);
188 /* From fork-child.c */
190 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
191 This function already calls set_executing. Return the ptid_t from
193 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
197 /* Initial inferior setup. Determines the exec file is not yet known,
198 takes any necessary post-attaching actions, fetches the target
199 description and syncs the shared library list. */
201 extern void setup_inferior (int from_tty
);
203 extern void post_create_inferior (int from_tty
);
205 extern void attach_command (const char *, int);
207 extern void set_inferior_args_vector (int, char **);
209 extern void registers_info (const char *, int);
211 extern void continue_1 (int all_threads
);
213 extern void interrupt_target_1 (bool all_threads
);
215 using delete_longjmp_breakpoint_cleanup
216 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint
);
218 extern void detach_command (const char *, int);
220 extern void notice_new_inferior (struct thread_info
*, bool, int);
222 extern struct value
*get_return_value (struct value
*function
,
223 struct type
*value_type
);
225 /* Prepare for execution command. TARGET is the target that will run
226 the command. BACKGROUND determines whether this is a foreground
227 (synchronous) or background (asynchronous) command. */
229 extern void prepare_execution_command (struct target_ops
*target
,
232 /* Nonzero if stopped due to completion of a stack dummy routine. */
234 extern enum stop_stack_kind stop_stack_dummy
;
236 /* Nonzero if program stopped due to a random (unexpected) signal in
239 extern int stopped_by_random_signal
;
241 /* Print notices on inferior events (attach, detach, etc.), set with
242 `set print inferior-events'. */
243 extern bool print_inferior_events
;
245 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
246 will handle it themselves. STOP_QUIETLY is used when running in
247 the shell before the child program has been exec'd and when running
248 through shared library loading. STOP_QUIETLY_REMOTE is used when
249 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
250 except that there is no need to hide a signal. */
252 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
253 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
254 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
255 a ptraced process has changed. Earlier versions of the kernel
256 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
257 other signal, i.e. it is not muffled.
259 If the gdb user does a 'continue' after the 'attach', gdb passes
260 the global variable stop_signal (which stores the signal from the
261 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
262 problematic, because the kernel doesn't ignore such SIGSTOP
263 now. I.e. it is reported back to gdb, which in turn presents it
266 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
267 gdb to clear the value of stop_signal after the attach, so that it
268 is not passed back down to the kernel. */
275 STOP_QUIETLY_NO_SIGSTOP
279 /* Possible values for gdbarch_call_dummy_location. */
281 #define AT_ENTRY_POINT 4
283 /* Base class for target-specific inferior data. */
285 struct private_inferior
287 virtual ~private_inferior () = 0;
290 /* Inferior process specific part of `struct infcall_control_state'.
292 Inferior thread counterpart is `struct thread_control_state'. */
294 struct inferior_control_state
296 inferior_control_state ()
297 : stop_soon (NO_STOP_QUIETLY
)
301 explicit inferior_control_state (enum stop_kind when
)
306 /* See the definition of stop_kind above. */
307 enum stop_kind stop_soon
;
310 /* Return a pointer to the current inferior. */
311 extern inferior
*current_inferior ();
313 extern void set_current_inferior (inferior
*);
315 /* Switch inferior (and program space) to INF, and switch to no thread
317 extern void switch_to_inferior_no_thread (inferior
*inf
);
319 /* GDB represents the state of each program execution with an object
320 called an inferior. An inferior typically corresponds to a process
321 but is more general and applies also to targets that do not have a
322 notion of processes. Each run of an executable creates a new
323 inferior, as does each attachment to an existing process.
324 Inferiors have unique internal identifiers that are different from
325 target process ids. Each inferior may in turn have multiple
326 threads running in it.
328 Inferiors are intrusively refcounted objects. Unlike thread
329 objects, being the user-selected inferior is considered a strong
330 reference and is thus accounted for in the inferior object's
331 refcount (see set_current_inferior). When GDB needs to remember
332 the selected inferior to later restore it, GDB temporarily bumps
333 the inferior object's refcount, to prevent something deleting the
334 inferior object before reverting back (e.g., due to a
335 "remove-inferiors" command (see
336 scoped_restore_current_inferior). All other inferior
337 references are considered weak references. Inferiors are always
338 listed exactly once in the inferior list, so placing an inferior in
339 the inferior list is an implicit, not counted strong reference. */
341 class inferior
: public refcounted_object
,
342 public intrusive_list_node
<inferior
>
345 explicit inferior (int pid
);
348 /* Returns true if we can delete this inferior. */
349 bool deletable () const { return refcount () == 0; }
351 /* Push T in this inferior's target stack. */
352 void push_target (struct target_ops
*t
)
353 { m_target_stack
.push (t
); }
355 /* An overload that deletes the target on failure. */
356 void push_target (target_ops_up
&&t
)
358 m_target_stack
.push (t
.get ());
362 /* Unpush T from this inferior's target stack. */
363 int unpush_target (struct target_ops
*t
);
365 /* Returns true if T is pushed in this inferior's target stack. */
366 bool target_is_pushed (target_ops
*t
)
367 { return m_target_stack
.is_pushed (t
); }
369 /* Find the target beneath T in this inferior's target stack. */
370 target_ops
*find_target_beneath (const target_ops
*t
)
371 { return m_target_stack
.find_beneath (t
); }
373 /* Return the target at the top of this inferior's target stack. */
374 target_ops
*top_target ()
375 { return m_target_stack
.top (); }
377 /* Return the target at process_stratum level in this inferior's
379 struct process_stratum_target
*process_target ()
380 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
382 /* Return the target at STRATUM in this inferior's target stack. */
383 target_ops
*target_at (enum strata stratum
)
384 { return m_target_stack
.at (stratum
); }
386 bool has_execution ()
387 { return target_has_execution (this); }
389 /* This inferior's thread list, sorted by creation order. */
390 intrusive_list
<thread_info
> thread_list
;
392 /* A map of ptid_t to thread_info*, for average O(1) ptid_t lookup.
393 Exited threads do not appear in the map. */
394 std::unordered_map
<ptid_t
, thread_info
*, hash_ptid
> ptid_thread_map
;
396 /* Returns a range adapter covering the inferior's threads,
397 including exited threads. Used like this:
399 for (thread_info *thr : inf->threads ())
402 inf_threads_range
threads ()
403 { return inf_threads_range (this->thread_list
.begin ()); }
405 /* Returns a range adapter covering the inferior's non-exited
406 threads. Used like this:
408 for (thread_info *thr : inf->non_exited_threads ())
411 inf_non_exited_threads_range
non_exited_threads ()
412 { return inf_non_exited_threads_range (this->thread_list
.begin ()); }
414 /* Like inferior::threads(), but returns a range adapter that can be
415 used with range-for, safely. I.e., it is safe to delete the
416 currently-iterated thread, like this:
418 for (thread_info *t : inf->threads_safe ())
419 if (some_condition ())
422 inline safe_inf_threads_range
threads_safe ()
423 { return safe_inf_threads_range (this->thread_list
.begin ()); }
425 /* Delete all threads in the thread list. If SILENT, exit threads
427 void clear_thread_list (bool silent
);
429 /* Continuations-related methods. A continuation is an std::function
430 to be called to finish the execution of a command when running
431 GDB asynchronously. A continuation is executed after any thread
432 of this inferior stops. Continuations are used by the attach
433 command and the remote target when a new inferior is detected. */
434 void add_continuation (std::function
<void ()> &&cont
);
435 void do_all_continuations ();
437 /* Set/get file name for default use for standard in/out in the
438 inferior. On Unix systems, we try to make TERMINAL_NAME the
439 inferior's controlling terminal. If TERMINAL_NAME is nullptr or
440 the empty string, then the inferior inherits GDB's terminal (or
441 GDBserver's if spawning a remote process). */
442 void set_tty (const char *terminal_name
);
445 /* Set the argument string to use when running this inferior.
447 An empty string can be used to represent "no arguments". */
448 void set_args (std::string args
)
450 m_args
= std::move (args
);
453 /* Get the argument string to use when running this inferior.
455 No arguments is represented by an empty string. */
456 const std::string
&args () const
461 /* Set the inferior current working directory.
463 If CWD is empty, unset the directory. */
464 void set_cwd (std::string cwd
)
466 m_cwd
= std::move (cwd
);
469 /* Get the inferior current working directory.
471 Return an empty string if the current working directory is not
473 const std::string
&cwd () const
478 /* Convenient handle (GDB inferior id). Unique across all
482 /* Actual target inferior id, usually, a process id. This matches
483 the ptid_t.pid member of threads of this inferior. */
485 /* True if the PID was actually faked by GDB. */
486 bool fake_pid_p
= false;
488 /* The highest thread number this inferior ever had. */
489 int highest_thread_num
= 0;
491 /* State of GDB control of inferior process execution.
492 See `struct inferior_control_state'. */
493 inferior_control_state control
;
495 /* True if this was an auto-created inferior, e.g. created from
496 following a fork; false, if this inferior was manually added by
497 the user, and we should not attempt to prune it
499 bool removable
= false;
501 /* The address space bound to this inferior. */
502 struct address_space
*aspace
= NULL
;
504 /* The program space bound to this inferior. */
505 struct program_space
*pspace
= NULL
;
507 /* The terminal state as set by the last target_terminal::terminal_*
509 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
511 /* Environment to use for running inferior,
512 in format described in environ.h. */
513 gdb_environ environment
;
515 /* True if this child process was attached rather than forked. */
516 bool attach_flag
= false;
518 /* If this inferior is a vfork child, then this is the pointer to
519 its vfork parent, if GDB is still attached to it. */
520 inferior
*vfork_parent
= NULL
;
522 /* If this process is a vfork parent, this is the pointer to the
523 child. Since a vfork parent is left frozen by the kernel until
524 the child execs or exits, a process can only have one vfork child
526 inferior
*vfork_child
= NULL
;
528 /* True if this inferior should be detached when it's vfork sibling
530 bool pending_detach
= false;
532 /* True if this inferior is a vfork parent waiting for a vfork child
533 not under our control to be done with the shared memory region,
534 either by exiting or execing. */
535 bool waiting_for_vfork_done
= false;
537 /* True if we're in the process of detaching from this inferior. */
538 bool detaching
= false;
540 /* True if setup_inferior wasn't called for this inferior yet.
541 Until that is done, we must not access inferior memory or
542 registers, as we haven't determined the target
543 architecture/description. */
544 bool needs_setup
= false;
546 /* True when we are reading the library list of the inferior during an
547 attach or handling a fork child. */
548 bool in_initial_library_scan
= false;
550 /* Private data used by the target vector implementation. */
551 std::unique_ptr
<private_inferior
> priv
;
553 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
554 In this case, the EXIT_CODE field is also valid. */
555 bool has_exit_code
= false;
556 LONGEST exit_code
= 0;
558 /* Default flags to pass to the symbol reading functions. These are
559 used whenever a new objfile is created. */
560 symfile_add_flags symfile_flags
= 0;
562 /* Info about an inferior's target description (if it's fetched; the
563 user supplied description's filename, if any; etc.). */
564 target_desc_info
*tdesc_info
= NULL
;
566 /* The architecture associated with the inferior through the
567 connection to the target.
569 The architecture vector provides some information that is really
570 a property of the inferior, accessed through a particular target:
571 ptrace operations; the layout of certain RSP packets; the
572 solib_ops vector; etc. To differentiate architecture accesses to
573 per-inferior/target properties from
574 per-thread/per-frame/per-objfile properties, accesses to
575 per-inferior/target properties should be made through
577 struct gdbarch
*gdbarch
= NULL
;
579 /* Data related to displaced stepping. */
580 displaced_step_inferior_state displaced_step_state
;
582 /* Per inferior data-pointers required by other GDB modules. */
586 /* The inferior's target stack. */
587 target_stack m_target_stack
;
589 /* The name of terminal device to use for I/O. */
590 gdb::unique_xmalloc_ptr
<char> m_terminal
;
592 /* The list of continuations. */
593 std::list
<std::function
<void ()>> m_continuations
;
595 /* The arguments string to use when running. */
598 /* The current working directory that will be used when starting
603 /* Keep a registry of per-inferior data-pointers required by other GDB
606 DECLARE_REGISTRY (inferior
);
608 /* Add an inferior to the inferior list, print a message that a new
609 inferior is found, and return the pointer to the new inferior.
610 Caller may use this pointer to initialize the private inferior
612 extern struct inferior
*add_inferior (int pid
);
614 /* Same as add_inferior, but don't print new inferior notifications to
616 extern struct inferior
*add_inferior_silent (int pid
);
618 extern void delete_inferior (struct inferior
*todel
);
620 /* Delete an existing inferior list entry, due to inferior detaching. */
621 extern void detach_inferior (inferior
*inf
);
623 extern void exit_inferior (inferior
*inf
);
625 extern void exit_inferior_silent (inferior
*inf
);
627 extern void exit_inferior_num_silent (int num
);
629 extern void inferior_appeared (struct inferior
*inf
, int pid
);
631 /* Search function to lookup an inferior of TARG by target 'pid'. */
632 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
635 /* Search function to lookup an inferior of TARG whose pid is equal to
637 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
640 /* Search function to lookup an inferior by GDB 'num'. */
641 extern struct inferior
*find_inferior_id (int num
);
643 /* Find an inferior bound to PSPACE, giving preference to the current
645 extern struct inferior
*
646 find_inferior_for_program_space (struct program_space
*pspace
);
648 /* Returns true if the inferior list is not empty. */
649 extern int have_inferiors (void);
651 /* Returns the number of live inferiors running on PROC_TARGET (real
652 live processes with execution). */
653 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
655 /* Returns true if there are any live inferiors in the inferior list
656 (not cores, not executables, real live processes). */
657 extern int have_live_inferiors (void);
659 /* Save/restore the current inferior. */
661 class scoped_restore_current_inferior
664 scoped_restore_current_inferior ()
665 : m_saved_inf (current_inferior ())
668 ~scoped_restore_current_inferior ()
669 { set_current_inferior (m_saved_inf
); }
671 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
674 inferior
*m_saved_inf
;
678 /* Traverse all inferiors. */
680 extern intrusive_list
<inferior
> inferior_list
;
682 /* Pull in the internals of the inferiors ranges and iterators. Must
683 be done after struct inferior is defined. */
684 #include "inferior-iter.h"
686 /* Return a range that can be used to walk over all inferiors
687 inferiors, with range-for, safely. I.e., it is safe to delete the
688 currently-iterated inferior. When combined with range-for, this
689 allow convenient patterns like this:
691 for (inferior *inf : all_inferiors_safe ())
692 if (some_condition ())
696 inline all_inferiors_safe_range
697 all_inferiors_safe ()
699 return all_inferiors_safe_range (nullptr, inferior_list
);
702 /* Returns a range representing all inferiors, suitable to use with
703 range-for, like this:
705 for (inferior *inf : all_inferiors ())
709 inline all_inferiors_range
710 all_inferiors (process_stratum_target
*proc_target
= nullptr)
712 return all_inferiors_range (proc_target
, inferior_list
);
715 /* Return a range that can be used to walk over all inferiors with PID
716 not zero, with range-for. */
718 inline all_non_exited_inferiors_range
719 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
721 return all_non_exited_inferiors_range (proc_target
, inferior_list
);
724 /* Prune away automatically added inferiors that aren't required
726 extern void prune_inferiors (void);
728 extern int number_of_inferiors (void);
730 extern struct inferior
*add_inferior_with_spaces (void);
732 /* Print the current selected inferior. */
733 extern void print_selected_inferior (struct ui_out
*uiout
);
735 #endif /* !defined (INFERIOR_H) */