1 /* Copyright (C) 1986-2022 Free Software Foundation, Inc.
3 This file is part of GDB.
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.
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.
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/>. */
21 #include "gdbthread.h"
23 #include "gdbsupport/byte-vector.h"
24 #include "gdbsupport/intrusive_list.h"
26 struct target_waitstatus
;
29 struct return_value_info
;
30 struct process_stratum_target
;
33 /* True if we are debugging run control. */
34 extern bool debug_infrun
;
36 /* Print an "infrun" debug statement. */
38 #define infrun_debug_printf(fmt, ...) \
39 debug_prefixed_printf_cond (debug_infrun, "infrun", fmt, ##__VA_ARGS__)
41 /* Print "infrun" start/end debug statements. */
43 #define INFRUN_SCOPED_DEBUG_START_END(fmt, ...) \
44 scoped_debug_start_end (debug_infrun, "infrun", fmt, ##__VA_ARGS__)
46 /* Print "infrun" enter/exit debug statements. */
48 #define INFRUN_SCOPED_DEBUG_ENTER_EXIT \
49 scoped_debug_enter_exit (debug_infrun, "infrun")
51 /* Nonzero if we want to give control to the user when we're notified
52 of shared library events by the dynamic linker. */
53 extern int stop_on_solib_events
;
55 /* True if execution commands resume all threads of all processes by
56 default; otherwise, resume only threads of the current inferior
58 extern bool sched_multi
;
60 /* When set, stop the 'step' command if we enter a function which has
61 no line number information. The normal behavior is that we step
62 over such function. */
63 extern bool step_stop_if_no_debug
;
65 /* If set, the inferior should be controlled in non-stop mode. In
66 this mode, each thread is controlled independently. Execution
67 commands apply only to the selected thread by default, and stop
68 events stop only the thread that had the event -- the other threads
69 are kept running freely. */
72 /* When set (default), the target should attempt to disable the
73 operating system's address space randomization feature when
74 starting an inferior. */
75 extern bool disable_randomization
;
77 /* Returns a unique identifier for the current stop. This can be used
78 to tell whether a command has proceeded the inferior past the
80 extern ULONGEST
get_stop_id (void);
82 /* Reverse execution. */
83 enum exec_direction_kind
89 /* The current execution direction. */
90 extern enum exec_direction_kind execution_direction
;
92 extern void start_remote (int from_tty
);
94 /* Clear out all variables saying what to do when inferior is
95 continued or stepped. First do this, then set the ones you want,
96 then call `proceed'. STEP indicates whether we're preparing for a
97 step/stepi command. */
98 extern void clear_proceed_status (int step
);
100 extern void proceed (CORE_ADDR
, enum gdb_signal
);
102 /* Return a ptid representing the set of threads that we will proceed,
103 in the perspective of the user/frontend. We may actually resume
104 fewer threads at first, e.g., if a thread is stopped at a
105 breakpoint that needs stepping-off, but that should not be visible
106 to the user/frontend, and neither should the frontend/user be
107 allowed to proceed any of the threads that happen to be stopped for
108 internal run control handling, if a previous command wanted them
110 extern ptid_t
user_visible_resume_ptid (int step
);
112 /* Return the process_stratum target that we will proceed, in the
113 perspective of the user/frontend. If RESUME_PTID is
114 MINUS_ONE_PTID, then we'll resume all threads of all targets, so
115 the function returns NULL. Otherwise, we'll be resuming a process
116 or thread of the current process, so we return the current
117 inferior's process stratum target. */
118 extern process_stratum_target
*user_visible_resume_target (ptid_t resume_ptid
);
120 /* Return control to GDB when the inferior stops for real. Print
121 appropriate messages, remove breakpoints, give terminal our modes,
122 and run the stop hook. Returns true if the stop hook proceeded the
123 target, false otherwise. */
124 extern int normal_stop (void);
126 /* Return the cached copy of the last target/ptid/waitstatus returned
127 by target_wait(). The data is actually cached by handle_inferior_event(),
128 which gets called immediately after target_wait(). */
129 extern void get_last_target_status (process_stratum_target
**target
,
131 struct target_waitstatus
*status
);
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
,
135 const target_waitstatus
&status
);
137 /* Clear the cached copy of the last ptid/waitstatus returned by
139 extern void nullify_last_target_wait_ptid ();
141 /* Stop all threads. Only returns after everything is halted.
143 REASON is a string indicating the reason why we stop all threads, used in
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);
150 extern void prepare_for_detach (void);
152 extern void fetch_inferior_event ();
154 extern void init_wait_for_inferior (void);
156 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch
*,
157 struct symtab_and_line
,
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
,
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
);
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);
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
,
176 struct symtab_and_line sal
);
178 /* Several print_*_reason helper functions to print why the inferior
179 has stopped to the passed in UIOUT. */
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
);
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
);
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
);
193 /* The inferior program is finished, print why it stopped. */
194 extern void print_exited_reason (struct ui_out
*uiout
, int exitstatus
);
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
);
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. */
204 extern void print_return_value (struct ui_out
*uiout
,
205 struct return_value_info
*rv
);
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.
209 If the execution command captured a return value, print it. If
210 DISPLAYS is false, do not call 'do_displays'. */
212 extern void print_stop_event (struct ui_out
*uiout
, bool displays
= true);
214 /* Pretty print the results of target_wait, for debugging purposes. */
216 extern void print_target_wait_results (ptid_t waiton_ptid
, ptid_t result_ptid
,
217 const struct target_waitstatus
&ws
);
219 extern int signal_stop_state (int);
221 extern int signal_print_state (int);
223 extern int signal_pass_state (int);
225 extern int signal_stop_update (int, int);
227 extern int signal_print_update (int, int);
229 extern int signal_pass_update (int, int);
231 extern void update_signals_program_target (void);
233 /* Clear the convenience variables associated with the exit of the
234 inferior. Currently, those variables are $_exitcode and
236 extern void clear_exit_convenience_vars (void);
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
);
241 extern void update_observer_mode (void);
243 extern void signal_catch_update (const unsigned int *);
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
);
254 /* Enables/disables infrun's async event source in the event loop. */
255 extern void infrun_async (int enable
);
257 /* Call infrun's event handler the next time through the event
259 extern void mark_infrun_async_event_handler (void);
261 /* The global chain of threads that need to do a step-over operation
262 to get past e.g., a breakpoint. */
263 extern thread_step_over_list global_thread_step_over_list
;
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);
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
272 extern void all_uis_check_sync_execution_done (void);
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);
279 /* In all-stop, restart the target if it had to be stopped to
281 extern void restart_after_all_stop_detach (process_stratum_target
*proc_target
);
283 /* RAII object to temporarily disable the requirement for target
284 stacks to commit their resumed threads.
286 On construction, set process_stratum_target::commit_resumed_state
287 to false for all process_stratum targets in all target
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:
294 - have no resumed threads
295 - have a resumed thread with a pending status
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
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:
312 scoped_disable_commit_resumed disable;
316 disable.reset_and_commit ();
322 scoped_disable_commit_resumed disable;
324 for (... each thread ...)
327 disable.reset_and_commit ();
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
335 struct scoped_disable_commit_resumed
337 explicit scoped_disable_commit_resumed (const char *reason
);
338 ~scoped_disable_commit_resumed ();
340 DISABLE_COPY_AND_ASSIGN (scoped_disable_commit_resumed
);
342 /* Undoes the disabling done by the ctor, and calls
343 maybe_call_commit_resumed_all_targets(). */
344 void reset_and_commit ();
347 /* Undoes the disabling done by the ctor. */
350 /* Whether this object has been reset. */
351 bool m_reset
= false;
353 const char *m_reason
;
354 bool m_prev_enable_commit_resumed
;
357 /* Call target_commit_resumed method on all target stacks whose
358 process_stratum target layer has COMMIT_RESUME_STATE set. */
360 extern void maybe_call_commit_resumed_all_targets ();
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. */
368 struct scoped_enable_commit_resumed
370 explicit scoped_enable_commit_resumed (const char *reason
);
371 ~scoped_enable_commit_resumed ();
373 DISABLE_COPY_AND_ASSIGN (scoped_enable_commit_resumed
);
376 const char *m_reason
;
377 bool m_prev_enable_commit_resumed
;
381 #endif /* INFRUN_H */