Update year range in copyright notice of all files owned by the GDB project.
[external/binutils.git] / gdb / infrun.h
1 /* Copyright (C) 1986-2015 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
23 struct target_waitstatus;
24 struct frame_info;
25 struct address_space;
26
27 /* True if we are debugging run control.  */
28 extern unsigned int debug_infrun;
29
30 /* True if we are debugging displaced stepping.  */
31 extern int debug_displaced;
32
33 /* Nonzero if we want to give control to the user when we're notified
34    of shared library events by the dynamic linker.  */
35 extern int stop_on_solib_events;
36
37 /* Are we simulating synchronous execution? This is used in async gdb
38    to implement the 'run', 'continue' etc commands, which will not
39    redisplay the prompt until the execution is actually over.  */
40 extern int sync_execution;
41
42 /* True if execution commands resume all threads of all processes by
43    default; otherwise, resume only threads of the current inferior
44    process.  */
45 extern int sched_multi;
46
47 /* When set, stop the 'step' command if we enter a function which has
48    no line number information.  The normal behavior is that we step
49    over such function.  */
50 extern int step_stop_if_no_debug;
51
52 /* If set, the inferior should be controlled in non-stop mode.  In
53    this mode, each thread is controlled independently.  Execution
54    commands apply only to the selected thread by default, and stop
55    events stop only the thread that had the event -- the other threads
56    are kept running freely.  */
57 extern int non_stop;
58
59 /* When set (default), the target should attempt to disable the
60    operating system's address space randomization feature when
61    starting an inferior.  */
62 extern int disable_randomization;
63
64 /* Reverse execution.  */
65 enum exec_direction_kind
66   {
67     EXEC_FORWARD,
68     EXEC_REVERSE
69   };
70
71 /* The current execution direction.  This should only be set to enum
72    exec_direction_kind values.  It is only an int to make it
73    compatible with make_cleanup_restore_integer.  */
74 extern int execution_direction;
75
76 /* Save register contents here when executing a "finish" command or
77    are about to pop a stack dummy frame, if-and-only-if
78    proceed_to_finish is set.  Thus this contains the return value from
79    the called function (assuming values are returned in a
80    register).  */
81 extern struct regcache *stop_registers;
82
83 extern void start_remote (int from_tty);
84
85 /* Clear out all variables saying what to do when inferior is
86    continued or stepped.  First do this, then set the ones you want,
87    then call `proceed'.  STEP indicates whether we're preparing for a
88    step/stepi command.  */
89 extern void clear_proceed_status (int step);
90
91 extern void proceed (CORE_ADDR, enum gdb_signal, int);
92
93 /* The `resume' routine should only be called in special circumstances.
94    Normally, use `proceed', which handles a lot of bookkeeping.  */
95 extern void resume (int, enum gdb_signal);
96
97 /* Return a ptid representing the set of threads that we will proceed,
98    in the perspective of the user/frontend.  */
99 extern ptid_t user_visible_resume_ptid (int step);
100
101 extern void wait_for_inferior (void);
102
103 extern void normal_stop (void);
104
105 extern void get_last_target_status (ptid_t *ptid,
106                                     struct target_waitstatus *status);
107
108 extern void prepare_for_detach (void);
109
110 extern void fetch_inferior_event (void *);
111
112 extern void init_wait_for_inferior (void);
113
114 extern void insert_step_resume_breakpoint_at_sal (struct gdbarch *,
115                                                   struct symtab_and_line ,
116                                                   struct frame_id);
117
118 /* Returns true if we're trying to step past the instruction at
119    ADDRESS in ASPACE.  */
120 extern int stepping_past_instruction_at (struct address_space *aspace,
121                                          CORE_ADDR address);
122
123 /* Returns true if we're trying to step past an instruction that
124    triggers a non-steppable watchpoint.  */
125 extern int stepping_past_nonsteppable_watchpoint (void);
126
127 extern void set_step_info (struct frame_info *frame,
128                            struct symtab_and_line sal);
129
130 /* Several print_*_reason helper functions to print why the inferior
131    has stopped to the passed in UIOUT.  */
132
133 /* Signal received, print why the inferior has stopped.  */
134 extern void print_signal_received_reason (struct ui_out *uiout,
135                                           enum gdb_signal siggnal);
136
137 /* Print why the inferior has stopped.  We are done with a
138    step/next/si/ni command, print why the inferior has stopped.  */
139 extern void print_end_stepping_range_reason (struct ui_out *uiout);
140
141 /* The inferior was terminated by a signal, print why it stopped.  */
142 extern void print_signal_exited_reason (struct ui_out *uiout,
143                                         enum gdb_signal siggnal);
144
145 /* The inferior program is finished, print why it stopped.  */
146 extern void print_exited_reason (struct ui_out *uiout, int exitstatus);
147
148 /* Reverse execution: target ran out of history info, print why the
149    inferior has stopped.  */
150 extern void print_no_history_reason (struct ui_out *uiout);
151
152 extern void print_stop_event (struct target_waitstatus *ws);
153
154 extern int signal_stop_state (int);
155
156 extern int signal_print_state (int);
157
158 extern int signal_pass_state (int);
159
160 extern int signal_stop_update (int, int);
161
162 extern int signal_print_update (int, int);
163
164 extern int signal_pass_update (int, int);
165
166 extern void update_signals_program_target (void);
167
168 /* Clear the convenience variables associated with the exit of the
169    inferior.  Currently, those variables are $_exitcode and
170    $_exitsignal.  */
171 extern void clear_exit_convenience_vars (void);
172
173 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline.  */
174 extern void displaced_step_dump_bytes (struct ui_file *file,
175                                        const gdb_byte *buf, size_t len);
176
177 extern struct displaced_step_closure *get_displaced_step_closure_by_addr
178     (CORE_ADDR addr);
179
180 extern void update_observer_mode (void);
181
182 extern void signal_catch_update (const unsigned int *);
183
184 /* In some circumstances we allow a command to specify a numeric
185    signal.  The idea is to keep these circumstances limited so that
186    users (and scripts) develop portable habits.  For comparison,
187    POSIX.2 `kill' requires that 1,2,3,6,9,14, and 15 work (and using a
188    numeric signal at all is obsolescent.  We are slightly more lenient
189    and allow 1-15 which should match host signal numbers on most
190    systems.  Use of symbolic signal names is strongly encouraged.  */
191 enum gdb_signal gdb_signal_from_command (int num);
192
193 #endif /* INFRUN_H */