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