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