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/devfs.h>
45 #include <sys/devfs_rules.h>
48 #include <sys/msgport2.h>
49 #include <sys/spinlock2.h>
50 #include <sys/mplock2.h>
51 #include <sys/sysref2.h>
53 MALLOC_DEFINE(M_DEVFS, "devfs", "Device File System (devfs) allocations");
54 DEVFS_DECLARE_CLONE_BITMAP(ops_id);
56 * SYSREF Integration - reference counting, allocation,
57 * sysid and syslink integration.
59 static void devfs_cdev_terminate(cdev_t dev);
60 static void devfs_cdev_lock(cdev_t dev);
61 static void devfs_cdev_unlock(cdev_t dev);
62 static struct sysref_class cdev_sysref_class = {
65 .proto = SYSREF_PROTO_DEV,
66 .offset = offsetof(struct cdev, si_sysref),
67 .objsize = sizeof(struct cdev),
71 .terminate = (sysref_terminate_func_t)devfs_cdev_terminate,
72 .lock = (sysref_lock_func_t)devfs_cdev_lock,
73 .unlock = (sysref_unlock_func_t)devfs_cdev_unlock
77 static struct objcache *devfs_node_cache;
78 static struct objcache *devfs_msg_cache;
79 static struct objcache *devfs_dev_cache;
81 static struct objcache_malloc_args devfs_node_malloc_args = {
82 sizeof(struct devfs_node), M_DEVFS };
83 struct objcache_malloc_args devfs_msg_malloc_args = {
84 sizeof(struct devfs_msg), M_DEVFS };
85 struct objcache_malloc_args devfs_dev_malloc_args = {
86 sizeof(struct cdev), M_DEVFS };
88 static struct devfs_dev_head devfs_dev_list =
89 TAILQ_HEAD_INITIALIZER(devfs_dev_list);
90 static struct devfs_mnt_head devfs_mnt_list =
91 TAILQ_HEAD_INITIALIZER(devfs_mnt_list);
92 static struct devfs_chandler_head devfs_chandler_list =
93 TAILQ_HEAD_INITIALIZER(devfs_chandler_list);
94 static struct devfs_alias_head devfs_alias_list =
95 TAILQ_HEAD_INITIALIZER(devfs_alias_list);
96 static struct devfs_dev_ops_head devfs_dev_ops_list =
97 TAILQ_HEAD_INITIALIZER(devfs_dev_ops_list);
99 struct lock devfs_lock;
100 static struct lwkt_port devfs_dispose_port;
101 static struct lwkt_port devfs_msg_port;
102 static struct thread *td_core;
104 static struct spinlock ino_lock;
106 static int devfs_debug_enable;
107 static int devfs_run;
109 static ino_t devfs_fetch_ino(void);
110 static int devfs_create_all_dev_worker(struct devfs_node *);
111 static int devfs_create_dev_worker(cdev_t, uid_t, gid_t, int);
112 static int devfs_destroy_dev_worker(cdev_t);
113 static int devfs_destroy_related_worker(cdev_t);
114 static int devfs_destroy_dev_by_ops_worker(struct dev_ops *, int);
115 static int devfs_propagate_dev(cdev_t, int);
116 static int devfs_unlink_dev(cdev_t dev);
117 static void devfs_msg_exec(devfs_msg_t msg);
119 static int devfs_chandler_add_worker(const char *, d_clone_t *);
120 static int devfs_chandler_del_worker(const char *);
122 static void devfs_msg_autofree_reply(lwkt_port_t, lwkt_msg_t);
123 static void devfs_msg_core(void *);
125 static int devfs_find_device_by_name_worker(devfs_msg_t);
126 static int devfs_find_device_by_udev_worker(devfs_msg_t);
128 static int devfs_apply_reset_rules_caller(char *, int);
130 static int devfs_scan_callback_worker(devfs_scan_t *, void *);
132 static struct devfs_node *devfs_resolve_or_create_dir(struct devfs_node *,
133 char *, size_t, int);
135 static int devfs_make_alias_worker(struct devfs_alias *);
136 static int devfs_destroy_alias_worker(struct devfs_alias *);
137 static int devfs_alias_remove(cdev_t);
138 static int devfs_alias_reap(void);
139 static int devfs_alias_propagate(struct devfs_alias *, int);
140 static int devfs_alias_apply(struct devfs_node *, struct devfs_alias *);
141 static int devfs_alias_check_create(struct devfs_node *);
143 static int devfs_clr_related_flag_worker(cdev_t, uint32_t);
144 static int devfs_destroy_related_without_flag_worker(cdev_t, uint32_t);
146 static void *devfs_reaperp_callback(struct devfs_node *, void *);
147 static void *devfs_gc_dirs_callback(struct devfs_node *, void *);
148 static void *devfs_gc_links_callback(struct devfs_node *, struct devfs_node *);
150 devfs_inode_to_vnode_worker_callback(struct devfs_node *, ino_t *);
153 * devfs_debug() is a SYSCTL and TUNABLE controlled debug output function
157 devfs_debug(int level, char *fmt, ...)
162 if (level <= devfs_debug_enable)
170 * devfs_allocp() Allocates a new devfs node with the specified
171 * parameters. The node is also automatically linked into the topology
172 * if a parent is specified. It also calls the rule and alias stuff to
173 * be applied on the new node
176 devfs_allocp(devfs_nodetype devfsnodetype, char *name,
177 struct devfs_node *parent, struct mount *mp, cdev_t dev)
179 struct devfs_node *node = NULL;
180 size_t namlen = strlen(name);
182 node = objcache_get(devfs_node_cache, M_WAITOK);
183 bzero(node, sizeof(*node));
185 atomic_add_long(&DEVFS_MNTDATA(mp)->leak_count, 1);
190 node->d_dir.d_ino = devfs_fetch_ino();
193 * Cookie jar for children. Leave 0 and 1 for '.' and '..' entries
196 node->cookie_jar = 2;
199 * Access Control members
201 node->mode = DEVFS_DEFAULT_MODE;
202 node->uid = DEVFS_DEFAULT_UID;
203 node->gid = DEVFS_DEFAULT_GID;
205 switch (devfsnodetype) {
208 * Ensure that we don't recycle the root vnode by marking it as
209 * linked into the topology.
211 node->flags |= DEVFS_NODE_LINKED;
213 TAILQ_INIT(DEVFS_DENODE_HEAD(node));
214 node->d_dir.d_type = DT_DIR;
219 node->d_dir.d_type = DT_LNK;
223 node->d_dir.d_type = DT_REG;
228 node->d_dir.d_type = DT_CHR;
231 node->mode = dev->si_perms;
232 node->uid = dev->si_uid;
233 node->gid = dev->si_gid;
235 devfs_alias_check_create(node);
240 panic("devfs_allocp: unknown node type");
244 node->node_type = devfsnodetype;
246 /* Initialize the dirent structure of each devfs vnode */
247 node->d_dir.d_namlen = namlen;
248 node->d_dir.d_name = kmalloc(namlen+1, M_DEVFS, M_WAITOK);
249 memcpy(node->d_dir.d_name, name, namlen);
250 node->d_dir.d_name[namlen] = '\0';
252 /* Initialize the parent node element */
253 node->parent = parent;
255 /* Initialize *time members */
256 nanotime(&node->atime);
257 node->mtime = node->ctime = node->atime;
260 * Associate with parent as last step, clean out namecache
263 if ((parent != NULL) &&
264 ((parent->node_type == Nroot) || (parent->node_type == Ndir))) {
266 node->cookie = parent->cookie_jar++;
267 node->flags |= DEVFS_NODE_LINKED;
268 TAILQ_INSERT_TAIL(DEVFS_DENODE_HEAD(parent), node, link);
270 /* This forces negative namecache lookups to clear */
271 ++mp->mnt_namecache_gen;
275 devfs_rule_check_apply(node, NULL);
277 atomic_add_long(&DEVFS_MNTDATA(mp)->file_count, 1);
283 * devfs_allocv() allocates a new vnode based on a devfs node.
286 devfs_allocv(struct vnode **vpp, struct devfs_node *node)
294 * devfs master lock must not be held across a vget() call, we have
295 * to hold our ad-hoc vp to avoid a free race from destroying the
296 * contents of the structure. The vget() will interlock recycles
300 while ((vp = node->v_node) != NULL) {
302 lockmgr(&devfs_lock, LK_RELEASE);
303 error = vget(vp, LK_EXCLUSIVE);
305 lockmgr(&devfs_lock, LK_EXCLUSIVE);
310 if (error != ENOENT) {
317 * devfs master lock must not be held across a getnewvnode() call.
319 lockmgr(&devfs_lock, LK_RELEASE);
320 if ((error = getnewvnode(VT_DEVFS, node->mp, vpp, 0, 0)) != 0) {
321 lockmgr(&devfs_lock, LK_EXCLUSIVE);
324 lockmgr(&devfs_lock, LK_EXCLUSIVE);
328 if (node->v_node != NULL) {
337 switch (node->node_type) {
339 vsetflags(vp, VROOT);
355 KKASSERT(node->d_dev);
357 vp->v_uminor = node->d_dev->si_uminor;
358 vp->v_umajor = node->d_dev->si_umajor;
360 v_associate_rdev(vp, node->d_dev);
361 vp->v_ops = &node->mp->mnt_vn_spec_ops;
365 panic("devfs_allocv: unknown node type");
373 * devfs_allocvp allocates both a devfs node (with the given settings) and a vnode
374 * based on the newly created devfs node.
377 devfs_allocvp(struct mount *mp, struct vnode **vpp, devfs_nodetype devfsnodetype,
378 char *name, struct devfs_node *parent, cdev_t dev)
380 struct devfs_node *node;
382 node = devfs_allocp(devfsnodetype, name, parent, mp, dev);
385 devfs_allocv(vpp, node);
393 * Destroy the devfs_node. The node must be unlinked from the topology.
395 * This function will also destroy any vnode association with the node
398 * The cdev_t itself remains intact.
400 * The core lock is not necessarily held on call and must be temporarily
401 * released if it is to avoid a deadlock.
404 devfs_freep(struct devfs_node *node)
410 KKASSERT(((node->flags & DEVFS_NODE_LINKED) == 0) ||
411 (node->node_type == Nroot));
414 * Protect against double frees
416 KKASSERT((node->flags & DEVFS_DESTROYED) == 0);
417 node->flags |= DEVFS_DESTROYED;
420 * Avoid deadlocks between devfs_lock and the vnode lock when
421 * disassociating the vnode (stress2 pty vs ls -la /dev/pts).
423 * This also prevents the vnode reclaim code from double-freeing
424 * the node. The vget() is required to safely modified the vp
425 * and cycle the refs to terminate an inactive vp.
427 if (lockstatus(&devfs_lock, curthread) == LK_EXCLUSIVE) {
428 lockmgr(&devfs_lock, LK_RELEASE);
434 while ((vp = node->v_node) != NULL) {
435 if (vget(vp, LK_EXCLUSIVE | LK_RETRY) != 0)
440 cache_inval_vp(vp, CINV_DESTROY);
447 atomic_subtract_long(&DEVFS_MNTDATA(node->mp)->leak_count, 1);
448 if (node->symlink_name) {
449 kfree(node->symlink_name, M_DEVFS);
450 node->symlink_name = NULL;
454 * Remove the node from the orphan list if it is still on it.
456 if (node->flags & DEVFS_ORPHANED)
457 devfs_tracer_del_orphan(node);
459 if (node->d_dir.d_name) {
460 kfree(node->d_dir.d_name, M_DEVFS);
461 node->d_dir.d_name = NULL;
463 atomic_subtract_long(&DEVFS_MNTDATA(node->mp)->file_count, 1);
464 objcache_put(devfs_node_cache, node);
467 lockmgr(&devfs_lock, LK_EXCLUSIVE);
473 * Unlink the devfs node from the topology and add it to the orphan list.
474 * The node will later be destroyed by freep.
476 * Any vnode association, including the v_rdev and v_data, remains intact
480 devfs_unlinkp(struct devfs_node *node)
482 struct devfs_node *parent;
486 * Add the node to the orphan list, so it is referenced somewhere, to
487 * so we don't leak it.
489 devfs_tracer_add_orphan(node);
491 parent = node->parent;
494 * If the parent is known we can unlink the node out of the topology
497 TAILQ_REMOVE(DEVFS_DENODE_HEAD(parent), node, link);
499 node->flags &= ~DEVFS_NODE_LINKED;
507 devfs_iterate_topology(struct devfs_node *node,
508 devfs_iterate_callback_t *callback, void *arg1)
510 struct devfs_node *node1, *node2;
513 if ((node->node_type == Nroot) || (node->node_type == Ndir)) {
514 if (node->nchildren > 2) {
515 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node),
517 if ((ret = devfs_iterate_topology(node1, callback, arg1)))
523 ret = callback(node, arg1);
528 * devfs_reaperp() is a recursive function that iterates through all the
529 * topology, unlinking and freeing all devfs nodes.
532 devfs_reaperp_callback(struct devfs_node *node, void *unused)
541 devfs_gc_dirs_callback(struct devfs_node *node, void *unused)
543 if (node->node_type == Ndir) {
544 if ((node->nchildren == 2) &&
545 !(node->flags & DEVFS_USER_CREATED)) {
555 devfs_gc_links_callback(struct devfs_node *node, struct devfs_node *target)
557 if ((node->node_type == Nlink) && (node->link_target == target)) {
566 * devfs_gc() is devfs garbage collector. It takes care of unlinking and
567 * freeing a node, but also removes empty directories and links that link
568 * via devfs auto-link mechanism to the node being deleted.
571 devfs_gc(struct devfs_node *node)
573 struct devfs_node *root_node = DEVFS_MNTDATA(node->mp)->root_node;
575 if (node->nlinks > 0)
576 devfs_iterate_topology(root_node,
577 (devfs_iterate_callback_t *)devfs_gc_links_callback, node);
580 devfs_iterate_topology(root_node,
581 (devfs_iterate_callback_t *)devfs_gc_dirs_callback, NULL);
589 * devfs_create_dev() is the asynchronous entry point for device creation.
590 * It just sends a message with the relevant details to the devfs core.
592 * This function will reference the passed device. The reference is owned
593 * by devfs and represents all of the device's node associations.
596 devfs_create_dev(cdev_t dev, uid_t uid, gid_t gid, int perms)
599 devfs_msg_send_dev(DEVFS_DEVICE_CREATE, dev, uid, gid, perms);
605 * devfs_destroy_dev() is the asynchronous entry point for device destruction.
606 * It just sends a message with the relevant details to the devfs core.
609 devfs_destroy_dev(cdev_t dev)
611 devfs_msg_send_dev(DEVFS_DEVICE_DESTROY, dev, 0, 0, 0);
616 * devfs_mount_add() is the synchronous entry point for adding a new devfs
617 * mount. It sends a synchronous message with the relevant details to the
621 devfs_mount_add(struct devfs_mnt_data *mnt)
625 msg = devfs_msg_get();
627 msg = devfs_msg_send_sync(DEVFS_MOUNT_ADD, msg);
634 * devfs_mount_del() is the synchronous entry point for removing a devfs mount.
635 * It sends a synchronous message with the relevant details to the devfs core.
638 devfs_mount_del(struct devfs_mnt_data *mnt)
642 msg = devfs_msg_get();
644 msg = devfs_msg_send_sync(DEVFS_MOUNT_DEL, msg);
651 * devfs_destroy_related() is the synchronous entry point for device
652 * destruction by subname. It just sends a message with the relevant details to
656 devfs_destroy_related(cdev_t dev)
660 msg = devfs_msg_get();
662 msg = devfs_msg_send_sync(DEVFS_DESTROY_RELATED, msg);
668 devfs_clr_related_flag(cdev_t dev, uint32_t flag)
672 msg = devfs_msg_get();
673 msg->mdv_flags.dev = dev;
674 msg->mdv_flags.flag = flag;
675 msg = devfs_msg_send_sync(DEVFS_CLR_RELATED_FLAG, msg);
682 devfs_destroy_related_without_flag(cdev_t dev, uint32_t flag)
686 msg = devfs_msg_get();
687 msg->mdv_flags.dev = dev;
688 msg->mdv_flags.flag = flag;
689 msg = devfs_msg_send_sync(DEVFS_DESTROY_RELATED_WO_FLAG, msg);
696 * devfs_create_all_dev is the asynchronous entry point to trigger device
697 * node creation. It just sends a message with the relevant details to
701 devfs_create_all_dev(struct devfs_node *root)
703 devfs_msg_send_generic(DEVFS_CREATE_ALL_DEV, root);
708 * devfs_destroy_dev_by_ops is the asynchronous entry point to destroy all
709 * devices with a specific set of dev_ops and minor. It just sends a
710 * message with the relevant details to the devfs core.
713 devfs_destroy_dev_by_ops(struct dev_ops *ops, int minor)
715 devfs_msg_send_ops(DEVFS_DESTROY_DEV_BY_OPS, ops, minor);
720 * devfs_clone_handler_add is the synchronous entry point to add a new
721 * clone handler. It just sends a message with the relevant details to
725 devfs_clone_handler_add(const char *name, d_clone_t *nhandler)
729 msg = devfs_msg_get();
730 msg->mdv_chandler.name = name;
731 msg->mdv_chandler.nhandler = nhandler;
732 msg = devfs_msg_send_sync(DEVFS_CHANDLER_ADD, msg);
738 * devfs_clone_handler_del is the synchronous entry point to remove a
739 * clone handler. It just sends a message with the relevant details to
743 devfs_clone_handler_del(const char *name)
747 msg = devfs_msg_get();
748 msg->mdv_chandler.name = name;
749 msg->mdv_chandler.nhandler = NULL;
750 msg = devfs_msg_send_sync(DEVFS_CHANDLER_DEL, msg);
756 * devfs_find_device_by_name is the synchronous entry point to find a
757 * device given its name. It sends a synchronous message with the
758 * relevant details to the devfs core and returns the answer.
761 devfs_find_device_by_name(const char *fmt, ...)
772 kvasnrprintf(&target, PATH_MAX, 10, fmt, ap);
775 msg = devfs_msg_get();
776 msg->mdv_name = target;
777 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_NAME, msg);
778 found = msg->mdv_cdev;
786 * devfs_find_device_by_udev is the synchronous entry point to find a
787 * device given its udev number. It sends a synchronous message with
788 * the relevant details to the devfs core and returns the answer.
791 devfs_find_device_by_udev(udev_t udev)
796 msg = devfs_msg_get();
797 msg->mdv_udev = udev;
798 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_UDEV, msg);
799 found = msg->mdv_cdev;
802 devfs_debug(DEVFS_DEBUG_DEBUG,
803 "devfs_find_device_by_udev found? %s -end:3-\n",
804 ((found) ? found->si_name:"NO"));
809 devfs_inode_to_vnode(struct mount *mp, ino_t target)
811 struct vnode *vp = NULL;
817 msg = devfs_msg_get();
818 msg->mdv_ino.mp = mp;
819 msg->mdv_ino.ino = target;
820 msg = devfs_msg_send_sync(DEVFS_INODE_TO_VNODE, msg);
821 vp = msg->mdv_ino.vp;
822 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
829 * devfs_make_alias is the asynchronous entry point to register an alias
830 * for a device. It just sends a message with the relevant details to the
834 devfs_make_alias(const char *name, cdev_t dev_target)
836 struct devfs_alias *alias;
841 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
842 alias->name = kstrdup(name, M_DEVFS);
844 alias->dev_target = dev_target;
846 devfs_msg_send_generic(DEVFS_MAKE_ALIAS, alias);
851 * devfs_destroy_alias is the asynchronous entry point to deregister an alias
852 * for a device. It just sends a message with the relevant details to the
856 devfs_destroy_alias(const char *name, cdev_t dev_target)
858 struct devfs_alias *alias;
863 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
864 alias->name = kstrdup(name, M_DEVFS);
866 alias->dev_target = dev_target;
868 devfs_msg_send_generic(DEVFS_DESTROY_ALIAS, alias);
873 * devfs_apply_rules is the asynchronous entry point to trigger application
874 * of all rules. It just sends a message with the relevant details to the
878 devfs_apply_rules(char *mntto)
882 new_name = kstrdup(mntto, M_DEVFS);
883 devfs_msg_send_name(DEVFS_APPLY_RULES, new_name);
889 * devfs_reset_rules is the asynchronous entry point to trigger reset of all
890 * rules. It just sends a message with the relevant details to the devfs core.
893 devfs_reset_rules(char *mntto)
897 new_name = kstrdup(mntto, M_DEVFS);
898 devfs_msg_send_name(DEVFS_RESET_RULES, new_name);
905 * devfs_scan_callback is the asynchronous entry point to call a callback
907 * It just sends a message with the relevant details to the devfs core.
910 devfs_scan_callback(devfs_scan_t *callback, void *arg)
916 msg = devfs_msg_get();
917 msg->mdv_load = callback;
918 msg->mdv_load2 = arg;
919 msg = devfs_msg_send_sync(DEVFS_SCAN_CALLBACK, msg);
927 * Acts as a message drain. Any message that is replied to here gets destroyed
928 * and the memory freed.
931 devfs_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
933 devfs_msg_put((devfs_msg_t)msg);
937 * devfs_msg_get allocates a new devfs msg and returns it.
942 return objcache_get(devfs_msg_cache, M_WAITOK);
946 * devfs_msg_put deallocates a given devfs msg.
949 devfs_msg_put(devfs_msg_t msg)
951 objcache_put(devfs_msg_cache, msg);
956 * devfs_msg_send is the generic asynchronous message sending facility
957 * for devfs. By default the reply port is the automatic disposal port.
959 * If the current thread is the devfs_msg_port thread we execute the
960 * operation synchronously.
963 devfs_msg_send(uint32_t cmd, devfs_msg_t devfs_msg)
965 lwkt_port_t port = &devfs_msg_port;
967 lwkt_initmsg(&devfs_msg->hdr, &devfs_dispose_port, 0);
969 devfs_msg->hdr.u.ms_result = cmd;
971 if (port->mpu_td == curthread) {
972 devfs_msg_exec(devfs_msg);
973 lwkt_replymsg(&devfs_msg->hdr, 0);
975 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
980 * devfs_msg_send_sync is the generic synchronous message sending
981 * facility for devfs. It initializes a local reply port and waits
982 * for the core's answer. This answer is then returned.
985 devfs_msg_send_sync(uint32_t cmd, devfs_msg_t devfs_msg)
987 struct lwkt_port rep_port;
988 devfs_msg_t msg_incoming;
989 lwkt_port_t port = &devfs_msg_port;
991 lwkt_initport_thread(&rep_port, curthread);
992 lwkt_initmsg(&devfs_msg->hdr, &rep_port, 0);
994 devfs_msg->hdr.u.ms_result = cmd;
996 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
997 msg_incoming = lwkt_waitport(&rep_port, 0);
1003 * sends a message with a generic argument.
1006 devfs_msg_send_generic(uint32_t cmd, void *load)
1008 devfs_msg_t devfs_msg = devfs_msg_get();
1010 devfs_msg->mdv_load = load;
1011 devfs_msg_send(cmd, devfs_msg);
1015 * sends a message with a name argument.
1018 devfs_msg_send_name(uint32_t cmd, char *name)
1020 devfs_msg_t devfs_msg = devfs_msg_get();
1022 devfs_msg->mdv_name = name;
1023 devfs_msg_send(cmd, devfs_msg);
1027 * sends a message with a mount argument.
1030 devfs_msg_send_mount(uint32_t cmd, struct devfs_mnt_data *mnt)
1032 devfs_msg_t devfs_msg = devfs_msg_get();
1034 devfs_msg->mdv_mnt = mnt;
1035 devfs_msg_send(cmd, devfs_msg);
1039 * sends a message with an ops argument.
1042 devfs_msg_send_ops(uint32_t cmd, struct dev_ops *ops, int minor)
1044 devfs_msg_t devfs_msg = devfs_msg_get();
1046 devfs_msg->mdv_ops.ops = ops;
1047 devfs_msg->mdv_ops.minor = minor;
1048 devfs_msg_send(cmd, devfs_msg);
1052 * sends a message with a clone handler argument.
1055 devfs_msg_send_chandler(uint32_t cmd, char *name, d_clone_t handler)
1057 devfs_msg_t devfs_msg = devfs_msg_get();
1059 devfs_msg->mdv_chandler.name = name;
1060 devfs_msg->mdv_chandler.nhandler = handler;
1061 devfs_msg_send(cmd, devfs_msg);
1065 * sends a message with a device argument.
1068 devfs_msg_send_dev(uint32_t cmd, cdev_t dev, uid_t uid, gid_t gid, int perms)
1070 devfs_msg_t devfs_msg = devfs_msg_get();
1072 devfs_msg->mdv_dev.dev = dev;
1073 devfs_msg->mdv_dev.uid = uid;
1074 devfs_msg->mdv_dev.gid = gid;
1075 devfs_msg->mdv_dev.perms = perms;
1077 devfs_msg_send(cmd, devfs_msg);
1081 * sends a message with a link argument.
1084 devfs_msg_send_link(uint32_t cmd, char *name, char *target, struct mount *mp)
1086 devfs_msg_t devfs_msg = devfs_msg_get();
1088 devfs_msg->mdv_link.name = name;
1089 devfs_msg->mdv_link.target = target;
1090 devfs_msg->mdv_link.mp = mp;
1091 devfs_msg_send(cmd, devfs_msg);
1095 * devfs_msg_core is the main devfs thread. It handles all incoming messages
1096 * and calls the relevant worker functions. By using messages it's assured
1097 * that events occur in the correct order.
1100 devfs_msg_core(void *arg)
1104 lwkt_initport_thread(&devfs_msg_port, curthread);
1106 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1109 lockmgr(&devfs_lock, LK_RELEASE);
1111 get_mplock(); /* mpsafe yet? */
1114 msg = (devfs_msg_t)lwkt_waitport(&devfs_msg_port, 0);
1115 devfs_debug(DEVFS_DEBUG_DEBUG,
1116 "devfs_msg_core, new msg: %x\n",
1117 (unsigned int)msg->hdr.u.ms_result);
1118 devfs_msg_exec(msg);
1119 lwkt_replymsg(&msg->hdr, 0);
1129 devfs_msg_exec(devfs_msg_t msg)
1131 struct devfs_mnt_data *mnt;
1132 struct devfs_node *node;
1136 * Acquire the devfs lock to ensure safety of all called functions
1138 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1140 switch (msg->hdr.u.ms_result) {
1141 case DEVFS_DEVICE_CREATE:
1142 dev = msg->mdv_dev.dev;
1143 devfs_create_dev_worker(dev,
1146 msg->mdv_dev.perms);
1148 case DEVFS_DEVICE_DESTROY:
1149 dev = msg->mdv_dev.dev;
1150 devfs_destroy_dev_worker(dev);
1152 case DEVFS_DESTROY_RELATED:
1153 devfs_destroy_related_worker(msg->mdv_load);
1155 case DEVFS_DESTROY_DEV_BY_OPS:
1156 devfs_destroy_dev_by_ops_worker(msg->mdv_ops.ops,
1157 msg->mdv_ops.minor);
1159 case DEVFS_CREATE_ALL_DEV:
1160 node = (struct devfs_node *)msg->mdv_load;
1161 devfs_create_all_dev_worker(node);
1163 case DEVFS_MOUNT_ADD:
1165 TAILQ_INSERT_TAIL(&devfs_mnt_list, mnt, link);
1166 devfs_create_all_dev_worker(mnt->root_node);
1168 case DEVFS_MOUNT_DEL:
1170 TAILQ_REMOVE(&devfs_mnt_list, mnt, link);
1171 devfs_iterate_topology(mnt->root_node, devfs_reaperp_callback,
1173 if (mnt->leak_count) {
1174 devfs_debug(DEVFS_DEBUG_SHOW,
1175 "Leaked %ld devfs_node elements!\n",
1179 case DEVFS_CHANDLER_ADD:
1180 devfs_chandler_add_worker(msg->mdv_chandler.name,
1181 msg->mdv_chandler.nhandler);
1183 case DEVFS_CHANDLER_DEL:
1184 devfs_chandler_del_worker(msg->mdv_chandler.name);
1186 case DEVFS_FIND_DEVICE_BY_NAME:
1187 devfs_find_device_by_name_worker(msg);
1189 case DEVFS_FIND_DEVICE_BY_UDEV:
1190 devfs_find_device_by_udev_worker(msg);
1192 case DEVFS_MAKE_ALIAS:
1193 devfs_make_alias_worker((struct devfs_alias *)msg->mdv_load);
1195 case DEVFS_DESTROY_ALIAS:
1196 devfs_destroy_alias_worker((struct devfs_alias *)msg->mdv_load);
1198 case DEVFS_APPLY_RULES:
1199 devfs_apply_reset_rules_caller(msg->mdv_name, 1);
1201 case DEVFS_RESET_RULES:
1202 devfs_apply_reset_rules_caller(msg->mdv_name, 0);
1204 case DEVFS_SCAN_CALLBACK:
1205 devfs_scan_callback_worker((devfs_scan_t *)msg->mdv_load,
1208 case DEVFS_CLR_RELATED_FLAG:
1209 devfs_clr_related_flag_worker(msg->mdv_flags.dev,
1210 msg->mdv_flags.flag);
1212 case DEVFS_DESTROY_RELATED_WO_FLAG:
1213 devfs_destroy_related_without_flag_worker(msg->mdv_flags.dev,
1214 msg->mdv_flags.flag);
1216 case DEVFS_INODE_TO_VNODE:
1217 msg->mdv_ino.vp = devfs_iterate_topology(
1218 DEVFS_MNTDATA(msg->mdv_ino.mp)->root_node,
1219 (devfs_iterate_callback_t *)devfs_inode_to_vnode_worker_callback,
1222 case DEVFS_TERMINATE_CORE:
1228 devfs_debug(DEVFS_DEBUG_WARNING,
1229 "devfs_msg_core: unknown message "
1230 "received at core\n");
1233 lockmgr(&devfs_lock, LK_RELEASE);
1237 * Worker function to insert a new dev into the dev list and initialize its
1238 * permissions. It also calls devfs_propagate_dev which in turn propagates
1239 * the change to all mount points.
1241 * The passed dev is already referenced. This reference is eaten by this
1242 * function and represents the dev's linkage into devfs_dev_list.
1245 devfs_create_dev_worker(cdev_t dev, uid_t uid, gid_t gid, int perms)
1251 dev->si_perms = perms;
1253 devfs_link_dev(dev);
1254 devfs_propagate_dev(dev, 1);
1256 udev_event_attach(dev, NULL, 0);
1262 * Worker function to delete a dev from the dev list and free the cdev.
1263 * It also calls devfs_propagate_dev which in turn propagates the change
1264 * to all mount points.
1267 devfs_destroy_dev_worker(cdev_t dev)
1272 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1274 error = devfs_unlink_dev(dev);
1275 devfs_propagate_dev(dev, 0);
1277 udev_event_detach(dev, NULL, 0);
1280 release_dev(dev); /* link ref */
1288 * Worker function to destroy all devices with a certain basename.
1289 * Calls devfs_destroy_dev_worker for the actual destruction.
1292 devfs_destroy_related_worker(cdev_t needle)
1297 devfs_debug(DEVFS_DEBUG_DEBUG, "related worker: %s\n",
1299 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1300 if (dev->si_parent == needle) {
1301 devfs_destroy_related_worker(dev);
1302 devfs_destroy_dev_worker(dev);
1310 devfs_clr_related_flag_worker(cdev_t needle, uint32_t flag)
1314 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1315 if (dev->si_parent == needle) {
1316 devfs_clr_related_flag_worker(dev, flag);
1317 dev->si_flags &= ~flag;
1325 devfs_destroy_related_without_flag_worker(cdev_t needle, uint32_t flag)
1330 devfs_debug(DEVFS_DEBUG_DEBUG, "related_wo_flag: %s\n",
1333 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1334 if (dev->si_parent == needle) {
1335 devfs_destroy_related_without_flag_worker(dev, flag);
1336 if (!(dev->si_flags & flag)) {
1337 devfs_destroy_dev_worker(dev);
1338 devfs_debug(DEVFS_DEBUG_DEBUG,
1339 "related_wo_flag: %s restart\n", dev->si_name);
1349 * Worker function that creates all device nodes on top of a devfs
1353 devfs_create_all_dev_worker(struct devfs_node *root)
1359 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1360 devfs_create_device_node(root, dev, NULL, NULL);
1367 * Worker function that destroys all devices that match a specific
1368 * dev_ops and/or minor. If minor is less than 0, it is not matched
1369 * against. It also propagates all changes.
1372 devfs_destroy_dev_by_ops_worker(struct dev_ops *ops, int minor)
1378 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1379 if (dev->si_ops != ops)
1381 if ((minor < 0) || (dev->si_uminor == minor)) {
1382 devfs_destroy_dev_worker(dev);
1390 * Worker function that registers a new clone handler in devfs.
1393 devfs_chandler_add_worker(const char *name, d_clone_t *nhandler)
1395 struct devfs_clone_handler *chandler = NULL;
1396 u_char len = strlen(name);
1401 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
1402 if (chandler->namlen != len)
1405 if (!memcmp(chandler->name, name, len)) {
1406 /* Clonable basename already exists */
1411 chandler = kmalloc(sizeof(*chandler), M_DEVFS, M_WAITOK | M_ZERO);
1412 chandler->name = kstrdup(name, M_DEVFS);
1413 chandler->namlen = len;
1414 chandler->nhandler = nhandler;
1416 TAILQ_INSERT_TAIL(&devfs_chandler_list, chandler, link);
1421 * Worker function that removes a given clone handler from the
1422 * clone handler list.
1425 devfs_chandler_del_worker(const char *name)
1427 struct devfs_clone_handler *chandler, *chandler2;
1428 u_char len = strlen(name);
1433 TAILQ_FOREACH_MUTABLE(chandler, &devfs_chandler_list, link, chandler2) {
1434 if (chandler->namlen != len)
1436 if (memcmp(chandler->name, name, len))
1439 TAILQ_REMOVE(&devfs_chandler_list, chandler, link);
1440 kfree(chandler->name, M_DEVFS);
1441 kfree(chandler, M_DEVFS);
1449 * Worker function that finds a given device name and changes
1450 * the message received accordingly so that when replied to,
1451 * the answer is returned to the caller.
1454 devfs_find_device_by_name_worker(devfs_msg_t devfs_msg)
1456 struct devfs_alias *alias;
1458 cdev_t found = NULL;
1460 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1461 if (strcmp(devfs_msg->mdv_name, dev->si_name) == 0) {
1466 if (found == NULL) {
1467 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1468 if (strcmp(devfs_msg->mdv_name, alias->name) == 0) {
1469 found = alias->dev_target;
1474 devfs_msg->mdv_cdev = found;
1480 * Worker function that finds a given device udev and changes
1481 * the message received accordingly so that when replied to,
1482 * the answer is returned to the caller.
1485 devfs_find_device_by_udev_worker(devfs_msg_t devfs_msg)
1488 cdev_t found = NULL;
1490 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1491 if (((udev_t)dev->si_inode) == devfs_msg->mdv_udev) {
1496 devfs_msg->mdv_cdev = found;
1502 * Worker function that inserts a given alias into the
1503 * alias list, and propagates the alias to all mount
1507 devfs_make_alias_worker(struct devfs_alias *alias)
1509 struct devfs_alias *alias2;
1510 size_t len = strlen(alias->name);
1513 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1514 if (len != alias2->namlen)
1517 if (!memcmp(alias->name, alias2->name, len)) {
1525 * The alias doesn't exist yet, so we add it to the alias list
1527 TAILQ_INSERT_TAIL(&devfs_alias_list, alias, link);
1528 devfs_alias_propagate(alias, 0);
1529 udev_event_attach(alias->dev_target, alias->name, 1);
1531 devfs_debug(DEVFS_DEBUG_WARNING,
1532 "Warning: duplicate devfs_make_alias for %s\n",
1534 kfree(alias->name, M_DEVFS);
1535 kfree(alias, M_DEVFS);
1542 * Worker function that delete a given alias from the
1543 * alias list, and propagates the removal to all mount
1547 devfs_destroy_alias_worker(struct devfs_alias *alias)
1549 struct devfs_alias *alias2;
1552 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1553 if (alias->dev_target != alias2->dev_target)
1556 if (devfs_WildCmp(alias->name, alias2->name) == 0) {
1563 devfs_debug(DEVFS_DEBUG_WARNING,
1564 "Warning: devfs_destroy_alias for inexistant alias: %s\n",
1566 kfree(alias->name, M_DEVFS);
1567 kfree(alias, M_DEVFS);
1570 * The alias exists, so we delete it from the alias list
1572 TAILQ_REMOVE(&devfs_alias_list, alias2, link);
1573 devfs_alias_propagate(alias2, 1);
1574 udev_event_detach(alias2->dev_target, alias2->name, 1);
1575 kfree(alias->name, M_DEVFS);
1576 kfree(alias, M_DEVFS);
1577 kfree(alias2->name, M_DEVFS);
1578 kfree(alias2, M_DEVFS);
1585 * Function that removes and frees all aliases.
1588 devfs_alias_reap(void)
1590 struct devfs_alias *alias, *alias2;
1592 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1593 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1594 kfree(alias->name, M_DEVFS);
1595 kfree(alias, M_DEVFS);
1601 * Function that removes an alias matching a specific cdev and frees
1605 devfs_alias_remove(cdev_t dev)
1607 struct devfs_alias *alias, *alias2;
1609 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1610 if (alias->dev_target == dev) {
1611 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1612 udev_event_detach(alias->dev_target, alias->name, 1);
1613 kfree(alias->name, M_DEVFS);
1614 kfree(alias, M_DEVFS);
1621 * This function propagates an alias addition or removal to
1625 devfs_alias_propagate(struct devfs_alias *alias, int remove)
1627 struct devfs_mnt_data *mnt;
1629 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1631 devfs_destroy_node(mnt->root_node, alias->name);
1633 devfs_alias_apply(mnt->root_node, alias);
1640 * This function is a recursive function iterating through
1641 * all device nodes in the topology and, if applicable,
1642 * creating the relevant alias for a device node.
1645 devfs_alias_apply(struct devfs_node *node, struct devfs_alias *alias)
1647 struct devfs_node *node1, *node2;
1649 KKASSERT(alias != NULL);
1651 if ((node->node_type == Nroot) || (node->node_type == Ndir)) {
1652 if (node->nchildren > 2) {
1653 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1654 devfs_alias_apply(node1, alias);
1658 if (node->d_dev == alias->dev_target)
1659 devfs_alias_create(alias->name, node, 0);
1665 * This function checks if any alias possibly is applicable
1666 * to the given node. If so, the alias is created.
1669 devfs_alias_check_create(struct devfs_node *node)
1671 struct devfs_alias *alias;
1673 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1674 if (node->d_dev == alias->dev_target)
1675 devfs_alias_create(alias->name, node, 0);
1681 * This function creates an alias with a given name
1682 * linking to a given devfs node. It also increments
1683 * the link count on the target node.
1686 devfs_alias_create(char *name_orig, struct devfs_node *target, int rule_based)
1688 struct mount *mp = target->mp;
1689 struct devfs_node *parent = DEVFS_MNTDATA(mp)->root_node;
1690 struct devfs_node *linknode;
1691 char *create_path = NULL;
1696 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1698 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1699 devfs_resolve_name_path(name_orig, name_buf, &create_path, &name);
1702 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1705 if (devfs_find_device_node_by_name(parent, name)) {
1706 devfs_debug(DEVFS_DEBUG_WARNING,
1707 "Node already exists: %s "
1708 "(devfs_make_alias_worker)!\n",
1714 linknode = devfs_allocp(Nlink, name, parent, mp, NULL);
1715 if (linknode == NULL) {
1720 linknode->link_target = target;
1724 linknode->flags |= DEVFS_RULE_CREATED;
1727 kfree(name_buf, M_TEMP);
1732 * This function is called by the core and handles mount point
1733 * strings. It either calls the relevant worker (devfs_apply_
1734 * reset_rules_worker) on all mountpoints or only a specific
1738 devfs_apply_reset_rules_caller(char *mountto, int apply)
1740 struct devfs_mnt_data *mnt;
1742 if (mountto[0] == '*') {
1743 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1744 devfs_iterate_topology(mnt->root_node,
1745 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1749 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1750 if (!strcmp(mnt->mp->mnt_stat.f_mntonname, mountto)) {
1751 devfs_iterate_topology(mnt->root_node,
1752 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1759 kfree(mountto, M_DEVFS);
1764 * This function calls a given callback function for
1765 * every dev node in the devfs dev list.
1768 devfs_scan_callback_worker(devfs_scan_t *callback, void *arg)
1771 struct devfs_alias *alias, *alias1;
1773 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1774 callback(dev->si_name, dev, false, arg);
1776 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias1) {
1777 callback(alias->name, alias->dev_target, true, arg);
1784 * This function tries to resolve a given directory, or if not
1785 * found and creation requested, creates the given directory.
1787 static struct devfs_node *
1788 devfs_resolve_or_create_dir(struct devfs_node *parent, char *dir_name,
1789 size_t name_len, int create)
1791 struct devfs_node *node, *found = NULL;
1793 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1794 if (name_len != node->d_dir.d_namlen)
1797 if (!memcmp(dir_name, node->d_dir.d_name, name_len)) {
1803 if ((found == NULL) && (create)) {
1804 found = devfs_allocp(Ndir, dir_name, parent, parent->mp, NULL);
1811 * This function tries to resolve a complete path. If creation is requested,
1812 * if a given part of the path cannot be resolved (because it doesn't exist),
1816 devfs_resolve_or_create_path(struct devfs_node *parent, char *path, int create)
1818 struct devfs_node *node = parent;
1825 buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1827 while (*path && idx < PATH_MAX - 1) {
1832 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1842 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1843 kfree (buf, M_TEMP);
1848 * Takes a full path and strips it into a directory path and a name.
1849 * For a/b/c/foo, it returns foo in namep and a/b/c in pathp. It
1850 * requires a working buffer with enough size to keep the whole
1854 devfs_resolve_name_path(char *fullpath, char *buf, char **pathp, char **namep)
1858 size_t len = strlen(fullpath) + 1;
1861 KKASSERT((fullpath != NULL) && (buf != NULL));
1862 KKASSERT((pathp != NULL) && (namep != NULL));
1864 memcpy(buf, fullpath, len);
1866 for (i = len-1; i>= 0; i--) {
1867 if (buf[i] == '/') {
1887 * This function creates a new devfs node for a given device. It can
1888 * handle a complete path as device name, and accordingly creates
1889 * the path and the final device node.
1891 * The reference count on the passed dev remains unchanged.
1894 devfs_create_device_node(struct devfs_node *root, cdev_t dev,
1895 char *dev_name, char *path_fmt, ...)
1897 struct devfs_node *parent, *node = NULL;
1903 char *create_path = NULL;
1904 char *names = "pqrsPQRS";
1906 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
1908 if (path_fmt != NULL) {
1909 __va_start(ap, path_fmt);
1910 kvasnrprintf(&path, PATH_MAX, 10, path_fmt, ap);
1914 parent = devfs_resolve_or_create_path(root, path, 1);
1917 devfs_resolve_name_path(
1918 ((dev_name == NULL) && (dev))?(dev->si_name):(dev_name),
1919 name_buf, &create_path, &name);
1922 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1925 if (devfs_find_device_node_by_name(parent, name)) {
1926 devfs_debug(DEVFS_DEBUG_WARNING, "devfs_create_device_node: "
1927 "DEVICE %s ALREADY EXISTS!!! Ignoring creation request.\n", name);
1931 node = devfs_allocp(Ndev, name, parent, parent->mp, dev);
1932 nanotime(&parent->mtime);
1935 * Ugly unix98 pty magic, to hide pty master (ptm) devices and their
1938 if ((dev) && (strlen(dev->si_name) >= 4) &&
1939 (!memcmp(dev->si_name, "ptm/", 4))) {
1940 node->parent->flags |= DEVFS_HIDDEN;
1941 node->flags |= DEVFS_HIDDEN;
1945 * Ugly pty magic, to tag pty devices as such and hide them if needed.
1947 if ((strlen(name) >= 3) && (!memcmp(name, "pty", 3)))
1948 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1950 if ((strlen(name) >= 3) && (!memcmp(name, "tty", 3))) {
1952 for (i = 0; i < strlen(names); i++) {
1953 if (name[3] == names[i]) {
1959 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1963 kfree(name_buf, M_TEMP);
1969 * This function finds a given device node in the topology with a given
1973 devfs_find_device_node_callback(struct devfs_node *node, cdev_t target)
1975 if ((node->node_type == Ndev) && (node->d_dev == target)) {
1983 * This function finds a device node in the given parent directory by its
1984 * name and returns it.
1987 devfs_find_device_node_by_name(struct devfs_node *parent, char *target)
1989 struct devfs_node *node, *found = NULL;
1990 size_t len = strlen(target);
1992 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1993 if (len != node->d_dir.d_namlen)
1996 if (!memcmp(node->d_dir.d_name, target, len)) {
2006 devfs_inode_to_vnode_worker_callback(struct devfs_node *node, ino_t *inop)
2008 struct vnode *vp = NULL;
2009 ino_t target = *inop;
2011 if (node->d_dir.d_ino == target) {
2014 vget(vp, LK_EXCLUSIVE | LK_RETRY);
2017 devfs_allocv(&vp, node);
2026 * This function takes a cdev and removes its devfs node in the
2027 * given topology. The cdev remains intact.
2030 devfs_destroy_device_node(struct devfs_node *root, cdev_t target)
2032 KKASSERT(target != NULL);
2033 return devfs_destroy_node(root, target->si_name);
2037 * This function takes a path to a devfs node, resolves it and
2038 * removes the devfs node from the given topology.
2041 devfs_destroy_node(struct devfs_node *root, char *target)
2043 struct devfs_node *node, *parent;
2046 char *create_path = NULL;
2050 name_buf = kmalloc(PATH_MAX, M_TEMP, M_WAITOK);
2051 ksnprintf(name_buf, PATH_MAX, "%s", target);
2053 devfs_resolve_name_path(target, name_buf, &create_path, &name);
2056 parent = devfs_resolve_or_create_path(root, create_path, 0);
2060 if (parent == NULL) {
2061 kfree(name_buf, M_TEMP);
2065 node = devfs_find_device_node_by_name(parent, name);
2068 nanotime(&node->parent->mtime);
2072 kfree(name_buf, M_TEMP);
2078 * Just set perms and ownership for given node.
2081 devfs_set_perms(struct devfs_node *node, uid_t uid, gid_t gid,
2082 u_short mode, u_long flags)
2092 * Propagates a device attach/detach to all mount
2093 * points. Also takes care of automatic alias removal
2094 * for a deleted cdev.
2097 devfs_propagate_dev(cdev_t dev, int attach)
2099 struct devfs_mnt_data *mnt;
2101 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
2103 /* Device is being attached */
2104 devfs_create_device_node(mnt->root_node, dev,
2107 /* Device is being detached */
2108 devfs_alias_remove(dev);
2109 devfs_destroy_device_node(mnt->root_node, dev);
2116 * devfs_clone either returns a basename from a complete name by
2117 * returning the length of the name without trailing digits, or,
2118 * if clone != 0, calls the device's clone handler to get a new
2119 * device, which in turn is returned in devp.
2122 devfs_clone(cdev_t dev, const char *name, size_t len, int mode,
2126 struct devfs_clone_handler *chandler;
2127 struct dev_clone_args ap;
2129 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
2130 if (chandler->namlen != len)
2132 if ((!memcmp(chandler->name, name, len)) && (chandler->nhandler)) {
2133 lockmgr(&devfs_lock, LK_RELEASE);
2135 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2137 ap.a_head.a_dev = dev;
2143 error = (chandler->nhandler)(&ap);
2156 * Registers a new orphan in the orphan list.
2159 devfs_tracer_add_orphan(struct devfs_node *node)
2161 struct devfs_orphan *orphan;
2164 orphan = kmalloc(sizeof(struct devfs_orphan), M_DEVFS, M_WAITOK);
2165 orphan->node = node;
2167 KKASSERT((node->flags & DEVFS_ORPHANED) == 0);
2168 node->flags |= DEVFS_ORPHANED;
2169 TAILQ_INSERT_TAIL(DEVFS_ORPHANLIST(node->mp), orphan, link);
2173 * Removes an orphan from the orphan list.
2176 devfs_tracer_del_orphan(struct devfs_node *node)
2178 struct devfs_orphan *orphan;
2182 TAILQ_FOREACH(orphan, DEVFS_ORPHANLIST(node->mp), link) {
2183 if (orphan->node == node) {
2184 node->flags &= ~DEVFS_ORPHANED;
2185 TAILQ_REMOVE(DEVFS_ORPHANLIST(node->mp), orphan, link);
2186 kfree(orphan, M_DEVFS);
2193 * Counts the orphans in the orphan list, and if cleanup
2194 * is specified, also frees the orphan and removes it from
2198 devfs_tracer_orphan_count(struct mount *mp, int cleanup)
2200 struct devfs_orphan *orphan, *orphan2;
2203 TAILQ_FOREACH_MUTABLE(orphan, DEVFS_ORPHANLIST(mp), link, orphan2) {
2206 * If we are instructed to clean up, we do so.
2209 TAILQ_REMOVE(DEVFS_ORPHANLIST(mp), orphan, link);
2210 orphan->node->flags &= ~DEVFS_ORPHANED;
2211 devfs_freep(orphan->node);
2212 kfree(orphan, M_DEVFS);
2220 * Fetch an ino_t from the global d_ino by increasing it
2224 devfs_fetch_ino(void)
2228 spin_lock(&ino_lock);
2230 spin_unlock(&ino_lock);
2236 * Allocates a new cdev and initializes it's most basic
2240 devfs_new_cdev(struct dev_ops *ops, int minor, struct dev_ops *bops)
2242 cdev_t dev = sysref_alloc(&cdev_sysref_class);
2244 sysref_activate(&dev->si_sysref);
2246 bzero(dev, offsetof(struct cdev, si_sysref));
2251 dev->si_drv1 = NULL;
2252 dev->si_drv2 = NULL;
2253 dev->si_lastread = 0; /* time_uptime */
2254 dev->si_lastwrite = 0; /* time_uptime */
2256 dev->si_dict = NULL;
2257 dev->si_parent = NULL;
2260 dev->si_uminor = minor;
2261 dev->si_bops = bops;
2264 * Since the disk subsystem is in the way, we need to
2265 * propagate the D_CANFREE from bops (and ops) to
2268 if (bops && (bops->head.flags & D_CANFREE)) {
2269 dev->si_flags |= SI_CANFREE;
2270 } else if (ops->head.flags & D_CANFREE) {
2271 dev->si_flags |= SI_CANFREE;
2274 /* If there is a backing device, we reference its ops */
2275 dev->si_inode = makeudev(
2276 devfs_reference_ops((bops)?(bops):(ops)),
2278 dev->si_umajor = umajor(dev->si_inode);
2284 devfs_cdev_terminate(cdev_t dev)
2288 /* Check if it is locked already. if not, we acquire the devfs lock */
2289 if ((lockstatus(&devfs_lock, curthread)) != LK_EXCLUSIVE) {
2290 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2295 * Make sure the node isn't linked anymore. Otherwise we've screwed
2296 * up somewhere, since normal devs are unlinked on the call to
2297 * destroy_dev and only-cdevs that have not been used for cloning
2298 * are not linked in the first place. only-cdevs used for cloning
2299 * will be linked in, too, and should only be destroyed via
2300 * destroy_dev, not destroy_only_dev, so we catch that problem, too.
2302 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2304 /* If we acquired the lock, we also get rid of it */
2306 lockmgr(&devfs_lock, LK_RELEASE);
2308 /* If there is a backing device, we release the backing device's ops */
2309 devfs_release_ops((dev->si_bops)?(dev->si_bops):(dev->si_ops));
2311 /* Finally destroy the device */
2312 sysref_put(&dev->si_sysref);
2316 * Dummies for now (individual locks for MPSAFE)
2319 devfs_cdev_lock(cdev_t dev)
2324 devfs_cdev_unlock(cdev_t dev)
2329 devfs_detached_filter_eof(struct knote *kn, long hint)
2331 kn->kn_flags |= (EV_EOF | EV_NODATA);
2336 devfs_detached_filter_detach(struct knote *kn)
2338 cdev_t dev = (cdev_t)kn->kn_hook;
2340 knote_remove(&dev->si_kqinfo.ki_note, kn);
2343 static struct filterops devfs_detached_filterops =
2344 { FILTEROP_ISFD, NULL,
2345 devfs_detached_filter_detach,
2346 devfs_detached_filter_eof };
2349 * Delegates knote filter handling responsibility to devfs
2351 * Any device that implements kqfilter event handling and could be detached
2352 * or shut down out from under the kevent subsystem must allow devfs to
2353 * assume responsibility for any knotes it may hold.
2356 devfs_assume_knotes(cdev_t dev, struct kqinfo *kqi)
2359 * Let kern/kern_event.c do the heavy lifting.
2361 knote_assume_knotes(kqi, &dev->si_kqinfo,
2362 &devfs_detached_filterops, (void *)dev);
2365 * These should probably be activated individually, but doing so
2366 * would require refactoring kq's public in-kernel interface.
2368 KNOTE(&dev->si_kqinfo.ki_note, 0);
2372 * Links a given cdev into the dev list.
2375 devfs_link_dev(cdev_t dev)
2377 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2378 dev->si_flags |= SI_DEVFS_LINKED;
2379 TAILQ_INSERT_TAIL(&devfs_dev_list, dev, link);
2385 * Removes a given cdev from the dev list. The caller is responsible for
2386 * releasing the reference on the device associated with the linkage.
2388 * Returns EALREADY if the dev has already been unlinked.
2391 devfs_unlink_dev(cdev_t dev)
2393 if ((dev->si_flags & SI_DEVFS_LINKED)) {
2394 TAILQ_REMOVE(&devfs_dev_list, dev, link);
2395 dev->si_flags &= ~SI_DEVFS_LINKED;
2402 devfs_node_is_accessible(struct devfs_node *node)
2404 if ((node) && (!(node->flags & DEVFS_HIDDEN)))
2411 devfs_reference_ops(struct dev_ops *ops)
2414 struct devfs_dev_ops *found = NULL;
2415 struct devfs_dev_ops *devops;
2417 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2418 if (devops->ops == ops) {
2425 found = kmalloc(sizeof(struct devfs_dev_ops), M_DEVFS, M_WAITOK);
2427 found->ref_count = 0;
2428 TAILQ_INSERT_TAIL(&devfs_dev_ops_list, found, link);
2433 if (found->ref_count == 0) {
2434 found->id = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(ops_id), 255);
2435 if (found->id == -1) {
2436 /* Ran out of unique ids */
2437 devfs_debug(DEVFS_DEBUG_WARNING,
2438 "devfs_reference_ops: WARNING: ran out of unique ids\n");
2448 devfs_release_ops(struct dev_ops *ops)
2450 struct devfs_dev_ops *found = NULL;
2451 struct devfs_dev_ops *devops;
2453 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2454 if (devops->ops == ops) {
2464 if (found->ref_count == 0) {
2465 TAILQ_REMOVE(&devfs_dev_ops_list, found, link);
2466 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(ops_id), found->id);
2467 kfree(found, M_DEVFS);
2472 * Wait for asynchronous messages to complete in the devfs helper
2473 * thread, then return. Do nothing if the helper thread is dead
2474 * or we are being indirectly called from the helper thread itself.
2481 if (devfs_run && curthread != td_core) {
2482 msg = devfs_msg_get();
2483 msg = devfs_msg_send_sync(DEVFS_SYNC, msg);
2489 * Called on init of devfs; creates the objcaches and
2490 * spawns off the devfs core thread. Also initializes
2496 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init() called\n");
2497 /* Create objcaches for nodes, msgs and devs */
2498 devfs_node_cache = objcache_create("devfs-node-cache", 0, 0,
2500 objcache_malloc_alloc,
2501 objcache_malloc_free,
2502 &devfs_node_malloc_args );
2504 devfs_msg_cache = objcache_create("devfs-msg-cache", 0, 0,
2506 objcache_malloc_alloc,
2507 objcache_malloc_free,
2508 &devfs_msg_malloc_args );
2510 devfs_dev_cache = objcache_create("devfs-dev-cache", 0, 0,
2512 objcache_malloc_alloc,
2513 objcache_malloc_free,
2514 &devfs_dev_malloc_args );
2516 devfs_clone_bitmap_init(&DEVFS_CLONE_BITMAP(ops_id));
2518 /* Initialize the reply-only port which acts as a message drain */
2519 lwkt_initport_replyonly(&devfs_dispose_port, devfs_msg_autofree_reply);
2521 /* Initialize *THE* devfs lock */
2522 lockinit(&devfs_lock, "devfs_core lock", 0, 0);
2524 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2525 lwkt_create(devfs_msg_core, /*args*/NULL, &td_core, NULL,
2526 0, -1, "devfs_msg_core");
2527 while (devfs_run == 0)
2528 lksleep(td_core, &devfs_lock, 0, "devfsc", 0);
2529 lockmgr(&devfs_lock, LK_RELEASE);
2531 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init finished\n");
2535 * Called on unload of devfs; takes care of destroying the core
2536 * and the objcaches. Also removes aliases that are no longer needed.
2541 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_uninit() called\n");
2543 devfs_msg_send(DEVFS_TERMINATE_CORE, NULL);
2545 tsleep(td_core, 0, "devfsc", hz*10);
2546 tsleep(td_core, 0, "devfsc", hz);
2548 devfs_clone_bitmap_uninit(&DEVFS_CLONE_BITMAP(ops_id));
2550 /* Destroy the objcaches */
2551 objcache_destroy(devfs_msg_cache);
2552 objcache_destroy(devfs_node_cache);
2553 objcache_destroy(devfs_dev_cache);
2559 * This is a sysctl handler to assist userland devname(3) to
2560 * find the device name for a given udev.
2563 devfs_sysctl_devname_helper(SYSCTL_HANDLER_ARGS)
2570 if ((error = SYSCTL_IN(req, &udev, sizeof(udev_t))))
2573 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs sysctl, received udev: %d\n", udev);
2578 if ((found = devfs_find_device_by_udev(udev)) == NULL)
2581 return(SYSCTL_OUT(req, found->si_name, strlen(found->si_name) + 1));
2585 SYSCTL_PROC(_kern, OID_AUTO, devname, CTLTYPE_OPAQUE|CTLFLAG_RW|CTLFLAG_ANYBODY,
2586 NULL, 0, devfs_sysctl_devname_helper, "", "helper for devname(3)");
2588 SYSCTL_NODE(_vfs, OID_AUTO, devfs, CTLFLAG_RW, 0, "devfs");
2589 TUNABLE_INT("vfs.devfs.debug", &devfs_debug_enable);
2590 SYSCTL_INT(_vfs_devfs, OID_AUTO, debug, CTLFLAG_RW, &devfs_debug_enable,
2591 0, "Enable DevFS debugging");
2593 SYSINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
2595 SYSUNINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY,
2596 devfs_uninit, NULL);
2599 * WildCmp() - compare wild string to sane string
2601 * Returns 0 on success, -1 on failure.
2604 wildCmp(const char **mary, int d, const char *w, const char *s)
2609 * skip fixed portion
2615 * optimize terminator
2619 if (w[1] != '?' && w[1] != '*') {
2621 * optimize * followed by non-wild
2623 for (i = 0; s + i < mary[d]; ++i) {
2624 if (s[i] == w[1] && wildCmp(mary, d + 1, w + 1, s + i) == 0)
2631 for (i = 0; s + i < mary[d]; ++i) {
2632 if (wildCmp(mary, d + 1, w + 1, s + i) == 0)
2647 if (*w == 0) /* terminator */
2660 * WildCaseCmp() - compare wild string to sane string, case insensitive
2662 * Returns 0 on success, -1 on failure.
2665 wildCaseCmp(const char **mary, int d, const char *w, const char *s)
2670 * skip fixed portion
2676 * optimize terminator
2680 if (w[1] != '?' && w[1] != '*') {
2682 * optimize * followed by non-wild
2684 for (i = 0; s + i < mary[d]; ++i) {
2685 if (s[i] == w[1] && wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
2692 for (i = 0; s + i < mary[d]; ++i) {
2693 if (wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
2707 #define tolower(x) ((x >= 'A' && x <= 'Z')?(x+('a'-'A')):(x))
2708 if (tolower(*w) != tolower(*s))
2711 if (*w == 0) /* terminator */
2723 devfs_WildCmp(const char *w, const char *s)
2727 int slen = strlen(s);
2730 for (i = c = 0; w[i]; ++i) {
2734 mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
2735 for (i = 0; i < c; ++i)
2737 i = wildCmp(mary, 0, w, s);
2738 kfree(mary, M_DEVFS);
2743 devfs_WildCaseCmp(const char *w, const char *s)
2747 int slen = strlen(s);
2750 for (i = c = 0; w[i]; ++i) {
2754 mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
2755 for (i = 0; i < c; ++i)
2757 i = wildCaseCmp(mary, 0, w, s);
2758 kfree(mary, M_DEVFS);