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-2013 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 #include "ptid.h"
  35
  36 /* For bpstat.  */
  37 #include "breakpoint.h"
  38
  39 /* For enum gdb_signal.  */
  40 #include "target.h"
  41
  42 /* For struct frame_id.  */
  43 #include "frame.h"
  44
  45 #include "progspace.h"
  46 #include "registry.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 /* Returns true if PTID matches filter FILTER.  FILTER can be the wild
  69    card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
  70    a process (ptid_is_pid returns true), in which case, all lwps and
  71    threads of that given process match, lwps and threads of other
  72    processes do not; or, it can represent a specific thread, in which
  73    case, only that thread will match true.  PTID must represent a
  74    specific LWP or THREAD, it can never be a wild card.  */
  75
  76 extern int ptid_match (ptid_t ptid, ptid_t filter);
  77
  78 /* Save value of inferior_ptid so that it may be restored by
  79    a later call to do_cleanups().  Returns the struct cleanup
  80    pointer needed for later doing the cleanup.  */
  81 extern struct cleanup * save_inferior_ptid (void);
  82
  83 extern void set_sigint_trap (void);
  84
  85 extern void clear_sigint_trap (void);
  86
  87 /* Set/get file name for default use for standard in/out in the inferior.  */
  88
  89 extern void set_inferior_io_terminal (const char *terminal_name);
  90 extern const char *get_inferior_io_terminal (void);
  91
  92 /* Collected pid, tid, etc. of the debugged inferior.  When there's
  93    no inferior, PIDGET (inferior_ptid) will be 0.  */
  94
  95 extern ptid_t inferior_ptid;
  96
  97 /* Are we simulating synchronous execution? This is used in async gdb
  98    to implement the 'run', 'continue' etc commands, which will not
  99    redisplay the prompt until the execution is actually over.  */
 100 extern int sync_execution;
 101
 102 /* Inferior environment.  */
 103
 104 extern void clear_proceed_status (void);
 105
 106 extern void proceed (CORE_ADDR, enum gdb_signal, int);
 107
 108 extern int sched_multi;
 109
 110 /* When set, stop the 'step' command if we enter a function which has
 111    no line number information.  The normal behavior is that we step
 112    over such function.  */
 113 extern int step_stop_if_no_debug;
 114
 115 /* If set, the inferior should be controlled in non-stop mode.  In
 116    this mode, each thread is controlled independently.  Execution
 117    commands apply only to the selected thread by default, and stop
 118    events stop only the thread that had the event -- the other threads
 119    are kept running freely.  */
 120 extern int non_stop;
 121
 122 /* If set (default), when following a fork, GDB will detach from one
 123    the fork branches, child or parent.  Exactly which branch is
 124    detached depends on 'set follow-fork-mode' setting.  */
 125 extern int detach_fork;
 126
 127 /* When set (default), the target should attempt to disable the operating
 128    system's address space randomization feature when starting an inferior.  */
 129 extern int disable_randomization;
 130
 131 extern void generic_mourn_inferior (void);
 132
 133 extern void terminal_save_ours (void);
 134
 135 extern void terminal_ours (void);
 136
 137 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
 138                                               struct type *type,
 139                                               const gdb_byte *buf);
 140 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
 141                                          struct type *type, gdb_byte *buf,
 142                                          CORE_ADDR addr);
 143 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
 144                                             struct type *type,
 145                                             const gdb_byte *buf);
 146 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
 147                                        struct type *type, gdb_byte *buf,
 148                                        CORE_ADDR addr);
 149
 150 extern void wait_for_inferior (void);
 151
 152 extern void prepare_for_detach (void);
 153
 154 extern void fetch_inferior_event (void *);
 155
 156 extern void init_wait_for_inferior (void);
 157
 158 extern void reopen_exec_file (void);
 159
 160 /* The `resume' routine should only be called in special circumstances.
 161    Normally, use `proceed', which handles a lot of bookkeeping.  */
 162
 163 extern void resume (int, enum gdb_signal);
 164
 165 extern ptid_t user_visible_resume_ptid (int step);
 166
 167 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 168                                                   struct symtab_and_line ,
 169                                                   struct frame_id);
 170
 171 /* From misc files */
 172
 173 extern void default_print_registers_info (struct gdbarch *gdbarch,
 174                                           struct ui_file *file,
 175                                           struct frame_info *frame,
 176                                           int regnum, int all);
 177
 178 extern void child_terminal_info (char *, int);
 179
 180 extern void term_info (char *, int);
 181
 182 extern void terminal_ours_for_output (void);
 183
 184 extern void terminal_inferior (void);
 185
 186 extern void terminal_init_inferior (void);
 187
 188 extern void terminal_init_inferior_with_pgrp (int pgrp);
 189
 190 /* From fork-child.c */
 191
 192 extern int fork_inferior (char *, char *, char **,
 193                           void (*)(void),
 194                           void (*)(int), void (*)(void), char *,
 195                           void (*)(const char *,
 196                                    char * const *, char * const *));
 197
 198
 199 extern void startup_inferior (int);
 200
 201 extern char *construct_inferior_arguments (int, char **);
 202
 203 /* From infrun.c */
 204
 205 extern unsigned int debug_infrun;
 206
 207 extern int stop_on_solib_events;
 208
 209 extern void start_remote (int from_tty);
 210
 211 extern void normal_stop (void);
 212
 213 extern int signal_stop_state (int);
 214
 215 extern int signal_print_state (int);
 216
 217 extern int signal_pass_state (int);
 218
 219 extern int signal_stop_update (int, int);
 220
 221 extern int signal_print_update (int, int);
 222
 223 extern int signal_pass_update (int, int);
 224
 225 extern void get_last_target_status(ptid_t *ptid,
 226                                    struct target_waitstatus *status);
 227
 228 extern void follow_inferior_reset_breakpoints (void);
 229
 230 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
 231
 232 /* From infcmd.c */
 233
 234 extern void post_create_inferior (struct target_ops *, int);
 235
 236 extern void attach_command (char *, int);
 237
 238 extern char *get_inferior_args (void);
 239
 240 extern void set_inferior_args (char *);
 241
 242 extern void set_inferior_args_vector (int, char **);
 243
 244 extern void registers_info (char *, int);
 245
 246 extern void continue_1 (int all_threads);
 247
 248 extern void interrupt_target_1 (int all_threads);
 249
 250 extern void delete_longjmp_breakpoint_cleanup (void *arg);
 251
 252 extern void detach_command (char *, int);
 253
 254 extern void notice_new_inferior (ptid_t, int, int);
 255
 256 extern struct value *get_return_value (struct value *function,
 257                                        struct type *value_type);
 258
 259 /* Address at which inferior stopped.  */
 260
 261 extern CORE_ADDR stop_pc;
 262
 263 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 264
 265 extern enum stop_stack_kind stop_stack_dummy;
 266
 267 /* Nonzero if program stopped due to a random (unexpected) signal in
 268    inferior process.  */
 269
 270 extern int stopped_by_random_signal;
 271
 272 /* STEP_OVER_ALL means step over all subroutine calls.
 273    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 274    STEP_OVER_NONE means don't step over any subroutine calls.  */
 275
 276 enum step_over_calls_kind
 277   {
 278     STEP_OVER_NONE,
 279     STEP_OVER_ALL,
 280     STEP_OVER_UNDEBUGGABLE
 281   };
 282
 283 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 284    will handle it themselves.  STOP_QUIETLY is used when running in
 285    the shell before the child program has been exec'd and when running
 286    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 287    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 288    except that there is no need to hide a signal.  */
 289
 290 /* It is also used after attach, due to attaching to a process.  This
 291    is a bit trickier.  When doing an attach, the kernel stops the
 292    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 293    the handling of SIGSTOP for a ptraced process has changed.  Earlier
 294    versions of the kernel would ignore these SIGSTOPs, while now
 295    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 296
 297    If the gdb user does a 'continue' after the 'attach', gdb passes
 298    the global variable stop_signal (which stores the signal from the
 299    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 300    problematic, because the kernel doesn't ignore such SIGSTOP
 301    now.  I.e. it is reported back to gdb, which in turn presents it
 302    back to the user.
 303
 304    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 305    gdb to clear the value of stop_signal after the attach, so that it
 306    is not passed back down to the kernel.  */
 307
 308 enum stop_kind
 309   {
 310     NO_STOP_QUIETLY = 0,
 311     STOP_QUIETLY,
 312     STOP_QUIETLY_REMOTE,
 313     STOP_QUIETLY_NO_SIGSTOP
 314   };
 315
 316 /* Reverse execution.  */
 317 enum exec_direction_kind
 318   {
 319     EXEC_FORWARD,
 320     EXEC_REVERSE
 321   };
 322
 323 /* The current execution direction.  This should only be set to enum
 324    exec_direction_kind values.  It is only an int to make it
 325    compatible with make_cleanup_restore_integer.  */
 326 extern int execution_direction;
 327
 328 /* Save register contents here when executing a "finish" command or are
 329    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 330    Thus this contains the return value from the called function (assuming
 331    values are returned in a register).  */
 332
 333 extern struct regcache *stop_registers;
 334
 335 /* True if we are debugging displaced stepping.  */
 336 extern int debug_displaced;
 337
 338 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 339 void displaced_step_dump_bytes (struct ui_file *file,
 340                                 const gdb_byte *buf, size_t len);
 341
 342 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
 343 \f
 344 /* Possible values for gdbarch_call_dummy_location.  */
 345 #define ON_STACK 1
 346 #define AT_ENTRY_POINT 4
 347
 348 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 349    will attempts to start up the debugee under a shell.
 350    This is in order for argument-expansion to occur.  E.g.,
 351    (gdb) run *
 352    The "*" gets expanded by the shell into a list of files.
 353    While this is a nice feature, it turns out to interact badly
 354    with some of the catch-fork/catch-exec features we have added.
 355    In particular, if the shell does any fork/exec's before
 356    the exec of the target program, that can confuse GDB.
 357    To disable this feature, set STARTUP_WITH_SHELL to 0.
 358    To enable this feature, set STARTUP_WITH_SHELL to 1.
 359    The catch-exec traps expected during start-up will
 360    be 1 if target is not started up with a shell, 2 if it is.
 361    - RT
 362    If you disable this, you need to decrement
 363    START_INFERIOR_TRAPS_EXPECTED in tm.h.  */
 364 #define STARTUP_WITH_SHELL 1
 365 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 366 #define START_INFERIOR_TRAPS_EXPECTED   2
 367 #endif
 368
 369 struct private_inferior;
 370
 371 /* Inferior process specific part of `struct infcall_control_state'.
 372
 373    Inferior thread counterpart is `struct thread_control_state'.  */
 374
 375 struct inferior_control_state
 376 {
 377   /* See the definition of stop_kind above.  */
 378   enum stop_kind stop_soon;
 379 };
 380
 381 /* Inferior process specific part of `struct infcall_suspend_state'.
 382
 383    Inferior thread counterpart is `struct thread_suspend_state'.  */
 384
 385 #if 0 /* Currently unused and empty structures are not valid C.  */
 386 struct inferior_suspend_state
 387 {
 388 };
 389 #endif
 390
 391 /* GDB represents the state of each program execution with an object
 392    called an inferior.  An inferior typically corresponds to a process
 393    but is more general and applies also to targets that do not have a
 394    notion of processes.  Each run of an executable creates a new
 395    inferior, as does each attachment to an existing process.
 396    Inferiors have unique internal identifiers that are different from
 397    target process ids.  Each inferior may in turn have multiple
 398    threads running in it.  */
 399
 400 struct inferior
 401 {
 402   /* Pointer to next inferior in singly-linked list of inferiors.  */
 403   struct inferior *next;
 404
 405   /* Convenient handle (GDB inferior id).  Unique across all
 406      inferiors.  */
 407   int num;
 408
 409   /* Actual target inferior id, usually, a process id.  This matches
 410      the ptid_t.pid member of threads of this inferior.  */
 411   int pid;
 412   /* True if the PID was actually faked by GDB.  */
 413   int fake_pid_p;
 414
 415   /* State of GDB control of inferior process execution.
 416      See `struct inferior_control_state'.  */
 417   struct inferior_control_state control;
 418
 419   /* State of inferior process to restore after GDB is done with an inferior
 420      call.  See `struct inferior_suspend_state'.  */
 421 #if 0 /* Currently unused and empty structures are not valid C.  */
 422   struct inferior_suspend_state suspend;
 423 #endif
 424
 425   /* True if this was an auto-created inferior, e.g. created from
 426      following a fork; false, if this inferior was manually added by
 427      the user, and we should not attempt to prune it
 428      automatically.  */
 429   int removable;
 430
 431   /* The address space bound to this inferior.  */
 432   struct address_space *aspace;
 433
 434   /* The program space bound to this inferior.  */
 435   struct program_space *pspace;
 436
 437   /* The arguments string to use when running.  */
 438   char *args;
 439
 440   /* The size of elements in argv.  */
 441   int argc;
 442
 443   /* The vector version of arguments.  If ARGC is nonzero,
 444      then we must compute ARGS from this (via the target).
 445      This is always coming from main's argv and therefore
 446      should never be freed.  */
 447   char **argv;
 448
 449   /* The name of terminal device to use for I/O.  */
 450   char *terminal;
 451
 452   /* Environment to use for running inferior,
 453      in format described in environ.h.  */
 454   struct gdb_environ *environment;
 455
 456   /* Nonzero if this child process was attached rather than
 457      forked.  */
 458   int attach_flag;
 459
 460   /* If this inferior is a vfork child, then this is the pointer to
 461      its vfork parent, if GDB is still attached to it.  */
 462   struct inferior *vfork_parent;
 463
 464   /* If this process is a vfork parent, this is the pointer to the
 465      child.  Since a vfork parent is left frozen by the kernel until
 466      the child execs or exits, a process can only have one vfork child
 467      at a given time.  */
 468   struct inferior *vfork_child;
 469
 470   /* True if this inferior should be detached when it's vfork sibling
 471      exits or execs.  */
 472   int pending_detach;
 473
 474   /* True if this inferior is a vfork parent waiting for a vfork child
 475      not under our control to be done with the shared memory region,
 476      either by exiting or execing.  */
 477   int waiting_for_vfork_done;
 478
 479   /* True if we're in the process of detaching from this inferior.  */
 480   int detaching;
 481
 482   /* What is left to do for an execution command after any thread of
 483      this inferior stops.  For continuations associated with a
 484      specific thread, see `struct thread_info'.  */
 485   struct continuation *continuations;
 486
 487   /* Private data used by the target vector implementation.  */
 488   struct private_inferior *private;
 489
 490   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 491      In this case, the EXIT_CODE field is also valid.  */
 492   int has_exit_code;
 493   LONGEST exit_code;
 494
 495   /* Default flags to pass to the symbol reading functions.  These are
 496      used whenever a new objfile is created.  The valid values come
 497      from enum symfile_add_flags.  */
 498   int symfile_flags;
 499
 500   /* Info about an inferior's target description (if it's fetched; the
 501      user supplied description's filename, if any; etc.).  */
 502   struct target_desc_info *tdesc_info;
 503
 504   /* The architecture associated with the inferior through the
 505      connection to the target.
 506
 507      The architecture vector provides some information that is really
 508      a property of the inferior, accessed through a particular target:
 509      ptrace operations; the layout of certain RSP packets; the
 510      solib_ops vector; etc.  To differentiate architecture accesses to
 511      per-inferior/target properties from
 512      per-thread/per-frame/per-objfile properties, accesses to
 513      per-inferior/target properties should be made through
 514      this gdbarch.  */
 515   struct gdbarch *gdbarch;
 516
 517   /* Per inferior data-pointers required by other GDB modules.  */
 518   REGISTRY_FIELDS;
 519 };
 520
 521 /* Keep a registry of per-inferior data-pointers required by other GDB
 522    modules.  */
 523
 524 DECLARE_REGISTRY (inferior);
 525
 526 /* Create an empty inferior list, or empty the existing one.  */
 527 extern void init_inferior_list (void);
 528
 529 /* Add an inferior to the inferior list, print a message that a new
 530    inferior is found, and return the pointer to the new inferior.
 531    Caller may use this pointer to initialize the private inferior
 532    data.  */
 533 extern struct inferior *add_inferior (int pid);
 534
 535 /* Same as add_inferior, but don't print new inferior notifications to
 536    the CLI.  */
 537 extern struct inferior *add_inferior_silent (int pid);
 538
 539 /* Delete an existing inferior list entry, due to inferior exit.  */
 540 extern void delete_inferior (int pid);
 541
 542 extern void delete_inferior_1 (struct inferior *todel, int silent);
 543
 544 /* Same as delete_inferior, but don't print new inferior notifications
 545    to the CLI.  */
 546 extern void delete_inferior_silent (int pid);
 547
 548 /* Delete an existing inferior list entry, due to inferior detaching.  */
 549 extern void detach_inferior (int pid);
 550
 551 extern void exit_inferior (int pid);
 552
 553 extern void exit_inferior_silent (int pid);
 554
 555 extern void exit_inferior_num_silent (int num);
 556
 557 extern void inferior_appeared (struct inferior *inf, int pid);
 558
 559 /* Get rid of all inferiors.  */
 560 extern void discard_all_inferiors (void);
 561
 562 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 563    into a "pid" (which may be overloaded with extra inferior information).  */
 564 extern int gdb_inferior_id_to_pid (int);
 565
 566 /* Translate a target 'pid' into the integer inferior id (GDB's
 567    homegrown id, not the system's).  */
 568 extern int pid_to_gdb_inferior_id (int pid);
 569
 570 /* Boolean test for an already-known pid.  */
 571 extern int in_inferior_list (int pid);
 572
 573 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 574    not the system's).  */
 575 extern int valid_gdb_inferior_id (int num);
 576
 577 /* Search function to lookup an inferior by target 'pid'.  */
 578 extern struct inferior *find_inferior_pid (int pid);
 579
 580 /* Search function to lookup an inferior by GDB 'num'.  */
 581 extern struct inferior *find_inferior_id (int num);
 582
 583 /* Find an inferior bound to PSPACE.  */
 584 extern struct inferior *
 585   find_inferior_for_program_space (struct program_space *pspace);
 586
 587 /* Inferior iterator function.
 588
 589    Calls a callback function once for each inferior, so long as the
 590    callback function returns false.  If the callback function returns
 591    true, the iteration will end and the current inferior will be
 592    returned.  This can be useful for implementing a search for a
 593    inferior with arbitrary attributes, or for applying some operation
 594    to every inferior.
 595
 596    It is safe to delete the iterated inferior from the callback.  */
 597 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 598                                                          void *),
 599                                                 void *);
 600
 601 /* Returns true if the inferior list is not empty.  */
 602 extern int have_inferiors (void);
 603
 604 /* Returns true if there are any live inferiors in the inferior list
 605    (not cores, not executables, real live processes).  */
 606 extern int have_live_inferiors (void);
 607
 608 /* Return a pointer to the current inferior.  It is an error to call
 609    this if there is no current inferior.  */
 610 extern struct inferior *current_inferior (void);
 611
 612 extern void set_current_inferior (struct inferior *);
 613
 614 extern struct cleanup *save_current_inferior (void);
 615
 616 /* Traverse all inferiors.  */
 617
 618 #define ALL_INFERIORS(I) \
 619   for ((I) = inferior_list; (I); (I) = (I)->next)
 620
 621 extern struct inferior *inferior_list;
 622
 623 /* Prune away automatically added inferiors that aren't required
 624    anymore.  */
 625 extern void prune_inferiors (void);
 626
 627 extern int number_of_inferiors (void);
 628
 629 extern struct inferior *add_inferior_with_spaces (void);
 630
 631 extern void update_observer_mode (void);
 632
 633 extern void update_signals_program_target (void);
 634
 635 extern void signal_catch_update (const unsigned int *);
 636
 637 /* In some circumstances we allow a command to specify a numeric
 638    signal.  The idea is to keep these circumstances limited so that
 639    users (and scripts) develop portable habits.  For comparison,
 640    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
 641    numeric signal at all is obsolescent.  We are slightly more lenient
 642    and allow 1-15 which should match host signal numbers on most
 643    systems.  Use of symbolic signal names is strongly encouraged.  */
 644
 645 enum gdb_signal gdb_signal_from_command (int num);
 646
 647 #endif /* !defined (INFERIOR_H) */