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, const 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,
 193                                             const void *buf);
 194 extern void address_to_signed_pointer (struct type *type, void *buf,
 195                                        CORE_ADDR addr);
 196
 197 extern void wait_for_inferior (void);
 198
 199 extern void fetch_inferior_event (void *);
 200
 201 extern void init_wait_for_inferior (void);
 202
 203 extern void close_exec_file (void);
 204
 205 extern void reopen_exec_file (void);
 206
 207 /* The `resume' routine should only be called in special circumstances.
 208    Normally, use `proceed', which handles a lot of bookkeeping.  */
 209
 210 extern void resume (int, enum target_signal);
 211
 212 /* From misc files */
 213
 214 extern void default_print_registers_info (struct gdbarch *gdbarch,
 215                                           struct ui_file *file,
 216                                           struct frame_info *frame,
 217                                           int regnum, int all);
 218
 219 extern void store_inferior_registers (int);
 220
 221 extern void fetch_inferior_registers (int);
 222
 223 extern void solib_create_inferior_hook (void);
 224
 225 extern void child_terminal_info (char *, int);
 226
 227 extern void term_info (char *, int);
 228
 229 extern void terminal_ours_for_output (void);
 230
 231 extern void terminal_inferior (void);
 232
 233 extern void terminal_init_inferior (void);
 234
 235 extern void terminal_init_inferior_with_pgrp (int pgrp);
 236
 237 /* From infptrace.c or infttrace.c */
 238
 239 extern int attach (int);
 240
 241 extern void detach (int);
 242
 243 /* PTRACE method of waiting for inferior process.  */
 244 int ptrace_wait (ptid_t, int *);
 245
 246 extern void child_resume (ptid_t, int, enum target_signal);
 247
 248 #ifndef PTRACE_ARG3_TYPE
 249 #define PTRACE_ARG3_TYPE int    /* Correct definition for most systems. */
 250 #endif
 251
 252 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
 253
 254 extern void pre_fork_inferior (void);
 255
 256 /* From procfs.c */
 257
 258 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
 259
 260 extern ptid_t procfs_first_available (void);
 261
 262 /* From fork-child.c */
 263
 264 extern void fork_inferior (char *, char *, char **,
 265                            void (*)(void),
 266                            void (*)(int), void (*)(void), char *);
 267
 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 extern void follow_inferior_reset_breakpoints (void);
 301
 302 /* From infcmd.c */
 303
 304 extern void tty_command (char *, int);
 305
 306 extern void attach_command (char *, int);
 307
 308 extern char *get_inferior_args (void);
 309
 310 extern char *set_inferior_args (char *);
 311
 312 extern void set_inferior_args_vector (int, char **);
 313
 314 extern void registers_info (char *, int);
 315
 316 extern void nexti_command (char *, int);
 317
 318 extern void stepi_command (char *, int);
 319
 320 extern void continue_command (char *, int);
 321
 322 extern void interrupt_target_command (char *args, int from_tty);
 323
 324 /* Last signal that the inferior received (why it stopped).  */
 325
 326 extern enum target_signal stop_signal;
 327
 328 /* Address at which inferior stopped.  */
 329
 330 extern CORE_ADDR stop_pc;
 331
 332 /* Chain containing status of breakpoint(s) that we have stopped at.  */
 333
 334 extern bpstat stop_bpstat;
 335
 336 /* Flag indicating that a command has proceeded the inferior past the
 337    current breakpoint.  */
 338
 339 extern int breakpoint_proceeded;
 340
 341 /* Nonzero if stopped due to a step command.  */
 342
 343 extern int stop_step;
 344
 345 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 346
 347 extern int stop_stack_dummy;
 348
 349 /* Nonzero if program stopped due to a random (unexpected) signal in
 350    inferior process.  */
 351
 352 extern int stopped_by_random_signal;
 353
 354 /* Range to single step within.
 355    If this is nonzero, respond to a single-step signal
 356    by continuing to step if the pc is in this range.
 357
 358    If step_range_start and step_range_end are both 1, it means to step for
 359    a single instruction (FIXME: it might clean up wait_for_inferior in a
 360    minor way if this were changed to the address of the instruction and
 361    that address plus one.  But maybe not.).  */
 362
 363 extern CORE_ADDR step_range_start;      /* Inclusive */
 364 extern CORE_ADDR step_range_end;        /* Exclusive */
 365
 366 /* Stack frame address as of when stepping command was issued.
 367    This is how we know when we step into a subroutine call,
 368    and how to set the frame for the breakpoint used to step out.  */
 369
 370 extern struct frame_id step_frame_id;
 371
 372 /* Our notion of the current stack pointer.  */
 373
 374 extern CORE_ADDR step_sp;
 375
 376 /* 1 means step over all subroutine calls.
 377    -1 means step over calls to undebuggable functions.  */
 378
 379 enum step_over_calls_kind
 380   {
 381     STEP_OVER_NONE,
 382     STEP_OVER_ALL,
 383     STEP_OVER_UNDEBUGGABLE
 384   };
 385
 386 extern enum step_over_calls_kind step_over_calls;
 387
 388 /* If stepping, nonzero means step count is > 1
 389    so don't print frame next time inferior stops
 390    if it stops due to stepping.  */
 391
 392 extern int step_multi;
 393
 394 /* Nonzero means expecting a trap and caller will handle it themselves.
 395    It is used after attach, due to attaching to a process;
 396    when running in the shell before the child program has been exec'd;
 397    and when running some kinds of remote stuff (FIXME?).  */
 398
 399 extern int stop_soon_quietly;
 400
 401 /* Nonzero if proceed is being used for a "finish" command or a similar
 402    situation when stop_registers should be saved.  */
 403
 404 extern int proceed_to_finish;
 405
 406 /* Save register contents here when about to pop a stack dummy frame,
 407    if-and-only-if proceed_to_finish is set.
 408    Thus this contains the return value from the called function (assuming
 409    values are returned in a register).  */
 410
 411 extern struct regcache *stop_registers;
 412
 413 /* Nonzero if the child process in inferior_ptid was attached rather
 414    than forked.  */
 415
 416 extern int attach_flag;
 417 \f
 418 /* Possible values for CALL_DUMMY_LOCATION.  */
 419 #define ON_STACK 1
 420 #define BEFORE_TEXT_END 2
 421 #define AFTER_TEXT_END 3
 422 #define AT_ENTRY_POINT 4
 423
 424 #if !defined (CALL_DUMMY_ADDRESS)
 425 #define CALL_DUMMY_ADDRESS() (internal_error (__FILE__, __LINE__, "CALL_DUMMY_ADDRESS"), 0)
 426 #endif
 427 #if !defined (CALL_DUMMY_START_OFFSET)
 428 #define CALL_DUMMY_START_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_START_OFFSET"), 0)
 429 #endif
 430 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
 431 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
 432 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
 433 #endif
 434 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
 435 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
 436 #endif
 437 #if !defined (CALL_DUMMY_LENGTH)
 438 #define CALL_DUMMY_LENGTH (internal_error (__FILE__, __LINE__, "CALL_DUMMY_LENGTH"), 0)
 439 #endif
 440
 441 #if defined (CALL_DUMMY_STACK_ADJUST)
 442 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
 443 #define CALL_DUMMY_STACK_ADJUST_P (1)
 444 #endif
 445 #endif
 446 #if !defined (CALL_DUMMY_STACK_ADJUST)
 447 #define CALL_DUMMY_STACK_ADJUST (internal_error (__FILE__, __LINE__, "CALL_DUMMY_STACK_ADJUST"), 0)
 448 #endif
 449 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
 450 #define CALL_DUMMY_STACK_ADJUST_P (0)
 451 #endif
 452
 453 /* FIXME: cagney/2000-04-17: gdbarch should manage this.  The default
 454    shouldn't be necessary. */
 455
 456 #if !defined (CALL_DUMMY_P)
 457 #if defined (CALL_DUMMY)
 458 #define CALL_DUMMY_P 1
 459 #else
 460 #define CALL_DUMMY_P 0
 461 #endif
 462 #endif
 463
 464 #if !defined PUSH_DUMMY_FRAME
 465 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
 466 #endif
 467
 468 #if !defined FIX_CALL_DUMMY
 469 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error (__FILE__, __LINE__, "FIX_CALL_DUMMY"), 0)
 470 #endif
 471
 472 #if !defined STORE_STRUCT_RETURN
 473 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
 474 #endif
 475
 476
 477 /* Are we in a call dummy? */
 478
 479 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
 480    dummy frames, and use generic_pc_in_call_dummy().  The generic
 481    version should be able to handle all cases since that code works by
 482    saving the address of the dummy's breakpoint (where ever it is).  */
 483
 484 extern int deprecated_pc_in_call_dummy_before_text_end (CORE_ADDR pc,
 485                                                         CORE_ADDR sp,
 486                                                         CORE_ADDR frame_address);
 487
 488 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
 489    dummy frames, and use generic_pc_in_call_dummy().  The generic
 490    version should be able to handle all cases since that code works by
 491    saving the address of the dummy's breakpoint (where ever it is).  */
 492
 493 extern int deprecated_pc_in_call_dummy_after_text_end (CORE_ADDR pc,
 494                                                        CORE_ADDR sp,
 495                                                        CORE_ADDR frame_address);
 496
 497 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
 498    dummy frames, and use generic_pc_in_call_dummy().  The generic
 499    version should be able to handle all cases since that code works by
 500    saving the address of the dummy's breakpoint (where ever it is).  */
 501
 502 extern int deprecated_pc_in_call_dummy_on_stack (CORE_ADDR pc,
 503                                                  CORE_ADDR sp,
 504                                                  CORE_ADDR frame_address);
 505
 506 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
 507    dummy frames, and use generic_pc_in_call_dummy().  The generic
 508    version should be able to handle all cases since that code works by
 509    saving the address of the dummy's breakpoint (where ever it is).  */
 510
 511 extern int deprecated_pc_in_call_dummy_at_entry_point (CORE_ADDR pc,
 512                                                        CORE_ADDR sp,
 513                                                        CORE_ADDR frame_address);
 514
 515 /* It's often not enough for our clients to know whether the PC is merely
 516    somewhere within the call dummy.  They may need to know whether the
 517    call dummy has actually completed.  (For example, wait_for_inferior
 518    wants to know when it should truly stop because the call dummy has
 519    completed.  If we're single-stepping because of slow watchpoints,
 520    then we may find ourselves stopped at the entry of the call dummy,
 521    and want to continue stepping until we reach the end.)
 522
 523    Note that this macro is intended for targets (like HP-UX) which
 524    require more than a single breakpoint in their call dummies, and
 525    therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
 526
 527    If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
 528    default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
 529    Else, a target may wish to supply an implementation that works in
 530    the presense of multiple breakpoints in its call dummy.
 531  */
 532 #if !defined(CALL_DUMMY_HAS_COMPLETED)
 533 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
 534   DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
 535 #endif
 536
 537 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 538    will attempts to start up the debugee under a shell.
 539    This is in order for argument-expansion to occur. E.g.,
 540    (gdb) run *
 541    The "*" gets expanded by the shell into a list of files.
 542    While this is a nice feature, it turns out to interact badly
 543    with some of the catch-fork/catch-exec features we have added.
 544    In particular, if the shell does any fork/exec's before
 545    the exec of the target program, that can confuse GDB.
 546    To disable this feature, set STARTUP_WITH_SHELL to 0.
 547    To enable this feature, set STARTUP_WITH_SHELL to 1.
 548    The catch-exec traps expected during start-up will
 549    be 1 if target is not started up with a shell, 2 if it is.
 550    - RT
 551    If you disable this, you need to decrement
 552    START_INFERIOR_TRAPS_EXPECTED in tm.h. */
 553 #define STARTUP_WITH_SHELL 1
 554 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 555 #define START_INFERIOR_TRAPS_EXPECTED   2
 556 #endif
 557 #endif /* !defined (INFERIOR_H) */