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
   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
  33 /* For bpstat.  */
  34 #include "breakpoint.h"
  35
  36 /* For enum target_signal.  */
  37 #include "target.h"
  38
  39 /* For struct frame_id.  */
  40 #include "frame.h"
  41
  42 /* Structure in which to save the status of the inferior.  Create/Save
  43    through "save_inferior_status", restore through
  44    "restore_inferior_status".
  45
  46    This pair of routines should be called around any transfer of
  47    control to the inferior which you don't want showing up in your
  48    control variables.  */
  49
  50 struct inferior_status;
  51
  52 extern struct inferior_status *save_inferior_status (int);
  53
  54 extern void restore_inferior_status (struct inferior_status *);
  55
  56 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
  57
  58 extern void discard_inferior_status (struct inferior_status *);
  59
  60 extern void write_inferior_status_register (struct inferior_status
  61                                             *inf_status, int regno,
  62                                             LONGEST val);
  63
  64 /* The -1 ptid, often used to indicate either an error condition
  65    or a "don't care" condition, i.e, "run all threads."  */
  66 extern ptid_t minus_one_ptid;
  67
  68 /* The null or zero ptid, often used to indicate no process. */
  69 extern ptid_t null_ptid;
  70
  71 /* Attempt to find and return an existing ptid with the given PID, LWP,
  72    and TID components.  If none exists, create a new one and return
  73    that.  */
  74 ptid_t ptid_build (int pid, long lwp, long tid);
  75
  76 /* Find/Create a ptid from just a pid. */
  77 ptid_t pid_to_ptid (int pid);
  78
  79 /* Fetch the pid (process id) component from a ptid. */
  80 int ptid_get_pid (ptid_t ptid);
  81
  82 /* Fetch the lwp (lightweight process) component from a ptid. */
  83 long ptid_get_lwp (ptid_t ptid);
  84
  85 /* Fetch the tid (thread id) component from a ptid. */
  86 long ptid_get_tid (ptid_t ptid);
  87
  88 /* Compare two ptids to see if they are equal */
  89 extern int ptid_equal (ptid_t p1, ptid_t p2);
  90
  91 /* Save value of inferior_ptid so that it may be restored by
  92    a later call to do_cleanups().  Returns the struct cleanup
  93    pointer needed for later doing the cleanup.  */
  94 extern struct cleanup * save_inferior_ptid (void);
  95
  96 extern void set_sigint_trap (void);
  97
  98 extern void clear_sigint_trap (void);
  99
 100 extern void set_sigio_trap (void);
 101
 102 extern void clear_sigio_trap (void);
 103
 104 /* Set/get file name for default use for standard in/out in the inferior.  */
 105
 106 extern void set_inferior_io_terminal (const char *terminal_name);
 107 extern const char *get_inferior_io_terminal (void);
 108
 109 /* Collected pid, tid, etc. of the debugged inferior.  When there's
 110    no inferior, PIDGET (inferior_ptid) will be 0. */
 111
 112 extern ptid_t inferior_ptid;
 113
 114 /* Are we simulating synchronous execution? This is used in async gdb
 115    to implement the 'run', 'continue' etc commands, which will not
 116    redisplay the prompt until the execution is actually over. */
 117 extern int sync_execution;
 118
 119 /* Some targets (stupidly) report more than one exec event per actual
 120    call to an event() system call.  If only the last such exec event
 121    need actually be noticed and responded to by the debugger (i.e.,
 122    be reported to the user), then this is the number of "leading"
 123    exec events which should be ignored.
 124  */
 125 extern int inferior_ignoring_leading_exec_events;
 126
 127 /* Inferior environment. */
 128
 129 extern struct gdb_environ *inferior_environ;
 130
 131 extern void clear_proceed_status (void);
 132
 133 extern void proceed (CORE_ADDR, enum target_signal, int);
 134
 135 extern ptid_t context_switch_to (ptid_t ptid);
 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 void 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 /* Last signal that the inferior received (why it stopped).  */
 283
 284 extern enum target_signal stop_signal;
 285
 286 /* Address at which inferior stopped.  */
 287
 288 extern CORE_ADDR stop_pc;
 289
 290 /* Flag indicating that a command has proceeded the inferior past the
 291    current breakpoint.  */
 292
 293 extern int breakpoint_proceeded;
 294
 295 /* Nonzero if stopped due to a step command.  */
 296
 297 extern int stop_step;
 298
 299 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 300
 301 extern int stop_stack_dummy;
 302
 303 /* Nonzero if program stopped due to a random (unexpected) signal in
 304    inferior process.  */
 305
 306 extern int stopped_by_random_signal;
 307
 308 /* 1 means step over all subroutine calls.
 309    -1 means step over calls to undebuggable functions.  */
 310
 311 enum step_over_calls_kind
 312   {
 313     STEP_OVER_NONE,
 314     STEP_OVER_ALL,
 315     STEP_OVER_UNDEBUGGABLE
 316   };
 317
 318 /* If stepping, nonzero means step count is > 1
 319    so don't print frame next time inferior stops
 320    if it stops due to stepping.  */
 321
 322 extern int step_multi;
 323
 324 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 325    will handle it themselves.  STOP_QUIETLY is used when running in
 326    the shell before the child program has been exec'd and when running
 327    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 328    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 329    except that there is no need to hide a signal.  */
 330
 331 /* It is also used after attach, due to attaching to a process. This
 332    is a bit trickier.  When doing an attach, the kernel stops the
 333    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 334    the handling of SIGSTOP for a ptraced process has changed. Earlier
 335    versions of the kernel would ignore these SIGSTOPs, while now
 336    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 337
 338    If the gdb user does a 'continue' after the 'attach', gdb passes
 339    the global variable stop_signal (which stores the signal from the
 340    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 341    problematic, because the kernel doesn't ignore such SIGSTOP
 342    now. I.e. it is reported back to gdb, which in turn presents it
 343    back to the user.
 344
 345    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 346    gdb to clear the value of stop_signal after the attach, so that it
 347    is not passed back down to the kernel.  */
 348
 349 enum stop_kind
 350   {
 351     NO_STOP_QUIETLY = 0,
 352     STOP_QUIETLY,
 353     STOP_QUIETLY_REMOTE,
 354     STOP_QUIETLY_NO_SIGSTOP
 355   };
 356
 357 extern enum stop_kind stop_soon;
 358
 359 /* Nonzero if proceed is being used for a "finish" command or a similar
 360    situation when stop_registers should be saved.  */
 361
 362 extern int proceed_to_finish;
 363
 364 /* Save register contents here when about to pop a stack dummy frame,
 365    if-and-only-if proceed_to_finish is set.
 366    Thus this contains the return value from the called function (assuming
 367    values are returned in a register).  */
 368
 369 extern struct regcache *stop_registers;
 370
 371 /* Nonzero if the child process in inferior_ptid was attached rather
 372    than forked.  */
 373
 374 extern int attach_flag;
 375
 376 /* True if we are debugging displaced stepping.  */
 377 extern int debug_displaced;
 378
 379 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 380 void displaced_step_dump_bytes (struct ui_file *file,
 381                                 const gdb_byte *buf, size_t len);
 382
 383
 384 /* When set, normal_stop will not call the normal_stop observer.  */
 385 extern int suppress_stop_observer;
 386
 387 /* When set, no calls to target_resumed observer will be made.  */
 388 extern int suppress_resume_observer;
 389
 390 \f
 391 /* Possible values for gdbarch_call_dummy_location.  */
 392 #define ON_STACK 1
 393 #define AT_ENTRY_POINT 4
 394 #define AT_SYMBOL 5
 395
 396 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 397    will attempts to start up the debugee under a shell.
 398    This is in order for argument-expansion to occur. E.g.,
 399    (gdb) run *
 400    The "*" gets expanded by the shell into a list of files.
 401    While this is a nice feature, it turns out to interact badly
 402    with some of the catch-fork/catch-exec features we have added.
 403    In particular, if the shell does any fork/exec's before
 404    the exec of the target program, that can confuse GDB.
 405    To disable this feature, set STARTUP_WITH_SHELL to 0.
 406    To enable this feature, set STARTUP_WITH_SHELL to 1.
 407    The catch-exec traps expected during start-up will
 408    be 1 if target is not started up with a shell, 2 if it is.
 409    - RT
 410    If you disable this, you need to decrement
 411    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 412 #define STARTUP_WITH_SHELL 1
 413 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 414 #define START_INFERIOR_TRAPS_EXPECTED   2
 415 #endif
 416 #endif /* !defined (INFERIOR_H) */