gdb/infrun.h

   1 /* Copyright (C) 1986-2015 Free Software Foundation, Inc.
   2
   3    This file is part of GDB.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef INFRUN_H
  19 #define INFRUN_H 1
  20
  21 #include "symtab.h"
  22
  23 struct target_waitstatus;
  24 struct frame_info;
  25 struct address_space;
  26 struct return_value_info;
  27
  28 /* True if we are debugging run control.  */
  29 extern unsigned int debug_infrun;
  30
  31 /* True if we are debugging displaced stepping.  */
  32 extern int debug_displaced;
  33
  34 /* Nonzero if we want to give control to the user when we're notified
  35    of shared library events by the dynamic linker.  */
  36 extern int stop_on_solib_events;
  37
  38 /* Are we simulating synchronous execution? This is used in async gdb
  39    to implement the 'run', 'continue' etc commands, which will not
  40    redisplay the prompt until the execution is actually over.  */
  41 extern int sync_execution;
  42
  43 /* True if execution commands resume all threads of all processes by
  44    default; otherwise, resume only threads of the current inferior
  45    process.  */
  46 extern int sched_multi;
  47
  48 /* When set, stop the 'step' command if we enter a function which has
  49    no line number information.  The normal behavior is that we step
  50    over such function.  */
  51 extern int step_stop_if_no_debug;
  52
  53 /* If set, the inferior should be controlled in non-stop mode.  In
  54    this mode, each thread is controlled independently.  Execution
  55    commands apply only to the selected thread by default, and stop
  56    events stop only the thread that had the event -- the other threads
  57    are kept running freely.  */
  58 extern int non_stop;
  59
  60 /* When set (default), the target should attempt to disable the
  61    operating system's address space randomization feature when
  62    starting an inferior.  */
  63 extern int disable_randomization;
  64
  65 /* Reverse execution.  */
  66 enum exec_direction_kind
  67   {
  68     EXEC_FORWARD,
  69     EXEC_REVERSE
  70   };
  71
  72 /* The current execution direction.  This should only be set to enum
  73    exec_direction_kind values.  It is only an int to make it
  74    compatible with make_cleanup_restore_integer.  */
  75 extern int execution_direction;
  76
  77 extern void start_remote (int from_tty);
  78
  79 /* Clear out all variables saying what to do when inferior is
  80    continued or stepped.  First do this, then set the ones you want,
  81    then call `proceed'.  STEP indicates whether we're preparing for a
  82    step/stepi command.  */
  83 extern void clear_proceed_status (int step);
  84
  85 extern void proceed (CORE_ADDR, enum gdb_signal);
  86
  87 /* The `resume' routine should only be called in special circumstances.
  88    Normally, use `proceed', which handles a lot of bookkeeping.  */
  89 extern void resume (enum gdb_signal);
  90
  91 /* Return a ptid representing the set of threads that we will proceed,
  92    in the perspective of the user/frontend.  We may actually resume
  93    fewer threads at first, e.g., if a thread is stopped at a
  94    breakpoint that needs stepping-off, but that should not be visible
  95    to the user/frontend, and neither should the frontend/user be
  96    allowed to proceed any of the threads that happen to be stopped for
  97    internal run control handling, if a previous command wanted them
  98    resumed.  */
  99 extern ptid_t user_visible_resume_ptid (int step);
 100
 101 extern void wait_for_inferior (void);
 102
 103 extern void normal_stop (void);
 104
 105 extern void get_last_target_status (ptid_t *ptid,
 106                                     struct target_waitstatus *status);
 107
 108 extern void prepare_for_detach (void);
 109
 110 extern void fetch_inferior_event (void *);
 111
 112 extern void init_wait_for_inferior (void);
 113
 114 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 115                                                   struct symtab_and_line ,
 116                                                   struct frame_id);
 117
 118 /* Returns true if we're trying to step past the instruction at
 119    ADDRESS in ASPACE.  */
 120 extern int stepping_past_instruction_at (struct address_space *aspace,
 121                                          CORE_ADDR address);
 122
 123 /* Returns true if we're trying to step past an instruction that
 124    triggers a non-steppable watchpoint.  */
 125 extern int stepping_past_nonsteppable_watchpoint (void);
 126
 127 extern void set_step_info (struct frame_info *frame,
 128                            struct symtab_and_line sal);
 129
 130 /* Several print_*_reason helper functions to print why the inferior
 131    has stopped to the passed in UIOUT.  */
 132
 133 /* Signal received, print why the inferior has stopped.  */
 134 extern void print_signal_received_reason (struct ui_out *uiout,
 135                                           enum gdb_signal siggnal);
 136
 137 /* Print why the inferior has stopped.  We are done with a
 138    step/next/si/ni command, print why the inferior has stopped.  */
 139 extern void print_end_stepping_range_reason (struct ui_out *uiout);
 140
 141 /* The inferior was terminated by a signal, print why it stopped.  */
 142 extern void print_signal_exited_reason (struct ui_out *uiout,
 143                                         enum gdb_signal siggnal);
 144
 145 /* The inferior program is finished, print why it stopped.  */
 146 extern void print_exited_reason (struct ui_out *uiout, int exitstatus);
 147
 148 /* Reverse execution: target ran out of history info, print why the
 149    inferior has stopped.  */
 150 extern void print_no_history_reason (struct ui_out *uiout);
 151
 152 /* Print the result of a function at the end of a 'finish' command.
 153    RV points at an object representing the captured return value/type
 154    and its position in the value history.  */
 155
 156 extern void print_return_value (struct ui_out *uiout,
 157                                 struct return_value_info *rv);
 158
 159 /* Print current location without a level number, if we have changed
 160    functions or hit a breakpoint.  Print source line if we have one.
 161    If the execution command captured a return value, print it.  */
 162
 163 extern void print_stop_event (struct ui_out *uiout);
 164
 165 /* Pretty print the results of target_wait, for debugging purposes.  */
 166
 167 extern void print_target_wait_results (ptid_t waiton_ptid, ptid_t result_ptid,
 168                                        const struct target_waitstatus *ws);
 169
 170 extern int signal_stop_state (int);
 171
 172 extern int signal_print_state (int);
 173
 174 extern int signal_pass_state (int);
 175
 176 extern int signal_stop_update (int, int);
 177
 178 extern int signal_print_update (int, int);
 179
 180 extern int signal_pass_update (int, int);
 181
 182 extern void update_signals_program_target (void);
 183
 184 /* Clear the convenience variables associated with the exit of the
 185    inferior.  Currently, those variables are $_exitcode and
 186    $_exitsignal.  */
 187 extern void clear_exit_convenience_vars (void);
 188
 189 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
 190 extern void displaced_step_dump_bytes (struct ui_file *file,
 191                                        const gdb_byte *buf, size_t len);
 192
 193 extern struct displaced_step_closure *get_displaced_step_closure_by_addr
 194     (CORE_ADDR addr);
 195
 196 extern void update_observer_mode (void);
 197
 198 extern void signal_catch_update (const unsigned int *);
 199
 200 /* In some circumstances we allow a command to specify a numeric
 201    signal.  The idea is to keep these circumstances limited so that
 202    users (and scripts) develop portable habits.  For comparison,
 203    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
 204    numeric signal at all is obsolescent.  We are slightly more lenient
 205    and allow 1-15 which should match host signal numbers on most
 206    systems.  Use of symbolic signal names is strongly encouraged.  */
 207 enum gdb_signal gdb_signal_from_command (int num);
 208
 209 /* Enables/disables infrun's async event source in the event loop.  */
 210 extern void infrun_async (int enable);
 211
 212 /* Call infrun's event handler the next time through the event
 213    loop.  */
 214 extern void mark_infrun_async_event_handler (void);
 215
 216 /* The global queue of threads that need to do a step-over operation
 217    to get past e.g., a breakpoint.  */
 218 extern struct thread_info *step_over_queue_head;
 219
 220 #endif /* INFRUN_H */