gdb/infrun.h

   1 /* Copyright (C) 1986-2022 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(fmt, ...) \
  42   scoped_debug_start_end (debug_infrun, "infrun", fmt, ##__VA_ARGS__)
  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
 142    REASON is a string indicating the reason why we stop all threads, used in
 143    debug messages.  */
 144 extern void stop_all_threads (const char *reason);
 145
 146 extern void prepare_for_detach (void);
 147
 148 extern void fetch_inferior_event ();
 149
 150 extern void init_wait_for_inferior (void);
 151
 152 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
 153                                                   struct symtab_and_line ,
 154                                                   struct frame_id);
 155
 156 /* Returns true if we're trying to step past the instruction at
 157    ADDRESS in ASPACE.  */
 158 extern int stepping_past_instruction_at (struct address_space *aspace,
 159                                          CORE_ADDR address);
 160
 161 /* Returns true if thread whose thread number is THREAD is stepping
 162    over a breakpoint.  */
 163 extern int thread_is_stepping_over_breakpoint (int thread);
 164
 165 /* Returns true if we're trying to step past an instruction that
 166    triggers a non-steppable watchpoint.  */
 167 extern int stepping_past_nonsteppable_watchpoint (void);
 168
 169 /* Record in TP the frame and location we're currently stepping through.  */
 170 extern void set_step_info (thread_info *tp,
 171                            struct frame_info *frame,
 172                            struct symtab_and_line sal);
 173
 174 /* Several print_*_reason helper functions to print why the inferior
 175    has stopped to the passed in UIOUT.  */
 176
 177 /* Signal received, print why the inferior has stopped.  */
 178 extern void print_signal_received_reason (struct ui_out *uiout,
 179                                           enum gdb_signal siggnal);
 180
 181 /* Print why the inferior has stopped.  We are done with a
 182    step/next/si/ni command, print why the inferior has stopped.  */
 183 extern void print_end_stepping_range_reason (struct ui_out *uiout);
 184
 185 /* The inferior was terminated by a signal, print why it stopped.  */
 186 extern void print_signal_exited_reason (struct ui_out *uiout,
 187                                         enum gdb_signal siggnal);
 188
 189 /* The inferior program is finished, print why it stopped.  */
 190 extern void print_exited_reason (struct ui_out *uiout, int exitstatus);
 191
 192 /* Reverse execution: target ran out of history info, print why the
 193    inferior has stopped.  */
 194 extern void print_no_history_reason (struct ui_out *uiout);
 195
 196 /* Print the result of a function at the end of a 'finish' command.
 197    RV points at an object representing the captured return value/type
 198    and its position in the value history.  */
 199
 200 extern void print_return_value (struct ui_out *uiout,
 201                                 struct return_value_info *rv);
 202
 203 /* Print current location without a level number, if we have changed
 204    functions or hit a breakpoint.  Print source line if we have one.
 205    If the execution command captured a return value, print it.  If
 206    DISPLAYS is false, do not call 'do_displays'.  */
 207
 208 extern void print_stop_event (struct ui_out *uiout, bool displays = true);
 209
 210 /* Pretty print the results of target_wait, for debugging purposes.  */
 211
 212 extern void print_target_wait_results (ptid_t waiton_ptid, ptid_t result_ptid,
 213                                        const struct target_waitstatus *ws);
 214
 215 extern int signal_stop_state (int);
 216
 217 extern int signal_print_state (int);
 218
 219 extern int signal_pass_state (int);
 220
 221 extern int signal_stop_update (int, int);
 222
 223 extern int signal_print_update (int, int);
 224
 225 extern int signal_pass_update (int, int);
 226
 227 extern void update_signals_program_target (void);
 228
 229 /* Clear the convenience variables associated with the exit of the
 230    inferior.  Currently, those variables are $_exitcode and
 231    $_exitsignal.  */
 232 extern void clear_exit_convenience_vars (void);
 233
 234 /* Dump LEN bytes at BUF in hex to a string and return it.  */
 235 extern std::string displaced_step_dump_bytes (const gdb_byte *buf, size_t len);
 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 chain of threads that need to do a step-over operation
 258    to get past e.g., a breakpoint.  */
 259 extern struct thread_info *global_thread_step_over_chain_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 /* In all-stop, restart the target if it had to be stopped to
 276    detach.  */
 277 extern void restart_after_all_stop_detach (process_stratum_target *proc_target);
 278
 279 /* RAII object to temporarily disable the requirement for target
 280    stacks to commit their resumed threads.
 281
 282    On construction, set process_stratum_target::commit_resumed_state
 283    to false for all process_stratum targets in all target
 284    stacks.
 285
 286    On destruction (or if reset_and_commit() is called), set
 287    process_stratum_target::commit_resumed_state to true for all
 288    process_stratum targets in all target stacks, except those that:
 289
 290      - have no resumed threads
 291      - have a resumed thread with a pending status
 292
 293    target_commit_resumed is not called in the destructor, because its
 294    implementations could throw, and we don't to swallow that error in
 295    a destructor.  Instead, the caller should call the
 296    reset_and_commit_resumed() method so that an eventual exception can
 297    propagate.  "reset" in the method name refers to the fact that this
 298    method has the same effect as the destructor, in addition to
 299    committing resumes.
 300
 301    The creation of nested scoped_disable_commit_resumed objects is
 302    tracked, such that only the outermost instance actually does
 303    something, for cases like this:
 304
 305      void
 306      inner_func ()
 307      {
 308        scoped_disable_commit_resumed disable;
 309
 310        // do stuff
 311
 312        disable.reset_and_commit ();
 313      }
 314
 315      void
 316      outer_func ()
 317      {
 318        scoped_disable_commit_resumed disable;
 319
 320        for (... each thread ...)
 321          inner_func ();
 322
 323        disable.reset_and_commit ();
 324      }
 325
 326    In this case, we don't want the `disable` destructor in
 327    `inner_func` to require targets to commit resumed threads, so that
 328    the `reset_and_commit()` call in `inner_func` doesn't actually
 329    resume threads.  */
 330
 331 struct scoped_disable_commit_resumed
 332 {
 333   explicit scoped_disable_commit_resumed (const char *reason);
 334   ~scoped_disable_commit_resumed ();
 335
 336   DISABLE_COPY_AND_ASSIGN (scoped_disable_commit_resumed);
 337
 338   /* Undoes the disabling done by the ctor, and calls
 339      maybe_call_commit_resumed_all_targets().  */
 340   void reset_and_commit ();
 341
 342 private:
 343   /* Undoes the disabling done by the ctor.  */
 344   void reset ();
 345
 346   /* Whether this object has been reset.  */
 347   bool m_reset = false;
 348
 349   const char *m_reason;
 350   bool m_prev_enable_commit_resumed;
 351 };
 352
 353 /* Call target_commit_resumed method on all target stacks whose
 354    process_stratum target layer has COMMIT_RESUME_STATE set.  */
 355
 356 extern void maybe_call_commit_resumed_all_targets ();
 357
 358 /* RAII object to temporarily enable the requirement for target stacks
 359    to commit their resumed threads.  This is the inverse of
 360    scoped_disable_commit_resumed.  The constructor calls the
 361    maybe_call_commit_resumed_all_targets function itself, since it's
 362    OK to throw from a constructor.  */
 363
 364 struct scoped_enable_commit_resumed
 365 {
 366   explicit scoped_enable_commit_resumed (const char *reason);
 367   ~scoped_enable_commit_resumed ();
 368
 369   DISABLE_COPY_AND_ASSIGN (scoped_enable_commit_resumed);
 370
 371 private:
 372   const char *m_reason;
 373   bool m_prev_enable_commit_resumed;
 374 };
 375
 376
 377 #endif /* INFRUN_H */