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