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)
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"
64 struct infcall_suspend_state
;
65 struct infcall_control_state
;
67 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
68 extern void restore_infcall_control_state (struct infcall_control_state
*);
70 /* A deleter for infcall_suspend_state that calls
71 restore_infcall_suspend_state. */
72 struct infcall_suspend_state_deleter
74 void operator() (struct infcall_suspend_state
*state
) const
78 restore_infcall_suspend_state (state
);
80 catch (const gdb_exception_error
&e
)
82 /* If we are restoring the inferior state due to an exception,
83 some error message will be printed. So, only warn the user
84 when we cannot restore during normal execution. */
86 #if __cpp_lib_uncaught_exceptions
87 unwinding
= std::uncaught_exceptions () > 0;
89 unwinding
= std::uncaught_exception ();
92 warning (_("Failed to restore inferior state: %s"), e
.what ());
97 /* A unique_ptr specialization for infcall_suspend_state. */
98 typedef std::unique_ptr
<infcall_suspend_state
, infcall_suspend_state_deleter
>
99 infcall_suspend_state_up
;
101 extern infcall_suspend_state_up
save_infcall_suspend_state ();
103 /* A deleter for infcall_control_state that calls
104 restore_infcall_control_state. */
105 struct infcall_control_state_deleter
107 void operator() (struct infcall_control_state
*state
) const
109 restore_infcall_control_state (state
);
113 /* A unique_ptr specialization for infcall_control_state. */
114 typedef std::unique_ptr
<infcall_control_state
, infcall_control_state_deleter
>
115 infcall_control_state_up
;
117 extern infcall_control_state_up
save_infcall_control_state ();
119 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
120 extern void discard_infcall_control_state (struct infcall_control_state
*);
122 extern readonly_detached_regcache
*
123 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
125 extern void set_sigint_trap (void);
127 extern void clear_sigint_trap (void);
129 /* Collected pid, tid, etc. of the debugged inferior. When there's
130 no inferior, inferior_ptid.pid () will be 0. */
132 extern ptid_t inferior_ptid
;
134 extern void generic_mourn_inferior (void);
136 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
138 const gdb_byte
*buf
);
139 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
140 struct type
*type
, gdb_byte
*buf
,
142 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
144 const gdb_byte
*buf
);
145 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
146 struct type
*type
, gdb_byte
*buf
,
149 extern void reopen_exec_file (void);
151 /* From misc files */
153 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
154 struct ui_file
*file
,
155 struct frame_info
*frame
,
156 int regnum
, int all
);
158 /* Default implementation of gdbarch_print_float_info. Print
159 the values of all floating point registers. */
161 extern void default_print_float_info (struct gdbarch
*gdbarch
,
162 struct ui_file
*file
,
163 struct frame_info
*frame
,
166 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
168 extern void child_terminal_ours (struct target_ops
*self
);
170 extern void child_terminal_ours_for_output (struct target_ops
*self
);
172 extern void child_terminal_inferior (struct target_ops
*self
);
174 extern void child_terminal_save_inferior (struct target_ops
*self
);
176 extern void child_terminal_init (struct target_ops
*self
);
178 extern void child_terminal_init_with_pgrp (int pgrp
);
180 extern void child_pass_ctrlc (struct target_ops
*self
);
182 extern void child_interrupt (struct target_ops
*self
);
184 /* From fork-child.c */
186 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
187 This function already calls set_executing. Return the ptid_t from
189 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
193 /* Initial inferior setup. Determines the exec file is not yet known,
194 takes any necessary post-attaching actions, fetches the target
195 description and syncs the shared library list. */
197 extern void setup_inferior (int from_tty
);
199 extern void post_create_inferior (int from_tty
);
201 extern void attach_command (const char *, int);
203 extern const char *get_inferior_args (void);
205 extern void set_inferior_args (const char *);
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
*, int, 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
344 explicit inferior (int pid
);
347 /* Returns true if we can delete this inferior. */
348 bool deletable () const { return refcount () == 0; }
350 /* Push T in this inferior's target stack. */
351 void push_target (struct target_ops
*t
)
352 { m_target_stack
.push (t
); }
354 /* Unpush T from this inferior's target stack. */
355 int unpush_target (struct target_ops
*t
)
356 { return m_target_stack
.unpush (t
); }
358 /* Returns true if T is pushed in this inferior's target stack. */
359 bool target_is_pushed (target_ops
*t
)
360 { return m_target_stack
.is_pushed (t
); }
362 /* Find the target beneath T in this inferior's target stack. */
363 target_ops
*find_target_beneath (const target_ops
*t
)
364 { return m_target_stack
.find_beneath (t
); }
366 /* Return the target at the top of this inferior's target stack. */
367 target_ops
*top_target ()
368 { return m_target_stack
.top (); }
370 /* Return the target at process_stratum level in this inferior's
372 struct process_stratum_target
*process_target ()
373 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
375 /* Return the target at STRATUM in this inferior's target stack. */
376 target_ops
*target_at (enum strata stratum
)
377 { return m_target_stack
.at (stratum
); }
379 bool has_execution ()
380 { return target_has_execution (this); }
382 /* Pointer to next inferior in singly-linked list of inferiors. */
383 struct inferior
*next
= NULL
;
385 /* This inferior's thread list. */
386 thread_info
*thread_list
= nullptr;
388 /* Returns a range adapter covering the inferior's threads,
389 including exited threads. Used like this:
391 for (thread_info *thr : inf->threads ())
394 inf_threads_range
threads ()
395 { return inf_threads_range (this->thread_list
); }
397 /* Returns a range adapter covering the inferior's non-exited
398 threads. Used like this:
400 for (thread_info *thr : inf->non_exited_threads ())
403 inf_non_exited_threads_range
non_exited_threads ()
404 { return inf_non_exited_threads_range (this->thread_list
); }
406 /* Like inferior::threads(), but returns a range adapter that can be
407 used with range-for, safely. I.e., it is safe to delete the
408 currently-iterated thread, like this:
410 for (thread_info *t : inf->threads_safe ())
411 if (some_condition ())
414 inline safe_inf_threads_range
threads_safe ()
415 { return safe_inf_threads_range (this->thread_list
); }
417 /* Set/get file name for default use for standard in/out in the
418 inferior. On Unix systems, we try to make TERMINAL_NAME the
419 inferior's controlling terminal. If TERMINAL_NAME is nullptr or
420 the empty string, then the inferior inherits GDB's terminal (or
421 GDBserver's if spawning a remote process). */
422 void set_tty (const char *terminal_name
);
425 /* Convenient handle (GDB inferior id). Unique across all
429 /* Actual target inferior id, usually, a process id. This matches
430 the ptid_t.pid member of threads of this inferior. */
432 /* True if the PID was actually faked by GDB. */
433 bool fake_pid_p
= false;
435 /* The highest thread number this inferior ever had. */
436 int highest_thread_num
= 0;
438 /* State of GDB control of inferior process execution.
439 See `struct inferior_control_state'. */
440 inferior_control_state control
;
442 /* True if this was an auto-created inferior, e.g. created from
443 following a fork; false, if this inferior was manually added by
444 the user, and we should not attempt to prune it
446 bool removable
= false;
448 /* The address space bound to this inferior. */
449 struct address_space
*aspace
= NULL
;
451 /* The program space bound to this inferior. */
452 struct program_space
*pspace
= NULL
;
454 /* The arguments string to use when running. */
457 /* The size of elements in argv. */
460 /* The vector version of arguments. If ARGC is nonzero,
461 then we must compute ARGS from this (via the target).
462 This is always coming from main's argv and therefore
463 should never be freed. */
466 /* The current working directory that will be used when starting
468 gdb::unique_xmalloc_ptr
<char> cwd
;
470 /* The terminal state as set by the last target_terminal::terminal_*
472 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
474 /* Environment to use for running inferior,
475 in format described in environ.h. */
476 gdb_environ environment
;
478 /* True if this child process was attached rather than forked. */
479 bool attach_flag
= false;
481 /* If this inferior is a vfork child, then this is the pointer to
482 its vfork parent, if GDB is still attached to it. */
483 inferior
*vfork_parent
= NULL
;
485 /* If this process is a vfork parent, this is the pointer to the
486 child. Since a vfork parent is left frozen by the kernel until
487 the child execs or exits, a process can only have one vfork child
489 inferior
*vfork_child
= NULL
;
491 /* True if this inferior should be detached when it's vfork sibling
493 bool pending_detach
= false;
495 /* True if this inferior is a vfork parent waiting for a vfork child
496 not under our control to be done with the shared memory region,
497 either by exiting or execing. */
498 bool waiting_for_vfork_done
= false;
500 /* True if we're in the process of detaching from this inferior. */
501 bool detaching
= false;
503 /* What is left to do for an execution command after any thread of
504 this inferior stops. For continuations associated with a
505 specific thread, see `struct thread_info'. */
506 continuation
*continuations
= NULL
;
508 /* True if setup_inferior wasn't called for this inferior yet.
509 Until that is done, we must not access inferior memory or
510 registers, as we haven't determined the target
511 architecture/description. */
512 bool needs_setup
= false;
514 /* Private data used by the target vector implementation. */
515 std::unique_ptr
<private_inferior
> priv
;
517 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
518 In this case, the EXIT_CODE field is also valid. */
519 bool has_exit_code
= false;
520 LONGEST exit_code
= 0;
522 /* Default flags to pass to the symbol reading functions. These are
523 used whenever a new objfile is created. */
524 symfile_add_flags symfile_flags
= 0;
526 /* Info about an inferior's target description (if it's fetched; the
527 user supplied description's filename, if any; etc.). */
528 target_desc_info
*tdesc_info
= NULL
;
530 /* The architecture associated with the inferior through the
531 connection to the target.
533 The architecture vector provides some information that is really
534 a property of the inferior, accessed through a particular target:
535 ptrace operations; the layout of certain RSP packets; the
536 solib_ops vector; etc. To differentiate architecture accesses to
537 per-inferior/target properties from
538 per-thread/per-frame/per-objfile properties, accesses to
539 per-inferior/target properties should be made through
541 struct gdbarch
*gdbarch
= NULL
;
543 /* Data related to displaced stepping. */
544 displaced_step_inferior_state displaced_step_state
;
546 /* Per inferior data-pointers required by other GDB modules. */
550 /* The inferior's target stack. */
551 target_stack m_target_stack
;
553 /* The name of terminal device to use for I/O. */
554 gdb::unique_xmalloc_ptr
<char> m_terminal
;
557 /* Keep a registry of per-inferior data-pointers required by other GDB
560 DECLARE_REGISTRY (inferior
);
562 /* Add an inferior to the inferior list, print a message that a new
563 inferior is found, and return the pointer to the new inferior.
564 Caller may use this pointer to initialize the private inferior
566 extern struct inferior
*add_inferior (int pid
);
568 /* Same as add_inferior, but don't print new inferior notifications to
570 extern struct inferior
*add_inferior_silent (int pid
);
572 extern void delete_inferior (struct inferior
*todel
);
574 /* Delete an existing inferior list entry, due to inferior detaching. */
575 extern void detach_inferior (inferior
*inf
);
577 extern void exit_inferior (inferior
*inf
);
579 extern void exit_inferior_silent (inferior
*inf
);
581 extern void exit_inferior_num_silent (int num
);
583 extern void inferior_appeared (struct inferior
*inf
, int pid
);
585 /* Search function to lookup an inferior of TARG by target 'pid'. */
586 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
589 /* Search function to lookup an inferior of TARG whose pid is equal to
591 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
594 /* Search function to lookup an inferior by GDB 'num'. */
595 extern struct inferior
*find_inferior_id (int num
);
597 /* Find an inferior bound to PSPACE, giving preference to the current
599 extern struct inferior
*
600 find_inferior_for_program_space (struct program_space
*pspace
);
602 /* Returns true if the inferior list is not empty. */
603 extern int have_inferiors (void);
605 /* Returns the number of live inferiors running on PROC_TARGET (real
606 live processes with execution). */
607 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
609 /* Returns true if there are any live inferiors in the inferior list
610 (not cores, not executables, real live processes). */
611 extern int have_live_inferiors (void);
613 /* Save/restore the current inferior. */
615 class scoped_restore_current_inferior
618 scoped_restore_current_inferior ()
619 : m_saved_inf (current_inferior ())
622 ~scoped_restore_current_inferior ()
623 { set_current_inferior (m_saved_inf
); }
625 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
628 inferior
*m_saved_inf
;
632 /* Traverse all inferiors. */
634 extern struct inferior
*inferior_list
;
636 /* Pull in the internals of the inferiors ranges and iterators. Must
637 be done after struct inferior is defined. */
638 #include "inferior-iter.h"
640 /* Return a range that can be used to walk over all inferiors
641 inferiors, with range-for, safely. I.e., it is safe to delete the
642 currently-iterated inferior. When combined with range-for, this
643 allow convenient patterns like this:
645 for (inferior *inf : all_inferiors_safe ())
646 if (some_condition ())
650 inline all_inferiors_safe_range
651 all_inferiors_safe ()
656 /* Returns a range representing all inferiors, suitable to use with
657 range-for, like this:
659 for (inferior *inf : all_inferiors ())
663 inline all_inferiors_range
664 all_inferiors (process_stratum_target
*proc_target
= nullptr)
666 return all_inferiors_range (proc_target
);
669 /* Return a range that can be used to walk over all inferiors with PID
670 not zero, with range-for. */
672 inline all_non_exited_inferiors_range
673 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
675 return all_non_exited_inferiors_range (proc_target
);
678 /* Prune away automatically added inferiors that aren't required
680 extern void prune_inferiors (void);
682 extern int number_of_inferiors (void);
684 extern struct inferior
*add_inferior_with_spaces (void);
686 /* Print the current selected inferior. */
687 extern void print_selected_inferior (struct ui_out
*uiout
);
689 #endif /* !defined (INFERIOR_H) */