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