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