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