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
   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 2 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, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23    Boston, MA 02110-1301, USA.  */
  24
  25 #if !defined (INFERIOR_H)
  26 #define INFERIOR_H 1
  27
  28 struct target_waitstatus;
  29 struct frame_info;
  30 struct ui_file;
  31 struct type;
  32 struct gdbarch;
  33 struct regcache;
  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 /* Structure in which to save the status of the inferior.  Create/Save
  45    through "save_inferior_status", restore through
  46    "restore_inferior_status".
  47
  48    This pair of routines should be called around any transfer of
  49    control to the inferior which you don't want showing up in your
  50    control variables.  */
  51
  52 struct inferior_status;
  53
  54 extern struct inferior_status *save_inferior_status (int);
  55
  56 extern void restore_inferior_status (struct inferior_status *);
  57
  58 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
  59
  60 extern void discard_inferior_status (struct inferior_status *);
  61
  62 extern void write_inferior_status_register (struct inferior_status
  63                                             *inf_status, int regno,
  64                                             LONGEST val);
  65
  66 /* The -1 ptid, often used to indicate either an error condition
  67    or a "don't care" condition, i.e, "run all threads."  */
  68 extern ptid_t minus_one_ptid;
  69
  70 /* The null or zero ptid, often used to indicate no process. */
  71 extern ptid_t null_ptid;
  72
  73 /* Attempt to find and return an existing ptid with the given PID, LWP,
  74    and TID components.  If none exists, create a new one and return
  75    that.  */
  76 ptid_t ptid_build (int pid, long lwp, long tid);
  77
  78 /* Find/Create a ptid from just a pid. */
  79 ptid_t pid_to_ptid (int pid);
  80
  81 /* Fetch the pid (process id) component from a ptid. */
  82 int ptid_get_pid (ptid_t ptid);
  83
  84 /* Fetch the lwp (lightweight process) component from a ptid. */
  85 long ptid_get_lwp (ptid_t ptid);
  86
  87 /* Fetch the tid (thread id) component from a ptid. */
  88 long ptid_get_tid (ptid_t ptid);
  89
  90 /* Compare two ptids to see if they are equal */
  91 extern int ptid_equal (ptid_t p1, ptid_t p2);
  92
  93 /* Save value of inferior_ptid so that it may be restored by
  94    a later call to do_cleanups().  Returns the struct cleanup
  95    pointer needed for later doing the cleanup.  */
  96 extern struct cleanup * save_inferior_ptid (void);
  97
  98 extern void set_sigint_trap (void);
  99
 100 extern void clear_sigint_trap (void);
 101
 102 extern void set_sigio_trap (void);
 103
 104 extern void clear_sigio_trap (void);
 105
 106 /* Set/get file name for default use for standard in/out in the inferior.  */
 107
 108 extern void set_inferior_io_terminal (const char *terminal_name);
 109 extern const char *get_inferior_io_terminal (void);
 110
 111 /* Collected pid, tid, etc. of the debugged inferior.  When there's
 112    no inferior, PIDGET (inferior_ptid) will be 0. */
 113
 114 extern ptid_t inferior_ptid;
 115
 116 /* Is the inferior running right now, as a result of a 'run&',
 117    'continue&' etc command? This is used in asycn gdb to determine
 118    whether a command that the user enters while the target is running
 119    is allowed or not. */
 120 extern int target_executing;
 121
 122 /* Are we simulating synchronous execution? This is used in async gdb
 123    to implement the 'run', 'continue' etc commands, which will not
 124    redisplay the prompt until the execution is actually over. */
 125 extern int sync_execution;
 126
 127 /* This is only valid when inferior_ptid is non-zero.
 128
 129    If this is 0, then exec events should be noticed and responded to
 130    by the debugger (i.e., be reported to the user).
 131
 132    If this is > 0, then that many subsequent exec events should be
 133    ignored (i.e., not be reported to the user).
 134  */
 135 extern int inferior_ignoring_startup_exec_events;
 136
 137 /* This is only valid when inferior_ignoring_startup_exec_events is
 138    zero.
 139
 140    Some targets (stupidly) report more than one exec event per actual
 141    call to an event() system call.  If only the last such exec event
 142    need actually be noticed and responded to by the debugger (i.e.,
 143    be reported to the user), then this is the number of "leading"
 144    exec events which should be ignored.
 145  */
 146 extern int inferior_ignoring_leading_exec_events;
 147
 148 /* Inferior environment. */
 149
 150 extern struct gdb_environ *inferior_environ;
 151
 152 extern void clear_proceed_status (void);
 153
 154 extern void proceed (CORE_ADDR, enum target_signal, int);
 155
 156 /* When set, stop the 'step' command if we enter a function which has
 157    no line number information.  The normal behavior is that we step
 158    over such function.  */
 159 extern int step_stop_if_no_debug;
 160
 161 extern void generic_mourn_inferior (void);
 162
 163 extern void terminal_save_ours (void);
 164
 165 extern void terminal_ours (void);
 166
 167 extern CORE_ADDR read_pc (void);
 168
 169 extern CORE_ADDR read_pc_pid (ptid_t);
 170
 171 extern void write_pc (CORE_ADDR);
 172
 173 extern void write_pc_pid (CORE_ADDR, ptid_t);
 174
 175 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
 176                                               const gdb_byte *buf);
 177 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
 178                                          CORE_ADDR addr);
 179 extern CORE_ADDR signed_pointer_to_address (struct type *type,
 180                                             const gdb_byte *buf);
 181 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
 182                                        CORE_ADDR addr);
 183
 184 extern void wait_for_inferior (void);
 185
 186 extern void fetch_inferior_event (void *);
 187
 188 extern void init_wait_for_inferior (void);
 189
 190 extern void close_exec_file (void);
 191
 192 extern void reopen_exec_file (void);
 193
 194 /* The `resume' routine should only be called in special circumstances.
 195    Normally, use `proceed', which handles a lot of bookkeeping.  */
 196
 197 extern void resume (int, enum target_signal);
 198
 199 /* From misc files */
 200
 201 extern void default_print_registers_info (struct gdbarch *gdbarch,
 202                                           struct ui_file *file,
 203                                           struct frame_info *frame,
 204                                           int regnum, int all);
 205
 206 extern void child_terminal_info (char *, int);
 207
 208 extern void term_info (char *, int);
 209
 210 extern void terminal_ours_for_output (void);
 211
 212 extern void terminal_inferior (void);
 213
 214 extern void terminal_init_inferior (void);
 215
 216 extern void terminal_init_inferior_with_pgrp (int pgrp);
 217
 218 /* From procfs.c */
 219
 220 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 221
 222 extern ptid_t procfs_first_available (void);
 223
 224 /* From fork-child.c */
 225
 226 extern void fork_inferior (char *, char *, char **,
 227                            void (*)(void),
 228                            void (*)(int), void (*)(void), char *);
 229
 230
 231 extern void startup_inferior (int);
 232
 233 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
 234
 235 /* From inflow.c */
 236
 237 extern void new_tty_prefork (const char *);
 238
 239 extern int gdb_has_a_terminal (void);
 240
 241 /* From infrun.c */
 242
 243 extern void start_remote (int from_tty);
 244
 245 extern void normal_stop (void);
 246
 247 extern int signal_stop_state (int);
 248
 249 extern int signal_print_state (int);
 250
 251 extern int signal_pass_state (int);
 252
 253 extern int signal_stop_update (int, int);
 254
 255 extern int signal_print_update (int, int);
 256
 257 extern int signal_pass_update (int, int);
 258
 259 extern void get_last_target_status(ptid_t *ptid,
 260                                    struct target_waitstatus *status);
 261
 262 extern void follow_inferior_reset_breakpoints (void);
 263
 264 /* From infcmd.c */
 265
 266 extern void tty_command (char *, int);
 267
 268 extern void post_create_inferior (struct target_ops *, int);
 269
 270 extern void attach_command (char *, int);
 271
 272 extern char *get_inferior_args (void);
 273
 274 extern char *set_inferior_args (char *);
 275
 276 extern void set_inferior_args_vector (int, char **);
 277
 278 extern void registers_info (char *, int);
 279
 280 extern void nexti_command (char *, int);
 281
 282 extern void stepi_command (char *, int);
 283
 284 extern void continue_command (char *, int);
 285
 286 extern void interrupt_target_command (char *args, int from_tty);
 287
 288 /* Last signal that the inferior received (why it stopped).  */
 289
 290 extern enum target_signal stop_signal;
 291
 292 /* Address at which inferior stopped.  */
 293
 294 extern CORE_ADDR stop_pc;
 295
 296 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 297
 298 extern bpstat stop_bpstat;
 299
 300 /* Flag indicating that a command has proceeded the inferior past the
 301    current breakpoint.  */
 302
 303 extern int breakpoint_proceeded;
 304
 305 /* Nonzero if stopped due to a step command.  */
 306
 307 extern int stop_step;
 308
 309 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 310
 311 extern int stop_stack_dummy;
 312
 313 /* Nonzero if program stopped due to a random (unexpected) signal in
 314    inferior process.  */
 315
 316 extern int stopped_by_random_signal;
 317
 318 /* Range to single step within.
 319    If this is nonzero, respond to a single-step signal
 320    by continuing to step if the pc is in this range.
 321
 322    If step_range_start and step_range_end are both 1, it means to step for
 323    a single instruction (FIXME: it might clean up wait_for_inferior in a
 324    minor way if this were changed to the address of the instruction and
 325    that address plus one.  But maybe not.).  */
 326
 327 extern CORE_ADDR step_range_start;      /* Inclusive */
 328 extern CORE_ADDR step_range_end;        /* Exclusive */
 329
 330 /* Stack frame address as of when stepping command was issued.
 331    This is how we know when we step into a subroutine call,
 332    and how to set the frame for the breakpoint used to step out.  */
 333
 334 extern struct frame_id step_frame_id;
 335
 336 /* 1 means step over all subroutine calls.
 337    -1 means step over calls to undebuggable functions.  */
 338
 339 enum step_over_calls_kind
 340   {
 341     STEP_OVER_NONE,
 342     STEP_OVER_ALL,
 343     STEP_OVER_UNDEBUGGABLE
 344   };
 345
 346 extern enum step_over_calls_kind step_over_calls;
 347
 348 /* If stepping, nonzero means step count is > 1
 349    so don't print frame next time inferior stops
 350    if it stops due to stepping.  */
 351
 352 extern int step_multi;
 353
 354 /* Nonzero means expecting a trap and caller will handle it
 355    themselves.  It is used when running in the shell before the child
 356    program has been exec'd; and when running some kinds of remote
 357    stuff (FIXME?).  */
 358
 359 /* It is also used after attach, due to attaching to a process. This
 360    is a bit trickier.  When doing an attach, the kernel stops the
 361    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 362    the handling of SIGSTOP for a ptraced process has changed. Earlier
 363    versions of the kernel would ignore these SIGSTOPs, while now
 364    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 365
 366    If the gdb user does a 'continue' after the 'attach', gdb passes
 367    the global variable stop_signal (which stores the signal from the
 368    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 369    problematic, because the kernel doesn't ignore such SIGSTOP
 370    now. I.e. it is reported back to gdb, which in turn presents it
 371    back to the user.
 372
 373    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 374    gdb to clear the value of stop_signal after the attach, so that it
 375    is not passed back down to the kernel.  */
 376
 377 enum stop_kind
 378   {
 379     NO_STOP_QUIETLY = 0,
 380     STOP_QUIETLY,
 381     STOP_QUIETLY_NO_SIGSTOP
 382   };
 383
 384 extern enum stop_kind stop_soon;
 385
 386 /* Nonzero if proceed is being used for a "finish" command or a similar
 387    situation when stop_registers should be saved.  */
 388
 389 extern int proceed_to_finish;
 390
 391 /* Save register contents here when about to pop a stack dummy frame,
 392    if-and-only-if proceed_to_finish is set.
 393    Thus this contains the return value from the called function (assuming
 394    values are returned in a register).  */
 395
 396 extern struct regcache *stop_registers;
 397
 398 /* Nonzero if the child process in inferior_ptid was attached rather
 399    than forked.  */
 400
 401 extern int attach_flag;
 402 \f
 403 /* Possible values for gdbarch_call_dummy_location.  */
 404 #define ON_STACK 1
 405 #define AT_ENTRY_POINT 4
 406 #define AT_SYMBOL 5
 407
 408 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 409    will attempts to start up the debugee under a shell.
 410    This is in order for argument-expansion to occur. E.g.,
 411    (gdb) run *
 412    The "*" gets expanded by the shell into a list of files.
 413    While this is a nice feature, it turns out to interact badly
 414    with some of the catch-fork/catch-exec features we have added.
 415    In particular, if the shell does any fork/exec's before
 416    the exec of the target program, that can confuse GDB.
 417    To disable this feature, set STARTUP_WITH_SHELL to 0.
 418    To enable this feature, set STARTUP_WITH_SHELL to 1.
 419    The catch-exec traps expected during start-up will
 420    be 1 if target is not started up with a shell, 2 if it is.
 421    - RT
 422    If you disable this, you need to decrement
 423    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 424 #define STARTUP_WITH_SHELL 1
 425 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 426 #define START_INFERIOR_TRAPS_EXPECTED   2
 427 #endif
 428 #endif /* !defined (INFERIOR_H) */