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-2017 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 struct target_waitstatus;
  25 struct frame_info;
  26 struct ui_file;
  27 struct type;
  28 struct gdbarch;
  29 struct regcache;
  30 struct ui_out;
  31 struct terminal_info;
  32 struct target_desc_info;
  33
  34 /* For bpstat.  */
  35 #include "breakpoint.h"
  36
  37 /* For enum gdb_signal.  */
  38 #include "target.h"
  39
  40 /* For struct frame_id.  */
  41 #include "frame.h"
  42
  43 #include "progspace.h"
  44 #include "registry.h"
  45
  46 #include "symfile-add-flags.h"
  47
  48 struct infcall_suspend_state;
  49 struct infcall_control_state;
  50
  51 extern struct infcall_suspend_state *save_infcall_suspend_state (void);
  52 extern struct infcall_control_state *save_infcall_control_state (void);
  53
  54 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
  55 extern void restore_infcall_control_state (struct infcall_control_state *);
  56
  57 extern struct cleanup *make_cleanup_restore_infcall_suspend_state
  58                                             (struct infcall_suspend_state *);
  59 extern struct cleanup *make_cleanup_restore_infcall_control_state
  60                                             (struct infcall_control_state *);
  61
  62 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
  63 extern void discard_infcall_control_state (struct infcall_control_state *);
  64
  65 extern struct regcache *
  66   get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
  67
  68 /* Save value of inferior_ptid so that it may be restored by
  69    a later call to do_cleanups().  Returns the struct cleanup
  70    pointer needed for later doing the cleanup.  */
  71 extern struct cleanup * save_inferior_ptid (void);
  72
  73 extern void set_sigint_trap (void);
  74
  75 extern void clear_sigint_trap (void);
  76
  77 /* Set/get file name for default use for standard in/out in the inferior.  */
  78
  79 extern void set_inferior_io_terminal (const char *terminal_name);
  80 extern const char *get_inferior_io_terminal (void);
  81
  82 /* Collected pid, tid, etc. of the debugged inferior.  When there's
  83    no inferior, ptid_get_pid (inferior_ptid) will be 0.  */
  84
  85 extern ptid_t inferior_ptid;
  86
  87 extern void generic_mourn_inferior (void);
  88
  89 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
  90                                               struct type *type,
  91                                               const gdb_byte *buf);
  92 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
  93                                          struct type *type, gdb_byte *buf,
  94                                          CORE_ADDR addr);
  95 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
  96                                             struct type *type,
  97                                             const gdb_byte *buf);
  98 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
  99                                        struct type *type, gdb_byte *buf,
 100                                        CORE_ADDR addr);
 101
 102 extern void reopen_exec_file (void);
 103
 104 /* From misc files */
 105
 106 extern void default_print_registers_info (struct gdbarch *gdbarch,
 107                                           struct ui_file *file,
 108                                           struct frame_info *frame,
 109                                           int regnum, int all);
 110
 111 /* Default implementation of gdbarch_print_float_info.  Print
 112    the values of all floating point registers.  */
 113
 114 extern void default_print_float_info (struct gdbarch *gdbarch,
 115                                       struct ui_file *file,
 116                                       struct frame_info *frame,
 117                                       const char *args);
 118
 119 extern void child_terminal_info (struct target_ops *self, const char *, int);
 120
 121 extern void term_info (char *, int);
 122
 123 extern void child_terminal_ours (struct target_ops *self);
 124
 125 extern void child_terminal_ours_for_output (struct target_ops *self);
 126
 127 extern void child_terminal_inferior (struct target_ops *self);
 128
 129 extern void child_terminal_init (struct target_ops *self);
 130
 131 extern void child_terminal_init_with_pgrp (int pgrp);
 132
 133 /* From fork-child.c */
 134
 135 /* Report an error that happened when starting to trace the inferior
 136    (i.e., when the "traceme_fun" callback is called on fork_inferior)
 137    and bail out.  This function does not return.  */
 138
 139 extern void trace_start_error (const char *fmt, ...)
 140   ATTRIBUTE_NORETURN;
 141
 142 /* Like "trace_start_error", but the error message is constructed by
 143    combining STRING with the system error message for errno.  This
 144    function does not return.  */
 145
 146 extern void trace_start_error_with_name (const char *string)
 147   ATTRIBUTE_NORETURN;
 148
 149 extern int fork_inferior (const char *, const std::string &, char **,
 150                           void (*)(void),
 151                           void (*)(int), void (*)(void), char *,
 152                           void (*)(const char *,
 153                                    char * const *, char * const *));
 154
 155
 156 extern void startup_inferior (int);
 157
 158 extern char *construct_inferior_arguments (int, char **);
 159
 160 /* From infcmd.c */
 161
 162 /* Initial inferior setup.  Determines the exec file is not yet known,
 163    takes any necessary post-attaching actions, fetches the target
 164    description and syncs the shared library list.  */
 165
 166 extern void setup_inferior (int from_tty);
 167
 168 extern void post_create_inferior (struct target_ops *, int);
 169
 170 extern void attach_command (char *, int);
 171
 172 extern char *get_inferior_args (void);
 173
 174 extern void set_inferior_args (char *);
 175
 176 extern void set_inferior_args_vector (int, char **);
 177
 178 extern void registers_info (char *, int);
 179
 180 extern void continue_1 (int all_threads);
 181
 182 extern void interrupt_target_1 (int all_threads);
 183
 184 extern void delete_longjmp_breakpoint_cleanup (void *arg);
 185
 186 extern void detach_command (char *, int);
 187
 188 extern void notice_new_inferior (ptid_t, int, int);
 189
 190 extern struct value *get_return_value (struct value *function,
 191                                        struct type *value_type);
 192
 193 /* Prepare for execution command.  TARGET is the target that will run
 194    the command.  BACKGROUND determines whether this is a foreground
 195    (synchronous) or background (asynchronous) command.  */
 196
 197 extern void prepare_execution_command (struct target_ops *target,
 198                                        int background);
 199
 200 /* Whether to start up the debuggee under a shell.
 201
 202    If startup-with-shell is set, GDB's "run" will attempt to start up
 203    the debuggee under a shell.
 204
 205    This is in order for argument-expansion to occur.  E.g.,
 206
 207    (gdb) run *
 208
 209    The "*" gets expanded by the shell into a list of files.
 210
 211    While this is a nice feature, it may be handy to bypass the shell
 212    in some cases.  To disable this feature, do "set startup-with-shell
 213    false".
 214
 215    The catch-exec traps expected during start-up will be one more if
 216    the target is started up with a shell.  */
 217 extern int startup_with_shell;
 218
 219 /* Address at which inferior stopped.  */
 220
 221 extern CORE_ADDR stop_pc;
 222
 223 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 224
 225 extern enum stop_stack_kind stop_stack_dummy;
 226
 227 /* Nonzero if program stopped due to a random (unexpected) signal in
 228    inferior process.  */
 229
 230 extern int stopped_by_random_signal;
 231
 232 /* STEP_OVER_ALL means step over all subroutine calls.
 233    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 234    STEP_OVER_NONE means don't step over any subroutine calls.  */
 235
 236 enum step_over_calls_kind
 237   {
 238     STEP_OVER_NONE,
 239     STEP_OVER_ALL,
 240     STEP_OVER_UNDEBUGGABLE
 241   };
 242
 243 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 244    will handle it themselves.  STOP_QUIETLY is used when running in
 245    the shell before the child program has been exec'd and when running
 246    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 247    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 248    except that there is no need to hide a signal.  */
 249
 250 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
 251    When doing an attach, the kernel stops the debuggee with a SIGSTOP.
 252    On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
 253    a ptraced process has changed.  Earlier versions of the kernel
 254    would ignore these SIGSTOPs, while now SIGSTOP is treated like any
 255    other signal, i.e. it is not muffled.
 256
 257    If the gdb user does a 'continue' after the 'attach', gdb passes
 258    the global variable stop_signal (which stores the signal from the
 259    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 260    problematic, because the kernel doesn't ignore such SIGSTOP
 261    now.  I.e. it is reported back to gdb, which in turn presents it
 262    back to the user.
 263
 264    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 265    gdb to clear the value of stop_signal after the attach, so that it
 266    is not passed back down to the kernel.  */
 267
 268 enum stop_kind
 269   {
 270     NO_STOP_QUIETLY = 0,
 271     STOP_QUIETLY,
 272     STOP_QUIETLY_REMOTE,
 273     STOP_QUIETLY_NO_SIGSTOP
 274   };
 275
 276 \f
 277 /* Possible values for gdbarch_call_dummy_location.  */
 278 #define ON_STACK 1
 279 #define AT_ENTRY_POINT 4
 280
 281 /* Number of traps that happen between exec'ing the shell to run an
 282    inferior and when we finally get to the inferior code, not counting
 283    the exec for the shell.  This is 1 on all supported
 284    implementations.  */
 285 #define START_INFERIOR_TRAPS_EXPECTED   1
 286
 287 struct private_inferior;
 288
 289 /* Inferior process specific part of `struct infcall_control_state'.
 290
 291    Inferior thread counterpart is `struct thread_control_state'.  */
 292
 293 struct inferior_control_state
 294 {
 295   /* See the definition of stop_kind above.  */
 296   enum stop_kind stop_soon;
 297 };
 298
 299 /* GDB represents the state of each program execution with an object
 300    called an inferior.  An inferior typically corresponds to a process
 301    but is more general and applies also to targets that do not have a
 302    notion of processes.  Each run of an executable creates a new
 303    inferior, as does each attachment to an existing process.
 304    Inferiors have unique internal identifiers that are different from
 305    target process ids.  Each inferior may in turn have multiple
 306    threads running in it.  */
 307
 308 struct inferior
 309 {
 310   /* Pointer to next inferior in singly-linked list of inferiors.  */
 311   struct inferior *next;
 312
 313   /* Convenient handle (GDB inferior id).  Unique across all
 314      inferiors.  */
 315   int num;
 316
 317   /* Actual target inferior id, usually, a process id.  This matches
 318      the ptid_t.pid member of threads of this inferior.  */
 319   int pid;
 320   /* True if the PID was actually faked by GDB.  */
 321   int fake_pid_p;
 322
 323   /* The highest thread number this inferior ever had.  */
 324   int highest_thread_num;
 325
 326   /* State of GDB control of inferior process execution.
 327      See `struct inferior_control_state'.  */
 328   struct inferior_control_state control;
 329
 330   /* True if this was an auto-created inferior, e.g. created from
 331      following a fork; false, if this inferior was manually added by
 332      the user, and we should not attempt to prune it
 333      automatically.  */
 334   int removable;
 335
 336   /* The address space bound to this inferior.  */
 337   struct address_space *aspace;
 338
 339   /* The program space bound to this inferior.  */
 340   struct program_space *pspace;
 341
 342   /* The arguments string to use when running.  */
 343   char *args;
 344
 345   /* The size of elements in argv.  */
 346   int argc;
 347
 348   /* The vector version of arguments.  If ARGC is nonzero,
 349      then we must compute ARGS from this (via the target).
 350      This is always coming from main's argv and therefore
 351      should never be freed.  */
 352   char **argv;
 353
 354   /* The name of terminal device to use for I/O.  */
 355   char *terminal;
 356
 357   /* Environment to use for running inferior,
 358      in format described in environ.h.  */
 359   struct gdb_environ *environment;
 360
 361   /* Nonzero if this child process was attached rather than
 362      forked.  */
 363   int attach_flag;
 364
 365   /* If this inferior is a vfork child, then this is the pointer to
 366      its vfork parent, if GDB is still attached to it.  */
 367   struct inferior *vfork_parent;
 368
 369   /* If this process is a vfork parent, this is the pointer to the
 370      child.  Since a vfork parent is left frozen by the kernel until
 371      the child execs or exits, a process can only have one vfork child
 372      at a given time.  */
 373   struct inferior *vfork_child;
 374
 375   /* True if this inferior should be detached when it's vfork sibling
 376      exits or execs.  */
 377   int pending_detach;
 378
 379   /* True if this inferior is a vfork parent waiting for a vfork child
 380      not under our control to be done with the shared memory region,
 381      either by exiting or execing.  */
 382   int waiting_for_vfork_done;
 383
 384   /* True if we're in the process of detaching from this inferior.  */
 385   int detaching;
 386
 387   /* What is left to do for an execution command after any thread of
 388      this inferior stops.  For continuations associated with a
 389      specific thread, see `struct thread_info'.  */
 390   struct continuation *continuations;
 391
 392   /* True if setup_inferior wasn't called for this inferior yet.
 393      Until that is done, we must not access inferior memory or
 394      registers, as we haven't determined the target
 395      architecture/description.  */
 396   int needs_setup;
 397
 398   /* Private data used by the target vector implementation.  */
 399   struct private_inferior *priv;
 400
 401   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 402      In this case, the EXIT_CODE field is also valid.  */
 403   int has_exit_code;
 404   LONGEST exit_code;
 405
 406   /* Default flags to pass to the symbol reading functions.  These are
 407      used whenever a new objfile is created.  */
 408   symfile_add_flags symfile_flags;
 409
 410   /* Info about an inferior's target description (if it's fetched; the
 411      user supplied description's filename, if any; etc.).  */
 412   struct target_desc_info *tdesc_info;
 413
 414   /* The architecture associated with the inferior through the
 415      connection to the target.
 416
 417      The architecture vector provides some information that is really
 418      a property of the inferior, accessed through a particular target:
 419      ptrace operations; the layout of certain RSP packets; the
 420      solib_ops vector; etc.  To differentiate architecture accesses to
 421      per-inferior/target properties from
 422      per-thread/per-frame/per-objfile properties, accesses to
 423      per-inferior/target properties should be made through
 424      this gdbarch.  */
 425   struct gdbarch *gdbarch;
 426
 427   /* Per inferior data-pointers required by other GDB modules.  */
 428   REGISTRY_FIELDS;
 429 };
 430
 431 /* Keep a registry of per-inferior data-pointers required by other GDB
 432    modules.  */
 433
 434 DECLARE_REGISTRY (inferior);
 435
 436 /* Create an empty inferior list, or empty the existing one.  */
 437 extern void init_inferior_list (void);
 438
 439 /* Add an inferior to the inferior list, print a message that a new
 440    inferior is found, and return the pointer to the new inferior.
 441    Caller may use this pointer to initialize the private inferior
 442    data.  */
 443 extern struct inferior *add_inferior (int pid);
 444
 445 /* Same as add_inferior, but don't print new inferior notifications to
 446    the CLI.  */
 447 extern struct inferior *add_inferior_silent (int pid);
 448
 449 extern void delete_inferior (struct inferior *todel);
 450
 451 /* Delete an existing inferior list entry, due to inferior detaching.  */
 452 extern void detach_inferior (int pid);
 453
 454 extern void exit_inferior (int pid);
 455
 456 extern void exit_inferior_silent (int pid);
 457
 458 extern void exit_inferior_num_silent (int num);
 459
 460 extern void inferior_appeared (struct inferior *inf, int pid);
 461
 462 /* Get rid of all inferiors.  */
 463 extern void discard_all_inferiors (void);
 464
 465 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 466    into a "pid" (which may be overloaded with extra inferior information).  */
 467 extern int gdb_inferior_id_to_pid (int);
 468
 469 /* Translate a target 'pid' into the integer inferior id (GDB's
 470    homegrown id, not the system's).  */
 471 extern int pid_to_gdb_inferior_id (int pid);
 472
 473 /* Boolean test for an already-known pid.  */
 474 extern int in_inferior_list (int pid);
 475
 476 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 477    not the system's).  */
 478 extern int valid_gdb_inferior_id (int num);
 479
 480 /* Search function to lookup an inferior by target 'pid'.  */
 481 extern struct inferior *find_inferior_pid (int pid);
 482
 483 /* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */
 484 extern struct inferior *find_inferior_ptid (ptid_t ptid);
 485
 486 /* Search function to lookup an inferior by GDB 'num'.  */
 487 extern struct inferior *find_inferior_id (int num);
 488
 489 /* Find an inferior bound to PSPACE, giving preference to the current
 490    inferior.  */
 491 extern struct inferior *
 492   find_inferior_for_program_space (struct program_space *pspace);
 493
 494 /* Inferior iterator function.
 495
 496    Calls a callback function once for each inferior, so long as the
 497    callback function returns false.  If the callback function returns
 498    true, the iteration will end and the current inferior will be
 499    returned.  This can be useful for implementing a search for a
 500    inferior with arbitrary attributes, or for applying some operation
 501    to every inferior.
 502
 503    It is safe to delete the iterated inferior from the callback.  */
 504 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 505                                                          void *),
 506                                                 void *);
 507
 508 /* Returns true if the inferior list is not empty.  */
 509 extern int have_inferiors (void);
 510
 511 /* Returns the number of live inferiors (real live processes).  */
 512 extern int number_of_live_inferiors (void);
 513
 514 /* Returns true if there are any live inferiors in the inferior list
 515    (not cores, not executables, real live processes).  */
 516 extern int have_live_inferiors (void);
 517
 518 /* Return a pointer to the current inferior.  It is an error to call
 519    this if there is no current inferior.  */
 520 extern struct inferior *current_inferior (void);
 521
 522 extern void set_current_inferior (struct inferior *);
 523
 524 extern struct cleanup *save_current_inferior (void);
 525
 526 /* Traverse all inferiors.  */
 527
 528 #define ALL_INFERIORS(I) \
 529   for ((I) = inferior_list; (I); (I) = (I)->next)
 530
 531 /* Traverse all non-exited inferiors.  */
 532
 533 #define ALL_NON_EXITED_INFERIORS(I) \
 534   ALL_INFERIORS (I)                 \
 535     if ((I)->pid != 0)
 536
 537 extern struct inferior *inferior_list;
 538
 539 /* Prune away automatically added inferiors that aren't required
 540    anymore.  */
 541 extern void prune_inferiors (void);
 542
 543 extern int number_of_inferiors (void);
 544
 545 extern struct inferior *add_inferior_with_spaces (void);
 546
 547 /* Print the current selected inferior.  */
 548 extern void print_selected_inferior (struct ui_out *uiout);
 549
 550 #endif /* !defined (INFERIOR_H) */