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 struct infcall_suspend_state
;
67 struct infcall_control_state
;
69 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
70 extern void restore_infcall_control_state (struct infcall_control_state
*);
72 /* A deleter for infcall_suspend_state that calls
73 restore_infcall_suspend_state. */
74 struct infcall_suspend_state_deleter
76 void operator() (struct infcall_suspend_state
*state
) const
80 restore_infcall_suspend_state (state
);
82 catch (const gdb_exception_error
&e
)
84 /* If we are restoring the inferior state due to an exception,
85 some error message will be printed. So, only warn the user
86 when we cannot restore during normal execution. */
88 #if __cpp_lib_uncaught_exceptions
89 unwinding
= std::uncaught_exceptions () > 0;
91 unwinding
= std::uncaught_exception ();
94 warning (_("Failed to restore inferior state: %s"), e
.what ());
99 /* A unique_ptr specialization for infcall_suspend_state. */
100 typedef std::unique_ptr
<infcall_suspend_state
, infcall_suspend_state_deleter
>
101 infcall_suspend_state_up
;
103 extern infcall_suspend_state_up
save_infcall_suspend_state ();
105 /* A deleter for infcall_control_state that calls
106 restore_infcall_control_state. */
107 struct infcall_control_state_deleter
109 void operator() (struct infcall_control_state
*state
) const
111 restore_infcall_control_state (state
);
115 /* A unique_ptr specialization for infcall_control_state. */
116 typedef std::unique_ptr
<infcall_control_state
, infcall_control_state_deleter
>
117 infcall_control_state_up
;
119 extern infcall_control_state_up
save_infcall_control_state ();
121 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
122 extern void discard_infcall_control_state (struct infcall_control_state
*);
124 extern readonly_detached_regcache
*
125 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
127 extern void set_sigint_trap (void);
129 extern void clear_sigint_trap (void);
131 /* Collected pid, tid, etc. of the debugged inferior. When there's
132 no inferior, inferior_ptid.pid () will be 0. */
134 extern ptid_t inferior_ptid
;
136 extern void generic_mourn_inferior (void);
138 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
140 const gdb_byte
*buf
);
141 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
142 struct type
*type
, gdb_byte
*buf
,
144 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
146 const gdb_byte
*buf
);
147 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
148 struct type
*type
, gdb_byte
*buf
,
151 extern void reopen_exec_file (void);
153 /* From misc files */
155 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
156 struct ui_file
*file
,
157 struct frame_info
*frame
,
158 int regnum
, int all
);
160 /* Default implementation of gdbarch_print_float_info. Print
161 the values of all floating point registers. */
163 extern void default_print_float_info (struct gdbarch
*gdbarch
,
164 struct ui_file
*file
,
165 struct frame_info
*frame
,
168 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
170 extern void child_terminal_ours (struct target_ops
*self
);
172 extern void child_terminal_ours_for_output (struct target_ops
*self
);
174 extern void child_terminal_inferior (struct target_ops
*self
);
176 extern void child_terminal_save_inferior (struct target_ops
*self
);
178 extern void child_terminal_init (struct target_ops
*self
);
180 extern void child_terminal_init_with_pgrp (int pgrp
);
182 extern void child_pass_ctrlc (struct target_ops
*self
);
184 extern void child_interrupt (struct target_ops
*self
);
186 /* From fork-child.c */
188 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
189 This function already calls set_executing. Return the ptid_t from
191 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
195 /* Initial inferior setup. Determines the exec file is not yet known,
196 takes any necessary post-attaching actions, fetches the target
197 description and syncs the shared library list. */
199 extern void setup_inferior (int from_tty
);
201 extern void post_create_inferior (int from_tty
);
203 extern void attach_command (const char *, int);
205 extern const char *get_inferior_args (void);
207 extern void set_inferior_args (const char *);
209 extern void set_inferior_args_vector (int, char **);
211 extern void registers_info (const char *, int);
213 extern void continue_1 (int all_threads
);
215 extern void interrupt_target_1 (bool all_threads
);
217 using delete_longjmp_breakpoint_cleanup
218 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint
);
220 extern void detach_command (const char *, int);
222 extern void notice_new_inferior (struct thread_info
*, bool, int);
224 extern struct value
*get_return_value (struct value
*function
,
225 struct type
*value_type
);
227 /* Prepare for execution command. TARGET is the target that will run
228 the command. BACKGROUND determines whether this is a foreground
229 (synchronous) or background (asynchronous) command. */
231 extern void prepare_execution_command (struct target_ops
*target
,
234 /* Nonzero if stopped due to completion of a stack dummy routine. */
236 extern enum stop_stack_kind stop_stack_dummy
;
238 /* Nonzero if program stopped due to a random (unexpected) signal in
241 extern int stopped_by_random_signal
;
243 /* Print notices on inferior events (attach, detach, etc.), set with
244 `set print inferior-events'. */
245 extern bool print_inferior_events
;
247 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
248 will handle it themselves. STOP_QUIETLY is used when running in
249 the shell before the child program has been exec'd and when running
250 through shared library loading. STOP_QUIETLY_REMOTE is used when
251 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
252 except that there is no need to hide a signal. */
254 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
255 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
256 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
257 a ptraced process has changed. Earlier versions of the kernel
258 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
259 other signal, i.e. it is not muffled.
261 If the gdb user does a 'continue' after the 'attach', gdb passes
262 the global variable stop_signal (which stores the signal from the
263 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
264 problematic, because the kernel doesn't ignore such SIGSTOP
265 now. I.e. it is reported back to gdb, which in turn presents it
268 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
269 gdb to clear the value of stop_signal after the attach, so that it
270 is not passed back down to the kernel. */
277 STOP_QUIETLY_NO_SIGSTOP
281 /* Possible values for gdbarch_call_dummy_location. */
283 #define AT_ENTRY_POINT 4
285 /* Base class for target-specific inferior data. */
287 struct private_inferior
289 virtual ~private_inferior () = 0;
292 /* Inferior process specific part of `struct infcall_control_state'.
294 Inferior thread counterpart is `struct thread_control_state'. */
296 struct inferior_control_state
298 inferior_control_state ()
299 : stop_soon (NO_STOP_QUIETLY
)
303 explicit inferior_control_state (enum stop_kind when
)
308 /* See the definition of stop_kind above. */
309 enum stop_kind stop_soon
;
312 /* Return a pointer to the current inferior. */
313 extern inferior
*current_inferior ();
315 extern void set_current_inferior (inferior
*);
317 /* Switch inferior (and program space) to INF, and switch to no thread
319 extern void switch_to_inferior_no_thread (inferior
*inf
);
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
,
344 public intrusive_list_node
<inferior
>
347 explicit inferior (int pid
);
350 /* Returns true if we can delete this inferior. */
351 bool deletable () const { return refcount () == 0; }
353 /* Push T in this inferior's target stack. */
354 void push_target (struct target_ops
*t
)
355 { m_target_stack
.push (t
); }
357 /* An overload that deletes the target on failure. */
358 void push_target (target_ops_up
&&t
)
360 m_target_stack
.push (t
.get ());
364 /* Unpush T from this inferior's target stack. */
365 int unpush_target (struct target_ops
*t
);
367 /* Returns true if T is pushed in this inferior's target stack. */
368 bool target_is_pushed (target_ops
*t
)
369 { return m_target_stack
.is_pushed (t
); }
371 /* Find the target beneath T in this inferior's target stack. */
372 target_ops
*find_target_beneath (const target_ops
*t
)
373 { return m_target_stack
.find_beneath (t
); }
375 /* Return the target at the top of this inferior's target stack. */
376 target_ops
*top_target ()
377 { return m_target_stack
.top (); }
379 /* Return the target at process_stratum level in this inferior's
381 struct process_stratum_target
*process_target ()
382 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
384 /* Return the target at STRATUM in this inferior's target stack. */
385 target_ops
*target_at (enum strata stratum
)
386 { return m_target_stack
.at (stratum
); }
388 bool has_execution ()
389 { return target_has_execution (this); }
391 /* This inferior's thread list, sorted by creation order. */
392 intrusive_list
<thread_info
> thread_list
;
394 /* Returns a range adapter covering the inferior's threads,
395 including exited threads. Used like this:
397 for (thread_info *thr : inf->threads ())
400 inf_threads_range
threads ()
401 { return inf_threads_range (this->thread_list
.begin ()); }
403 /* Returns a range adapter covering the inferior's non-exited
404 threads. Used like this:
406 for (thread_info *thr : inf->non_exited_threads ())
409 inf_non_exited_threads_range
non_exited_threads ()
410 { return inf_non_exited_threads_range (this->thread_list
.begin ()); }
412 /* Like inferior::threads(), but returns a range adapter that can be
413 used with range-for, safely. I.e., it is safe to delete the
414 currently-iterated thread, like this:
416 for (thread_info *t : inf->threads_safe ())
417 if (some_condition ())
420 inline safe_inf_threads_range
threads_safe ()
421 { return safe_inf_threads_range (this->thread_list
.begin ()); }
423 /* Delete all threads in the thread list. If SILENT, exit threads
425 void clear_thread_list (bool silent
);
427 /* Continuations-related methods. A continuation is an std::function
428 to be called to finish the execution of a command when running
429 GDB asynchronously. A continuation is executed after any thread
430 of this inferior stops. Continuations are used by the attach
431 command and the remote target when a new inferior is detected. */
432 void add_continuation (std::function
<void ()> &&cont
);
433 void do_all_continuations ();
435 /* Set/get file name for default use for standard in/out in the
436 inferior. On Unix systems, we try to make TERMINAL_NAME the
437 inferior's controlling terminal. If TERMINAL_NAME is nullptr or
438 the empty string, then the inferior inherits GDB's terminal (or
439 GDBserver's if spawning a remote process). */
440 void set_tty (const char *terminal_name
);
443 /* Convenient handle (GDB inferior id). Unique across all
447 /* Actual target inferior id, usually, a process id. This matches
448 the ptid_t.pid member of threads of this inferior. */
450 /* True if the PID was actually faked by GDB. */
451 bool fake_pid_p
= false;
453 /* The highest thread number this inferior ever had. */
454 int highest_thread_num
= 0;
456 /* State of GDB control of inferior process execution.
457 See `struct inferior_control_state'. */
458 inferior_control_state control
;
460 /* True if this was an auto-created inferior, e.g. created from
461 following a fork; false, if this inferior was manually added by
462 the user, and we should not attempt to prune it
464 bool removable
= false;
466 /* The address space bound to this inferior. */
467 struct address_space
*aspace
= NULL
;
469 /* The program space bound to this inferior. */
470 struct program_space
*pspace
= NULL
;
472 /* The arguments string to use when running. */
473 gdb::unique_xmalloc_ptr
<char> args
;
475 /* The size of elements in argv. */
478 /* The vector version of arguments. If ARGC is nonzero,
479 then we must compute ARGS from this (via the target).
480 This is always coming from main's argv and therefore
481 should never be freed. */
484 /* The current working directory that will be used when starting
486 gdb::unique_xmalloc_ptr
<char> cwd
;
488 /* The terminal state as set by the last target_terminal::terminal_*
490 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
492 /* Environment to use for running inferior,
493 in format described in environ.h. */
494 gdb_environ environment
;
496 /* True if this child process was attached rather than forked. */
497 bool attach_flag
= false;
499 /* If this inferior is a vfork child, then this is the pointer to
500 its vfork parent, if GDB is still attached to it. */
501 inferior
*vfork_parent
= NULL
;
503 /* If this process is a vfork parent, this is the pointer to the
504 child. Since a vfork parent is left frozen by the kernel until
505 the child execs or exits, a process can only have one vfork child
507 inferior
*vfork_child
= NULL
;
509 /* True if this inferior should be detached when it's vfork sibling
511 bool pending_detach
= false;
513 /* True if this inferior is a vfork parent waiting for a vfork child
514 not under our control to be done with the shared memory region,
515 either by exiting or execing. */
516 bool waiting_for_vfork_done
= false;
518 /* True if we're in the process of detaching from this inferior. */
519 bool detaching
= false;
521 /* True if setup_inferior wasn't called for this inferior yet.
522 Until that is done, we must not access inferior memory or
523 registers, as we haven't determined the target
524 architecture/description. */
525 bool needs_setup
= false;
527 /* True when we are reading the library list of the inferior during an
528 attach or handling a fork child. */
529 bool in_initial_library_scan
= false;
531 /* Private data used by the target vector implementation. */
532 std::unique_ptr
<private_inferior
> priv
;
534 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
535 In this case, the EXIT_CODE field is also valid. */
536 bool has_exit_code
= false;
537 LONGEST exit_code
= 0;
539 /* Default flags to pass to the symbol reading functions. These are
540 used whenever a new objfile is created. */
541 symfile_add_flags symfile_flags
= 0;
543 /* Info about an inferior's target description (if it's fetched; the
544 user supplied description's filename, if any; etc.). */
545 target_desc_info
*tdesc_info
= NULL
;
547 /* The architecture associated with the inferior through the
548 connection to the target.
550 The architecture vector provides some information that is really
551 a property of the inferior, accessed through a particular target:
552 ptrace operations; the layout of certain RSP packets; the
553 solib_ops vector; etc. To differentiate architecture accesses to
554 per-inferior/target properties from
555 per-thread/per-frame/per-objfile properties, accesses to
556 per-inferior/target properties should be made through
558 struct gdbarch
*gdbarch
= NULL
;
560 /* Data related to displaced stepping. */
561 displaced_step_inferior_state displaced_step_state
;
563 /* Per inferior data-pointers required by other GDB modules. */
567 /* The inferior's target stack. */
568 target_stack m_target_stack
;
570 /* The name of terminal device to use for I/O. */
571 gdb::unique_xmalloc_ptr
<char> m_terminal
;
573 /* The list of continuations. */
574 std::list
<std::function
<void ()>> m_continuations
;
577 /* Keep a registry of per-inferior data-pointers required by other GDB
580 DECLARE_REGISTRY (inferior
);
582 /* Add an inferior to the inferior list, print a message that a new
583 inferior is found, and return the pointer to the new inferior.
584 Caller may use this pointer to initialize the private inferior
586 extern struct inferior
*add_inferior (int pid
);
588 /* Same as add_inferior, but don't print new inferior notifications to
590 extern struct inferior
*add_inferior_silent (int pid
);
592 extern void delete_inferior (struct inferior
*todel
);
594 /* Delete an existing inferior list entry, due to inferior detaching. */
595 extern void detach_inferior (inferior
*inf
);
597 extern void exit_inferior (inferior
*inf
);
599 extern void exit_inferior_silent (inferior
*inf
);
601 extern void exit_inferior_num_silent (int num
);
603 extern void inferior_appeared (struct inferior
*inf
, int pid
);
605 /* Search function to lookup an inferior of TARG by target 'pid'. */
606 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
609 /* Search function to lookup an inferior of TARG whose pid is equal to
611 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
614 /* Search function to lookup an inferior by GDB 'num'. */
615 extern struct inferior
*find_inferior_id (int num
);
617 /* Find an inferior bound to PSPACE, giving preference to the current
619 extern struct inferior
*
620 find_inferior_for_program_space (struct program_space
*pspace
);
622 /* Returns true if the inferior list is not empty. */
623 extern int have_inferiors (void);
625 /* Returns the number of live inferiors running on PROC_TARGET (real
626 live processes with execution). */
627 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
629 /* Returns true if there are any live inferiors in the inferior list
630 (not cores, not executables, real live processes). */
631 extern int have_live_inferiors (void);
633 /* Save/restore the current inferior. */
635 class scoped_restore_current_inferior
638 scoped_restore_current_inferior ()
639 : m_saved_inf (current_inferior ())
642 ~scoped_restore_current_inferior ()
643 { set_current_inferior (m_saved_inf
); }
645 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
648 inferior
*m_saved_inf
;
652 /* Traverse all inferiors. */
654 extern intrusive_list
<inferior
> inferior_list
;
656 /* Pull in the internals of the inferiors ranges and iterators. Must
657 be done after struct inferior is defined. */
658 #include "inferior-iter.h"
660 /* Return a range that can be used to walk over all inferiors
661 inferiors, with range-for, safely. I.e., it is safe to delete the
662 currently-iterated inferior. When combined with range-for, this
663 allow convenient patterns like this:
665 for (inferior *inf : all_inferiors_safe ())
666 if (some_condition ())
670 inline all_inferiors_safe_range
671 all_inferiors_safe ()
676 /* Returns a range representing all inferiors, suitable to use with
677 range-for, like this:
679 for (inferior *inf : all_inferiors ())
683 inline all_inferiors_range
684 all_inferiors (process_stratum_target
*proc_target
= nullptr)
686 return all_inferiors_range (proc_target
, inferior_list
);
689 /* Return a range that can be used to walk over all inferiors with PID
690 not zero, with range-for. */
692 inline all_non_exited_inferiors_range
693 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
695 return all_non_exited_inferiors_range (proc_target
, inferior_list
);
698 /* Prune away automatically added inferiors that aren't required
700 extern void prune_inferiors (void);
702 extern int number_of_inferiors (void);
704 extern struct inferior
*add_inferior_with_spaces (void);
706 /* Print the current selected inferior. */
707 extern void print_selected_inferior (struct ui_out
*uiout
);
709 #endif /* !defined (INFERIOR_H) */