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    Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
   4    1998, 1999, 2000, 2001 Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place - Suite 330,
  21    Boston, MA 02111-1307, USA.  */
  22
  23 #if !defined (INFERIOR_H)
  24 #define INFERIOR_H 1
  25
  26 /* For bpstat.  */
  27 #include "breakpoint.h"
  28
  29 /* For enum target_signal.  */
  30 #include "target.h"
  31
  32 /* Structure in which to save the status of the inferior.  Create/Save
  33    through "save_inferior_status", restore through
  34    "restore_inferior_status".
  35
  36    This pair of routines should be called around any transfer of
  37    control to the inferior which you don't want showing up in your
  38    control variables.  */
  39
  40 struct inferior_status;
  41
  42 extern struct inferior_status *save_inferior_status (int);
  43
  44 extern void restore_inferior_status (struct inferior_status *);
  45
  46 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
  47
  48 extern void discard_inferior_status (struct inferior_status *);
  49
  50 extern void write_inferior_status_register (struct inferior_status
  51                                             *inf_status, int regno,
  52                                             LONGEST val);
  53
  54 /* This macro gives the number of registers actually in use by the
  55    inferior.  This may be less than the total number of registers,
  56    perhaps depending on the actual CPU in use or program being run.
  57    FIXME: This could be replaced by the new MULTI_ARCH capability.  */
  58
  59 #ifndef ARCH_NUM_REGS
  60 #define ARCH_NUM_REGS NUM_REGS
  61 #endif
  62
  63 extern void set_sigint_trap (void);
  64
  65 extern void clear_sigint_trap (void);
  66
  67 extern void set_sigio_trap (void);
  68
  69 extern void clear_sigio_trap (void);
  70
  71 /* File name for default use for standard in/out in the inferior.  */
  72
  73 extern char *inferior_io_terminal;
  74
  75 /* Pid of our debugged inferior, or 0 if no inferior now.  */
  76
  77 extern int inferior_pid;
  78
  79 /* Is the inferior running right now, as a result of a 'run&',
  80    'continue&' etc command? This is used in asycn gdb to determine
  81    whether a command that the user enters while the target is running
  82    is allowed or not. */
  83 extern int target_executing;
  84
  85 /* Are we simulating synchronous execution? This is used in async gdb
  86    to implement the 'run', 'continue' etc commands, which will not
  87    redisplay the prompt until the execution is actually over. */
  88 extern int sync_execution;
  89
  90 /* This is only valid when inferior_pid is non-zero.
  91
  92    If this is 0, then exec events should be noticed and responded to
  93    by the debugger (i.e., be reported to the user).
  94
  95    If this is > 0, then that many subsequent exec events should be
  96    ignored (i.e., not be reported to the user).
  97  */
  98 extern int inferior_ignoring_startup_exec_events;
  99
 100 /* This is only valid when inferior_ignoring_startup_exec_events is
 101    zero.
 102
 103    Some targets (stupidly) report more than one exec event per actual
 104    call to an event() system call.  If only the last such exec event
 105    need actually be noticed and responded to by the debugger (i.e.,
 106    be reported to the user), then this is the number of "leading"
 107    exec events which should be ignored.
 108  */
 109 extern int inferior_ignoring_leading_exec_events;
 110
 111 /* Inferior environment. */
 112
 113 extern struct environ *inferior_environ;
 114
 115 extern void clear_proceed_status (void);
 116
 117 extern void proceed (CORE_ADDR, enum target_signal, int);
 118
 119 /* When set, stop the 'step' command if we enter a function which has
 120    no line number information.  The normal behavior is that we step
 121    over such function.  */
 122 extern int step_stop_if_no_debug;
 123
 124 extern void kill_inferior (void);
 125
 126 extern void generic_mourn_inferior (void);
 127
 128 extern void terminal_ours (void);
 129
 130 extern int run_stack_dummy (CORE_ADDR, char *);
 131
 132 extern CORE_ADDR read_pc (void);
 133
 134 extern CORE_ADDR read_pc_pid (int);
 135
 136 extern CORE_ADDR generic_target_read_pc (int);
 137
 138 extern void write_pc (CORE_ADDR);
 139
 140 extern void write_pc_pid (CORE_ADDR, int);
 141
 142 extern void generic_target_write_pc (CORE_ADDR, int);
 143
 144 extern CORE_ADDR read_sp (void);
 145
 146 extern CORE_ADDR generic_target_read_sp (void);
 147
 148 extern void write_sp (CORE_ADDR);
 149
 150 extern void generic_target_write_sp (CORE_ADDR);
 151
 152 extern CORE_ADDR read_fp (void);
 153
 154 extern CORE_ADDR generic_target_read_fp (void);
 155
 156 extern void write_fp (CORE_ADDR);
 157
 158 extern void generic_target_write_fp (CORE_ADDR);
 159
 160 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, void *buf);
 161
 162 extern void unsigned_address_to_pointer (struct type *type, void *buf,
 163                                          CORE_ADDR addr);
 164 extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
 165 extern void address_to_signed_pointer (struct type *type, void *buf,
 166                                        CORE_ADDR addr);
 167
 168 extern void wait_for_inferior (void);
 169
 170 extern void fetch_inferior_event (void *);
 171
 172 extern void init_wait_for_inferior (void);
 173
 174 extern void close_exec_file (void);
 175
 176 extern void reopen_exec_file (void);
 177
 178 /* The `resume' routine should only be called in special circumstances.
 179    Normally, use `proceed', which handles a lot of bookkeeping.  */
 180
 181 extern void resume (int, enum target_signal);
 182
 183 /* From misc files */
 184
 185 extern void do_registers_info (int, int);
 186
 187 extern void store_inferior_registers (int);
 188
 189 extern void fetch_inferior_registers (int);
 190
 191 extern void solib_create_inferior_hook (void);
 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 infptrace.c or infttrace.c */
 206
 207 extern int attach (int);
 208
 209 #if !defined(REQUIRE_ATTACH)
 210 #define REQUIRE_ATTACH attach
 211 #endif
 212
 213 #if !defined(REQUIRE_DETACH)
 214 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
 215 #endif
 216
 217 extern void detach (int);
 218
 219 /* PTRACE method of waiting for inferior process.  */
 220 int ptrace_wait (int, int *);
 221
 222 extern void child_resume (int, int, enum target_signal);
 223
 224 #ifndef PTRACE_ARG3_TYPE
 225 #define PTRACE_ARG3_TYPE int    /* Correct definition for most systems. */
 226 #endif
 227
 228 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
 229
 230 extern void pre_fork_inferior (void);
 231
 232 /* From procfs.c */
 233
 234 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 235
 236 extern int procfs_first_available (void);
 237
 238 /* From fork-child.c */
 239
 240 extern void fork_inferior (char *, char *, char **,
 241                            void (*)(void),
 242                            void (*)(int), void (*)(void), char *);
 243
 244
 245 extern void clone_and_follow_inferior (int, int *);
 246
 247 extern void startup_inferior (int);
 248
 249 /* From inflow.c */
 250
 251 extern void new_tty_prefork (char *);
 252
 253 extern int gdb_has_a_terminal (void);
 254
 255 /* From infrun.c */
 256
 257 extern void start_remote (void);
 258
 259 extern void normal_stop (void);
 260
 261 extern int signal_stop_state (int);
 262
 263 extern int signal_print_state (int);
 264
 265 extern int signal_pass_state (int);
 266
 267 extern int signal_stop_update (int, int);
 268
 269 extern int signal_print_update (int, int);
 270
 271 extern int signal_pass_update (int, int);
 272
 273 /* From infcmd.c */
 274
 275 extern void tty_command (char *, int);
 276
 277 extern void attach_command (char *, int);
 278
 279 extern char *get_inferior_arg (void);
 280
 281 extern char *set_inferior_arg (char *);
 282
 283 /* Last signal that the inferior received (why it stopped).  */
 284
 285 extern enum target_signal stop_signal;
 286
 287 /* Address at which inferior stopped.  */
 288
 289 extern CORE_ADDR stop_pc;
 290
 291 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 292
 293 extern bpstat stop_bpstat;
 294
 295 /* Flag indicating that a command has proceeded the inferior past the
 296    current breakpoint.  */
 297
 298 extern int breakpoint_proceeded;
 299
 300 /* Nonzero if stopped due to a step command.  */
 301
 302 extern int stop_step;
 303
 304 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 305
 306 extern int stop_stack_dummy;
 307
 308 /* Nonzero if program stopped due to a random (unexpected) signal in
 309    inferior process.  */
 310
 311 extern int stopped_by_random_signal;
 312
 313 /* Range to single step within.
 314    If this is nonzero, respond to a single-step signal
 315    by continuing to step if the pc is in this range.
 316
 317    If step_range_start and step_range_end are both 1, it means to step for
 318    a single instruction (FIXME: it might clean up wait_for_inferior in a
 319    minor way if this were changed to the address of the instruction and
 320    that address plus one.  But maybe not.).  */
 321
 322 extern CORE_ADDR step_range_start;      /* Inclusive */
 323 extern CORE_ADDR step_range_end;        /* Exclusive */
 324
 325 /* Stack frame address as of when stepping command was issued.
 326    This is how we know when we step into a subroutine call,
 327    and how to set the frame for the breakpoint used to step out.  */
 328
 329 extern CORE_ADDR step_frame_address;
 330
 331 /* Our notion of the current stack pointer.  */
 332
 333 extern CORE_ADDR step_sp;
 334
 335 /* 1 means step over all subroutine calls.
 336    -1 means step over calls to undebuggable functions.  */
 337
 338 enum step_over_calls_kind
 339   {
 340     STEP_OVER_NONE,
 341     STEP_OVER_ALL,
 342     STEP_OVER_UNDEBUGGABLE
 343   };
 344
 345 extern enum step_over_calls_kind step_over_calls;
 346
 347 /* If stepping, nonzero means step count is > 1
 348    so don't print frame next time inferior stops
 349    if it stops due to stepping.  */
 350
 351 extern int step_multi;
 352
 353 /* Nonzero means expecting a trap and caller will handle it themselves.
 354    It is used after attach, due to attaching to a process;
 355    when running in the shell before the child program has been exec'd;
 356    and when running some kinds of remote stuff (FIXME?).  */
 357
 358 extern int stop_soon_quietly;
 359
 360 /* Nonzero if proceed is being used for a "finish" command or a similar
 361    situation when stop_registers should be saved.  */
 362
 363 extern int proceed_to_finish;
 364
 365 /* Save register contents here when about to pop a stack dummy frame,
 366    if-and-only-if proceed_to_finish is set.
 367    Thus this contains the return value from the called function (assuming
 368    values are returned in a register).  */
 369
 370 extern char *stop_registers;
 371
 372 /* Nonzero if the child process in inferior_pid was attached rather
 373    than forked.  */
 374
 375 extern int attach_flag;
 376 \f
 377 /* Sigtramp is a routine that the kernel calls (which then calls the
 378    signal handler).  On most machines it is a library routine that
 379    is linked into the executable.
 380
 381    This macro, given a program counter value and the name of the
 382    function in which that PC resides (which can be null if the
 383    name is not known), returns nonzero if the PC and name show
 384    that we are in sigtramp.
 385
 386    On most machines just see if the name is sigtramp (and if we have
 387    no name, assume we are not in sigtramp).  */
 388 #if !defined (IN_SIGTRAMP)
 389 #if defined (SIGTRAMP_START)
 390 #define IN_SIGTRAMP(pc, name) \
 391        ((pc) >= SIGTRAMP_START(pc)   \
 392         && (pc) < SIGTRAMP_END(pc) \
 393         )
 394 #else
 395 #define IN_SIGTRAMP(pc, name) \
 396        (name && STREQ ("_sigtramp", name))
 397 #endif
 398 #endif
 399 \f
 400 /* Possible values for CALL_DUMMY_LOCATION.  */
 401 #define ON_STACK 1
 402 #define BEFORE_TEXT_END 2
 403 #define AFTER_TEXT_END 3
 404 #define AT_ENTRY_POINT 4
 405
 406 #if !defined (USE_GENERIC_DUMMY_FRAMES)
 407 #define USE_GENERIC_DUMMY_FRAMES 0
 408 #endif
 409
 410 #if !defined (CALL_DUMMY_LOCATION)
 411 #define CALL_DUMMY_LOCATION ON_STACK
 412 #endif /* No CALL_DUMMY_LOCATION.  */
 413
 414 #if !defined (CALL_DUMMY_ADDRESS)
 415 #define CALL_DUMMY_ADDRESS() (internal_error (__FILE__, __LINE__, "CALL_DUMMY_ADDRESS"), 0)
 416 #endif
 417 #if !defined (CALL_DUMMY_START_OFFSET)
 418 #define CALL_DUMMY_START_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_START_OFFSET"), 0)
 419 #endif
 420 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
 421 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
 422 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
 423 #endif
 424 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
 425 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
 426 #endif
 427 #if !defined (CALL_DUMMY_LENGTH)
 428 #define CALL_DUMMY_LENGTH (internal_error (__FILE__, __LINE__, "CALL_DUMMY_LENGTH"), 0)
 429 #endif
 430
 431 #if defined (CALL_DUMMY_STACK_ADJUST)
 432 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
 433 #define CALL_DUMMY_STACK_ADJUST_P (1)
 434 #endif
 435 #endif
 436 #if !defined (CALL_DUMMY_STACK_ADJUST)
 437 #define CALL_DUMMY_STACK_ADJUST (internal_error (__FILE__, __LINE__, "CALL_DUMMY_STACK_ADJUST"), 0)
 438 #endif
 439 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
 440 #define CALL_DUMMY_STACK_ADJUST_P (0)
 441 #endif
 442
 443 /* FIXME: cagney/2000-04-17: gdbarch should manage this.  The default
 444    shouldn't be necessary. */
 445
 446 #if !defined (CALL_DUMMY_P)
 447 #if defined (CALL_DUMMY)
 448 #define CALL_DUMMY_P 1
 449 #else
 450 #define CALL_DUMMY_P 0
 451 #endif
 452 #endif
 453
 454 #if !defined PUSH_DUMMY_FRAME
 455 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
 456 #endif
 457
 458 #if !defined FIX_CALL_DUMMY
 459 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error (__FILE__, __LINE__, "FIX_CALL_DUMMY"), 0)
 460 #endif
 461
 462 #if !defined STORE_STRUCT_RETURN
 463 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
 464 #endif
 465
 466
 467 /* Are we in a call dummy? */
 468
 469 extern int pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
 470                                              CORE_ADDR frame_address);
 471 #if !GDB_MULTI_ARCH
 472 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
 473 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
 474 #endif /* Before text_end.  */
 475 #endif
 476
 477 extern int pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
 478                                             CORE_ADDR frame_address);
 479 #if !GDB_MULTI_ARCH
 480 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
 481 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
 482 #endif
 483 #endif
 484
 485 extern int pc_in_call_dummy_on_stack (CORE_ADDR pc, CORE_ADDR sp,
 486                                       CORE_ADDR frame_address);
 487 #if !GDB_MULTI_ARCH
 488 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
 489 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
 490 #endif
 491 #endif
 492
 493 extern int pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
 494                                             CORE_ADDR frame_address);
 495 #if !GDB_MULTI_ARCH
 496 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
 497 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
 498 #endif
 499 #endif
 500
 501 /* It's often not enough for our clients to know whether the PC is merely
 502    somewhere within the call dummy.  They may need to know whether the
 503    call dummy has actually completed.  (For example, wait_for_inferior
 504    wants to know when it should truly stop because the call dummy has
 505    completed.  If we're single-stepping because of slow watchpoints,
 506    then we may find ourselves stopped at the entry of the call dummy,
 507    and want to continue stepping until we reach the end.)
 508
 509    Note that this macro is intended for targets (like HP-UX) which
 510    require more than a single breakpoint in their call dummies, and
 511    therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
 512
 513    If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
 514    default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
 515    Else, a target may wish to supply an implementation that works in
 516    the presense of multiple breakpoints in its call dummy.
 517  */
 518 #if !defined(CALL_DUMMY_HAS_COMPLETED)
 519 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
 520   PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
 521 #endif
 522
 523 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 524    will attempts to start up the debugee under a shell.
 525    This is in order for argument-expansion to occur. E.g.,
 526    (gdb) run *
 527    The "*" gets expanded by the shell into a list of files.
 528    While this is a nice feature, it turns out to interact badly
 529    with some of the catch-fork/catch-exec features we have added.
 530    In particular, if the shell does any fork/exec's before
 531    the exec of the target program, that can confuse GDB.
 532    To disable this feature, set STARTUP_WITH_SHELL to 0.
 533    To enable this feature, set STARTUP_WITH_SHELL to 1.
 534    The catch-exec traps expected during start-up will
 535    be 1 if target is not started up with a shell, 2 if it is.
 536    - RT
 537    If you disable this, you need to decrement
 538    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 539 #define STARTUP_WITH_SHELL 1
 540 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 541 #define START_INFERIOR_TRAPS_EXPECTED   2
 542 #endif
 543 #endif /* !defined (INFERIOR_H) */