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