1 /*- 2 * Copyright (c) 2002 Poul-Henning Kamp 3 * Copyright (c) 2002 Networks Associates Technology, Inc. 4 * All rights reserved. 5 * 6 * This software was developed for the FreeBSD Project by Poul-Henning Kamp 7 * and NAI Labs, the Security Research Division of Network Associates, Inc. 8 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 9 * DARPA CHATS research program. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. The names of the authors may not be used to endorse or promote 20 * products derived from this software without specific prior written 21 * permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 */ 35 36 /* 37 * XXX: How do we in general know that objects referenced in events 38 * have not been destroyed before we get around to handle the event ? 39 */ 40 41 #include <sys/cdefs.h> 42 __FBSDID("$FreeBSD$"); 43 44 #include <sys/param.h> 45 #include <sys/malloc.h> 46 #include <sys/systm.h> 47 #include <sys/kernel.h> 48 #include <sys/lock.h> 49 #include <sys/mutex.h> 50 #include <sys/proc.h> 51 #include <sys/errno.h> 52 #include <sys/time.h> 53 #include <geom/geom.h> 54 #include <geom/geom_int.h> 55 56 #include <machine/stdarg.h> 57 58 TAILQ_HEAD(event_tailq_head, g_event); 59 60 static struct event_tailq_head g_events = TAILQ_HEAD_INITIALIZER(g_events); 61 static u_int g_pending_events; 62 static TAILQ_HEAD(,g_provider) g_doorstep = TAILQ_HEAD_INITIALIZER(g_doorstep); 63 static struct mtx g_eventlock; 64 static int g_wither_work; 65 66 #define G_N_EVENTREFS 20 67 68 struct g_event { 69 TAILQ_ENTRY(g_event) events; 70 g_event_t *func; 71 void *arg; 72 int flag; 73 void *ref[G_N_EVENTREFS]; 74 }; 75 76 #define EV_DONE 0x80000 77 #define EV_WAKEUP 0x40000 78 #define EV_CANCELED 0x20000 79 80 void 81 g_waitidle(void) 82 { 83 84 g_topology_assert_not(); 85 mtx_assert(&Giant, MA_NOTOWNED); 86 87 mtx_lock(&g_eventlock); 88 while (!TAILQ_EMPTY(&g_events)) 89 msleep(&g_pending_events, &g_eventlock, PPAUSE, 90 "g_waitidle", hz/5); 91 mtx_unlock(&g_eventlock); 92 curthread->td_pflags &= ~TDP_GEOM; 93 } 94 95 #if 0 96 void 97 g_waitidlelock(void) 98 { 99 100 g_topology_assert(); 101 mtx_lock(&g_eventlock); 102 while (!TAILQ_EMPTY(&g_events)) { 103 g_topology_unlock(); 104 msleep(&g_pending_events, &g_eventlock, PPAUSE, 105 "g_waitidlel", hz/5); 106 g_topology_lock(); 107 } 108 mtx_unlock(&g_eventlock); 109 } 110 #endif 111 112 void 113 g_orphan_provider(struct g_provider *pp, int error) 114 { 115 116 /* G_VALID_PROVIDER(pp) We likely lack topology lock */ 117 g_trace(G_T_TOPOLOGY, "g_orphan_provider(%p(%s), %d)", 118 pp, pp->name, error); 119 KASSERT(error != 0, 120 ("g_orphan_provider(%p(%s), 0) error must be non-zero\n", 121 pp, pp->name)); 122 123 pp->error = error; 124 mtx_lock(&g_eventlock); 125 KASSERT(!(pp->flags & G_PF_ORPHAN), 126 ("g_orphan_provider(%p(%s)), already an orphan", pp, pp->name)); 127 pp->flags |= G_PF_ORPHAN; 128 TAILQ_INSERT_TAIL(&g_doorstep, pp, orphan); 129 mtx_unlock(&g_eventlock); 130 wakeup(&g_wait_event); 131 } 132 133 /* 134 * This function is called once on each provider which the event handler 135 * finds on its g_doorstep. 136 */ 137 138 static void 139 g_orphan_register(struct g_provider *pp) 140 { 141 struct g_consumer *cp, *cp2; 142 int wf; 143 144 g_topology_assert(); 145 G_VALID_PROVIDER(pp); 146 g_trace(G_T_TOPOLOGY, "g_orphan_register(%s)", pp->name); 147 148 wf = pp->flags & G_PF_WITHER; 149 pp->flags &= ~G_PF_WITHER; 150 151 /* 152 * Tell all consumers the bad news. 153 * Don't be surprised if they self-destruct. 154 */ 155 cp = LIST_FIRST(&pp->consumers); 156 while (cp != NULL) { 157 cp2 = LIST_NEXT(cp, consumers); 158 KASSERT(cp->geom->orphan != NULL, 159 ("geom %s has no orphan, class %s", 160 cp->geom->name, cp->geom->class->name)); 161 cp->geom->orphan(cp); 162 cp = cp2; 163 } 164 if (LIST_EMPTY(&pp->consumers) && wf) 165 g_destroy_provider(pp); 166 else 167 pp->flags |= wf; 168 #ifdef notyet 169 cp = LIST_FIRST(&pp->consumers); 170 if (cp != NULL) 171 return; 172 if (pp->geom->flags & G_GEOM_WITHER) 173 g_destroy_provider(pp); 174 #endif 175 } 176 177 static int 178 one_event(void) 179 { 180 struct g_event *ep; 181 struct g_provider *pp; 182 183 g_topology_lock(); 184 for (;;) { 185 mtx_lock(&g_eventlock); 186 TAILQ_FOREACH(pp, &g_doorstep, orphan) { 187 if (pp->nstart == pp->nend) 188 break; 189 } 190 if (pp != NULL) { 191 G_VALID_PROVIDER(pp); 192 TAILQ_REMOVE(&g_doorstep, pp, orphan); 193 } 194 mtx_unlock(&g_eventlock); 195 if (pp == NULL) 196 break; 197 g_orphan_register(pp); 198 } 199 mtx_lock(&g_eventlock); 200 ep = TAILQ_FIRST(&g_events); 201 if (ep == NULL) { 202 wakeup(&g_pending_events); 203 mtx_unlock(&g_eventlock); 204 g_topology_unlock(); 205 return (0); 206 } 207 mtx_unlock(&g_eventlock); 208 g_topology_assert(); 209 ep->func(ep->arg, 0); 210 g_topology_assert(); 211 mtx_lock(&g_eventlock); 212 TAILQ_REMOVE(&g_events, ep, events); 213 mtx_unlock(&g_eventlock); 214 if (ep->flag & EV_WAKEUP) { 215 ep->flag |= EV_DONE; 216 wakeup(ep); 217 } else { 218 g_free(ep); 219 } 220 g_topology_unlock(); 221 return (1); 222 } 223 224 void 225 g_run_events() 226 { 227 int i; 228 229 while (one_event()) 230 ; 231 g_topology_lock(); 232 i = g_wither_work; 233 while (i) { 234 i = g_wither_washer(); 235 g_wither_work = i & 1; 236 i &= 2; 237 } 238 g_topology_unlock(); 239 } 240 241 void 242 g_cancel_event(void *ref) 243 { 244 struct g_event *ep, *epn; 245 struct g_provider *pp; 246 u_int n; 247 248 mtx_lock(&g_eventlock); 249 TAILQ_FOREACH(pp, &g_doorstep, orphan) { 250 if (pp != ref) 251 continue; 252 TAILQ_REMOVE(&g_doorstep, pp, orphan); 253 break; 254 } 255 TAILQ_FOREACH_SAFE(ep, &g_events, events, epn) { 256 for (n = 0; n < G_N_EVENTREFS; n++) { 257 if (ep->ref[n] == NULL) 258 break; 259 if (ep->ref[n] != ref) 260 continue; 261 TAILQ_REMOVE(&g_events, ep, events); 262 ep->func(ep->arg, EV_CANCEL); 263 mtx_assert(&g_eventlock, MA_OWNED); 264 if (ep->flag & EV_WAKEUP) { 265 ep->flag |= (EV_DONE|EV_CANCELED); 266 wakeup(ep); 267 } else { 268 g_free(ep); 269 } 270 break; 271 } 272 } 273 if (TAILQ_EMPTY(&g_events)) 274 wakeup(&g_pending_events); 275 mtx_unlock(&g_eventlock); 276 } 277 278 static int 279 g_post_event_x(g_event_t *func, void *arg, int flag, int wuflag, struct g_event **epp, va_list ap) 280 { 281 struct g_event *ep; 282 void *p; 283 u_int n; 284 285 g_trace(G_T_TOPOLOGY, "g_post_event_x(%p, %p, %d, %d)", 286 func, arg, flag, wuflag); 287 KASSERT(wuflag == 0 || wuflag == EV_WAKEUP, 288 ("Wrong wuflag in g_post_event_x(0x%x)", wuflag)); 289 ep = g_malloc(sizeof *ep, flag | M_ZERO); 290 if (ep == NULL) 291 return (ENOMEM); 292 ep->flag = wuflag; 293 for (n = 0; n < G_N_EVENTREFS; n++) { 294 p = va_arg(ap, void *); 295 if (p == NULL) 296 break; 297 g_trace(G_T_TOPOLOGY, " ref %p", p); 298 ep->ref[n] = p; 299 } 300 KASSERT(p == NULL, ("Too many references to event")); 301 ep->func = func; 302 ep->arg = arg; 303 mtx_lock(&g_eventlock); 304 TAILQ_INSERT_TAIL(&g_events, ep, events); 305 mtx_unlock(&g_eventlock); 306 wakeup(&g_wait_event); 307 if (epp != NULL) 308 *epp = ep; 309 curthread->td_pflags |= TDP_GEOM; 310 return (0); 311 } 312 313 int 314 g_post_event(g_event_t *func, void *arg, int flag, ...) 315 { 316 va_list ap; 317 int i; 318 319 KASSERT(flag == M_WAITOK || flag == M_NOWAIT, 320 ("Wrong flag to g_post_event")); 321 va_start(ap, flag); 322 i = g_post_event_x(func, arg, flag, 0, NULL, ap); 323 va_end(ap); 324 return (i); 325 } 326 327 void 328 g_do_wither() { 329 330 g_wither_work = 1; 331 wakeup(&g_wait_event); 332 } 333 334 /* 335 * XXX: It might actually be useful to call this function with topology held. 336 * XXX: This would ensure that the event gets created before anything else 337 * XXX: changes. At present all users have a handle on things in some other 338 * XXX: way, so this remains an XXX for now. 339 */ 340 341 int 342 g_waitfor_event(g_event_t *func, void *arg, int flag, ...) 343 { 344 va_list ap; 345 struct g_event *ep; 346 int error; 347 348 g_topology_assert_not(); 349 KASSERT(flag == M_WAITOK || flag == M_NOWAIT, 350 ("Wrong flag to g_post_event")); 351 va_start(ap, flag); 352 error = g_post_event_x(func, arg, flag, EV_WAKEUP, &ep, ap); 353 va_end(ap); 354 if (error) 355 return (error); 356 do 357 tsleep(ep, PRIBIO, "g_waitfor_event", hz); 358 while (!(ep->flag & EV_DONE)); 359 if (ep->flag & EV_CANCELED) 360 error = EAGAIN; 361 g_free(ep); 362 return (error); 363 } 364 365 void 366 g_event_init() 367 { 368 369 mtx_init(&g_eventlock, "GEOM orphanage", NULL, MTX_DEF); 370 } 371