2 * Copyright (c) 1999 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifndef _SYS_EVENTHANDLER_H_
30 #define _SYS_EVENTHANDLER_H_
34 #include <sys/mutex.h>
35 #include <sys/queue.h>
37 struct eventhandler_entry {
38 TAILQ_ENTRY(eventhandler_entry) ee_link;
40 #define EHE_DEAD_PRIORITY (-1)
45 struct eventhandler_entry_vimage {
46 void (* func)(void); /* Original function registered. */
47 void *ee_arg; /* Original argument registered. */
52 struct eventhandler_list {
55 #define EHL_INITTED (1<<0)
58 TAILQ_ENTRY(eventhandler_list) el_link;
59 TAILQ_HEAD(,eventhandler_entry) el_entries;
62 typedef struct eventhandler_entry *eventhandler_tag;
64 #define EHL_LOCK(p) mtx_lock(&(p)->el_lock)
65 #define EHL_UNLOCK(p) mtx_unlock(&(p)->el_lock)
66 #define EHL_LOCK_ASSERT(p, x) mtx_assert(&(p)->el_lock, x)
69 * Macro to invoke the handlers for a given event.
71 #define _EVENTHANDLER_INVOKE(name, list, ...) do { \
72 struct eventhandler_entry *_ep; \
73 struct eventhandler_entry_ ## name *_t; \
75 KASSERT((list)->el_flags & EHL_INITTED, \
76 ("eventhandler_invoke: running non-inited list")); \
77 EHL_LOCK_ASSERT((list), MA_OWNED); \
78 (list)->el_runcount++; \
79 KASSERT((list)->el_runcount > 0, \
80 ("eventhandler_invoke: runcount overflow")); \
81 CTR0(KTR_EVH, "eventhandler_invoke(\"" __STRING(name) "\")"); \
82 TAILQ_FOREACH(_ep, &((list)->el_entries), ee_link) { \
83 if (_ep->ee_priority != EHE_DEAD_PRIORITY) { \
85 _t = (struct eventhandler_entry_ ## name *)_ep; \
86 CTR1(KTR_EVH, "eventhandler_invoke: executing %p", \
87 (void *)_t->eh_func); \
88 _t->eh_func(_ep->ee_arg , ## __VA_ARGS__); \
92 KASSERT((list)->el_runcount > 0, \
93 ("eventhandler_invoke: runcount underflow")); \
94 (list)->el_runcount--; \
95 if ((list)->el_runcount == 0) \
96 eventhandler_prune_list(list); \
101 * Slow handlers are entirely dynamic; lists are created
102 * when entries are added to them, and thus have no concept of "owner",
104 * Slow handlers need to be declared, but do not need to be defined. The
105 * declaration must be in scope wherever the handler is to be invoked.
107 #define EVENTHANDLER_DECLARE(name, type) \
108 struct eventhandler_entry_ ## name \
110 struct eventhandler_entry ee; \
115 #define EVENTHANDLER_DEFINE(name, func, arg, priority) \
116 static eventhandler_tag name ## _tag; \
117 static void name ## _evh_init(void *ctx) \
119 name ## _tag = EVENTHANDLER_REGISTER(name, func, ctx, \
122 SYSINIT(name ## _evh_init, SI_SUB_CONFIGURE, SI_ORDER_ANY, \
123 name ## _evh_init, arg); \
126 #define EVENTHANDLER_INVOKE(name, ...) \
128 struct eventhandler_list *_el; \
130 if ((_el = eventhandler_find_list(#name)) != NULL) \
131 _EVENTHANDLER_INVOKE(name, _el , ## __VA_ARGS__); \
134 #define EVENTHANDLER_REGISTER(name, func, arg, priority) \
135 eventhandler_register(NULL, #name, func, arg, priority)
137 #define EVENTHANDLER_DEREGISTER(name, tag) \
139 struct eventhandler_list *_el; \
141 if ((_el = eventhandler_find_list(#name)) != NULL) \
142 eventhandler_deregister(_el, tag); \
145 #define EVENTHANDLER_DEREGISTER_NOWAIT(name, tag) \
147 struct eventhandler_list *_el; \
149 if ((_el = eventhandler_find_list(#name)) != NULL) \
150 eventhandler_deregister_nowait(_el, tag); \
153 eventhandler_tag eventhandler_register(struct eventhandler_list *list,
154 const char *name, void *func, void *arg, int priority);
155 void eventhandler_deregister(struct eventhandler_list *list,
156 eventhandler_tag tag);
157 void eventhandler_deregister_nowait(struct eventhandler_list *list,
158 eventhandler_tag tag);
159 struct eventhandler_list *eventhandler_find_list(const char *name);
160 void eventhandler_prune_list(struct eventhandler_list *list);
163 typedef void (*vimage_iterator_func_t)(void *, ...);
165 eventhandler_tag vimage_eventhandler_register(struct eventhandler_list *list,
166 const char *name, void *func, void *arg, int priority,
167 vimage_iterator_func_t);
171 * Standard system event queues.
174 /* Generic priority levels */
175 #define EVENTHANDLER_PRI_FIRST 0
176 #define EVENTHANDLER_PRI_ANY 10000
177 #define EVENTHANDLER_PRI_LAST 20000
179 /* Shutdown events */
180 typedef void (*shutdown_fn)(void *, int);
182 #define SHUTDOWN_PRI_FIRST EVENTHANDLER_PRI_FIRST
183 #define SHUTDOWN_PRI_DEFAULT EVENTHANDLER_PRI_ANY
184 #define SHUTDOWN_PRI_LAST EVENTHANDLER_PRI_LAST
186 EVENTHANDLER_DECLARE(shutdown_pre_sync, shutdown_fn); /* before fs sync */
187 EVENTHANDLER_DECLARE(shutdown_post_sync, shutdown_fn); /* after fs sync */
188 EVENTHANDLER_DECLARE(shutdown_final, shutdown_fn);
190 /* Power state change events */
191 typedef void (*power_change_fn)(void *);
192 EVENTHANDLER_DECLARE(power_resume, power_change_fn);
193 EVENTHANDLER_DECLARE(power_suspend, power_change_fn);
194 EVENTHANDLER_DECLARE(power_suspend_early, power_change_fn);
196 /* Low memory event */
197 typedef void (*vm_lowmem_handler_t)(void *, int);
198 #define LOWMEM_PRI_DEFAULT EVENTHANDLER_PRI_FIRST
199 EVENTHANDLER_DECLARE(vm_lowmem, vm_lowmem_handler_t);
201 /* Root mounted event */
202 typedef void (*mountroot_handler_t)(void *);
203 EVENTHANDLER_DECLARE(mountroot, mountroot_handler_t);
205 /* File system mount events */
209 typedef void (*vfs_mounted_notify_fn)(void *, struct mount *, struct vnode *,
211 typedef void (*vfs_unmounted_notify_fn)(void *, struct mount *,
213 EVENTHANDLER_DECLARE(vfs_mounted, vfs_mounted_notify_fn);
214 EVENTHANDLER_DECLARE(vfs_unmounted, vfs_unmounted_notify_fn);
218 * process_fork and exit handlers are called without Giant.
219 * exec handlers are called with Giant, but that is by accident.
224 typedef void (*exitlist_fn)(void *, struct proc *);
225 typedef void (*forklist_fn)(void *, struct proc *, struct proc *, int);
226 typedef void (*execlist_fn)(void *, struct proc *, struct image_params *);
227 typedef void (*proc_ctor_fn)(void *, struct proc *);
228 typedef void (*proc_dtor_fn)(void *, struct proc *);
229 typedef void (*proc_init_fn)(void *, struct proc *);
230 typedef void (*proc_fini_fn)(void *, struct proc *);
231 EVENTHANDLER_DECLARE(process_ctor, proc_ctor_fn);
232 EVENTHANDLER_DECLARE(process_dtor, proc_dtor_fn);
233 EVENTHANDLER_DECLARE(process_init, proc_init_fn);
234 EVENTHANDLER_DECLARE(process_fini, proc_fini_fn);
235 EVENTHANDLER_DECLARE(process_exit, exitlist_fn);
236 EVENTHANDLER_DECLARE(process_fork, forklist_fn);
237 EVENTHANDLER_DECLARE(process_exec, execlist_fn);
240 * application dump event
242 typedef void (*app_coredump_start_fn)(void *, struct thread *, char *name);
243 typedef void (*app_coredump_progress_fn)(void *, struct thread *td, int byte_count);
244 typedef void (*app_coredump_finish_fn)(void *, struct thread *td);
245 typedef void (*app_coredump_error_fn)(void *, struct thread *td, char *msg, ...);
247 EVENTHANDLER_DECLARE(app_coredump_start, app_coredump_start_fn);
248 EVENTHANDLER_DECLARE(app_coredump_progress, app_coredump_progress_fn);
249 EVENTHANDLER_DECLARE(app_coredump_finish, app_coredump_finish_fn);
250 EVENTHANDLER_DECLARE(app_coredump_error, app_coredump_error_fn);
252 typedef void (*thread_ctor_fn)(void *, struct thread *);
253 typedef void (*thread_dtor_fn)(void *, struct thread *);
254 typedef void (*thread_fini_fn)(void *, struct thread *);
255 typedef void (*thread_init_fn)(void *, struct thread *);
256 EVENTHANDLER_DECLARE(thread_ctor, thread_ctor_fn);
257 EVENTHANDLER_DECLARE(thread_dtor, thread_dtor_fn);
258 EVENTHANDLER_DECLARE(thread_init, thread_init_fn);
259 EVENTHANDLER_DECLARE(thread_fini, thread_fini_fn);
261 typedef void (*uma_zone_chfn)(void *);
262 EVENTHANDLER_DECLARE(nmbclusters_change, uma_zone_chfn);
263 EVENTHANDLER_DECLARE(nmbufs_change, uma_zone_chfn);
264 EVENTHANDLER_DECLARE(maxsockets_change, uma_zone_chfn);
266 /* Kernel linker file load and unload events */
268 typedef void (*kld_load_fn)(void *, struct linker_file *);
269 typedef void (*kld_unload_fn)(void *, const char *, caddr_t, size_t);
270 typedef void (*kld_unload_try_fn)(void *, struct linker_file *, int *);
271 EVENTHANDLER_DECLARE(kld_load, kld_load_fn);
272 EVENTHANDLER_DECLARE(kld_unload, kld_unload_fn);
273 EVENTHANDLER_DECLARE(kld_unload_try, kld_unload_try_fn);
275 /* Generic graphics framebuffer interface */
277 typedef void (*register_framebuffer_fn)(void *, struct fb_info *);
278 typedef void (*unregister_framebuffer_fn)(void *, struct fb_info *);
279 EVENTHANDLER_DECLARE(register_framebuffer, register_framebuffer_fn);
280 EVENTHANDLER_DECLARE(unregister_framebuffer, unregister_framebuffer_fn);
282 /* Veto ada attachment */
285 typedef void (*ada_probe_veto_fn)(void *, struct cam_path *,
286 struct ata_params *, int *);
287 EVENTHANDLER_DECLARE(ada_probe_veto, ada_probe_veto_fn);
289 /* Swap device events */
291 typedef void (*swapon_fn)(void *, struct swdevt *);
292 typedef void (*swapoff_fn)(void *, struct swdevt *);
293 EVENTHANDLER_DECLARE(swapon, swapon_fn);
294 EVENTHANDLER_DECLARE(swapoff, swapoff_fn);
296 /* newbus device events */
298 EVHDEV_DETACH_BEGIN, /* Before detach() is called */
299 EVHDEV_DETACH_COMPLETE, /* After detach() returns 0 */
300 EVHDEV_DETACH_FAILED /* After detach() returns err */
302 typedef void (*device_attach_fn)(void *, device_t);
303 typedef void (*device_detach_fn)(void *, device_t, enum evhdev_detach);
304 EVENTHANDLER_DECLARE(device_attach, device_attach_fn);
305 EVENTHANDLER_DECLARE(device_detach, device_detach_fn);
307 #endif /* _SYS_EVENTHANDLER_H_ */