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