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