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