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)
24 struct target_waitstatus
;
32 struct target_desc_info
;
38 #include "breakpoint.h"
40 /* For enum gdb_signal. */
43 /* For struct frame_id. */
46 /* For gdb_environ. */
47 #include "gdbsupport/environ.h"
49 #include "progspace.h"
52 #include "symfile-add-flags.h"
53 #include "gdbsupport/refcounted-object.h"
54 #include "gdbsupport/forward-scope-exit.h"
55 #include "gdbsupport/gdb_unique_ptr.h"
57 #include "gdbsupport/common-inferior.h"
58 #include "gdbthread.h"
60 #include "process-stratum-target.h"
62 struct infcall_suspend_state
;
63 struct infcall_control_state
;
65 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
66 extern void restore_infcall_control_state (struct infcall_control_state
*);
68 /* A deleter for infcall_suspend_state that calls
69 restore_infcall_suspend_state. */
70 struct infcall_suspend_state_deleter
72 void operator() (struct infcall_suspend_state
*state
) const
76 restore_infcall_suspend_state (state
);
78 catch (const gdb_exception_error
&e
)
80 /* If we are restoring the inferior state due to an exception,
81 some error message will be printed. So, only warn the user
82 when we cannot restore during normal execution. */
83 if (!std::uncaught_exception ())
84 warning (_("Failed to restore inferior state: %s"), e
.what ());
89 /* A unique_ptr specialization for infcall_suspend_state. */
90 typedef std::unique_ptr
<infcall_suspend_state
, infcall_suspend_state_deleter
>
91 infcall_suspend_state_up
;
93 extern infcall_suspend_state_up
save_infcall_suspend_state ();
95 /* A deleter for infcall_control_state that calls
96 restore_infcall_control_state. */
97 struct infcall_control_state_deleter
99 void operator() (struct infcall_control_state
*state
) const
101 restore_infcall_control_state (state
);
105 /* A unique_ptr specialization for infcall_control_state. */
106 typedef std::unique_ptr
<infcall_control_state
, infcall_control_state_deleter
>
107 infcall_control_state_up
;
109 extern infcall_control_state_up
save_infcall_control_state ();
111 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
112 extern void discard_infcall_control_state (struct infcall_control_state
*);
114 extern readonly_detached_regcache
*
115 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
117 extern void set_sigint_trap (void);
119 extern void clear_sigint_trap (void);
121 /* Collected pid, tid, etc. of the debugged inferior. When there's
122 no inferior, inferior_ptid.pid () will be 0. */
124 extern ptid_t inferior_ptid
;
126 extern void generic_mourn_inferior (void);
128 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
130 const gdb_byte
*buf
);
131 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
132 struct type
*type
, gdb_byte
*buf
,
134 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
136 const gdb_byte
*buf
);
137 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
138 struct type
*type
, gdb_byte
*buf
,
141 extern void reopen_exec_file (void);
143 /* From misc files */
145 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
146 struct ui_file
*file
,
147 struct frame_info
*frame
,
148 int regnum
, int all
);
150 /* Default implementation of gdbarch_print_float_info. Print
151 the values of all floating point registers. */
153 extern void default_print_float_info (struct gdbarch
*gdbarch
,
154 struct ui_file
*file
,
155 struct frame_info
*frame
,
158 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
160 extern void child_terminal_ours (struct target_ops
*self
);
162 extern void child_terminal_ours_for_output (struct target_ops
*self
);
164 extern void child_terminal_inferior (struct target_ops
*self
);
166 extern void child_terminal_save_inferior (struct target_ops
*self
);
168 extern void child_terminal_init (struct target_ops
*self
);
170 extern void child_terminal_init_with_pgrp (int pgrp
);
172 extern void child_pass_ctrlc (struct target_ops
*self
);
174 extern void child_interrupt (struct target_ops
*self
);
176 /* From fork-child.c */
178 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
179 This function already calls set_executing. Return the ptid_t from
181 extern ptid_t
gdb_startup_inferior (pid_t pid
, int num_traps
);
185 /* Initial inferior setup. Determines the exec file is not yet known,
186 takes any necessary post-attaching actions, fetches the target
187 description and syncs the shared library list. */
189 extern void setup_inferior (int from_tty
);
191 extern void post_create_inferior (struct target_ops
*, int);
193 extern void attach_command (const char *, int);
195 extern const char *get_inferior_args (void);
197 extern void set_inferior_args (const char *);
199 extern void set_inferior_args_vector (int, char **);
201 extern void registers_info (const char *, int);
203 extern void continue_1 (int all_threads
);
205 extern void interrupt_target_1 (bool all_threads
);
207 using delete_longjmp_breakpoint_cleanup
208 = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint
);
210 extern void detach_command (const char *, int);
212 extern void notice_new_inferior (struct thread_info
*, int, int);
214 extern struct value
*get_return_value (struct value
*function
,
215 struct type
*value_type
);
217 /* Prepare for execution command. TARGET is the target that will run
218 the command. BACKGROUND determines whether this is a foreground
219 (synchronous) or background (asynchronous) command. */
221 extern void prepare_execution_command (struct target_ops
*target
,
224 /* Nonzero if stopped due to completion of a stack dummy routine. */
226 extern enum stop_stack_kind stop_stack_dummy
;
228 /* Nonzero if program stopped due to a random (unexpected) signal in
231 extern int stopped_by_random_signal
;
233 /* Print notices on inferior events (attach, detach, etc.), set with
234 `set print inferior-events'. */
235 extern bool print_inferior_events
;
237 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
238 will handle it themselves. STOP_QUIETLY is used when running in
239 the shell before the child program has been exec'd and when running
240 through shared library loading. STOP_QUIETLY_REMOTE is used when
241 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
242 except that there is no need to hide a signal. */
244 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
245 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
246 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
247 a ptraced process has changed. Earlier versions of the kernel
248 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
249 other signal, i.e. it is not muffled.
251 If the gdb user does a 'continue' after the 'attach', gdb passes
252 the global variable stop_signal (which stores the signal from the
253 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
254 problematic, because the kernel doesn't ignore such SIGSTOP
255 now. I.e. it is reported back to gdb, which in turn presents it
258 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
259 gdb to clear the value of stop_signal after the attach, so that it
260 is not passed back down to the kernel. */
267 STOP_QUIETLY_NO_SIGSTOP
271 /* Possible values for gdbarch_call_dummy_location. */
273 #define AT_ENTRY_POINT 4
275 /* Base class for target-specific inferior data. */
277 struct private_inferior
279 virtual ~private_inferior () = 0;
282 /* Inferior process specific part of `struct infcall_control_state'.
284 Inferior thread counterpart is `struct thread_control_state'. */
286 struct inferior_control_state
288 inferior_control_state ()
289 : stop_soon (NO_STOP_QUIETLY
)
293 explicit inferior_control_state (enum stop_kind when
)
298 /* See the definition of stop_kind above. */
299 enum stop_kind stop_soon
;
302 /* Return a pointer to the current inferior. */
303 extern inferior
*current_inferior ();
305 extern void set_current_inferior (inferior
*);
307 /* Switch inferior (and program space) to INF, and switch to no thread
309 extern void switch_to_inferior_no_thread (inferior
*inf
);
311 /* GDB represents the state of each program execution with an object
312 called an inferior. An inferior typically corresponds to a process
313 but is more general and applies also to targets that do not have a
314 notion of processes. Each run of an executable creates a new
315 inferior, as does each attachment to an existing process.
316 Inferiors have unique internal identifiers that are different from
317 target process ids. Each inferior may in turn have multiple
318 threads running in it.
320 Inferiors are intrusively refcounted objects. Unlike thread
321 objects, being the user-selected inferior is considered a strong
322 reference and is thus accounted for in the inferior object's
323 refcount (see set_current_inferior). When GDB needs to remember
324 the selected inferior to later restore it, GDB temporarily bumps
325 the inferior object's refcount, to prevent something deleting the
326 inferior object before reverting back (e.g., due to a
327 "remove-inferiors" command (see
328 scoped_restore_current_inferior). All other inferior
329 references are considered weak references. Inferiors are always
330 listed exactly once in the inferior list, so placing an inferior in
331 the inferior list is an implicit, not counted strong reference. */
333 class inferior
: public refcounted_object
336 explicit inferior (int pid
);
339 /* Returns true if we can delete this inferior. */
340 bool deletable () const { return refcount () == 0; }
342 /* Push T in this inferior's target stack. */
343 void push_target (struct target_ops
*t
)
344 { m_target_stack
.push (t
); }
346 /* Unpush T from this inferior's target stack. */
347 int unpush_target (struct target_ops
*t
)
348 { return m_target_stack
.unpush (t
); }
350 /* Returns true if T is pushed in this inferior's target stack. */
351 bool target_is_pushed (target_ops
*t
)
352 { return m_target_stack
.is_pushed (t
); }
354 /* Find the target beneath T in this inferior's target stack. */
355 target_ops
*find_target_beneath (const target_ops
*t
)
356 { return m_target_stack
.find_beneath (t
); }
358 /* Return the target at the top of this inferior's target stack. */
359 target_ops
*top_target ()
360 { return m_target_stack
.top (); }
362 /* Return the target at process_stratum level in this inferior's
364 struct process_stratum_target
*process_target ()
365 { return (process_stratum_target
*) m_target_stack
.at (process_stratum
); }
367 /* Return the target at STRATUM in this inferior's target stack. */
368 target_ops
*target_at (enum strata stratum
)
369 { return m_target_stack
.at (stratum
); }
371 bool has_execution ()
372 { return target_has_execution_1 (this); }
374 /* Pointer to next inferior in singly-linked list of inferiors. */
375 struct inferior
*next
= NULL
;
377 /* This inferior's thread list. */
378 thread_info
*thread_list
= nullptr;
380 /* Returns a range adapter covering the inferior's threads,
381 including exited threads. Used like this:
383 for (thread_info *thr : inf->threads ())
386 inf_threads_range
threads ()
387 { return inf_threads_range (this->thread_list
); }
389 /* Returns a range adapter covering the inferior's non-exited
390 threads. Used like this:
392 for (thread_info *thr : inf->non_exited_threads ())
395 inf_non_exited_threads_range
non_exited_threads ()
396 { return inf_non_exited_threads_range (this->thread_list
); }
398 /* Like inferior::threads(), but returns a range adapter that can be
399 used with range-for, safely. I.e., it is safe to delete the
400 currently-iterated thread, like this:
402 for (thread_info *t : inf->threads_safe ())
403 if (some_condition ())
406 inline safe_inf_threads_range
threads_safe ()
407 { return safe_inf_threads_range (this->thread_list
); }
409 /* Set/get file name for default use for standard in/out in the
410 inferior. On Unix systems, we try to make TERMINAL_NAME the
411 inferior's controlling terminal. If TERMINAL_NAME is nullptr or
412 the empty string, then the inferior inherits GDB's terminal (or
413 GDBserver's if spawning a remote process). */
414 void set_tty (const char *terminal_name
);
417 /* Convenient handle (GDB inferior id). Unique across all
421 /* Actual target inferior id, usually, a process id. This matches
422 the ptid_t.pid member of threads of this inferior. */
424 /* True if the PID was actually faked by GDB. */
425 bool fake_pid_p
= false;
427 /* The highest thread number this inferior ever had. */
428 int highest_thread_num
= 0;
430 /* State of GDB control of inferior process execution.
431 See `struct inferior_control_state'. */
432 inferior_control_state control
;
434 /* True if this was an auto-created inferior, e.g. created from
435 following a fork; false, if this inferior was manually added by
436 the user, and we should not attempt to prune it
438 bool removable
= false;
440 /* The address space bound to this inferior. */
441 struct address_space
*aspace
= NULL
;
443 /* The program space bound to this inferior. */
444 struct program_space
*pspace
= NULL
;
446 /* The arguments string to use when running. */
449 /* The size of elements in argv. */
452 /* The vector version of arguments. If ARGC is nonzero,
453 then we must compute ARGS from this (via the target).
454 This is always coming from main's argv and therefore
455 should never be freed. */
458 /* The current working directory that will be used when starting
460 gdb::unique_xmalloc_ptr
<char> cwd
;
462 /* The terminal state as set by the last target_terminal::terminal_*
464 target_terminal_state terminal_state
= target_terminal_state::is_ours
;
466 /* Environment to use for running inferior,
467 in format described in environ.h. */
468 gdb_environ environment
;
470 /* True if this child process was attached rather than forked. */
471 bool attach_flag
= false;
473 /* If this inferior is a vfork child, then this is the pointer to
474 its vfork parent, if GDB is still attached to it. */
475 inferior
*vfork_parent
= NULL
;
477 /* If this process is a vfork parent, this is the pointer to the
478 child. Since a vfork parent is left frozen by the kernel until
479 the child execs or exits, a process can only have one vfork child
481 inferior
*vfork_child
= NULL
;
483 /* True if this inferior should be detached when it's vfork sibling
485 bool pending_detach
= false;
487 /* True if this inferior is a vfork parent waiting for a vfork child
488 not under our control to be done with the shared memory region,
489 either by exiting or execing. */
490 bool waiting_for_vfork_done
= false;
492 /* True if we're in the process of detaching from this inferior. */
493 bool detaching
= false;
495 /* What is left to do for an execution command after any thread of
496 this inferior stops. For continuations associated with a
497 specific thread, see `struct thread_info'. */
498 continuation
*continuations
= NULL
;
500 /* True if setup_inferior wasn't called for this inferior yet.
501 Until that is done, we must not access inferior memory or
502 registers, as we haven't determined the target
503 architecture/description. */
504 bool needs_setup
= false;
506 /* Private data used by the target vector implementation. */
507 std::unique_ptr
<private_inferior
> priv
;
509 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
510 In this case, the EXIT_CODE field is also valid. */
511 bool has_exit_code
= false;
512 LONGEST exit_code
= 0;
514 /* Default flags to pass to the symbol reading functions. These are
515 used whenever a new objfile is created. */
516 symfile_add_flags symfile_flags
= 0;
518 /* Info about an inferior's target description (if it's fetched; the
519 user supplied description's filename, if any; etc.). */
520 target_desc_info
*tdesc_info
= NULL
;
522 /* The architecture associated with the inferior through the
523 connection to the target.
525 The architecture vector provides some information that is really
526 a property of the inferior, accessed through a particular target:
527 ptrace operations; the layout of certain RSP packets; the
528 solib_ops vector; etc. To differentiate architecture accesses to
529 per-inferior/target properties from
530 per-thread/per-frame/per-objfile properties, accesses to
531 per-inferior/target properties should be made through
533 struct gdbarch
*gdbarch
= NULL
;
535 /* Data related to displaced stepping. */
536 displaced_step_inferior_state displaced_step_state
;
538 /* Per inferior data-pointers required by other GDB modules. */
542 /* The inferior's target stack. */
543 target_stack m_target_stack
;
545 /* The name of terminal device to use for I/O. */
546 gdb::unique_xmalloc_ptr
<char> m_terminal
;
549 /* Keep a registry of per-inferior data-pointers required by other GDB
552 DECLARE_REGISTRY (inferior
);
554 /* Add an inferior to the inferior list, print a message that a new
555 inferior is found, and return the pointer to the new inferior.
556 Caller may use this pointer to initialize the private inferior
558 extern struct inferior
*add_inferior (int pid
);
560 /* Same as add_inferior, but don't print new inferior notifications to
562 extern struct inferior
*add_inferior_silent (int pid
);
564 extern void delete_inferior (struct inferior
*todel
);
566 /* Delete an existing inferior list entry, due to inferior detaching. */
567 extern void detach_inferior (inferior
*inf
);
569 extern void exit_inferior (inferior
*inf
);
571 extern void exit_inferior_silent (inferior
*inf
);
573 extern void exit_inferior_num_silent (int num
);
575 extern void inferior_appeared (struct inferior
*inf
, int pid
);
577 /* Search function to lookup an inferior of TARG by target 'pid'. */
578 extern struct inferior
*find_inferior_pid (process_stratum_target
*targ
,
581 /* Search function to lookup an inferior of TARG whose pid is equal to
583 extern struct inferior
*find_inferior_ptid (process_stratum_target
*targ
,
586 /* Search function to lookup an inferior by GDB 'num'. */
587 extern struct inferior
*find_inferior_id (int num
);
589 /* Find an inferior bound to PSPACE, giving preference to the current
591 extern struct inferior
*
592 find_inferior_for_program_space (struct program_space
*pspace
);
594 /* Returns true if the inferior list is not empty. */
595 extern int have_inferiors (void);
597 /* Returns the number of live inferiors running on PROC_TARGET (real
598 live processes with execution). */
599 extern int number_of_live_inferiors (process_stratum_target
*proc_target
);
601 /* Returns true if there are any live inferiors in the inferior list
602 (not cores, not executables, real live processes). */
603 extern int have_live_inferiors (void);
605 /* Save/restore the current inferior. */
607 class scoped_restore_current_inferior
610 scoped_restore_current_inferior ()
611 : m_saved_inf (current_inferior ())
614 ~scoped_restore_current_inferior ()
615 { set_current_inferior (m_saved_inf
); }
617 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior
);
620 inferior
*m_saved_inf
;
624 /* Traverse all inferiors. */
626 extern struct inferior
*inferior_list
;
628 /* Pull in the internals of the inferiors ranges and iterators. Must
629 be done after struct inferior is defined. */
630 #include "inferior-iter.h"
632 /* Return a range that can be used to walk over all inferiors
633 inferiors, with range-for, safely. I.e., it is safe to delete the
634 currently-iterated inferior. When combined with range-for, this
635 allow convenient patterns like this:
637 for (inferior *inf : all_inferiors_safe ())
638 if (some_condition ())
642 inline all_inferiors_safe_range
643 all_inferiors_safe ()
648 /* Returns a range representing all inferiors, suitable to use with
649 range-for, like this:
651 for (inferior *inf : all_inferiors ())
655 inline all_inferiors_range
656 all_inferiors (process_stratum_target
*proc_target
= nullptr)
658 return all_inferiors_range (proc_target
);
661 /* Return a range that can be used to walk over all inferiors with PID
662 not zero, with range-for. */
664 inline all_non_exited_inferiors_range
665 all_non_exited_inferiors (process_stratum_target
*proc_target
= nullptr)
667 return all_non_exited_inferiors_range (proc_target
);
670 /* Prune away automatically added inferiors that aren't required
672 extern void prune_inferiors (void);
674 extern int number_of_inferiors (void);
676 extern struct inferior
*add_inferior_with_spaces (void);
678 /* Print the current selected inferior. */
679 extern void print_selected_inferior (struct ui_out
*uiout
);
681 #endif /* !defined (INFERIOR_H) */