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