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 struct target_desc_info;
  34
  35 #include "ptid.h"
  36
  37 /* For bpstat.  */
  38 #include "breakpoint.h"
  39
  40 /* For enum gdb_signal.  */
  41 #include "target.h"
  42
  43 /* For struct frame_id.  */
  44 #include "frame.h"
  45
  46 #include "progspace.h"
  47 #include "registry.h"
  48
  49 struct infcall_suspend_state;
  50 struct infcall_control_state;
  51
  52 extern struct infcall_suspend_state *save_infcall_suspend_state (void);
  53 extern struct infcall_control_state *save_infcall_control_state (void);
  54
  55 extern void restore_infcall_suspend_state (struct infcall_suspend_state *);
  56 extern void restore_infcall_control_state (struct infcall_control_state *);
  57
  58 extern struct cleanup *make_cleanup_restore_infcall_suspend_state
  59                                             (struct infcall_suspend_state *);
  60 extern struct cleanup *make_cleanup_restore_infcall_control_state
  61                                             (struct infcall_control_state *);
  62
  63 extern void discard_infcall_suspend_state (struct infcall_suspend_state *);
  64 extern void discard_infcall_control_state (struct infcall_control_state *);
  65
  66 extern struct regcache *
  67   get_infcall_suspend_state_regcache (struct infcall_suspend_state *);
  68
  69 /* Returns true if PTID matches filter FILTER.  FILTER can be the wild
  70    card MINUS_ONE_PTID (all ptid match it); can be a ptid representing
  71    a process (ptid_is_pid returns true), in which case, all lwps and
  72    threads of that given process match, lwps and threads of other
  73    processes do not; or, it can represent a specific thread, in which
  74    case, only that thread will match true.  PTID must represent a
  75    specific LWP or THREAD, it can never be a wild card.  */
  76
  77 extern int ptid_match (ptid_t ptid, ptid_t filter);
  78
  79 /* Save value of inferior_ptid so that it may be restored by
  80    a later call to do_cleanups().  Returns the struct cleanup
  81    pointer needed for later doing the cleanup.  */
  82 extern struct cleanup * save_inferior_ptid (void);
  83
  84 extern void set_sigint_trap (void);
  85
  86 extern void clear_sigint_trap (void);
  87
  88 /* Set/get file name for default use for standard in/out in the inferior.  */
  89
  90 extern void set_inferior_io_terminal (const char *terminal_name);
  91 extern const char *get_inferior_io_terminal (void);
  92
  93 /* Collected pid, tid, etc. of the debugged inferior.  When there's
  94    no inferior, PIDGET (inferior_ptid) will be 0.  */
  95
  96 extern ptid_t inferior_ptid;
  97
  98 /* Are we simulating synchronous execution? This is used in async gdb
  99    to implement the 'run', 'continue' etc commands, which will not
 100    redisplay the prompt until the execution is actually over.  */
 101 extern int sync_execution;
 102
 103 /* Inferior environment.  */
 104
 105 extern void clear_proceed_status (void);
 106
 107 extern void proceed (CORE_ADDR, enum gdb_signal, int);
 108
 109 extern int sched_multi;
 110
 111 /* When set, stop the 'step' command if we enter a function which has
 112    no line number information.  The normal behavior is that we step
 113    over such function.  */
 114 extern int step_stop_if_no_debug;
 115
 116 /* If set, the inferior should be controlled in non-stop mode.  In
 117    this mode, each thread is controlled independently.  Execution
 118    commands apply only to the selected thread by default, and stop
 119    events stop only the thread that had the event -- the other threads
 120    are kept running freely.  */
 121 extern int non_stop;
 122
 123 /* If set (default), when following a fork, GDB will detach from one
 124    the fork branches, child or parent.  Exactly which branch is
 125    detached depends on 'set follow-fork-mode' setting.  */
 126 extern int detach_fork;
 127
 128 /* When set (default), the target should attempt to disable the operating
 129    system's address space randomization feature when starting an inferior.  */
 130 extern int disable_randomization;
 131
 132 extern void generic_mourn_inferior (void);
 133
 134 extern void terminal_save_ours (void);
 135
 136 extern void terminal_ours (void);
 137
 138 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch,
 139                                               struct type *type,
 140                                               const gdb_byte *buf);
 141 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch,
 142                                          struct type *type, gdb_byte *buf,
 143                                          CORE_ADDR addr);
 144 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch,
 145                                             struct type *type,
 146                                             const gdb_byte *buf);
 147 extern void address_to_signed_pointer (struct gdbarch *gdbarch,
 148                                        struct type *type, gdb_byte *buf,
 149                                        CORE_ADDR addr);
 150
 151 extern void wait_for_inferior (void);
 152
 153 extern void prepare_for_detach (void);
 154
 155 extern void fetch_inferior_event (void *);
 156
 157 extern void init_wait_for_inferior (void);
 158
 159 extern void reopen_exec_file (void);
 160
 161 /* The `resume' routine should only be called in special circumstances.
 162    Normally, use `proceed', which handles a lot of bookkeeping.  */
 163
 164 extern void resume (int, enum gdb_signal);
 165
 166 extern ptid_t user_visible_resume_ptid (int step);
 167
 168 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 169                                                   struct symtab_and_line ,
 170                                                   struct frame_id);
 171
 172 /* From misc files */
 173
 174 extern void default_print_registers_info (struct gdbarch *gdbarch,
 175                                           struct ui_file *file,
 176                                           struct frame_info *frame,
 177                                           int regnum, int all);
 178
 179 extern void child_terminal_info (char *, int);
 180
 181 extern void term_info (char *, int);
 182
 183 extern void terminal_ours_for_output (void);
 184
 185 extern void terminal_inferior (void);
 186
 187 extern void terminal_init_inferior (void);
 188
 189 extern void terminal_init_inferior_with_pgrp (int pgrp);
 190
 191 /* From fork-child.c */
 192
 193 extern int fork_inferior (char *, char *, char **,
 194                           void (*)(void),
 195                           void (*)(int), void (*)(void), char *,
 196                           void (*)(const char *,
 197                                    char * const *, char * const *));
 198
 199
 200 extern void startup_inferior (int);
 201
 202 extern char *construct_inferior_arguments (int, char **);
 203
 204 /* From infrun.c */
 205
 206 extern unsigned int debug_infrun;
 207
 208 extern int stop_on_solib_events;
 209
 210 extern void start_remote (int from_tty);
 211
 212 extern void normal_stop (void);
 213
 214 extern int signal_stop_state (int);
 215
 216 extern int signal_print_state (int);
 217
 218 extern int signal_pass_state (int);
 219
 220 extern int signal_stop_update (int, int);
 221
 222 extern int signal_print_update (int, int);
 223
 224 extern int signal_pass_update (int, int);
 225
 226 extern void get_last_target_status(ptid_t *ptid,
 227                                    struct target_waitstatus *status);
 228
 229 extern void follow_inferior_reset_breakpoints (void);
 230
 231 void set_step_info (struct frame_info *frame, struct symtab_and_line sal);
 232
 233 /* From infcmd.c */
 234
 235 extern void post_create_inferior (struct target_ops *, int);
 236
 237 extern void attach_command (char *, int);
 238
 239 extern char *get_inferior_args (void);
 240
 241 extern void set_inferior_args (char *);
 242
 243 extern void set_inferior_args_vector (int, char **);
 244
 245 extern void all_registers_info (char *, int);
 246
 247 extern void registers_info (char *, int);
 248
 249 extern void nexti_command (char *, int);
 250
 251 extern void stepi_command (char *, int);
 252
 253 extern void continue_1 (int all_threads);
 254
 255 extern void continue_command (char *, int);
 256
 257 extern void interrupt_target_command (char *args, int from_tty);
 258
 259 extern void interrupt_target_1 (int all_threads);
 260
 261 extern void delete_longjmp_breakpoint_cleanup (void *arg);
 262
 263 extern void detach_command (char *, int);
 264
 265 extern void notice_new_inferior (ptid_t, int, int);
 266
 267 extern struct value *get_return_value (struct value *function,
 268                                        struct type *value_type);
 269
 270 /* Address at which inferior stopped.  */
 271
 272 extern CORE_ADDR stop_pc;
 273
 274 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 275
 276 extern enum stop_stack_kind stop_stack_dummy;
 277
 278 /* Nonzero if program stopped due to a random (unexpected) signal in
 279    inferior process.  */
 280
 281 extern int stopped_by_random_signal;
 282
 283 /* STEP_OVER_ALL means step over all subroutine calls.
 284    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 285    STEP_OVER_NONE means don't step over any subroutine calls.  */
 286
 287 enum step_over_calls_kind
 288   {
 289     STEP_OVER_NONE,
 290     STEP_OVER_ALL,
 291     STEP_OVER_UNDEBUGGABLE
 292   };
 293
 294 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 295    will handle it themselves.  STOP_QUIETLY is used when running in
 296    the shell before the child program has been exec'd and when running
 297    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 298    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 299    except that there is no need to hide a signal.  */
 300
 301 /* It is also used after attach, due to attaching to a process.  This
 302    is a bit trickier.  When doing an attach, the kernel stops the
 303    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 304    the handling of SIGSTOP for a ptraced process has changed.  Earlier
 305    versions of the kernel would ignore these SIGSTOPs, while now
 306    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 307
 308    If the gdb user does a 'continue' after the 'attach', gdb passes
 309    the global variable stop_signal (which stores the signal from the
 310    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 311    problematic, because the kernel doesn't ignore such SIGSTOP
 312    now.  I.e. it is reported back to gdb, which in turn presents it
 313    back to the user.
 314
 315    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 316    gdb to clear the value of stop_signal after the attach, so that it
 317    is not passed back down to the kernel.  */
 318
 319 enum stop_kind
 320   {
 321     NO_STOP_QUIETLY = 0,
 322     STOP_QUIETLY,
 323     STOP_QUIETLY_REMOTE,
 324     STOP_QUIETLY_NO_SIGSTOP
 325   };
 326
 327 /* Reverse execution.  */
 328 enum exec_direction_kind
 329   {
 330     EXEC_FORWARD,
 331     EXEC_REVERSE
 332   };
 333
 334 /* The current execution direction.  This should only be set to enum
 335    exec_direction_kind values.  It is only an int to make it
 336    compatible with make_cleanup_restore_integer.  */
 337 extern int execution_direction;
 338
 339 /* Save register contents here when executing a "finish" command or are
 340    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 341    Thus this contains the return value from the called function (assuming
 342    values are returned in a register).  */
 343
 344 extern struct regcache *stop_registers;
 345
 346 /* True if we are debugging displaced stepping.  */
 347 extern int debug_displaced;
 348
 349 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 350 void displaced_step_dump_bytes (struct ui_file *file,
 351                                 const gdb_byte *buf, size_t len);
 352
 353 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
 354 \f
 355 /* Possible values for gdbarch_call_dummy_location.  */
 356 #define ON_STACK 1
 357 #define AT_ENTRY_POINT 4
 358
 359 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 360    will attempts to start up the debugee under a shell.
 361    This is in order for argument-expansion to occur.  E.g.,
 362    (gdb) run *
 363    The "*" gets expanded by the shell into a list of files.
 364    While this is a nice feature, it turns out to interact badly
 365    with some of the catch-fork/catch-exec features we have added.
 366    In particular, if the shell does any fork/exec's before
 367    the exec of the target program, that can confuse GDB.
 368    To disable this feature, set STARTUP_WITH_SHELL to 0.
 369    To enable this feature, set STARTUP_WITH_SHELL to 1.
 370    The catch-exec traps expected during start-up will
 371    be 1 if target is not started up with a shell, 2 if it is.
 372    - RT
 373    If you disable this, you need to decrement
 374    START_INFERIOR_TRAPS_EXPECTED in tm.h.  */
 375 #define STARTUP_WITH_SHELL 1
 376 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 377 #define START_INFERIOR_TRAPS_EXPECTED   2
 378 #endif
 379
 380 struct private_inferior;
 381
 382 /* Inferior process specific part of `struct infcall_control_state'.
 383
 384    Inferior thread counterpart is `struct thread_control_state'.  */
 385
 386 struct inferior_control_state
 387 {
 388   /* See the definition of stop_kind above.  */
 389   enum stop_kind stop_soon;
 390 };
 391
 392 /* Inferior process specific part of `struct infcall_suspend_state'.
 393
 394    Inferior thread counterpart is `struct thread_suspend_state'.  */
 395
 396 #if 0 /* Currently unused and empty structures are not valid C.  */
 397 struct inferior_suspend_state
 398 {
 399 };
 400 #endif
 401
 402 /* GDB represents the state of each program execution with an object
 403    called an inferior.  An inferior typically corresponds to a process
 404    but is more general and applies also to targets that do not have a
 405    notion of processes.  Each run of an executable creates a new
 406    inferior, as does each attachment to an existing process.
 407    Inferiors have unique internal identifiers that are different from
 408    target process ids.  Each inferior may in turn have multiple
 409    threads running in it.  */
 410
 411 struct inferior
 412 {
 413   /* Pointer to next inferior in singly-linked list of inferiors.  */
 414   struct inferior *next;
 415
 416   /* Convenient handle (GDB inferior id).  Unique across all
 417      inferiors.  */
 418   int num;
 419
 420   /* Actual target inferior id, usually, a process id.  This matches
 421      the ptid_t.pid member of threads of this inferior.  */
 422   int pid;
 423   /* True if the PID was actually faked by GDB.  */
 424   int fake_pid_p;
 425
 426   /* State of GDB control of inferior process execution.
 427      See `struct inferior_control_state'.  */
 428   struct inferior_control_state control;
 429
 430   /* State of inferior process to restore after GDB is done with an inferior
 431      call.  See `struct inferior_suspend_state'.  */
 432 #if 0 /* Currently unused and empty structures are not valid C.  */
 433   struct inferior_suspend_state suspend;
 434 #endif
 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   /* Default flags to pass to the symbol reading functions.  These are
 507      used whenever a new objfile is created.  The valid values come
 508      from enum symfile_add_flags.  */
 509   int symfile_flags;
 510
 511   /* Info about an inferior's target description (if it's fetched; the
 512      user supplied description's filename, if any; etc.).  */
 513   struct target_desc_info *tdesc_info;
 514
 515   /* The architecture associated with the inferior through the
 516      connection to the target.
 517
 518      The architecture vector provides some information that is really
 519      a property of the inferior, accessed through a particular target:
 520      ptrace operations; the layout of certain RSP packets; the
 521      solib_ops vector; etc.  To differentiate architecture accesses to
 522      per-inferior/target properties from
 523      per-thread/per-frame/per-objfile properties, accesses to
 524      per-inferior/target properties should be made through
 525      this gdbarch.  */
 526   struct gdbarch *gdbarch;
 527
 528   /* Per inferior data-pointers required by other GDB modules.  */
 529   REGISTRY_FIELDS;
 530 };
 531
 532 /* Keep a registry of per-inferior data-pointers required by other GDB
 533    modules.  */
 534
 535 DECLARE_REGISTRY (inferior);
 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 extern void update_signals_program_target (void);
 645
 646 /* In some circumstances we allow a command to specify a numeric
 647    signal.  The idea is to keep these circumstances limited so that
 648    users (and scripts) develop portable habits.  For comparison,
 649    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
 650    numeric signal at all is obsolescent.  We are slightly more lenient
 651    and allow 1-15 which should match host signal numbers on most
 652    systems.  Use of symbolic signal names is strongly encouraged.  */
 653
 654 enum gdb_signal gdb_signal_from_command (int num);
 655
 656 #endif /* !defined (INFERIOR_H) */