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