gdb/inferior.h

   1 /* Variables that describe the inferior process running under GDB:
   2    Where it is, why it stopped, and how to step it.
   3
   4    Copyright (C) 1986, 1988-1996, 1998-2001, 2003-2012 Free Software
   5    Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (INFERIOR_H)
  23 #define INFERIOR_H 1
  24
  25 struct target_waitstatus;
  26 struct frame_info;
  27 struct ui_file;
  28 struct type;
  29 struct gdbarch;
  30 struct regcache;
  31 struct ui_out;
  32 struct terminal_info;
  33
  34 #include "ptid.h"
  35
  36 /* For bpstat.  */
  37 #include "breakpoint.h"
  38
  39 /* For enum gdb_signal.  */
  40 #include "target.h"
  41
  42 /* For struct frame_id.  */
  43 #include "frame.h"
  44
  45 #include "progspace.h"
  46
  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 gdb_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 gdb_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 all_registers_info (char *, int);
 250
 251 extern void registers_info (char *, int);
 252
 253 extern void nexti_command (char *, int);
 254
 255 extern void stepi_command (char *, int);
 256
 257 extern void continue_1 (int all_threads);
 258
 259 extern void continue_command (char *, int);
 260
 261 extern void interrupt_target_command (char *args, int from_tty);
 262
 263 extern void interrupt_target_1 (int all_threads);
 264
 265 extern void delete_longjmp_breakpoint_cleanup (void *arg);
 266
 267 extern void detach_command (char *, int);
 268
 269 extern void notice_new_inferior (ptid_t, int, int);
 270
 271 extern struct value *get_return_value (struct value *function,
 272                                        struct type *value_type);
 273
 274 /* Address at which inferior stopped.  */
 275
 276 extern CORE_ADDR stop_pc;
 277
 278 /* Nonzero if stopped due to completion of a stack dummy routine.  */
 279
 280 extern enum stop_stack_kind stop_stack_dummy;
 281
 282 /* Nonzero if program stopped due to a random (unexpected) signal in
 283    inferior process.  */
 284
 285 extern int stopped_by_random_signal;
 286
 287 /* STEP_OVER_ALL means step over all subroutine calls.
 288    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
 289    STEP_OVER_NONE means don't step over any subroutine calls.  */
 290
 291 enum step_over_calls_kind
 292   {
 293     STEP_OVER_NONE,
 294     STEP_OVER_ALL,
 295     STEP_OVER_UNDEBUGGABLE
 296   };
 297
 298 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
 299    will handle it themselves.  STOP_QUIETLY is used when running in
 300    the shell before the child program has been exec'd and when running
 301    through shared library loading.  STOP_QUIETLY_REMOTE is used when
 302    setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
 303    except that there is no need to hide a signal.  */
 304
 305 /* It is also used after attach, due to attaching to a process.  This
 306    is a bit trickier.  When doing an attach, the kernel stops the
 307    debuggee with a SIGSTOP.  On newer GNU/Linux kernels (>= 2.5.61)
 308    the handling of SIGSTOP for a ptraced process has changed.  Earlier
 309    versions of the kernel would ignore these SIGSTOPs, while now
 310    SIGSTOP is treated like any other signal, i.e. it is not muffled.
 311
 312    If the gdb user does a 'continue' after the 'attach', gdb passes
 313    the global variable stop_signal (which stores the signal from the
 314    attach, SIGSTOP) to the ptrace(PTRACE_CONT,...)  call.  This is
 315    problematic, because the kernel doesn't ignore such SIGSTOP
 316    now.  I.e. it is reported back to gdb, which in turn presents it
 317    back to the user.
 318
 319    To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
 320    gdb to clear the value of stop_signal after the attach, so that it
 321    is not passed back down to the kernel.  */
 322
 323 enum stop_kind
 324   {
 325     NO_STOP_QUIETLY = 0,
 326     STOP_QUIETLY,
 327     STOP_QUIETLY_REMOTE,
 328     STOP_QUIETLY_NO_SIGSTOP
 329   };
 330
 331 /* Reverse execution.  */
 332 enum exec_direction_kind
 333   {
 334     EXEC_FORWARD,
 335     EXEC_REVERSE
 336   };
 337
 338 /* The current execution direction.  This should only be set to enum
 339    exec_direction_kind values.  It is only an int to make it
 340    compatible with make_cleanup_restore_integer.  */
 341 extern int execution_direction;
 342
 343 /* Save register contents here when executing a "finish" command or are
 344    about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set.
 345    Thus this contains the return value from the called function (assuming
 346    values are returned in a register).  */
 347
 348 extern struct regcache *stop_registers;
 349
 350 /* True if we are debugging displaced stepping.  */
 351 extern int debug_displaced;
 352
 353 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 354 void displaced_step_dump_bytes (struct ui_file *file,
 355                                 const gdb_byte *buf, size_t len);
 356
 357 struct displaced_step_closure *get_displaced_step_closure_by_addr (CORE_ADDR addr);
 358 \f
 359 /* Possible values for gdbarch_call_dummy_location.  */
 360 #define ON_STACK 1
 361 #define AT_ENTRY_POINT 4
 362
 363 /* If STARTUP_WITH_SHELL is set, GDB's "run"
 364    will attempts to start up the debugee under a shell.
 365    This is in order for argument-expansion to occur.  E.g.,
 366    (gdb) run *
 367    The "*" gets expanded by the shell into a list of files.
 368    While this is a nice feature, it turns out to interact badly
 369    with some of the catch-fork/catch-exec features we have added.
 370    In particular, if the shell does any fork/exec's before
 371    the exec of the target program, that can confuse GDB.
 372    To disable this feature, set STARTUP_WITH_SHELL to 0.
 373    To enable this feature, set STARTUP_WITH_SHELL to 1.
 374    The catch-exec traps expected during start-up will
 375    be 1 if target is not started up with a shell, 2 if it is.
 376    - RT
 377    If you disable this, you need to decrement
 378    START_INFERIOR_TRAPS_EXPECTED in tm.h.  */
 379 #define STARTUP_WITH_SHELL 1
 380 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
 381 #define START_INFERIOR_TRAPS_EXPECTED   2
 382 #endif
 383
 384 struct private_inferior;
 385
 386 /* Inferior process specific part of `struct infcall_control_state'.
 387
 388    Inferior thread counterpart is `struct thread_control_state'.  */
 389
 390 struct inferior_control_state
 391 {
 392   /* See the definition of stop_kind above.  */
 393   enum stop_kind stop_soon;
 394 };
 395
 396 /* Inferior process specific part of `struct infcall_suspend_state'.
 397
 398    Inferior thread counterpart is `struct thread_suspend_state'.  */
 399
 400 #if 0 /* Currently unused and empty structures are not valid C.  */
 401 struct inferior_suspend_state
 402 {
 403 };
 404 #endif
 405
 406 /* GDB represents the state of each program execution with an object
 407    called an inferior.  An inferior typically corresponds to a process
 408    but is more general and applies also to targets that do not have a
 409    notion of processes.  Each run of an executable creates a new
 410    inferior, as does each attachment to an existing process.
 411    Inferiors have unique internal identifiers that are different from
 412    target process ids.  Each inferior may in turn have multiple
 413    threads running in it.  */
 414
 415 struct inferior
 416 {
 417   /* Pointer to next inferior in singly-linked list of inferiors.  */
 418   struct inferior *next;
 419
 420   /* Convenient handle (GDB inferior id).  Unique across all
 421      inferiors.  */
 422   int num;
 423
 424   /* Actual target inferior id, usually, a process id.  This matches
 425      the ptid_t.pid member of threads of this inferior.  */
 426   int pid;
 427   /* True if the PID was actually faked by GDB.  */
 428   int fake_pid_p;
 429
 430   /* State of GDB control of inferior process execution.
 431      See `struct inferior_control_state'.  */
 432   struct inferior_control_state control;
 433
 434   /* State of inferior process to restore after GDB is done with an inferior
 435      call.  See `struct inferior_suspend_state'.  */
 436 #if 0 /* Currently unused and empty structures are not valid C.  */
 437   struct inferior_suspend_state suspend;
 438 #endif
 439
 440   /* True if this was an auto-created inferior, e.g. created from
 441      following a fork; false, if this inferior was manually added by
 442      the user, and we should not attempt to prune it
 443      automatically.  */
 444   int removable;
 445
 446   /* The address space bound to this inferior.  */
 447   struct address_space *aspace;
 448
 449   /* The program space bound to this inferior.  */
 450   struct program_space *pspace;
 451
 452   /* The arguments string to use when running.  */
 453   char *args;
 454
 455   /* The size of elements in argv.  */
 456   int argc;
 457
 458   /* The vector version of arguments.  If ARGC is nonzero,
 459      then we must compute ARGS from this (via the target).
 460      This is always coming from main's argv and therefore
 461      should never be freed.  */
 462   char **argv;
 463
 464   /* The name of terminal device to use for I/O.  */
 465   char *terminal;
 466
 467   /* Environment to use for running inferior,
 468      in format described in environ.h.  */
 469   struct gdb_environ *environment;
 470
 471   /* Nonzero if this child process was attached rather than
 472      forked.  */
 473   int attach_flag;
 474
 475   /* If this inferior is a vfork child, then this is the pointer to
 476      its vfork parent, if GDB is still attached to it.  */
 477   struct inferior *vfork_parent;
 478
 479   /* If this process is a vfork parent, this is the pointer to the
 480      child.  Since a vfork parent is left frozen by the kernel until
 481      the child execs or exits, a process can only have one vfork child
 482      at a given time.  */
 483   struct inferior *vfork_child;
 484
 485   /* True if this inferior should be detached when it's vfork sibling
 486      exits or execs.  */
 487   int pending_detach;
 488
 489   /* True if this inferior is a vfork parent waiting for a vfork child
 490      not under our control to be done with the shared memory region,
 491      either by exiting or execing.  */
 492   int waiting_for_vfork_done;
 493
 494   /* True if we're in the process of detaching from this inferior.  */
 495   int detaching;
 496
 497   /* What is left to do for an execution command after any thread of
 498      this inferior stops.  For continuations associated with a
 499      specific thread, see `struct thread_info'.  */
 500   struct continuation *continuations;
 501
 502   /* Private data used by the target vector implementation.  */
 503   struct private_inferior *private;
 504
 505   /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
 506      In this case, the EXIT_CODE field is also valid.  */
 507   int has_exit_code;
 508   LONGEST exit_code;
 509
 510   /* Default flags to pass to the symbol reading functions.  These are
 511      used whenever a new objfile is created.  The valid values come
 512      from enum symfile_add_flags.  */
 513   int symfile_flags;
 514
 515   /* Per inferior data-pointers required by other GDB modules.  */
 516   void **data;
 517   unsigned num_data;
 518 };
 519
 520 /* Keep a registry of per-inferior data-pointers required by other GDB
 521    modules.  */
 522
 523 extern const struct inferior_data *register_inferior_data (void);
 524 extern const struct inferior_data *register_inferior_data_with_cleanup
 525   (void (*cleanup) (struct inferior *, void *));
 526 extern void clear_inferior_data (struct inferior *inf);
 527 extern void set_inferior_data (struct inferior *inf,
 528                                const struct inferior_data *data, void *value);
 529 extern void *inferior_data (struct inferior *inf,
 530                             const struct inferior_data *data);
 531
 532 /* Create an empty inferior list, or empty the existing one.  */
 533 extern void init_inferior_list (void);
 534
 535 /* Add an inferior to the inferior list, print a message that a new
 536    inferior is found, and return the pointer to the new inferior.
 537    Caller may use this pointer to initialize the private inferior
 538    data.  */
 539 extern struct inferior *add_inferior (int pid);
 540
 541 /* Same as add_inferior, but don't print new inferior notifications to
 542    the CLI.  */
 543 extern struct inferior *add_inferior_silent (int pid);
 544
 545 /* Delete an existing inferior list entry, due to inferior exit.  */
 546 extern void delete_inferior (int pid);
 547
 548 extern void delete_inferior_1 (struct inferior *todel, int silent);
 549
 550 /* Same as delete_inferior, but don't print new inferior notifications
 551    to the CLI.  */
 552 extern void delete_inferior_silent (int pid);
 553
 554 /* Delete an existing inferior list entry, due to inferior detaching.  */
 555 extern void detach_inferior (int pid);
 556
 557 extern void exit_inferior (int pid);
 558
 559 extern void exit_inferior_silent (int pid);
 560
 561 extern void exit_inferior_num_silent (int num);
 562
 563 extern void inferior_appeared (struct inferior *inf, int pid);
 564
 565 /* Get rid of all inferiors.  */
 566 extern void discard_all_inferiors (void);
 567
 568 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
 569    into a "pid" (which may be overloaded with extra inferior information).  */
 570 extern int gdb_inferior_id_to_pid (int);
 571
 572 /* Translate a target 'pid' into the integer inferior id (GDB's
 573    homegrown id, not the system's).  */
 574 extern int pid_to_gdb_inferior_id (int pid);
 575
 576 /* Boolean test for an already-known pid.  */
 577 extern int in_inferior_list (int pid);
 578
 579 /* Boolean test for an already-known inferior id (GDB's homegrown id,
 580    not the system's).  */
 581 extern int valid_gdb_inferior_id (int num);
 582
 583 /* Search function to lookup an inferior by target 'pid'.  */
 584 extern struct inferior *find_inferior_pid (int pid);
 585
 586 /* Search function to lookup an inferior by GDB 'num'.  */
 587 extern struct inferior *find_inferior_id (int num);
 588
 589 /* Find an inferior bound to PSPACE.  */
 590 extern struct inferior *
 591   find_inferior_for_program_space (struct program_space *pspace);
 592
 593 /* Inferior iterator function.
 594
 595    Calls a callback function once for each inferior, so long as the
 596    callback function returns false.  If the callback function returns
 597    true, the iteration will end and the current inferior will be
 598    returned.  This can be useful for implementing a search for a
 599    inferior with arbitrary attributes, or for applying some operation
 600    to every inferior.
 601
 602    It is safe to delete the iterated inferior from the callback.  */
 603 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *,
 604                                                          void *),
 605                                                 void *);
 606
 607 /* Returns true if the inferior list is not empty.  */
 608 extern int have_inferiors (void);
 609
 610 /* Returns true if there are any live inferiors in the inferior list
 611    (not cores, not executables, real live processes).  */
 612 extern int have_live_inferiors (void);
 613
 614 /* Return a pointer to the current inferior.  It is an error to call
 615    this if there is no current inferior.  */
 616 extern struct inferior *current_inferior (void);
 617
 618 extern void set_current_inferior (struct inferior *);
 619
 620 extern struct cleanup *save_current_inferior (void);
 621
 622 /* Traverse all inferiors.  */
 623
 624 #define ALL_INFERIORS(I) \
 625   for ((I) = inferior_list; (I); (I) = (I)->next)
 626
 627 extern struct inferior *inferior_list;
 628
 629 /* Prune away automatically added inferiors that aren't required
 630    anymore.  */
 631 extern void prune_inferiors (void);
 632
 633 extern int number_of_inferiors (void);
 634
 635 extern struct inferior *add_inferior_with_spaces (void);
 636
 637 extern void update_observer_mode (void);
 638
 639 extern void update_signals_program_target (void);
 640
 641 /* In some circumstances we allow a command to specify a numeric
 642    signal.  The idea is to keep these circumstances limited so that
 643    users (and scripts) develop portable habits.  For comparison,
 644    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
 645    numeric signal at all is obsolescent.  We are slightly more lenient
 646    and allow 1-15 which should match host signal numbers on most
 647    systems.  Use of symbolic signal names is strongly encouraged.  */
 648
 649 enum gdb_signal gdb_signal_from_command (int num);
 650
 651 #endif /* !defined (INFERIOR_H) */