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