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