gdb/infrun.h

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