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