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 /* When set, stop the 'step' command if we enter a function which has
 136    no line number information.  The normal behavior is that we step
 137    over such function.  */
 138 extern int step_stop_if_no_debug;
 139
 140 extern void generic_mourn_inferior (void);
 141
 142 extern void terminal_save_ours (void);
 143
 144 extern void terminal_ours (void);
 145
 146 extern CORE_ADDR read_pc (void);
 147
 148 extern void write_pc (CORE_ADDR);
 149
 150 extern CORE_ADDR unsigned_pointer_to_address (struct type *type,
 151                                               const gdb_byte *buf);
 152 extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf,
 153                                          CORE_ADDR addr);
 154 extern CORE_ADDR signed_pointer_to_address (struct type *type,
 155                                             const gdb_byte *buf);
 156 extern void address_to_signed_pointer (struct type *type, gdb_byte *buf,
 157                                        CORE_ADDR addr);
 158
 159 extern void wait_for_inferior (int treat_exec_as_sigtrap);
 160
 161 extern void fetch_inferior_event (void *);
 162
 163 extern void init_wait_for_inferior (void);
 164
 165 extern void close_exec_file (void);
 166
 167 extern void reopen_exec_file (void);
 168
 169 /* The `resume' routine should only be called in special circumstances.
 170    Normally, use `proceed', which handles a lot of bookkeeping.  */
 171
 172 extern void resume (int, enum target_signal);
 173
 174 /* From misc files */
 175
 176 extern void default_print_registers_info (struct gdbarch *gdbarch,
 177                                           struct ui_file *file,
 178                                           struct frame_info *frame,
 179                                           int regnum, int all);
 180
 181 extern void child_terminal_info (char *, int);
 182
 183 extern void term_info (char *, int);
 184
 185 extern void terminal_ours_for_output (void);
 186
 187 extern void terminal_inferior (void);
 188
 189 extern void terminal_init_inferior (void);
 190
 191 extern void terminal_init_inferior_with_pgrp (int pgrp);
 192
 193 /* From procfs.c */
 194
 195 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 196
 197 extern ptid_t procfs_first_available (void);
 198
 199 /* From fork-child.c */
 200
 201 extern void fork_inferior (char *, char *, char **,
 202                            void (*)(void),
 203                            void (*)(int), void (*)(void), char *);
 204
 205
 206 extern void startup_inferior (int);
 207
 208 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
 209
 210 /* From inflow.c */
 211
 212 extern void new_tty_prefork (const char *);
 213
 214 extern int gdb_has_a_terminal (void);
 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 /* From infcmd.c */
 240
 241 extern void tty_command (char *, int);
 242
 243 extern void post_create_inferior (struct target_ops *, int);
 244
 245 extern void attach_command (char *, int);
 246
 247 extern char *get_inferior_args (void);
 248
 249 extern char *set_inferior_args (char *);
 250
 251 extern void set_inferior_args_vector (int, char **);
 252
 253 extern void registers_info (char *, int);
 254
 255 extern void nexti_command (char *, int);
 256
 257 extern void stepi_command (char *, int);
 258
 259 extern void continue_command (char *, int);
 260
 261 extern void interrupt_target_command (char *args, int from_tty);
 262
 263 /* Last signal that the inferior received (why it stopped).  */
 264
 265 extern enum target_signal stop_signal;
 266
 267 /* Address at which inferior stopped.  */
 268
 269 extern CORE_ADDR stop_pc;
 270
 271 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 272
 273 extern bpstat stop_bpstat;
 274
 275 /* Flag indicating that a command has proceeded the inferior past the
 276    current breakpoint.  */
 277
 278 extern int breakpoint_proceeded;
 279
 280 /* Nonzero if stopped due to a step command.  */
 281
 282 extern int stop_step;
 283
 284 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 285
 286 extern int stop_stack_dummy;
 287
 288 /* Nonzero if program stopped due to a random (unexpected) signal in
 289    inferior process.  */
 290
 291 extern int stopped_by_random_signal;
 292
 293 /* Range to single step within.
 294    If this is nonzero, respond to a single-step signal
 295    by continuing to step if the pc is in this range.
 296
 297    If step_range_start and step_range_end are both 1, it means to step for
 298    a single instruction (FIXME: it might clean up wait_for_inferior in a
 299    minor way if this were changed to the address of the instruction and
 300    that address plus one.  But maybe not.).  */
 301
 302 extern CORE_ADDR step_range_start;      /* Inclusive */
 303 extern CORE_ADDR step_range_end;        /* Exclusive */
 304
 305 /* Stack frame address as of when stepping command was issued.
 306    This is how we know when we step into a subroutine call,
 307    and how to set the frame for the breakpoint used to step out.  */
 308
 309 extern struct frame_id step_frame_id;
 310
 311 /* 1 means step over all subroutine calls.
 312    -1 means step over calls to undebuggable functions.  */
 313
 314 enum step_over_calls_kind
 315   {
 316     STEP_OVER_NONE,
 317     STEP_OVER_ALL,
 318     STEP_OVER_UNDEBUGGABLE
 319   };
 320
 321 extern enum step_over_calls_kind step_over_calls;
 322
 323 /* If stepping, nonzero means step count is > 1
 324    so don't print frame next time inferior stops
 325    if it stops due to stepping.  */
 326
 327 extern int step_multi;
 328
 329 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 330    will handle it themselves.  STOP_QUIETLY is used when running in
 331    the shell before the child program has been exec'd and when running
 332    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 333    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 334    except that there is no need to hide a signal.  */
 335
 336 /* It is also used after attach, due to attaching to a process. This
 337    is a bit trickier.  When doing an attach, the kernel stops the
 338    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 339    the handling of SIGSTOP for a ptraced process has changed. Earlier
 340    versions of the kernel would ignore these SIGSTOPs, while now
 341    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 342
 343    If the gdb user does a 'continue' after the 'attach', gdb passes
 344    the global variable stop_signal (which stores the signal from the
 345    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 346    problematic, because the kernel doesn't ignore such SIGSTOP
 347    now. I.e. it is reported back to gdb, which in turn presents it
 348    back to the user.
 349
 350    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 351    gdb to clear the value of stop_signal after the attach, so that it
 352    is not passed back down to the kernel.  */
 353
 354 enum stop_kind
 355   {
 356     NO_STOP_QUIETLY = 0,
 357     STOP_QUIETLY,
 358     STOP_QUIETLY_REMOTE,
 359     STOP_QUIETLY_NO_SIGSTOP
 360   };
 361
 362 extern enum stop_kind stop_soon;
 363
 364 /* Nonzero if proceed is being used for a "finish" command or a similar
 365    situation when stop_registers should be saved.  */
 366
 367 extern int proceed_to_finish;
 368
 369 /* Save register contents here when about to pop a stack dummy frame,
 370    if-and-only-if proceed_to_finish is set.
 371    Thus this contains the return value from the called function (assuming
 372    values are returned in a register).  */
 373
 374 extern struct regcache *stop_registers;
 375
 376 /* Nonzero if the child process in inferior_ptid was attached rather
 377    than forked.  */
 378
 379 extern int attach_flag;
 380
 381 /* True if we are debugging displaced stepping.  */
 382 extern int debug_displaced;
 383
 384 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 385 void displaced_step_dump_bytes (struct ui_file *file,
 386                                 const gdb_byte *buf, size_t len);
 387
 388
 389 /* When set, normal_stop will not call the normal_stop observer.  */
 390 extern int suppress_stop_observer;
 391
 392 /* When set, no calls to target_resumed observer will be made.  */
 393 extern int suppress_resume_observer;
 394
 395 \f
 396 /* Possible values for gdbarch_call_dummy_location.  */
 397 #define ON_STACK 1
 398 #define AT_ENTRY_POINT 4
 399 #define AT_SYMBOL 5
 400
 401 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 402    will attempts to start up the debugee under a shell.
 403    This is in order for argument-expansion to occur. E.g.,
 404    (gdb) run *
 405    The "*" gets expanded by the shell into a list of files.
 406    While this is a nice feature, it turns out to interact badly
 407    with some of the catch-fork/catch-exec features we have added.
 408    In particular, if the shell does any fork/exec's before
 409    the exec of the target program, that can confuse GDB.
 410    To disable this feature, set STARTUP_WITH_SHELL to 0.
 411    To enable this feature, set STARTUP_WITH_SHELL to 1.
 412    The catch-exec traps expected during start-up will
 413    be 1 if target is not started up with a shell, 2 if it is.
 414    - RT
 415    If you disable this, you need to decrement
 416    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 417 #define STARTUP_WITH_SHELL 1
 418 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 419 #define START_INFERIOR_TRAPS_EXPECTED   2
 420 #endif
 421 #endif /* !defined (INFERIOR_H) */