gdb/infrun.h

   1 /* Copyright (C) 1986-2020 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 #include "gdbsupport/byte-vector.h"
  23
  24 struct target_waitstatus;
  25 struct frame_info;
  26 struct address_space;
  27 struct return_value_info;
  28 struct process_stratum_target;
  29 struct thread_info;
  30
  31 /* True if we are debugging run control.  */
  32 extern unsigned int debug_infrun;
  33
  34 /* Print an "infrun" debug statement.  */
  35
  36 #define infrun_debug_printf(fmt, ...) \
  37   do \
  38     { \
  39       if (debug_infrun) \
  40         debug_prefixed_printf ("infrun", __func__, fmt, ##__VA_ARGS__); \
  41     } \
  42   while (0)
  43
  44 /* Nonzero if we want to give control to the user when we're notified
  45    of shared library events by the dynamic linker.  */
  46 extern int stop_on_solib_events;
  47
  48 /* True if execution commands resume all threads of all processes by
  49    default; otherwise, resume only threads of the current inferior
  50    process.  */
  51 extern bool sched_multi;
  52
  53 /* When set, stop the 'step' command if we enter a function which has
  54    no line number information.  The normal behavior is that we step
  55    over such function.  */
  56 extern bool step_stop_if_no_debug;
  57
  58 /* If set, the inferior should be controlled in non-stop mode.  In
  59    this mode, each thread is controlled independently.  Execution
  60    commands apply only to the selected thread by default, and stop
  61    events stop only the thread that had the event -- the other threads
  62    are kept running freely.  */
  63 extern bool non_stop;
  64
  65 /* When set (default), the target should attempt to disable the
  66    operating system's address space randomization feature when
  67    starting an inferior.  */
  68 extern bool disable_randomization;
  69
  70 /* Returns a unique identifier for the current stop.  This can be used
  71    to tell whether a command has proceeded the inferior past the
  72    current location.  */
  73 extern ULONGEST get_stop_id (void);
  74
  75 /* Reverse execution.  */
  76 enum exec_direction_kind
  77   {
  78     EXEC_FORWARD,
  79     EXEC_REVERSE
  80   };
  81
  82 /* The current execution direction.  */
  83 extern enum exec_direction_kind execution_direction;
  84
  85 extern void start_remote (int from_tty);
  86
  87 /* Clear out all variables saying what to do when inferior is
  88    continued or stepped.  First do this, then set the ones you want,
  89    then call `proceed'.  STEP indicates whether we're preparing for a
  90    step/stepi command.  */
  91 extern void clear_proceed_status (int step);
  92
  93 extern void proceed (CORE_ADDR, enum gdb_signal);
  94
  95 /* Return a ptid representing the set of threads that we will proceed,
  96    in the perspective of the user/frontend.  We may actually resume
  97    fewer threads at first, e.g., if a thread is stopped at a
  98    breakpoint that needs stepping-off, but that should not be visible
  99    to the user/frontend, and neither should the frontend/user be
 100    allowed to proceed any of the threads that happen to be stopped for
 101    internal run control handling, if a previous command wanted them
 102    resumed.  */
 103 extern ptid_t user_visible_resume_ptid (int step);
 104
 105 /* Return the process_stratum target that we will proceed, in the
 106    perspective of the user/frontend.  If RESUME_PTID is
 107    MINUS_ONE_PTID, then we'll resume all threads of all targets, so
 108    the function returns NULL.  Otherwise, we'll be resuming a process
 109    or thread of the current process, so we return the current
 110    inferior's process stratum target.  */
 111 extern process_stratum_target *user_visible_resume_target (ptid_t resume_ptid);
 112
 113 /* Return control to GDB when the inferior stops for real.  Print
 114    appropriate messages, remove breakpoints, give terminal our modes,
 115    and run the stop hook.  Returns true if the stop hook proceeded the
 116    target, false otherwise.  */
 117 extern int normal_stop (void);
 118
 119 /* Return the cached copy of the last target/ptid/waitstatus returned
 120    by target_wait()/deprecated_target_wait_hook().  The data is
 121    actually cached by handle_inferior_event(), which gets called
 122    immediately after target_wait()/deprecated_target_wait_hook().  */
 123 extern void get_last_target_status (process_stratum_target **target,
 124                                     ptid_t *ptid,
 125                                     struct target_waitstatus *status);
 126
 127 /* Set the cached copy of the last target/ptid/waitstatus.  */
 128 extern void set_last_target_status (process_stratum_target *target, ptid_t ptid,
 129                                     struct target_waitstatus status);
 130
 131 /* Clear the cached copy of the last ptid/waitstatus returned by
 132    target_wait().  */
 133 extern void nullify_last_target_wait_ptid ();
 134
 135 /* Stop all threads.  Only returns after everything is halted.  */
 136 extern void stop_all_threads (void);
 137
 138 extern void prepare_for_detach (void);
 139
 140 extern void fetch_inferior_event ();
 141
 142 extern void init_wait_for_inferior (void);
 143
 144 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 145                                                   struct symtab_and_line ,
 146                                                   struct frame_id);
 147
 148 /* Returns true if we're trying to step past the instruction at
 149    ADDRESS in ASPACE.  */
 150 extern int stepping_past_instruction_at (struct address_space *aspace,
 151                                          CORE_ADDR address);
 152
 153 /* Returns true if thread whose thread number is THREAD is stepping
 154    over a breakpoint.  */
 155 extern int thread_is_stepping_over_breakpoint (int thread);
 156
 157 /* Returns true if we're trying to step past an instruction that
 158    triggers a non-steppable watchpoint.  */
 159 extern int stepping_past_nonsteppable_watchpoint (void);
 160
 161 /* Record in TP the frame and location we're currently stepping through.  */
 162 extern void set_step_info (thread_info *tp,
 163                            struct frame_info *frame,
 164                            struct symtab_and_line sal);
 165
 166 /* Several print_*_reason helper functions to print why the inferior
 167    has stopped to the passed in UIOUT.  */
 168
 169 /* Signal received, print why the inferior has stopped.  */
 170 extern void print_signal_received_reason (struct ui_out *uiout,
 171                                           enum gdb_signal siggnal);
 172
 173 /* Print why the inferior has stopped.  We are done with a
 174    step/next/si/ni command, print why the inferior has stopped.  */
 175 extern void print_end_stepping_range_reason (struct ui_out *uiout);
 176
 177 /* The inferior was terminated by a signal, print why it stopped.  */
 178 extern void print_signal_exited_reason (struct ui_out *uiout,
 179                                         enum gdb_signal siggnal);
 180
 181 /* The inferior program is finished, print why it stopped.  */
 182 extern void print_exited_reason (struct ui_out *uiout, int exitstatus);
 183
 184 /* Reverse execution: target ran out of history info, print why the
 185    inferior has stopped.  */
 186 extern void print_no_history_reason (struct ui_out *uiout);
 187
 188 /* Print the result of a function at the end of a 'finish' command.
 189    RV points at an object representing the captured return value/type
 190    and its position in the value history.  */
 191
 192 extern void print_return_value (struct ui_out *uiout,
 193                                 struct return_value_info *rv);
 194
 195 /* Print current location without a level number, if we have changed
 196    functions or hit a breakpoint.  Print source line if we have one.
 197    If the execution command captured a return value, print it.  If
 198    DISPLAYS is false, do not call 'do_displays'.  */
 199
 200 extern void print_stop_event (struct ui_out *uiout, bool displays = true);
 201
 202 /* Pretty print the results of target_wait, for debugging purposes.  */
 203
 204 extern void print_target_wait_results (ptid_t waiton_ptid, ptid_t result_ptid,
 205                                        const struct target_waitstatus *ws);
 206
 207 extern int signal_stop_state (int);
 208
 209 extern int signal_print_state (int);
 210
 211 extern int signal_pass_state (int);
 212
 213 extern int signal_stop_update (int, int);
 214
 215 extern int signal_print_update (int, int);
 216
 217 extern int signal_pass_update (int, int);
 218
 219 extern void update_signals_program_target (void);
 220
 221 /* Clear the convenience variables associated with the exit of the
 222    inferior.  Currently, those variables are $_exitcode and
 223    $_exitsignal.  */
 224 extern void clear_exit_convenience_vars (void);
 225
 226 /* Dump LEN bytes at BUF in hex to a string and return it.  */
 227 extern std::string displaced_step_dump_bytes (const gdb_byte *buf, size_t len);
 228
 229 extern struct displaced_step_copy_insn_closure *
 230   get_displaced_step_copy_insn_closure_by_addr (CORE_ADDR addr);
 231
 232 extern void update_observer_mode (void);
 233
 234 extern void signal_catch_update (const unsigned int *);
 235
 236 /* In some circumstances we allow a command to specify a numeric
 237    signal.  The idea is to keep these circumstances limited so that
 238    users (and scripts) develop portable habits.  For comparison,
 239    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
 240    numeric signal at all is obsolescent.  We are slightly more lenient
 241    and allow 1-15 which should match host signal numbers on most
 242    systems.  Use of symbolic signal names is strongly encouraged.  */
 243 enum gdb_signal gdb_signal_from_command (int num);
 244
 245 /* Enables/disables infrun's async event source in the event loop.  */
 246 extern void infrun_async (int enable);
 247
 248 /* Call infrun's event handler the next time through the event
 249    loop.  */
 250 extern void mark_infrun_async_event_handler (void);
 251
 252 /* The global chain of threads that need to do a step-over operation
 253    to get past e.g., a breakpoint.  */
 254 extern struct thread_info *global_thread_step_over_chain_head;
 255
 256 /* Remove breakpoints if possible (usually that means, if everything
 257    is stopped).  On failure, print a message.  */
 258 extern void maybe_remove_breakpoints (void);
 259
 260 /* If a UI was in sync execution mode, and now isn't, restore its
 261    prompt (a synchronous execution command has finished, and we're
 262    ready for input).  */
 263 extern void all_uis_check_sync_execution_done (void);
 264
 265 /* If a UI was in sync execution mode, and hasn't displayed the prompt
 266    yet, re-disable its prompt (a synchronous execution command was
 267    started or re-started).  */
 268 extern void all_uis_on_sync_execution_starting (void);
 269
 270 #endif /* INFRUN_H */