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 unsigned_pointer_to_address (struct type *type,
 156                                               const gdb_byte *buf);
 157 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
 158                                          CORE_ADDR addr);
 159 extern CORE_ADDR signed_pointer_to_address (struct type *type,
 160                                             const gdb_byte *buf);
 161 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
 162                                        CORE_ADDR addr);
 163
 164 extern void wait_for_inferior (int treat_exec_as_sigtrap);
 165
 166 extern void fetch_inferior_event (void *);
 167
 168 extern void init_wait_for_inferior (void);
 169
 170 extern void close_exec_file (void);
 171
 172 extern void reopen_exec_file (void);
 173
 174 /* The `resume' routine should only be called in special circumstances.
 175    Normally, use `proceed', which handles a lot of bookkeeping.  */
 176
 177 extern void resume (int, enum target_signal);
 178
 179 /* From misc files */
 180
 181 extern void default_print_registers_info (struct gdbarch *gdbarch,
 182                                           struct ui_file *file,
 183                                           struct frame_info *frame,
 184                                           int regnum, int all);
 185
 186 extern void child_terminal_info (char *, int);
 187
 188 extern void term_info (char *, int);
 189
 190 extern void terminal_ours_for_output (void);
 191
 192 extern void terminal_inferior (void);
 193
 194 extern void terminal_init_inferior (void);
 195
 196 extern void terminal_init_inferior_with_pgrp (int pgrp);
 197
 198 /* From procfs.c */
 199
 200 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 201
 202 extern ptid_t procfs_first_available (void);
 203
 204 /* From fork-child.c */
 205
 206 extern int fork_inferior (char *, char *, char **,
 207                           void (*)(void),
 208                           void (*)(int), void (*)(void), char *);
 209
 210
 211 extern void startup_inferior (int);
 212
 213 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
 214
 215 /* From inflow.c */
 216
 217 extern void new_tty_prefork (const char *);
 218
 219 extern int gdb_has_a_terminal (void);
 220
 221 /* From infrun.c */
 222
 223 extern void start_remote (int from_tty);
 224
 225 extern void normal_stop (void);
 226
 227 extern int signal_stop_state (int);
 228
 229 extern int signal_print_state (int);
 230
 231 extern int signal_pass_state (int);
 232
 233 extern int signal_stop_update (int, int);
 234
 235 extern int signal_print_update (int, int);
 236
 237 extern int signal_pass_update (int, int);
 238
 239 extern void get_last_target_status(ptid_t *ptid,
 240                                    struct target_waitstatus *status);
 241
 242 extern void follow_inferior_reset_breakpoints (void);
 243
 244 /* Throw an error indicating the current thread is running.  */
 245 extern void error_is_running (void);
 246
 247 /* Calls error_is_running if the current thread is running.  */
 248 extern void ensure_not_running (void);
 249
 250 /* From infcmd.c */
 251
 252 extern void tty_command (char *, int);
 253
 254 extern void post_create_inferior (struct target_ops *, int);
 255
 256 extern void attach_command (char *, int);
 257
 258 extern char *get_inferior_args (void);
 259
 260 extern char *set_inferior_args (char *);
 261
 262 extern void set_inferior_args_vector (int, char **);
 263
 264 extern void registers_info (char *, int);
 265
 266 extern void nexti_command (char *, int);
 267
 268 extern void stepi_command (char *, int);
 269
 270 extern void continue_1 (int all_threads);
 271
 272 extern void continue_command (char *, int);
 273
 274 extern void interrupt_target_command (char *args, int from_tty);
 275
 276 extern void interrupt_target_1 (int all_threads);
 277
 278 extern void detach_command (char *, int);
 279
 280 extern void notice_new_inferior (ptid_t, int, int);
 281
 282 /* Address at which inferior stopped.  */
 283
 284 extern CORE_ADDR stop_pc;
 285
 286 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 287
 288 extern int stop_stack_dummy;
 289
 290 /* Nonzero if program stopped due to a random (unexpected) signal in
 291    inferior process.  */
 292
 293 extern int stopped_by_random_signal;
 294
 295 /* 1 means step over all subroutine calls.
 296    -1 means step over calls to undebuggable functions.  */
 297
 298 enum step_over_calls_kind
 299   {
 300     STEP_OVER_NONE,
 301     STEP_OVER_ALL,
 302     STEP_OVER_UNDEBUGGABLE
 303   };
 304
 305 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 306    will handle it themselves.  STOP_QUIETLY is used when running in
 307    the shell before the child program has been exec'd and when running
 308    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 309    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 310    except that there is no need to hide a signal.  */
 311
 312 /* It is also used after attach, due to attaching to a process. This
 313    is a bit trickier.  When doing an attach, the kernel stops the
 314    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 315    the handling of SIGSTOP for a ptraced process has changed. Earlier
 316    versions of the kernel would ignore these SIGSTOPs, while now
 317    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 318
 319    If the gdb user does a 'continue' after the 'attach', gdb passes
 320    the global variable stop_signal (which stores the signal from the
 321    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 322    problematic, because the kernel doesn't ignore such SIGSTOP
 323    now. I.e. it is reported back to gdb, which in turn presents it
 324    back to the user.
 325
 326    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 327    gdb to clear the value of stop_signal after the attach, so that it
 328    is not passed back down to the kernel.  */
 329
 330 enum stop_kind
 331   {
 332     NO_STOP_QUIETLY = 0,
 333     STOP_QUIETLY,
 334     STOP_QUIETLY_REMOTE,
 335     STOP_QUIETLY_NO_SIGSTOP
 336   };
 337
 338 /* Reverse execution.  */
 339 enum exec_direction_kind
 340   {
 341     EXEC_FORWARD,
 342     EXEC_REVERSE,
 343     EXEC_ERROR
 344   };
 345
 346 extern enum exec_direction_kind execution_direction;
 347
 348 /* Save register contents here when executing a "finish" command or are
 349    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 350    Thus this contains the return value from the called function (assuming
 351    values are returned in a register).  */
 352
 353 extern struct regcache *stop_registers;
 354
 355 /* True if we are debugging displaced stepping.  */
 356 extern int debug_displaced;
 357
 358 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 359 void displaced_step_dump_bytes (struct ui_file *file,
 360                                 const gdb_byte *buf, size_t len);
 361
 362 \f
 363 /* Possible values for gdbarch_call_dummy_location.  */
 364 #define ON_STACK 1
 365 #define AT_ENTRY_POINT 4
 366 #define AT_SYMBOL 5
 367
 368 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 369    will attempts to start up the debugee under a shell.
 370    This is in order for argument-expansion to occur. E.g.,
 371    (gdb) run *
 372    The "*" gets expanded by the shell into a list of files.
 373    While this is a nice feature, it turns out to interact badly
 374    with some of the catch-fork/catch-exec features we have added.
 375    In particular, if the shell does any fork/exec's before
 376    the exec of the target program, that can confuse GDB.
 377    To disable this feature, set STARTUP_WITH_SHELL to 0.
 378    To enable this feature, set STARTUP_WITH_SHELL to 1.
 379    The catch-exec traps expected during start-up will
 380    be 1 if target is not started up with a shell, 2 if it is.
 381    - RT
 382    If you disable this, you need to decrement
 383    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 384 #define STARTUP_WITH_SHELL 1
 385 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 386 #define START_INFERIOR_TRAPS_EXPECTED   2
 387 #endif
 388
 389 struct private_inferior;
 390
 391 /* GDB represents the state of each program execution with an object
 392    called an inferior.  An inferior typically corresponds to a process
 393    but is more general and applies also to targets that do not have a
 394    notion of processes.  Each run of an executable creates a new
 395    inferior, as does each attachment to an existing process.
 396    Inferiors have unique internal identifiers that are different from
 397    target process ids.  Each inferior may in turn have multiple
 398    threads running in it.  */
 399
 400 struct inferior
 401 {
 402   /* Pointer to next inferior in singly-linked list of inferiors.  */
 403   struct inferior *next;
 404
 405   /* Convenient handle (GDB inferior id).  Unique across all
 406      inferiors.  */
 407   int num;
 408
 409   /* Actual target inferior id, usually, a process id.  This matches
 410      the ptid_t.pid member of threads of this inferior.  */
 411   int pid;
 412
 413   /* See the definition of stop_kind above.  */
 414   enum stop_kind stop_soon;
 415
 416   /* Nonzero if this child process was attached rather than
 417      forked.  */
 418   int attach_flag;
 419
 420   /* What is left to do for an execution command after any thread of
 421      this inferior stops.  For continuations associated with a
 422      specific thread, see `struct thread_info'.  */
 423   struct continuation *continuations;
 424
 425   /* Private data used by the target vector implementation.  */
 426   struct private_inferior *private;
 427 };
 428
 429 /* Create an empty inferior list, or empty the existing one.  */
 430 extern void init_inferior_list (void);
 431
 432 /* Add an inferior to the inferior list, print a message that a new
 433    inferior is found, and return the pointer to the new inferior.
 434    Caller may use this pointer to initialize the private inferior
 435    data.  */
 436 extern struct inferior *add_inferior (int pid);
 437
 438 /* Same as add_inferior, but don't print new inferior notifications to
 439    the CLI.  */
 440 extern struct inferior *add_inferior_silent (int pid);
 441
 442 /* Delete an existing inferior list entry, due to inferior exit.  */
 443 extern void delete_inferior (int pid);
 444
 445 /* Same as delete_inferior, but don't print new inferior notifications
 446    to the CLI.  */
 447 extern void delete_inferior_silent (int pid);
 448
 449 /* Delete an existing inferior list entry, due to inferior detaching.  */
 450 extern void detach_inferior (int pid);
 451
 452 /* Get rid of all inferiors.  */
 453 extern void discard_all_inferiors (void);
 454
 455 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 456    into a "pid" (which may be overloaded with extra inferior information).  */
 457 extern int gdb_inferior_id_to_pid (int);
 458
 459 /* Translate a target 'pid' into the integer inferior id (GDB's
 460    homegrown id, not the system's).  */
 461 extern int pid_to_gdb_inferior_id (int pid);
 462
 463 /* Boolean test for an already-known pid.  */
 464 extern int in_inferior_list (int pid);
 465
 466 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 467    not the system's).  */
 468 extern int valid_gdb_inferior_id (int num);
 469
 470 /* Search function to lookup a inferior by target 'pid'.  */
 471 extern struct inferior *find_inferior_pid (int pid);
 472
 473 /* Inferior iterator function.
 474
 475    Calls a callback function once for each inferior, so long as the
 476    callback function returns false.  If the callback function returns
 477    true, the iteration will end and the current inferior will be
 478    returned.  This can be useful for implementing a search for a
 479    inferior with arbitrary attributes, or for applying some operation
 480    to every inferior.
 481
 482    It is safe to delete the iterated inferior from the callback.  */
 483 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 484                                                          void *),
 485                                                 void *);
 486
 487 /* Prints the list of inferiors and their details on UIOUT.
 488
 489    If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior
 490    that should be printed.  Otherwise, all inferiors are printed.  */
 491 extern void print_inferior (struct ui_out *uiout, int requested_inferior);
 492
 493 /* Returns true if the inferior list is not empty.  */
 494 extern int have_inferiors (void);
 495
 496 /* Return a pointer to the current inferior.  It is an error to call
 497    this if there is no current inferior.  */
 498 extern struct inferior *current_inferior (void);
 499
 500 #endif /* !defined (INFERIOR_H) */