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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/kernel.h>
33 #include <sys/malloc.h>
34 #include <sys/mutex.h>
36 #include <sys/systm.h>
37 #include <sys/eventhandler.h>
39 static MALLOC_DEFINE(M_EVENTHANDLER, "eventhandler", "Event handler records");
41 /* List of 'slow' lists */
42 static TAILQ_HEAD(, eventhandler_list) eventhandler_lists;
43 static int eventhandler_lists_initted = 0;
44 static struct mtx eventhandler_mutex;
46 struct eventhandler_entry_generic
48 struct eventhandler_entry ee;
52 static struct eventhandler_list *_eventhandler_find_list(const char *name);
55 * Initialize the eventhandler mutex and list.
58 eventhandler_init(void *dummy __unused)
60 TAILQ_INIT(&eventhandler_lists);
61 mtx_init(&eventhandler_mutex, "eventhandler", NULL, MTX_DEF);
62 atomic_store_rel_int(&eventhandler_lists_initted, 1);
64 SYSINIT(eventhandlers, SI_SUB_EVENTHANDLER, SI_ORDER_FIRST, eventhandler_init,
68 * Insertion is O(n) due to the priority scan, but optimises to O(1)
69 * if all priorities are identical.
71 static eventhandler_tag
72 eventhandler_register_internal(struct eventhandler_list *list,
73 const char *name, eventhandler_tag epn)
75 struct eventhandler_list *new_list;
76 struct eventhandler_entry *ep;
78 KASSERT(eventhandler_lists_initted, ("eventhandler registered too early"));
79 KASSERT(epn != NULL, ("%s: cannot register NULL event", __func__));
81 /* lock the eventhandler lists */
82 mtx_lock(&eventhandler_mutex);
84 /* Do we need to find/create the (slow) list? */
86 /* look for a matching, existing list */
87 list = _eventhandler_find_list(name);
89 /* Do we need to create the list? */
91 mtx_unlock(&eventhandler_mutex);
93 new_list = malloc(sizeof(struct eventhandler_list) +
94 strlen(name) + 1, M_EVENTHANDLER, M_WAITOK);
96 /* If someone else created it already, then use that one. */
97 mtx_lock(&eventhandler_mutex);
98 list = _eventhandler_find_list(name);
100 free(new_list, M_EVENTHANDLER);
102 CTR2(KTR_EVH, "%s: creating list \"%s\"", __func__, name);
105 list->el_runcount = 0;
106 bzero(&list->el_lock, sizeof(list->el_lock));
107 list->el_name = (char *)list + sizeof(struct eventhandler_list);
108 strcpy(list->el_name, name);
109 TAILQ_INSERT_HEAD(&eventhandler_lists, list, el_link);
113 if (!(list->el_flags & EHL_INITTED)) {
114 TAILQ_INIT(&list->el_entries);
115 mtx_init(&list->el_lock, name, "eventhandler list", MTX_DEF);
116 atomic_store_rel_int(&list->el_flags, EHL_INITTED);
118 mtx_unlock(&eventhandler_mutex);
120 KASSERT(epn->ee_priority != EHE_DEAD_PRIORITY,
121 ("%s: handler for %s registered with dead priority", __func__, name));
123 /* sort it into the list */
124 CTR4(KTR_EVH, "%s: adding item %p (function %p) to \"%s\"", __func__, epn,
125 ((struct eventhandler_entry_generic *)epn)->func, name);
127 TAILQ_FOREACH(ep, &list->el_entries, ee_link) {
128 if (ep->ee_priority != EHE_DEAD_PRIORITY &&
129 epn->ee_priority < ep->ee_priority) {
130 TAILQ_INSERT_BEFORE(ep, epn, ee_link);
135 TAILQ_INSERT_TAIL(&list->el_entries, epn, ee_link);
141 eventhandler_register(struct eventhandler_list *list, const char *name,
142 void *func, void *arg, int priority)
144 struct eventhandler_entry_generic *eg;
146 /* allocate an entry for this handler, populate it */
147 eg = malloc(sizeof(struct eventhandler_entry_generic), M_EVENTHANDLER,
151 eg->ee.ee_priority = priority;
153 return (eventhandler_register_internal(list, name, &eg->ee));
157 struct eventhandler_entry_generic_vimage
159 struct eventhandler_entry ee;
160 vimage_iterator_func_t func; /* Vimage iterator function. */
161 struct eventhandler_entry_vimage v_ee; /* Original func, arg. */
165 vimage_eventhandler_register(struct eventhandler_list *list, const char *name,
166 void *func, void *arg, int priority, vimage_iterator_func_t iterfunc)
168 struct eventhandler_entry_generic_vimage *eg;
170 /* allocate an entry for this handler, populate it */
171 eg = malloc(sizeof(struct eventhandler_entry_generic_vimage),
172 M_EVENTHANDLER, M_WAITOK | M_ZERO);
174 eg->v_ee.func = func;
175 eg->v_ee.ee_arg = arg;
176 eg->ee.ee_arg = &eg->v_ee;
177 eg->ee.ee_priority = priority;
179 return (eventhandler_register_internal(list, name, &eg->ee));
184 eventhandler_deregister(struct eventhandler_list *list, eventhandler_tag tag)
186 struct eventhandler_entry *ep = tag;
188 EHL_LOCK_ASSERT(list, MA_OWNED);
190 /* remove just this entry */
191 if (list->el_runcount == 0) {
192 CTR3(KTR_EVH, "%s: removing item %p from \"%s\"", __func__, ep,
194 TAILQ_REMOVE(&list->el_entries, ep, ee_link);
195 free(ep, M_EVENTHANDLER);
197 CTR3(KTR_EVH, "%s: marking item %p from \"%s\" as dead", __func__,
199 ep->ee_priority = EHE_DEAD_PRIORITY;
202 /* remove entire list */
203 if (list->el_runcount == 0) {
204 CTR2(KTR_EVH, "%s: removing all items from \"%s\"", __func__,
206 while (!TAILQ_EMPTY(&list->el_entries)) {
207 ep = TAILQ_FIRST(&list->el_entries);
208 TAILQ_REMOVE(&list->el_entries, ep, ee_link);
209 free(ep, M_EVENTHANDLER);
212 CTR2(KTR_EVH, "%s: marking all items from \"%s\" as dead",
213 __func__, list->el_name);
214 TAILQ_FOREACH(ep, &list->el_entries, ee_link)
215 ep->ee_priority = EHE_DEAD_PRIORITY;
218 while (list->el_runcount > 0)
219 mtx_sleep(list, &list->el_lock, 0, "evhrm", 0);
224 * Internal version for use when eventhandler list is already locked.
226 static struct eventhandler_list *
227 _eventhandler_find_list(const char *name)
229 struct eventhandler_list *list;
231 mtx_assert(&eventhandler_mutex, MA_OWNED);
232 TAILQ_FOREACH(list, &eventhandler_lists, el_link) {
233 if (!strcmp(name, list->el_name))
240 * Lookup a "slow" list by name. Returns with the list locked.
242 struct eventhandler_list *
243 eventhandler_find_list(const char *name)
245 struct eventhandler_list *list;
247 if (!eventhandler_lists_initted)
250 /* scan looking for the requested list */
251 mtx_lock(&eventhandler_mutex);
252 list = _eventhandler_find_list(name);
255 mtx_unlock(&eventhandler_mutex);
261 * Prune "dead" entries from an eventhandler list.
264 eventhandler_prune_list(struct eventhandler_list *list)
266 struct eventhandler_entry *ep, *en;
269 CTR2(KTR_EVH, "%s: pruning list \"%s\"", __func__, list->el_name);
270 EHL_LOCK_ASSERT(list, MA_OWNED);
271 TAILQ_FOREACH_SAFE(ep, &list->el_entries, ee_link, en) {
272 if (ep->ee_priority == EHE_DEAD_PRIORITY) {
273 TAILQ_REMOVE(&list->el_entries, ep, ee_link);
274 free(ep, M_EVENTHANDLER);