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