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