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