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