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 unsigned_pointer_to_address (struct type *type, void *buf);
 164
 165 extern void unsigned_address_to_pointer (struct type *type, void *buf,
 166                                          CORE_ADDR addr);
 167 extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
 168 extern void address_to_signed_pointer (struct type *type, void *buf,
 169                                        CORE_ADDR addr);
 170
 171 extern void wait_for_inferior (void);
 172
 173 extern void fetch_inferior_event (void *);
 174
 175 extern void init_wait_for_inferior (void);
 176
 177 extern void close_exec_file (void);
 178
 179 extern void reopen_exec_file (void);
 180
 181 /* The `resume' routine should only be called in special circumstances.
 182    Normally, use `proceed', which handles a lot of bookkeeping.  */
 183
 184 extern void resume (int, enum target_signal);
 185
 186 /* From misc files */
 187
 188 extern void store_inferior_registers (int);
 189
 190 extern void fetch_inferior_registers (int);
 191
 192 extern void solib_create_inferior_hook (void);
 193
 194 extern void child_terminal_info (char *, int);
 195
 196 extern void term_info (char *, int);
 197
 198 extern void terminal_ours_for_output (void);
 199
 200 extern void terminal_inferior (void);
 201
 202 extern void terminal_init_inferior (void);
 203
 204 extern void terminal_init_inferior_with_pgrp (int pgrp);
 205
 206 /* From infptrace.c or infttrace.c */
 207
 208 extern int attach (int);
 209
 210 #if !defined(REQUIRE_ATTACH)
 211 #define REQUIRE_ATTACH attach
 212 #endif
 213
 214 #if !defined(REQUIRE_DETACH)
 215 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
 216 #endif
 217
 218 extern void detach (int);
 219
 220 /* PTRACE method of waiting for inferior process.  */
 221 int ptrace_wait (int, int *);
 222
 223 extern void child_resume (int, int, enum target_signal);
 224
 225 #ifndef PTRACE_ARG3_TYPE
 226 #define PTRACE_ARG3_TYPE int    /* Correct definition for most systems. */
 227 #endif
 228
 229 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
 230
 231 extern void pre_fork_inferior (void);
 232
 233 /* From procfs.c */
 234
 235 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 236
 237 extern int procfs_first_available (void);
 238
 239 /* From fork-child.c */
 240
 241 extern void fork_inferior (char *, char *, char **,
 242                            void (*)(void),
 243                            void (*)(int), void (*)(void), char *);
 244
 245
 246 extern void clone_and_follow_inferior (int, int *);
 247
 248 extern void startup_inferior (int);
 249
 250 /* From inflow.c */
 251
 252 extern void new_tty_prefork (char *);
 253
 254 extern int gdb_has_a_terminal (void);
 255
 256 /* From infrun.c */
 257
 258 extern void start_remote (void);
 259
 260 extern void normal_stop (void);
 261
 262 extern int signal_stop_state (int);
 263
 264 extern int signal_print_state (int);
 265
 266 extern int signal_pass_state (int);
 267
 268 extern int signal_stop_update (int, int);
 269
 270 extern int signal_print_update (int, int);
 271
 272 extern int signal_pass_update (int, int);
 273
 274 /* From infcmd.c */
 275
 276 extern void tty_command (char *, int);
 277
 278 extern void attach_command (char *, int);
 279
 280 /* Last signal that the inferior received (why it stopped).  */
 281
 282 extern enum target_signal stop_signal;
 283
 284 /* Address at which inferior stopped.  */
 285
 286 extern CORE_ADDR stop_pc;
 287
 288 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 289
 290 extern bpstat stop_bpstat;
 291
 292 /* Flag indicating that a command has proceeded the inferior past the
 293    current breakpoint.  */
 294
 295 extern int breakpoint_proceeded;
 296
 297 /* Nonzero if stopped due to a step command.  */
 298
 299 extern int stop_step;
 300
 301 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 302
 303 extern int stop_stack_dummy;
 304
 305 /* Nonzero if program stopped due to a random (unexpected) signal in
 306    inferior process.  */
 307
 308 extern int stopped_by_random_signal;
 309
 310 /* Range to single step within.
 311    If this is nonzero, respond to a single-step signal
 312    by continuing to step if the pc is in this range.
 313
 314    If step_range_start and step_range_end are both 1, it means to step for
 315    a single instruction (FIXME: it might clean up wait_for_inferior in a
 316    minor way if this were changed to the address of the instruction and
 317    that address plus one.  But maybe not.).  */
 318
 319 extern CORE_ADDR step_range_start;      /* Inclusive */
 320 extern CORE_ADDR step_range_end;        /* Exclusive */
 321
 322 /* Stack frame address as of when stepping command was issued.
 323    This is how we know when we step into a subroutine call,
 324    and how to set the frame for the breakpoint used to step out.  */
 325
 326 extern CORE_ADDR step_frame_address;
 327
 328 /* Our notion of the current stack pointer.  */
 329
 330 extern CORE_ADDR step_sp;
 331
 332 /* 1 means step over all subroutine calls.
 333    -1 means step over calls to undebuggable functions.  */
 334
 335 extern int step_over_calls;
 336
 337 /* If stepping, nonzero means step count is > 1
 338    so don't print frame next time inferior stops
 339    if it stops due to stepping.  */
 340
 341 extern int step_multi;
 342
 343 /* Nonzero means expecting a trap and caller will handle it themselves.
 344    It is used after attach, due to attaching to a process;
 345    when running in the shell before the child program has been exec'd;
 346    and when running some kinds of remote stuff (FIXME?).  */
 347
 348 extern int stop_soon_quietly;
 349
 350 /* Nonzero if proceed is being used for a "finish" command or a similar
 351    situation when stop_registers should be saved.  */
 352
 353 extern int proceed_to_finish;
 354
 355 /* Save register contents here when about to pop a stack dummy frame,
 356    if-and-only-if proceed_to_finish is set.
 357    Thus this contains the return value from the called function (assuming
 358    values are returned in a register).  */
 359
 360 extern char *stop_registers;
 361
 362 /* Nonzero if the child process in inferior_pid was attached rather
 363    than forked.  */
 364
 365 extern int attach_flag;
 366 \f
 367 /* Sigtramp is a routine that the kernel calls (which then calls the
 368    signal handler).  On most machines it is a library routine that
 369    is linked into the executable.
 370
 371    This macro, given a program counter value and the name of the
 372    function in which that PC resides (which can be null if the
 373    name is not known), returns nonzero if the PC and name show
 374    that we are in sigtramp.
 375
 376    On most machines just see if the name is sigtramp (and if we have
 377    no name, assume we are not in sigtramp).  */
 378 #if !defined (IN_SIGTRAMP)
 379 #if defined (SIGTRAMP_START)
 380 #define IN_SIGTRAMP(pc, name) \
 381        ((pc) >= SIGTRAMP_START(pc)   \
 382         && (pc) < SIGTRAMP_END(pc) \
 383         )
 384 #else
 385 #define IN_SIGTRAMP(pc, name) \
 386        (name && STREQ ("_sigtramp", name))
 387 #endif
 388 #endif
 389 \f
 390 /* Possible values for CALL_DUMMY_LOCATION.  */
 391 #define ON_STACK 1
 392 #define BEFORE_TEXT_END 2
 393 #define AFTER_TEXT_END 3
 394 #define AT_ENTRY_POINT 4
 395
 396 #if !defined (USE_GENERIC_DUMMY_FRAMES)
 397 #define USE_GENERIC_DUMMY_FRAMES 0
 398 #endif
 399
 400 #if !defined (CALL_DUMMY_LOCATION)
 401 #define CALL_DUMMY_LOCATION ON_STACK
 402 #endif /* No CALL_DUMMY_LOCATION.  */
 403
 404 #if !defined (CALL_DUMMY_ADDRESS)
 405 #define CALL_DUMMY_ADDRESS() (internal_error ("CALL_DUMMY_ADDRESS"), 0)
 406 #endif
 407 #if !defined (CALL_DUMMY_START_OFFSET)
 408 #define CALL_DUMMY_START_OFFSET (internal_error ("CALL_DUMMY_START_OFFSET"), 0)
 409 #endif
 410 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
 411 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
 412 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error ("CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
 413 #endif
 414 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
 415 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
 416 #endif
 417 #if !defined (CALL_DUMMY_LENGTH)
 418 #define CALL_DUMMY_LENGTH (internal_error ("CALL_DUMMY_LENGTH"), 0)
 419 #endif
 420
 421 #if defined (CALL_DUMMY_STACK_ADJUST)
 422 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
 423 #define CALL_DUMMY_STACK_ADJUST_P (1)
 424 #endif
 425 #endif
 426 #if !defined (CALL_DUMMY_STACK_ADJUST)
 427 #define CALL_DUMMY_STACK_ADJUST (internal_error ("CALL_DUMMY_STACK_ADJUST"), 0)
 428 #endif
 429 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
 430 #define CALL_DUMMY_STACK_ADJUST_P (0)
 431 #endif
 432
 433 /* FIXME: cagney/2000-04-17: gdbarch should manage this.  The default
 434    shouldn't be necessary. */
 435
 436 #if !defined (CALL_DUMMY_P)
 437 #if defined (CALL_DUMMY)
 438 #define CALL_DUMMY_P 1
 439 #else
 440 #define CALL_DUMMY_P 0
 441 #endif
 442 #endif
 443
 444 #if !defined PUSH_DUMMY_FRAME
 445 #define PUSH_DUMMY_FRAME (internal_error ("PUSH_DUMMY_FRAME"), 0)
 446 #endif
 447
 448 #if !defined FIX_CALL_DUMMY
 449 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error ("FIX_CALL_DUMMY"), 0)
 450 #endif
 451
 452 #if !defined STORE_STRUCT_RETURN
 453 #define STORE_STRUCT_RETURN(a1,a2) (internal_error ("STORE_STRUCT_RETURN"), 0)
 454 #endif
 455
 456
 457 /* Are we in a call dummy? */
 458
 459 extern int pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
 460                                              CORE_ADDR frame_address);
 461 #if !GDB_MULTI_ARCH
 462 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
 463 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
 464 #endif /* Before text_end.  */
 465 #endif
 466
 467 extern int pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
 468                                             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 (CORE_ADDR pc, CORE_ADDR sp,
 476                                       CORE_ADDR frame_address);
 477 #if !GDB_MULTI_ARCH
 478 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
 479 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
 480 #endif
 481 #endif
 482
 483 extern int pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
 484                                             CORE_ADDR frame_address);
 485 #if !GDB_MULTI_ARCH
 486 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
 487 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
 488 #endif
 489 #endif
 490
 491 /* It's often not enough for our clients to know whether the PC is merely
 492    somewhere within the call dummy.  They may need to know whether the
 493    call dummy has actually completed.  (For example, wait_for_inferior
 494    wants to know when it should truly stop because the call dummy has
 495    completed.  If we're single-stepping because of slow watchpoints,
 496    then we may find ourselves stopped at the entry of the call dummy,
 497    and want to continue stepping until we reach the end.)
 498
 499    Note that this macro is intended for targets (like HP-UX) which
 500    require more than a single breakpoint in their call dummies, and
 501    therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
 502
 503    If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
 504    default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
 505    Else, a target may wish to supply an implementation that works in
 506    the presense of multiple breakpoints in its call dummy.
 507  */
 508 #if !defined(CALL_DUMMY_HAS_COMPLETED)
 509 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
 510   PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
 511 #endif
 512
 513 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 514    will attempts to start up the debugee under a shell.
 515    This is in order for argument-expansion to occur. E.g.,
 516    (gdb) run *
 517    The "*" gets expanded by the shell into a list of files.
 518    While this is a nice feature, it turns out to interact badly
 519    with some of the catch-fork/catch-exec features we have added.
 520    In particular, if the shell does any fork/exec's before
 521    the exec of the target program, that can confuse GDB.
 522    To disable this feature, set STARTUP_WITH_SHELL to 0.
 523    To enable this feature, set STARTUP_WITH_SHELL to 1.
 524    The catch-exec traps expected during start-up will
 525    be 1 if target is not started up with a shell, 2 if it is.
 526    - RT
 527    If you disable this, you need to decrement
 528    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 529 #define STARTUP_WITH_SHELL 1
 530 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 531 #define START_INFERIOR_TRAPS_EXPECTED   2
 532 #endif
 533 #endif /* !defined (INFERIOR_H) */