1 .\" Copyright (c) 2004 Joseph Koshy
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Nd kernel event handling functions
33 .In sys/eventhandler.h
34 .Fn EVENTHANDLER_DECLARE name type
35 .Fn EVENTHANDLER_INVOKE name ...
37 .Fn EVENTHANDLER_REGISTER name func arg priority
38 .Fn EVENTHANDLER_DEREGISTER name tag
40 .Fo eventhandler_register
41 .Fa "struct eventhandler_list *list"
42 .Fa "const char *name"
48 .Fo eventhandler_deregister
49 .Fa "struct eventhandler_list *list"
50 .Fa "eventhandler_tag tag"
52 .Ft "struct eventhandler_list *"
53 .Fn eventhandler_find_list "const char *name"
55 .Fn eventhandler_prune_list "struct eventhandler_list *list"
59 mechanism provides a way for kernel subsystems to register interest in
60 kernel events and have their callback functions invoked when these
63 The normal way to use this subsystem is via the macro interface.
64 The macros that can be used for working with event handlers and callback
66 .Bl -tag -width indent
67 .It Fn EVENTHANDLER_DECLARE
68 This macro declares an event handler named by argument
70 with callback functions of type
72 .It Fn EVENTHANDLER_REGISTER
73 This macro registers a callback function
77 When invoked, function
79 will be invoked with argument
81 as its first parameter along with any additional parameters passed in
83 .Fn EVENTHANDLER_INVOKE
85 Callback functions are invoked in order of priority.
86 The relative priority of each callback among other callbacks
87 associated with an event is given by argument
89 which is an integer ranging from
90 .Dv EVENTHANDLER_PRI_FIRST
91 (highest priority), to
92 .Dv EVENTHANDLER_PRI_LAST
95 .Dv EVENTHANDLER_PRI_ANY
96 may be used if the handler does not have a specific priority
98 If registration is successful,
99 .Fn EVENTHANDLER_REGISTER
100 returns a cookie of type
101 .Vt eventhandler_tag .
102 .It Fn EVENTHANDLER_DEREGISTER
103 This macro removes a previously registered callback associated with tag
105 from the event handler named by argument
107 .It Fn EVENTHANDLER_INVOKE
108 This macro is used to invoke all the callbacks associated with event
111 This macro is a variadic one.
112 Additional arguments to the macro after the
114 parameter are passed as the second and subsequent arguments to each
115 registered callback function.
118 The macros are implemented using the following functions:
119 .Bl -tag -width indent
120 .It Fn eventhandler_register
122 .Fn eventhandler_register
123 function is used to register a callback with a given event.
124 The arguments expected by this function are:
125 .Bl -tag -width ".Fa priority"
127 A pointer to an existing event handler list, or
133 the event handler list corresponding to argument
137 The name of the event handler list.
139 A pointer to a callback function.
142 is a passed to the callback function
144 as its first argument when it is invoked.
146 The relative priority of this callback among all the callbacks
147 registered for this event.
148 Valid values are those in the range
149 .Dv EVENTHANDLER_PRI_FIRST
151 .Dv EVENTHANDLER_PRI_LAST .
155 .Fn eventhandler_register
158 that can later be used with
159 .Fn eventhandler_deregister
160 to remove the particular callback function.
161 .It Fn eventhandler_deregister
163 .Fn eventhandler_deregister
164 function removes the callback associated with tag
166 from the event handler list pointed to by
168 This function is safe to call from inside an event handler
170 .It Fn eventhandler_find_list
172 .Fn eventhandler_find_list
173 function returns a pointer to event handler list structure corresponding
176 .It Fn eventhandler_prune_list
178 .Fn eventhandler_prune_list
179 function removes all deregistered callbacks from the event list
182 .Ss Kernel Event Handlers
183 The following event handlers are present in the kernel:
184 .Bl -tag -width indent
185 .It Vt acpi_sleep_event
186 Callbacks invoked when the system is being sent to sleep.
187 .It Vt acpi_wakeup_event
188 Callbacks invoked when the system is being woken up.
190 Callbacks invoked when a new entry is created under
193 Callbacks invoked when an address is set up on a network interface.
194 .It Vt if_clone_event
195 Callbacks invoked when an interface is cloned.
196 .It Vt ifnet_arrival_event
197 Callbacks invoked when a new network interface appears.
198 .It Vt ifnet_departure_event
199 Callbacks invoked when a network interface is taken down.
200 .It Vt power_profile_change
201 Callbacks invoked when the power profile of the system changes.
203 Callbacks invoked when a process performs an
207 Callbacks invoked when a process exits.
209 Callbacks invoked when a process forks a child.
210 .It Vt shutdown_pre_sync
211 Callbacks invoked at shutdown time, before file systems are synchronized.
212 .It Vt shutdown_post_sync
213 Callbacks invoked at shutdown time, after all file systems are synchronized.
214 .It Vt shutdown_final
215 Callbacks invoked just before halting the system.
217 Callbacks invoked when virtual memory is low.
219 Callbacks invoked when the system watchdog timer is reinitialized.
223 .Fn EVENTHANDLER_REGISTER
225 .Fn eventhandler_register
226 return a cookie of type
227 .Vt eventhandler_tag ,
228 which may be used in a subsequent call to
229 .Fn EVENTHANDLER_DEREGISTER
231 .Fn eventhandler_deregister .
234 .Fn eventhandler_find_list
236 returns a pointer to an event handler list corresponding to parameter
240 if no such list was found.
244 facility first appeared in
247 This manual page was written by
248 .An Joseph Koshy Aq jkoshy@FreeBSD.org .