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