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