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
 194
 195 extern void startup_inferior (int);
 196
 197 extern char *construct_inferior_arguments (int, char **);
 198
 199 /* From infrun.c */
 200
 201 extern int debug_infrun;
 202
 203 extern int stop_on_solib_events;
 204
 205 extern void start_remote (int from_tty);
 206
 207 extern void normal_stop (void);
 208
 209 extern int signal_stop_state (int);
 210
 211 extern int signal_print_state (int);
 212
 213 extern int signal_pass_state (int);
 214
 215 extern int signal_stop_update (int, int);
 216
 217 extern int signal_print_update (int, int);
 218
 219 extern int signal_pass_update (int, int);
 220
 221 extern void get_last_target_status(ptid_t *ptid,
 222                                    struct target_waitstatus *status);
 223
 224 extern void follow_inferior_reset_breakpoints (void);
 225
 226 /* Throw an error indicating the current thread is running.  */
 227 extern void error_is_running (void);
 228
 229 /* Calls error_is_running if the current thread is running.  */
 230 extern void ensure_not_running (void);
 231
 232 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
 233
 234 /* From infcmd.c */
 235
 236 extern void post_create_inferior (struct target_ops *, int);
 237
 238 extern void attach_command (char *, int);
 239
 240 extern char *get_inferior_args (void);
 241
 242 extern void set_inferior_args (char *);
 243
 244 extern void set_inferior_args_vector (int, char **);
 245
 246 extern void registers_info (char *, int);
 247
 248 extern void nexti_command (char *, int);
 249
 250 extern void stepi_command (char *, int);
 251
 252 extern void continue_1 (int all_threads);
 253
 254 extern void continue_command (char *, int);
 255
 256 extern void interrupt_target_command (char *args, int from_tty);
 257
 258 extern void interrupt_target_1 (int all_threads);
 259
 260 extern void delete_longjmp_breakpoint_cleanup (void *arg);
 261
 262 extern void detach_command (char *, int);
 263
 264 extern void notice_new_inferior (ptid_t, int, int);
 265
 266 /* Address at which inferior stopped.  */
 267
 268 extern CORE_ADDR stop_pc;
 269
 270 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 271
 272 extern enum stop_stack_kind stop_stack_dummy;
 273
 274 /* Nonzero if program stopped due to a random (unexpected) signal in
 275    inferior process.  */
 276
 277 extern int stopped_by_random_signal;
 278
 279 /* STEP_OVER_ALL means step over all subroutine calls.
 280    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 281    STEP_OVER_NONE means don't step over any subroutine calls.  */
 282
 283 enum step_over_calls_kind
 284   {
 285     STEP_OVER_NONE,
 286     STEP_OVER_ALL,
 287     STEP_OVER_UNDEBUGGABLE
 288   };
 289
 290 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 291    will handle it themselves.  STOP_QUIETLY is used when running in
 292    the shell before the child program has been exec'd and when running
 293    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 294    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 295    except that there is no need to hide a signal.  */
 296
 297 /* It is also used after attach, due to attaching to a process.  This
 298    is a bit trickier.  When doing an attach, the kernel stops the
 299    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 300    the handling of SIGSTOP for a ptraced process has changed.  Earlier
 301    versions of the kernel would ignore these SIGSTOPs, while now
 302    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 303
 304    If the gdb user does a 'continue' after the 'attach', gdb passes
 305    the global variable stop_signal (which stores the signal from the
 306    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 307    problematic, because the kernel doesn't ignore such SIGSTOP
 308    now.  I.e. it is reported back to gdb, which in turn presents it
 309    back to the user.
 310
 311    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 312    gdb to clear the value of stop_signal after the attach, so that it
 313    is not passed back down to the kernel.  */
 314
 315 enum stop_kind
 316   {
 317     NO_STOP_QUIETLY = 0,
 318     STOP_QUIETLY,
 319     STOP_QUIETLY_REMOTE,
 320     STOP_QUIETLY_NO_SIGSTOP
 321   };
 322
 323 /* Reverse execution.  */
 324 enum exec_direction_kind
 325   {
 326     EXEC_FORWARD,
 327     EXEC_REVERSE
 328   };
 329
 330 /* The current execution direction.  This should only be set to enum
 331    exec_direction_kind values.  It is only an int to make it
 332    compatible with make_cleanup_restore_integer.  */
 333 extern int execution_direction;
 334
 335 /* Save register contents here when executing a "finish" command or are
 336    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 337    Thus this contains the return value from the called function (assuming
 338    values are returned in a register).  */
 339
 340 extern struct regcache *stop_registers;
 341
 342 /* True if we are debugging displaced stepping.  */
 343 extern int debug_displaced;
 344
 345 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 346 void displaced_step_dump_bytes (struct ui_file *file,
 347                                 const gdb_byte *buf, size_t len);
 348
 349 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
 350 \f
 351 /* Possible values for gdbarch_call_dummy_location.  */
 352 #define ON_STACK 1
 353 #define AT_ENTRY_POINT 4
 354 #define AT_SYMBOL 5
 355
 356 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 357    will attempts to start up the debugee under a shell.
 358    This is in order for argument-expansion to occur.  E.g.,
 359    (gdb) run *
 360    The "*" gets expanded by the shell into a list of files.
 361    While this is a nice feature, it turns out to interact badly
 362    with some of the catch-fork/catch-exec features we have added.
 363    In particular, if the shell does any fork/exec's before
 364    the exec of the target program, that can confuse GDB.
 365    To disable this feature, set STARTUP_WITH_SHELL to 0.
 366    To enable this feature, set STARTUP_WITH_SHELL to 1.
 367    The catch-exec traps expected during start-up will
 368    be 1 if target is not started up with a shell, 2 if it is.
 369    - RT
 370    If you disable this, you need to decrement
 371    START_INFERIOR_TRAPS_EXPECTED in tm.h.  */
 372 #define STARTUP_WITH_SHELL 1
 373 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 374 #define START_INFERIOR_TRAPS_EXPECTED   2
 375 #endif
 376
 377 struct private_inferior;
 378
 379 /* Inferior process specific part of `struct infcall_control_state'.
 380
 381    Inferior thread counterpart is `struct thread_control_state'.  */
 382
 383 struct inferior_control_state
 384 {
 385   /* See the definition of stop_kind above.  */
 386   enum stop_kind stop_soon;
 387 };
 388
 389 /* Inferior process specific part of `struct infcall_suspend_state'.
 390
 391    Inferior thread counterpart is `struct thread_suspend_state'.  */
 392
 393 struct inferior_suspend_state
 394 {
 395 };
 396
 397 /* GDB represents the state of each program execution with an object
 398    called an inferior.  An inferior typically corresponds to a process
 399    but is more general and applies also to targets that do not have a
 400    notion of processes.  Each run of an executable creates a new
 401    inferior, as does each attachment to an existing process.
 402    Inferiors have unique internal identifiers that are different from
 403    target process ids.  Each inferior may in turn have multiple
 404    threads running in it.  */
 405
 406 struct inferior
 407 {
 408   /* Pointer to next inferior in singly-linked list of inferiors.  */
 409   struct inferior *next;
 410
 411   /* Convenient handle (GDB inferior id).  Unique across all
 412      inferiors.  */
 413   int num;
 414
 415   /* Actual target inferior id, usually, a process id.  This matches
 416      the ptid_t.pid member of threads of this inferior.  */
 417   int pid;
 418
 419   /* State of GDB control of inferior process execution.
 420      See `struct inferior_control_state'.  */
 421   struct inferior_control_state control;
 422
 423   /* State of inferior process to restore after GDB is done with an inferior
 424      call.  See `struct inferior_suspend_state'.  */
 425   struct inferior_suspend_state suspend;
 426
 427   /* True if this was an auto-created inferior, e.g. created from
 428      following a fork; false, if this inferior was manually added by
 429      the user, and we should not attempt to prune it
 430      automatically.  */
 431   int removable;
 432
 433   /* The address space bound to this inferior.  */
 434   struct address_space *aspace;
 435
 436   /* The program space bound to this inferior.  */
 437   struct program_space *pspace;
 438
 439   /* The arguments string to use when running.  */
 440   char *args;
 441
 442   /* The size of elements in argv.  */
 443   int argc;
 444
 445   /* The vector version of arguments.  If ARGC is nonzero,
 446      then we must compute ARGS from this (via the target).
 447      This is always coming from main's argv and therefore
 448      should never be freed.  */
 449   char **argv;
 450
 451   /* The name of terminal device to use for I/O.  */
 452   char *terminal;
 453
 454   /* Environment to use for running inferior,
 455      in format described in environ.h.  */
 456   struct gdb_environ *environment;
 457
 458   /* Nonzero if this child process was attached rather than
 459      forked.  */
 460   int attach_flag;
 461
 462   /* If this inferior is a vfork child, then this is the pointer to
 463      its vfork parent, if GDB is still attached to it.  */
 464   struct inferior *vfork_parent;
 465
 466   /* If this process is a vfork parent, this is the pointer to the
 467      child.  Since a vfork parent is left frozen by the kernel until
 468      the child execs or exits, a process can only have one vfork child
 469      at a given time.  */
 470   struct inferior *vfork_child;
 471
 472   /* True if this inferior should be detached when it's vfork sibling
 473      exits or execs.  */
 474   int pending_detach;
 475
 476   /* True if this inferior is a vfork parent waiting for a vfork child
 477      not under our control to be done with the shared memory region,
 478      either by exiting or execing.  */
 479   int waiting_for_vfork_done;
 480
 481   /* True if we're in the process of detaching from this inferior.  */
 482   int detaching;
 483
 484   /* What is left to do for an execution command after any thread of
 485      this inferior stops.  For continuations associated with a
 486      specific thread, see `struct thread_info'.  */
 487   struct continuation *continuations;
 488
 489   /* Private data used by the target vector implementation.  */
 490   struct private_inferior *private;
 491
 492   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 493      In this case, the EXIT_CODE field is also valid.  */
 494   int has_exit_code;
 495   LONGEST exit_code;
 496
 497   /* We keep a count of the number of times the user has requested a
 498      particular syscall to be tracked, and pass this information to the
 499      target.  This lets capable targets implement filtering directly.  */
 500
 501   /* Number of times that "any" syscall is requested.  */
 502   int any_syscall_count;
 503
 504   /* Count of each system call.  */
 505   VEC(int) *syscalls_counts;
 506
 507   /* This counts all syscall catch requests, so we can readily determine
 508      if any catching is necessary.  */
 509   int total_syscalls_count;
 510
 511   /* Per inferior data-pointers required by other GDB modules.  */
 512   void **data;
 513   unsigned num_data;
 514 };
 515
 516 /* Keep a registry of per-inferior data-pointers required by other GDB
 517    modules.  */
 518
 519 extern const struct inferior_data *register_inferior_data (void);
 520 extern const struct inferior_data *register_inferior_data_with_cleanup
 521   (void (*cleanup) (struct inferior *, void *));
 522 extern void clear_inferior_data (struct inferior *inf);
 523 extern void set_inferior_data (struct inferior *inf,
 524                                const struct inferior_data *data, void *value);
 525 extern void *inferior_data (struct inferior *inf,
 526                             const struct inferior_data *data);
 527
 528 /* Create an empty inferior list, or empty the existing one.  */
 529 extern void init_inferior_list (void);
 530
 531 /* Add an inferior to the inferior list, print a message that a new
 532    inferior is found, and return the pointer to the new inferior.
 533    Caller may use this pointer to initialize the private inferior
 534    data.  */
 535 extern struct inferior *add_inferior (int pid);
 536
 537 /* Same as add_inferior, but don't print new inferior notifications to
 538    the CLI.  */
 539 extern struct inferior *add_inferior_silent (int pid);
 540
 541 /* Delete an existing inferior list entry, due to inferior exit.  */
 542 extern void delete_inferior (int pid);
 543
 544 extern void delete_inferior_1 (struct inferior *todel, int silent);
 545
 546 /* Same as delete_inferior, but don't print new inferior notifications
 547    to the CLI.  */
 548 extern void delete_inferior_silent (int pid);
 549
 550 /* Delete an existing inferior list entry, due to inferior detaching.  */
 551 extern void detach_inferior (int pid);
 552
 553 extern void exit_inferior (int pid);
 554
 555 extern void exit_inferior_silent (int pid);
 556
 557 extern void exit_inferior_num_silent (int num);
 558
 559 extern void inferior_appeared (struct inferior *inf, int pid);
 560
 561 /* Get rid of all inferiors.  */
 562 extern void discard_all_inferiors (void);
 563
 564 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 565    into a "pid" (which may be overloaded with extra inferior information).  */
 566 extern int gdb_inferior_id_to_pid (int);
 567
 568 /* Translate a target 'pid' into the integer inferior id (GDB's
 569    homegrown id, not the system's).  */
 570 extern int pid_to_gdb_inferior_id (int pid);
 571
 572 /* Boolean test for an already-known pid.  */
 573 extern int in_inferior_list (int pid);
 574
 575 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 576    not the system's).  */
 577 extern int valid_gdb_inferior_id (int num);
 578
 579 /* Search function to lookup an inferior by target 'pid'.  */
 580 extern struct inferior *find_inferior_pid (int pid);
 581
 582 /* Search function to lookup an inferior by GDB 'num'.  */
 583 extern struct inferior *find_inferior_id (int num);
 584
 585 /* Find an inferior bound to PSPACE.  */
 586 extern struct inferior *
 587   find_inferior_for_program_space (struct program_space *pspace);
 588
 589 /* Inferior iterator function.
 590
 591    Calls a callback function once for each inferior, so long as the
 592    callback function returns false.  If the callback function returns
 593    true, the iteration will end and the current inferior will be
 594    returned.  This can be useful for implementing a search for a
 595    inferior with arbitrary attributes, or for applying some operation
 596    to every inferior.
 597
 598    It is safe to delete the iterated inferior from the callback.  */
 599 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 600                                                          void *),
 601                                                 void *);
 602
 603 /* Returns true if the inferior list is not empty.  */
 604 extern int have_inferiors (void);
 605
 606 /* Returns true if there are any live inferiors in the inferior list
 607    (not cores, not executables, real live processes).  */
 608 extern int have_live_inferiors (void);
 609
 610 /* Return a pointer to the current inferior.  It is an error to call
 611    this if there is no current inferior.  */
 612 extern struct inferior *current_inferior (void);
 613
 614 extern void set_current_inferior (struct inferior *);
 615
 616 extern struct cleanup *save_current_inferior (void);
 617
 618 /* Traverse all inferiors.  */
 619
 620 #define ALL_INFERIORS(I) \
 621   for ((I) = inferior_list; (I); (I) = (I)->next)
 622
 623 extern struct inferior *inferior_list;
 624
 625 /* Prune away automatically added inferiors that aren't required
 626    anymore.  */
 627 extern void prune_inferiors (void);
 628
 629 extern int number_of_inferiors (void);
 630
 631 extern struct inferior *add_inferior_with_spaces (void);
 632
 633 extern void update_observer_mode (void);
 634
 635 #endif /* !defined (INFERIOR_H) */