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 void start_remote (int from_tty);
 236
 237 extern void normal_stop (void);
 238
 239 extern int signal_stop_state (int);
 240
 241 extern int signal_print_state (int);
 242
 243 extern int signal_pass_state (int);
 244
 245 extern int signal_stop_update (int, int);
 246
 247 extern int signal_print_update (int, int);
 248
 249 extern int signal_pass_update (int, int);
 250
 251 extern void get_last_target_status(ptid_t *ptid,
 252                                    struct target_waitstatus *status);
 253
 254 extern void follow_inferior_reset_breakpoints (void);
 255
 256 /* Throw an error indicating the current thread is running.  */
 257 extern void error_is_running (void);
 258
 259 /* Calls error_is_running if the current thread is running.  */
 260 extern void ensure_not_running (void);
 261
 262 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
 263
 264 /* From infcmd.c */
 265
 266 extern void post_create_inferior (struct target_ops *, int);
 267
 268 extern void attach_command (char *, int);
 269
 270 extern char *get_inferior_args (void);
 271
 272 extern void set_inferior_args (char *);
 273
 274 extern void set_inferior_args_vector (int, char **);
 275
 276 extern void registers_info (char *, int);
 277
 278 extern void nexti_command (char *, int);
 279
 280 extern void stepi_command (char *, int);
 281
 282 extern void continue_1 (int all_threads);
 283
 284 extern void continue_command (char *, int);
 285
 286 extern void interrupt_target_command (char *args, int from_tty);
 287
 288 extern void interrupt_target_1 (int all_threads);
 289
 290 extern void detach_command (char *, int);
 291
 292 extern void notice_new_inferior (ptid_t, int, int);
 293
 294 /* Address at which inferior stopped.  */
 295
 296 extern CORE_ADDR stop_pc;
 297
 298 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 299
 300 extern enum stop_stack_kind stop_stack_dummy;
 301
 302 /* Nonzero if program stopped due to a random (unexpected) signal in
 303    inferior process.  */
 304
 305 extern int stopped_by_random_signal;
 306
 307 /* STEP_OVER_ALL means step over all subroutine calls.
 308    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 309    STEP_OVER_NONE means don't step over any subroutine calls.  */
 310
 311 enum step_over_calls_kind
 312   {
 313     STEP_OVER_NONE,
 314     STEP_OVER_ALL,
 315     STEP_OVER_UNDEBUGGABLE
 316   };
 317
 318 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 319    will handle it themselves.  STOP_QUIETLY is used when running in
 320    the shell before the child program has been exec'd and when running
 321    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 322    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 323    except that there is no need to hide a signal.  */
 324
 325 /* It is also used after attach, due to attaching to a process. This
 326    is a bit trickier.  When doing an attach, the kernel stops the
 327    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 328    the handling of SIGSTOP for a ptraced process has changed. Earlier
 329    versions of the kernel would ignore these SIGSTOPs, while now
 330    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 331
 332    If the gdb user does a 'continue' after the 'attach', gdb passes
 333    the global variable stop_signal (which stores the signal from the
 334    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 335    problematic, because the kernel doesn't ignore such SIGSTOP
 336    now. I.e. it is reported back to gdb, which in turn presents it
 337    back to the user.
 338
 339    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 340    gdb to clear the value of stop_signal after the attach, so that it
 341    is not passed back down to the kernel.  */
 342
 343 enum stop_kind
 344   {
 345     NO_STOP_QUIETLY = 0,
 346     STOP_QUIETLY,
 347     STOP_QUIETLY_REMOTE,
 348     STOP_QUIETLY_NO_SIGSTOP
 349   };
 350
 351 /* Reverse execution.  */
 352 enum exec_direction_kind
 353   {
 354     EXEC_FORWARD,
 355     EXEC_REVERSE,
 356     EXEC_ERROR
 357   };
 358
 359 extern enum exec_direction_kind execution_direction;
 360
 361 /* Save register contents here when executing a "finish" command or are
 362    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 363    Thus this contains the return value from the called function (assuming
 364    values are returned in a register).  */
 365
 366 extern struct regcache *stop_registers;
 367
 368 /* True if we are debugging displaced stepping.  */
 369 extern int debug_displaced;
 370
 371 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 372 void displaced_step_dump_bytes (struct ui_file *file,
 373                                 const gdb_byte *buf, size_t len);
 374
 375 \f
 376 /* Possible values for gdbarch_call_dummy_location.  */
 377 #define ON_STACK 1
 378 #define AT_ENTRY_POINT 4
 379 #define AT_SYMBOL 5
 380
 381 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 382    will attempts to start up the debugee under a shell.
 383    This is in order for argument-expansion to occur. E.g.,
 384    (gdb) run *
 385    The "*" gets expanded by the shell into a list of files.
 386    While this is a nice feature, it turns out to interact badly
 387    with some of the catch-fork/catch-exec features we have added.
 388    In particular, if the shell does any fork/exec's before
 389    the exec of the target program, that can confuse GDB.
 390    To disable this feature, set STARTUP_WITH_SHELL to 0.
 391    To enable this feature, set STARTUP_WITH_SHELL to 1.
 392    The catch-exec traps expected during start-up will
 393    be 1 if target is not started up with a shell, 2 if it is.
 394    - RT
 395    If you disable this, you need to decrement
 396    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 397 #define STARTUP_WITH_SHELL 1
 398 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 399 #define START_INFERIOR_TRAPS_EXPECTED   2
 400 #endif
 401
 402 struct private_inferior;
 403
 404 /* GDB represents the state of each program execution with an object
 405    called an inferior.  An inferior typically corresponds to a process
 406    but is more general and applies also to targets that do not have a
 407    notion of processes.  Each run of an executable creates a new
 408    inferior, as does each attachment to an existing process.
 409    Inferiors have unique internal identifiers that are different from
 410    target process ids.  Each inferior may in turn have multiple
 411    threads running in it.  */
 412
 413 struct inferior
 414 {
 415   /* Pointer to next inferior in singly-linked list of inferiors.  */
 416   struct inferior *next;
 417
 418   /* Convenient handle (GDB inferior id).  Unique across all
 419      inferiors.  */
 420   int num;
 421
 422   /* Actual target inferior id, usually, a process id.  This matches
 423      the ptid_t.pid member of threads of this inferior.  */
 424   int pid;
 425
 426   /* True if this was an auto-created inferior, e.g. created from
 427      following a fork; false, if this inferior was manually added by
 428      the user, and we should not attempt to prune it
 429      automatically.  */
 430   int removable;
 431
 432   /* The address space bound to this inferior.  */
 433   struct address_space *aspace;
 434
 435   /* The program space bound to this inferior.  */
 436   struct program_space *pspace;
 437
 438   /* The arguments string to use when running.  */
 439   char *args;
 440
 441   /* The size of elements in argv.  */
 442   int argc;
 443
 444   /* The vector version of arguments.  If ARGC is nonzero,
 445      then we must compute ARGS from this (via the target).
 446      This is always coming from main's argv and therefore
 447      should never be freed.  */
 448   char **argv;
 449
 450   /* The name of terminal device to use for I/O.  */
 451   char *terminal;
 452
 453   /* Environment to use for running inferior,
 454      in format described in environ.h.  */
 455   struct gdb_environ *environment;
 456
 457   /* See the definition of stop_kind above.  */
 458   enum stop_kind stop_soon;
 459
 460   /* Nonzero if this child process was attached rather than
 461      forked.  */
 462   int attach_flag;
 463
 464   /* If this inferior is a vfork child, then this is the pointer to
 465      its vfork parent, if GDB is still attached to it.  */
 466   struct inferior *vfork_parent;
 467
 468   /* If this process is a vfork parent, this is the pointer to the
 469      child.  Since a vfork parent is left frozen by the kernel until
 470      the child execs or exits, a process can only have one vfork child
 471      at a given time.  */
 472   struct inferior *vfork_child;
 473
 474   /* True if this inferior should be detached when it's vfork sibling
 475      exits or execs.  */
 476   int pending_detach;
 477
 478   /* True if this inferior is a vfork parent waiting for a vfork child
 479      not under our control to be done with the shared memory region,
 480      either by exiting or execing.  */
 481   int waiting_for_vfork_done;
 482
 483   /* True if we're in the process of detaching from this inferior.  */
 484   int detaching;
 485
 486   /* What is left to do for an execution command after any thread of
 487      this inferior stops.  For continuations associated with a
 488      specific thread, see `struct thread_info'.  */
 489   struct continuation *continuations;
 490
 491   /* Private data used by the target vector implementation.  */
 492   struct private_inferior *private;
 493
 494   /* We keep a count of the number of times the user has requested a
 495      particular syscall to be tracked, and pass this information to the
 496      target.  This lets capable targets implement filtering directly.  */
 497
 498   /* Number of times that "any" syscall is requested.  */
 499   int any_syscall_count;
 500
 501   /* Count of each system call.  */
 502   VEC(int) *syscalls_counts;
 503
 504   /* This counts all syscall catch requests, so we can readily determine
 505      if any catching is necessary.  */
 506   int total_syscalls_count;
 507
 508   /* Per inferior data-pointers required by other GDB modules.  */
 509   void **data;
 510   unsigned num_data;
 511 };
 512
 513 /* Keep a registry of per-inferior data-pointers required by other GDB
 514    modules.  */
 515
 516 extern const struct inferior_data *register_inferior_data (void);
 517 extern const struct inferior_data *register_inferior_data_with_cleanup
 518   (void (*cleanup) (struct inferior *, void *));
 519 extern void clear_inferior_data (struct inferior *inf);
 520 extern void set_inferior_data (struct inferior *inf,
 521                                const struct inferior_data *data, void *value);
 522 extern void *inferior_data (struct inferior *inf,
 523                             const struct inferior_data *data);
 524
 525 /* Create an empty inferior list, or empty the existing one.  */
 526 extern void init_inferior_list (void);
 527
 528 /* Add an inferior to the inferior list, print a message that a new
 529    inferior is found, and return the pointer to the new inferior.
 530    Caller may use this pointer to initialize the private inferior
 531    data.  */
 532 extern struct inferior *add_inferior (int pid);
 533
 534 /* Same as add_inferior, but don't print new inferior notifications to
 535    the CLI.  */
 536 extern struct inferior *add_inferior_silent (int pid);
 537
 538 /* Delete an existing inferior list entry, due to inferior exit.  */
 539 extern void delete_inferior (int pid);
 540
 541 extern void delete_inferior_1 (struct inferior *todel, int silent);
 542
 543 /* Same as delete_inferior, but don't print new inferior notifications
 544    to the CLI.  */
 545 extern void delete_inferior_silent (int pid);
 546
 547 /* Delete an existing inferior list entry, due to inferior detaching.  */
 548 extern void detach_inferior (int pid);
 549
 550 extern void exit_inferior (int pid);
 551
 552 extern void exit_inferior_silent (int pid);
 553
 554 extern void exit_inferior_num_silent (int num);
 555
 556 extern void inferior_appeared (struct inferior *inf, int pid);
 557
 558 /* Get rid of all inferiors.  */
 559 extern void discard_all_inferiors (void);
 560
 561 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 562    into a "pid" (which may be overloaded with extra inferior information).  */
 563 extern int gdb_inferior_id_to_pid (int);
 564
 565 /* Translate a target 'pid' into the integer inferior id (GDB's
 566    homegrown id, not the system's).  */
 567 extern int pid_to_gdb_inferior_id (int pid);
 568
 569 /* Boolean test for an already-known pid.  */
 570 extern int in_inferior_list (int pid);
 571
 572 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 573    not the system's).  */
 574 extern int valid_gdb_inferior_id (int num);
 575
 576 /* Search function to lookup an inferior by target 'pid'.  */
 577 extern struct inferior *find_inferior_pid (int pid);
 578
 579 /* Search function to lookup an inferior by GDB 'num'.  */
 580 extern struct inferior *find_inferior_id (int num);
 581
 582 /* Find an inferior bound to PSPACE.  */
 583 extern struct inferior *
 584   find_inferior_for_program_space (struct program_space *pspace);
 585
 586 /* Inferior iterator function.
 587
 588    Calls a callback function once for each inferior, so long as the
 589    callback function returns false.  If the callback function returns
 590    true, the iteration will end and the current inferior will be
 591    returned.  This can be useful for implementing a search for a
 592    inferior with arbitrary attributes, or for applying some operation
 593    to every inferior.
 594
 595    It is safe to delete the iterated inferior from the callback.  */
 596 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 597                                                          void *),
 598                                                 void *);
 599
 600 /* Prints the list of inferiors and their details on UIOUT.
 601
 602    If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
 603    that should be printed.  Otherwise, all inferiors are printed.  */
 604 extern void print_inferior (struct ui_out *uiout, int requested_inferior);
 605
 606 /* Returns true if the inferior list is not empty.  */
 607 extern int have_inferiors (void);
 608
 609 /* Returns true if there are any live inferiors in the inferior list
 610    (not cores, not executables, real live processes).  */
 611 extern int have_live_inferiors (void);
 612
 613 /* Return a pointer to the current inferior.  It is an error to call
 614    this if there is no current inferior.  */
 615 extern struct inferior *current_inferior (void);
 616
 617 extern void set_current_inferior (struct inferior *);
 618
 619 extern struct cleanup *save_current_inferior (void);
 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 #endif /* !defined (INFERIOR_H) */