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