gdb/inferior.h

   1 /* Variables that describe the inferior process running under GDB:
   2    Where it is, why it stopped, and how to step it.
   3
   4    Copyright (C) 1986-2021 Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   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.
  12
  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.
  17
  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/>.  */
  20
  21 #if !defined (INFERIOR_H)
  22 #define INFERIOR_H 1
  23
  24 #include <exception>
  25 #include <list>
  26
  27 struct target_waitstatus;
  28 struct frame_info;
  29 struct ui_file;
  30 struct type;
  31 struct gdbarch;
  32 struct regcache;
  33 struct ui_out;
  34 struct terminal_info;
  35 struct target_desc_info;
  36 struct inferior;
  37 struct thread_info;
  38
  39 /* For bpstat.  */
  40 #include "breakpoint.h"
  41
  42 /* For enum gdb_signal.  */
  43 #include "target.h"
  44
  45 /* For struct frame_id.  */
  46 #include "frame.h"
  47
  48 /* For gdb_environ.  */
  49 #include "gdbsupport/environ.h"
  50
  51 #include "progspace.h"
  52 #include "registry.h"
  53
  54 #include "symfile-add-flags.h"
  55 #include "gdbsupport/refcounted-object.h"
  56 #include "gdbsupport/forward-scope-exit.h"
  57 #include "gdbsupport/gdb_unique_ptr.h"
  58 #include "gdbsupport/intrusive_list.h"
  59
  60 #include "gdbsupport/common-inferior.h"
  61 #include "gdbthread.h"
  62
  63 #include "process-stratum-target.h"
  64 #include "displaced-stepping.h"
  65
  66 #include <unordered_map>
  67
  68 struct infcall_suspend_state;
  69 struct infcall_control_state;
  70
  71 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
  72 extern void restore_infcall_control_state (struct infcall_control_state *);
  73
  74 /* A deleter for infcall_suspend_state that calls
  75    restore_infcall_suspend_state.  */
  76 struct infcall_suspend_state_deleter
  77 {
  78   void operator() (struct infcall_suspend_state *state) const
  79   {
  80     try
  81       {
  82         restore_infcall_suspend_state (state);
  83       }
  84     catch (const gdb_exception_error &e)
  85       {
  86         /* If we are restoring the inferior state due to an exception,
  87            some error message will be printed.  So, only warn the user
  88            when we cannot restore during normal execution.  */
  89         bool unwinding;
  90 #if __cpp_lib_uncaught_exceptions
  91         unwinding = std::uncaught_exceptions () > 0;
  92 #else
  93         unwinding = std::uncaught_exception ();
  94 #endif
  95         if (!unwinding)
  96           warning (_("Failed to restore inferior state: %s"), e.what ());
  97       }
  98   }
  99 };
 100
 101 /* A unique_ptr specialization for infcall_suspend_state.  */
 102 typedef std::unique_ptr<infcall_suspend_state, infcall_suspend_state_deleter>
 103     infcall_suspend_state_up;
 104
 105 extern infcall_suspend_state_up save_infcall_suspend_state ();
 106
 107 /* A deleter for infcall_control_state that calls
 108    restore_infcall_control_state.  */
 109 struct infcall_control_state_deleter
 110 {
 111   void operator() (struct infcall_control_state *state) const
 112   {
 113     restore_infcall_control_state (state);
 114   }
 115 };
 116
 117 /* A unique_ptr specialization for infcall_control_state.  */
 118 typedef std::unique_ptr<infcall_control_state, infcall_control_state_deleter>
 119     infcall_control_state_up;
 120
 121 extern infcall_control_state_up save_infcall_control_state ();
 122
 123 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
 124 extern void discard_infcall_control_state (struct infcall_control_state *);
 125
 126 extern readonly_detached_regcache *
 127   get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
 128
 129 extern void set_sigint_trap (void);
 130
 131 extern void clear_sigint_trap (void);
 132
 133 /* Collected pid, tid, etc. of the debugged inferior.  When there's
 134    no inferior, inferior_ptid.pid () will be 0.  */
 135
 136 extern ptid_t inferior_ptid;
 137
 138 extern void generic_mourn_inferior (void);
 139
 140 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
 141                                               struct type *type,
 142                                               const gdb_byte *buf);
 143 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
 144                                          struct type *type, gdb_byte *buf,
 145                                          CORE_ADDR addr);
 146 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
 147                                             struct type *type,
 148                                             const gdb_byte *buf);
 149 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
 150                                        struct type *type, gdb_byte *buf,
 151                                        CORE_ADDR addr);
 152
 153 extern void reopen_exec_file (void);
 154
 155 /* From misc files */
 156
 157 extern void default_print_registers_info (struct gdbarch *gdbarch,
 158                                           struct ui_file *file,
 159                                           struct frame_info *frame,
 160                                           int regnum, int all);
 161
 162 /* Default implementation of gdbarch_print_float_info.  Print
 163    the values of all floating point registers.  */
 164
 165 extern void default_print_float_info (struct gdbarch *gdbarch,
 166                                       struct ui_file *file,
 167                                       struct frame_info *frame,
 168                                       const char *args);
 169
 170 extern void child_terminal_info (struct target_ops *self, const char *, int);
 171
 172 extern void child_terminal_ours (struct target_ops *self);
 173
 174 extern void child_terminal_ours_for_output (struct target_ops *self);
 175
 176 extern void child_terminal_inferior (struct target_ops *self);
 177
 178 extern void child_terminal_save_inferior (struct target_ops *self);
 179
 180 extern void child_terminal_init (struct target_ops *self);
 181
 182 extern void child_terminal_init_with_pgrp (int pgrp);
 183
 184 extern void child_pass_ctrlc (struct target_ops *self);
 185
 186 extern void child_interrupt (struct target_ops *self);
 187
 188 /* From fork-child.c */
 189
 190 /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS.
 191    This function already calls set_executing.  Return the ptid_t from
 192    STARTUP_INFERIOR.  */
 193 extern ptid_t gdb_startup_inferior (pid_t pid, int num_traps);
 194
 195 /* From infcmd.c */
 196
 197 /* Initial inferior setup.  Determines the exec file is not yet known,
 198    takes any necessary post-attaching actions, fetches the target
 199    description and syncs the shared library list.  */
 200
 201 extern void setup_inferior (int from_tty);
 202
 203 extern void post_create_inferior (int from_tty);
 204
 205 extern void attach_command (const char *, int);
 206
 207 extern void set_inferior_args_vector (int, char **);
 208
 209 extern void registers_info (const char *, int);
 210
 211 extern void continue_1 (int all_threads);
 212
 213 extern void interrupt_target_1 (bool all_threads);
 214
 215 using delete_longjmp_breakpoint_cleanup
 216   = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint);
 217
 218 extern void detach_command (const char *, int);
 219
 220 extern void notice_new_inferior (struct thread_info *, bool, int);
 221
 222 extern struct value *get_return_value (struct value *function,
 223                                        struct type *value_type);
 224
 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.  */
 228
 229 extern void prepare_execution_command (struct target_ops *target,
 230                                        int background);
 231
 232 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 233
 234 extern enum stop_stack_kind stop_stack_dummy;
 235
 236 /* Nonzero if program stopped due to a random (unexpected) signal in
 237    inferior process.  */
 238
 239 extern int stopped_by_random_signal;
 240
 241 /* Print notices on inferior events (attach, detach, etc.), set with
 242    `set print inferior-events'.  */
 243 extern bool print_inferior_events;
 244
 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.  */
 251
 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.
 258
 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
 264    back to the user.
 265
 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.  */
 269
 270 enum stop_kind
 271   {
 272     NO_STOP_QUIETLY = 0,
 273     STOP_QUIETLY,
 274     STOP_QUIETLY_REMOTE,
 275     STOP_QUIETLY_NO_SIGSTOP
 276   };
 277
 278 \f
 279 /* Possible values for gdbarch_call_dummy_location.  */
 280 #define ON_STACK 1
 281 #define AT_ENTRY_POINT 4
 282
 283 /* Base class for target-specific inferior data.  */
 284
 285 struct private_inferior
 286 {
 287   virtual ~private_inferior () = 0;
 288 };
 289
 290 /* Inferior process specific part of `struct infcall_control_state'.
 291
 292    Inferior thread counterpart is `struct thread_control_state'.  */
 293
 294 struct inferior_control_state
 295 {
 296   inferior_control_state ()
 297     : stop_soon (NO_STOP_QUIETLY)
 298   {
 299   }
 300
 301   explicit inferior_control_state (enum stop_kind when)
 302     : stop_soon (when)
 303   {
 304   }
 305
 306   /* See the definition of stop_kind above.  */
 307   enum stop_kind stop_soon;
 308 };
 309
 310 /* Return a pointer to the current inferior.  */
 311 extern inferior *current_inferior ();
 312
 313 extern void set_current_inferior (inferior *);
 314
 315 /* Switch inferior (and program space) to INF, and switch to no thread
 316    selected.  */
 317 extern void switch_to_inferior_no_thread (inferior *inf);
 318
 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.
 327
 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.  */
 340
 341 class inferior : public refcounted_object,
 342                  public intrusive_list_node<inferior>
 343 {
 344 public:
 345   explicit inferior (int pid);
 346   ~inferior ();
 347
 348   /* Returns true if we can delete this inferior.  */
 349   bool deletable () const { return refcount () == 0; }
 350
 351   /* Push T in this inferior's target stack.  */
 352   void push_target (struct target_ops *t)
 353   { m_target_stack.push (t); }
 354
 355   /* An overload that deletes the target on failure.  */
 356   void push_target (target_ops_up &&t)
 357   {
 358     m_target_stack.push (t.get ());
 359     t.release ();
 360   }
 361
 362   /* Unpush T from this inferior's target stack.  */
 363   int unpush_target (struct target_ops *t);
 364
 365   /* Returns true if T is pushed in this inferior's target stack.  */
 366   bool target_is_pushed (target_ops *t)
 367   { return m_target_stack.is_pushed (t); }
 368
 369   /* Find the target beneath T in this inferior's target stack.  */
 370   target_ops *find_target_beneath (const target_ops *t)
 371   { return m_target_stack.find_beneath (t); }
 372
 373   /* Return the target at the top of this inferior's target stack.  */
 374   target_ops *top_target ()
 375   { return m_target_stack.top (); }
 376
 377   /* Return the target at process_stratum level in this inferior's
 378      target stack.  */
 379   struct process_stratum_target *process_target ()
 380   { return (process_stratum_target *) m_target_stack.at (process_stratum); }
 381
 382   /* Return the target at STRATUM in this inferior's target stack.  */
 383   target_ops *target_at (enum strata stratum)
 384   { return m_target_stack.at (stratum); }
 385
 386   bool has_execution ()
 387   { return target_has_execution (this); }
 388
 389   /* This inferior's thread list, sorted by creation order.  */
 390   intrusive_list<thread_info> thread_list;
 391
 392   /* A map of ptid_t to thread_info*, for average O(1) ptid_t lookup.
 393      Exited threads do not appear in the map.  */
 394   std::unordered_map<ptid_t, thread_info *, hash_ptid> ptid_thread_map;
 395
 396   /* Returns a range adapter covering the inferior's threads,
 397      including exited threads.  Used like this:
 398
 399        for (thread_info *thr : inf->threads ())
 400          { .... }
 401   */
 402   inf_threads_range threads ()
 403   { return inf_threads_range (this->thread_list.begin ()); }
 404
 405   /* Returns a range adapter covering the inferior's non-exited
 406      threads.  Used like this:
 407
 408        for (thread_info *thr : inf->non_exited_threads ())
 409          { .... }
 410   */
 411   inf_non_exited_threads_range non_exited_threads ()
 412   { return inf_non_exited_threads_range (this->thread_list.begin ()); }
 413
 414   /* Like inferior::threads(), but returns a range adapter that can be
 415      used with range-for, safely.  I.e., it is safe to delete the
 416      currently-iterated thread, like this:
 417
 418      for (thread_info *t : inf->threads_safe ())
 419        if (some_condition ())
 420          delete f;
 421   */
 422   inline safe_inf_threads_range threads_safe ()
 423   { return safe_inf_threads_range (this->thread_list.begin ()); }
 424
 425   /* Delete all threads in the thread list.  If SILENT, exit threads
 426      silently.  */
 427   void clear_thread_list (bool silent);
 428
 429   /* Continuations-related methods.  A continuation is an std::function
 430      to be called to finish the execution of a command when running
 431      GDB asynchronously.  A continuation is executed after any thread
 432      of this inferior stops.  Continuations are used by the attach
 433      command and the remote target when a new inferior is detected.  */
 434   void add_continuation (std::function<void ()> &&cont);
 435   void do_all_continuations ();
 436
 437   /* Set/get file name for default use for standard in/out in the
 438      inferior.  On Unix systems, we try to make TERMINAL_NAME the
 439      inferior's controlling terminal.  If TERMINAL_NAME is nullptr or
 440      the empty string, then the inferior inherits GDB's terminal (or
 441      GDBserver's if spawning a remote process).  */
 442   void set_tty (const char *terminal_name);
 443   const char *tty ();
 444
 445   /* Set the argument string to use when running this inferior.
 446
 447      Either nullptr or an empty string can be used to represent "no
 448      arguments".  */
 449   void set_args (const char *args)
 450   {
 451     if (args != nullptr && args[0] != '\0')
 452       m_args = make_unique_xstrdup (args);
 453     else
 454       m_args.reset ();
 455   };
 456
 457   /* Get the argument string to use when running this inferior.
 458
 459      The return value is always non-nullptr.  No arguments is represented by
 460      an empty string.  */
 461   const char *args () const
 462   {
 463     if (m_args == nullptr)
 464       return "";
 465
 466     return m_args.get ();
 467   }
 468
 469   /* Set the inferior current working directory.
 470
 471      If CWD is NULL, unset the directory.  */
 472   void set_cwd (const char *cwd)
 473   {
 474     if (cwd == NULL)
 475       m_cwd.reset ();
 476     else
 477       m_cwd.reset (xstrdup (cwd));
 478   }
 479
 480   /* Get the inferior current working directory.
 481
 482      Return nullptr if the current working directory is not specified.  */
 483   const char *cwd () const
 484   {
 485     return m_cwd.get ();
 486   }
 487
 488   /* Convenient handle (GDB inferior id).  Unique across all
 489      inferiors.  */
 490   int num = 0;
 491
 492   /* Actual target inferior id, usually, a process id.  This matches
 493      the ptid_t.pid member of threads of this inferior.  */
 494   int pid = 0;
 495   /* True if the PID was actually faked by GDB.  */
 496   bool fake_pid_p = false;
 497
 498   /* The highest thread number this inferior ever had.  */
 499   int highest_thread_num = 0;
 500
 501   /* State of GDB control of inferior process execution.
 502      See `struct inferior_control_state'.  */
 503   inferior_control_state control;
 504
 505   /* True if this was an auto-created inferior, e.g. created from
 506      following a fork; false, if this inferior was manually added by
 507      the user, and we should not attempt to prune it
 508      automatically.  */
 509   bool removable = false;
 510
 511   /* The address space bound to this inferior.  */
 512   struct address_space *aspace = NULL;
 513
 514   /* The program space bound to this inferior.  */
 515   struct program_space *pspace = NULL;
 516
 517   /* The terminal state as set by the last target_terminal::terminal_*
 518      call.  */
 519   target_terminal_state terminal_state = target_terminal_state::is_ours;
 520
 521   /* Environment to use for running inferior,
 522      in format described in environ.h.  */
 523   gdb_environ environment;
 524
 525   /* True if this child process was attached rather than forked.  */
 526   bool attach_flag = false;
 527
 528   /* If this inferior is a vfork child, then this is the pointer to
 529      its vfork parent, if GDB is still attached to it.  */
 530   inferior *vfork_parent = NULL;
 531
 532   /* If this process is a vfork parent, this is the pointer to the
 533      child.  Since a vfork parent is left frozen by the kernel until
 534      the child execs or exits, a process can only have one vfork child
 535      at a given time.  */
 536   inferior *vfork_child = NULL;
 537
 538   /* True if this inferior should be detached when it's vfork sibling
 539      exits or execs.  */
 540   bool pending_detach = false;
 541
 542   /* True if this inferior is a vfork parent waiting for a vfork child
 543      not under our control to be done with the shared memory region,
 544      either by exiting or execing.  */
 545   bool waiting_for_vfork_done = false;
 546
 547   /* True if we're in the process of detaching from this inferior.  */
 548   bool detaching = false;
 549
 550   /* True if setup_inferior wasn't called for this inferior yet.
 551      Until that is done, we must not access inferior memory or
 552      registers, as we haven't determined the target
 553      architecture/description.  */
 554   bool needs_setup = false;
 555
 556   /* True when we are reading the library list of the inferior during an
 557      attach or handling a fork child.  */
 558   bool in_initial_library_scan = false;
 559
 560   /* Private data used by the target vector implementation.  */
 561   std::unique_ptr<private_inferior> priv;
 562
 563   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 564      In this case, the EXIT_CODE field is also valid.  */
 565   bool has_exit_code = false;
 566   LONGEST exit_code = 0;
 567
 568   /* Default flags to pass to the symbol reading functions.  These are
 569      used whenever a new objfile is created.  */
 570   symfile_add_flags symfile_flags = 0;
 571
 572   /* Info about an inferior's target description (if it's fetched; the
 573      user supplied description's filename, if any; etc.).  */
 574   target_desc_info *tdesc_info = NULL;
 575
 576   /* The architecture associated with the inferior through the
 577      connection to the target.
 578
 579      The architecture vector provides some information that is really
 580      a property of the inferior, accessed through a particular target:
 581      ptrace operations; the layout of certain RSP packets; the
 582      solib_ops vector; etc.  To differentiate architecture accesses to
 583      per-inferior/target properties from
 584      per-thread/per-frame/per-objfile properties, accesses to
 585      per-inferior/target properties should be made through
 586      this gdbarch.  */
 587   struct gdbarch *gdbarch = NULL;
 588
 589   /* Data related to displaced stepping.  */
 590   displaced_step_inferior_state displaced_step_state;
 591
 592   /* Per inferior data-pointers required by other GDB modules.  */
 593   REGISTRY_FIELDS;
 594
 595 private:
 596   /* The inferior's target stack.  */
 597   target_stack m_target_stack;
 598
 599   /* The name of terminal device to use for I/O.  */
 600   gdb::unique_xmalloc_ptr<char> m_terminal;
 601
 602   /* The list of continuations.  */
 603   std::list<std::function<void ()>> m_continuations;
 604
 605   /* The arguments string to use when running.
 606
 607      This is nullptr when there are not args.  */
 608   gdb::unique_xmalloc_ptr<char> m_args;
 609
 610   /* The current working directory that will be used when starting
 611      this inferior.  */
 612   gdb::unique_xmalloc_ptr<char> m_cwd;
 613 };
 614
 615 /* Keep a registry of per-inferior data-pointers required by other GDB
 616    modules.  */
 617
 618 DECLARE_REGISTRY (inferior);
 619
 620 /* Add an inferior to the inferior list, print a message that a new
 621    inferior is found, and return the pointer to the new inferior.
 622    Caller may use this pointer to initialize the private inferior
 623    data.  */
 624 extern struct inferior *add_inferior (int pid);
 625
 626 /* Same as add_inferior, but don't print new inferior notifications to
 627    the CLI.  */
 628 extern struct inferior *add_inferior_silent (int pid);
 629
 630 extern void delete_inferior (struct inferior *todel);
 631
 632 /* Delete an existing inferior list entry, due to inferior detaching.  */
 633 extern void detach_inferior (inferior *inf);
 634
 635 extern void exit_inferior (inferior *inf);
 636
 637 extern void exit_inferior_silent (inferior *inf);
 638
 639 extern void exit_inferior_num_silent (int num);
 640
 641 extern void inferior_appeared (struct inferior *inf, int pid);
 642
 643 /* Search function to lookup an inferior of TARG by target 'pid'.  */
 644 extern struct inferior *find_inferior_pid (process_stratum_target *targ,
 645                                            int pid);
 646
 647 /* Search function to lookup an inferior of TARG whose pid is equal to
 648    'ptid.pid'. */
 649 extern struct inferior *find_inferior_ptid (process_stratum_target *targ,
 650                                             ptid_t ptid);
 651
 652 /* Search function to lookup an inferior by GDB 'num'.  */
 653 extern struct inferior *find_inferior_id (int num);
 654
 655 /* Find an inferior bound to PSPACE, giving preference to the current
 656    inferior.  */
 657 extern struct inferior *
 658   find_inferior_for_program_space (struct program_space *pspace);
 659
 660 /* Returns true if the inferior list is not empty.  */
 661 extern int have_inferiors (void);
 662
 663 /* Returns the number of live inferiors running on PROC_TARGET (real
 664    live processes with execution).  */
 665 extern int number_of_live_inferiors (process_stratum_target *proc_target);
 666
 667 /* Returns true if there are any live inferiors in the inferior list
 668    (not cores, not executables, real live processes).  */
 669 extern int have_live_inferiors (void);
 670
 671 /* Save/restore the current inferior.  */
 672
 673 class scoped_restore_current_inferior
 674 {
 675 public:
 676   scoped_restore_current_inferior ()
 677     : m_saved_inf (current_inferior ())
 678   {}
 679
 680   ~scoped_restore_current_inferior ()
 681   { set_current_inferior (m_saved_inf); }
 682
 683   DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior);
 684
 685 private:
 686   inferior *m_saved_inf;
 687 };
 688
 689
 690 /* Traverse all inferiors.  */
 691
 692 extern intrusive_list<inferior> inferior_list;
 693
 694 /* Pull in the internals of the inferiors ranges and iterators.  Must
 695    be done after struct inferior is defined.  */
 696 #include "inferior-iter.h"
 697
 698 /* Return a range that can be used to walk over all inferiors
 699    inferiors, with range-for, safely.  I.e., it is safe to delete the
 700    currently-iterated inferior.  When combined with range-for, this
 701    allow convenient patterns like this:
 702
 703      for (inferior *inf : all_inferiors_safe ())
 704        if (some_condition ())
 705          delete inf;
 706 */
 707
 708 inline all_inferiors_safe_range
 709 all_inferiors_safe ()
 710 {
 711   return all_inferiors_safe_range (nullptr, inferior_list);
 712 }
 713
 714 /* Returns a range representing all inferiors, suitable to use with
 715    range-for, like this:
 716
 717    for (inferior *inf : all_inferiors ())
 718      [...]
 719 */
 720
 721 inline all_inferiors_range
 722 all_inferiors (process_stratum_target *proc_target = nullptr)
 723 {
 724   return all_inferiors_range (proc_target, inferior_list);
 725 }
 726
 727 /* Return a range that can be used to walk over all inferiors with PID
 728    not zero, with range-for.  */
 729
 730 inline all_non_exited_inferiors_range
 731 all_non_exited_inferiors (process_stratum_target *proc_target = nullptr)
 732 {
 733   return all_non_exited_inferiors_range (proc_target, inferior_list);
 734 }
 735
 736 /* Prune away automatically added inferiors that aren't required
 737    anymore.  */
 738 extern void prune_inferiors (void);
 739
 740 extern int number_of_inferiors (void);
 741
 742 extern struct inferior *add_inferior_with_spaces (void);
 743
 744 /* Print the current selected inferior.  */
 745 extern void print_selected_inferior (struct ui_out *uiout);
 746
 747 #endif /* !defined (INFERIOR_H) */