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