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