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