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 = {
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, "devtype", (dev_dflags(dev) & D_TYPEMASK))))
215 if ((error = _udev_dict_set_uint(dict, "kptr", kptr)))
217 if ((error = _udev_dict_set_cstr(dict, "key", __DECONST(char *, key))))
223 prop_object_release(dict);
228 udev_dict_set_cstr(cdev_t dev, const char *key, char *str)
230 prop_dictionary_t dict;
233 KKASSERT(dev != NULL);
235 if (dev->si_dict == NULL) {
236 error = udev_init_dict(dev);
241 /* Queue a key update event */
242 dict = udev_init_dict_event(dev, key);
246 if ((error = _udev_dict_set_cstr(dict, "value", str))) {
247 prop_object_release(dict);
250 udev_event_insert(UDEV_EV_KEY_UPDATE, dict);
251 prop_object_release(dict);
253 error = _udev_dict_set_cstr(dev->si_dict, key, str);
258 udev_dict_set_int(cdev_t dev, const char *key, int64_t val)
260 prop_dictionary_t dict;
263 KKASSERT(dev != NULL);
265 if (dev->si_dict == NULL) {
266 error = udev_init_dict(dev);
271 /* Queue a key update event */
272 dict = udev_init_dict_event(dev, key);
275 if ((error = _udev_dict_set_int(dict, "value", val))) {
276 prop_object_release(dict);
279 udev_event_insert(UDEV_EV_KEY_UPDATE, dict);
280 prop_object_release(dict);
282 return _udev_dict_set_int(dev->si_dict, key, val);
286 udev_dict_set_uint(cdev_t dev, const char *key, uint64_t val)
288 prop_dictionary_t dict;
291 KKASSERT(dev != NULL);
293 if (dev->si_dict == NULL) {
294 error = udev_init_dict(dev);
299 /* Queue a key update event */
300 dict = udev_init_dict_event(dev, key);
303 if ((error = _udev_dict_set_uint(dict, "value", val))) {
304 prop_object_release(dict);
307 udev_event_insert(UDEV_EV_KEY_UPDATE, dict);
308 prop_object_release(dict);
310 return _udev_dict_set_uint(dev->si_dict, key, val);
314 udev_dict_delete_key(cdev_t dev, const char *key)
316 prop_dictionary_t dict;
318 KKASSERT(dev != NULL);
320 /* Queue a key removal event */
321 dict = udev_init_dict_event(dev, key);
324 udev_event_insert(UDEV_EV_KEY_REMOVE, dict);
325 prop_object_release(dict);
327 return _udev_dict_delete_key(dev->si_dict, key);
331 udev_init_dict(cdev_t dev)
333 prop_dictionary_t dict;
337 kptr = (uint64_t)(uintptr_t)dev;
339 KKASSERT(dev != NULL);
341 if (dev->si_dict != NULL) {
344 "udev_init_dict: new dict for %s, but has dict already (%p)!\n",
345 dev->si_name, dev->si_dict);
350 dict = prop_dictionary_create();
352 log(LOG_DEBUG, "udev_init_dict: prop_dictionary_create() failed\n");
356 if ((error = _udev_dict_set_cstr(dict, "name", dev->si_name)))
358 if ((error = _udev_dict_set_uint(dict, "devnum", dev->si_inode)))
360 if ((error = _udev_dict_set_uint(dict, "kptr", kptr)))
362 if ((error = _udev_dict_set_uint(dict, "devtype", (dev_dflags(dev) & D_TYPEMASK))))
365 /* XXX: The next 3 are marginallly useful, if at all */
366 if ((error = _udev_dict_set_uint(dict, "uid", dev->si_uid)))
368 if ((error = _udev_dict_set_uint(dict, "gid", dev->si_gid)))
370 if ((error = _udev_dict_set_int(dict, "mode", dev->si_perms)))
373 if ((error = _udev_dict_set_int(dict, "major", umajor(dev->si_inode))))
375 if ((error = _udev_dict_set_int(dict, "minor", dev->si_uminor)))
377 if (dev->si_ops->head.name != NULL) {
378 if ((error = _udev_dict_set_cstr(dict, "driver",
379 __DECONST(char *, dev->si_ops->head.name))))
388 prop_object_release(dict);
393 udev_destroy_dict(cdev_t dev)
395 KKASSERT(dev != NULL);
397 if (dev->si_dict != NULL) {
398 prop_object_release(dev->si_dict);
406 udev_event_insert(int ev_type, prop_dictionary_t dict)
408 struct udev_event_kernel *ev;
410 /* Only start queing events after client has initiated properly */
411 if (!udevctx.initiated)
414 /* XXX: use objcache eventually */
415 ev = kmalloc(sizeof(*ev), M_UDEV, M_WAITOK);
416 ev->ev.ev_dict = prop_dictionary_copy(dict);
417 if (ev->ev.ev_dict == NULL) {
421 ev->ev.ev_type = ev_type;
423 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
424 TAILQ_INSERT_TAIL(&udevctx.ev_queue, ev, link);
426 lockmgr(&udevctx.lock, LK_RELEASE);
429 KNOTE(&udevctx.kq.ki_note, 0);
432 static struct udev_event_kernel *
433 udev_event_remove(void)
435 struct udev_event_kernel *ev;
437 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
438 if (TAILQ_EMPTY(&udevctx.ev_queue)) {
439 lockmgr(&udevctx.lock, LK_RELEASE);
443 ev = TAILQ_FIRST(&udevctx.ev_queue);
444 TAILQ_REMOVE(&udevctx.ev_queue, ev, link);
446 lockmgr(&udevctx.lock, LK_RELEASE);
452 udev_event_free(struct udev_event_kernel *ev)
454 /* XXX: use objcache eventually */
459 udev_event_externalize(struct udev_event_kernel *ev)
461 prop_dictionary_t dict;
466 dict = prop_dictionary_create();
468 log(LOG_DEBUG, "udev_event_externalize: prop_dictionary_create() failed\n");
472 if ((error = _udev_dict_set_int(dict, "evtype", ev->ev.ev_type))) {
473 prop_object_release(dict);
477 if (prop_dictionary_set(dict, "evdict", ev->ev.ev_dict) == false) {
478 prop_object_release(dict);
482 prop_object_release(ev->ev.ev_dict);
484 xml = prop_dictionary_externalize(dict);
486 prop_object_release(dict);
492 udev_event_attach(cdev_t dev, char *name, int alias)
494 prop_dictionary_t dict;
497 KKASSERT(dev != NULL);
502 dict = prop_dictionary_copy(dev->si_dict);
506 if ((error = _udev_dict_set_cstr(dict, "name", name))) {
507 prop_object_release(dict);
511 _udev_dict_set_int(dict, "alias", 1);
513 udev_event_insert(UDEV_EVENT_ATTACH, dict);
514 prop_object_release(dict);
516 error = udev_init_dict(dev);
520 _udev_dict_set_int(dev->si_dict, "alias", 0);
521 udev_event_insert(UDEV_EVENT_ATTACH, dev->si_dict);
529 udev_event_detach(cdev_t dev, char *name, int alias)
531 prop_dictionary_t dict;
533 KKASSERT(dev != NULL);
536 dict = prop_dictionary_copy(dev->si_dict);
540 if (_udev_dict_set_cstr(dict, "name", name)) {
541 prop_object_release(dict);
545 _udev_dict_set_int(dict, "alias", 1);
547 udev_event_insert(UDEV_EVENT_DETACH, dict);
548 prop_object_release(dict);
550 udev_event_insert(UDEV_EVENT_DETACH, dev->si_dict);
554 udev_destroy_dict(dev);
563 udev_dev_open(struct dev_open_args *ap)
574 udev_dev_close(struct dev_close_args *ap)
577 udevctx.initiated = 0;
583 static struct filterops udev_dev_read_filtops =
584 { FILTEROP_ISFD, NULL, udev_dev_filter_detach, udev_dev_filter_read };
587 udev_dev_kqfilter(struct dev_kqfilter_args *ap)
589 struct knote *kn = ap->a_kn;
593 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
595 switch (kn->kn_filter) {
597 kn->kn_fop = &udev_dev_read_filtops;
600 ap->a_result = EOPNOTSUPP;
601 lockmgr(&udevctx.lock, LK_RELEASE);
605 klist = &udevctx.kq.ki_note;
606 knote_insert(klist, kn);
608 lockmgr(&udevctx.lock, LK_RELEASE);
614 udev_dev_filter_detach(struct knote *kn)
618 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
619 klist = &udevctx.kq.ki_note;
620 knote_remove(klist, kn);
621 lockmgr(&udevctx.lock, LK_RELEASE);
625 udev_dev_filter_read(struct knote *kn, long hint)
629 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
630 if (!TAILQ_EMPTY(&udevctx.ev_queue))
632 lockmgr(&udevctx.lock, LK_RELEASE);
638 udev_dev_read(struct dev_read_args *ap)
640 struct udev_event_kernel *ev;
641 struct uio *uio = ap->a_uio;
647 lockmgr(&udevctx.lock, LK_EXCLUSIVE);
650 if ((ev = udev_event_remove()) != NULL) {
651 if ((xml = udev_event_externalize(ev)) == NULL) {
652 lockmgr(&udevctx.lock, LK_RELEASE);
656 len = strlen(xml) + 1; /* account for NULL-termination */
657 if (uio->uio_resid < len) {
660 error = uiomove((caddr_t)xml, len, uio);
665 lockmgr(&udevctx.lock, LK_RELEASE);
669 if ((error = lksleep(&udevctx, &udevctx.lock, 0, "udevq", 0))) {
670 lockmgr(&udevctx.lock, LK_RELEASE);
675 lockmgr(&udevctx.lock, LK_RELEASE);
680 udev_dev_ioctl(struct dev_ioctl_args *ap)
682 prop_dictionary_t dict;
685 struct plistref *pref;
692 /* Use proplib(3) for userspace/kernel communication */
693 pref = (struct plistref *)ap->a_data;
694 error = prop_dictionary_copyin_ioctl(pref, ap->a_cmd, &dict);
698 po = prop_dictionary_get(dict, "command");
699 if (po == NULL || prop_object_type(po) != PROP_TYPE_STRING) {
700 log(LOG_DEBUG, "udev: prop_dictionary_get() failed\n");
701 prop_object_release(dict);
707 for(i = 0; cmd_fn[i].cmd != NULL; i++) {
708 if (prop_string_equals_cstring(ps, cmd_fn[i].cmd))
712 if (cmd_fn[i].cmd != NULL) {
713 error = cmd_fn[i].fn(pref, ap->a_cmd, dict);
718 //prop_object_release(po);
719 prop_object_release(dict);
722 error = ENOTTY; /* Inappropriate ioctl for device */
730 udev_getdevs_scan_callback(cdev_t cdev, void *arg)
732 struct udev_prop_ctx *ctx = arg;
734 KKASSERT(arg != NULL);
736 if (cdev->si_dict == NULL)
739 if (prop_array_add(ctx->cdevs, cdev->si_dict) == false) {
746 udev_getdevs_ioctl(struct plistref *pref, u_long cmd, prop_dictionary_t dict)
748 prop_dictionary_t odict;
749 struct udev_prop_ctx ctx;
753 ctx.cdevs = prop_array_create();
754 if (ctx.cdevs == NULL) {
755 log(LOG_DEBUG, "udev_getdevs_ioctl: prop_array_create() failed\n");
759 /* XXX: need devfs_scan_alias_callback() */
760 devfs_scan_callback(udev_getdevs_scan_callback, &ctx);
762 if (ctx.error != 0) {
763 prop_object_release(ctx.cdevs);
766 udevctx.initiated = 1;
768 odict = prop_dictionary_create();
773 if ((prop_dictionary_set(odict, "array", ctx.cdevs)) == 0) {
774 log(LOG_DEBUG, "udev_getdevs_ioctl: prop_dictionary_set failed\n");
775 prop_object_release(odict);
779 error = prop_dictionary_copyout_ioctl(pref, cmd, odict);
781 prop_object_release(odict);
792 lockinit(&udevctx.lock, "udevevq", 0, LK_CANRECURSE);
793 TAILQ_INIT(&udevctx.ev_queue);
804 udev_dev = make_dev(&udev_dev_ops,
813 udev_dev_uninit(void)
815 destroy_dev(udev_dev);
818 SYSINIT(subr_udev_register, SI_SUB_CREATE_INIT, SI_ORDER_ANY, udev_init, NULL);
819 SYSUNINIT(subr_udev_register, SI_SUB_CREATE_INIT, SI_ORDER_ANY, udev_uninit, NULL);
820 SYSINIT(subr_udev_dev_register, SI_SUB_DRIVERS, SI_ORDER_ANY, udev_dev_init, NULL);
821 SYSUNINIT(subr_udev_dev_register, SI_SUB_DRIVERS, SI_ORDER_ANY, udev_dev_uninit, NULL);