]> Git Repo - binutils.git/blob - gdb/infrun.h
gdb: remove SYMBOL_CLASS macro, add getter
[binutils.git] / gdb / infrun.h
1 /* Copyright (C) 1986-2022 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 "gdbthread.h"
22 #include "symtab.h"
23 #include "gdbsupport/byte-vector.h"
24 #include "gdbsupport/intrusive_list.h"
25
26 struct target_waitstatus;
27 struct frame_info;
28 struct address_space;
29 struct return_value_info;
30 struct process_stratum_target;
31 struct thread_info;
32
33 /* True if we are debugging run control.  */
34 extern bool debug_infrun;
35
36 /* Print an "infrun" debug statement.  */
37
38 #define infrun_debug_printf(fmt, ...) \
39   debug_prefixed_printf_cond (debug_infrun, "infrun", fmt, ##__VA_ARGS__)
40
41 /* Print "infrun" start/end debug statements.  */
42
43 #define INFRUN_SCOPED_DEBUG_START_END(msg) \
44   scoped_debug_start_end (debug_infrun, "infrun", msg)
45
46 /* Print "infrun" enter/exit debug statements.  */
47
48 #define INFRUN_SCOPED_DEBUG_ENTER_EXIT \
49   scoped_debug_enter_exit (debug_infrun, "infrun")
50
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;
54
55 /* True if execution commands resume all threads of all processes by
56    default; otherwise, resume only threads of the current inferior
57    process.  */
58 extern bool sched_multi;
59
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;
64
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.  */
70 extern bool non_stop;
71
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;
76
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
79    current location.  */
80 extern ULONGEST get_stop_id (void);
81
82 /* Reverse execution.  */
83 enum exec_direction_kind
84   {
85     EXEC_FORWARD,
86     EXEC_REVERSE
87   };
88
89 /* The current execution direction.  */
90 extern enum exec_direction_kind execution_direction;
91
92 extern void start_remote (int from_tty);
93
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);
99
100 extern void proceed (CORE_ADDR, enum gdb_signal);
101
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
109    resumed.  */
110 extern ptid_t user_visible_resume_ptid (int step);
111
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);
119
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);
125
126 /* Return the cached copy of the last target/ptid/waitstatus returned
127    by target_wait()/deprecated_target_wait_hook().  The data is
128    actually cached by handle_inferior_event(), which gets called
129    immediately after target_wait()/deprecated_target_wait_hook().  */
130 extern void get_last_target_status (process_stratum_target **target,
131                                     ptid_t *ptid,
132                                     struct target_waitstatus *status);
133
134 /* Set the cached copy of the last target/ptid/waitstatus.  */
135 extern void set_last_target_status (process_stratum_target *target, ptid_t ptid,
136                                     const target_waitstatus &status);
137
138 /* Clear the cached copy of the last ptid/waitstatus returned by
139    target_wait().  */
140 extern void nullify_last_target_wait_ptid ();
141
142 /* Stop all threads.  Only returns after everything is halted.  */
143 extern void stop_all_threads (void);
144
145 extern void prepare_for_detach (void);
146
147 extern void fetch_inferior_event ();
148
149 extern void init_wait_for_inferior (void);
150
151 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
152                                                   struct symtab_and_line ,
153                                                   struct frame_id);
154
155 /* Returns true if we're trying to step past the instruction at
156    ADDRESS in ASPACE.  */
157 extern int stepping_past_instruction_at (struct address_space *aspace,
158                                          CORE_ADDR address);
159
160 /* Returns true if thread whose thread number is THREAD is stepping
161    over a breakpoint.  */
162 extern int thread_is_stepping_over_breakpoint (int thread);
163
164 /* Returns true if we're trying to step past an instruction that
165    triggers a non-steppable watchpoint.  */
166 extern int stepping_past_nonsteppable_watchpoint (void);
167
168 /* Record in TP the frame and location we're currently stepping through.  */
169 extern void set_step_info (thread_info *tp,
170                            struct frame_info *frame,
171                            struct symtab_and_line sal);
172
173 /* Several print_*_reason helper functions to print why the inferior
174    has stopped to the passed in UIOUT.  */
175
176 /* Signal received, print why the inferior has stopped.  */
177 extern void print_signal_received_reason (struct ui_out *uiout,
178                                           enum gdb_signal siggnal);
179
180 /* Print why the inferior has stopped.  We are done with a
181    step/next/si/ni command, print why the inferior has stopped.  */
182 extern void print_end_stepping_range_reason (struct ui_out *uiout);
183
184 /* The inferior was terminated by a signal, print why it stopped.  */
185 extern void print_signal_exited_reason (struct ui_out *uiout,
186                                         enum gdb_signal siggnal);
187
188 /* The inferior program is finished, print why it stopped.  */
189 extern void print_exited_reason (struct ui_out *uiout, int exitstatus);
190
191 /* Reverse execution: target ran out of history info, print why the
192    inferior has stopped.  */
193 extern void print_no_history_reason (struct ui_out *uiout);
194
195 /* Print the result of a function at the end of a 'finish' command.
196    RV points at an object representing the captured return value/type
197    and its position in the value history.  */
198
199 extern void print_return_value (struct ui_out *uiout,
200                                 struct return_value_info *rv);
201
202 /* Print current location without a level number, if we have changed
203    functions or hit a breakpoint.  Print source line if we have one.
204    If the execution command captured a return value, print it.  If
205    DISPLAYS is false, do not call 'do_displays'.  */
206
207 extern void print_stop_event (struct ui_out *uiout, bool displays = true);
208
209 /* Pretty print the results of target_wait, for debugging purposes.  */
210
211 extern void print_target_wait_results (ptid_t waiton_ptid, ptid_t result_ptid,
212                                        const struct target_waitstatus &ws);
213
214 extern int signal_stop_state (int);
215
216 extern int signal_print_state (int);
217
218 extern int signal_pass_state (int);
219
220 extern int signal_stop_update (int, int);
221
222 extern int signal_print_update (int, int);
223
224 extern int signal_pass_update (int, int);
225
226 extern void update_signals_program_target (void);
227
228 /* Clear the convenience variables associated with the exit of the
229    inferior.  Currently, those variables are $_exitcode and
230    $_exitsignal.  */
231 extern void clear_exit_convenience_vars (void);
232
233 /* Dump LEN bytes at BUF in hex to a string and return it.  */
234 extern std::string displaced_step_dump_bytes (const gdb_byte *buf, size_t len);
235
236 extern void update_observer_mode (void);
237
238 extern void signal_catch_update (const unsigned int *);
239
240 /* In some circumstances we allow a command to specify a numeric
241    signal.  The idea is to keep these circumstances limited so that
242    users (and scripts) develop portable habits.  For comparison,
243    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
244    numeric signal at all is obsolescent.  We are slightly more lenient
245    and allow 1-15 which should match host signal numbers on most
246    systems.  Use of symbolic signal names is strongly encouraged.  */
247 enum gdb_signal gdb_signal_from_command (int num);
248
249 /* Enables/disables infrun's async event source in the event loop.  */
250 extern void infrun_async (int enable);
251
252 /* Call infrun's event handler the next time through the event
253    loop.  */
254 extern void mark_infrun_async_event_handler (void);
255
256 /* The global chain of threads that need to do a step-over operation
257    to get past e.g., a breakpoint.  */
258 extern thread_step_over_list global_thread_step_over_list;
259
260 /* Remove breakpoints if possible (usually that means, if everything
261    is stopped).  On failure, print a message.  */
262 extern void maybe_remove_breakpoints (void);
263
264 /* If a UI was in sync execution mode, and now isn't, restore its
265    prompt (a synchronous execution command has finished, and we're
266    ready for input).  */
267 extern void all_uis_check_sync_execution_done (void);
268
269 /* If a UI was in sync execution mode, and hasn't displayed the prompt
270    yet, re-disable its prompt (a synchronous execution command was
271    started or re-started).  */
272 extern void all_uis_on_sync_execution_starting (void);
273
274 /* In all-stop, restart the target if it had to be stopped to
275    detach.  */
276 extern void restart_after_all_stop_detach (process_stratum_target *proc_target);
277
278 /* RAII object to temporarily disable the requirement for target
279    stacks to commit their resumed threads.
280
281    On construction, set process_stratum_target::commit_resumed_state
282    to false for all process_stratum targets in all target
283    stacks.
284
285    On destruction (or if reset_and_commit() is called), set
286    process_stratum_target::commit_resumed_state to true for all
287    process_stratum targets in all target stacks, except those that:
288
289      - have no resumed threads
290      - have a resumed thread with a pending status
291
292    target_commit_resumed is not called in the destructor, because its
293    implementations could throw, and we don't to swallow that error in
294    a destructor.  Instead, the caller should call the
295    reset_and_commit_resumed() method so that an eventual exception can
296    propagate.  "reset" in the method name refers to the fact that this
297    method has the same effect as the destructor, in addition to
298    committing resumes.
299
300    The creation of nested scoped_disable_commit_resumed objects is
301    tracked, such that only the outermost instance actually does
302    something, for cases like this:
303
304      void
305      inner_func ()
306      {
307        scoped_disable_commit_resumed disable;
308
309        // do stuff
310
311        disable.reset_and_commit ();
312      }
313
314      void
315      outer_func ()
316      {
317        scoped_disable_commit_resumed disable;
318
319        for (... each thread ...)
320          inner_func ();
321
322        disable.reset_and_commit ();
323      }
324
325    In this case, we don't want the `disable` destructor in
326    `inner_func` to require targets to commit resumed threads, so that
327    the `reset_and_commit()` call in `inner_func` doesn't actually
328    resume threads.  */
329
330 struct scoped_disable_commit_resumed
331 {
332   explicit scoped_disable_commit_resumed (const char *reason);
333   ~scoped_disable_commit_resumed ();
334
335   DISABLE_COPY_AND_ASSIGN (scoped_disable_commit_resumed);
336
337   /* Undoes the disabling done by the ctor, and calls
338      maybe_call_commit_resumed_all_targets().  */
339   void reset_and_commit ();
340
341 private:
342   /* Undoes the disabling done by the ctor.  */
343   void reset ();
344
345   /* Whether this object has been reset.  */
346   bool m_reset = false;
347
348   const char *m_reason;
349   bool m_prev_enable_commit_resumed;
350 };
351
352 /* Call target_commit_resumed method on all target stacks whose
353    process_stratum target layer has COMMIT_RESUME_STATE set.  */
354
355 extern void maybe_call_commit_resumed_all_targets ();
356
357 /* RAII object to temporarily enable the requirement for target stacks
358    to commit their resumed threads.  This is the inverse of
359    scoped_disable_commit_resumed.  The constructor calls the
360    maybe_call_commit_resumed_all_targets function itself, since it's
361    OK to throw from a constructor.  */
362
363 struct scoped_enable_commit_resumed
364 {
365   explicit scoped_enable_commit_resumed (const char *reason);
366   ~scoped_enable_commit_resumed ();
367
368   DISABLE_COPY_AND_ASSIGN (scoped_enable_commit_resumed);
369
370 private:
371   const char *m_reason;
372   bool m_prev_enable_commit_resumed;
373 };
374
375
376 #endif /* INFRUN_H */
This page took 0.045401 seconds and 4 git commands to generate.