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
   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
  34 /* For bpstat.  */
  35 #include "breakpoint.h"
  36
  37 /* For enum target_signal.  */
  38 #include "target.h"
  39
  40 /* For struct frame_id.  */
  41 #include "frame.h"
  42
  43 /* Two structures are used to record inferior state.
  44
  45    inferior_thread_state contains state about the program itself like its
  46    registers and any signal it received when it last stopped.
  47    This state must be restored regardless of how the inferior function call
  48    ends (either successfully, or after it hits a breakpoint or signal)
  49    if the program is to properly continue where it left off.
  50
  51    inferior_status contains state regarding gdb's control of the inferior
  52    itself like stepping control.  It also contains session state like the
  53    user's currently selected frame.
  54
  55    Call these routines around hand called functions, including function calls
  56    in conditional breakpoints for example.  */
  57
  58 struct inferior_thread_state;
  59 struct inferior_status;
  60
  61 extern struct inferior_thread_state *save_inferior_thread_state (void);
  62 extern struct inferior_status *save_inferior_status (void);
  63
  64 extern void restore_inferior_thread_state (struct inferior_thread_state *);
  65 extern void restore_inferior_status (struct inferior_status *);
  66
  67 extern struct cleanup *make_cleanup_restore_inferior_thread_state (struct inferior_thread_state *);
  68 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
  69
  70 extern void discard_inferior_thread_state (struct inferior_thread_state *);
  71 extern void discard_inferior_status (struct inferior_status *);
  72
  73 extern struct regcache *get_inferior_thread_state_regcache (struct inferior_thread_state *);
  74
  75 /* The -1 ptid, often used to indicate either an error condition
  76    or a "don't care" condition, i.e, "run all threads."  */
  77 extern ptid_t minus_one_ptid;
  78
  79 /* The null or zero ptid, often used to indicate no process. */
  80 extern ptid_t null_ptid;
  81
  82 /* Attempt to find and return an existing ptid with the given PID, LWP,
  83    and TID components.  If none exists, create a new one and return
  84    that.  */
  85 ptid_t ptid_build (int pid, long lwp, long tid);
  86
  87 /* Find/Create a ptid from just a pid. */
  88 ptid_t pid_to_ptid (int pid);
  89
  90 /* Fetch the pid (process id) component from a ptid. */
  91 int ptid_get_pid (ptid_t ptid);
  92
  93 /* Fetch the lwp (lightweight process) component from a ptid. */
  94 long ptid_get_lwp (ptid_t ptid);
  95
  96 /* Fetch the tid (thread id) component from a ptid. */
  97 long ptid_get_tid (ptid_t ptid);
  98
  99 /* Compare two ptids to see if they are equal */
 100 extern int ptid_equal (ptid_t p1, ptid_t p2);
 101
 102 /* Return true if PTID represents a process id.  */
 103 extern int ptid_is_pid (ptid_t ptid);
 104
 105 /* Save value of inferior_ptid so that it may be restored by
 106    a later call to do_cleanups().  Returns the struct cleanup
 107    pointer needed for later doing the cleanup.  */
 108 extern struct cleanup * save_inferior_ptid (void);
 109
 110 extern void set_sigint_trap (void);
 111
 112 extern void clear_sigint_trap (void);
 113
 114 /* Set/get file name for default use for standard in/out in the inferior.  */
 115
 116 extern void set_inferior_io_terminal (const char *terminal_name);
 117 extern const char *get_inferior_io_terminal (void);
 118
 119 /* Collected pid, tid, etc. of the debugged inferior.  When there's
 120    no inferior, PIDGET (inferior_ptid) will be 0. */
 121
 122 extern ptid_t inferior_ptid;
 123
 124 /* Are we simulating synchronous execution? This is used in async gdb
 125    to implement the 'run', 'continue' etc commands, which will not
 126    redisplay the prompt until the execution is actually over. */
 127 extern int sync_execution;
 128
 129 /* Inferior environment. */
 130
 131 extern struct gdb_environ *inferior_environ;
 132
 133 extern void clear_proceed_status (void);
 134
 135 extern void proceed (CORE_ADDR, enum target_signal, int);
 136
 137 /* When set, stop the 'step' command if we enter a function which has
 138    no line number information.  The normal behavior is that we step
 139    over such function.  */
 140 extern int step_stop_if_no_debug;
 141
 142 /* If set, the inferior should be controlled in non-stop mode.  In
 143    this mode, each thread is controlled independently.  Execution
 144    commands apply only to the the selected thread by default, and stop
 145    events stop only the thread that had the event -- the other threads
 146    are kept running freely.  */
 147 extern int non_stop;
 148
 149 extern void generic_mourn_inferior (void);
 150
 151 extern void terminal_save_ours (void);
 152
 153 extern void terminal_ours (void);
 154
 155 extern CORE_ADDR read_pc (void);
 156
 157 extern void write_pc (CORE_ADDR);
 158
 159 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
 160                                               const gdb_byte *buf);
 161 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
 162                                          CORE_ADDR addr);
 163 extern CORE_ADDR signed_pointer_to_address (struct type *type,
 164                                             const gdb_byte *buf);
 165 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
 166                                        CORE_ADDR addr);
 167
 168 extern void wait_for_inferior (int treat_exec_as_sigtrap);
 169
 170 extern void fetch_inferior_event (void *);
 171
 172 extern void init_wait_for_inferior (void);
 173
 174 extern void close_exec_file (void);
 175
 176 extern void reopen_exec_file (void);
 177
 178 /* The `resume' routine should only be called in special circumstances.
 179    Normally, use `proceed', which handles a lot of bookkeeping.  */
 180
 181 extern void resume (int, enum target_signal);
 182
 183 /* From misc files */
 184
 185 extern void default_print_registers_info (struct gdbarch *gdbarch,
 186                                           struct ui_file *file,
 187                                           struct frame_info *frame,
 188                                           int regnum, int all);
 189
 190 extern void child_terminal_info (char *, int);
 191
 192 extern void term_info (char *, int);
 193
 194 extern void terminal_ours_for_output (void);
 195
 196 extern void terminal_inferior (void);
 197
 198 extern void terminal_init_inferior (void);
 199
 200 extern void terminal_init_inferior_with_pgrp (int pgrp);
 201
 202 /* From procfs.c */
 203
 204 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 205
 206 extern ptid_t procfs_first_available (void);
 207
 208 /* From fork-child.c */
 209
 210 extern int fork_inferior (char *, char *, char **,
 211                           void (*)(void),
 212                           void (*)(int), void (*)(void), char *);
 213
 214
 215 extern void startup_inferior (int);
 216
 217 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
 218
 219 /* From inflow.c */
 220
 221 extern void new_tty_prefork (const char *);
 222
 223 extern int gdb_has_a_terminal (void);
 224
 225 /* From infrun.c */
 226
 227 extern void start_remote (int from_tty);
 228
 229 extern void normal_stop (void);
 230
 231 extern int signal_stop_state (int);
 232
 233 extern int signal_print_state (int);
 234
 235 extern int signal_pass_state (int);
 236
 237 extern int signal_stop_update (int, int);
 238
 239 extern int signal_print_update (int, int);
 240
 241 extern int signal_pass_update (int, int);
 242
 243 extern void get_last_target_status(ptid_t *ptid,
 244                                    struct target_waitstatus *status);
 245
 246 extern void follow_inferior_reset_breakpoints (void);
 247
 248 /* Throw an error indicating the current thread is running.  */
 249 extern void error_is_running (void);
 250
 251 /* Calls error_is_running if the current thread is running.  */
 252 extern void ensure_not_running (void);
 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 /* 1 means step over all subroutine calls.
 300    -1 means step over calls to undebuggable functions.  */
 301
 302 enum step_over_calls_kind
 303   {
 304     STEP_OVER_NONE,
 305     STEP_OVER_ALL,
 306     STEP_OVER_UNDEBUGGABLE
 307   };
 308
 309 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 310    will handle it themselves.  STOP_QUIETLY is used when running in
 311    the shell before the child program has been exec'd and when running
 312    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 313    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 314    except that there is no need to hide a signal.  */
 315
 316 /* It is also used after attach, due to attaching to a process. This
 317    is a bit trickier.  When doing an attach, the kernel stops the
 318    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 319    the handling of SIGSTOP for a ptraced process has changed. Earlier
 320    versions of the kernel would ignore these SIGSTOPs, while now
 321    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 322
 323    If the gdb user does a 'continue' after the 'attach', gdb passes
 324    the global variable stop_signal (which stores the signal from the
 325    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 326    problematic, because the kernel doesn't ignore such SIGSTOP
 327    now. I.e. it is reported back to gdb, which in turn presents it
 328    back to the user.
 329
 330    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 331    gdb to clear the value of stop_signal after the attach, so that it
 332    is not passed back down to the kernel.  */
 333
 334 enum stop_kind
 335   {
 336     NO_STOP_QUIETLY = 0,
 337     STOP_QUIETLY,
 338     STOP_QUIETLY_REMOTE,
 339     STOP_QUIETLY_NO_SIGSTOP
 340   };
 341
 342 /* Reverse execution.  */
 343 enum exec_direction_kind
 344   {
 345     EXEC_FORWARD,
 346     EXEC_REVERSE,
 347     EXEC_ERROR
 348   };
 349
 350 extern enum exec_direction_kind execution_direction;
 351
 352 /* Save register contents here when executing a "finish" command or are
 353    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 354    Thus this contains the return value from the called function (assuming
 355    values are returned in a register).  */
 356
 357 extern struct regcache *stop_registers;
 358
 359 /* True if we are debugging displaced stepping.  */
 360 extern int debug_displaced;
 361
 362 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 363 void displaced_step_dump_bytes (struct ui_file *file,
 364                                 const gdb_byte *buf, size_t len);
 365
 366 \f
 367 /* Possible values for gdbarch_call_dummy_location.  */
 368 #define ON_STACK 1
 369 #define AT_ENTRY_POINT 4
 370 #define AT_SYMBOL 5
 371
 372 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 373    will attempts to start up the debugee under a shell.
 374    This is in order for argument-expansion to occur. E.g.,
 375    (gdb) run *
 376    The "*" gets expanded by the shell into a list of files.
 377    While this is a nice feature, it turns out to interact badly
 378    with some of the catch-fork/catch-exec features we have added.
 379    In particular, if the shell does any fork/exec's before
 380    the exec of the target program, that can confuse GDB.
 381    To disable this feature, set STARTUP_WITH_SHELL to 0.
 382    To enable this feature, set STARTUP_WITH_SHELL to 1.
 383    The catch-exec traps expected during start-up will
 384    be 1 if target is not started up with a shell, 2 if it is.
 385    - RT
 386    If you disable this, you need to decrement
 387    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 388 #define STARTUP_WITH_SHELL 1
 389 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 390 #define START_INFERIOR_TRAPS_EXPECTED   2
 391 #endif
 392
 393 struct private_inferior;
 394
 395 /* GDB represents the state of each program execution with an object
 396    called an inferior.  An inferior typically corresponds to a process
 397    but is more general and applies also to targets that do not have a
 398    notion of processes.  Each run of an executable creates a new
 399    inferior, as does each attachment to an existing process.
 400    Inferiors have unique internal identifiers that are different from
 401    target process ids.  Each inferior may in turn have multiple
 402    threads running in it.  */
 403
 404 struct inferior
 405 {
 406   /* Pointer to next inferior in singly-linked list of inferiors.  */
 407   struct inferior *next;
 408
 409   /* Convenient handle (GDB inferior id).  Unique across all
 410      inferiors.  */
 411   int num;
 412
 413   /* Actual target inferior id, usually, a process id.  This matches
 414      the ptid_t.pid member of threads of this inferior.  */
 415   int pid;
 416
 417   /* See the definition of stop_kind above.  */
 418   enum stop_kind stop_soon;
 419
 420   /* Nonzero if this child process was attached rather than
 421      forked.  */
 422   int attach_flag;
 423
 424   /* What is left to do for an execution command after any thread of
 425      this inferior stops.  For continuations associated with a
 426      specific thread, see `struct thread_info'.  */
 427   struct continuation *continuations;
 428
 429   /* Private data used by the target vector implementation.  */
 430   struct private_inferior *private;
 431 };
 432
 433 /* Create an empty inferior list, or empty the existing one.  */
 434 extern void init_inferior_list (void);
 435
 436 /* Add an inferior to the inferior list, print a message that a new
 437    inferior is found, and return the pointer to the new inferior.
 438    Caller may use this pointer to initialize the private inferior
 439    data.  */
 440 extern struct inferior *add_inferior (int pid);
 441
 442 /* Same as add_inferior, but don't print new inferior notifications to
 443    the CLI.  */
 444 extern struct inferior *add_inferior_silent (int pid);
 445
 446 /* Delete an existing inferior list entry, due to inferior exit.  */
 447 extern void delete_inferior (int pid);
 448
 449 /* Same as delete_inferior, but don't print new inferior notifications
 450    to the CLI.  */
 451 extern void delete_inferior_silent (int pid);
 452
 453 /* Delete an existing inferior list entry, due to inferior detaching.  */
 454 extern void detach_inferior (int pid);
 455
 456 /* Get rid of all inferiors.  */
 457 extern void discard_all_inferiors (void);
 458
 459 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 460    into a "pid" (which may be overloaded with extra inferior information).  */
 461 extern int gdb_inferior_id_to_pid (int);
 462
 463 /* Translate a target 'pid' into the integer inferior id (GDB's
 464    homegrown id, not the system's).  */
 465 extern int pid_to_gdb_inferior_id (int pid);
 466
 467 /* Boolean test for an already-known pid.  */
 468 extern int in_inferior_list (int pid);
 469
 470 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 471    not the system's).  */
 472 extern int valid_gdb_inferior_id (int num);
 473
 474 /* Search function to lookup a inferior by target 'pid'.  */
 475 extern struct inferior *find_inferior_pid (int pid);
 476
 477 /* Inferior iterator function.
 478
 479    Calls a callback function once for each inferior, so long as the
 480    callback function returns false.  If the callback function returns
 481    true, the iteration will end and the current inferior will be
 482    returned.  This can be useful for implementing a search for a
 483    inferior with arbitrary attributes, or for applying some operation
 484    to every inferior.
 485
 486    It is safe to delete the iterated inferior from the callback.  */
 487 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 488                                                          void *),
 489                                                 void *);
 490
 491 /* Prints the list of inferiors and their details on UIOUT.
 492
 493    If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
 494    that should be printed.  Otherwise, all inferiors are printed.  */
 495 extern void print_inferior (struct ui_out *uiout, int requested_inferior);
 496
 497 /* Returns true if the inferior list is not empty.  */
 498 extern int have_inferiors (void);
 499
 500 /* Return a pointer to the current inferior.  It is an error to call
 501    this if there is no current inferior.  */
 502 extern struct inferior *current_inferior (void);
 503
 504 #endif /* !defined (INFERIOR_H) */