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>
37 #include <sys/mount.h>
38 #include <sys/vnode.h>
39 #include <sys/types.h>
41 #include <sys/msgport.h>
42 #include <sys/sysctl.h>
43 #include <sys/ucred.h>
44 #include <sys/param.h>
45 #include <sys/systm.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 == Proot) || (parent->node_type == Pdir))) {
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 while ((vp = node->v_node) != NULL) {
297 error = vget(vp, LK_EXCLUSIVE);
298 if (error != ENOENT) {
304 if ((error = getnewvnode(VT_DEVFS, node->mp, vpp, 0, 0)) != 0)
309 if (node->v_node != NULL) {
318 switch (node->node_type) {
320 vsetflags(vp, VROOT);
336 KKASSERT(node->d_dev);
338 vp->v_uminor = node->d_dev->si_uminor;
341 v_associate_rdev(vp, node->d_dev);
342 vp->v_ops = &node->mp->mnt_vn_spec_ops;
346 panic("devfs_allocv: unknown node type");
354 * devfs_allocvp allocates both a devfs node (with the given settings) and a vnode
355 * based on the newly created devfs node.
358 devfs_allocvp(struct mount *mp, struct vnode **vpp, devfs_nodetype devfsnodetype,
359 char *name, struct devfs_node *parent, cdev_t dev)
361 struct devfs_node *node;
363 node = devfs_allocp(devfsnodetype, name, parent, mp, dev);
366 devfs_allocv(vpp, node);
374 * Destroy the devfs_node. The node must be unlinked from the topology.
376 * This function will also destroy any vnode association with the node
379 * The cdev_t itself remains intact.
381 * The core lock is not necessarily held on call and must be temporarily
382 * released if it is to avoid a deadlock.
385 devfs_freep(struct devfs_node *node)
391 KKASSERT(((node->flags & DEVFS_NODE_LINKED) == 0) ||
392 (node->node_type == Proot));
395 * Protect against double frees
397 KKASSERT((node->flags & DEVFS_DESTROYED) == 0);
398 node->flags |= DEVFS_DESTROYED;
401 * Avoid deadlocks between devfs_lock and the vnode lock when
402 * disassociating the vnode (stress2 pty vs ls -la /dev/pts).
404 * This also prevents the vnode reclaim code from double-freeing
405 * the node. The vget() is required to safely modified the vp
406 * and cycle the refs to terminate an inactive vp.
408 if (lockstatus(&devfs_lock, curthread) == LK_EXCLUSIVE) {
409 lockmgr(&devfs_lock, LK_RELEASE);
415 while ((vp = node->v_node) != NULL) {
416 if (vget(vp, LK_EXCLUSIVE | LK_RETRY) != 0)
421 cache_inval_vp(vp, CINV_DESTROY);
428 atomic_subtract_long(&DEVFS_MNTDATA(node->mp)->leak_count, 1);
429 if (node->symlink_name) {
430 kfree(node->symlink_name, M_DEVFS);
431 node->symlink_name = NULL;
435 * Remove the node from the orphan list if it is still on it.
437 if (node->flags & DEVFS_ORPHANED)
438 devfs_tracer_del_orphan(node);
440 if (node->d_dir.d_name) {
441 kfree(node->d_dir.d_name, M_DEVFS);
442 node->d_dir.d_name = NULL;
444 atomic_subtract_long(&DEVFS_MNTDATA(node->mp)->file_count, 1);
445 objcache_put(devfs_node_cache, node);
448 lockmgr(&devfs_lock, LK_EXCLUSIVE);
454 * Unlink the devfs node from the topology and add it to the orphan list.
455 * The node will later be destroyed by freep.
457 * Any vnode association, including the v_rdev and v_data, remains intact
461 devfs_unlinkp(struct devfs_node *node)
463 struct devfs_node *parent;
467 * Add the node to the orphan list, so it is referenced somewhere, to
468 * so we don't leak it.
470 devfs_tracer_add_orphan(node);
472 parent = node->parent;
475 * If the parent is known we can unlink the node out of the topology
478 TAILQ_REMOVE(DEVFS_DENODE_HEAD(parent), node, link);
480 node->flags &= ~DEVFS_NODE_LINKED;
488 devfs_iterate_topology(struct devfs_node *node,
489 devfs_iterate_callback_t *callback, void *arg1)
491 struct devfs_node *node1, *node2;
494 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
495 if (node->nchildren > 2) {
496 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node),
498 if ((ret = devfs_iterate_topology(node1, callback, arg1)))
504 ret = callback(node, arg1);
509 * devfs_reaperp() is a recursive function that iterates through all the
510 * topology, unlinking and freeing all devfs nodes.
513 devfs_reaperp_callback(struct devfs_node *node, void *unused)
522 devfs_gc_dirs_callback(struct devfs_node *node, void *unused)
524 if (node->node_type == Pdir) {
525 if ((node->nchildren == 2) &&
526 !(node->flags & DEVFS_USER_CREATED)) {
536 devfs_gc_links_callback(struct devfs_node *node, struct devfs_node *target)
538 if ((node->node_type == Plink) && (node->link_target == target)) {
547 * devfs_gc() is devfs garbage collector. It takes care of unlinking and
548 * freeing a node, but also removes empty directories and links that link
549 * via devfs auto-link mechanism to the node being deleted.
552 devfs_gc(struct devfs_node *node)
554 struct devfs_node *root_node = DEVFS_MNTDATA(node->mp)->root_node;
556 if (node->nlinks > 0)
557 devfs_iterate_topology(root_node,
558 (devfs_iterate_callback_t *)devfs_gc_links_callback, node);
561 devfs_iterate_topology(root_node,
562 (devfs_iterate_callback_t *)devfs_gc_dirs_callback, NULL);
570 * devfs_create_dev() is the asynchronous entry point for device creation.
571 * It just sends a message with the relevant details to the devfs core.
573 * This function will reference the passed device. The reference is owned
574 * by devfs and represents all of the device's node associations.
577 devfs_create_dev(cdev_t dev, uid_t uid, gid_t gid, int perms)
580 devfs_msg_send_dev(DEVFS_DEVICE_CREATE, dev, uid, gid, perms);
586 * devfs_destroy_dev() is the asynchronous entry point for device destruction.
587 * It just sends a message with the relevant details to the devfs core.
590 devfs_destroy_dev(cdev_t dev)
592 devfs_msg_send_dev(DEVFS_DEVICE_DESTROY, dev, 0, 0, 0);
597 * devfs_mount_add() is the synchronous entry point for adding a new devfs
598 * mount. It sends a synchronous message with the relevant details to the
602 devfs_mount_add(struct devfs_mnt_data *mnt)
606 msg = devfs_msg_get();
608 msg = devfs_msg_send_sync(DEVFS_MOUNT_ADD, msg);
615 * devfs_mount_del() is the synchronous entry point for removing a devfs mount.
616 * It sends a synchronous message with the relevant details to the devfs core.
619 devfs_mount_del(struct devfs_mnt_data *mnt)
623 msg = devfs_msg_get();
625 msg = devfs_msg_send_sync(DEVFS_MOUNT_DEL, msg);
632 * devfs_destroy_related() is the synchronous entry point for device
633 * destruction by subname. It just sends a message with the relevant details to
637 devfs_destroy_related(cdev_t dev)
641 msg = devfs_msg_get();
643 msg = devfs_msg_send_sync(DEVFS_DESTROY_RELATED, msg);
649 devfs_clr_related_flag(cdev_t dev, uint32_t flag)
653 msg = devfs_msg_get();
654 msg->mdv_flags.dev = dev;
655 msg->mdv_flags.flag = flag;
656 msg = devfs_msg_send_sync(DEVFS_CLR_RELATED_FLAG, msg);
663 devfs_destroy_related_without_flag(cdev_t dev, uint32_t flag)
667 msg = devfs_msg_get();
668 msg->mdv_flags.dev = dev;
669 msg->mdv_flags.flag = flag;
670 msg = devfs_msg_send_sync(DEVFS_DESTROY_RELATED_WO_FLAG, msg);
677 * devfs_create_all_dev is the asynchronous entry point to trigger device
678 * node creation. It just sends a message with the relevant details to
682 devfs_create_all_dev(struct devfs_node *root)
684 devfs_msg_send_generic(DEVFS_CREATE_ALL_DEV, root);
689 * devfs_destroy_dev_by_ops is the asynchronous entry point to destroy all
690 * devices with a specific set of dev_ops and minor. It just sends a
691 * message with the relevant details to the devfs core.
694 devfs_destroy_dev_by_ops(struct dev_ops *ops, int minor)
696 devfs_msg_send_ops(DEVFS_DESTROY_DEV_BY_OPS, ops, minor);
701 * devfs_clone_handler_add is the synchronous entry point to add a new
702 * clone handler. It just sends a message with the relevant details to
706 devfs_clone_handler_add(const char *name, d_clone_t *nhandler)
710 msg = devfs_msg_get();
711 msg->mdv_chandler.name = name;
712 msg->mdv_chandler.nhandler = nhandler;
713 msg = devfs_msg_send_sync(DEVFS_CHANDLER_ADD, msg);
719 * devfs_clone_handler_del is the synchronous entry point to remove a
720 * clone handler. It just sends a message with the relevant details to
724 devfs_clone_handler_del(const char *name)
728 msg = devfs_msg_get();
729 msg->mdv_chandler.name = name;
730 msg->mdv_chandler.nhandler = NULL;
731 msg = devfs_msg_send_sync(DEVFS_CHANDLER_DEL, msg);
737 * devfs_find_device_by_name is the synchronous entry point to find a
738 * device given its name. It sends a synchronous message with the
739 * relevant details to the devfs core and returns the answer.
742 devfs_find_device_by_name(const char *fmt, ...)
753 kvasnrprintf(&target, PATH_MAX, 10, fmt, ap);
756 msg = devfs_msg_get();
757 msg->mdv_name = target;
758 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_NAME, msg);
759 found = msg->mdv_cdev;
767 * devfs_find_device_by_udev is the synchronous entry point to find a
768 * device given its udev number. It sends a synchronous message with
769 * the relevant details to the devfs core and returns the answer.
772 devfs_find_device_by_udev(udev_t udev)
777 msg = devfs_msg_get();
778 msg->mdv_udev = udev;
779 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_UDEV, msg);
780 found = msg->mdv_cdev;
783 devfs_debug(DEVFS_DEBUG_DEBUG,
784 "devfs_find_device_by_udev found? %s -end:3-\n",
785 ((found) ? found->si_name:"NO"));
790 devfs_inode_to_vnode(struct mount *mp, ino_t target)
792 struct vnode *vp = NULL;
798 msg = devfs_msg_get();
799 msg->mdv_ino.mp = mp;
800 msg->mdv_ino.ino = target;
801 msg = devfs_msg_send_sync(DEVFS_INODE_TO_VNODE, msg);
802 vp = msg->mdv_ino.vp;
803 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
810 * devfs_make_alias is the asynchronous entry point to register an alias
811 * for a device. It just sends a message with the relevant details to the
815 devfs_make_alias(const char *name, cdev_t dev_target)
817 struct devfs_alias *alias;
822 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
823 alias->name = kstrdup(name, M_DEVFS);
825 alias->dev_target = dev_target;
827 devfs_msg_send_generic(DEVFS_MAKE_ALIAS, alias);
832 * devfs_destroy_alias is the asynchronous entry point to deregister an alias
833 * for a device. It just sends a message with the relevant details to the
837 devfs_destroy_alias(const char *name, cdev_t dev_target)
839 struct devfs_alias *alias;
844 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
845 alias->name = kstrdup(name, M_DEVFS);
847 alias->dev_target = dev_target;
849 devfs_msg_send_generic(DEVFS_DESTROY_ALIAS, alias);
854 * devfs_apply_rules is the asynchronous entry point to trigger application
855 * of all rules. It just sends a message with the relevant details to the
859 devfs_apply_rules(char *mntto)
863 new_name = kstrdup(mntto, M_DEVFS);
864 devfs_msg_send_name(DEVFS_APPLY_RULES, new_name);
870 * devfs_reset_rules is the asynchronous entry point to trigger reset of all
871 * rules. It just sends a message with the relevant details to the devfs core.
874 devfs_reset_rules(char *mntto)
878 new_name = kstrdup(mntto, M_DEVFS);
879 devfs_msg_send_name(DEVFS_RESET_RULES, new_name);
886 * devfs_scan_callback is the asynchronous entry point to call a callback
888 * It just sends a message with the relevant details to the devfs core.
891 devfs_scan_callback(devfs_scan_t *callback, void *arg)
895 KKASSERT(sizeof(callback) == sizeof(void *));
897 msg = devfs_msg_get();
898 msg->mdv_load = callback;
899 msg->mdv_load2 = arg;
900 msg = devfs_msg_send_sync(DEVFS_SCAN_CALLBACK, msg);
908 * Acts as a message drain. Any message that is replied to here gets destroyed
909 * and the memory freed.
912 devfs_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
914 devfs_msg_put((devfs_msg_t)msg);
918 * devfs_msg_get allocates a new devfs msg and returns it.
923 return objcache_get(devfs_msg_cache, M_WAITOK);
927 * devfs_msg_put deallocates a given devfs msg.
930 devfs_msg_put(devfs_msg_t msg)
932 objcache_put(devfs_msg_cache, msg);
937 * devfs_msg_send is the generic asynchronous message sending facility
938 * for devfs. By default the reply port is the automatic disposal port.
940 * If the current thread is the devfs_msg_port thread we execute the
941 * operation synchronously.
944 devfs_msg_send(uint32_t cmd, devfs_msg_t devfs_msg)
946 lwkt_port_t port = &devfs_msg_port;
948 lwkt_initmsg(&devfs_msg->hdr, &devfs_dispose_port, 0);
950 devfs_msg->hdr.u.ms_result = cmd;
952 if (port->mpu_td == curthread) {
953 devfs_msg_exec(devfs_msg);
954 lwkt_replymsg(&devfs_msg->hdr, 0);
956 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
961 * devfs_msg_send_sync is the generic synchronous message sending
962 * facility for devfs. It initializes a local reply port and waits
963 * for the core's answer. This answer is then returned.
966 devfs_msg_send_sync(uint32_t cmd, devfs_msg_t devfs_msg)
968 struct lwkt_port rep_port;
969 devfs_msg_t msg_incoming;
970 lwkt_port_t port = &devfs_msg_port;
972 lwkt_initport_thread(&rep_port, curthread);
973 lwkt_initmsg(&devfs_msg->hdr, &rep_port, 0);
975 devfs_msg->hdr.u.ms_result = cmd;
977 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
978 msg_incoming = lwkt_waitport(&rep_port, 0);
984 * sends a message with a generic argument.
987 devfs_msg_send_generic(uint32_t cmd, void *load)
989 devfs_msg_t devfs_msg = devfs_msg_get();
991 devfs_msg->mdv_load = load;
992 devfs_msg_send(cmd, devfs_msg);
996 * sends a message with a name argument.
999 devfs_msg_send_name(uint32_t cmd, char *name)
1001 devfs_msg_t devfs_msg = devfs_msg_get();
1003 devfs_msg->mdv_name = name;
1004 devfs_msg_send(cmd, devfs_msg);
1008 * sends a message with a mount argument.
1011 devfs_msg_send_mount(uint32_t cmd, struct devfs_mnt_data *mnt)
1013 devfs_msg_t devfs_msg = devfs_msg_get();
1015 devfs_msg->mdv_mnt = mnt;
1016 devfs_msg_send(cmd, devfs_msg);
1020 * sends a message with an ops argument.
1023 devfs_msg_send_ops(uint32_t cmd, struct dev_ops *ops, int minor)
1025 devfs_msg_t devfs_msg = devfs_msg_get();
1027 devfs_msg->mdv_ops.ops = ops;
1028 devfs_msg->mdv_ops.minor = minor;
1029 devfs_msg_send(cmd, devfs_msg);
1033 * sends a message with a clone handler argument.
1036 devfs_msg_send_chandler(uint32_t cmd, char *name, d_clone_t handler)
1038 devfs_msg_t devfs_msg = devfs_msg_get();
1040 devfs_msg->mdv_chandler.name = name;
1041 devfs_msg->mdv_chandler.nhandler = handler;
1042 devfs_msg_send(cmd, devfs_msg);
1046 * sends a message with a device argument.
1049 devfs_msg_send_dev(uint32_t cmd, cdev_t dev, uid_t uid, gid_t gid, int perms)
1051 devfs_msg_t devfs_msg = devfs_msg_get();
1053 devfs_msg->mdv_dev.dev = dev;
1054 devfs_msg->mdv_dev.uid = uid;
1055 devfs_msg->mdv_dev.gid = gid;
1056 devfs_msg->mdv_dev.perms = perms;
1058 devfs_msg_send(cmd, devfs_msg);
1062 * sends a message with a link argument.
1065 devfs_msg_send_link(uint32_t cmd, char *name, char *target, struct mount *mp)
1067 devfs_msg_t devfs_msg = devfs_msg_get();
1069 devfs_msg->mdv_link.name = name;
1070 devfs_msg->mdv_link.target = target;
1071 devfs_msg->mdv_link.mp = mp;
1072 devfs_msg_send(cmd, devfs_msg);
1076 * devfs_msg_core is the main devfs thread. It handles all incoming messages
1077 * and calls the relevant worker functions. By using messages it's assured
1078 * that events occur in the correct order.
1081 devfs_msg_core(void *arg)
1085 lwkt_initport_thread(&devfs_msg_port, curthread);
1087 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1090 lockmgr(&devfs_lock, LK_RELEASE);
1092 get_mplock(); /* mpsafe yet? */
1095 msg = (devfs_msg_t)lwkt_waitport(&devfs_msg_port, 0);
1096 devfs_debug(DEVFS_DEBUG_DEBUG,
1097 "devfs_msg_core, new msg: %x\n",
1098 (unsigned int)msg->hdr.u.ms_result);
1099 devfs_msg_exec(msg);
1100 lwkt_replymsg(&msg->hdr, 0);
1110 devfs_msg_exec(devfs_msg_t msg)
1112 struct devfs_mnt_data *mnt;
1113 struct devfs_node *node;
1117 * Acquire the devfs lock to ensure safety of all called functions
1119 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1121 switch (msg->hdr.u.ms_result) {
1122 case DEVFS_DEVICE_CREATE:
1123 dev = msg->mdv_dev.dev;
1124 devfs_create_dev_worker(dev,
1127 msg->mdv_dev.perms);
1129 case DEVFS_DEVICE_DESTROY:
1130 dev = msg->mdv_dev.dev;
1131 devfs_destroy_dev_worker(dev);
1133 case DEVFS_DESTROY_RELATED:
1134 devfs_destroy_related_worker(msg->mdv_load);
1136 case DEVFS_DESTROY_DEV_BY_OPS:
1137 devfs_destroy_dev_by_ops_worker(msg->mdv_ops.ops,
1138 msg->mdv_ops.minor);
1140 case DEVFS_CREATE_ALL_DEV:
1141 node = (struct devfs_node *)msg->mdv_load;
1142 devfs_create_all_dev_worker(node);
1144 case DEVFS_MOUNT_ADD:
1146 TAILQ_INSERT_TAIL(&devfs_mnt_list, mnt, link);
1147 devfs_create_all_dev_worker(mnt->root_node);
1149 case DEVFS_MOUNT_DEL:
1151 TAILQ_REMOVE(&devfs_mnt_list, mnt, link);
1152 devfs_iterate_topology(mnt->root_node, devfs_reaperp_callback,
1154 if (mnt->leak_count) {
1155 devfs_debug(DEVFS_DEBUG_SHOW,
1156 "Leaked %ld devfs_node elements!\n",
1160 case DEVFS_CHANDLER_ADD:
1161 devfs_chandler_add_worker(msg->mdv_chandler.name,
1162 msg->mdv_chandler.nhandler);
1164 case DEVFS_CHANDLER_DEL:
1165 devfs_chandler_del_worker(msg->mdv_chandler.name);
1167 case DEVFS_FIND_DEVICE_BY_NAME:
1168 devfs_find_device_by_name_worker(msg);
1170 case DEVFS_FIND_DEVICE_BY_UDEV:
1171 devfs_find_device_by_udev_worker(msg);
1173 case DEVFS_MAKE_ALIAS:
1174 devfs_make_alias_worker((struct devfs_alias *)msg->mdv_load);
1176 case DEVFS_DESTROY_ALIAS:
1177 devfs_destroy_alias_worker((struct devfs_alias *)msg->mdv_load);
1179 case DEVFS_APPLY_RULES:
1180 devfs_apply_reset_rules_caller(msg->mdv_name, 1);
1182 case DEVFS_RESET_RULES:
1183 devfs_apply_reset_rules_caller(msg->mdv_name, 0);
1185 case DEVFS_SCAN_CALLBACK:
1186 devfs_scan_callback_worker((devfs_scan_t *)msg->mdv_load,
1189 case DEVFS_CLR_RELATED_FLAG:
1190 devfs_clr_related_flag_worker(msg->mdv_flags.dev,
1191 msg->mdv_flags.flag);
1193 case DEVFS_DESTROY_RELATED_WO_FLAG:
1194 devfs_destroy_related_without_flag_worker(msg->mdv_flags.dev,
1195 msg->mdv_flags.flag);
1197 case DEVFS_INODE_TO_VNODE:
1198 msg->mdv_ino.vp = devfs_iterate_topology(
1199 DEVFS_MNTDATA(msg->mdv_ino.mp)->root_node,
1200 (devfs_iterate_callback_t *)devfs_inode_to_vnode_worker_callback,
1203 case DEVFS_TERMINATE_CORE:
1209 devfs_debug(DEVFS_DEBUG_WARNING,
1210 "devfs_msg_core: unknown message "
1211 "received at core\n");
1214 lockmgr(&devfs_lock, LK_RELEASE);
1218 * Worker function to insert a new dev into the dev list and initialize its
1219 * permissions. It also calls devfs_propagate_dev which in turn propagates
1220 * the change to all mount points.
1222 * The passed dev is already referenced. This reference is eaten by this
1223 * function and represents the dev's linkage into devfs_dev_list.
1226 devfs_create_dev_worker(cdev_t dev, uid_t uid, gid_t gid, int perms)
1232 dev->si_perms = perms;
1234 devfs_link_dev(dev);
1235 devfs_propagate_dev(dev, 1);
1237 udev_event_attach(dev, NULL, 0);
1243 * Worker function to delete a dev from the dev list and free the cdev.
1244 * It also calls devfs_propagate_dev which in turn propagates the change
1245 * to all mount points.
1248 devfs_destroy_dev_worker(cdev_t dev)
1253 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1255 error = devfs_unlink_dev(dev);
1256 devfs_propagate_dev(dev, 0);
1258 udev_event_detach(dev, NULL, 0);
1261 release_dev(dev); /* link ref */
1269 * Worker function to destroy all devices with a certain basename.
1270 * Calls devfs_destroy_dev_worker for the actual destruction.
1273 devfs_destroy_related_worker(cdev_t needle)
1278 devfs_debug(DEVFS_DEBUG_DEBUG, "related worker: %s\n",
1280 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1281 if (dev->si_parent == needle) {
1282 devfs_destroy_related_worker(dev);
1283 devfs_destroy_dev_worker(dev);
1291 devfs_clr_related_flag_worker(cdev_t needle, uint32_t flag)
1295 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1296 if (dev->si_parent == needle) {
1297 devfs_clr_related_flag_worker(dev, flag);
1298 dev->si_flags &= ~flag;
1306 devfs_destroy_related_without_flag_worker(cdev_t needle, uint32_t flag)
1311 devfs_debug(DEVFS_DEBUG_DEBUG, "related_wo_flag: %s\n",
1314 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1315 if (dev->si_parent == needle) {
1316 devfs_destroy_related_without_flag_worker(dev, flag);
1317 if (!(dev->si_flags & flag)) {
1318 devfs_destroy_dev_worker(dev);
1319 devfs_debug(DEVFS_DEBUG_DEBUG,
1320 "related_wo_flag: %s restart\n", dev->si_name);
1330 * Worker function that creates all device nodes on top of a devfs
1334 devfs_create_all_dev_worker(struct devfs_node *root)
1340 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1341 devfs_create_device_node(root, dev, NULL, NULL);
1348 * Worker function that destroys all devices that match a specific
1349 * dev_ops and/or minor. If minor is less than 0, it is not matched
1350 * against. It also propagates all changes.
1353 devfs_destroy_dev_by_ops_worker(struct dev_ops *ops, int minor)
1359 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1360 if (dev->si_ops != ops)
1362 if ((minor < 0) || (dev->si_uminor == minor)) {
1363 devfs_destroy_dev_worker(dev);
1371 * Worker function that registers a new clone handler in devfs.
1374 devfs_chandler_add_worker(const char *name, d_clone_t *nhandler)
1376 struct devfs_clone_handler *chandler = NULL;
1377 u_char len = strlen(name);
1382 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
1383 if (chandler->namlen != len)
1386 if (!memcmp(chandler->name, name, len)) {
1387 /* Clonable basename already exists */
1392 chandler = kmalloc(sizeof(*chandler), M_DEVFS, M_WAITOK | M_ZERO);
1393 chandler->name = kstrdup(name, M_DEVFS);
1394 chandler->namlen = len;
1395 chandler->nhandler = nhandler;
1397 TAILQ_INSERT_TAIL(&devfs_chandler_list, chandler, link);
1402 * Worker function that removes a given clone handler from the
1403 * clone handler list.
1406 devfs_chandler_del_worker(const char *name)
1408 struct devfs_clone_handler *chandler, *chandler2;
1409 u_char len = strlen(name);
1414 TAILQ_FOREACH_MUTABLE(chandler, &devfs_chandler_list, link, chandler2) {
1415 if (chandler->namlen != len)
1417 if (memcmp(chandler->name, name, len))
1420 TAILQ_REMOVE(&devfs_chandler_list, chandler, link);
1421 kfree(chandler->name, M_DEVFS);
1422 kfree(chandler, M_DEVFS);
1430 * Worker function that finds a given device name and changes
1431 * the message received accordingly so that when replied to,
1432 * the answer is returned to the caller.
1435 devfs_find_device_by_name_worker(devfs_msg_t devfs_msg)
1437 struct devfs_alias *alias;
1439 cdev_t found = NULL;
1441 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1442 if (strcmp(devfs_msg->mdv_name, dev->si_name) == 0) {
1447 if (found == NULL) {
1448 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1449 if (strcmp(devfs_msg->mdv_name, alias->name) == 0) {
1450 found = alias->dev_target;
1455 devfs_msg->mdv_cdev = found;
1461 * Worker function that finds a given device udev and changes
1462 * the message received accordingly so that when replied to,
1463 * the answer is returned to the caller.
1466 devfs_find_device_by_udev_worker(devfs_msg_t devfs_msg)
1469 cdev_t found = NULL;
1471 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1472 if (((udev_t)dev->si_inode) == devfs_msg->mdv_udev) {
1477 devfs_msg->mdv_cdev = found;
1483 * Worker function that inserts a given alias into the
1484 * alias list, and propagates the alias to all mount
1488 devfs_make_alias_worker(struct devfs_alias *alias)
1490 struct devfs_alias *alias2;
1491 size_t len = strlen(alias->name);
1494 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1495 if (len != alias2->namlen)
1498 if (!memcmp(alias->name, alias2->name, len)) {
1506 * The alias doesn't exist yet, so we add it to the alias list
1508 TAILQ_INSERT_TAIL(&devfs_alias_list, alias, link);
1509 devfs_alias_propagate(alias, 0);
1510 udev_event_attach(alias->dev_target, alias->name, 1);
1512 devfs_debug(DEVFS_DEBUG_WARNING,
1513 "Warning: duplicate devfs_make_alias for %s\n",
1515 kfree(alias->name, M_DEVFS);
1516 kfree(alias, M_DEVFS);
1523 * Worker function that delete a given alias from the
1524 * alias list, and propagates the removal to all mount
1528 devfs_destroy_alias_worker(struct devfs_alias *alias)
1530 struct devfs_alias *alias2;
1533 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1534 if (alias->dev_target != alias2->dev_target)
1537 if (devfs_WildCmp(alias->name, alias2->name) == 0) {
1544 devfs_debug(DEVFS_DEBUG_WARNING,
1545 "Warning: devfs_destroy_alias for inexistant alias: %s\n",
1547 kfree(alias->name, M_DEVFS);
1548 kfree(alias, M_DEVFS);
1551 * The alias exists, so we delete it from the alias list
1553 TAILQ_REMOVE(&devfs_alias_list, alias2, link);
1554 devfs_alias_propagate(alias2, 1);
1555 udev_event_detach(alias2->dev_target, alias2->name, 1);
1556 kfree(alias->name, M_DEVFS);
1557 kfree(alias, M_DEVFS);
1558 kfree(alias2->name, M_DEVFS);
1559 kfree(alias2, M_DEVFS);
1566 * Function that removes and frees all aliases.
1569 devfs_alias_reap(void)
1571 struct devfs_alias *alias, *alias2;
1573 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1574 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1575 kfree(alias->name, M_DEVFS);
1576 kfree(alias, M_DEVFS);
1582 * Function that removes an alias matching a specific cdev and frees
1586 devfs_alias_remove(cdev_t dev)
1588 struct devfs_alias *alias, *alias2;
1590 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1591 if (alias->dev_target == dev) {
1592 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1593 udev_event_detach(alias->dev_target, alias->name, 1);
1594 kfree(alias->name, M_DEVFS);
1595 kfree(alias, M_DEVFS);
1602 * This function propagates an alias addition or removal to
1606 devfs_alias_propagate(struct devfs_alias *alias, int remove)
1608 struct devfs_mnt_data *mnt;
1610 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1612 devfs_destroy_node(mnt->root_node, alias->name);
1614 devfs_alias_apply(mnt->root_node, alias);
1621 * This function is a recursive function iterating through
1622 * all device nodes in the topology and, if applicable,
1623 * creating the relevant alias for a device node.
1626 devfs_alias_apply(struct devfs_node *node, struct devfs_alias *alias)
1628 struct devfs_node *node1, *node2;
1630 KKASSERT(alias != NULL);
1632 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
1633 if (node->nchildren > 2) {
1634 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1635 devfs_alias_apply(node1, alias);
1639 if (node->d_dev == alias->dev_target)
1640 devfs_alias_create(alias->name, node, 0);
1646 * This function checks if any alias possibly is applicable
1647 * to the given node. If so, the alias is created.
1650 devfs_alias_check_create(struct devfs_node *node)
1652 struct devfs_alias *alias;
1654 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1655 if (node->d_dev == alias->dev_target)
1656 devfs_alias_create(alias->name, node, 0);
1662 * This function creates an alias with a given name
1663 * linking to a given devfs node. It also increments
1664 * the link count on the target node.
1667 devfs_alias_create(char *name_orig, struct devfs_node *target, int rule_based)
1669 struct mount *mp = target->mp;
1670 struct devfs_node *parent = DEVFS_MNTDATA(mp)->root_node;
1671 struct devfs_node *linknode;
1672 char *create_path = NULL;
1677 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1679 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1680 devfs_resolve_name_path(name_orig, name_buf, &create_path, &name);
1683 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1686 if (devfs_find_device_node_by_name(parent, name)) {
1687 devfs_debug(DEVFS_DEBUG_WARNING,
1688 "Node already exists: %s "
1689 "(devfs_make_alias_worker)!\n",
1695 linknode = devfs_allocp(Plink, name, parent, mp, NULL);
1696 if (linknode == NULL) {
1701 linknode->link_target = target;
1705 linknode->flags |= DEVFS_RULE_CREATED;
1708 kfree(name_buf, M_TEMP);
1713 * This function is called by the core and handles mount point
1714 * strings. It either calls the relevant worker (devfs_apply_
1715 * reset_rules_worker) on all mountpoints or only a specific
1719 devfs_apply_reset_rules_caller(char *mountto, int apply)
1721 struct devfs_mnt_data *mnt;
1723 if (mountto[0] == '*') {
1724 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1725 devfs_iterate_topology(mnt->root_node,
1726 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1730 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1731 if (!strcmp(mnt->mp->mnt_stat.f_mntonname, mountto)) {
1732 devfs_iterate_topology(mnt->root_node,
1733 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1740 kfree(mountto, M_DEVFS);
1745 * This function calls a given callback function for
1746 * every dev node in the devfs dev list.
1749 devfs_scan_callback_worker(devfs_scan_t *callback, void *arg)
1753 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1761 * This function tries to resolve a given directory, or if not
1762 * found and creation requested, creates the given directory.
1764 static struct devfs_node *
1765 devfs_resolve_or_create_dir(struct devfs_node *parent, char *dir_name,
1766 size_t name_len, int create)
1768 struct devfs_node *node, *found = NULL;
1770 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1771 if (name_len != node->d_dir.d_namlen)
1774 if (!memcmp(dir_name, node->d_dir.d_name, name_len)) {
1780 if ((found == NULL) && (create)) {
1781 found = devfs_allocp(Pdir, dir_name, parent, parent->mp, NULL);
1788 * This function tries to resolve a complete path. If creation is requested,
1789 * if a given part of the path cannot be resolved (because it doesn't exist),
1793 devfs_resolve_or_create_path(struct devfs_node *parent, char *path, int create)
1795 struct devfs_node *node = parent;
1802 buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1804 while (*path && idx < PATH_MAX - 1) {
1809 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1819 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1820 kfree (buf, M_TEMP);
1825 * Takes a full path and strips it into a directory path and a name.
1826 * For a/b/c/foo, it returns foo in namep and a/b/c in pathp. It
1827 * requires a working buffer with enough size to keep the whole
1831 devfs_resolve_name_path(char *fullpath, char *buf, char **pathp, char **namep)
1835 size_t len = strlen(fullpath) + 1;
1838 KKASSERT((fullpath != NULL) && (buf != NULL));
1839 KKASSERT((pathp != NULL) && (namep != NULL));
1841 memcpy(buf, fullpath, len);
1843 for (i = len-1; i>= 0; i--) {
1844 if (buf[i] == '/') {
1864 * This function creates a new devfs node for a given device. It can
1865 * handle a complete path as device name, and accordingly creates
1866 * the path and the final device node.
1868 * The reference count on the passed dev remains unchanged.
1871 devfs_create_device_node(struct devfs_node *root, cdev_t dev,
1872 char *dev_name, char *path_fmt, ...)
1874 struct devfs_node *parent, *node = NULL;
1880 char *create_path = NULL;
1881 char *names = "pqrsPQRS";
1883 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1885 if (path_fmt != NULL) {
1886 __va_start(ap, path_fmt);
1887 kvasnrprintf(&path, PATH_MAX, 10, path_fmt, ap);
1891 parent = devfs_resolve_or_create_path(root, path, 1);
1894 devfs_resolve_name_path(
1895 ((dev_name == NULL) && (dev))?(dev->si_name):(dev_name),
1896 name_buf, &create_path, &name);
1899 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1902 if (devfs_find_device_node_by_name(parent, name)) {
1903 devfs_debug(DEVFS_DEBUG_WARNING, "devfs_create_device_node: "
1904 "DEVICE %s ALREADY EXISTS!!! Ignoring creation request.\n", name);
1908 node = devfs_allocp(Pdev, name, parent, parent->mp, dev);
1909 nanotime(&parent->mtime);
1912 * Ugly unix98 pty magic, to hide pty master (ptm) devices and their
1915 if ((dev) && (strlen(dev->si_name) >= 4) &&
1916 (!memcmp(dev->si_name, "ptm/", 4))) {
1917 node->parent->flags |= DEVFS_HIDDEN;
1918 node->flags |= DEVFS_HIDDEN;
1922 * Ugly pty magic, to tag pty devices as such and hide them if needed.
1924 if ((strlen(name) >= 3) && (!memcmp(name, "pty", 3)))
1925 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1927 if ((strlen(name) >= 3) && (!memcmp(name, "tty", 3))) {
1929 for (i = 0; i < strlen(names); i++) {
1930 if (name[3] == names[i]) {
1936 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1940 kfree(name_buf, M_TEMP);
1946 * This function finds a given device node in the topology with a given
1950 devfs_find_device_node_callback(struct devfs_node *node, cdev_t target)
1952 if ((node->node_type == Pdev) && (node->d_dev == target)) {
1960 * This function finds a device node in the given parent directory by its
1961 * name and returns it.
1964 devfs_find_device_node_by_name(struct devfs_node *parent, char *target)
1966 struct devfs_node *node, *found = NULL;
1967 size_t len = strlen(target);
1969 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1970 if (len != node->d_dir.d_namlen)
1973 if (!memcmp(node->d_dir.d_name, target, len)) {
1983 devfs_inode_to_vnode_worker_callback(struct devfs_node *node, ino_t *inop)
1985 struct vnode *vp = NULL;
1986 ino_t target = *inop;
1988 if (node->d_dir.d_ino == target) {
1991 vget(vp, LK_EXCLUSIVE | LK_RETRY);
1994 devfs_allocv(&vp, node);
2003 * This function takes a cdev and removes its devfs node in the
2004 * given topology. The cdev remains intact.
2007 devfs_destroy_device_node(struct devfs_node *root, cdev_t target)
2009 KKASSERT(target != NULL);
2010 return devfs_destroy_node(root, target->si_name);
2014 * This function takes a path to a devfs node, resolves it and
2015 * removes the devfs node from the given topology.
2018 devfs_destroy_node(struct devfs_node *root, char *target)
2020 struct devfs_node *node, *parent;
2023 char *create_path = NULL;
2027 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
2028 ksnprintf(name_buf, PATH_MAX, "%s", target);
2030 devfs_resolve_name_path(target, name_buf, &create_path, &name);
2033 parent = devfs_resolve_or_create_path(root, create_path, 0);
2037 if (parent == NULL) {
2038 kfree(name_buf, M_TEMP);
2042 node = devfs_find_device_node_by_name(parent, name);
2045 nanotime(&node->parent->mtime);
2049 kfree(name_buf, M_TEMP);
2055 * Just set perms and ownership for given node.
2058 devfs_set_perms(struct devfs_node *node, uid_t uid, gid_t gid,
2059 u_short mode, u_long flags)
2069 * Propagates a device attach/detach to all mount
2070 * points. Also takes care of automatic alias removal
2071 * for a deleted cdev.
2074 devfs_propagate_dev(cdev_t dev, int attach)
2076 struct devfs_mnt_data *mnt;
2078 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
2080 /* Device is being attached */
2081 devfs_create_device_node(mnt->root_node, dev,
2084 /* Device is being detached */
2085 devfs_alias_remove(dev);
2086 devfs_destroy_device_node(mnt->root_node, dev);
2093 * devfs_clone either returns a basename from a complete name by
2094 * returning the length of the name without trailing digits, or,
2095 * if clone != 0, calls the device's clone handler to get a new
2096 * device, which in turn is returned in devp.
2099 devfs_clone(cdev_t dev, const char *name, size_t len, int mode,
2103 struct devfs_clone_handler *chandler;
2104 struct dev_clone_args ap;
2106 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
2107 if (chandler->namlen != len)
2109 if ((!memcmp(chandler->name, name, len)) && (chandler->nhandler)) {
2110 lockmgr(&devfs_lock, LK_RELEASE);
2112 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2114 ap.a_head.a_dev = dev;
2120 error = (chandler->nhandler)(&ap);
2133 * Registers a new orphan in the orphan list.
2136 devfs_tracer_add_orphan(struct devfs_node *node)
2138 struct devfs_orphan *orphan;
2141 orphan = kmalloc(sizeof(struct devfs_orphan), M_DEVFS, M_WAITOK);
2142 orphan->node = node;
2144 KKASSERT((node->flags & DEVFS_ORPHANED) == 0);
2145 node->flags |= DEVFS_ORPHANED;
2146 TAILQ_INSERT_TAIL(DEVFS_ORPHANLIST(node->mp), orphan, link);
2150 * Removes an orphan from the orphan list.
2153 devfs_tracer_del_orphan(struct devfs_node *node)
2155 struct devfs_orphan *orphan;
2159 TAILQ_FOREACH(orphan, DEVFS_ORPHANLIST(node->mp), link) {
2160 if (orphan->node == node) {
2161 node->flags &= ~DEVFS_ORPHANED;
2162 TAILQ_REMOVE(DEVFS_ORPHANLIST(node->mp), orphan, link);
2163 kfree(orphan, M_DEVFS);
2170 * Counts the orphans in the orphan list, and if cleanup
2171 * is specified, also frees the orphan and removes it from
2175 devfs_tracer_orphan_count(struct mount *mp, int cleanup)
2177 struct devfs_orphan *orphan, *orphan2;
2180 TAILQ_FOREACH_MUTABLE(orphan, DEVFS_ORPHANLIST(mp), link, orphan2) {
2183 * If we are instructed to clean up, we do so.
2186 TAILQ_REMOVE(DEVFS_ORPHANLIST(mp), orphan, link);
2187 orphan->node->flags &= ~DEVFS_ORPHANED;
2188 devfs_freep(orphan->node);
2189 kfree(orphan, M_DEVFS);
2197 * Fetch an ino_t from the global d_ino by increasing it
2201 devfs_fetch_ino(void)
2205 spin_lock(&ino_lock);
2207 spin_unlock(&ino_lock);
2213 * Allocates a new cdev and initializes it's most basic
2217 devfs_new_cdev(struct dev_ops *ops, int minor, struct dev_ops *bops)
2219 cdev_t dev = sysref_alloc(&cdev_sysref_class);
2221 sysref_activate(&dev->si_sysref);
2223 bzero(dev, offsetof(struct cdev, si_sysref));
2228 dev->si_drv1 = NULL;
2229 dev->si_drv2 = NULL;
2230 dev->si_lastread = 0; /* time_second */
2231 dev->si_lastwrite = 0; /* time_second */
2233 dev->si_dict = NULL;
2234 dev->si_parent = NULL;
2238 dev->si_uminor = minor;
2239 dev->si_bops = bops;
2242 * Since the disk subsystem is in the way, we need to
2243 * propagate the D_CANFREE from bops (and ops) to
2246 if (bops && (bops->head.flags & D_CANFREE)) {
2247 dev->si_flags |= SI_CANFREE;
2248 } else if (ops->head.flags & D_CANFREE) {
2249 dev->si_flags |= SI_CANFREE;
2252 /* If there is a backing device, we reference its ops */
2253 dev->si_inode = makeudev(
2254 devfs_reference_ops((bops)?(bops):(ops)),
2261 devfs_cdev_terminate(cdev_t dev)
2265 /* Check if it is locked already. if not, we acquire the devfs lock */
2266 if (!(lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE) {
2267 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2272 * Make sure the node isn't linked anymore. Otherwise we've screwed
2273 * up somewhere, since normal devs are unlinked on the call to
2274 * destroy_dev and only-cdevs that have not been used for cloning
2275 * are not linked in the first place. only-cdevs used for cloning
2276 * will be linked in, too, and should only be destroyed via
2277 * destroy_dev, not destroy_only_dev, so we catch that problem, too.
2279 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2281 /* If we acquired the lock, we also get rid of it */
2283 lockmgr(&devfs_lock, LK_RELEASE);
2285 /* If there is a backing device, we release the backing device's ops */
2286 devfs_release_ops((dev->si_bops)?(dev->si_bops):(dev->si_ops));
2288 /* Finally destroy the device */
2289 sysref_put(&dev->si_sysref);
2293 * Dummies for now (individual locks for MPSAFE)
2296 devfs_cdev_lock(cdev_t dev)
2301 devfs_cdev_unlock(cdev_t dev)
2306 devfs_detached_filter_eof(struct knote *kn, long hint)
2308 kn->kn_flags |= (EV_EOF | EV_NODATA);
2313 devfs_detached_filter_detach(struct knote *kn)
2315 cdev_t dev = (cdev_t)kn->kn_hook;
2317 knote_remove(&dev->si_kqinfo.ki_note, kn);
2320 static struct filterops devfs_detached_filterops =
2321 { FILTEROP_ISFD, NULL,
2322 devfs_detached_filter_detach,
2323 devfs_detached_filter_eof };
2326 * Delegates knote filter handling responsibility to devfs
2328 * Any device that implements kqfilter event handling and could be detached
2329 * or shut down out from under the kevent subsystem must allow devfs to
2330 * assume responsibility for any knotes it may hold.
2333 devfs_assume_knotes(cdev_t dev, struct kqinfo *kqi)
2336 * Let kern/kern_event.c do the heavy lifting.
2338 knote_assume_knotes(kqi, &dev->si_kqinfo,
2339 &devfs_detached_filterops, (void *)dev);
2342 * These should probably be activated individually, but doing so
2343 * would require refactoring kq's public in-kernel interface.
2345 KNOTE(&dev->si_kqinfo.ki_note, 0);
2349 * Links a given cdev into the dev list.
2352 devfs_link_dev(cdev_t dev)
2354 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2355 dev->si_flags |= SI_DEVFS_LINKED;
2356 TAILQ_INSERT_TAIL(&devfs_dev_list, dev, link);
2362 * Removes a given cdev from the dev list. The caller is responsible for
2363 * releasing the reference on the device associated with the linkage.
2365 * Returns EALREADY if the dev has already been unlinked.
2368 devfs_unlink_dev(cdev_t dev)
2370 if ((dev->si_flags & SI_DEVFS_LINKED)) {
2371 TAILQ_REMOVE(&devfs_dev_list, dev, link);
2372 dev->si_flags &= ~SI_DEVFS_LINKED;
2379 devfs_node_is_accessible(struct devfs_node *node)
2381 if ((node) && (!(node->flags & DEVFS_HIDDEN)))
2388 devfs_reference_ops(struct dev_ops *ops)
2391 struct devfs_dev_ops *found = NULL;
2392 struct devfs_dev_ops *devops;
2394 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2395 if (devops->ops == ops) {
2402 found = kmalloc(sizeof(struct devfs_dev_ops), M_DEVFS, M_WAITOK);
2404 found->ref_count = 0;
2405 TAILQ_INSERT_TAIL(&devfs_dev_ops_list, found, link);
2410 if (found->ref_count == 0) {
2411 found->id = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(ops_id), 255);
2412 if (found->id == -1) {
2413 /* Ran out of unique ids */
2414 devfs_debug(DEVFS_DEBUG_WARNING,
2415 "devfs_reference_ops: WARNING: ran out of unique ids\n");
2425 devfs_release_ops(struct dev_ops *ops)
2427 struct devfs_dev_ops *found = NULL;
2428 struct devfs_dev_ops *devops;
2430 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2431 if (devops->ops == ops) {
2441 if (found->ref_count == 0) {
2442 TAILQ_REMOVE(&devfs_dev_ops_list, found, link);
2443 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(ops_id), found->id);
2444 kfree(found, M_DEVFS);
2449 * Wait for asynchronous messages to complete in the devfs helper
2450 * thread, then return. Do nothing if the helper thread is dead
2451 * or we are being indirectly called from the helper thread itself.
2458 if (devfs_run && curthread != td_core) {
2459 msg = devfs_msg_get();
2460 msg = devfs_msg_send_sync(DEVFS_SYNC, msg);
2466 * Called on init of devfs; creates the objcaches and
2467 * spawns off the devfs core thread. Also initializes
2473 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init() called\n");
2474 /* Create objcaches for nodes, msgs and devs */
2475 devfs_node_cache = objcache_create("devfs-node-cache", 0, 0,
2477 objcache_malloc_alloc,
2478 objcache_malloc_free,
2479 &devfs_node_malloc_args );
2481 devfs_msg_cache = objcache_create("devfs-msg-cache", 0, 0,
2483 objcache_malloc_alloc,
2484 objcache_malloc_free,
2485 &devfs_msg_malloc_args );
2487 devfs_dev_cache = objcache_create("devfs-dev-cache", 0, 0,
2489 objcache_malloc_alloc,
2490 objcache_malloc_free,
2491 &devfs_dev_malloc_args );
2493 devfs_clone_bitmap_init(&DEVFS_CLONE_BITMAP(ops_id));
2495 /* Initialize the reply-only port which acts as a message drain */
2496 lwkt_initport_replyonly(&devfs_dispose_port, devfs_msg_autofree_reply);
2498 /* Initialize *THE* devfs lock */
2499 lockinit(&devfs_lock, "devfs_core lock", 0, 0);
2501 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2502 lwkt_create(devfs_msg_core, /*args*/NULL, &td_core, NULL,
2503 0, -1, "devfs_msg_core");
2504 while (devfs_run == 0)
2505 lksleep(td_core, &devfs_lock, 0, "devfsc", 0);
2506 lockmgr(&devfs_lock, LK_RELEASE);
2508 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init finished\n");
2512 * Called on unload of devfs; takes care of destroying the core
2513 * and the objcaches. Also removes aliases that are no longer needed.
2518 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_uninit() called\n");
2520 devfs_msg_send(DEVFS_TERMINATE_CORE, NULL);
2522 tsleep(td_core, 0, "devfsc", hz*10);
2523 tsleep(td_core, 0, "devfsc", hz);
2525 devfs_clone_bitmap_uninit(&DEVFS_CLONE_BITMAP(ops_id));
2527 /* Destroy the objcaches */
2528 objcache_destroy(devfs_msg_cache);
2529 objcache_destroy(devfs_node_cache);
2530 objcache_destroy(devfs_dev_cache);
2536 * This is a sysctl handler to assist userland devname(3) to
2537 * find the device name for a given udev.
2540 devfs_sysctl_devname_helper(SYSCTL_HANDLER_ARGS)
2547 if ((error = SYSCTL_IN(req, &udev, sizeof(udev_t))))
2550 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs sysctl, received udev: %d\n", udev);
2555 if ((found = devfs_find_device_by_udev(udev)) == NULL)
2558 return(SYSCTL_OUT(req, found->si_name, strlen(found->si_name) + 1));
2562 SYSCTL_PROC(_kern, OID_AUTO, devname, CTLTYPE_OPAQUE|CTLFLAG_RW|CTLFLAG_ANYBODY,
2563 NULL, 0, devfs_sysctl_devname_helper, "", "helper for devname(3)");
2565 SYSCTL_NODE(_vfs, OID_AUTO, devfs, CTLFLAG_RW, 0, "devfs");
2566 TUNABLE_INT("vfs.devfs.debug", &devfs_debug_enable);
2567 SYSCTL_INT(_vfs_devfs, OID_AUTO, debug, CTLFLAG_RW, &devfs_debug_enable,
2568 0, "Enable DevFS debugging");
2570 SYSINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
2572 SYSUNINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY,
2573 devfs_uninit, NULL);
2576 * WildCmp() - compare wild string to sane string
2578 * Returns 0 on success, -1 on failure.
2581 wildCmp(const char **mary, int d, const char *w, const char *s)
2586 * skip fixed portion
2592 * optimize terminator
2596 if (w[1] != '?' && w[1] != '*') {
2598 * optimize * followed by non-wild
2600 for (i = 0; s + i < mary[d]; ++i) {
2601 if (s[i] == w[1] && wildCmp(mary, d + 1, w + 1, s + i) == 0)
2608 for (i = 0; s + i < mary[d]; ++i) {
2609 if (wildCmp(mary, d + 1, w + 1, s + i) == 0)
2624 if (*w == 0) /* terminator */
2637 * WildCaseCmp() - compare wild string to sane string, case insensitive
2639 * Returns 0 on success, -1 on failure.
2642 wildCaseCmp(const char **mary, int d, const char *w, const char *s)
2647 * skip fixed portion
2653 * optimize terminator
2657 if (w[1] != '?' && w[1] != '*') {
2659 * optimize * followed by non-wild
2661 for (i = 0; s + i < mary[d]; ++i) {
2662 if (s[i] == w[1] && wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
2669 for (i = 0; s + i < mary[d]; ++i) {
2670 if (wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
2684 #define tolower(x) ((x >= 'A' && x <= 'Z')?(x+('a'-'A')):(x))
2685 if (tolower(*w) != tolower(*s))
2688 if (*w == 0) /* terminator */
2700 devfs_WildCmp(const char *w, const char *s)
2704 int slen = strlen(s);
2707 for (i = c = 0; w[i]; ++i) {
2711 mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
2712 for (i = 0; i < c; ++i)
2714 i = wildCmp(mary, 0, w, s);
2715 kfree(mary, M_DEVFS);
2720 devfs_WildCaseCmp(const char *w, const char *s)
2724 int slen = strlen(s);
2727 for (i = c = 0; w[i]; ++i) {
2731 mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
2732 for (i = 0; i < c; ++i)
2734 i = wildCaseCmp(mary, 0, w, s);
2735 kfree(mary, M_DEVFS);