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