2003-03-18 17:44:23 +00:00
|
|
|
@c -*-texinfo-*-
|
2006-05-10 18:49:08 +00:00
|
|
|
|
|
|
|
|
@c This file is part of the GDB manual.
|
|
|
|
|
@c
|
gdb:
* tui/tui-hooks.c: Include observer.h.
(tui_event_default, tui_old_event_hooks, tui_event_hooks):
Remove.
(tui_bp_created_observer, tui_bp_deleted_observer,
tui_bp_modified_observer): New globals.
(tui_install_hooks): Use observers, not events.
(tui_remove_hooks): Likewise.
* mi/mi-cmd-break.c: Include observer.h, not gdb-events.h.
(mi_breakpoint_observers_installed, mi_can_breakpoint_notify): New
globals.
(breakpoint_notify): Check mi_can_breakpoint_notify.
(breakpoint_hooks): Remove.
(mi_cmd_break_insert): Attach observers. Don't use events.
* tracepoint.c: Include observer.h, not gdb-events.h.
(tracepoint_operation, trace_pass_command): Notify observer.
* interps.c: Don't include gdb-events.h.
(clear_interpreter_hooks): Don't call clear_gdb_event_hooks.
* gdbarch.c: Rebuild.
* gdbarch.sh: Emit include for observer.h, not gdb-events.h.
(deprecated_current_gdbarch_select_hack): Notify observer.
* breakpoint.h: Don't include gdb-events.h.
* breakpoint.c: Don't include gdb-events.h.
(condition_command): Notify observer.
(commands_command): Likewise.
(commands_from_control_command): Likewise.
(mention, delete_breakpoint, set_ignore_count): Likewise.
(disable_breakpoint, do_enable_breakpoint): Likewise.
* Makefile.in (gdb_events_h): Remove.
(breakpoint_h): Update.
(COMMON_OBS): Remove gdb-events.o.
(gdb-events.o): Remove.
(breakpoint.o, gdbarch.o, interps.o, tracepoint.o, gdbtk-bp.o,
gdbtk-hooks.o, mi-cmd-break.o, tui-hooks.o): Update.
* gdb-events.c: Remove.
* gdb-events.h: Remove.
* gdb-events.sh: Remove.
gdb/doc:
* observer.texi (GDB Observers): Document new observers:
breakpoint_created, breakpoint_deleted, breakpoint_modified,
tracepoint_created, tracepoint_deleted, tracepoint_modified,
architecture_changed.
gdb/gdbtk:
* generic/gdbtk-hooks.c: Include observer.h, not gdb-events.h.
(gdbtk_add_hooks): Use observers, not events.
(gdbtk_architecture_changed): Add argument, for observer.
* generic/gdbtk-bp.c: Include observer.h.
(gdb_set_bp): Notify observer.
(gdb_set_bp_addr): Likewise.
2008-07-25 16:12:03 +00:00
|
|
|
@c Copyright (C) 2003, 2004, 2005, 2006, 2008
|
2006-05-10 18:49:08 +00:00
|
|
|
@c Free Software Foundation, Inc.
|
|
|
|
|
@c
|
|
|
|
|
@c See the file gdbint.texinfo for copying conditions.
|
|
|
|
|
@c
|
|
|
|
|
@c Also, the @deftypefun lines from this file are processed into a
|
|
|
|
|
@c header file during the GDB build process. Permission is granted
|
|
|
|
|
@c to redistribute and/or modify those lines under the terms of the
|
|
|
|
|
@c GNU General Public License as published by the Free Software
|
|
|
|
|
@c Foundation; either version 2 of the License, or (at your option)
|
|
|
|
|
@c any later version.
|
|
|
|
|
|
2003-03-18 17:44:23 +00:00
|
|
|
@node GDB Observers
|
|
|
|
|
@appendix @value{GDBN} Currently available observers
|
|
|
|
|
|
|
|
|
|
@section Implementation rationale
|
|
|
|
|
@cindex observers implementation rationale
|
|
|
|
|
|
|
|
|
|
An @dfn{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 @dfn{subject}. To receive
|
|
|
|
|
notifications, the observer attaches a callback to the subject.
|
|
|
|
|
One subject can have several observers.
|
|
|
|
|
|
|
|
|
|
@file{observer.c} implements an internal generic low-level event
|
2003-04-03 15:14:48 +00:00
|
|
|
notification mechanism. This generic event notification mechanism is
|
2003-03-18 17:44:23 +00:00
|
|
|
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
|
2003-04-03 15:14:48 +00:00
|
|
|
data, then the generic notification mechanism will need to be
|
2003-03-18 17:44:23 +00:00
|
|
|
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.
|
|
|
|
|
|
2004-05-07 22:51:55 +00:00
|
|
|
@section Debugging
|
|
|
|
|
Observer notifications can be traced using the command @samp{set debug
|
|
|
|
|
observer 1} (@pxref{Debugging Output, , Optional messages about
|
|
|
|
|
internal happenings, gdb, Debugging with @var{GDBN}}).
|
|
|
|
|
|
2003-03-18 17:44:23 +00:00
|
|
|
@section @code{normal_stop} Notifications
|
|
|
|
|
@cindex @code{normal_stop} observer
|
|
|
|
|
@cindex notification about inferior execution stop
|
|
|
|
|
|
2003-04-03 15:14:48 +00:00
|
|
|
@value{GDBN} notifies all @code{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
|
2006-05-10 18:49:08 +00:00
|
|
|
to the user.
|
2003-04-03 15:14:48 +00:00
|
|
|
|
|
|
|
|
Note that the @code{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.
|
2003-03-18 17:44:23 +00:00
|
|
|
|
2004-04-15 14:29:21 +00:00
|
|
|
The following interfaces are available to manage observers:
|
2003-03-18 17:44:23 +00:00
|
|
|
|
2004-04-15 14:29:21 +00:00
|
|
|
@deftypefun extern struct observer *observer_attach_@var{event} (observer_@var{event}_ftype *@var{f})
|
|
|
|
|
Using the function @var{f}, create an observer that is notified when
|
2007-01-20 16:51:56 +00:00
|
|
|
ever @var{event} occurs, return the observer.
|
2003-03-18 17:44:23 +00:00
|
|
|
@end deftypefun
|
|
|
|
|
|
2004-04-15 14:29:21 +00:00
|
|
|
@deftypefun extern void observer_detach_@var{event} (struct observer *@var{observer});
|
2003-03-18 17:44:23 +00:00
|
|
|
Remove @var{observer} from the list of observers to be notified when
|
2004-04-15 14:29:21 +00:00
|
|
|
@var{event} occurs.
|
2003-03-18 17:44:23 +00:00
|
|
|
@end deftypefun
|
|
|
|
|
|
2004-04-15 14:29:21 +00:00
|
|
|
@deftypefun extern void observer_notify_@var{event} (void);
|
|
|
|
|
Send a notification to all @var{event} observers.
|
2003-03-18 17:44:23 +00:00
|
|
|
@end deftypefun
|
|
|
|
|
|
2004-04-15 14:29:21 +00:00
|
|
|
The following observable events are defined:
|
2003-03-18 17:44:23 +00:00
|
|
|
|
2004-04-15 14:29:21 +00:00
|
|
|
@deftypefun void normal_stop (struct bpstats *@var{bs})
|
|
|
|
|
The inferior has stopped for real.
|
|
|
|
|
@end deftypefun
|
2004-04-26 09:36:56 +00:00
|
|
|
|
|
|
|
|
@deftypefun void target_changed (struct target_ops *@var{target})
|
2004-04-30 07:38:50 +00:00
|
|
|
The target's register contents have changed.
|
2004-04-26 09:36:56 +00:00
|
|
|
@end deftypefun
|
2004-05-21 16:04:03 +00:00
|
|
|
|
2008-07-21 16:47:11 +00:00
|
|
|
@deftypefun void executable_changed (void)
|
2005-03-08 04:34:45 +00:00
|
|
|
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).
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
2004-05-21 16:04:03 +00:00
|
|
|
@deftypefun void inferior_created (struct target_ops *@var{objfile}, int @var{from_tty})
|
|
|
|
|
@value{GDBN} has just connected to an inferior. For @samp{run},
|
|
|
|
|
@value{GDBN} calls this observer while the inferior is still stopped
|
|
|
|
|
at the entry-point instruction. For @samp{attach} and @samp{core},
|
|
|
|
|
@value{GDBN} calls this observer immediately after connecting to the
|
|
|
|
|
inferior, and before any information on the inferior has been printed.
|
|
|
|
|
@end deftypefun
|
2004-09-01 17:59:37 +00:00
|
|
|
|
2005-01-12 20:48:08 +00:00
|
|
|
@deftypefun void solib_loaded (struct so_list *@var{solib})
|
|
|
|
|
The shared library specified by @var{solib} has been loaded. Note that
|
|
|
|
|
when @value{GDBN} calls this observer, the library's symbols probably
|
|
|
|
|
haven't been loaded yet.
|
2004-09-01 17:59:37 +00:00
|
|
|
@end deftypefun
|
|
|
|
|
|
2005-01-12 20:48:08 +00:00
|
|
|
@deftypefun void solib_unloaded (struct so_list *@var{solib})
|
|
|
|
|
The shared library specified by @var{solib} has been unloaded.
|
|
|
|
|
@end deftypefun
|
2007-05-11 19:55:20 +00:00
|
|
|
|
|
|
|
|
@deftypefun void new_objfile (struct objfile *@var{objfile})
|
|
|
|
|
The symbol file specified by @var{objfile} has been loaded.
|
|
|
|
|
Called with @var{objfile} equal to @code{NULL} to indicate
|
|
|
|
|
previously loaded symbol table data has now been invalidated.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
2008-03-14 17:21:08 +00:00
|
|
|
@deftypefun void new_thread (struct thread_info *@var{t})
|
|
|
|
|
The thread specified by @var{t} has been created.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
2008-05-03 15:10:42 +00:00
|
|
|
@deftypefun void thread_exit (struct thread_info *@var{t})
|
|
|
|
|
The thread specified by @var{t} has exited.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
2008-06-10 10:23:54 +00:00
|
|
|
@deftypefun void target_resumed (ptid_t @var{ptid})
|
|
|
|
|
The target was resumed. The @var{ptid} parameter specifies which
|
|
|
|
|
thread was resume, and may be RESUME_ALL if all threads are resumed.
|
|
|
|
|
@end deftypefun
|
gdb:
* tui/tui-hooks.c: Include observer.h.
(tui_event_default, tui_old_event_hooks, tui_event_hooks):
Remove.
(tui_bp_created_observer, tui_bp_deleted_observer,
tui_bp_modified_observer): New globals.
(tui_install_hooks): Use observers, not events.
(tui_remove_hooks): Likewise.
* mi/mi-cmd-break.c: Include observer.h, not gdb-events.h.
(mi_breakpoint_observers_installed, mi_can_breakpoint_notify): New
globals.
(breakpoint_notify): Check mi_can_breakpoint_notify.
(breakpoint_hooks): Remove.
(mi_cmd_break_insert): Attach observers. Don't use events.
* tracepoint.c: Include observer.h, not gdb-events.h.
(tracepoint_operation, trace_pass_command): Notify observer.
* interps.c: Don't include gdb-events.h.
(clear_interpreter_hooks): Don't call clear_gdb_event_hooks.
* gdbarch.c: Rebuild.
* gdbarch.sh: Emit include for observer.h, not gdb-events.h.
(deprecated_current_gdbarch_select_hack): Notify observer.
* breakpoint.h: Don't include gdb-events.h.
* breakpoint.c: Don't include gdb-events.h.
(condition_command): Notify observer.
(commands_command): Likewise.
(commands_from_control_command): Likewise.
(mention, delete_breakpoint, set_ignore_count): Likewise.
(disable_breakpoint, do_enable_breakpoint): Likewise.
* Makefile.in (gdb_events_h): Remove.
(breakpoint_h): Update.
(COMMON_OBS): Remove gdb-events.o.
(gdb-events.o): Remove.
(breakpoint.o, gdbarch.o, interps.o, tracepoint.o, gdbtk-bp.o,
gdbtk-hooks.o, mi-cmd-break.o, tui-hooks.o): Update.
* gdb-events.c: Remove.
* gdb-events.h: Remove.
* gdb-events.sh: Remove.
gdb/doc:
* observer.texi (GDB Observers): Document new observers:
breakpoint_created, breakpoint_deleted, breakpoint_modified,
tracepoint_created, tracepoint_deleted, tracepoint_modified,
architecture_changed.
gdb/gdbtk:
* generic/gdbtk-hooks.c: Include observer.h, not gdb-events.h.
(gdbtk_add_hooks): Use observers, not events.
(gdbtk_architecture_changed): Add argument, for observer.
* generic/gdbtk-bp.c: Include observer.h.
(gdb_set_bp): Notify observer.
(gdb_set_bp_addr): Likewise.
2008-07-25 16:12:03 +00:00
|
|
|
|
|
|
|
|
@deftypefun void breakpoint_created (int @var{bpnum})
|
|
|
|
|
A new breakpoint has been created. The argument @var{bpnum} is the
|
|
|
|
|
number of the newly-created breakpoint.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
|
|
|
|
@deftypefun void breakpoint_deleted (int @var{bpnum})
|
|
|
|
|
A breakpoint has been destroyed. The argument @var{bpnum} is the
|
|
|
|
|
number of the newly-destroyed breakpoint.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
|
|
|
|
@deftypefun void breakpoint_modified (int @var{bpnum})
|
|
|
|
|
A breakpoint has been modified in some way. The argument @var{bpnum}
|
|
|
|
|
is the number of the modified breakpoint.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
|
|
|
|
@deftypefun void tracepoint_created (int @var{tpnum})
|
|
|
|
|
A new tracepoint has been created. The argument @var{tpnum} is the
|
|
|
|
|
number of the newly-created tracepoint.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
|
|
|
|
@deftypefun void tracepoint_deleted (int @var{tpnum})
|
|
|
|
|
A tracepoint has been destroyed. The argument @var{tpnum} is the
|
|
|
|
|
number of the newly-destroyed tracepoint.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
|
|
|
|
@deftypefun void tracepoint_modified (int @var{tpnum})
|
|
|
|
|
A tracepoint has been modified in some way. The argument @var{tpnum}
|
|
|
|
|
is the number of the modified tracepoint.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
|
|
|
|
@deftypefun void architecture_changed (struct gdbarch *@var{newarch})
|
|
|
|
|
The current architecture has changed. The argument @var{newarch} is
|
|
|
|
|
a pointer to the new architecture.
|
|
|
|
|
@end deftypefun
|
|
|
|
|
|
2008-08-18 22:35:17 +00:00
|
|
|
@deftypefun void thread_ptid_changed (ptid_t @var{old_ptid}, ptid_t @var{new_ptid})
|
|
|
|
|
The thread's ptid has changed. The @var{old_ptid} parameter specifies
|
|
|
|
|
the old value, and @var{new_ptid} specifies the new value.
|
|
|
|
|
@end deftypefun
|
