mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-21 04:42:53 +08:00
0803633106
As preparation for multi-target, this patch makes each inferior have
its own thread list.
This isn't absolutely necessary for multi-target, but simplifies
things. It originally stemmed from the desire to eliminate the
init_thread_list calls sprinkled around, plus it makes it more
efficient to iterate over threads of a given inferior (no need to
always iterate over threads of all inferiors).
We still need to iterate over threads of all inferiors in a number of
places, which means we'd need adjust the ALL_THREADS /
ALL_NON_EXITED_THREADS macros. However, naively tweaking those macros
to have an extra for loop, like:
#define ALL_THREADS (thr, inf) \
for (inf = inferior_list; inf; inf = inf->next) \
for (thr = inf->thread_list; thr; thr = thr->next)
causes problems with code that does "break" or "continue" within the
ALL_THREADS loop body. Plus, we need to declare the extra "inf" local
variable in order to pass it as temporary variable to ALL_THREADS
(etc.)
It gets even trickier when we consider extending the macros to filter
out threads matching a ptid_t and a target. The macros become tricker
to read/write. Been there.
An alternative (which was my next attempt), is to replace the
ALL_THREADS etc. iteration style with for_each_all_threads,
for_each_non_exited_threads, etc. functions which would take a
callback as parameter, which would usually be passed a lambda.
However, I did not find that satisfactory at all, because the
resulting code ends up a little less natural / more noisy to read,
write and debug/step-through (due to use of lambdas), and in many
places where we use "continue;" to skip to the next thread now need to
use "return;". (I ran into hard to debug bugs caused by a
continue/return confusion.)
I.e., before:
ALL_NON_EXITED_THREADS (tp)
{
if (tp->not_what_I_want)
continue;
// do something
}
would turn into:
for_each_non_exited_thread ([&] (thread_info *tp)
{
if (tp->not_what_I_want)
return;
// do something
});
Lastly, the solution I settled with was to replace the ALL_THREADS /
ALL_NON_EXITED_THREADS / ALL_INFERIORS macros with (C++20-like) ranges
and iterators, such that you can instead naturaly iterate over
threads/inferiors using range-for, like e.g,.:
// all threads, including THREAD_EXITED threads.
for (thread_info *tp : all_threads ())
{ .... }
// all non-exited threads.
for (thread_info *tp : all_non_exited_threads ())
{ .... }
// all non-exited threads of INF inferior.
for (thread_info *tp : inf->non_exited_threads ())
{ .... }
The all_non_exited_threads() function takes an optional filter ptid_t as
parameter, which is quite convenient when we need to iterate over
threads matching that filter. See e.g., how the
set_executing/set_stop_requested/finish_thread_state etc. functions in
thread.c end up being simplified.
Most of the patch thus is about adding the infrustructure for allowing
the above. Later on when we get to actual multi-target, these
functions/ranges/iterators will gain a "target_ops *" parameter so
that e.g., we can iterate over all threads of a given target that
match a given filter ptid_t.
The only entry points users needs to be aware of are the
all_threads/all_non_exited_threads etc. functions seen above. Thus,
those functions are declared in gdbthread.h/inferior.h. The actual
iterators/ranges are mainly "internals" and thus are put out of view
in the new thread-iter.h/thread-iter.c/inferior-iter.h files. That
keeps the gdbthread.h/inferior.h headers quite a bit more readable.
A common/safe-iterator.h header is added which adds a template that
can be used to build "safe" iterators, which are forward iterators
that can be used to replace the ALL_THREADS_SAFE macro and other
instances of the same idiom in future.
There's a little bit of shuffling of code between
gdbthread.h/thread.c/inferior.h in the patch. That is necessary in
order to avoid circular dependencies between the
gdbthread.h/inferior.h headers.
As for the init_thread_list calls sprinkled around, they're all
eliminated by this patch, and a new, central call is added to
inferior_appeared. Note how also related to that, there's a call to
init_wait_for_inferior in remote.c that is eliminated.
init_wait_for_inferior is currently responsible for discarding skipped
inline frames, which had to be moved elsewhere. Given that nowadays
we always have a thread even for single-threaded processes, the
natural place is to delete a frame's inline frame info when we delete
the thread. I.e., from clear_thread_inferior_resources.
gdb/ChangeLog:
2018-11-22 Pedro Alves <palves@redhat.com>
* Makefile.in (COMMON_SFILES): Add thread-iter.c.
* breakpoint.c (breakpoints_should_be_inserted_now): Replace
ALL_NON_EXITED_THREADS with all_non_exited_threads.
(print_one_breakpoint_location): Replace ALL_INFERIORS with
all_inferiors.
* bsd-kvm.c: Include inferior.h.
* btrace.c (btrace_free_objfile): Replace ALL_NON_EXITED_THREADS
with all_non_exited_threads.
* common/filtered-iterator.h: New.
* common/safe-iterator.h: New.
* corelow.c (core_target_open): Don't call init_thread_list here.
* darwin-nat.c (thread_info_from_private_thread_info): Replace
ALL_THREADS with all_threads.
* fbsd-nat.c (fbsd_nat_target::resume): Replace
ALL_NON_EXITED_THREADS with inf->non_exited_threads.
* fbsd-tdep.c (fbsd_make_corefile_notes): Replace
ALL_NON_EXITED_THREADS with inf->non_exited_threads.
* fork-child.c (postfork_hook): Don't call init_thread_list here.
* gdbarch-selftests.c (register_to_value_test): Adjust.
* gdbthread.h: Don't include "inferior.h" here.
(struct inferior): Forward declare.
(enum step_over_calls_kind): Moved here from inferior.h.
(thread_info::deletable): Definition moved to thread.c.
(find_thread_ptid (inferior *, ptid_t)): Declare.
(ALL_THREADS, ALL_THREADS_BY_INFERIOR, ALL_THREADS_SAFE): Delete.
Include "thread-iter.h".
(all_threads, all_non_exited_threads, all_threads_safe): New.
(any_thread_p): Declare.
(thread_list): Delete.
* infcmd.c (signal_command): Replace ALL_NON_EXITED_THREADS with
all_non_exited_threads.
(proceed_after_attach_callback): Delete.
(proceed_after_attach): Take an inferior pointer instead of an
integer PID. Adjust to use range-for.
(attach_post_wait): Pass down inferior pointer instead of pid.
Use range-for instead of ALL_NON_EXITED_THREADS.
(detach_command): Remove init_thread_list call.
* inferior-iter.h: New.
* inferior.c (struct delete_thread_of_inferior_arg): Delete.
(delete_thread_of_inferior): Delete.
(delete_inferior, exit_inferior_1): Use range-for with
inf->threads_safe() instead of iterate_over_threads.
(inferior_appeared): Call init_thread_list here.
(discard_all_inferiors): Use all_non_exited_inferiors.
(find_inferior_id, find_inferior_pid): Use all_inferiors.
(iterate_over_inferiors): Use all_inferiors_safe.
(have_inferiors, number_of_live_inferiors): Use
all_non_exited_inferiors.
(number_of_inferiors): Use all_inferiors and std::distance.
(print_inferior): Use all_inferiors.
* inferior.h: Include gdbthread.h.
(enum step_over_calls_kind): Moved to gdbthread.h.
(struct inferior) <thread_list>: New field.
<threads, non_exited_threads, threads_safe>: New methods.
(ALL_INFERIORS): Delete.
Include "inferior-iter.h".
(ALL_NON_EXITED_INFERIORS): Delete.
(all_inferiors_safe, all_inferiors, all_non_exited_inferiors): New
functions.
* inflow.c (child_interrupt, child_pass_ctrlc): Replace
ALL_NON_EXITED_THREADS with all_non_exited_threads.
* infrun.c (follow_exec): Use all_threads_safe.
(clear_proceed_status, proceed): Use all_non_exited_threads.
(init_wait_for_inferior): Don't clear inline frame state here.
(infrun_thread_stop_requested, for_each_just_stopped_thread): Use
all_threads instead of ALL_NON_EXITED_THREADS.
(random_pending_event_thread): Use all_non_exited_threads instead
of ALL_NON_EXITED_THREADS. Use a lambda for repeated code.
(clean_up_just_stopped_threads_fsms): Use all_non_exited_threads
instead of ALL_NON_EXITED_THREADS.
(handle_no_resumed): Use all_non_exited_threads instead of
ALL_NON_EXITED_THREADS. Use all_inferiors instead of
ALL_INFERIORS.
(restart_threads, switch_back_to_stepped_thread): Use
all_non_exited_threads instead of ALL_NON_EXITED_THREADS.
* linux-nat.c (check_zombie_leaders): Replace ALL_INFERIORS with
all_inferiors.
(kill_unfollowed_fork_children): Use inf->non_exited_threads
instead of ALL_NON_EXITED_THREADS.
* linux-tdep.c (linux_make_corefile_notes): Use
inf->non_exited_threads instead of ALL_NON_EXITED_THREADS.
* linux-thread-db.c (thread_db_target::update_thread_list):
Replace ALL_INFERIORS with all_inferiors.
(thread_db_target::thread_handle_to_thread_info): Use
inf->non_exited_threads instead of ALL_NON_EXITED_THREADS.
* mi/mi-interp.c (multiple_inferiors_p): New.
(mi_on_resume_1): Simplify using all_non_exited_threads and
multiple_inferiors_p.
* mi/mi-main.c (mi_cmd_thread_list_ids): Use all_non_exited_threads
instead of ALL_NON_EXITED_THREADS.
* nto-procfs.c (nto_procfs_target::open): Don't call
init_thread_list here.
* record-btrace.c (record_btrace_target_open)
(record_btrace_target::stop_recording)
(record_btrace_target::close)
(record_btrace_target::record_is_replaying)
(record_btrace_target::resume, record_btrace_target::wait)
(record_btrace_target::record_stop_replaying): Use
all_non_exited_threads instead of ALL_NON_EXITED_THREADS.
* record-full.c (record_full_wait_1): Use all_non_exited_threads
instead of ALL_NON_EXITED_THREADS.
* regcache.c (cooked_read_test): Remove reference to global
thread_list.
* remote-sim.c (gdbsim_target::create_inferior): Don't call
init_thread_list here.
* remote.c (remote_target::update_thread_list): Use
all_threads_safe instead of ALL_NON_EXITED_THREADS.
(remote_target::process_initial_stop_replies): Replace
ALL_INFERIORS with all_non_exited_inferiors and use
all_non_exited_threads instead of ALL_NON_EXITED_THREADS.
(remote_target::open_1): Don't call init_thread_list here.
(remote_target::append_pending_thread_resumptions)
(remote_target::remote_resume_with_hc): Use all_non_exited_threads
instead of ALL_NON_EXITED_THREADS.
(remote_target::commit_resume)
(remote_target::remove_new_fork_children): Replace ALL_INFERIORS
with all_non_exited_inferiors and use all_non_exited_threads
instead of ALL_NON_EXITED_THREADS.
(remote_target::kill_new_fork_children): Use
all_non_exited_threads instead of ALL_NON_EXITED_THREADS. Remove
init_thread_list and init_wait_for_inferior calls.
(remote_target::remote_btrace_maybe_reopen)
(remote_target::thread_handle_to_thread_info): Use
all_non_exited_threads instead of ALL_NON_EXITED_THREADS.
* target.c (target_terminal::restore_inferior)
(target_terminal_is_ours_kind): Replace ALL_INFERIORS with
all_non_exited_inferiors.
* thread-iter.c: New file.
* thread-iter.h: New file.
* thread.c: Include "inline-frame.h".
(thread_list): Delete.
(clear_thread_inferior_resources): Call clear_inline_frame_state.
(init_thread_list): Use all_threads_safe instead of
ALL_THREADS_SAFE. Adjust to per-inferior thread lists.
(new_thread): Adjust to per-inferior thread lists.
(add_thread_silent): Pass inferior to find_thread_ptid.
(thread_info::deletable): New, moved from the header.
(delete_thread_1): Adjust to per-inferior thread lists.
(find_thread_global_id): Use inf->threads().
(find_thread_ptid): Use find_inferior_ptid and pass inferior to
find_thread_ptid.
(find_thread_ptid(inferior*, ptid_t)): New overload.
(iterate_over_threads): Use all_threads_safe.
(any_thread_p): New.
(thread_count): Use all_threads and std::distance.
(live_threads_count): Use all_non_exited_threads and
std::distance.
(valid_global_thread_id): Use all_threads.
(in_thread_list): Use find_thread_ptid.
(first_thread_of_inferior): Adjust to per-inferior thread lists.
(any_thread_of_inferior, any_live_thread_of_inferior): Use
inf->non_exited_threads().
(prune_threads, delete_exited_threads): Use all_threads_safe.
(thread_change_ptid): Pass inferior pointer to find_thread_ptid.
(set_resumed, set_running): Use all_non_exited_threads.
(is_thread_state, is_stopped, is_exited, is_running)
(is_executing): Delete.
(set_executing, set_stop_requested, finish_thread_state): Use
all_non_exited_threads.
(print_thread_info_1): Use all_inferiors and all_threads.
(thread_apply_all_command): Use all_non_exited_threads.
(thread_find_command): Use all_threads.
(update_threads_executing): Use all_non_exited_threads.
* tid-parse.c (parse_thread_id): Use inf->threads.
* x86-bsd-nat.c (x86bsd_dr_set): Use inf->non_exited_threads ().
656 lines
21 KiB
C++
656 lines
21 KiB
C++
/* Variables that describe the inferior process running under GDB:
|
||
Where it is, why it stopped, and how to step it.
|
||
|
||
Copyright (C) 1986-2018 Free Software Foundation, Inc.
|
||
|
||
This file is part of GDB.
|
||
|
||
This program is free software; you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation; either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
||
|
||
#if !defined (INFERIOR_H)
|
||
#define INFERIOR_H 1
|
||
|
||
struct target_waitstatus;
|
||
struct frame_info;
|
||
struct ui_file;
|
||
struct type;
|
||
struct gdbarch;
|
||
struct regcache;
|
||
struct ui_out;
|
||
struct terminal_info;
|
||
struct target_desc_info;
|
||
struct continuation;
|
||
struct inferior;
|
||
struct thread_info;
|
||
|
||
/* For bpstat. */
|
||
#include "breakpoint.h"
|
||
|
||
/* For enum gdb_signal. */
|
||
#include "target.h"
|
||
|
||
/* For struct frame_id. */
|
||
#include "frame.h"
|
||
|
||
/* For gdb_environ. */
|
||
#include "environ.h"
|
||
|
||
#include "progspace.h"
|
||
#include "registry.h"
|
||
|
||
#include "symfile-add-flags.h"
|
||
#include "common/refcounted-object.h"
|
||
|
||
#include "common-inferior.h"
|
||
#include "gdbthread.h"
|
||
|
||
struct infcall_suspend_state;
|
||
struct infcall_control_state;
|
||
|
||
extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
|
||
extern void restore_infcall_control_state (struct infcall_control_state *);
|
||
|
||
/* A deleter for infcall_suspend_state that calls
|
||
restore_infcall_suspend_state. */
|
||
struct infcall_suspend_state_deleter
|
||
{
|
||
void operator() (struct infcall_suspend_state *state) const
|
||
{
|
||
restore_infcall_suspend_state (state);
|
||
}
|
||
};
|
||
|
||
/* A unique_ptr specialization for infcall_suspend_state. */
|
||
typedef std::unique_ptr<infcall_suspend_state, infcall_suspend_state_deleter>
|
||
infcall_suspend_state_up;
|
||
|
||
extern infcall_suspend_state_up save_infcall_suspend_state ();
|
||
|
||
/* A deleter for infcall_control_state that calls
|
||
restore_infcall_control_state. */
|
||
struct infcall_control_state_deleter
|
||
{
|
||
void operator() (struct infcall_control_state *state) const
|
||
{
|
||
restore_infcall_control_state (state);
|
||
}
|
||
};
|
||
|
||
/* A unique_ptr specialization for infcall_control_state. */
|
||
typedef std::unique_ptr<infcall_control_state, infcall_control_state_deleter>
|
||
infcall_control_state_up;
|
||
|
||
extern infcall_control_state_up save_infcall_control_state ();
|
||
|
||
extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
|
||
extern void discard_infcall_control_state (struct infcall_control_state *);
|
||
|
||
extern readonly_detached_regcache *
|
||
get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
|
||
|
||
extern void set_sigint_trap (void);
|
||
|
||
extern void clear_sigint_trap (void);
|
||
|
||
/* Set/get file name for default use for standard in/out in the inferior. */
|
||
|
||
extern void set_inferior_io_terminal (const char *terminal_name);
|
||
extern const char *get_inferior_io_terminal (void);
|
||
|
||
/* Collected pid, tid, etc. of the debugged inferior. When there's
|
||
no inferior, inferior_ptid.pid () will be 0. */
|
||
|
||
extern ptid_t inferior_ptid;
|
||
|
||
extern void generic_mourn_inferior (void);
|
||
|
||
extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
|
||
struct type *type,
|
||
const gdb_byte *buf);
|
||
extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
|
||
struct type *type, gdb_byte *buf,
|
||
CORE_ADDR addr);
|
||
extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
|
||
struct type *type,
|
||
const gdb_byte *buf);
|
||
extern void address_to_signed_pointer (struct gdbarch *gdbarch,
|
||
struct type *type, gdb_byte *buf,
|
||
CORE_ADDR addr);
|
||
|
||
extern void reopen_exec_file (void);
|
||
|
||
/* From misc files */
|
||
|
||
extern void default_print_registers_info (struct gdbarch *gdbarch,
|
||
struct ui_file *file,
|
||
struct frame_info *frame,
|
||
int regnum, int all);
|
||
|
||
/* Default implementation of gdbarch_print_float_info. Print
|
||
the values of all floating point registers. */
|
||
|
||
extern void default_print_float_info (struct gdbarch *gdbarch,
|
||
struct ui_file *file,
|
||
struct frame_info *frame,
|
||
const char *args);
|
||
|
||
extern void child_terminal_info (struct target_ops *self, const char *, int);
|
||
|
||
extern void info_terminal_command (char *, int);
|
||
|
||
extern void child_terminal_ours (struct target_ops *self);
|
||
|
||
extern void child_terminal_ours_for_output (struct target_ops *self);
|
||
|
||
extern void child_terminal_inferior (struct target_ops *self);
|
||
|
||
extern void child_terminal_save_inferior (struct target_ops *self);
|
||
|
||
extern void child_terminal_init (struct target_ops *self);
|
||
|
||
extern void child_terminal_init_with_pgrp (int pgrp);
|
||
|
||
extern void child_pass_ctrlc (struct target_ops *self);
|
||
|
||
extern void child_interrupt (struct target_ops *self);
|
||
|
||
/* From fork-child.c */
|
||
|
||
/* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
|
||
This function already calls set_executing. Return the ptid_t from
|
||
STARTUP_INFERIOR. */
|
||
extern ptid_t gdb_startup_inferior (pid_t pid, int num_traps);
|
||
|
||
extern char *construct_inferior_arguments (int, char **);
|
||
|
||
/* From infcmd.c */
|
||
|
||
/* Initial inferior setup. Determines the exec file is not yet known,
|
||
takes any necessary post-attaching actions, fetches the target
|
||
description and syncs the shared library list. */
|
||
|
||
extern void setup_inferior (int from_tty);
|
||
|
||
extern void post_create_inferior (struct target_ops *, int);
|
||
|
||
extern void attach_command (const char *, int);
|
||
|
||
extern const char *get_inferior_args (void);
|
||
|
||
extern void set_inferior_args (const char *);
|
||
|
||
extern void set_inferior_args_vector (int, char **);
|
||
|
||
extern void registers_info (const char *, int);
|
||
|
||
extern void continue_1 (int all_threads);
|
||
|
||
extern void interrupt_target_1 (int all_threads);
|
||
|
||
extern void delete_longjmp_breakpoint_cleanup (void *arg);
|
||
|
||
extern void detach_command (const char *, int);
|
||
|
||
extern void notice_new_inferior (struct thread_info *, int, int);
|
||
|
||
extern struct value *get_return_value (struct value *function,
|
||
struct type *value_type);
|
||
|
||
/* Prepare for execution command. TARGET is the target that will run
|
||
the command. BACKGROUND determines whether this is a foreground
|
||
(synchronous) or background (asynchronous) command. */
|
||
|
||
extern void prepare_execution_command (struct target_ops *target,
|
||
int background);
|
||
|
||
/* Whether to start up the debuggee under a shell.
|
||
|
||
If startup-with-shell is set, GDB's "run" will attempt to start up
|
||
the debuggee under a shell.
|
||
|
||
This is in order for argument-expansion to occur. E.g.,
|
||
|
||
(gdb) run *
|
||
|
||
The "*" gets expanded by the shell into a list of files.
|
||
|
||
While this is a nice feature, it may be handy to bypass the shell
|
||
in some cases. To disable this feature, do "set startup-with-shell
|
||
false".
|
||
|
||
The catch-exec traps expected during start-up will be one more if
|
||
the target is started up with a shell. */
|
||
extern int startup_with_shell;
|
||
|
||
/* Nonzero if stopped due to completion of a stack dummy routine. */
|
||
|
||
extern enum stop_stack_kind stop_stack_dummy;
|
||
|
||
/* Nonzero if program stopped due to a random (unexpected) signal in
|
||
inferior process. */
|
||
|
||
extern int stopped_by_random_signal;
|
||
|
||
/* Print notices on inferior events (attach, detach, etc.), set with
|
||
`set print inferior-events'. */
|
||
extern int print_inferior_events;
|
||
|
||
/* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
|
||
will handle it themselves. STOP_QUIETLY is used when running in
|
||
the shell before the child program has been exec'd and when running
|
||
through shared library loading. STOP_QUIETLY_REMOTE is used when
|
||
setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
|
||
except that there is no need to hide a signal. */
|
||
|
||
/* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
|
||
When doing an attach, the kernel stops the debuggee with a SIGSTOP.
|
||
On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
|
||
a ptraced process has changed. Earlier versions of the kernel
|
||
would ignore these SIGSTOPs, while now SIGSTOP is treated like any
|
||
other signal, i.e. it is not muffled.
|
||
|
||
If the gdb user does a 'continue' after the 'attach', gdb passes
|
||
the global variable stop_signal (which stores the signal from the
|
||
attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
|
||
problematic, because the kernel doesn't ignore such SIGSTOP
|
||
now. I.e. it is reported back to gdb, which in turn presents it
|
||
back to the user.
|
||
|
||
To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
|
||
gdb to clear the value of stop_signal after the attach, so that it
|
||
is not passed back down to the kernel. */
|
||
|
||
enum stop_kind
|
||
{
|
||
NO_STOP_QUIETLY = 0,
|
||
STOP_QUIETLY,
|
||
STOP_QUIETLY_REMOTE,
|
||
STOP_QUIETLY_NO_SIGSTOP
|
||
};
|
||
|
||
|
||
/* Possible values for gdbarch_call_dummy_location. */
|
||
#define ON_STACK 1
|
||
#define AT_ENTRY_POINT 4
|
||
|
||
/* Base class for target-specific inferior data. */
|
||
|
||
struct private_inferior
|
||
{
|
||
virtual ~private_inferior () = 0;
|
||
};
|
||
|
||
/* Inferior process specific part of `struct infcall_control_state'.
|
||
|
||
Inferior thread counterpart is `struct thread_control_state'. */
|
||
|
||
struct inferior_control_state
|
||
{
|
||
inferior_control_state ()
|
||
: stop_soon (NO_STOP_QUIETLY)
|
||
{
|
||
}
|
||
|
||
explicit inferior_control_state (enum stop_kind when)
|
||
: stop_soon (when)
|
||
{
|
||
}
|
||
|
||
/* See the definition of stop_kind above. */
|
||
enum stop_kind stop_soon;
|
||
};
|
||
|
||
/* Return a pointer to the current inferior. */
|
||
extern inferior *current_inferior ();
|
||
|
||
extern void set_current_inferior (inferior *);
|
||
|
||
/* GDB represents the state of each program execution with an object
|
||
called an inferior. An inferior typically corresponds to a process
|
||
but is more general and applies also to targets that do not have a
|
||
notion of processes. Each run of an executable creates a new
|
||
inferior, as does each attachment to an existing process.
|
||
Inferiors have unique internal identifiers that are different from
|
||
target process ids. Each inferior may in turn have multiple
|
||
threads running in it.
|
||
|
||
Inferiors are intrusively refcounted objects. Unlike thread
|
||
objects, being the user-selected inferior is considered a strong
|
||
reference and is thus accounted for in the inferior object's
|
||
refcount (see set_current_inferior). When GDB needs to remember
|
||
the selected inferior to later restore it, GDB temporarily bumps
|
||
the inferior object's refcount, to prevent something deleting the
|
||
inferior object before reverting back (e.g., due to a
|
||
"remove-inferiors" command (see
|
||
make_cleanup_restore_current_thread). All other inferior
|
||
references are considered weak references. Inferiors are always
|
||
listed exactly once in the inferior list, so placing an inferior in
|
||
the inferior list is an implicit, not counted strong reference. */
|
||
|
||
class inferior : public refcounted_object
|
||
{
|
||
public:
|
||
explicit inferior (int pid);
|
||
~inferior ();
|
||
|
||
/* Returns true if we can delete this inferior. */
|
||
bool deletable () const { return refcount () == 0; }
|
||
|
||
/* Pointer to next inferior in singly-linked list of inferiors. */
|
||
struct inferior *next = NULL;
|
||
|
||
/* This inferior's thread list. */
|
||
thread_info *thread_list = nullptr;
|
||
|
||
/* Returns a range adapter covering the inferior's threads,
|
||
including exited threads. Used like this:
|
||
|
||
for (thread_info *thr : inf->threads ())
|
||
{ .... }
|
||
*/
|
||
inf_threads_range threads ()
|
||
{ return inf_threads_range (this->thread_list); }
|
||
|
||
/* Returns a range adapter covering the inferior's non-exited
|
||
threads. Used like this:
|
||
|
||
for (thread_info *thr : inf->non_exited_threads ())
|
||
{ .... }
|
||
*/
|
||
inf_non_exited_threads_range non_exited_threads ()
|
||
{ return inf_non_exited_threads_range (this->thread_list); }
|
||
|
||
/* Like inferior::threads(), but returns a range adapter that can be
|
||
used with range-for, safely. I.e., it is safe to delete the
|
||
currently-iterated thread, like this:
|
||
|
||
for (thread_info *t : inf->threads_safe ())
|
||
if (some_condition ())
|
||
delete f;
|
||
*/
|
||
inline safe_inf_threads_range threads_safe ()
|
||
{ return safe_inf_threads_range (this->thread_list); }
|
||
|
||
/* Convenient handle (GDB inferior id). Unique across all
|
||
inferiors. */
|
||
int num = 0;
|
||
|
||
/* Actual target inferior id, usually, a process id. This matches
|
||
the ptid_t.pid member of threads of this inferior. */
|
||
int pid = 0;
|
||
/* True if the PID was actually faked by GDB. */
|
||
bool fake_pid_p = false;
|
||
|
||
/* The highest thread number this inferior ever had. */
|
||
int highest_thread_num = 0;
|
||
|
||
/* State of GDB control of inferior process execution.
|
||
See `struct inferior_control_state'. */
|
||
inferior_control_state control;
|
||
|
||
/* True if this was an auto-created inferior, e.g. created from
|
||
following a fork; false, if this inferior was manually added by
|
||
the user, and we should not attempt to prune it
|
||
automatically. */
|
||
bool removable = false;
|
||
|
||
/* The address space bound to this inferior. */
|
||
struct address_space *aspace = NULL;
|
||
|
||
/* The program space bound to this inferior. */
|
||
struct program_space *pspace = NULL;
|
||
|
||
/* The arguments string to use when running. */
|
||
char *args = NULL;
|
||
|
||
/* The size of elements in argv. */
|
||
int argc = 0;
|
||
|
||
/* The vector version of arguments. If ARGC is nonzero,
|
||
then we must compute ARGS from this (via the target).
|
||
This is always coming from main's argv and therefore
|
||
should never be freed. */
|
||
char **argv = NULL;
|
||
|
||
/* The current working directory that will be used when starting
|
||
this inferior. */
|
||
gdb::unique_xmalloc_ptr<char> cwd;
|
||
|
||
/* The name of terminal device to use for I/O. */
|
||
char *terminal = NULL;
|
||
|
||
/* The terminal state as set by the last target_terminal::terminal_*
|
||
call. */
|
||
target_terminal_state terminal_state = target_terminal_state::is_ours;
|
||
|
||
/* Environment to use for running inferior,
|
||
in format described in environ.h. */
|
||
gdb_environ environment;
|
||
|
||
/* True if this child process was attached rather than forked. */
|
||
bool attach_flag = false;
|
||
|
||
/* If this inferior is a vfork child, then this is the pointer to
|
||
its vfork parent, if GDB is still attached to it. */
|
||
inferior *vfork_parent = NULL;
|
||
|
||
/* If this process is a vfork parent, this is the pointer to the
|
||
child. Since a vfork parent is left frozen by the kernel until
|
||
the child execs or exits, a process can only have one vfork child
|
||
at a given time. */
|
||
inferior *vfork_child = NULL;
|
||
|
||
/* True if this inferior should be detached when it's vfork sibling
|
||
exits or execs. */
|
||
bool pending_detach = false;
|
||
|
||
/* True if this inferior is a vfork parent waiting for a vfork child
|
||
not under our control to be done with the shared memory region,
|
||
either by exiting or execing. */
|
||
bool waiting_for_vfork_done = false;
|
||
|
||
/* True if we're in the process of detaching from this inferior. */
|
||
bool detaching = false;
|
||
|
||
/* What is left to do for an execution command after any thread of
|
||
this inferior stops. For continuations associated with a
|
||
specific thread, see `struct thread_info'. */
|
||
continuation *continuations = NULL;
|
||
|
||
/* True if setup_inferior wasn't called for this inferior yet.
|
||
Until that is done, we must not access inferior memory or
|
||
registers, as we haven't determined the target
|
||
architecture/description. */
|
||
bool needs_setup = false;
|
||
|
||
/* Private data used by the target vector implementation. */
|
||
std::unique_ptr<private_inferior> priv;
|
||
|
||
/* HAS_EXIT_CODE is true if the inferior exited with an exit code.
|
||
In this case, the EXIT_CODE field is also valid. */
|
||
bool has_exit_code = false;
|
||
LONGEST exit_code = 0;
|
||
|
||
/* Default flags to pass to the symbol reading functions. These are
|
||
used whenever a new objfile is created. */
|
||
symfile_add_flags symfile_flags = 0;
|
||
|
||
/* Info about an inferior's target description (if it's fetched; the
|
||
user supplied description's filename, if any; etc.). */
|
||
target_desc_info *tdesc_info = NULL;
|
||
|
||
/* The architecture associated with the inferior through the
|
||
connection to the target.
|
||
|
||
The architecture vector provides some information that is really
|
||
a property of the inferior, accessed through a particular target:
|
||
ptrace operations; the layout of certain RSP packets; the
|
||
solib_ops vector; etc. To differentiate architecture accesses to
|
||
per-inferior/target properties from
|
||
per-thread/per-frame/per-objfile properties, accesses to
|
||
per-inferior/target properties should be made through
|
||
this gdbarch. */
|
||
struct gdbarch *gdbarch = NULL;
|
||
|
||
/* Per inferior data-pointers required by other GDB modules. */
|
||
REGISTRY_FIELDS;
|
||
};
|
||
|
||
/* Keep a registry of per-inferior data-pointers required by other GDB
|
||
modules. */
|
||
|
||
DECLARE_REGISTRY (inferior);
|
||
|
||
/* Add an inferior to the inferior list, print a message that a new
|
||
inferior is found, and return the pointer to the new inferior.
|
||
Caller may use this pointer to initialize the private inferior
|
||
data. */
|
||
extern struct inferior *add_inferior (int pid);
|
||
|
||
/* Same as add_inferior, but don't print new inferior notifications to
|
||
the CLI. */
|
||
extern struct inferior *add_inferior_silent (int pid);
|
||
|
||
extern void delete_inferior (struct inferior *todel);
|
||
|
||
/* Delete an existing inferior list entry, due to inferior detaching. */
|
||
extern void detach_inferior (inferior *inf);
|
||
|
||
extern void exit_inferior (inferior *inf);
|
||
|
||
extern void exit_inferior_silent (inferior *inf);
|
||
|
||
extern void exit_inferior_num_silent (int num);
|
||
|
||
extern void inferior_appeared (struct inferior *inf, int pid);
|
||
|
||
/* Get rid of all inferiors. */
|
||
extern void discard_all_inferiors (void);
|
||
|
||
/* Search function to lookup an inferior by target 'pid'. */
|
||
extern struct inferior *find_inferior_pid (int pid);
|
||
|
||
/* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */
|
||
extern struct inferior *find_inferior_ptid (ptid_t ptid);
|
||
|
||
/* Search function to lookup an inferior by GDB 'num'. */
|
||
extern struct inferior *find_inferior_id (int num);
|
||
|
||
/* Find an inferior bound to PSPACE, giving preference to the current
|
||
inferior. */
|
||
extern struct inferior *
|
||
find_inferior_for_program_space (struct program_space *pspace);
|
||
|
||
/* Inferior iterator function.
|
||
|
||
Calls a callback function once for each inferior, so long as the
|
||
callback function returns false. If the callback function returns
|
||
true, the iteration will end and the current inferior will be
|
||
returned. This can be useful for implementing a search for a
|
||
inferior with arbitrary attributes, or for applying some operation
|
||
to every inferior.
|
||
|
||
It is safe to delete the iterated inferior from the callback. */
|
||
extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
|
||
void *),
|
||
void *);
|
||
|
||
/* Returns true if the inferior list is not empty. */
|
||
extern int have_inferiors (void);
|
||
|
||
/* Returns the number of live inferiors (real live processes). */
|
||
extern int number_of_live_inferiors (void);
|
||
|
||
/* Returns true if there are any live inferiors in the inferior list
|
||
(not cores, not executables, real live processes). */
|
||
extern int have_live_inferiors (void);
|
||
|
||
/* Save/restore the current inferior. */
|
||
|
||
class scoped_restore_current_inferior
|
||
{
|
||
public:
|
||
scoped_restore_current_inferior ()
|
||
: m_saved_inf (current_inferior ())
|
||
{}
|
||
|
||
~scoped_restore_current_inferior ()
|
||
{ set_current_inferior (m_saved_inf); }
|
||
|
||
DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior);
|
||
|
||
private:
|
||
inferior *m_saved_inf;
|
||
};
|
||
|
||
|
||
/* Traverse all inferiors. */
|
||
|
||
extern struct inferior *inferior_list;
|
||
|
||
/* Pull in the internals of the inferiors ranges and iterators. Must
|
||
be done after struct inferior is defined. */
|
||
#include "inferior-iter.h"
|
||
|
||
/* Return a range that can be used to walk over all inferiors
|
||
inferiors, with range-for, safely. I.e., it is safe to delete the
|
||
currently-iterated inferior. When combined with range-for, this
|
||
allow convenient patterns like this:
|
||
|
||
for (inferior *inf : all_inferiors_safe ())
|
||
if (some_condition ())
|
||
delete inf;
|
||
*/
|
||
|
||
inline all_inferiors_safe_range
|
||
all_inferiors_safe ()
|
||
{
|
||
return {};
|
||
}
|
||
|
||
/* Returns a range representing all inferiors, suitable to use with
|
||
range-for, like this:
|
||
|
||
for (inferior *inf : all_inferiors ())
|
||
[...]
|
||
*/
|
||
|
||
inline all_inferiors_range
|
||
all_inferiors ()
|
||
{
|
||
return {};
|
||
}
|
||
|
||
/* Return a range that can be used to walk over all inferiors with PID
|
||
not zero, with range-for. */
|
||
|
||
inline all_non_exited_inferiors_range
|
||
all_non_exited_inferiors ()
|
||
{
|
||
return {};
|
||
}
|
||
|
||
/* Prune away automatically added inferiors that aren't required
|
||
anymore. */
|
||
extern void prune_inferiors (void);
|
||
|
||
extern int number_of_inferiors (void);
|
||
|
||
extern struct inferior *add_inferior_with_spaces (void);
|
||
|
||
/* Print the current selected inferior. */
|
||
extern void print_selected_inferior (struct ui_out *uiout);
|
||
|
||
#endif /* !defined (INFERIOR_H) */
|