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