2 * Copyright (c) 2010 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Alex Hornung <ahornung@gmail.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
40 #include <sys/event.h>
41 #include <sys/ioccom.h>
42 #include <sys/malloc.h>
43 #include <sys/ctype.h>
44 #include <sys/syslog.h>
46 #include <sys/devfs.h>
47 #include <libprop/proplib.h>
49 #include <sys/thread2.h>
51 MALLOC_DEFINE(M_UDEV, "udev", "udev allocs");
53 /* XXX: use UUIDs for identification; would need help from devfs */
55 static cdev_t udev_dev;
56 static d_open_t udev_dev_open;
57 static d_close_t udev_dev_close;
58 static d_read_t udev_dev_read;
59 static d_kqfilter_t udev_dev_kqfilter;
60 static d_ioctl_t udev_dev_ioctl;
62 static int _udev_dict_set_cstr(prop_dictionary_t, const char *, char *);
63 static int _udev_dict_set_int(prop_dictionary_t, const char *, int64_t);
64 static int _udev_dict_set_uint(prop_dictionary_t, const char *, uint64_t);
65 static int _udev_dict_delete_key(prop_dictionary_t, const char *);
66 static prop_dictionary_t udev_init_dict_event(cdev_t, const char *);
67 static int udev_init_dict(cdev_t);
68 static int udev_destroy_dict(cdev_t);
69 static void udev_event_insert(int, prop_dictionary_t);
70 static struct udev_event_kernel *udev_event_remove(void);
71 static void udev_event_free(struct udev_event_kernel *);
72 static char *udev_event_externalize(struct udev_event_kernel *);
73 static void udev_getdevs_scan_callback(cdev_t, void *);
74 static int udev_getdevs_ioctl(struct plistref *, u_long, prop_dictionary_t);
75 static void udev_dev_filter_detach(struct knote *);
76 static int udev_dev_filter_read(struct knote *, long);
80 int (*fn)(struct plistref *, u_long, prop_dictionary_t);
83 struct udev_prop_ctx {
88 struct udev_event_kernel {
90 TAILQ_ENTRY(udev_event_kernel) link;
101 TAILQ_HEAD(, udev_event_kernel) ev_queue; /* list of thread_io */
104 static struct dev_ops udev_dev_ops = {
105 { "udev", 0, D_KQFILTER },
106 .d_open = udev_dev_open,
107 .d_close = udev_dev_close,
108 .d_read = udev_dev_read,
109 .d_kqfilter = udev_dev_kqfilter,
110 .d_ioctl = udev_dev_ioctl
113 static struct cmd_function cmd_fn[] = {
114 { .cmd = "getdevs", .fn = udev_getdevs_ioctl},
119 _udev_dict_set_cstr(prop_dictionary_t dict, const char *key, char *str)
123 KKASSERT(dict != NULL);
125 ps = prop_string_create_cstring(str);
130 if (prop_dictionary_set(dict, key, ps) == false) {
131 prop_object_release(ps);
135 prop_object_release(ps);
140 _udev_dict_set_int(prop_dictionary_t dict, const char *key, int64_t val)
144 KKASSERT(dict != NULL);
146 pn = prop_number_create_integer(val);
150 if (prop_dictionary_set(dict, key, pn) == false) {
151 prop_object_release(pn);
155 prop_object_release(pn);
160 _udev_dict_set_uint(prop_dictionary_t dict, const char *key, uint64_t val)
164 KKASSERT(dict != NULL);
166 pn = prop_number_create_unsigned_integer(val);
170 if (prop_dictionary_set(dict, key, pn) == false) {
171 prop_object_release(pn);
175 prop_object_release(pn);
180 _udev_dict_delete_key(prop_dictionary_t dict, const char *key)
182 KKASSERT(dict != NULL);
184 prop_dictionary_remove(dict, key);
190 * Initialize an event dictionary, which contains three parameters to
191 * identify the device referred to (name, devnum, kptr) and the affected key.
193 static prop_dictionary_t
194 udev_init_dict_event(cdev_t dev, const char *key)
196 prop_dictionary_t dict;
200 kptr = (uint64_t)(uintptr_t)dev;
201 KKASSERT(dev != NULL);
203 dict = prop_dictionary_create();
205 log(LOG_DEBUG, "udev_init_dict_event: prop_dictionary_create() failed\n");
209 if ((error = _udev_dict_set_cstr(dict, "name", dev->si_name)))
211 if ((error = _udev_dict_set_uint(dict, "devnum", dev->si_inode)))
213 if ((error = _udev_dict_set_uint(dict, "kptr", kptr)))
215 if ((error = _udev_dict_set_cstr(dict, "key", __DECONST(char *, key))))
221 prop_object_release(dict);
226 udev_dict_set_cstr(cdev_t dev, const char *key, char *str)
228 prop_dictionary_t dict;
231 KKASSERT(dev != NULL);
233 if (dev->si_dict == NULL) {
234 error = udev_init_dict(dev);
239 /* Queue a key update event */
240 dict = udev_init_dict_event(dev, key);
244 if ((error = _udev_dict_set_cstr(dict, "value", str))) {
245 prop_object_release(dict);
248 udev_event_insert(UDEV_EV_KEY_UPDATE, dict);
249 prop_object_release(dict);
251 error = _udev_dict_set_cstr(dev->si_dict, key, str);
256 udev_dict_set_int(cdev_t dev, const char *key, int64_t val)
258 prop_dictionary_t dict;
261 KKASSERT(dev != NULL);
263 if (dev->si_dict == NULL) {
264 error = udev_init_dict(dev);
269 /* Queue a key update event */
270 dict = udev_init_dict_event(dev, key);
273 if ((error = _udev_dict_set_int(dict, "value", val))) {
274 prop_object_release(dict);
277 udev_event_insert(UDEV_EV_KEY_UPDATE, dict);
278 prop_object_release(dict);
280 return _udev_dict_set_int(dev->si_dict, key, val);
284 udev_dict_set_uint(cdev_t dev, const char *key, uint64_t val)
286 prop_dictionary_t dict;
289 KKASSERT(dev != NULL);
291 if (dev->si_dict == NULL) {
292 error = udev_init_dict(dev);
297 /* Queue a key update event */
298 dict = udev_init_dict_event(dev, key);
301 if ((error = _udev_dict_set_uint(dict, "value", val))) {
302 prop_object_release(dict);
305 udev_event_insert(UDEV_EV_KEY_UPDATE, dict);
306 prop_object_release(dict);
308 return _udev_dict_set_uint(dev->si_dict, key, val);
312 udev_dict_delete_key(cdev_t dev, const char *key)
314 prop_dictionary_t dict;
316 KKASSERT(dev != NULL);
318 /* Queue a key removal event */
319 dict = udev_init_dict_event(dev, key);
322 udev_event_insert(UDEV_EV_KEY_REMOVE, dict);
323 prop_object_release(dict);
325 return _udev_dict_delete_key(dev->si_dict, key);
329 udev_init_dict(cdev_t dev)
331 prop_dictionary_t dict;
335 kptr = (uint64_t)(uintptr_t)dev;
337 KKASSERT(dev != NULL);
339 if (dev->si_dict != NULL) {
342 "udev_init_dict: new dict for %s, but has dict already (%p)!\n",
343 dev->si_name, dev->si_dict);
348 dict = prop_dictionary_create();
350 log(LOG_DEBUG, "udev_init_dict: prop_dictionary_create() failed\n");
354 if ((error = _udev_dict_set_cstr(dict, "name", dev->si_name)))
356 if ((error = _udev_dict_set_uint(dict, "devnum", dev->si_inode)))
358 if ((error = _udev_dict_set_uint(dict, "kptr", kptr)))
361 /* XXX: The next 3 are marginallly useful, if at all */
362 if ((error = _udev_dict_set_uint(dict, "uid", dev->si_uid)))
364 if ((error = _udev_dict_set_uint(dict, "gid", dev->si_gid)))
366 if ((error = _udev_dict_set_int(dict, "mode", dev->si_perms)))
369 if ((error = _udev_dict_set_int(dict, "major", umajor(dev->si_inode))))
371 if ((error = _udev_dict_set_int(dict, "minor", dev->si_uminor)))
373 if (dev->si_ops->head.name != NULL) {
374 if ((error = _udev_dict_set_cstr(dict, "driver",
375 __DECONST(char *, dev->si_ops->head.name))))
384 prop_object_release(dict);
389 udev_destroy_dict(cdev_t dev)
391 KKASSERT(dev != NULL);
393 if (dev->si_dict != NULL) {
394 prop_object_release(dev->si_dict);
402 udev_event_insert(int ev_type, prop_dictionary_t dict)
404 struct udev_event_kernel *ev;
406 /* Only start queing events after client has initiated properly */
407 if (!udevctx.initiated)
410 /* XXX: use objcache eventually */
411 ev = kmalloc(sizeof(*ev), M_UDEV, M_WAITOK);
412 ev->ev.ev_dict = prop_dictionary_copy(dict);
413 if (ev->ev.ev_dict == NULL) {
417 ev->ev.ev_type = ev_type;
419 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
420 TAILQ_INSERT_TAIL(&udevctx.ev_queue, ev, link);
422 lockmgr(&udevctx.lock, LK_RELEASE);
425 selwakeup(&udevctx.sel);
426 KNOTE(&udevctx.sel.si_note, 0);
429 static struct udev_event_kernel *
430 udev_event_remove(void)
432 struct udev_event_kernel *ev;
434 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
435 if (TAILQ_EMPTY(&udevctx.ev_queue)) {
436 lockmgr(&udevctx.lock, LK_RELEASE);
440 ev = TAILQ_FIRST(&udevctx.ev_queue);
441 TAILQ_REMOVE(&udevctx.ev_queue, ev, link);
443 lockmgr(&udevctx.lock, LK_RELEASE);
449 udev_event_free(struct udev_event_kernel *ev)
451 /* XXX: use objcache eventually */
456 udev_event_externalize(struct udev_event_kernel *ev)
458 prop_dictionary_t dict;
463 dict = prop_dictionary_create();
465 log(LOG_DEBUG, "udev_event_externalize: prop_dictionary_create() failed\n");
469 if ((error = _udev_dict_set_int(dict, "evtype", ev->ev.ev_type))) {
470 prop_object_release(dict);
474 if (prop_dictionary_set(dict, "evdict", ev->ev.ev_dict) == false) {
475 prop_object_release(dict);
479 prop_object_release(ev->ev.ev_dict);
481 xml = prop_dictionary_externalize(dict);
483 prop_object_release(dict);
489 udev_event_attach(cdev_t dev, char *name, int alias)
491 prop_dictionary_t dict;
494 KKASSERT(dev != NULL);
499 dict = prop_dictionary_copy(dev->si_dict);
503 if ((error = _udev_dict_set_cstr(dict, "name", name))) {
504 prop_object_release(dict);
508 _udev_dict_set_int(dict, "alias", 1);
510 udev_event_insert(UDEV_EVENT_ATTACH, dict);
511 prop_object_release(dict);
513 error = udev_init_dict(dev);
517 _udev_dict_set_int(dev->si_dict, "alias", 0);
518 udev_event_insert(UDEV_EVENT_ATTACH, dev->si_dict);
526 udev_event_detach(cdev_t dev, char *name, int alias)
528 prop_dictionary_t dict;
530 KKASSERT(dev != NULL);
533 dict = prop_dictionary_copy(dev->si_dict);
537 if (_udev_dict_set_cstr(dict, "name", name)) {
538 prop_object_release(dict);
542 _udev_dict_set_int(dict, "alias", 1);
544 udev_event_insert(UDEV_EVENT_DETACH, dict);
545 prop_object_release(dict);
547 udev_event_insert(UDEV_EVENT_DETACH, dev->si_dict);
551 udev_destroy_dict(dev);
560 udev_dev_open(struct dev_open_args *ap)
571 udev_dev_close(struct dev_close_args *ap)
574 udevctx.initiated = 0;
580 static struct filterops udev_dev_read_filtops =
581 { 1, NULL, udev_dev_filter_detach, udev_dev_filter_read };
584 udev_dev_kqfilter(struct dev_kqfilter_args *ap)
586 struct knote *kn = ap->a_kn;
590 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
592 switch (kn->kn_filter) {
594 kn->kn_fop = &udev_dev_read_filtops;
597 ap->a_result = EOPNOTSUPP;
598 lockmgr(&udevctx.lock, LK_RELEASE);
603 klist = &udevctx.sel.si_note;
604 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
607 lockmgr(&udevctx.lock, LK_RELEASE);
613 udev_dev_filter_detach(struct knote *kn)
617 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
619 klist = &udevctx.sel.si_note;
620 SLIST_REMOVE(klist, kn, knote, kn_selnext);
622 lockmgr(&udevctx.lock, LK_RELEASE);
626 udev_dev_filter_read(struct knote *kn, long hint)
630 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
631 if (!TAILQ_EMPTY(&udevctx.ev_queue))
633 lockmgr(&udevctx.lock, LK_RELEASE);
639 udev_dev_read(struct dev_read_args *ap)
641 struct udev_event_kernel *ev;
642 struct uio *uio = ap->a_uio;
648 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
651 if ((ev = udev_event_remove()) != NULL) {
652 if ((xml = udev_event_externalize(ev)) == NULL) {
653 lockmgr(&udevctx.lock, LK_RELEASE);
657 len = strlen(xml) + 1; /* account for NULL-termination */
658 if (uio->uio_resid < len) {
661 error = uiomove((caddr_t)xml, len, uio);
666 lockmgr(&udevctx.lock, LK_RELEASE);
670 if ((error = lksleep(&udevctx, &udevctx.lock, 0, "udevq", 0))) {
671 lockmgr(&udevctx.lock, LK_RELEASE);
676 lockmgr(&udevctx.lock, LK_RELEASE);
681 udev_dev_ioctl(struct dev_ioctl_args *ap)
683 prop_dictionary_t dict;
686 struct plistref *pref;
693 /* Use proplib(3) for userspace/kernel communication */
694 pref = (struct plistref *)ap->a_data;
695 error = prop_dictionary_copyin_ioctl(pref, ap->a_cmd, &dict);
699 po = prop_dictionary_get(dict, "command");
700 if (po == NULL || prop_object_type(po) != PROP_TYPE_STRING) {
701 log(LOG_DEBUG, "udev: prop_dictionary_get() failed\n");
702 prop_object_release(dict);
708 for(i = 0; cmd_fn[i].cmd != NULL; i++) {
709 if (prop_string_equals_cstring(ps, cmd_fn[i].cmd))
713 if (cmd_fn[i].cmd != NULL) {
714 error = cmd_fn[i].fn(pref, ap->a_cmd, dict);
719 //prop_object_release(po);
720 prop_object_release(dict);
723 error = ENOTTY; /* Inappropriate ioctl for device */
731 udev_getdevs_scan_callback(cdev_t cdev, void *arg)
733 struct udev_prop_ctx *ctx = arg;
735 KKASSERT(arg != NULL);
737 if (cdev->si_dict == NULL)
740 if (prop_array_add(ctx->cdevs, cdev->si_dict) == false) {
747 udev_getdevs_ioctl(struct plistref *pref, u_long cmd, prop_dictionary_t dict)
749 prop_dictionary_t odict;
750 struct udev_prop_ctx ctx;
754 ctx.cdevs = prop_array_create();
755 if (ctx.cdevs == NULL) {
756 log(LOG_DEBUG, "udev_getdevs_ioctl: prop_array_create() failed\n");
760 /* XXX: need devfs_scan_alias_callback() */
761 devfs_scan_callback(udev_getdevs_scan_callback, &ctx);
763 if (ctx.error != 0) {
764 prop_object_release(ctx.cdevs);
767 udevctx.initiated = 1;
769 odict = prop_dictionary_create();
774 if ((prop_dictionary_set(odict, "array", ctx.cdevs)) == 0) {
775 log(LOG_DEBUG, "udev_getdevs_ioctl: prop_dictionary_set failed\n");
776 prop_object_release(odict);
780 error = prop_dictionary_copyout_ioctl(pref, cmd, odict);
782 prop_object_release(odict);
793 lockinit(&udevctx.lock, "udevevq", 0, LK_CANRECURSE);
794 TAILQ_INIT(&udevctx.ev_queue);
805 udev_dev = make_dev(&udev_dev_ops,
814 udev_dev_uninit(void)
816 destroy_dev(udev_dev);
819 SYSINIT(subr_udev_register, SI_SUB_CREATE_INIT, SI_ORDER_ANY, udev_init, NULL);
820 SYSUNINIT(subr_udev_register, SI_SUB_CREATE_INIT, SI_ORDER_ANY, udev_uninit, NULL);
821 SYSINIT(subr_udev_dev_register, SI_SUB_DRIVERS, SI_ORDER_ANY, udev_dev_init, NULL);
822 SYSUNINIT(subr_udev_dev_register, SI_SUB_DRIVERS, SI_ORDER_ANY, udev_dev_uninit, NULL);