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