contrib/gdb-7/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
   4    Copyright (C) 1986, 1988-1996, 1998-2001, 2003-2012 Free Software
   5    Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (INFERIOR_H)
  23 #define INFERIOR_H 1
  24
  25 struct target_waitstatus;
  26 struct frame_info;
  27 struct ui_file;
  28 struct type;
  29 struct gdbarch;
  30 struct regcache;
  31 struct ui_out;
  32 struct terminal_info;
  33
  34 #define FAKE_PROCESS_ID -777
  35
  36 #include "ptid.h"
  37
  38 /* For bpstat.  */
  39 #include "breakpoint.h"
  40
  41 /* For enum target_signal.  */
  42 #include "target.h"
  43
  44 /* For struct frame_id.  */
  45 #include "frame.h"
  46
  47 #include "progspace.h"
  48
  49 struct infcall_suspend_state;
  50 struct infcall_control_state;
  51
  52 extern struct infcall_suspend_state *save_infcall_suspend_state (void);
  53 extern struct infcall_control_state *save_infcall_control_state (void);
  54
  55 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
  56 extern void restore_infcall_control_state (struct infcall_control_state *);
  57
  58 extern struct cleanup *make_cleanup_restore_infcall_suspend_state
  59                                             (struct infcall_suspend_state *);
  60 extern struct cleanup *make_cleanup_restore_infcall_control_state
  61                                             (struct infcall_control_state *);
  62
  63 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
  64 extern void discard_infcall_control_state (struct infcall_control_state *);
  65
  66 extern struct regcache *
  67   get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
  68
  69 /* Returns true if PTID matches filter FILTER.  FILTER can be the wild
  70    card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
  71    a process (ptid_is_pid returns true), in which case, all lwps and
  72    threads of that given process match, lwps and threads of other
  73    processes do not; or, it can represent a specific thread, in which
  74    case, only that thread will match true.  PTID must represent a
  75    specific LWP or THREAD, it can never be a wild card.  */
  76
  77 extern int ptid_match (ptid_t ptid, ptid_t filter);
  78
  79 /* Save value of inferior_ptid so that it may be restored by
  80    a later call to do_cleanups().  Returns the struct cleanup
  81    pointer needed for later doing the cleanup.  */
  82 extern struct cleanup * save_inferior_ptid (void);
  83
  84 extern void set_sigint_trap (void);
  85
  86 extern void clear_sigint_trap (void);
  87
  88 /* Set/get file name for default use for standard in/out in the inferior.  */
  89
  90 extern void set_inferior_io_terminal (const char *terminal_name);
  91 extern const char *get_inferior_io_terminal (void);
  92
  93 /* Collected pid, tid, etc. of the debugged inferior.  When there's
  94    no inferior, PIDGET (inferior_ptid) will be 0.  */
  95
  96 extern ptid_t inferior_ptid;
  97
  98 /* Are we simulating synchronous execution? This is used in async gdb
  99    to implement the 'run', 'continue' etc commands, which will not
 100    redisplay the prompt until the execution is actually over.  */
 101 extern int sync_execution;
 102
 103 /* Inferior environment.  */
 104
 105 extern void clear_proceed_status (void);
 106
 107 extern void proceed (CORE_ADDR, enum target_signal, int);
 108
 109 extern int sched_multi;
 110
 111 /* When set, stop the 'step' command if we enter a function which has
 112    no line number information.  The normal behavior is that we step
 113    over such function.  */
 114 extern int step_stop_if_no_debug;
 115
 116 /* If set, the inferior should be controlled in non-stop mode.  In
 117    this mode, each thread is controlled independently.  Execution
 118    commands apply only to the selected thread by default, and stop
 119    events stop only the thread that had the event -- the other threads
 120    are kept running freely.  */
 121 extern int non_stop;
 122
 123 /* If set (default), when following a fork, GDB will detach from one
 124    the fork branches, child or parent.  Exactly which branch is
 125    detached depends on 'set follow-fork-mode' setting.  */
 126 extern int detach_fork;
 127
 128 /* When set (default), the target should attempt to disable the operating
 129    system's address space randomization feature when starting an inferior.  */
 130 extern int disable_randomization;
 131
 132 extern void generic_mourn_inferior (void);
 133
 134 extern void terminal_save_ours (void);
 135
 136 extern void terminal_ours (void);
 137
 138 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
 139                                               struct type *type,
 140                                               const gdb_byte *buf);
 141 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
 142                                          struct type *type, gdb_byte *buf,
 143                                          CORE_ADDR addr);
 144 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
 145                                             struct type *type,
 146                                             const gdb_byte *buf);
 147 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
 148                                        struct type *type, gdb_byte *buf,
 149                                        CORE_ADDR addr);
 150
 151 extern void wait_for_inferior (void);
 152
 153 extern void prepare_for_detach (void);
 154
 155 extern void fetch_inferior_event (void *);
 156
 157 extern void init_wait_for_inferior (void);
 158
 159 extern void close_exec_file (void);
 160
 161 extern void reopen_exec_file (void);
 162
 163 /* The `resume' routine should only be called in special circumstances.
 164    Normally, use `proceed', which handles a lot of bookkeeping.  */
 165
 166 extern void resume (int, enum target_signal);
 167
 168 extern ptid_t user_visible_resume_ptid (int step);
 169
 170 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 171                                                   struct symtab_and_line ,
 172                                                   struct frame_id);
 173
 174 /* From misc files */
 175
 176 extern void default_print_registers_info (struct gdbarch *gdbarch,
 177                                           struct ui_file *file,
 178                                           struct frame_info *frame,
 179                                           int regnum, int all);
 180
 181 extern void child_terminal_info (char *, int);
 182
 183 extern void term_info (char *, int);
 184
 185 extern void terminal_ours_for_output (void);
 186
 187 extern void terminal_inferior (void);
 188
 189 extern void terminal_init_inferior (void);
 190
 191 extern void terminal_init_inferior_with_pgrp (int pgrp);
 192
 193 /* From fork-child.c */
 194
 195 extern int fork_inferior (char *, char *, char **,
 196                           void (*)(void),
 197                           void (*)(int), void (*)(void), char *,
 198                           void (*)(const char *,
 199                                    char * const *, char * const *));
 200
 201
 202 extern void startup_inferior (int);
 203
 204 extern char *construct_inferior_arguments (int, char **);
 205
 206 /* From infrun.c */
 207
 208 extern int debug_infrun;
 209
 210 extern int stop_on_solib_events;
 211
 212 extern void start_remote (int from_tty);
 213
 214 extern void normal_stop (void);
 215
 216 extern int signal_stop_state (int);
 217
 218 extern int signal_print_state (int);
 219
 220 extern int signal_pass_state (int);
 221
 222 extern int signal_stop_update (int, int);
 223
 224 extern int signal_print_update (int, int);
 225
 226 extern int signal_pass_update (int, int);
 227
 228 extern void get_last_target_status(ptid_t *ptid,
 229                                    struct target_waitstatus *status);
 230
 231 extern void follow_inferior_reset_breakpoints (void);
 232
 233 /* Throw an error indicating the current thread is running.  */
 234 extern void error_is_running (void);
 235
 236 /* Calls error_is_running if the current thread is running.  */
 237 extern void ensure_not_running (void);
 238
 239 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
 240
 241 /* From infcmd.c */
 242
 243 extern void post_create_inferior (struct target_ops *, int);
 244
 245 extern void attach_command (char *, int);
 246
 247 extern char *get_inferior_args (void);
 248
 249 extern void set_inferior_args (char *);
 250
 251 extern void set_inferior_args_vector (int, char **);
 252
 253 extern void registers_info (char *, int);
 254
 255 extern void nexti_command (char *, int);
 256
 257 extern void stepi_command (char *, int);
 258
 259 extern void continue_1 (int all_threads);
 260
 261 extern void continue_command (char *, int);
 262
 263 extern void interrupt_target_command (char *args, int from_tty);
 264
 265 extern void interrupt_target_1 (int all_threads);
 266
 267 extern void delete_longjmp_breakpoint_cleanup (void *arg);
 268
 269 extern void detach_command (char *, int);
 270
 271 extern void notice_new_inferior (ptid_t, int, int);
 272
 273 extern struct value *get_return_value (struct type *func_type,
 274                                        struct type *value_type);
 275
 276 /* Address at which inferior stopped.  */
 277
 278 extern CORE_ADDR stop_pc;
 279
 280 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 281
 282 extern enum stop_stack_kind stop_stack_dummy;
 283
 284 /* Nonzero if program stopped due to a random (unexpected) signal in
 285    inferior process.  */
 286
 287 extern int stopped_by_random_signal;
 288
 289 /* STEP_OVER_ALL means step over all subroutine calls.
 290    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 291    STEP_OVER_NONE means don't step over any subroutine calls.  */
 292
 293 enum step_over_calls_kind
 294   {
 295     STEP_OVER_NONE,
 296     STEP_OVER_ALL,
 297     STEP_OVER_UNDEBUGGABLE
 298   };
 299
 300 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 301    will handle it themselves.  STOP_QUIETLY is used when running in
 302    the shell before the child program has been exec'd and when running
 303    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 304    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 305    except that there is no need to hide a signal.  */
 306
 307 /* It is also used after attach, due to attaching to a process.  This
 308    is a bit trickier.  When doing an attach, the kernel stops the
 309    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 310    the handling of SIGSTOP for a ptraced process has changed.  Earlier
 311    versions of the kernel would ignore these SIGSTOPs, while now
 312    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 313
 314    If the gdb user does a 'continue' after the 'attach', gdb passes
 315    the global variable stop_signal (which stores the signal from the
 316    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 317    problematic, because the kernel doesn't ignore such SIGSTOP
 318    now.  I.e. it is reported back to gdb, which in turn presents it
 319    back to the user.
 320
 321    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 322    gdb to clear the value of stop_signal after the attach, so that it
 323    is not passed back down to the kernel.  */
 324
 325 enum stop_kind
 326   {
 327     NO_STOP_QUIETLY = 0,
 328     STOP_QUIETLY,
 329     STOP_QUIETLY_REMOTE,
 330     STOP_QUIETLY_NO_SIGSTOP
 331   };
 332
 333 /* Reverse execution.  */
 334 enum exec_direction_kind
 335   {
 336     EXEC_FORWARD,
 337     EXEC_REVERSE
 338   };
 339
 340 /* The current execution direction.  This should only be set to enum
 341    exec_direction_kind values.  It is only an int to make it
 342    compatible with make_cleanup_restore_integer.  */
 343 extern int execution_direction;
 344
 345 /* Save register contents here when executing a "finish" command or are
 346    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 347    Thus this contains the return value from the called function (assuming
 348    values are returned in a register).  */
 349
 350 extern struct regcache *stop_registers;
 351
 352 /* True if we are debugging displaced stepping.  */
 353 extern int debug_displaced;
 354
 355 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 356 void displaced_step_dump_bytes (struct ui_file *file,
 357                                 const gdb_byte *buf, size_t len);
 358
 359 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
 360 \f
 361 /* Possible values for gdbarch_call_dummy_location.  */
 362 #define ON_STACK 1
 363 #define AT_ENTRY_POINT 4
 364 #define AT_SYMBOL 5
 365
 366 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 367    will attempts to start up the debugee under a shell.
 368    This is in order for argument-expansion to occur.  E.g.,
 369    (gdb) run *
 370    The "*" gets expanded by the shell into a list of files.
 371    While this is a nice feature, it turns out to interact badly
 372    with some of the catch-fork/catch-exec features we have added.
 373    In particular, if the shell does any fork/exec's before
 374    the exec of the target program, that can confuse GDB.
 375    To disable this feature, set STARTUP_WITH_SHELL to 0.
 376    To enable this feature, set STARTUP_WITH_SHELL to 1.
 377    The catch-exec traps expected during start-up will
 378    be 1 if target is not started up with a shell, 2 if it is.
 379    - RT
 380    If you disable this, you need to decrement
 381    START_INFERIOR_TRAPS_EXPECTED in tm.h.  */
 382 #define STARTUP_WITH_SHELL 1
 383 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 384 #define START_INFERIOR_TRAPS_EXPECTED   2
 385 #endif
 386
 387 struct private_inferior;
 388
 389 /* Inferior process specific part of `struct infcall_control_state'.
 390
 391    Inferior thread counterpart is `struct thread_control_state'.  */
 392
 393 struct inferior_control_state
 394 {
 395   /* See the definition of stop_kind above.  */
 396   enum stop_kind stop_soon;
 397 };
 398
 399 /* Inferior process specific part of `struct infcall_suspend_state'.
 400
 401    Inferior thread counterpart is `struct thread_suspend_state'.  */
 402
 403 struct inferior_suspend_state
 404 {
 405 };
 406
 407 /* GDB represents the state of each program execution with an object
 408    called an inferior.  An inferior typically corresponds to a process
 409    but is more general and applies also to targets that do not have a
 410    notion of processes.  Each run of an executable creates a new
 411    inferior, as does each attachment to an existing process.
 412    Inferiors have unique internal identifiers that are different from
 413    target process ids.  Each inferior may in turn have multiple
 414    threads running in it.  */
 415
 416 struct inferior
 417 {
 418   /* Pointer to next inferior in singly-linked list of inferiors.  */
 419   struct inferior *next;
 420
 421   /* Convenient handle (GDB inferior id).  Unique across all
 422      inferiors.  */
 423   int num;
 424
 425   /* Actual target inferior id, usually, a process id.  This matches
 426      the ptid_t.pid member of threads of this inferior.  */
 427   int pid;
 428
 429   /* State of GDB control of inferior process execution.
 430      See `struct inferior_control_state'.  */
 431   struct inferior_control_state control;
 432
 433   /* State of inferior process to restore after GDB is done with an inferior
 434      call.  See `struct inferior_suspend_state'.  */
 435   struct inferior_suspend_state suspend;
 436
 437   /* True if this was an auto-created inferior, e.g. created from
 438      following a fork; false, if this inferior was manually added by
 439      the user, and we should not attempt to prune it
 440      automatically.  */
 441   int removable;
 442
 443   /* The address space bound to this inferior.  */
 444   struct address_space *aspace;
 445
 446   /* The program space bound to this inferior.  */
 447   struct program_space *pspace;
 448
 449   /* The arguments string to use when running.  */
 450   char *args;
 451
 452   /* The size of elements in argv.  */
 453   int argc;
 454
 455   /* The vector version of arguments.  If ARGC is nonzero,
 456      then we must compute ARGS from this (via the target).
 457      This is always coming from main's argv and therefore
 458      should never be freed.  */
 459   char **argv;
 460
 461   /* The name of terminal device to use for I/O.  */
 462   char *terminal;
 463
 464   /* Environment to use for running inferior,
 465      in format described in environ.h.  */
 466   struct gdb_environ *environment;
 467
 468   /* Nonzero if this child process was attached rather than
 469      forked.  */
 470   int attach_flag;
 471
 472   /* If this inferior is a vfork child, then this is the pointer to
 473      its vfork parent, if GDB is still attached to it.  */
 474   struct inferior *vfork_parent;
 475
 476   /* If this process is a vfork parent, this is the pointer to the
 477      child.  Since a vfork parent is left frozen by the kernel until
 478      the child execs or exits, a process can only have one vfork child
 479      at a given time.  */
 480   struct inferior *vfork_child;
 481
 482   /* True if this inferior should be detached when it's vfork sibling
 483      exits or execs.  */
 484   int pending_detach;
 485
 486   /* True if this inferior is a vfork parent waiting for a vfork child
 487      not under our control to be done with the shared memory region,
 488      either by exiting or execing.  */
 489   int waiting_for_vfork_done;
 490
 491   /* True if we're in the process of detaching from this inferior.  */
 492   int detaching;
 493
 494   /* What is left to do for an execution command after any thread of
 495      this inferior stops.  For continuations associated with a
 496      specific thread, see `struct thread_info'.  */
 497   struct continuation *continuations;
 498
 499   /* Private data used by the target vector implementation.  */
 500   struct private_inferior *private;
 501
 502   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 503      In this case, the EXIT_CODE field is also valid.  */
 504   int has_exit_code;
 505   LONGEST exit_code;
 506
 507   /* We keep a count of the number of times the user has requested a
 508      particular syscall to be tracked, and pass this information to the
 509      target.  This lets capable targets implement filtering directly.  */
 510
 511   /* Number of times that "any" syscall is requested.  */
 512   int any_syscall_count;
 513
 514   /* Count of each system call.  */
 515   VEC(int) *syscalls_counts;
 516
 517   /* This counts all syscall catch requests, so we can readily determine
 518      if any catching is necessary.  */
 519   int total_syscalls_count;
 520
 521   /* Per inferior data-pointers required by other GDB modules.  */
 522   void **data;
 523   unsigned num_data;
 524 };
 525
 526 /* Keep a registry of per-inferior data-pointers required by other GDB
 527    modules.  */
 528
 529 extern const struct inferior_data *register_inferior_data (void);
 530 extern const struct inferior_data *register_inferior_data_with_cleanup
 531   (void (*cleanup) (struct inferior *, void *));
 532 extern void clear_inferior_data (struct inferior *inf);
 533 extern void set_inferior_data (struct inferior *inf,
 534                                const struct inferior_data *data, void *value);
 535 extern void *inferior_data (struct inferior *inf,
 536                             const struct inferior_data *data);
 537
 538 /* Create an empty inferior list, or empty the existing one.  */
 539 extern void init_inferior_list (void);
 540
 541 /* Add an inferior to the inferior list, print a message that a new
 542    inferior is found, and return the pointer to the new inferior.
 543    Caller may use this pointer to initialize the private inferior
 544    data.  */
 545 extern struct inferior *add_inferior (int pid);
 546
 547 /* Same as add_inferior, but don't print new inferior notifications to
 548    the CLI.  */
 549 extern struct inferior *add_inferior_silent (int pid);
 550
 551 /* Delete an existing inferior list entry, due to inferior exit.  */
 552 extern void delete_inferior (int pid);
 553
 554 extern void delete_inferior_1 (struct inferior *todel, int silent);
 555
 556 /* Same as delete_inferior, but don't print new inferior notifications
 557    to the CLI.  */
 558 extern void delete_inferior_silent (int pid);
 559
 560 /* Delete an existing inferior list entry, due to inferior detaching.  */
 561 extern void detach_inferior (int pid);
 562
 563 extern void exit_inferior (int pid);
 564
 565 extern void exit_inferior_silent (int pid);
 566
 567 extern void exit_inferior_num_silent (int num);
 568
 569 extern void inferior_appeared (struct inferior *inf, int pid);
 570
 571 /* Get rid of all inferiors.  */
 572 extern void discard_all_inferiors (void);
 573
 574 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 575    into a "pid" (which may be overloaded with extra inferior information).  */
 576 extern int gdb_inferior_id_to_pid (int);
 577
 578 /* Translate a target 'pid' into the integer inferior id (GDB's
 579    homegrown id, not the system's).  */
 580 extern int pid_to_gdb_inferior_id (int pid);
 581
 582 /* Boolean test for an already-known pid.  */
 583 extern int in_inferior_list (int pid);
 584
 585 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 586    not the system's).  */
 587 extern int valid_gdb_inferior_id (int num);
 588
 589 /* Search function to lookup an inferior by target 'pid'.  */
 590 extern struct inferior *find_inferior_pid (int pid);
 591
 592 /* Search function to lookup an inferior by GDB 'num'.  */
 593 extern struct inferior *find_inferior_id (int num);
 594
 595 /* Find an inferior bound to PSPACE.  */
 596 extern struct inferior *
 597   find_inferior_for_program_space (struct program_space *pspace);
 598
 599 /* Inferior iterator function.
 600
 601    Calls a callback function once for each inferior, so long as the
 602    callback function returns false.  If the callback function returns
 603    true, the iteration will end and the current inferior will be
 604    returned.  This can be useful for implementing a search for a
 605    inferior with arbitrary attributes, or for applying some operation
 606    to every inferior.
 607
 608    It is safe to delete the iterated inferior from the callback.  */
 609 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 610                                                          void *),
 611                                                 void *);
 612
 613 /* Returns true if the inferior list is not empty.  */
 614 extern int have_inferiors (void);
 615
 616 /* Returns true if there are any live inferiors in the inferior list
 617    (not cores, not executables, real live processes).  */
 618 extern int have_live_inferiors (void);
 619
 620 /* Return a pointer to the current inferior.  It is an error to call
 621    this if there is no current inferior.  */
 622 extern struct inferior *current_inferior (void);
 623
 624 extern void set_current_inferior (struct inferior *);
 625
 626 extern struct cleanup *save_current_inferior (void);
 627
 628 /* Traverse all inferiors.  */
 629
 630 #define ALL_INFERIORS(I) \
 631   for ((I) = inferior_list; (I); (I) = (I)->next)
 632
 633 extern struct inferior *inferior_list;
 634
 635 /* Prune away automatically added inferiors that aren't required
 636    anymore.  */
 637 extern void prune_inferiors (void);
 638
 639 extern int number_of_inferiors (void);
 640
 641 extern struct inferior *add_inferior_with_spaces (void);
 642
 643 extern void update_observer_mode (void);
 644
 645 #endif /* !defined (INFERIOR_H) */