gdb/inferior.h

   1 /* Variables that describe the inferior process running under GDB:
   2    Where it is, why it stopped, and how to step it.
   3
   4    Copyright (C) 1986, 1988-1996, 1998-2001, 2003-2012 Free Software
   5    Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (INFERIOR_H)
  23 #define INFERIOR_H 1
  24
  25 struct target_waitstatus;
  26 struct frame_info;
  27 struct ui_file;
  28 struct type;
  29 struct gdbarch;
  30 struct regcache;
  31 struct ui_out;
  32 struct terminal_info;
  33
  34 #include "ptid.h"
  35
  36 /* For bpstat.  */
  37 #include "breakpoint.h"
  38
  39 /* For enum gdb_signal.  */
  40 #include "target.h"
  41
  42 /* For struct frame_id.  */
  43 #include "frame.h"
  44
  45 #include "progspace.h"
  46 #include "registry.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 gdb_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 reopen_exec_file (void);
 159
 160 /* The `resume' routine should only be called in special circumstances.
 161    Normally, use `proceed', which handles a lot of bookkeeping.  */
 162
 163 extern void resume (int, enum gdb_signal);
 164
 165 extern ptid_t user_visible_resume_ptid (int step);
 166
 167 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 168                                                   struct symtab_and_line ,
 169                                                   struct frame_id);
 170
 171 /* From misc files */
 172
 173 extern void default_print_registers_info (struct gdbarch *gdbarch,
 174                                           struct ui_file *file,
 175                                           struct frame_info *frame,
 176                                           int regnum, int all);
 177
 178 extern void child_terminal_info (char *, int);
 179
 180 extern void term_info (char *, int);
 181
 182 extern void terminal_ours_for_output (void);
 183
 184 extern void terminal_inferior (void);
 185
 186 extern void terminal_init_inferior (void);
 187
 188 extern void terminal_init_inferior_with_pgrp (int pgrp);
 189
 190 /* From fork-child.c */
 191
 192 extern int fork_inferior (char *, char *, char **,
 193                           void (*)(void),
 194                           void (*)(int), void (*)(void), char *,
 195                           void (*)(const char *,
 196                                    char * const *, char * const *));
 197
 198
 199 extern void startup_inferior (int);
 200
 201 extern char *construct_inferior_arguments (int, char **);
 202
 203 /* From infrun.c */
 204
 205 extern unsigned int debug_infrun;
 206
 207 extern int stop_on_solib_events;
 208
 209 extern void start_remote (int from_tty);
 210
 211 extern void normal_stop (void);
 212
 213 extern int signal_stop_state (int);
 214
 215 extern int signal_print_state (int);
 216
 217 extern int signal_pass_state (int);
 218
 219 extern int signal_stop_update (int, int);
 220
 221 extern int signal_print_update (int, int);
 222
 223 extern int signal_pass_update (int, int);
 224
 225 extern void get_last_target_status(ptid_t *ptid,
 226                                    struct target_waitstatus *status);
 227
 228 extern void follow_inferior_reset_breakpoints (void);
 229
 230 /* Throw an error indicating the current thread is running.  */
 231 extern void error_is_running (void);
 232
 233 /* Calls error_is_running if the current thread is running.  */
 234 extern void ensure_not_running (void);
 235
 236 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
 237
 238 /* From infcmd.c */
 239
 240 extern void post_create_inferior (struct target_ops *, int);
 241
 242 extern void attach_command (char *, int);
 243
 244 extern char *get_inferior_args (void);
 245
 246 extern void set_inferior_args (char *);
 247
 248 extern void set_inferior_args_vector (int, char **);
 249
 250 extern void all_registers_info (char *, int);
 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 value *function,
 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
 364 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 365    will attempts to start up the debugee under a shell.
 366    This is in order for argument-expansion to occur.  E.g.,
 367    (gdb) run *
 368    The "*" gets expanded by the shell into a list of files.
 369    While this is a nice feature, it turns out to interact badly
 370    with some of the catch-fork/catch-exec features we have added.
 371    In particular, if the shell does any fork/exec's before
 372    the exec of the target program, that can confuse GDB.
 373    To disable this feature, set STARTUP_WITH_SHELL to 0.
 374    To enable this feature, set STARTUP_WITH_SHELL to 1.
 375    The catch-exec traps expected during start-up will
 376    be 1 if target is not started up with a shell, 2 if it is.
 377    - RT
 378    If you disable this, you need to decrement
 379    START_INFERIOR_TRAPS_EXPECTED in tm.h.  */
 380 #define STARTUP_WITH_SHELL 1
 381 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 382 #define START_INFERIOR_TRAPS_EXPECTED   2
 383 #endif
 384
 385 struct private_inferior;
 386
 387 /* Inferior process specific part of `struct infcall_control_state'.
 388
 389    Inferior thread counterpart is `struct thread_control_state'.  */
 390
 391 struct inferior_control_state
 392 {
 393   /* See the definition of stop_kind above.  */
 394   enum stop_kind stop_soon;
 395 };
 396
 397 /* Inferior process specific part of `struct infcall_suspend_state'.
 398
 399    Inferior thread counterpart is `struct thread_suspend_state'.  */
 400
 401 #if 0 /* Currently unused and empty structures are not valid C.  */
 402 struct inferior_suspend_state
 403 {
 404 };
 405 #endif
 406
 407 /* GDB represents the state of each program execution with an object
 408    called an inferior.  An inferior typically corresponds to a process
 409    but is more general and applies also to targets that do not have a
 410    notion of processes.  Each run of an executable creates a new
 411    inferior, as does each attachment to an existing process.
 412    Inferiors have unique internal identifiers that are different from
 413    target process ids.  Each inferior may in turn have multiple
 414    threads running in it.  */
 415
 416 struct inferior
 417 {
 418   /* Pointer to next inferior in singly-linked list of inferiors.  */
 419   struct inferior *next;
 420
 421   /* Convenient handle (GDB inferior id).  Unique across all
 422      inferiors.  */
 423   int num;
 424
 425   /* Actual target inferior id, usually, a process id.  This matches
 426      the ptid_t.pid member of threads of this inferior.  */
 427   int pid;
 428   /* True if the PID was actually faked by GDB.  */
 429   int fake_pid_p;
 430
 431   /* State of GDB control of inferior process execution.
 432      See `struct inferior_control_state'.  */
 433   struct inferior_control_state control;
 434
 435   /* State of inferior process to restore after GDB is done with an inferior
 436      call.  See `struct inferior_suspend_state'.  */
 437 #if 0 /* Currently unused and empty structures are not valid C.  */
 438   struct inferior_suspend_state suspend;
 439 #endif
 440
 441   /* True if this was an auto-created inferior, e.g. created from
 442      following a fork; false, if this inferior was manually added by
 443      the user, and we should not attempt to prune it
 444      automatically.  */
 445   int removable;
 446
 447   /* The address space bound to this inferior.  */
 448   struct address_space *aspace;
 449
 450   /* The program space bound to this inferior.  */
 451   struct program_space *pspace;
 452
 453   /* The arguments string to use when running.  */
 454   char *args;
 455
 456   /* The size of elements in argv.  */
 457   int argc;
 458
 459   /* The vector version of arguments.  If ARGC is nonzero,
 460      then we must compute ARGS from this (via the target).
 461      This is always coming from main's argv and therefore
 462      should never be freed.  */
 463   char **argv;
 464
 465   /* The name of terminal device to use for I/O.  */
 466   char *terminal;
 467
 468   /* Environment to use for running inferior,
 469      in format described in environ.h.  */
 470   struct gdb_environ *environment;
 471
 472   /* Nonzero if this child process was attached rather than
 473      forked.  */
 474   int attach_flag;
 475
 476   /* If this inferior is a vfork child, then this is the pointer to
 477      its vfork parent, if GDB is still attached to it.  */
 478   struct inferior *vfork_parent;
 479
 480   /* If this process is a vfork parent, this is the pointer to the
 481      child.  Since a vfork parent is left frozen by the kernel until
 482      the child execs or exits, a process can only have one vfork child
 483      at a given time.  */
 484   struct inferior *vfork_child;
 485
 486   /* True if this inferior should be detached when it's vfork sibling
 487      exits or execs.  */
 488   int pending_detach;
 489
 490   /* True if this inferior is a vfork parent waiting for a vfork child
 491      not under our control to be done with the shared memory region,
 492      either by exiting or execing.  */
 493   int waiting_for_vfork_done;
 494
 495   /* True if we're in the process of detaching from this inferior.  */
 496   int detaching;
 497
 498   /* What is left to do for an execution command after any thread of
 499      this inferior stops.  For continuations associated with a
 500      specific thread, see `struct thread_info'.  */
 501   struct continuation *continuations;
 502
 503   /* Private data used by the target vector implementation.  */
 504   struct private_inferior *private;
 505
 506   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 507      In this case, the EXIT_CODE field is also valid.  */
 508   int has_exit_code;
 509   LONGEST exit_code;
 510
 511   /* Default flags to pass to the symbol reading functions.  These are
 512      used whenever a new objfile is created.  The valid values come
 513      from enum symfile_add_flags.  */
 514   int symfile_flags;
 515
 516   /* Per inferior data-pointers required by other GDB modules.  */
 517   REGISTRY_FIELDS;
 518 };
 519
 520 /* Keep a registry of per-inferior data-pointers required by other GDB
 521    modules.  */
 522
 523 DECLARE_REGISTRY (inferior);
 524
 525 /* Create an empty inferior list, or empty the existing one.  */
 526 extern void init_inferior_list (void);
 527
 528 /* Add an inferior to the inferior list, print a message that a new
 529    inferior is found, and return the pointer to the new inferior.
 530    Caller may use this pointer to initialize the private inferior
 531    data.  */
 532 extern struct inferior *add_inferior (int pid);
 533
 534 /* Same as add_inferior, but don't print new inferior notifications to
 535    the CLI.  */
 536 extern struct inferior *add_inferior_silent (int pid);
 537
 538 /* Delete an existing inferior list entry, due to inferior exit.  */
 539 extern void delete_inferior (int pid);
 540
 541 extern void delete_inferior_1 (struct inferior *todel, int silent);
 542
 543 /* Same as delete_inferior, but don't print new inferior notifications
 544    to the CLI.  */
 545 extern void delete_inferior_silent (int pid);
 546
 547 /* Delete an existing inferior list entry, due to inferior detaching.  */
 548 extern void detach_inferior (int pid);
 549
 550 extern void exit_inferior (int pid);
 551
 552 extern void exit_inferior_silent (int pid);
 553
 554 extern void exit_inferior_num_silent (int num);
 555
 556 extern void inferior_appeared (struct inferior *inf, int pid);
 557
 558 /* Get rid of all inferiors.  */
 559 extern void discard_all_inferiors (void);
 560
 561 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 562    into a "pid" (which may be overloaded with extra inferior information).  */
 563 extern int gdb_inferior_id_to_pid (int);
 564
 565 /* Translate a target 'pid' into the integer inferior id (GDB's
 566    homegrown id, not the system's).  */
 567 extern int pid_to_gdb_inferior_id (int pid);
 568
 569 /* Boolean test for an already-known pid.  */
 570 extern int in_inferior_list (int pid);
 571
 572 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 573    not the system's).  */
 574 extern int valid_gdb_inferior_id (int num);
 575
 576 /* Search function to lookup an inferior by target 'pid'.  */
 577 extern struct inferior *find_inferior_pid (int pid);
 578
 579 /* Search function to lookup an inferior by GDB 'num'.  */
 580 extern struct inferior *find_inferior_id (int num);
 581
 582 /* Find an inferior bound to PSPACE.  */
 583 extern struct inferior *
 584   find_inferior_for_program_space (struct program_space *pspace);
 585
 586 /* Inferior iterator function.
 587
 588    Calls a callback function once for each inferior, so long as the
 589    callback function returns false.  If the callback function returns
 590    true, the iteration will end and the current inferior will be
 591    returned.  This can be useful for implementing a search for a
 592    inferior with arbitrary attributes, or for applying some operation
 593    to every inferior.
 594
 595    It is safe to delete the iterated inferior from the callback.  */
 596 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 597                                                          void *),
 598                                                 void *);
 599
 600 /* Returns true if the inferior list is not empty.  */
 601 extern int have_inferiors (void);
 602
 603 /* Returns true if there are any live inferiors in the inferior list
 604    (not cores, not executables, real live processes).  */
 605 extern int have_live_inferiors (void);
 606
 607 /* Return a pointer to the current inferior.  It is an error to call
 608    this if there is no current inferior.  */
 609 extern struct inferior *current_inferior (void);
 610
 611 extern void set_current_inferior (struct inferior *);
 612
 613 extern struct cleanup *save_current_inferior (void);
 614
 615 /* Traverse all inferiors.  */
 616
 617 #define ALL_INFERIORS(I) \
 618   for ((I) = inferior_list; (I); (I) = (I)->next)
 619
 620 extern struct inferior *inferior_list;
 621
 622 /* Prune away automatically added inferiors that aren't required
 623    anymore.  */
 624 extern void prune_inferiors (void);
 625
 626 extern int number_of_inferiors (void);
 627
 628 extern struct inferior *add_inferior_with_spaces (void);
 629
 630 extern void update_observer_mode (void);
 631
 632 extern void update_signals_program_target (void);
 633
 634 /* In some circumstances we allow a command to specify a numeric
 635    signal.  The idea is to keep these circumstances limited so that
 636    users (and scripts) develop portable habits.  For comparison,
 637    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
 638    numeric signal at all is obsolescent.  We are slightly more lenient
 639    and allow 1-15 which should match host signal numbers on most
 640    systems.  Use of symbolic signal names is strongly encouraged.  */
 641
 642 enum gdb_signal gdb_signal_from_command (int num);
 643
 644 #endif /* !defined (INFERIOR_H) */