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 Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330,
  22    Boston, MA 02111-1307, USA.  */
  23
  24 #if !defined (INFERIOR_H)
  25 #define INFERIOR_H 1
  26
  27 struct target_waitstatus;
  28 struct frame_info;
  29 struct ui_file;
  30 struct type;
  31 struct gdbarch;
  32 struct regcache;
  33
  34 /* For bpstat.  */
  35 #include "breakpoint.h"
  36
  37 /* For enum target_signal.  */
  38 #include "target.h"
  39
  40 /* For struct frame_id.  */
  41 #include "frame.h"
  42
  43 /* Structure in which to save the status of the inferior.  Create/Save
  44    through "save_inferior_status", restore through
  45    "restore_inferior_status".
  46
  47    This pair of routines should be called around any transfer of
  48    control to the inferior which you don't want showing up in your
  49    control variables.  */
  50
  51 struct inferior_status;
  52
  53 extern struct inferior_status *save_inferior_status (int);
  54
  55 extern void restore_inferior_status (struct inferior_status *);
  56
  57 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
  58
  59 extern void discard_inferior_status (struct inferior_status *);
  60
  61 extern void write_inferior_status_register (struct inferior_status
  62                                             *inf_status, int regno,
  63                                             LONGEST val);
  64
  65 /* The -1 ptid, often used to indicate either an error condition
  66    or a "don't care" condition, i.e, "run all threads."  */
  67 extern ptid_t minus_one_ptid;
  68
  69 /* The null or zero ptid, often used to indicate no process. */
  70 extern ptid_t null_ptid;
  71
  72 /* Attempt to find and return an existing ptid with the given PID, LWP,
  73    and TID components.  If none exists, create a new one and return
  74    that.  */
  75 ptid_t ptid_build (int pid, long lwp, long tid);
  76
  77 /* Find/Create a ptid from just a pid. */
  78 ptid_t pid_to_ptid (int pid);
  79
  80 /* Fetch the pid (process id) component from a ptid. */
  81 int ptid_get_pid (ptid_t ptid);
  82
  83 /* Fetch the lwp (lightweight process) component from a ptid. */
  84 long ptid_get_lwp (ptid_t ptid);
  85
  86 /* Fetch the tid (thread id) component from a ptid. */
  87 long ptid_get_tid (ptid_t ptid);
  88
  89 /* Compare two ptids to see if they are equal */
  90 extern int ptid_equal (ptid_t p1, ptid_t p2);
  91
  92 /* Save value of inferior_ptid so that it may be restored by
  93    a later call to do_cleanups().  Returns the struct cleanup
  94    pointer needed for later doing the cleanup.  */
  95 extern struct cleanup * save_inferior_ptid (void);
  96
  97 extern void set_sigint_trap (void);
  98
  99 extern void clear_sigint_trap (void);
 100
 101 extern void set_sigio_trap (void);
 102
 103 extern void clear_sigio_trap (void);
 104
 105 /* File name for default use for standard in/out in the inferior.  */
 106
 107 extern char *inferior_io_terminal;
 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 /* This is only valid when inferior_ptid is non-zero.
 126
 127    If this is 0, then exec events should be noticed and responded to
 128    by the debugger (i.e., be reported to the user).
 129
 130    If this is > 0, then that many subsequent exec events should be
 131    ignored (i.e., not be reported to the user).
 132  */
 133 extern int inferior_ignoring_startup_exec_events;
 134
 135 /* This is only valid when inferior_ignoring_startup_exec_events is
 136    zero.
 137
 138    Some targets (stupidly) report more than one exec event per actual
 139    call to an event() system call.  If only the last such exec event
 140    need actually be noticed and responded to by the debugger (i.e.,
 141    be reported to the user), then this is the number of "leading"
 142    exec events which should be ignored.
 143  */
 144 extern int inferior_ignoring_leading_exec_events;
 145
 146 /* Inferior environment. */
 147
 148 extern struct environ *inferior_environ;
 149
 150 extern void clear_proceed_status (void);
 151
 152 extern void proceed (CORE_ADDR, enum target_signal, int);
 153
 154 /* When set, stop the 'step' command if we enter a function which has
 155    no line number information.  The normal behavior is that we step
 156    over such function.  */
 157 extern int step_stop_if_no_debug;
 158
 159 extern void kill_inferior (void);
 160
 161 extern void generic_mourn_inferior (void);
 162
 163 extern void terminal_save_ours (void);
 164
 165 extern void terminal_ours (void);
 166
 167 extern CORE_ADDR read_pc (void);
 168
 169 extern CORE_ADDR read_pc_pid (ptid_t);
 170
 171 extern void write_pc (CORE_ADDR);
 172
 173 extern void write_pc_pid (CORE_ADDR, ptid_t);
 174
 175 extern void generic_target_write_pc (CORE_ADDR, ptid_t);
 176
 177 extern CORE_ADDR read_sp (void);
 178
 179 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, const void *buf);
 180
 181 extern void unsigned_address_to_pointer (struct type *type, void *buf,
 182                                          CORE_ADDR addr);
 183 extern CORE_ADDR signed_pointer_to_address (struct type *type,
 184                                             const void *buf);
 185 extern void address_to_signed_pointer (struct type *type, void *buf,
 186                                        CORE_ADDR addr);
 187
 188 extern void wait_for_inferior (void);
 189
 190 extern void fetch_inferior_event (void *);
 191
 192 extern void init_wait_for_inferior (void);
 193
 194 extern void close_exec_file (void);
 195
 196 extern void reopen_exec_file (void);
 197
 198 /* The `resume' routine should only be called in special circumstances.
 199    Normally, use `proceed', which handles a lot of bookkeeping.  */
 200
 201 extern void resume (int, enum target_signal);
 202
 203 /* From misc files */
 204
 205 extern void default_print_registers_info (struct gdbarch *gdbarch,
 206                                           struct ui_file *file,
 207                                           struct frame_info *frame,
 208                                           int regnum, int all);
 209
 210 extern void store_inferior_registers (int);
 211
 212 extern void fetch_inferior_registers (int);
 213
 214 extern void solib_create_inferior_hook (void);
 215
 216 extern void child_terminal_info (char *, int);
 217
 218 extern void term_info (char *, int);
 219
 220 extern void terminal_ours_for_output (void);
 221
 222 extern void terminal_inferior (void);
 223
 224 extern void terminal_init_inferior (void);
 225
 226 extern void terminal_init_inferior_with_pgrp (int pgrp);
 227
 228 /* From infptrace.c or infttrace.c */
 229
 230 extern int attach (int);
 231
 232 extern void detach (int);
 233
 234 /* PTRACE method of waiting for inferior process.  */
 235 int ptrace_wait (ptid_t, int *);
 236
 237 extern void child_resume (ptid_t, int, enum target_signal);
 238
 239 #ifndef PTRACE_ARG3_TYPE
 240 #define PTRACE_ARG3_TYPE int    /* Correct definition for most systems. */
 241 #endif
 242
 243 extern int call_ptrace (int, int, PTRACE_TYPE_ARG3, int);
 244
 245 extern void pre_fork_inferior (void);
 246
 247 /* From procfs.c */
 248
 249 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 250
 251 extern ptid_t procfs_first_available (void);
 252
 253 /* From fork-child.c */
 254
 255 extern void fork_inferior (char *, char *, char **,
 256                            void (*)(void),
 257                            void (*)(int), void (*)(void), char *);
 258
 259
 260 extern void startup_inferior (int);
 261
 262 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
 263
 264 /* From inflow.c */
 265
 266 extern void new_tty_prefork (char *);
 267
 268 extern int gdb_has_a_terminal (void);
 269
 270 /* From infrun.c */
 271
 272 extern void start_remote (void);
 273
 274 extern void normal_stop (void);
 275
 276 extern int signal_stop_state (int);
 277
 278 extern int signal_print_state (int);
 279
 280 extern int signal_pass_state (int);
 281
 282 extern int signal_stop_update (int, int);
 283
 284 extern int signal_print_update (int, int);
 285
 286 extern int signal_pass_update (int, int);
 287
 288 extern void get_last_target_status(ptid_t *ptid,
 289                                    struct target_waitstatus *status);
 290
 291 extern void follow_inferior_reset_breakpoints (void);
 292
 293 /* From infcmd.c */
 294
 295 extern void tty_command (char *, int);
 296
 297 extern void attach_command (char *, int);
 298
 299 extern char *get_inferior_args (void);
 300
 301 extern char *set_inferior_args (char *);
 302
 303 extern void set_inferior_args_vector (int, char **);
 304
 305 extern void registers_info (char *, int);
 306
 307 extern void nexti_command (char *, int);
 308
 309 extern void stepi_command (char *, int);
 310
 311 extern void continue_command (char *, int);
 312
 313 extern void interrupt_target_command (char *args, int from_tty);
 314
 315 /* Last signal that the inferior received (why it stopped).  */
 316
 317 extern enum target_signal stop_signal;
 318
 319 /* Address at which inferior stopped.  */
 320
 321 extern CORE_ADDR stop_pc;
 322
 323 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 324
 325 extern bpstat stop_bpstat;
 326
 327 /* Flag indicating that a command has proceeded the inferior past the
 328    current breakpoint.  */
 329
 330 extern int breakpoint_proceeded;
 331
 332 /* Nonzero if stopped due to a step command.  */
 333
 334 extern int stop_step;
 335
 336 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 337
 338 extern int stop_stack_dummy;
 339
 340 /* Nonzero if program stopped due to a random (unexpected) signal in
 341    inferior process.  */
 342
 343 extern int stopped_by_random_signal;
 344
 345 /* Range to single step within.
 346    If this is nonzero, respond to a single-step signal
 347    by continuing to step if the pc is in this range.
 348
 349    If step_range_start and step_range_end are both 1, it means to step for
 350    a single instruction (FIXME: it might clean up wait_for_inferior in a
 351    minor way if this were changed to the address of the instruction and
 352    that address plus one.  But maybe not.).  */
 353
 354 extern CORE_ADDR step_range_start;      /* Inclusive */
 355 extern CORE_ADDR step_range_end;        /* Exclusive */
 356
 357 /* Stack frame address as of when stepping command was issued.
 358    This is how we know when we step into a subroutine call,
 359    and how to set the frame for the breakpoint used to step out.  */
 360
 361 extern struct frame_id step_frame_id;
 362
 363 /* 1 means step over all subroutine calls.
 364    -1 means step over calls to undebuggable functions.  */
 365
 366 enum step_over_calls_kind
 367   {
 368     STEP_OVER_NONE,
 369     STEP_OVER_ALL,
 370     STEP_OVER_UNDEBUGGABLE
 371   };
 372
 373 extern enum step_over_calls_kind step_over_calls;
 374
 375 /* If stepping, nonzero means step count is > 1
 376    so don't print frame next time inferior stops
 377    if it stops due to stepping.  */
 378
 379 extern int step_multi;
 380
 381 /* Nonzero means expecting a trap and caller will handle it
 382    themselves.  It is used when running in the shell before the child
 383    program has been exec'd; and when running some kinds of remote
 384    stuff (FIXME?).  */
 385
 386 /* It is also used after attach, due to attaching to a process. This
 387    is a bit trickier.  When doing an attach, the kernel stops the
 388    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 389    the handling of SIGSTOP for a ptraced process has changed. Earlier
 390    versions of the kernel would ignore these SIGSTOPs, while now
 391    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 392
 393    If the gdb user does a 'continue' after the 'attach', gdb passes
 394    the global variable stop_signal (which stores the signal from the
 395    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 396    problematic, because the kernel doesn't ignore such SIGSTOP
 397    now. I.e. it is reported back to gdb, which in turn presents it
 398    back to the user.
 399
 400    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 401    gdb to clear the value of stop_signal after the attach, so that it
 402    is not passed back down to the kernel.  */
 403
 404 enum stop_kind
 405   {
 406     NO_STOP_QUIETLY = 0,
 407     STOP_QUIETLY,
 408     STOP_QUIETLY_NO_SIGSTOP
 409   };
 410
 411 extern enum stop_kind stop_soon;
 412
 413 /* Nonzero if proceed is being used for a "finish" command or a similar
 414    situation when stop_registers should be saved.  */
 415
 416 extern int proceed_to_finish;
 417
 418 /* Save register contents here when about to pop a stack dummy frame,
 419    if-and-only-if proceed_to_finish is set.
 420    Thus this contains the return value from the called function (assuming
 421    values are returned in a register).  */
 422
 423 extern struct regcache *stop_registers;
 424
 425 /* Nonzero if the child process in inferior_ptid was attached rather
 426    than forked.  */
 427
 428 extern int attach_flag;
 429 \f
 430 /* Possible values for CALL_DUMMY_LOCATION.  */
 431 #define ON_STACK 1
 432 #define AT_ENTRY_POINT 4
 433 #define AT_SYMBOL 5
 434
 435 /* FIXME: cagney/2000-04-17: gdbarch should manage this.  The default
 436    shouldn't be necessary. */
 437
 438 #if !defined STORE_STRUCT_RETURN
 439 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
 440 #endif
 441
 442
 443 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 444    will attempts to start up the debugee under a shell.
 445    This is in order for argument-expansion to occur. E.g.,
 446    (gdb) run *
 447    The "*" gets expanded by the shell into a list of files.
 448    While this is a nice feature, it turns out to interact badly
 449    with some of the catch-fork/catch-exec features we have added.
 450    In particular, if the shell does any fork/exec's before
 451    the exec of the target program, that can confuse GDB.
 452    To disable this feature, set STARTUP_WITH_SHELL to 0.
 453    To enable this feature, set STARTUP_WITH_SHELL to 1.
 454    The catch-exec traps expected during start-up will
 455    be 1 if target is not started up with a shell, 2 if it is.
 456    - RT
 457    If you disable this, you need to decrement
 458    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 459 #define STARTUP_WITH_SHELL 1
 460 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 461 #define START_INFERIOR_TRAPS_EXPECTED   2
 462 #endif
 463 #endif /* !defined (INFERIOR_H) */