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