]> Git Repo - binutils.git/blob - gdb/observable.h
[gdb] Fix heap-buffer-overflow in completion_tracker::build_completion_result
[binutils.git] / gdb / observable.h
1 /* Observers
2
3    Copyright (C) 2016-2020 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #ifndef OBSERVABLE_H
21 #define OBSERVABLE_H
22
23 #include "gdbsupport/observable.h"
24
25 struct bpstats;
26 struct so_list;
27 struct objfile;
28 struct thread_info;
29 struct inferior;
30 struct process_stratum_target;
31 struct trace_state_variable;
32
33 namespace gdb
34 {
35
36 namespace observers
37 {
38
39 /* The inferior has stopped for real.  The BS argument describes the
40    breakpoints were are stopped at, if any.  Second argument
41    PRINT_FRAME non-zero means display the location where the
42    inferior has stopped.
43
44    gdb notifies all normal_stop observers when the inferior execution
45    has just stopped, the associated messages and annotations have been
46    printed, and the control is about to be returned to the user.
47
48    Note that the normal_stop notification is not emitted when the
49    execution stops due to a breakpoint, and this breakpoint has a
50    condition that is not met.  If the breakpoint has any associated
51    commands list, the commands are executed after the notification is
52    emitted.  */
53 extern observable<struct bpstats */* bs */, int /* print_frame */> normal_stop;
54
55 /* The inferior was stopped by a signal.  */
56 extern observable<enum gdb_signal /* siggnal */> signal_received;
57
58 /* We are done with a step/next/si/ni command.  */
59 extern observable<> end_stepping_range;
60
61 /* The inferior was terminated by a signal.  */
62 extern observable<enum gdb_signal /* siggnal */> signal_exited;
63
64 /* The inferior program is finished.  */
65 extern observable<int /* exitstatus */> exited;
66
67 /* Reverse execution: target ran out of history info.  */
68 extern observable<> no_history;
69
70 /* A synchronous command finished.  */
71 extern observable<> sync_execution_done;
72
73 /* An error was caught while executing a command.  */
74 extern observable<> command_error;
75
76 /* The target's register contents have changed.  */
77 extern observable<struct target_ops */* target */> target_changed;
78
79 /* The executable being debugged by GDB has changed: The user
80    decided to debug a different program, or the program he was
81    debugging has been modified since being loaded by the debugger
82    (by being recompiled, for instance).  */
83 extern observable<> executable_changed;
84
85 /* gdb has just connected to an inferior.  For 'run', gdb calls this
86    observer while the inferior is still stopped at the entry-point
87    instruction.  For 'attach' and 'core', gdb calls this observer
88    immediately after connecting to the inferior, and before any
89    information on the inferior has been printed.  */
90 extern observable<inferior */* inferior */> inferior_created;
91
92 /* The status of process record for inferior inferior in gdb has
93    changed.  The process record is started if STARTED is true, and
94    the process record is stopped if STARTED is false.
95
96    When STARTED is true, METHOD indicates the short name of the
97    method used for recording.  If the method supports multiple
98    formats, FORMAT indicates which one is being used, otherwise it
99    is NULL.  When STARTED is false, they are both NULL.  */
100 extern observable<struct inferior */* inferior */, int /* started */,
101                   const char */* method */, const char */* format */>
102     record_changed;
103
104 /* The shared library specified by SOLIB has been loaded.  Note that
105    when gdb calls this observer, the library's symbols probably
106    haven't been loaded yet.  */
107 extern observable<struct so_list */* solib */> solib_loaded;
108
109 /* The shared library specified by SOLIB has been unloaded.  Note
110    that when gdb calls this observer, the library's symbols have not
111    been unloaded yet, and thus are still available.  */
112 extern observable<struct so_list */* solib */> solib_unloaded;
113
114 /* The symbol file specified by OBJFILE has been loaded.  Called
115    with OBJFILE equal to NULL to indicate previously loaded symbol
116    table data has now been invalidated.  */
117 extern observable<struct objfile */* objfile */> new_objfile;
118
119 /* The object file specified by OBJFILE is about to be freed.  */
120 extern observable<struct objfile */* objfile */> free_objfile;
121
122 /* The thread specified by T has been created.  */
123 extern observable<struct thread_info */* t */> new_thread;
124
125 /* The thread specified by T has exited.  The SILENT argument
126    indicates that gdb is removing the thread from its tables without
127    wanting to notify the user about it.  */
128 extern observable<struct thread_info */* t */, int /* silent */> thread_exit;
129
130 /* An explicit stop request was issued to PTID.  If PTID equals
131    minus_one_ptid, the request applied to all threads.  If
132    ptid_is_pid(PTID) returns true, the request applied to all
133    threads of the process pointed at by PTID.  Otherwise, the
134    request applied to the single thread pointed at by PTID.  */
135 extern observable<ptid_t /* ptid */> thread_stop_requested;
136
137 /* The target was resumed.  The PTID parameter specifies which
138    thread was resume, and may be RESUME_ALL if all threads are
139    resumed.  */
140 extern observable<ptid_t /* ptid */> target_resumed;
141
142 /* The target is about to be proceeded.  */
143 extern observable<> about_to_proceed;
144
145 /* A new breakpoint B has been created.  */
146 extern observable<struct breakpoint */* b */> breakpoint_created;
147
148 /* A breakpoint has been destroyed.  The argument B is the
149    pointer to the destroyed breakpoint.  */
150 extern observable<struct breakpoint */* b */> breakpoint_deleted;
151
152 /* A breakpoint has been modified in some way.  The argument B
153    is the modified breakpoint.  */
154 extern observable<struct breakpoint */* b */> breakpoint_modified;
155
156 /* The trace frame is changed to TFNUM (e.g., by using the 'tfind'
157    command).  If TFNUM is negative, it means gdb resumes live
158    debugging.  The number of the tracepoint associated with this
159    traceframe is TPNUM.  */
160 extern observable<int /* tfnum */, int /* tpnum */> traceframe_changed;
161
162 /* The current architecture has changed.  The argument NEWARCH is a
163    pointer to the new architecture.  */
164 extern observable<struct gdbarch */* newarch */> architecture_changed;
165
166 /* The thread's ptid has changed.  The OLD_PTID parameter specifies
167    the old value, and NEW_PTID specifies the new value.  */
168 extern observable<process_stratum_target * /* target */,
169                   ptid_t /* old_ptid */, ptid_t /* new_ptid */>
170   thread_ptid_changed;
171
172 /* The inferior INF has been added to the list of inferiors.  At
173    this point, it might not be associated with any process.  */
174 extern observable<struct inferior */* inf */> inferior_added;
175
176 /* The inferior identified by INF has been attached to a
177    process.  */
178 extern observable<struct inferior */* inf */> inferior_appeared;
179
180 /* Either the inferior associated with INF has been detached from
181    the process, or the process has exited.  */
182 extern observable<struct inferior */* inf */> inferior_exit;
183
184 /* The inferior INF has been removed from the list of inferiors.
185    This method is called immediately before freeing INF.  */
186 extern observable<struct inferior */* inf */> inferior_removed;
187
188 /* Bytes from DATA to DATA + LEN have been written to the inferior
189    at ADDR.  */
190 extern observable<struct inferior */* inferior */, CORE_ADDR /* addr */,
191                   ssize_t /* len */, const bfd_byte */* data */>
192     memory_changed;
193
194 /* Called before a top-level prompt is displayed.  CURRENT_PROMPT is
195    the current top-level prompt.  */
196 extern observable<const char */* current_prompt */> before_prompt;
197
198 /* Variable gdb_datadir has been set.  The value may not necessarily
199    change.  */
200 extern observable<> gdb_datadir_changed;
201
202 /* The parameter of some 'set' commands in console are changed.
203    This method is called after a command 'set param value'.  PARAM
204    is the parameter of 'set' command, and VALUE is the value of
205    changed parameter.  */
206 extern observable<const char */* param */, const char */* value */>
207     command_param_changed;
208
209 /* The new trace state variable TSV is created.  */
210 extern observable<const struct trace_state_variable */* tsv */> tsv_created;
211
212 /* The trace state variable TSV is deleted.  If TSV is NULL, all
213    trace state variables are deleted.  */
214 extern observable<const struct trace_state_variable */* tsv */> tsv_deleted;
215
216 /* The trace state value TSV is modified.  */
217 extern observable<const struct trace_state_variable */* tsv */> tsv_modified;
218
219 /* An inferior function at ADDRESS is about to be called in thread
220    THREAD.  */
221 extern observable<ptid_t /* thread */, CORE_ADDR /* address */>
222     inferior_call_pre;
223
224 /* The inferior function at ADDRESS has just been called.  This
225    observer is called even if the inferior exits during the call.
226    THREAD is the thread in which the function was called, which may
227    be different from the current thread.  */
228 extern observable<ptid_t /* thread */, CORE_ADDR /* address */>
229     inferior_call_post;
230
231 /* A register in the inferior has been modified by the gdb user.  */
232 extern observable<struct frame_info */* frame */, int /* regnum */>
233     register_changed;
234
235 /* The user-selected inferior, thread and/or frame has changed.  The
236    user_select_what flag specifies if the inferior, thread and/or
237    frame has changed.  */
238 extern observable<user_selected_what /* selection */>
239     user_selected_context_changed;
240
241 /* This is notified when the source styling setting has changed and
242    should be reconsulted.  */
243 extern observable<> source_styling_changed;
244
245 /* The CLI's notion of the current source has changed.  This differs
246    from user_selected_context_changed in that it is also set by the
247    "list" command.  */
248
249 extern observable<> current_source_symtab_and_line_changed;
250
251 } /* namespace observers */
252
253 } /* namespace gdb */
254
255 #endif /* OBSERVABLE_H */
This page took 0.047078 seconds and 4 git commands to generate.