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