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