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