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