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