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