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