2 * Copyright (c) 2009 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>
38 #include <sys/mount.h>
39 #include <sys/vnode.h>
40 #include <sys/types.h>
43 #include <sys/msgport.h>
44 #include <sys/sysctl.h>
45 #include <sys/ucred.h>
46 #include <sys/devfs.h>
47 #include <sys/devfs_rules.h>
50 #include <sys/msgport2.h>
51 #include <sys/spinlock2.h>
52 #include <sys/mplock2.h>
53 #include <sys/sysref2.h>
55 MALLOC_DEFINE(M_DEVFS, "devfs", "Device File System (devfs) allocations");
56 DEVFS_DECLARE_CLONE_BITMAP(ops_id);
58 * SYSREF Integration - reference counting, allocation,
59 * sysid and syslink integration.
61 static void devfs_cdev_terminate(cdev_t dev);
62 static void devfs_cdev_lock(cdev_t dev);
63 static void devfs_cdev_unlock(cdev_t dev);
64 static struct sysref_class cdev_sysref_class = {
67 .proto = SYSREF_PROTO_DEV,
68 .offset = offsetof(struct cdev, si_sysref),
69 .objsize = sizeof(struct cdev),
73 .terminate = (sysref_terminate_func_t)devfs_cdev_terminate,
74 .lock = (sysref_lock_func_t)devfs_cdev_lock,
75 .unlock = (sysref_unlock_func_t)devfs_cdev_unlock
79 static struct objcache *devfs_node_cache;
80 static struct objcache *devfs_msg_cache;
81 static struct objcache *devfs_dev_cache;
83 static struct objcache_malloc_args devfs_node_malloc_args = {
84 sizeof(struct devfs_node), M_DEVFS };
85 struct objcache_malloc_args devfs_msg_malloc_args = {
86 sizeof(struct devfs_msg), M_DEVFS };
87 struct objcache_malloc_args devfs_dev_malloc_args = {
88 sizeof(struct cdev), M_DEVFS };
90 static struct devfs_dev_head devfs_dev_list =
91 TAILQ_HEAD_INITIALIZER(devfs_dev_list);
92 static struct devfs_mnt_head devfs_mnt_list =
93 TAILQ_HEAD_INITIALIZER(devfs_mnt_list);
94 static struct devfs_chandler_head devfs_chandler_list =
95 TAILQ_HEAD_INITIALIZER(devfs_chandler_list);
96 static struct devfs_alias_head devfs_alias_list =
97 TAILQ_HEAD_INITIALIZER(devfs_alias_list);
98 static struct devfs_dev_ops_head devfs_dev_ops_list =
99 TAILQ_HEAD_INITIALIZER(devfs_dev_ops_list);
101 struct lock devfs_lock;
102 static struct lwkt_port devfs_dispose_port;
103 static struct lwkt_port devfs_msg_port;
104 static struct thread *td_core;
106 static struct spinlock ino_lock;
108 static int devfs_debug_enable;
109 static int devfs_run;
111 static ino_t devfs_fetch_ino(void);
112 static int devfs_create_all_dev_worker(struct devfs_node *);
113 static int devfs_create_dev_worker(cdev_t, uid_t, gid_t, int);
114 static int devfs_destroy_dev_worker(cdev_t);
115 static int devfs_destroy_related_worker(cdev_t);
116 static int devfs_destroy_dev_by_ops_worker(struct dev_ops *, int);
117 static int devfs_propagate_dev(cdev_t, int);
118 static int devfs_unlink_dev(cdev_t dev);
119 static void devfs_msg_exec(devfs_msg_t msg);
121 static int devfs_chandler_add_worker(const char *, d_clone_t *);
122 static int devfs_chandler_del_worker(const char *);
124 static void devfs_msg_autofree_reply(lwkt_port_t, lwkt_msg_t);
125 static void devfs_msg_core(void *);
127 static int devfs_find_device_by_name_worker(devfs_msg_t);
128 static int devfs_find_device_by_udev_worker(devfs_msg_t);
130 static int devfs_apply_reset_rules_caller(char *, int);
132 static int devfs_scan_callback_worker(devfs_scan_t *, void *);
134 static struct devfs_node *devfs_resolve_or_create_dir(struct devfs_node *,
135 char *, size_t, int);
137 static int devfs_make_alias_worker(struct devfs_alias *);
138 static int devfs_destroy_alias_worker(struct devfs_alias *);
139 static int devfs_alias_remove(cdev_t);
140 static int devfs_alias_reap(void);
141 static int devfs_alias_propagate(struct devfs_alias *, int);
142 static int devfs_alias_apply(struct devfs_node *, struct devfs_alias *);
143 static int devfs_alias_check_create(struct devfs_node *);
145 static int devfs_clr_related_flag_worker(cdev_t, uint32_t);
146 static int devfs_destroy_related_without_flag_worker(cdev_t, uint32_t);
148 static void *devfs_reaperp_callback(struct devfs_node *, void *);
149 static void *devfs_gc_dirs_callback(struct devfs_node *, void *);
150 static void *devfs_gc_links_callback(struct devfs_node *, struct devfs_node *);
152 devfs_inode_to_vnode_worker_callback(struct devfs_node *, ino_t *);
155 * devfs_debug() is a SYSCTL and TUNABLE controlled debug output function
159 devfs_debug(int level, char *fmt, ...)
164 if (level <= devfs_debug_enable)
172 * devfs_allocp() Allocates a new devfs node with the specified
173 * parameters. The node is also automatically linked into the topology
174 * if a parent is specified. It also calls the rule and alias stuff to
175 * be applied on the new node
178 devfs_allocp(devfs_nodetype devfsnodetype, char *name,
179 struct devfs_node *parent, struct mount *mp, cdev_t dev)
181 struct devfs_node *node = NULL;
182 size_t namlen = strlen(name);
184 node = objcache_get(devfs_node_cache, M_WAITOK);
185 bzero(node, sizeof(*node));
187 atomic_add_long(&DEVFS_MNTDATA(mp)->leak_count, 1);
192 node->d_dir.d_ino = devfs_fetch_ino();
195 * Cookie jar for children. Leave 0 and 1 for '.' and '..' entries
198 node->cookie_jar = 2;
201 * Access Control members
203 node->mode = DEVFS_DEFAULT_MODE;
204 node->uid = DEVFS_DEFAULT_UID;
205 node->gid = DEVFS_DEFAULT_GID;
207 switch (devfsnodetype) {
210 * Ensure that we don't recycle the root vnode by marking it as
211 * linked into the topology.
213 node->flags |= DEVFS_NODE_LINKED;
215 TAILQ_INIT(DEVFS_DENODE_HEAD(node));
216 node->d_dir.d_type = DT_DIR;
221 node->d_dir.d_type = DT_LNK;
225 node->d_dir.d_type = DT_REG;
230 node->d_dir.d_type = DT_CHR;
233 node->mode = dev->si_perms;
234 node->uid = dev->si_uid;
235 node->gid = dev->si_gid;
237 devfs_alias_check_create(node);
242 panic("devfs_allocp: unknown node type");
246 node->node_type = devfsnodetype;
248 /* Initialize the dirent structure of each devfs vnode */
249 node->d_dir.d_namlen = namlen;
250 node->d_dir.d_name = kmalloc(namlen+1, M_DEVFS, M_WAITOK);
251 memcpy(node->d_dir.d_name, name, namlen);
252 node->d_dir.d_name[namlen] = '\0';
254 /* Initialize the parent node element */
255 node->parent = parent;
257 /* Initialize *time members */
258 nanotime(&node->atime);
259 node->mtime = node->ctime = node->atime;
262 * Associate with parent as last step, clean out namecache
265 if ((parent != NULL) &&
266 ((parent->node_type == Nroot) || (parent->node_type == Ndir))) {
268 node->cookie = parent->cookie_jar++;
269 node->flags |= DEVFS_NODE_LINKED;
270 TAILQ_INSERT_TAIL(DEVFS_DENODE_HEAD(parent), node, link);
272 /* This forces negative namecache lookups to clear */
273 ++mp->mnt_namecache_gen;
277 devfs_rule_check_apply(node, NULL);
279 atomic_add_long(&DEVFS_MNTDATA(mp)->file_count, 1);
285 * devfs_allocv() allocates a new vnode based on a devfs node.
288 devfs_allocv(struct vnode **vpp, struct devfs_node *node)
296 * devfs master lock must not be held across a vget() call, we have
297 * to hold our ad-hoc vp to avoid a free race from destroying the
298 * contents of the structure. The vget() will interlock recycles
302 while ((vp = node->v_node) != NULL) {
304 lockmgr(&devfs_lock, LK_RELEASE);
305 error = vget(vp, LK_EXCLUSIVE);
307 lockmgr(&devfs_lock, LK_EXCLUSIVE);
312 if (error != ENOENT) {
319 * devfs master lock must not be held across a getnewvnode() call.
321 lockmgr(&devfs_lock, LK_RELEASE);
322 if ((error = getnewvnode(VT_DEVFS, node->mp, vpp, 0, 0)) != 0) {
323 lockmgr(&devfs_lock, LK_EXCLUSIVE);
326 lockmgr(&devfs_lock, LK_EXCLUSIVE);
330 if (node->v_node != NULL) {
339 switch (node->node_type) {
341 vsetflags(vp, VROOT);
357 KKASSERT(node->d_dev);
359 vp->v_uminor = node->d_dev->si_uminor;
360 vp->v_umajor = node->d_dev->si_umajor;
362 v_associate_rdev(vp, node->d_dev);
363 vp->v_ops = &node->mp->mnt_vn_spec_ops;
367 panic("devfs_allocv: unknown node type");
375 * devfs_allocvp allocates both a devfs node (with the given settings) and a vnode
376 * based on the newly created devfs node.
379 devfs_allocvp(struct mount *mp, struct vnode **vpp, devfs_nodetype devfsnodetype,
380 char *name, struct devfs_node *parent, cdev_t dev)
382 struct devfs_node *node;
384 node = devfs_allocp(devfsnodetype, name, parent, mp, dev);
387 devfs_allocv(vpp, node);
395 * Destroy the devfs_node. The node must be unlinked from the topology.
397 * This function will also destroy any vnode association with the node
400 * The cdev_t itself remains intact.
402 * The core lock is not necessarily held on call and must be temporarily
403 * released if it is to avoid a deadlock.
406 devfs_freep(struct devfs_node *node)
412 KKASSERT(((node->flags & DEVFS_NODE_LINKED) == 0) ||
413 (node->node_type == Nroot));
416 * Protect against double frees
418 KKASSERT((node->flags & DEVFS_DESTROYED) == 0);
419 node->flags |= DEVFS_DESTROYED;
422 * Avoid deadlocks between devfs_lock and the vnode lock when
423 * disassociating the vnode (stress2 pty vs ls -la /dev/pts).
425 * This also prevents the vnode reclaim code from double-freeing
426 * the node. The vget() is required to safely modified the vp
427 * and cycle the refs to terminate an inactive vp.
429 if (lockstatus(&devfs_lock, curthread) == LK_EXCLUSIVE) {
430 lockmgr(&devfs_lock, LK_RELEASE);
436 while ((vp = node->v_node) != NULL) {
437 if (vget(vp, LK_EXCLUSIVE | LK_RETRY) != 0)
442 cache_inval_vp(vp, CINV_DESTROY);
449 atomic_subtract_long(&DEVFS_MNTDATA(node->mp)->leak_count, 1);
450 if (node->symlink_name) {
451 kfree(node->symlink_name, M_DEVFS);
452 node->symlink_name = NULL;
456 * Remove the node from the orphan list if it is still on it.
458 if (node->flags & DEVFS_ORPHANED)
459 devfs_tracer_del_orphan(node);
461 if (node->d_dir.d_name) {
462 kfree(node->d_dir.d_name, M_DEVFS);
463 node->d_dir.d_name = NULL;
465 atomic_subtract_long(&DEVFS_MNTDATA(node->mp)->file_count, 1);
466 objcache_put(devfs_node_cache, node);
469 lockmgr(&devfs_lock, LK_EXCLUSIVE);
475 * Unlink the devfs node from the topology and add it to the orphan list.
476 * The node will later be destroyed by freep.
478 * Any vnode association, including the v_rdev and v_data, remains intact
482 devfs_unlinkp(struct devfs_node *node)
484 struct devfs_node *parent;
488 * Add the node to the orphan list, so it is referenced somewhere, to
489 * so we don't leak it.
491 devfs_tracer_add_orphan(node);
493 parent = node->parent;
496 * If the parent is known we can unlink the node out of the topology
499 TAILQ_REMOVE(DEVFS_DENODE_HEAD(parent), node, link);
501 node->flags &= ~DEVFS_NODE_LINKED;
509 devfs_iterate_topology(struct devfs_node *node,
510 devfs_iterate_callback_t *callback, void *arg1)
512 struct devfs_node *node1, *node2;
515 if ((node->node_type == Nroot) || (node->node_type == Ndir)) {
516 if (node->nchildren > 2) {
517 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node),
519 if ((ret = devfs_iterate_topology(node1, callback, arg1)))
525 ret = callback(node, arg1);
530 * devfs_reaperp() is a recursive function that iterates through all the
531 * topology, unlinking and freeing all devfs nodes.
534 devfs_reaperp_callback(struct devfs_node *node, void *unused)
543 devfs_gc_dirs_callback(struct devfs_node *node, void *unused)
545 if (node->node_type == Ndir) {
546 if ((node->nchildren == 2) &&
547 !(node->flags & DEVFS_USER_CREATED)) {
557 devfs_gc_links_callback(struct devfs_node *node, struct devfs_node *target)
559 if ((node->node_type == Nlink) && (node->link_target == target)) {
568 * devfs_gc() is devfs garbage collector. It takes care of unlinking and
569 * freeing a node, but also removes empty directories and links that link
570 * via devfs auto-link mechanism to the node being deleted.
573 devfs_gc(struct devfs_node *node)
575 struct devfs_node *root_node = DEVFS_MNTDATA(node->mp)->root_node;
577 if (node->nlinks > 0)
578 devfs_iterate_topology(root_node,
579 (devfs_iterate_callback_t *)devfs_gc_links_callback, node);
582 devfs_iterate_topology(root_node,
583 (devfs_iterate_callback_t *)devfs_gc_dirs_callback, NULL);
591 * devfs_create_dev() is the asynchronous entry point for device creation.
592 * It just sends a message with the relevant details to the devfs core.
594 * This function will reference the passed device. The reference is owned
595 * by devfs and represents all of the device's node associations.
598 devfs_create_dev(cdev_t dev, uid_t uid, gid_t gid, int perms)
601 devfs_msg_send_dev(DEVFS_DEVICE_CREATE, dev, uid, gid, perms);
607 * devfs_destroy_dev() is the asynchronous entry point for device destruction.
608 * It just sends a message with the relevant details to the devfs core.
611 devfs_destroy_dev(cdev_t dev)
613 devfs_msg_send_dev(DEVFS_DEVICE_DESTROY, dev, 0, 0, 0);
618 * devfs_mount_add() is the synchronous entry point for adding a new devfs
619 * mount. It sends a synchronous message with the relevant details to the
623 devfs_mount_add(struct devfs_mnt_data *mnt)
627 msg = devfs_msg_get();
629 msg = devfs_msg_send_sync(DEVFS_MOUNT_ADD, msg);
636 * devfs_mount_del() is the synchronous entry point for removing a devfs mount.
637 * It sends a synchronous message with the relevant details to the devfs core.
640 devfs_mount_del(struct devfs_mnt_data *mnt)
644 msg = devfs_msg_get();
646 msg = devfs_msg_send_sync(DEVFS_MOUNT_DEL, msg);
653 * devfs_destroy_related() is the synchronous entry point for device
654 * destruction by subname. It just sends a message with the relevant details to
658 devfs_destroy_related(cdev_t dev)
662 msg = devfs_msg_get();
664 msg = devfs_msg_send_sync(DEVFS_DESTROY_RELATED, msg);
670 devfs_clr_related_flag(cdev_t dev, uint32_t flag)
674 msg = devfs_msg_get();
675 msg->mdv_flags.dev = dev;
676 msg->mdv_flags.flag = flag;
677 msg = devfs_msg_send_sync(DEVFS_CLR_RELATED_FLAG, msg);
684 devfs_destroy_related_without_flag(cdev_t dev, uint32_t flag)
688 msg = devfs_msg_get();
689 msg->mdv_flags.dev = dev;
690 msg->mdv_flags.flag = flag;
691 msg = devfs_msg_send_sync(DEVFS_DESTROY_RELATED_WO_FLAG, msg);
698 * devfs_create_all_dev is the asynchronous entry point to trigger device
699 * node creation. It just sends a message with the relevant details to
703 devfs_create_all_dev(struct devfs_node *root)
705 devfs_msg_send_generic(DEVFS_CREATE_ALL_DEV, root);
710 * devfs_destroy_dev_by_ops is the asynchronous entry point to destroy all
711 * devices with a specific set of dev_ops and minor. It just sends a
712 * message with the relevant details to the devfs core.
715 devfs_destroy_dev_by_ops(struct dev_ops *ops, int minor)
717 devfs_msg_send_ops(DEVFS_DESTROY_DEV_BY_OPS, ops, minor);
722 * devfs_clone_handler_add is the synchronous entry point to add a new
723 * clone handler. It just sends a message with the relevant details to
727 devfs_clone_handler_add(const char *name, d_clone_t *nhandler)
731 msg = devfs_msg_get();
732 msg->mdv_chandler.name = name;
733 msg->mdv_chandler.nhandler = nhandler;
734 msg = devfs_msg_send_sync(DEVFS_CHANDLER_ADD, msg);
740 * devfs_clone_handler_del is the synchronous entry point to remove a
741 * clone handler. It just sends a message with the relevant details to
745 devfs_clone_handler_del(const char *name)
749 msg = devfs_msg_get();
750 msg->mdv_chandler.name = name;
751 msg->mdv_chandler.nhandler = NULL;
752 msg = devfs_msg_send_sync(DEVFS_CHANDLER_DEL, msg);
758 * devfs_find_device_by_name is the synchronous entry point to find a
759 * device given its name. It sends a synchronous message with the
760 * relevant details to the devfs core and returns the answer.
763 devfs_find_device_by_name(const char *fmt, ...)
774 kvasnrprintf(&target, PATH_MAX, 10, fmt, ap);
777 msg = devfs_msg_get();
778 msg->mdv_name = target;
779 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_NAME, msg);
780 found = msg->mdv_cdev;
788 * devfs_find_device_by_udev is the synchronous entry point to find a
789 * device given its udev number. It sends a synchronous message with
790 * the relevant details to the devfs core and returns the answer.
793 devfs_find_device_by_udev(udev_t udev)
798 msg = devfs_msg_get();
799 msg->mdv_udev = udev;
800 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_UDEV, msg);
801 found = msg->mdv_cdev;
804 devfs_debug(DEVFS_DEBUG_DEBUG,
805 "devfs_find_device_by_udev found? %s -end:3-\n",
806 ((found) ? found->si_name:"NO"));
811 devfs_inode_to_vnode(struct mount *mp, ino_t target)
813 struct vnode *vp = NULL;
819 msg = devfs_msg_get();
820 msg->mdv_ino.mp = mp;
821 msg->mdv_ino.ino = target;
822 msg = devfs_msg_send_sync(DEVFS_INODE_TO_VNODE, msg);
823 vp = msg->mdv_ino.vp;
824 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
831 * devfs_make_alias is the asynchronous entry point to register an alias
832 * for a device. It just sends a message with the relevant details to the
836 devfs_make_alias(const char *name, cdev_t dev_target)
838 struct devfs_alias *alias;
843 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
844 alias->name = kstrdup(name, M_DEVFS);
846 alias->dev_target = dev_target;
848 devfs_msg_send_generic(DEVFS_MAKE_ALIAS, alias);
853 * devfs_destroy_alias is the asynchronous entry point to deregister an alias
854 * for a device. It just sends a message with the relevant details to the
858 devfs_destroy_alias(const char *name, cdev_t dev_target)
860 struct devfs_alias *alias;
865 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
866 alias->name = kstrdup(name, M_DEVFS);
868 alias->dev_target = dev_target;
870 devfs_msg_send_generic(DEVFS_DESTROY_ALIAS, alias);
875 * devfs_apply_rules is the asynchronous entry point to trigger application
876 * of all rules. It just sends a message with the relevant details to the
880 devfs_apply_rules(char *mntto)
884 new_name = kstrdup(mntto, M_DEVFS);
885 devfs_msg_send_name(DEVFS_APPLY_RULES, new_name);
891 * devfs_reset_rules is the asynchronous entry point to trigger reset of all
892 * rules. It just sends a message with the relevant details to the devfs core.
895 devfs_reset_rules(char *mntto)
899 new_name = kstrdup(mntto, M_DEVFS);
900 devfs_msg_send_name(DEVFS_RESET_RULES, new_name);
907 * devfs_scan_callback is the asynchronous entry point to call a callback
909 * It just sends a message with the relevant details to the devfs core.
912 devfs_scan_callback(devfs_scan_t *callback, void *arg)
918 msg = devfs_msg_get();
919 msg->mdv_load = callback;
920 msg->mdv_load2 = arg;
921 msg = devfs_msg_send_sync(DEVFS_SCAN_CALLBACK, msg);
929 * Acts as a message drain. Any message that is replied to here gets destroyed
930 * and the memory freed.
933 devfs_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
935 devfs_msg_put((devfs_msg_t)msg);
939 * devfs_msg_get allocates a new devfs msg and returns it.
944 return objcache_get(devfs_msg_cache, M_WAITOK);
948 * devfs_msg_put deallocates a given devfs msg.
951 devfs_msg_put(devfs_msg_t msg)
953 objcache_put(devfs_msg_cache, msg);
958 * devfs_msg_send is the generic asynchronous message sending facility
959 * for devfs. By default the reply port is the automatic disposal port.
961 * If the current thread is the devfs_msg_port thread we execute the
962 * operation synchronously.
965 devfs_msg_send(uint32_t cmd, devfs_msg_t devfs_msg)
967 lwkt_port_t port = &devfs_msg_port;
969 lwkt_initmsg(&devfs_msg->hdr, &devfs_dispose_port, 0);
971 devfs_msg->hdr.u.ms_result = cmd;
973 if (port->mpu_td == curthread) {
974 devfs_msg_exec(devfs_msg);
975 lwkt_replymsg(&devfs_msg->hdr, 0);
977 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
982 * devfs_msg_send_sync is the generic synchronous message sending
983 * facility for devfs. It initializes a local reply port and waits
984 * for the core's answer. This answer is then returned.
987 devfs_msg_send_sync(uint32_t cmd, devfs_msg_t devfs_msg)
989 struct lwkt_port rep_port;
990 devfs_msg_t msg_incoming;
991 lwkt_port_t port = &devfs_msg_port;
993 lwkt_initport_thread(&rep_port, curthread);
994 lwkt_initmsg(&devfs_msg->hdr, &rep_port, 0);
996 devfs_msg->hdr.u.ms_result = cmd;
998 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
999 msg_incoming = lwkt_waitport(&rep_port, 0);
1001 return msg_incoming;
1005 * sends a message with a generic argument.
1008 devfs_msg_send_generic(uint32_t cmd, void *load)
1010 devfs_msg_t devfs_msg = devfs_msg_get();
1012 devfs_msg->mdv_load = load;
1013 devfs_msg_send(cmd, devfs_msg);
1017 * sends a message with a name argument.
1020 devfs_msg_send_name(uint32_t cmd, char *name)
1022 devfs_msg_t devfs_msg = devfs_msg_get();
1024 devfs_msg->mdv_name = name;
1025 devfs_msg_send(cmd, devfs_msg);
1029 * sends a message with a mount argument.
1032 devfs_msg_send_mount(uint32_t cmd, struct devfs_mnt_data *mnt)
1034 devfs_msg_t devfs_msg = devfs_msg_get();
1036 devfs_msg->mdv_mnt = mnt;
1037 devfs_msg_send(cmd, devfs_msg);
1041 * sends a message with an ops argument.
1044 devfs_msg_send_ops(uint32_t cmd, struct dev_ops *ops, int minor)
1046 devfs_msg_t devfs_msg = devfs_msg_get();
1048 devfs_msg->mdv_ops.ops = ops;
1049 devfs_msg->mdv_ops.minor = minor;
1050 devfs_msg_send(cmd, devfs_msg);
1054 * sends a message with a clone handler argument.
1057 devfs_msg_send_chandler(uint32_t cmd, char *name, d_clone_t handler)
1059 devfs_msg_t devfs_msg = devfs_msg_get();
1061 devfs_msg->mdv_chandler.name = name;
1062 devfs_msg->mdv_chandler.nhandler = handler;
1063 devfs_msg_send(cmd, devfs_msg);
1067 * sends a message with a device argument.
1070 devfs_msg_send_dev(uint32_t cmd, cdev_t dev, uid_t uid, gid_t gid, int perms)
1072 devfs_msg_t devfs_msg = devfs_msg_get();
1074 devfs_msg->mdv_dev.dev = dev;
1075 devfs_msg->mdv_dev.uid = uid;
1076 devfs_msg->mdv_dev.gid = gid;
1077 devfs_msg->mdv_dev.perms = perms;
1079 devfs_msg_send(cmd, devfs_msg);
1083 * sends a message with a link argument.
1086 devfs_msg_send_link(uint32_t cmd, char *name, char *target, struct mount *mp)
1088 devfs_msg_t devfs_msg = devfs_msg_get();
1090 devfs_msg->mdv_link.name = name;
1091 devfs_msg->mdv_link.target = target;
1092 devfs_msg->mdv_link.mp = mp;
1093 devfs_msg_send(cmd, devfs_msg);
1097 * devfs_msg_core is the main devfs thread. It handles all incoming messages
1098 * and calls the relevant worker functions. By using messages it's assured
1099 * that events occur in the correct order.
1102 devfs_msg_core(void *arg)
1106 lwkt_initport_thread(&devfs_msg_port, curthread);
1108 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1111 lockmgr(&devfs_lock, LK_RELEASE);
1113 get_mplock(); /* mpsafe yet? */
1116 msg = (devfs_msg_t)lwkt_waitport(&devfs_msg_port, 0);
1117 devfs_debug(DEVFS_DEBUG_DEBUG,
1118 "devfs_msg_core, new msg: %x\n",
1119 (unsigned int)msg->hdr.u.ms_result);
1120 devfs_msg_exec(msg);
1121 lwkt_replymsg(&msg->hdr, 0);
1131 devfs_msg_exec(devfs_msg_t msg)
1133 struct devfs_mnt_data *mnt;
1134 struct devfs_node *node;
1138 * Acquire the devfs lock to ensure safety of all called functions
1140 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1142 switch (msg->hdr.u.ms_result) {
1143 case DEVFS_DEVICE_CREATE:
1144 dev = msg->mdv_dev.dev;
1145 devfs_create_dev_worker(dev,
1148 msg->mdv_dev.perms);
1150 case DEVFS_DEVICE_DESTROY:
1151 dev = msg->mdv_dev.dev;
1152 devfs_destroy_dev_worker(dev);
1154 case DEVFS_DESTROY_RELATED:
1155 devfs_destroy_related_worker(msg->mdv_load);
1157 case DEVFS_DESTROY_DEV_BY_OPS:
1158 devfs_destroy_dev_by_ops_worker(msg->mdv_ops.ops,
1159 msg->mdv_ops.minor);
1161 case DEVFS_CREATE_ALL_DEV:
1162 node = (struct devfs_node *)msg->mdv_load;
1163 devfs_create_all_dev_worker(node);
1165 case DEVFS_MOUNT_ADD:
1167 TAILQ_INSERT_TAIL(&devfs_mnt_list, mnt, link);
1168 devfs_create_all_dev_worker(mnt->root_node);
1170 case DEVFS_MOUNT_DEL:
1172 TAILQ_REMOVE(&devfs_mnt_list, mnt, link);
1173 devfs_iterate_topology(mnt->root_node, devfs_reaperp_callback,
1175 if (mnt->leak_count) {
1176 devfs_debug(DEVFS_DEBUG_SHOW,
1177 "Leaked %ld devfs_node elements!\n",
1181 case DEVFS_CHANDLER_ADD:
1182 devfs_chandler_add_worker(msg->mdv_chandler.name,
1183 msg->mdv_chandler.nhandler);
1185 case DEVFS_CHANDLER_DEL:
1186 devfs_chandler_del_worker(msg->mdv_chandler.name);
1188 case DEVFS_FIND_DEVICE_BY_NAME:
1189 devfs_find_device_by_name_worker(msg);
1191 case DEVFS_FIND_DEVICE_BY_UDEV:
1192 devfs_find_device_by_udev_worker(msg);
1194 case DEVFS_MAKE_ALIAS:
1195 devfs_make_alias_worker((struct devfs_alias *)msg->mdv_load);
1197 case DEVFS_DESTROY_ALIAS:
1198 devfs_destroy_alias_worker((struct devfs_alias *)msg->mdv_load);
1200 case DEVFS_APPLY_RULES:
1201 devfs_apply_reset_rules_caller(msg->mdv_name, 1);
1203 case DEVFS_RESET_RULES:
1204 devfs_apply_reset_rules_caller(msg->mdv_name, 0);
1206 case DEVFS_SCAN_CALLBACK:
1207 devfs_scan_callback_worker((devfs_scan_t *)msg->mdv_load,
1210 case DEVFS_CLR_RELATED_FLAG:
1211 devfs_clr_related_flag_worker(msg->mdv_flags.dev,
1212 msg->mdv_flags.flag);
1214 case DEVFS_DESTROY_RELATED_WO_FLAG:
1215 devfs_destroy_related_without_flag_worker(msg->mdv_flags.dev,
1216 msg->mdv_flags.flag);
1218 case DEVFS_INODE_TO_VNODE:
1219 msg->mdv_ino.vp = devfs_iterate_topology(
1220 DEVFS_MNTDATA(msg->mdv_ino.mp)->root_node,
1221 (devfs_iterate_callback_t *)devfs_inode_to_vnode_worker_callback,
1224 case DEVFS_TERMINATE_CORE:
1230 devfs_debug(DEVFS_DEBUG_WARNING,
1231 "devfs_msg_core: unknown message "
1232 "received at core\n");
1235 lockmgr(&devfs_lock, LK_RELEASE);
1239 devfs_devctl_notify(cdev_t dev, const char *ev)
1241 static const char prefix[] = "cdev=";
1245 namelen = strlen(dev->si_name);
1246 data = kmalloc(namelen + sizeof(prefix), M_TEMP, M_WAITOK);
1247 memcpy(data, prefix, sizeof(prefix) - 1);
1248 memcpy(data + sizeof(prefix) - 1, dev->si_name, namelen + 1);
1249 devctl_notify("DEVFS", "CDEV", ev, data);
1250 kfree(data, M_TEMP);
1254 * Worker function to insert a new dev into the dev list and initialize its
1255 * permissions. It also calls devfs_propagate_dev which in turn propagates
1256 * the change to all mount points.
1258 * The passed dev is already referenced. This reference is eaten by this
1259 * function and represents the dev's linkage into devfs_dev_list.
1262 devfs_create_dev_worker(cdev_t dev, uid_t uid, gid_t gid, int perms)
1268 dev->si_perms = perms;
1270 devfs_link_dev(dev);
1271 devfs_propagate_dev(dev, 1);
1273 udev_event_attach(dev, NULL, 0);
1274 devfs_devctl_notify(dev, "CREATE");
1280 * Worker function to delete a dev from the dev list and free the cdev.
1281 * It also calls devfs_propagate_dev which in turn propagates the change
1282 * to all mount points.
1285 devfs_destroy_dev_worker(cdev_t dev)
1290 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1292 error = devfs_unlink_dev(dev);
1293 devfs_propagate_dev(dev, 0);
1295 devfs_devctl_notify(dev, "DESTROY");
1296 udev_event_detach(dev, NULL, 0);
1299 release_dev(dev); /* link ref */
1307 * Worker function to destroy all devices with a certain basename.
1308 * Calls devfs_destroy_dev_worker for the actual destruction.
1311 devfs_destroy_related_worker(cdev_t needle)
1316 devfs_debug(DEVFS_DEBUG_DEBUG, "related worker: %s\n",
1318 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1319 if (dev->si_parent == needle) {
1320 devfs_destroy_related_worker(dev);
1321 devfs_destroy_dev_worker(dev);
1329 devfs_clr_related_flag_worker(cdev_t needle, uint32_t flag)
1333 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1334 if (dev->si_parent == needle) {
1335 devfs_clr_related_flag_worker(dev, flag);
1336 dev->si_flags &= ~flag;
1344 devfs_destroy_related_without_flag_worker(cdev_t needle, uint32_t flag)
1349 devfs_debug(DEVFS_DEBUG_DEBUG, "related_wo_flag: %s\n",
1352 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1353 if (dev->si_parent == needle) {
1354 devfs_destroy_related_without_flag_worker(dev, flag);
1355 if (!(dev->si_flags & flag)) {
1356 devfs_destroy_dev_worker(dev);
1357 devfs_debug(DEVFS_DEBUG_DEBUG,
1358 "related_wo_flag: %s restart\n", dev->si_name);
1368 * Worker function that creates all device nodes on top of a devfs
1372 devfs_create_all_dev_worker(struct devfs_node *root)
1378 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1379 devfs_create_device_node(root, dev, NULL, NULL);
1386 * Worker function that destroys all devices that match a specific
1387 * dev_ops and/or minor. If minor is less than 0, it is not matched
1388 * against. It also propagates all changes.
1391 devfs_destroy_dev_by_ops_worker(struct dev_ops *ops, int minor)
1397 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1398 if (dev->si_ops != ops)
1400 if ((minor < 0) || (dev->si_uminor == minor)) {
1401 devfs_destroy_dev_worker(dev);
1409 * Worker function that registers a new clone handler in devfs.
1412 devfs_chandler_add_worker(const char *name, d_clone_t *nhandler)
1414 struct devfs_clone_handler *chandler = NULL;
1415 u_char len = strlen(name);
1420 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
1421 if (chandler->namlen != len)
1424 if (!memcmp(chandler->name, name, len)) {
1425 /* Clonable basename already exists */
1430 chandler = kmalloc(sizeof(*chandler), M_DEVFS, M_WAITOK | M_ZERO);
1431 chandler->name = kstrdup(name, M_DEVFS);
1432 chandler->namlen = len;
1433 chandler->nhandler = nhandler;
1435 TAILQ_INSERT_TAIL(&devfs_chandler_list, chandler, link);
1440 * Worker function that removes a given clone handler from the
1441 * clone handler list.
1444 devfs_chandler_del_worker(const char *name)
1446 struct devfs_clone_handler *chandler, *chandler2;
1447 u_char len = strlen(name);
1452 TAILQ_FOREACH_MUTABLE(chandler, &devfs_chandler_list, link, chandler2) {
1453 if (chandler->namlen != len)
1455 if (memcmp(chandler->name, name, len))
1458 TAILQ_REMOVE(&devfs_chandler_list, chandler, link);
1459 kfree(chandler->name, M_DEVFS);
1460 kfree(chandler, M_DEVFS);
1468 * Worker function that finds a given device name and changes
1469 * the message received accordingly so that when replied to,
1470 * the answer is returned to the caller.
1473 devfs_find_device_by_name_worker(devfs_msg_t devfs_msg)
1475 struct devfs_alias *alias;
1477 cdev_t found = NULL;
1479 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1480 if (strcmp(devfs_msg->mdv_name, dev->si_name) == 0) {
1485 if (found == NULL) {
1486 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1487 if (strcmp(devfs_msg->mdv_name, alias->name) == 0) {
1488 found = alias->dev_target;
1493 devfs_msg->mdv_cdev = found;
1499 * Worker function that finds a given device udev and changes
1500 * the message received accordingly so that when replied to,
1501 * the answer is returned to the caller.
1504 devfs_find_device_by_udev_worker(devfs_msg_t devfs_msg)
1507 cdev_t found = NULL;
1509 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1510 if (((udev_t)dev->si_inode) == devfs_msg->mdv_udev) {
1515 devfs_msg->mdv_cdev = found;
1521 * Worker function that inserts a given alias into the
1522 * alias list, and propagates the alias to all mount
1526 devfs_make_alias_worker(struct devfs_alias *alias)
1528 struct devfs_alias *alias2;
1529 size_t len = strlen(alias->name);
1532 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1533 if (len != alias2->namlen)
1536 if (!memcmp(alias->name, alias2->name, len)) {
1544 * The alias doesn't exist yet, so we add it to the alias list
1546 TAILQ_INSERT_TAIL(&devfs_alias_list, alias, link);
1547 devfs_alias_propagate(alias, 0);
1548 udev_event_attach(alias->dev_target, alias->name, 1);
1550 devfs_debug(DEVFS_DEBUG_WARNING,
1551 "Warning: duplicate devfs_make_alias for %s\n",
1553 kfree(alias->name, M_DEVFS);
1554 kfree(alias, M_DEVFS);
1561 * Worker function that delete a given alias from the
1562 * alias list, and propagates the removal to all mount
1566 devfs_destroy_alias_worker(struct devfs_alias *alias)
1568 struct devfs_alias *alias2;
1571 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1572 if (alias->dev_target != alias2->dev_target)
1575 if (devfs_WildCmp(alias->name, alias2->name) == 0) {
1582 devfs_debug(DEVFS_DEBUG_WARNING,
1583 "Warning: devfs_destroy_alias for inexistant alias: %s\n",
1585 kfree(alias->name, M_DEVFS);
1586 kfree(alias, M_DEVFS);
1589 * The alias exists, so we delete it from the alias list
1591 TAILQ_REMOVE(&devfs_alias_list, alias2, link);
1592 devfs_alias_propagate(alias2, 1);
1593 udev_event_detach(alias2->dev_target, alias2->name, 1);
1594 kfree(alias->name, M_DEVFS);
1595 kfree(alias, M_DEVFS);
1596 kfree(alias2->name, M_DEVFS);
1597 kfree(alias2, M_DEVFS);
1604 * Function that removes and frees all aliases.
1607 devfs_alias_reap(void)
1609 struct devfs_alias *alias, *alias2;
1611 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1612 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1613 kfree(alias->name, M_DEVFS);
1614 kfree(alias, M_DEVFS);
1620 * Function that removes an alias matching a specific cdev and frees
1624 devfs_alias_remove(cdev_t dev)
1626 struct devfs_alias *alias, *alias2;
1628 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1629 if (alias->dev_target == dev) {
1630 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1631 udev_event_detach(alias->dev_target, alias->name, 1);
1632 kfree(alias->name, M_DEVFS);
1633 kfree(alias, M_DEVFS);
1640 * This function propagates an alias addition or removal to
1644 devfs_alias_propagate(struct devfs_alias *alias, int remove)
1646 struct devfs_mnt_data *mnt;
1648 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1650 devfs_destroy_node(mnt->root_node, alias->name);
1652 devfs_alias_apply(mnt->root_node, alias);
1659 * This function is a recursive function iterating through
1660 * all device nodes in the topology and, if applicable,
1661 * creating the relevant alias for a device node.
1664 devfs_alias_apply(struct devfs_node *node, struct devfs_alias *alias)
1666 struct devfs_node *node1, *node2;
1668 KKASSERT(alias != NULL);
1670 if ((node->node_type == Nroot) || (node->node_type == Ndir)) {
1671 if (node->nchildren > 2) {
1672 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1673 devfs_alias_apply(node1, alias);
1677 if (node->d_dev == alias->dev_target)
1678 devfs_alias_create(alias->name, node, 0);
1684 * This function checks if any alias possibly is applicable
1685 * to the given node. If so, the alias is created.
1688 devfs_alias_check_create(struct devfs_node *node)
1690 struct devfs_alias *alias;
1692 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1693 if (node->d_dev == alias->dev_target)
1694 devfs_alias_create(alias->name, node, 0);
1700 * This function creates an alias with a given name
1701 * linking to a given devfs node. It also increments
1702 * the link count on the target node.
1705 devfs_alias_create(char *name_orig, struct devfs_node *target, int rule_based)
1707 struct mount *mp = target->mp;
1708 struct devfs_node *parent = DEVFS_MNTDATA(mp)->root_node;
1709 struct devfs_node *linknode;
1710 char *create_path = NULL;
1715 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1717 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1718 devfs_resolve_name_path(name_orig, name_buf, &create_path, &name);
1721 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1724 if (devfs_find_device_node_by_name(parent, name)) {
1725 devfs_debug(DEVFS_DEBUG_WARNING,
1726 "Node already exists: %s "
1727 "(devfs_make_alias_worker)!\n",
1733 linknode = devfs_allocp(Nlink, name, parent, mp, NULL);
1734 if (linknode == NULL) {
1739 linknode->link_target = target;
1743 linknode->flags |= DEVFS_RULE_CREATED;
1746 kfree(name_buf, M_TEMP);
1751 * This function is called by the core and handles mount point
1752 * strings. It either calls the relevant worker (devfs_apply_
1753 * reset_rules_worker) on all mountpoints or only a specific
1757 devfs_apply_reset_rules_caller(char *mountto, int apply)
1759 struct devfs_mnt_data *mnt;
1761 if (mountto[0] == '*') {
1762 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1763 devfs_iterate_topology(mnt->root_node,
1764 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1768 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1769 if (!strcmp(mnt->mp->mnt_stat.f_mntonname, mountto)) {
1770 devfs_iterate_topology(mnt->root_node,
1771 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1778 kfree(mountto, M_DEVFS);
1783 * This function calls a given callback function for
1784 * every dev node in the devfs dev list.
1787 devfs_scan_callback_worker(devfs_scan_t *callback, void *arg)
1790 struct devfs_alias *alias, *alias1;
1792 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1793 callback(dev->si_name, dev, false, arg);
1795 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias1) {
1796 callback(alias->name, alias->dev_target, true, arg);
1803 * This function tries to resolve a given directory, or if not
1804 * found and creation requested, creates the given directory.
1806 static struct devfs_node *
1807 devfs_resolve_or_create_dir(struct devfs_node *parent, char *dir_name,
1808 size_t name_len, int create)
1810 struct devfs_node *node, *found = NULL;
1812 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1813 if (name_len != node->d_dir.d_namlen)
1816 if (!memcmp(dir_name, node->d_dir.d_name, name_len)) {
1822 if ((found == NULL) && (create)) {
1823 found = devfs_allocp(Ndir, dir_name, parent, parent->mp, NULL);
1830 * This function tries to resolve a complete path. If creation is requested,
1831 * if a given part of the path cannot be resolved (because it doesn't exist),
1835 devfs_resolve_or_create_path(struct devfs_node *parent, char *path, int create)
1837 struct devfs_node *node = parent;
1844 buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1846 while (*path && idx < PATH_MAX - 1) {
1851 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1861 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1862 kfree (buf, M_TEMP);
1867 * Takes a full path and strips it into a directory path and a name.
1868 * For a/b/c/foo, it returns foo in namep and a/b/c in pathp. It
1869 * requires a working buffer with enough size to keep the whole
1873 devfs_resolve_name_path(char *fullpath, char *buf, char **pathp, char **namep)
1877 size_t len = strlen(fullpath) + 1;
1880 KKASSERT((fullpath != NULL) && (buf != NULL));
1881 KKASSERT((pathp != NULL) && (namep != NULL));
1883 memcpy(buf, fullpath, len);
1885 for (i = len-1; i>= 0; i--) {
1886 if (buf[i] == '/') {
1906 * This function creates a new devfs node for a given device. It can
1907 * handle a complete path as device name, and accordingly creates
1908 * the path and the final device node.
1910 * The reference count on the passed dev remains unchanged.
1913 devfs_create_device_node(struct devfs_node *root, cdev_t dev,
1914 char *dev_name, char *path_fmt, ...)
1916 struct devfs_node *parent, *node = NULL;
1922 char *create_path = NULL;
1923 char *names = "pqrsPQRS";
1925 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1927 if (path_fmt != NULL) {
1928 __va_start(ap, path_fmt);
1929 kvasnrprintf(&path, PATH_MAX, 10, path_fmt, ap);
1933 parent = devfs_resolve_or_create_path(root, path, 1);
1936 devfs_resolve_name_path(
1937 ((dev_name == NULL) && (dev))?(dev->si_name):(dev_name),
1938 name_buf, &create_path, &name);
1941 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1944 if (devfs_find_device_node_by_name(parent, name)) {
1945 devfs_debug(DEVFS_DEBUG_WARNING, "devfs_create_device_node: "
1946 "DEVICE %s ALREADY EXISTS!!! Ignoring creation request.\n", name);
1950 node = devfs_allocp(Ndev, name, parent, parent->mp, dev);
1951 nanotime(&parent->mtime);
1954 * Ugly unix98 pty magic, to hide pty master (ptm) devices and their
1957 if ((dev) && (strlen(dev->si_name) >= 4) &&
1958 (!memcmp(dev->si_name, "ptm/", 4))) {
1959 node->parent->flags |= DEVFS_HIDDEN;
1960 node->flags |= DEVFS_HIDDEN;
1964 * Ugly pty magic, to tag pty devices as such and hide them if needed.
1966 if ((strlen(name) >= 3) && (!memcmp(name, "pty", 3)))
1967 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1969 if ((strlen(name) >= 3) && (!memcmp(name, "tty", 3))) {
1971 for (i = 0; i < strlen(names); i++) {
1972 if (name[3] == names[i]) {
1978 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1982 kfree(name_buf, M_TEMP);
1988 * This function finds a given device node in the topology with a given
1992 devfs_find_device_node_callback(struct devfs_node *node, cdev_t target)
1994 if ((node->node_type == Ndev) && (node->d_dev == target)) {
2002 * This function finds a device node in the given parent directory by its
2003 * name and returns it.
2006 devfs_find_device_node_by_name(struct devfs_node *parent, char *target)
2008 struct devfs_node *node, *found = NULL;
2009 size_t len = strlen(target);
2011 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
2012 if (len != node->d_dir.d_namlen)
2015 if (!memcmp(node->d_dir.d_name, target, len)) {
2025 devfs_inode_to_vnode_worker_callback(struct devfs_node *node, ino_t *inop)
2027 struct vnode *vp = NULL;
2028 ino_t target = *inop;
2030 if (node->d_dir.d_ino == target) {
2033 vget(vp, LK_EXCLUSIVE | LK_RETRY);
2036 devfs_allocv(&vp, node);
2045 * This function takes a cdev and removes its devfs node in the
2046 * given topology. The cdev remains intact.
2049 devfs_destroy_device_node(struct devfs_node *root, cdev_t target)
2051 KKASSERT(target != NULL);
2052 return devfs_destroy_node(root, target->si_name);
2056 * This function takes a path to a devfs node, resolves it and
2057 * removes the devfs node from the given topology.
2060 devfs_destroy_node(struct devfs_node *root, char *target)
2062 struct devfs_node *node, *parent;
2065 char *create_path = NULL;
2069 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
2070 ksnprintf(name_buf, PATH_MAX, "%s", target);
2072 devfs_resolve_name_path(target, name_buf, &create_path, &name);
2075 parent = devfs_resolve_or_create_path(root, create_path, 0);
2079 if (parent == NULL) {
2080 kfree(name_buf, M_TEMP);
2084 node = devfs_find_device_node_by_name(parent, name);
2087 nanotime(&node->parent->mtime);
2091 kfree(name_buf, M_TEMP);
2097 * Just set perms and ownership for given node.
2100 devfs_set_perms(struct devfs_node *node, uid_t uid, gid_t gid,
2101 u_short mode, u_long flags)
2111 * Propagates a device attach/detach to all mount
2112 * points. Also takes care of automatic alias removal
2113 * for a deleted cdev.
2116 devfs_propagate_dev(cdev_t dev, int attach)
2118 struct devfs_mnt_data *mnt;
2120 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
2122 /* Device is being attached */
2123 devfs_create_device_node(mnt->root_node, dev,
2126 /* Device is being detached */
2127 devfs_alias_remove(dev);
2128 devfs_destroy_device_node(mnt->root_node, dev);
2135 * devfs_clone either returns a basename from a complete name by
2136 * returning the length of the name without trailing digits, or,
2137 * if clone != 0, calls the device's clone handler to get a new
2138 * device, which in turn is returned in devp.
2141 devfs_clone(cdev_t dev, const char *name, size_t len, int mode,
2145 struct devfs_clone_handler *chandler;
2146 struct dev_clone_args ap;
2148 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
2149 if (chandler->namlen != len)
2151 if ((!memcmp(chandler->name, name, len)) && (chandler->nhandler)) {
2152 lockmgr(&devfs_lock, LK_RELEASE);
2154 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2156 ap.a_head.a_dev = dev;
2162 error = (chandler->nhandler)(&ap);
2175 * Registers a new orphan in the orphan list.
2178 devfs_tracer_add_orphan(struct devfs_node *node)
2180 struct devfs_orphan *orphan;
2183 orphan = kmalloc(sizeof(struct devfs_orphan), M_DEVFS, M_WAITOK);
2184 orphan->node = node;
2186 KKASSERT((node->flags & DEVFS_ORPHANED) == 0);
2187 node->flags |= DEVFS_ORPHANED;
2188 TAILQ_INSERT_TAIL(DEVFS_ORPHANLIST(node->mp), orphan, link);
2192 * Removes an orphan from the orphan list.
2195 devfs_tracer_del_orphan(struct devfs_node *node)
2197 struct devfs_orphan *orphan;
2201 TAILQ_FOREACH(orphan, DEVFS_ORPHANLIST(node->mp), link) {
2202 if (orphan->node == node) {
2203 node->flags &= ~DEVFS_ORPHANED;
2204 TAILQ_REMOVE(DEVFS_ORPHANLIST(node->mp), orphan, link);
2205 kfree(orphan, M_DEVFS);
2212 * Counts the orphans in the orphan list, and if cleanup
2213 * is specified, also frees the orphan and removes it from
2217 devfs_tracer_orphan_count(struct mount *mp, int cleanup)
2219 struct devfs_orphan *orphan, *orphan2;
2222 TAILQ_FOREACH_MUTABLE(orphan, DEVFS_ORPHANLIST(mp), link, orphan2) {
2225 * If we are instructed to clean up, we do so.
2228 TAILQ_REMOVE(DEVFS_ORPHANLIST(mp), orphan, link);
2229 orphan->node->flags &= ~DEVFS_ORPHANED;
2230 devfs_freep(orphan->node);
2231 kfree(orphan, M_DEVFS);
2239 * Fetch an ino_t from the global d_ino by increasing it
2243 devfs_fetch_ino(void)
2247 spin_lock(&ino_lock);
2249 spin_unlock(&ino_lock);
2255 * Allocates a new cdev and initializes it's most basic
2259 devfs_new_cdev(struct dev_ops *ops, int minor, struct dev_ops *bops)
2261 cdev_t dev = sysref_alloc(&cdev_sysref_class);
2263 sysref_activate(&dev->si_sysref);
2265 bzero(dev, offsetof(struct cdev, si_sysref));
2270 dev->si_drv1 = NULL;
2271 dev->si_drv2 = NULL;
2272 dev->si_lastread = 0; /* time_uptime */
2273 dev->si_lastwrite = 0; /* time_uptime */
2275 dev->si_dict = NULL;
2276 dev->si_parent = NULL;
2279 dev->si_uminor = minor;
2280 dev->si_bops = bops;
2283 * Since the disk subsystem is in the way, we need to
2284 * propagate the D_CANFREE from bops (and ops) to
2287 if (bops && (bops->head.flags & D_CANFREE)) {
2288 dev->si_flags |= SI_CANFREE;
2289 } else if (ops->head.flags & D_CANFREE) {
2290 dev->si_flags |= SI_CANFREE;
2293 /* If there is a backing device, we reference its ops */
2294 dev->si_inode = makeudev(
2295 devfs_reference_ops((bops)?(bops):(ops)),
2297 dev->si_umajor = umajor(dev->si_inode);
2303 devfs_cdev_terminate(cdev_t dev)
2307 /* Check if it is locked already. if not, we acquire the devfs lock */
2308 if ((lockstatus(&devfs_lock, curthread)) != LK_EXCLUSIVE) {
2309 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2314 * Make sure the node isn't linked anymore. Otherwise we've screwed
2315 * up somewhere, since normal devs are unlinked on the call to
2316 * destroy_dev and only-cdevs that have not been used for cloning
2317 * are not linked in the first place. only-cdevs used for cloning
2318 * will be linked in, too, and should only be destroyed via
2319 * destroy_dev, not destroy_only_dev, so we catch that problem, too.
2321 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2323 /* If we acquired the lock, we also get rid of it */
2325 lockmgr(&devfs_lock, LK_RELEASE);
2327 /* If there is a backing device, we release the backing device's ops */
2328 devfs_release_ops((dev->si_bops)?(dev->si_bops):(dev->si_ops));
2330 /* Finally destroy the device */
2331 sysref_put(&dev->si_sysref);
2335 * Dummies for now (individual locks for MPSAFE)
2338 devfs_cdev_lock(cdev_t dev)
2343 devfs_cdev_unlock(cdev_t dev)
2348 devfs_detached_filter_eof(struct knote *kn, long hint)
2350 kn->kn_flags |= (EV_EOF | EV_NODATA);
2355 devfs_detached_filter_detach(struct knote *kn)
2357 cdev_t dev = (cdev_t)kn->kn_hook;
2359 knote_remove(&dev->si_kqinfo.ki_note, kn);
2362 static struct filterops devfs_detached_filterops =
2363 { FILTEROP_ISFD, NULL,
2364 devfs_detached_filter_detach,
2365 devfs_detached_filter_eof };
2368 * Delegates knote filter handling responsibility to devfs
2370 * Any device that implements kqfilter event handling and could be detached
2371 * or shut down out from under the kevent subsystem must allow devfs to
2372 * assume responsibility for any knotes it may hold.
2375 devfs_assume_knotes(cdev_t dev, struct kqinfo *kqi)
2378 * Let kern/kern_event.c do the heavy lifting.
2380 knote_assume_knotes(kqi, &dev->si_kqinfo,
2381 &devfs_detached_filterops, (void *)dev);
2384 * These should probably be activated individually, but doing so
2385 * would require refactoring kq's public in-kernel interface.
2387 KNOTE(&dev->si_kqinfo.ki_note, 0);
2391 * Links a given cdev into the dev list.
2394 devfs_link_dev(cdev_t dev)
2396 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2397 dev->si_flags |= SI_DEVFS_LINKED;
2398 TAILQ_INSERT_TAIL(&devfs_dev_list, dev, link);
2404 * Removes a given cdev from the dev list. The caller is responsible for
2405 * releasing the reference on the device associated with the linkage.
2407 * Returns EALREADY if the dev has already been unlinked.
2410 devfs_unlink_dev(cdev_t dev)
2412 if ((dev->si_flags & SI_DEVFS_LINKED)) {
2413 TAILQ_REMOVE(&devfs_dev_list, dev, link);
2414 dev->si_flags &= ~SI_DEVFS_LINKED;
2421 devfs_node_is_accessible(struct devfs_node *node)
2423 if ((node) && (!(node->flags & DEVFS_HIDDEN)))
2430 devfs_reference_ops(struct dev_ops *ops)
2433 struct devfs_dev_ops *found = NULL;
2434 struct devfs_dev_ops *devops;
2436 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2437 if (devops->ops == ops) {
2444 found = kmalloc(sizeof(struct devfs_dev_ops), M_DEVFS, M_WAITOK);
2446 found->ref_count = 0;
2447 TAILQ_INSERT_TAIL(&devfs_dev_ops_list, found, link);
2452 if (found->ref_count == 0) {
2453 found->id = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(ops_id), 255);
2454 if (found->id == -1) {
2455 /* Ran out of unique ids */
2456 devfs_debug(DEVFS_DEBUG_WARNING,
2457 "devfs_reference_ops: WARNING: ran out of unique ids\n");
2467 devfs_release_ops(struct dev_ops *ops)
2469 struct devfs_dev_ops *found = NULL;
2470 struct devfs_dev_ops *devops;
2472 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2473 if (devops->ops == ops) {
2483 if (found->ref_count == 0) {
2484 TAILQ_REMOVE(&devfs_dev_ops_list, found, link);
2485 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(ops_id), found->id);
2486 kfree(found, M_DEVFS);
2491 * Wait for asynchronous messages to complete in the devfs helper
2492 * thread, then return. Do nothing if the helper thread is dead
2493 * or we are being indirectly called from the helper thread itself.
2500 if (devfs_run && curthread != td_core) {
2501 msg = devfs_msg_get();
2502 msg = devfs_msg_send_sync(DEVFS_SYNC, msg);
2508 * Called on init of devfs; creates the objcaches and
2509 * spawns off the devfs core thread. Also initializes
2515 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init() called\n");
2516 /* Create objcaches for nodes, msgs and devs */
2517 devfs_node_cache = objcache_create("devfs-node-cache", 0, 0,
2519 objcache_malloc_alloc,
2520 objcache_malloc_free,
2521 &devfs_node_malloc_args );
2523 devfs_msg_cache = objcache_create("devfs-msg-cache", 0, 0,
2525 objcache_malloc_alloc,
2526 objcache_malloc_free,
2527 &devfs_msg_malloc_args );
2529 devfs_dev_cache = objcache_create("devfs-dev-cache", 0, 0,
2531 objcache_malloc_alloc,
2532 objcache_malloc_free,
2533 &devfs_dev_malloc_args );
2535 devfs_clone_bitmap_init(&DEVFS_CLONE_BITMAP(ops_id));
2537 /* Initialize the reply-only port which acts as a message drain */
2538 lwkt_initport_replyonly(&devfs_dispose_port, devfs_msg_autofree_reply);
2540 /* Initialize *THE* devfs lock */
2541 lockinit(&devfs_lock, "devfs_core lock", 0, 0);
2543 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2544 lwkt_create(devfs_msg_core, /*args*/NULL, &td_core, NULL,
2545 0, -1, "devfs_msg_core");
2546 while (devfs_run == 0)
2547 lksleep(td_core, &devfs_lock, 0, "devfsc", 0);
2548 lockmgr(&devfs_lock, LK_RELEASE);
2550 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init finished\n");
2554 * Called on unload of devfs; takes care of destroying the core
2555 * and the objcaches. Also removes aliases that are no longer needed.
2560 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_uninit() called\n");
2562 devfs_msg_send(DEVFS_TERMINATE_CORE, NULL);
2564 tsleep(td_core, 0, "devfsc", hz*10);
2565 tsleep(td_core, 0, "devfsc", hz);
2567 devfs_clone_bitmap_uninit(&DEVFS_CLONE_BITMAP(ops_id));
2569 /* Destroy the objcaches */
2570 objcache_destroy(devfs_msg_cache);
2571 objcache_destroy(devfs_node_cache);
2572 objcache_destroy(devfs_dev_cache);
2578 * This is a sysctl handler to assist userland devname(3) to
2579 * find the device name for a given udev.
2582 devfs_sysctl_devname_helper(SYSCTL_HANDLER_ARGS)
2589 if ((error = SYSCTL_IN(req, &udev, sizeof(udev_t))))
2592 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs sysctl, received udev: %d\n", udev);
2597 if ((found = devfs_find_device_by_udev(udev)) == NULL)
2600 return(SYSCTL_OUT(req, found->si_name, strlen(found->si_name) + 1));
2604 SYSCTL_PROC(_kern, OID_AUTO, devname, CTLTYPE_OPAQUE|CTLFLAG_RW|CTLFLAG_ANYBODY,
2605 NULL, 0, devfs_sysctl_devname_helper, "", "helper for devname(3)");
2607 SYSCTL_NODE(_vfs, OID_AUTO, devfs, CTLFLAG_RW, 0, "devfs");
2608 TUNABLE_INT("vfs.devfs.debug", &devfs_debug_enable);
2609 SYSCTL_INT(_vfs_devfs, OID_AUTO, debug, CTLFLAG_RW, &devfs_debug_enable,
2610 0, "Enable DevFS debugging");
2612 SYSINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
2614 SYSUNINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY,
2615 devfs_uninit, NULL);
2618 * WildCmp() - compare wild string to sane string
2620 * Returns 0 on success, -1 on failure.
2623 wildCmp(const char **mary, int d, const char *w, const char *s)
2628 * skip fixed portion
2634 * optimize terminator
2638 if (w[1] != '?' && w[1] != '*') {
2640 * optimize * followed by non-wild
2642 for (i = 0; s + i < mary[d]; ++i) {
2643 if (s[i] == w[1] && wildCmp(mary, d + 1, w + 1, s + i) == 0)
2650 for (i = 0; s + i < mary[d]; ++i) {
2651 if (wildCmp(mary, d + 1, w + 1, s + i) == 0)
2666 if (*w == 0) /* terminator */
2679 * WildCaseCmp() - compare wild string to sane string, case insensitive
2681 * Returns 0 on success, -1 on failure.
2684 wildCaseCmp(const char **mary, int d, const char *w, const char *s)
2689 * skip fixed portion
2695 * optimize terminator
2699 if (w[1] != '?' && w[1] != '*') {
2701 * optimize * followed by non-wild
2703 for (i = 0; s + i < mary[d]; ++i) {
2704 if (s[i] == w[1] && wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
2711 for (i = 0; s + i < mary[d]; ++i) {
2712 if (wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
2726 #define tolower(x) ((x >= 'A' && x <= 'Z')?(x+('a'-'A')):(x))
2727 if (tolower(*w) != tolower(*s))
2730 if (*w == 0) /* terminator */
2741 struct cdev_privdata {
2743 cdevpriv_dtr_t cdpd_dtr;
2746 int devfs_get_cdevpriv(struct file *fp, void **datap)
2748 struct cdev_privdata *p;
2753 p = (struct cdev_privdata*) fp->f_data1;
2756 *datap = p->cdpd_data;
2762 int devfs_set_cdevpriv(struct file *fp, void *priv, cdevpriv_dtr_t dtr)
2764 struct cdev_privdata *p;
2770 p = kmalloc(sizeof(struct cdev_privdata), M_DEVFS, M_WAITOK);
2771 p->cdpd_data = priv;
2774 spin_lock(&fp->f_spin);
2775 if (fp->f_data1 == NULL) {
2780 spin_unlock(&fp->f_spin);
2788 void devfs_clear_cdevpriv(struct file *fp)
2790 struct cdev_privdata *p;
2795 spin_lock(&fp->f_spin);
2798 spin_unlock(&fp->f_spin);
2801 (p->cdpd_dtr)(p->cdpd_data);
2807 devfs_WildCmp(const char *w, const char *s)
2811 int slen = strlen(s);
2814 for (i = c = 0; w[i]; ++i) {
2818 mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
2819 for (i = 0; i < c; ++i)
2821 i = wildCmp(mary, 0, w, s);
2822 kfree(mary, M_DEVFS);
2827 devfs_WildCaseCmp(const char *w, const char *s)
2831 int slen = strlen(s);
2834 for (i = c = 0; w[i]; ++i) {
2838 mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
2839 for (i = 0; i < c; ++i)
2841 i = wildCaseCmp(mary, 0, w, s);
2842 kfree(mary, M_DEVFS);