gdb/observable.h

   1 /* Observers
   2
   3    Copyright (C) 2016-2023 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 #include "target/waitstatus.h"
  25
  26 struct bpstat;
  27 struct so_list;
  28 struct objfile;
  29 struct thread_info;
  30 struct inferior;
  31 struct process_stratum_target;
  32 struct target_ops;
  33 struct trace_state_variable;
  34
  35 namespace gdb
  36 {
  37
  38 namespace observers
  39 {
  40
  41 /* The inferior has stopped for real.  The BS argument describes the
  42    breakpoints were are stopped at, if any.  Second argument
  43    PRINT_FRAME non-zero means display the location where the
  44    inferior has stopped.
  45
  46    gdb notifies all normal_stop observers when the inferior execution
  47    has just stopped, the associated messages and annotations have been
  48    printed, and the control is about to be returned to the user.
  49
  50    Note that the normal_stop notification is not emitted when the
  51    execution stops due to a breakpoint, and this breakpoint has a
  52    condition that is not met.  If the breakpoint has any associated
  53    commands list, the commands are executed after the notification is
  54    emitted.  */
  55 extern observable<struct bpstat */* bs */, int /* print_frame */> normal_stop;
  56
  57 /* The inferior was stopped by a signal.  */
  58 extern observable<enum gdb_signal /* siggnal */> signal_received;
  59
  60 /* We are done with a step/next/si/ni command.  */
  61 extern observable<> end_stepping_range;
  62
  63 /* The inferior was terminated by a signal.  */
  64 extern observable<enum gdb_signal /* siggnal */> signal_exited;
  65
  66 /* The inferior program is finished.  */
  67 extern observable<int /* exitstatus */> exited;
  68
  69 /* Reverse execution: target ran out of history info.  */
  70 extern observable<> no_history;
  71
  72 /* A synchronous command finished.  */
  73 extern observable<> sync_execution_done;
  74
  75 /* An error was caught while executing a command.  */
  76 extern observable<> command_error;
  77
  78 /* The target's register contents have changed.  */
  79 extern observable<struct target_ops */* target */> target_changed;
  80
  81 /* The executable being debugged by GDB has changed: The user
  82    decided to debug a different program, or the program he was
  83    debugging has been modified since being loaded by the debugger
  84    (by being recompiled, for instance).  */
  85 extern observable<> executable_changed;
  86
  87 /* gdb has just connected to an inferior.  For 'run', gdb calls this
  88    observer while the inferior is still stopped at the entry-point
  89    instruction.  For 'attach' and 'core', gdb calls this observer
  90    immediately after connecting to the inferior, and before any
  91    information on the inferior has been printed.  */
  92 extern observable<inferior */* inferior */> inferior_created;
  93
  94 /* The inferior EXEC_INF has exec'ed a new executable file.
  95
  96    Execution continues in FOLLOW_INF, which may or may not be the same as
  97    EXEC_INF, depending on "set follow-exec-mode".  */
  98 extern observable<inferior */* exec_inf */, inferior */* follow_inf */>
  99     inferior_execd;
 100
 101 /* The inferior PARENT_INF has forked.  If we are setting up an inferior for
 102    the child (because we follow only the child or we follow both), CHILD_INF
 103    is the child inferior.  Otherwise, CHILD_INF is nullptr.
 104
 105    FORK_KIND is TARGET_WAITKIND_FORKED or TARGET_WAITKIND_VFORKED.  */
 106 extern observable<inferior */* parent_inf */, inferior */* child_inf */,
 107                   target_waitkind /* fork_kind */> inferior_forked;
 108
 109 /* The status of process record for inferior inferior in gdb has
 110    changed.  The process record is started if STARTED is true, and
 111    the process record is stopped if STARTED is false.
 112
 113    When STARTED is true, METHOD indicates the short name of the
 114    method used for recording.  If the method supports multiple
 115    formats, FORMAT indicates which one is being used, otherwise it
 116    is NULL.  When STARTED is false, they are both NULL.  */
 117 extern observable<struct inferior */* inferior */, int /* started */,
 118                   const char */* method */, const char */* format */>
 119     record_changed;
 120
 121 /* The shared library specified by SOLIB has been loaded.  Note that
 122    when gdb calls this observer, the library's symbols probably
 123    haven't been loaded yet.  */
 124 extern observable<struct so_list */* solib */> solib_loaded;
 125
 126 /* The shared library specified by SOLIB has been unloaded.  Note
 127    that when gdb calls this observer, the library's symbols have not
 128    been unloaded yet, and thus are still available.  */
 129 extern observable<struct so_list */* solib */> solib_unloaded;
 130
 131 /* The symbol file specified by OBJFILE has been loaded.  Called
 132    with OBJFILE equal to NULL to indicate previously loaded symbol
 133    table data has now been invalidated.  */
 134 extern observable<struct objfile */* objfile */> new_objfile;
 135
 136 /* The object file specified by OBJFILE is about to be freed.  */
 137 extern observable<struct objfile */* objfile */> free_objfile;
 138
 139 /* The thread specified by T has been created.  */
 140 extern observable<struct thread_info */* t */> new_thread;
 141
 142 /* The thread specified by T has exited.  The SILENT argument
 143    indicates that gdb is removing the thread from its tables without
 144    wanting to notify the user about it.  */
 145 extern observable<struct thread_info */* t */, int /* silent */> thread_exit;
 146
 147 /* An explicit stop request was issued to PTID.  If PTID equals
 148    minus_one_ptid, the request applied to all threads.  If
 149    ptid_is_pid(PTID) returns true, the request applied to all
 150    threads of the process pointed at by PTID.  Otherwise, the
 151    request applied to the single thread pointed at by PTID.  */
 152 extern observable<ptid_t /* ptid */> thread_stop_requested;
 153
 154 /* The target was resumed.  The PTID parameter specifies which
 155    thread was resume, and may be RESUME_ALL if all threads are
 156    resumed.  */
 157 extern observable<ptid_t /* ptid */> target_resumed;
 158
 159 /* The target is about to be proceeded.  */
 160 extern observable<> about_to_proceed;
 161
 162 /* A new breakpoint B has been created.  */
 163 extern observable<struct breakpoint */* b */> breakpoint_created;
 164
 165 /* A breakpoint has been destroyed.  The argument B is the
 166    pointer to the destroyed breakpoint.  */
 167 extern observable<struct breakpoint */* b */> breakpoint_deleted;
 168
 169 /* A breakpoint has been modified in some way.  The argument B
 170    is the modified breakpoint.  */
 171 extern observable<struct breakpoint */* b */> breakpoint_modified;
 172
 173 /* The trace frame is changed to TFNUM (e.g., by using the 'tfind'
 174    command).  If TFNUM is negative, it means gdb resumes live
 175    debugging.  The number of the tracepoint associated with this
 176    traceframe is TPNUM.  */
 177 extern observable<int /* tfnum */, int /* tpnum */> traceframe_changed;
 178
 179 /* The current architecture has changed.  The argument NEWARCH is a
 180    pointer to the new architecture.  */
 181 extern observable<struct gdbarch */* newarch */> architecture_changed;
 182
 183 /* The thread's ptid has changed.  The OLD_PTID parameter specifies
 184    the old value, and NEW_PTID specifies the new value.  */
 185 extern observable<process_stratum_target * /* target */,
 186                   ptid_t /* old_ptid */, ptid_t /* new_ptid */>
 187   thread_ptid_changed;
 188
 189 /* The inferior INF has been added to the list of inferiors.  At
 190    this point, it might not be associated with any process.  */
 191 extern observable<struct inferior */* inf */> inferior_added;
 192
 193 /* The inferior identified by INF has been attached to a
 194    process.  */
 195 extern observable<struct inferior */* inf */> inferior_appeared;
 196
 197 /* Inferior INF is about to be detached.  */
 198 extern observable<struct inferior */* inf */> inferior_pre_detach;
 199
 200 /* Either the inferior associated with INF has been detached from
 201    the process, or the process has exited.  */
 202 extern observable<struct inferior */* inf */> inferior_exit;
 203
 204 /* The inferior INF has been removed from the list of inferiors.
 205    This method is called immediately before freeing INF.  */
 206 extern observable<struct inferior */* inf */> inferior_removed;
 207
 208 /* Bytes from DATA to DATA + LEN have been written to the inferior
 209    at ADDR.  */
 210 extern observable<struct inferior */* inferior */, CORE_ADDR /* addr */,
 211                   ssize_t /* len */, const bfd_byte */* data */>
 212     memory_changed;
 213
 214 /* Called before a top-level prompt is displayed.  CURRENT_PROMPT is
 215    the current top-level prompt.  */
 216 extern observable<const char */* current_prompt */> before_prompt;
 217
 218 /* Variable gdb_datadir has been set.  The value may not necessarily
 219    change.  */
 220 extern observable<> gdb_datadir_changed;
 221
 222 /* The parameter of some 'set' commands in console are changed.
 223    This method is called after a command 'set param value'.  PARAM
 224    is the parameter of 'set' command, and VALUE is the value of
 225    changed parameter.  */
 226 extern observable<const char */* param */, const char */* value */>
 227     command_param_changed;
 228
 229 /* The new trace state variable TSV is created.  */
 230 extern observable<const struct trace_state_variable */* tsv */> tsv_created;
 231
 232 /* The trace state variable TSV is deleted.  If TSV is NULL, all
 233    trace state variables are deleted.  */
 234 extern observable<const struct trace_state_variable */* tsv */> tsv_deleted;
 235
 236 /* The trace state value TSV is modified.  */
 237 extern observable<const struct trace_state_variable */* tsv */> tsv_modified;
 238
 239 /* An inferior function at ADDRESS is about to be called in thread
 240    THREAD.  */
 241 extern observable<ptid_t /* thread */, CORE_ADDR /* address */>
 242     inferior_call_pre;
 243
 244 /* The inferior function at ADDRESS has just been called.  This
 245    observer is called even if the inferior exits during the call.
 246    THREAD is the thread in which the function was called, which may
 247    be different from the current thread.  */
 248 extern observable<ptid_t /* thread */, CORE_ADDR /* address */>
 249     inferior_call_post;
 250
 251 /* A register in the inferior has been modified by the gdb user.  */
 252 extern observable<frame_info_ptr /* frame */, int /* regnum */>
 253     register_changed;
 254
 255 /* The user-selected inferior, thread and/or frame has changed.  The
 256    user_select_what flag specifies if the inferior, thread and/or
 257    frame has changed.  */
 258 extern observable<user_selected_what /* selection */>
 259     user_selected_context_changed;
 260
 261 /* This is notified when a styling setting has changed, content may need
 262    to be updated based on the new settings.  */
 263 extern observable<> styling_changed;
 264
 265 /* The CLI's notion of the current source has changed.  This differs
 266    from user_selected_context_changed in that it is also set by the
 267    "list" command.  */
 268 extern observable<> current_source_symtab_and_line_changed;
 269
 270 /* Called when GDB is about to exit.  */
 271 extern observable<int> gdb_exiting;
 272
 273 /* When a connection is removed.  */
 274 extern observable<process_stratum_target */* target */> connection_removed;
 275
 276 /* About to enter target_wait (). */
 277 extern observable <ptid_t /* ptid */> target_pre_wait;
 278
 279 /* About to leave target_wait (). */
 280 extern observable <ptid_t /* event_ptid */> target_post_wait;
 281
 282 } /* namespace observers */
 283
 284 } /* namespace gdb */
 285
 286 #endif /* OBSERVABLE_H */