This page was produced by an automated import process, and may have formatting errors; feel free to fix. [GDB-Currently-available-observers ]
GDB Currently available observers
- [Implementation-rationale ]
An observer is an entity which is interested in being notified when GDB reaches certain states, or certain events occur in GDB. The entity being observed is called the subject. To receive notifications, the observer attaches a callback to the subject. One subject can have several observers.
observer.c implements an internal generic low-level event notification mechanism. This generic event notification mechanism is then re-used to implement the exported high-level notification management routines for all possible notifications.
The current implementation of the generic observer provides support for contextual data. This contextual data is given to the subject when attaching the callback. In return, the subject will provide this contextual data back to the observer as a parameter of the callback.
Note that the current support for the contextual data is only partial, as it lacks a mechanism that would deallocate this data when the callback is detached. This is not a problem so far, as this contextual data is only used internally to hold a function pointer. Later on, if a certain observer needs to provide support for user-level contextual data, then the generic notification mechanism will need to be enhanced to allow the observer to provide a routine to deallocate the data when attaching the callback.
The observer implementation is also currently not reentrant. In particular, it is therefore not possible to call the attach or detach routines during a notification. [Debugging ]
Observer notifications can be traced using the command ‘set debug observer 1’ (see [http://sourceware.org/gdb/current/onlinedocs/gdb/Debugging-Output.html#Debugging-Output Optional messages about internal happenings] in Debugging with GDBN). [normal_005fstop-Notifications ]
GDB notifies all normal_stop observers when the inferior execution has just stopped, the associated messages and annotations have been printed, and the control is about to be returned to the user.
Note that the normal_stop notification is not emitted when the execution stops due to a breakpoint, and this breakpoint has a condition that is not met. If the breakpoint has any associated commands list, the commands are executed after the notification is emitted.
The following interfaces are available to manage observers:
- Function: ''extern'' struct ''observer *observer_attach_''event'' (observer_''event''_ftype *''f'')''
Using the function f, create an observer that is notified when ever event occurs, return the observer.
- Function: ''extern'' void ''observer_detach_''event'' (struct observer *''observer'');''
Remove observer from the list of observers to be notified when event occurs.
Send a notification to all event observers.
The following observable events are defined:
- Function: ''void'' normal_stop ''(struct bpstats *''bs'', int ''print_frame'')''
The inferior has stopped for real. The bs argument describes the breakpoints were are stopped at, if any. Second argument print_frame non-zero means display the location where the inferior has stopped.
- Function: ''void'' target_changed ''(struct target_ops *''target'')''
The target’s register contents have changed.
- Function: ''void'' executable_changed ''(void)''
The executable being debugged by GDB has changed: The user decided to debug a different program, or the program he was debugging has been modified since being loaded by the debugger (by being recompiled, for instance).
- Function: ''void'' inferior_created ''(struct target_ops *''objfile'', int ''from_tty'')''
GDB has just connected to an inferior. For ‘run’, GDB calls this observer while the inferior is still stopped at the entry-point instruction. For ‘attach’ and ‘core’, GDB calls this observer immediately after connecting to the inferior, and before any information on the inferior has been printed.
- Function: ''void'' record_changed ''(struct inferior *''inferior'', int ''started'')''
The status of process record for inferior inferior in GDB has changed. The process record is started if started is true, and the process record is stopped if started is false.
- Function: ''void'' solib_loaded ''(struct so_list *''solib'')''
The shared library specified by solib has been loaded. Note that when GDB calls this observer, the library’s symbols probably haven’t been loaded yet.
- Function: ''void'' solib_unloaded ''(struct so_list *''solib'')''
The shared library specified by solib has been unloaded. Note that when GDB calls this observer, the library’s symbols have not been unloaded yet, and thus are still available.
- Function: ''void'' new_objfile ''(struct objfile *''objfile'')''
The symbol file specified by objfile has been loaded. Called with objfile equal to NULL to indicate previously loaded symbol table data has now been invalidated.
- Function: ''void'' new_thread ''(struct thread_info *''t'')''
The thread specified by t has been created.
- Function: ''void'' thread_exit ''(struct thread_info *''t'', int ''silent'')''
The thread specified by t has exited. The silent argument indicates that GDB is removing the thread from its tables without wanting to notify the user about it.
- Function: ''void'' thread_stop_requested ''(ptid_t ''ptid'')''
An explicit stop request was issued to ptid. If ptid equals minus_one_ptid, the request applied to all threads. If ptid_is_pid(ptid) returns true, the request applied to all threads of the process pointed at by ptid. Otherwise, the request applied to the single thread pointed at by ptid.
- Function: ''void'' target_resumed ''(ptid_t ''ptid'')''
The target was resumed. The ptid parameter specifies which thread was resume, and may be RESUME_ALL if all threads are resumed.
- Function: ''void'' about_to_proceed ''(void)''
The target is about to be proceeded.
- Function: ''void'' breakpoint_created ''(struct breakpoint *''b'')''
A new breakpoint b has been created.
- Function: ''void'' breakpoint_deleted ''(struct breakpoint *''b'')''
A breakpoint has been destroyed. The argument b is the pointer to the destroyed breakpoint.
- Function: ''void'' breakpoint_modified ''(struct breakpoint *''b'')''
A breakpoint has been modified in some way. The argument b is the modified breakpoint.
- Function: ''void'' traceframe_changed ''(int ''tfnum'', int ''tpnum'')''
The trace frame is changed to tfnum (e.g., by using the tfind command). If tfnum is negative, it means GDB resumes live debugging. The number of the tracepoint associated with this traceframe is tpnum.
- Function: ''void'' architecture_changed ''(struct gdbarch *''newarch'')''
The current architecture has changed. The argument newarch is a pointer to the new architecture.
- Function: ''void'' thread_ptid_changed ''(ptid_t ''old_ptid'', ptid_t ''new_ptid'')''
The thread’s ptid has changed. The old_ptid parameter specifies the old value, and new_ptid specifies the new value.
- Function: ''void'' inferior_added ''(struct inferior *''inf'')''
The inferior inf has been added to the list of inferiors. At this point, it might not be associated with any process.
- Function: ''void'' inferior_appeared ''(struct inferior *''inf'')''
The inferior identified by inf has been attached to a process.
- Function: ''void'' inferior_exit ''(struct inferior *''inf'')''
Either the inferior associated with inf has been detached from the process, or the process has exited.
- Function: ''void'' inferior_removed ''(struct inferior *''inf'')''
The inferior inf has been removed from the list of inferiors. This method is called immediately before freeing inf.
- Function: ''void'' memory_changed ''(struct inferior *''inferior'', CORE_ADDR ''addr'', ssize_t ''len'', const bfd_byte *''data'')''
Bytes from data to data + len have been written to the inferior at addr.
- Function: ''void'' before_prompt ''(const char *''current_prompt'')''
Called before a top-level prompt is displayed. current_prompt is the current top-level prompt.
- Function: ''void'' gdb_datadir_changed ''(void)''
Variable gdb_datadir has been set. The value may not necessarily change.
- Function: ''void'' command_param_changed ''(const char *''param'', const char *''value'')''
The parameter of some set commands in console are changed. This method is called after a command set ''param'' ''value''. param is the parameter of set command, and value is the value of changed parameter.
- Function: ''void'' tsv_created ''(const struct trace_state_variable *''tsv'')''
The new trace state variable tsv is created.
- Function: ''void'' tsv_deleted ''(const struct trace_state_variable *''tsv'')''
The trace state variable tsv is deleted. If tsv is NULL, all trace state variables are deleted.
- Function: ''void'' tsv_modified ''(const struct trace_state_variable *''tsv'')''
The trace state value tsv is modified.
- Function: ''void'' test_notification ''(int ''somearg'')''
This observer is used for internal testing. Do not use. See testsuite/gdb.gdb/observer.exp.