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