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 CORE_ADDR generic_target_read_pc (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 generic_target_read_sp (void);
 182
 183 extern void generic_target_write_sp (CORE_ADDR);
 184
 185 extern CORE_ADDR deprecated_read_fp (void);
 186
 187 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, const void *buf);
 188
 189 extern void unsigned_address_to_pointer (struct type *type, void *buf,
 190                                          CORE_ADDR addr);
 191 extern CORE_ADDR signed_pointer_to_address (struct type *type,
 192                                             const void *buf);
 193 extern void address_to_signed_pointer (struct type *type, void *buf,
 194                                        CORE_ADDR addr);
 195
 196 extern void wait_for_inferior (void);
 197
 198 extern void fetch_inferior_event (void *);
 199
 200 extern void init_wait_for_inferior (void);
 201
 202 extern void close_exec_file (void);
 203
 204 extern void reopen_exec_file (void);
 205
 206 /* The `resume' routine should only be called in special circumstances.
 207    Normally, use `proceed', which handles a lot of bookkeeping.  */
 208
 209 extern void resume (int, enum target_signal);
 210
 211 /* From misc files */
 212
 213 extern void default_print_registers_info (struct gdbarch *gdbarch,
 214                                           struct ui_file *file,
 215                                           struct frame_info *frame,
 216                                           int regnum, int all);
 217
 218 extern void store_inferior_registers (int);
 219
 220 extern void fetch_inferior_registers (int);
 221
 222 extern void solib_create_inferior_hook (void);
 223
 224 extern void child_terminal_info (char *, int);
 225
 226 extern void term_info (char *, int);
 227
 228 extern void terminal_ours_for_output (void);
 229
 230 extern void terminal_inferior (void);
 231
 232 extern void terminal_init_inferior (void);
 233
 234 extern void terminal_init_inferior_with_pgrp (int pgrp);
 235
 236 /* From infptrace.c or infttrace.c */
 237
 238 extern int attach (int);
 239
 240 extern void detach (int);
 241
 242 /* PTRACE method of waiting for inferior process.  */
 243 int ptrace_wait (ptid_t, int *);
 244
 245 extern void child_resume (ptid_t, int, enum target_signal);
 246
 247 #ifndef PTRACE_ARG3_TYPE
 248 #define PTRACE_ARG3_TYPE int    /* Correct definition for most systems. */
 249 #endif
 250
 251 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
 252
 253 extern void pre_fork_inferior (void);
 254
 255 /* From procfs.c */
 256
 257 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 258
 259 extern ptid_t procfs_first_available (void);
 260
 261 /* From fork-child.c */
 262
 263 extern void fork_inferior (char *, char *, char **,
 264                            void (*)(void),
 265                            void (*)(int), void (*)(void), char *);
 266
 267
 268 extern void startup_inferior (int);
 269
 270 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
 271
 272 /* From inflow.c */
 273
 274 extern void new_tty_prefork (char *);
 275
 276 extern int gdb_has_a_terminal (void);
 277
 278 /* From infrun.c */
 279
 280 extern void start_remote (void);
 281
 282 extern void normal_stop (void);
 283
 284 extern int signal_stop_state (int);
 285
 286 extern int signal_print_state (int);
 287
 288 extern int signal_pass_state (int);
 289
 290 extern int signal_stop_update (int, int);
 291
 292 extern int signal_print_update (int, int);
 293
 294 extern int signal_pass_update (int, int);
 295
 296 extern void get_last_target_status(ptid_t *ptid,
 297                                    struct target_waitstatus *status);
 298
 299 extern void follow_inferior_reset_breakpoints (void);
 300
 301 /* From infcmd.c */
 302
 303 extern void tty_command (char *, int);
 304
 305 extern void attach_command (char *, int);
 306
 307 extern char *get_inferior_args (void);
 308
 309 extern char *set_inferior_args (char *);
 310
 311 extern void set_inferior_args_vector (int, char **);
 312
 313 extern void registers_info (char *, int);
 314
 315 extern void nexti_command (char *, int);
 316
 317 extern void stepi_command (char *, int);
 318
 319 extern void continue_command (char *, int);
 320
 321 extern void interrupt_target_command (char *args, int from_tty);
 322
 323 /* Last signal that the inferior received (why it stopped).  */
 324
 325 extern enum target_signal stop_signal;
 326
 327 /* Address at which inferior stopped.  */
 328
 329 extern CORE_ADDR stop_pc;
 330
 331 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 332
 333 extern bpstat stop_bpstat;
 334
 335 /* Flag indicating that a command has proceeded the inferior past the
 336    current breakpoint.  */
 337
 338 extern int breakpoint_proceeded;
 339
 340 /* Nonzero if stopped due to a step command.  */
 341
 342 extern int stop_step;
 343
 344 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 345
 346 extern int stop_stack_dummy;
 347
 348 /* Nonzero if program stopped due to a random (unexpected) signal in
 349    inferior process.  */
 350
 351 extern int stopped_by_random_signal;
 352
 353 /* Range to single step within.
 354    If this is nonzero, respond to a single-step signal
 355    by continuing to step if the pc is in this range.
 356
 357    If step_range_start and step_range_end are both 1, it means to step for
 358    a single instruction (FIXME: it might clean up wait_for_inferior in a
 359    minor way if this were changed to the address of the instruction and
 360    that address plus one.  But maybe not.).  */
 361
 362 extern CORE_ADDR step_range_start;      /* Inclusive */
 363 extern CORE_ADDR step_range_end;        /* Exclusive */
 364
 365 /* Stack frame address as of when stepping command was issued.
 366    This is how we know when we step into a subroutine call,
 367    and how to set the frame for the breakpoint used to step out.  */
 368
 369 extern struct frame_id step_frame_id;
 370
 371 /* Our notion of the current stack pointer.  */
 372
 373 extern CORE_ADDR step_sp;
 374
 375 /* 1 means step over all subroutine calls.
 376    -1 means step over calls to undebuggable functions.  */
 377
 378 enum step_over_calls_kind
 379   {
 380     STEP_OVER_NONE,
 381     STEP_OVER_ALL,
 382     STEP_OVER_UNDEBUGGABLE
 383   };
 384
 385 extern enum step_over_calls_kind step_over_calls;
 386
 387 /* If stepping, nonzero means step count is > 1
 388    so don't print frame next time inferior stops
 389    if it stops due to stepping.  */
 390
 391 extern int step_multi;
 392
 393 /* Nonzero means expecting a trap and caller will handle it
 394    themselves.  It is used when running in the shell before the child
 395    program has been exec'd; and when running some kinds of remote
 396    stuff (FIXME?).  */
 397
 398 /* It is also used after attach, due to attaching to a process. This
 399    is a bit trickier.  When doing an attach, the kernel stops the
 400    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 401    the handling of SIGSTOP for a ptraced process has changed. Earlier
 402    versions of the kernel would ignore these SIGSTOPs, while now
 403    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 404
 405    If the gdb user does a 'continue' after the 'attach', gdb passes
 406    the global variable stop_signal (which stores the signal from the
 407    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 408    problematic, because the kernel doesn't ignore such SIGSTOP
 409    now. I.e. it is reported back to gdb, which in turn presents it
 410    back to the user.
 411
 412    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 413    gdb to clear the value of stop_signal after the attach, so that it
 414    is not passed back down to the kernel.  */
 415
 416 enum stop_kind
 417   {
 418     NO_STOP_QUIETLY = 0,
 419     STOP_QUIETLY,
 420     STOP_QUIETLY_NO_SIGSTOP
 421   };
 422
 423 extern enum stop_kind stop_soon;
 424
 425 /* Nonzero if proceed is being used for a "finish" command or a similar
 426    situation when stop_registers should be saved.  */
 427
 428 extern int proceed_to_finish;
 429
 430 /* Save register contents here when about to pop a stack dummy frame,
 431    if-and-only-if proceed_to_finish is set.
 432    Thus this contains the return value from the called function (assuming
 433    values are returned in a register).  */
 434
 435 extern struct regcache *stop_registers;
 436
 437 /* Nonzero if the child process in inferior_ptid was attached rather
 438    than forked.  */
 439
 440 extern int attach_flag;
 441 \f
 442 /* Possible values for CALL_DUMMY_LOCATION.  */
 443 #define ON_STACK 1
 444 #define AT_ENTRY_POINT 4
 445
 446 /* FIXME: cagney/2000-04-17: gdbarch should manage this.  The default
 447    shouldn't be necessary. */
 448
 449 #if !defined PUSH_DUMMY_FRAME
 450 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
 451 #endif
 452
 453 #if !defined STORE_STRUCT_RETURN
 454 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
 455 #endif
 456
 457
 458 /* Are we in a call dummy? */
 459
 460 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
 461    dummy frames, and use generic_pc_in_call_dummy().  The generic
 462    version should be able to handle all cases since that code works by
 463    saving the address of the dummy's breakpoint (where ever it is).  */
 464
 465 extern int deprecated_pc_in_call_dummy_on_stack (CORE_ADDR pc,
 466                                                  CORE_ADDR sp,
 467                                                  CORE_ADDR frame_address);
 468
 469 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
 470    dummy frames, and use generic_pc_in_call_dummy().  The generic
 471    version should be able to handle all cases since that code works by
 472    saving the address of the dummy's breakpoint (where ever it is).  */
 473
 474 extern int deprecated_pc_in_call_dummy_at_entry_point (CORE_ADDR pc,
 475                                                        CORE_ADDR sp,
 476                                                        CORE_ADDR frame_address);
 477
 478 /* It's often not enough for our clients to know whether the PC is merely
 479    somewhere within the call dummy.  They may need to know whether the
 480    call dummy has actually completed.  (For example, wait_for_inferior
 481    wants to know when it should truly stop because the call dummy has
 482    completed.  If we're single-stepping because of slow watchpoints,
 483    then we may find ourselves stopped at the entry of the call dummy,
 484    and want to continue stepping until we reach the end.)
 485
 486    Note that this macro is intended for targets (like HP-UX) which
 487    require more than a single breakpoint in their call dummies, and
 488    therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
 489
 490    If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
 491    default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
 492    Else, a target may wish to supply an implementation that works in
 493    the presense of multiple breakpoints in its call dummy.
 494  */
 495 #if !defined(CALL_DUMMY_HAS_COMPLETED)
 496 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
 497   DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
 498 #endif
 499
 500 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 501    will attempts to start up the debugee under a shell.
 502    This is in order for argument-expansion to occur. E.g.,
 503    (gdb) run *
 504    The "*" gets expanded by the shell into a list of files.
 505    While this is a nice feature, it turns out to interact badly
 506    with some of the catch-fork/catch-exec features we have added.
 507    In particular, if the shell does any fork/exec's before
 508    the exec of the target program, that can confuse GDB.
 509    To disable this feature, set STARTUP_WITH_SHELL to 0.
 510    To enable this feature, set STARTUP_WITH_SHELL to 1.
 511    The catch-exec traps expected during start-up will
 512    be 1 if target is not started up with a shell, 2 if it is.
 513    - RT
 514    If you disable this, you need to decrement
 515    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 516 #define STARTUP_WITH_SHELL 1
 517 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 518 #define START_INFERIOR_TRAPS_EXPECTED   2
 519 #endif
 520 #endif /* !defined (INFERIOR_H) */