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)
26 struct target_waitstatus
;
34 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"
59 #include "gdbsupport/common-inferior.h"
60 #include "gdbthread.h"
62 #include "process-stratum-target.h"
63 #include "displaced-stepping.h"
65 struct infcall_suspend_state
;
66 struct infcall_control_state
;
68 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
69 extern void restore_infcall_control_state (struct infcall_control_state
*);
71 /* A deleter for infcall_suspend_state that calls
72 restore_infcall_suspend_state. */
73 struct infcall_suspend_state_deleter
75 void operator() (struct infcall_suspend_state
*state
) const
79 restore_infcall_suspend_state (state
);
81 catch (const gdb_exception_error
&e
)
83 /* If we are restoring the inferior state due to an exception,
84 some error message will be printed. So, only warn the user
85 when we cannot restore during normal execution. */
87 #if __cpp_lib_uncaught_exceptions
88 unwinding
= std::uncaught_exceptions () > 0;
90 unwinding
= std::uncaught_exception ();
93 warning (_("Failed to restore inferior state: %s"), e
.what ());
98 /* A unique_ptr specialization for infcall_suspend_state. */
99 typedef std::unique_ptr
<infcall_suspend_state
, infcall_suspend_state_deleter
>
100 infcall_suspend_state_up
;
102 extern infcall_suspend_state_up
save_infcall_suspend_state ();
104 /* A deleter for infcall_control_state that calls
105 restore_infcall_control_state. */
106 struct infcall_control_state_deleter
108 void operator() (struct infcall_control_state
*state
) const
110 restore_infcall_control_state (state
);
114 /* A unique_ptr specialization for infcall_control_state. */
115 typedef std::unique_ptr
<infcall_control_state
, infcall_control_state_deleter
>
116 infcall_control_state_up
;
118 extern infcall_control_state_up
save_infcall_control_state ();
120 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
121 extern void discard_infcall_control_state (struct infcall_control_state
*);
123 extern readonly_detached_regcache
*
124 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
126 extern void set_sigint_trap (void);
128 extern void clear_sigint_trap (void);
130 /* Collected pid, tid, etc. of the debugged inferior. When there's
131 no inferior, inferior_ptid.pid () will be 0. */
133 extern ptid_t inferior_ptid
;
135 extern void generic_mourn_inferior (void);
137 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
139 const gdb_byte
*buf
);
140 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
141 struct type
*type
, gdb_byte
*buf
,
143 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
145 const gdb_byte
*buf
);
146 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
147 struct type
*type
, gdb_byte
*buf
,
150 extern void reopen_exec_file (void);
152 /* From misc files */
154 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
155 struct ui_file
*file
,
156 struct frame_info
*frame
,
157 int regnum
, int all
);
159 /* Default implementation of gdbarch_print_float_info. Print
160 the values of all floating point registers. */
162 extern void default_print_float_info (struct gdbarch
*gdbarch
,
163 struct ui_file
*file
,
164 struct frame_info
*frame
,
167 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
169 extern void child_terminal_ours (struct target_ops
*self
);
171 extern void child_terminal_ours_for_output (struct target_ops
*self
);
173 extern void child_terminal_inferior (struct target_ops
*self
);
175 extern void child_terminal_save_inferior (struct target_ops
*self
);
177 extern void child_terminal_init (struct target_ops
*self
);
179 extern void child_terminal_init_with_pgrp (int pgrp
);
181 extern void child_pass_ctrlc (struct target_ops
*self
);
183 extern void child_interrupt (struct target_ops
*self
);
185 /* From fork-child.c */
187 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
188 This function already calls set_executing. Return the ptid_t from
190 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
194 /* Initial inferior setup. Determines the exec file is not yet known,
195 takes any necessary post-attaching actions, fetches the target
196 description and syncs the shared library list. */
198 extern void setup_inferior (int from_tty
);
200 extern void post_create_inferior (int from_tty
);
202 extern void attach_command (const char *, int);
204 extern const char *get_inferior_args (void);
206 extern void set_inferior_args (const char *);
208 extern void set_inferior_args_vector (int, char **);
210 extern void registers_info (const char *, int);
212 extern void continue_1 (int all_threads
);
214 extern void interrupt_target_1 (bool all_threads
);
216 using delete_longjmp_breakpoint_cleanup
217 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint
);
219 extern void detach_command (const char *, int);
221 extern void notice_new_inferior (struct thread_info
*, int, int);
223 extern struct value
*get_return_value (struct value
*function
,
224 struct type
*value_type
);
226 /* Prepare for execution command. TARGET is the target that will run
227 the command. BACKGROUND determines whether this is a foreground
228 (synchronous) or background (asynchronous) command. */
230 extern void prepare_execution_command (struct target_ops
*target
,
233 /* Nonzero if stopped due to completion of a stack dummy routine. */
235 extern enum stop_stack_kind stop_stack_dummy
;
237 /* Nonzero if program stopped due to a random (unexpected) signal in
240 extern int stopped_by_random_signal
;
242 /* Print notices on inferior events (attach, detach, etc.), set with
243 `set print inferior-events'. */
244 extern bool print_inferior_events
;
246 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
247 will handle it themselves. STOP_QUIETLY is used when running in
248 the shell before the child program has been exec'd and when running
249 through shared library loading. STOP_QUIETLY_REMOTE is used when
250 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
251 except that there is no need to hide a signal. */
253 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
254 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
255 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
256 a ptraced process has changed. Earlier versions of the kernel
257 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
258 other signal, i.e. it is not muffled.
260 If the gdb user does a 'continue' after the 'attach', gdb passes
261 the global variable stop_signal (which stores the signal from the
262 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
263 problematic, because the kernel doesn't ignore such SIGSTOP
264 now. I.e. it is reported back to gdb, which in turn presents it
267 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
268 gdb to clear the value of stop_signal after the attach, so that it
269 is not passed back down to the kernel. */
276 STOP_QUIETLY_NO_SIGSTOP
280 /* Possible values for gdbarch_call_dummy_location. */
282 #define AT_ENTRY_POINT 4
284 /* Base class for target-specific inferior data. */
286 struct private_inferior
288 virtual ~private_inferior () = 0;
291 /* Inferior process specific part of `struct infcall_control_state'.
293 Inferior thread counterpart is `struct thread_control_state'. */
295 struct inferior_control_state
297 inferior_control_state ()
298 : stop_soon (NO_STOP_QUIETLY
)
302 explicit inferior_control_state (enum stop_kind when
)
307 /* See the definition of stop_kind above. */
308 enum stop_kind stop_soon
;
311 /* Return a pointer to the current inferior. */
312 extern inferior
*current_inferior ();
314 extern void set_current_inferior (inferior
*);
316 /* Switch inferior (and program space) to INF, and switch to no thread
318 extern void switch_to_inferior_no_thread (inferior
*inf
);
320 /* GDB represents the state of each program execution with an object
321 called an inferior. An inferior typically corresponds to a process
322 but is more general and applies also to targets that do not have a
323 notion of processes. Each run of an executable creates a new
324 inferior, as does each attachment to an existing process.
325 Inferiors have unique internal identifiers that are different from
326 target process ids. Each inferior may in turn have multiple
327 threads running in it.
329 Inferiors are intrusively refcounted objects. Unlike thread
330 objects, being the user-selected inferior is considered a strong
331 reference and is thus accounted for in the inferior object's
332 refcount (see set_current_inferior). When GDB needs to remember
333 the selected inferior to later restore it, GDB temporarily bumps
334 the inferior object's refcount, to prevent something deleting the
335 inferior object before reverting back (e.g., due to a
336 "remove-inferiors" command (see
337 scoped_restore_current_inferior). All other inferior
338 references are considered weak references. Inferiors are always
339 listed exactly once in the inferior list, so placing an inferior in
340 the inferior list is an implicit, not counted strong reference. */
342 class inferior
: public refcounted_object
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 /* Unpush T from this inferior's target stack. */
356 int unpush_target (struct target_ops
*t
)
357 { return m_target_stack
.unpush (t
); }
359 /* Returns true if T is pushed in this inferior's target stack. */
360 bool target_is_pushed (target_ops
*t
)
361 { return m_target_stack
.is_pushed (t
); }
363 /* Find the target beneath T in this inferior's target stack. */
364 target_ops
*find_target_beneath (const target_ops
*t
)
365 { return m_target_stack
.find_beneath (t
); }
367 /* Return the target at the top of this inferior's target stack. */
368 target_ops
*top_target ()
369 { return m_target_stack
.top (); }
371 /* Return the target at process_stratum level in this inferior's
373 struct process_stratum_target
*process_target ()
374 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
376 /* Return the target at STRATUM in this inferior's target stack. */
377 target_ops
*target_at (enum strata stratum
)
378 { return m_target_stack
.at (stratum
); }
380 bool has_execution ()
381 { return target_has_execution (this); }
383 /* Pointer to next inferior in singly-linked list of inferiors. */
384 struct inferior
*next
= NULL
;
386 /* This inferior's thread list. */
387 thread_info
*thread_list
= nullptr;
389 /* Returns a range adapter covering the inferior's threads,
390 including exited threads. Used like this:
392 for (thread_info *thr : inf->threads ())
395 inf_threads_range
threads ()
396 { return inf_threads_range (this->thread_list
); }
398 /* Returns a range adapter covering the inferior's non-exited
399 threads. Used like this:
401 for (thread_info *thr : inf->non_exited_threads ())
404 inf_non_exited_threads_range
non_exited_threads ()
405 { return inf_non_exited_threads_range (this->thread_list
); }
407 /* Like inferior::threads(), but returns a range adapter that can be
408 used with range-for, safely. I.e., it is safe to delete the
409 currently-iterated thread, like this:
411 for (thread_info *t : inf->threads_safe ())
412 if (some_condition ())
415 inline safe_inf_threads_range
threads_safe ()
416 { return safe_inf_threads_range (this->thread_list
); }
418 /* Set/get file name for default use for standard in/out in the
419 inferior. On Unix systems, we try to make TERMINAL_NAME the
420 inferior's controlling terminal. If TERMINAL_NAME is nullptr or
421 the empty string, then the inferior inherits GDB's terminal (or
422 GDBserver's if spawning a remote process). */
423 void set_tty (const char *terminal_name
);
426 /* Convenient handle (GDB inferior id). Unique across all
430 /* Actual target inferior id, usually, a process id. This matches
431 the ptid_t.pid member of threads of this inferior. */
433 /* True if the PID was actually faked by GDB. */
434 bool fake_pid_p
= false;
436 /* The highest thread number this inferior ever had. */
437 int highest_thread_num
= 0;
439 /* State of GDB control of inferior process execution.
440 See `struct inferior_control_state'. */
441 inferior_control_state control
;
443 /* True if this was an auto-created inferior, e.g. created from
444 following a fork; false, if this inferior was manually added by
445 the user, and we should not attempt to prune it
447 bool removable
= false;
449 /* The address space bound to this inferior. */
450 struct address_space
*aspace
= NULL
;
452 /* The program space bound to this inferior. */
453 struct program_space
*pspace
= NULL
;
455 /* The arguments string to use when running. */
458 /* The size of elements in argv. */
461 /* The vector version of arguments. If ARGC is nonzero,
462 then we must compute ARGS from this (via the target).
463 This is always coming from main's argv and therefore
464 should never be freed. */
467 /* The current working directory that will be used when starting
469 gdb::unique_xmalloc_ptr
<char> cwd
;
471 /* The terminal state as set by the last target_terminal::terminal_*
473 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
475 /* Environment to use for running inferior,
476 in format described in environ.h. */
477 gdb_environ environment
;
479 /* True if this child process was attached rather than forked. */
480 bool attach_flag
= false;
482 /* If this inferior is a vfork child, then this is the pointer to
483 its vfork parent, if GDB is still attached to it. */
484 inferior
*vfork_parent
= NULL
;
486 /* If this process is a vfork parent, this is the pointer to the
487 child. Since a vfork parent is left frozen by the kernel until
488 the child execs or exits, a process can only have one vfork child
490 inferior
*vfork_child
= NULL
;
492 /* True if this inferior should be detached when it's vfork sibling
494 bool pending_detach
= false;
496 /* True if this inferior is a vfork parent waiting for a vfork child
497 not under our control to be done with the shared memory region,
498 either by exiting or execing. */
499 bool waiting_for_vfork_done
= false;
501 /* True if we're in the process of detaching from this inferior. */
502 bool detaching
= false;
504 /* What is left to do for an execution command after any thread of
505 this inferior stops. For continuations associated with a
506 specific thread, see `struct thread_info'. */
507 continuation
*continuations
= NULL
;
509 /* True if setup_inferior wasn't called for this inferior yet.
510 Until that is done, we must not access inferior memory or
511 registers, as we haven't determined the target
512 architecture/description. */
513 bool needs_setup
= false;
515 /* Private data used by the target vector implementation. */
516 std::unique_ptr
<private_inferior
> priv
;
518 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
519 In this case, the EXIT_CODE field is also valid. */
520 bool has_exit_code
= false;
521 LONGEST exit_code
= 0;
523 /* Default flags to pass to the symbol reading functions. These are
524 used whenever a new objfile is created. */
525 symfile_add_flags symfile_flags
= 0;
527 /* Info about an inferior's target description (if it's fetched; the
528 user supplied description's filename, if any; etc.). */
529 target_desc_info
*tdesc_info
= NULL
;
531 /* The architecture associated with the inferior through the
532 connection to the target.
534 The architecture vector provides some information that is really
535 a property of the inferior, accessed through a particular target:
536 ptrace operations; the layout of certain RSP packets; the
537 solib_ops vector; etc. To differentiate architecture accesses to
538 per-inferior/target properties from
539 per-thread/per-frame/per-objfile properties, accesses to
540 per-inferior/target properties should be made through
542 struct gdbarch
*gdbarch
= NULL
;
544 /* Data related to displaced stepping. */
545 displaced_step_inferior_state displaced_step_state
;
547 /* Per inferior data-pointers required by other GDB modules. */
551 /* The inferior's target stack. */
552 target_stack m_target_stack
;
554 /* The name of terminal device to use for I/O. */
555 gdb::unique_xmalloc_ptr
<char> m_terminal
;
558 /* Keep a registry of per-inferior data-pointers required by other GDB
561 DECLARE_REGISTRY (inferior
);
563 /* Add an inferior to the inferior list, print a message that a new
564 inferior is found, and return the pointer to the new inferior.
565 Caller may use this pointer to initialize the private inferior
567 extern struct inferior
*add_inferior (int pid
);
569 /* Same as add_inferior, but don't print new inferior notifications to
571 extern struct inferior
*add_inferior_silent (int pid
);
573 extern void delete_inferior (struct inferior
*todel
);
575 /* Delete an existing inferior list entry, due to inferior detaching. */
576 extern void detach_inferior (inferior
*inf
);
578 extern void exit_inferior (inferior
*inf
);
580 extern void exit_inferior_silent (inferior
*inf
);
582 extern void exit_inferior_num_silent (int num
);
584 extern void inferior_appeared (struct inferior
*inf
, int pid
);
586 /* Search function to lookup an inferior of TARG by target 'pid'. */
587 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
590 /* Search function to lookup an inferior of TARG whose pid is equal to
592 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
595 /* Search function to lookup an inferior by GDB 'num'. */
596 extern struct inferior
*find_inferior_id (int num
);
598 /* Find an inferior bound to PSPACE, giving preference to the current
600 extern struct inferior
*
601 find_inferior_for_program_space (struct program_space
*pspace
);
603 /* Returns true if the inferior list is not empty. */
604 extern int have_inferiors (void);
606 /* Returns the number of live inferiors running on PROC_TARGET (real
607 live processes with execution). */
608 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
610 /* Returns true if there are any live inferiors in the inferior list
611 (not cores, not executables, real live processes). */
612 extern int have_live_inferiors (void);
614 /* Save/restore the current inferior. */
616 class scoped_restore_current_inferior
619 scoped_restore_current_inferior ()
620 : m_saved_inf (current_inferior ())
623 ~scoped_restore_current_inferior ()
624 { set_current_inferior (m_saved_inf
); }
626 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
629 inferior
*m_saved_inf
;
633 /* Traverse all inferiors. */
635 extern struct inferior
*inferior_list
;
637 /* Pull in the internals of the inferiors ranges and iterators. Must
638 be done after struct inferior is defined. */
639 #include "inferior-iter.h"
641 /* Return a range that can be used to walk over all inferiors
642 inferiors, with range-for, safely. I.e., it is safe to delete the
643 currently-iterated inferior. When combined with range-for, this
644 allow convenient patterns like this:
646 for (inferior *inf : all_inferiors_safe ())
647 if (some_condition ())
651 inline all_inferiors_safe_range
652 all_inferiors_safe ()
657 /* Returns a range representing all inferiors, suitable to use with
658 range-for, like this:
660 for (inferior *inf : all_inferiors ())
664 inline all_inferiors_range
665 all_inferiors (process_stratum_target
*proc_target
= nullptr)
667 return all_inferiors_range (proc_target
);
670 /* Return a range that can be used to walk over all inferiors with PID
671 not zero, with range-for. */
673 inline all_non_exited_inferiors_range
674 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
676 return all_non_exited_inferiors_range (proc_target
);
679 /* Prune away automatically added inferiors that aren't required
681 extern void prune_inferiors (void);
683 extern int number_of_inferiors (void);
685 extern struct inferior
*add_inferior_with_spaces (void);
687 /* Print the current selected inferior. */
688 extern void print_selected_inferior (struct ui_out
*uiout
);
690 #endif /* !defined (INFERIOR_H) */