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/msgport2.h>
43 #include <sys/spinlock2.h>
44 #include <sys/sysctl.h>
45 #include <sys/ucred.h>
46 #include <sys/param.h>
47 #include <sys/sysref2.h>
48 #include <sys/systm.h>
49 #include <vfs/devfs/devfs.h>
50 #include <vfs/devfs/devfs_rules.h>
52 MALLOC_DEFINE(M_DEVFS, "devfs", "Device File System (devfs) allocations");
53 DEVFS_DECLARE_CLONE_BITMAP(ops_id);
55 * SYSREF Integration - reference counting, allocation,
56 * sysid and syslink integration.
58 static void devfs_cdev_terminate(cdev_t dev);
59 static struct sysref_class cdev_sysref_class = {
62 .proto = SYSREF_PROTO_DEV,
63 .offset = offsetof(struct cdev, si_sysref),
64 .objsize = sizeof(struct cdev),
68 .terminate = (sysref_terminate_func_t)devfs_cdev_terminate
72 static struct objcache *devfs_node_cache;
73 static struct objcache *devfs_msg_cache;
74 static struct objcache *devfs_dev_cache;
76 static struct objcache_malloc_args devfs_node_malloc_args = {
77 sizeof(struct devfs_node), M_DEVFS };
78 struct objcache_malloc_args devfs_msg_malloc_args = {
79 sizeof(struct devfs_msg), M_DEVFS };
80 struct objcache_malloc_args devfs_dev_malloc_args = {
81 sizeof(struct cdev), M_DEVFS };
83 static struct devfs_dev_head devfs_dev_list = TAILQ_HEAD_INITIALIZER(devfs_dev_list);
84 static struct devfs_mnt_head devfs_mnt_list = TAILQ_HEAD_INITIALIZER(devfs_mnt_list);
85 static struct devfs_chandler_head devfs_chandler_list = TAILQ_HEAD_INITIALIZER(devfs_chandler_list);
86 static struct devfs_alias_head devfs_alias_list = TAILQ_HEAD_INITIALIZER(devfs_alias_list);
88 struct lock devfs_lock;
89 static struct lwkt_port devfs_dispose_port;
90 static struct lwkt_port devfs_msg_port;
91 static struct thread *td_core;
93 static ino_t d_ino = 0;
94 static __uint32_t msg_id = 0;
95 static struct spinlock ino_lock;
96 static int devfs_debug_enable = 0;
98 static ino_t devfs_fetch_ino(void);
99 static int devfs_gc_dirs(struct devfs_node *);
100 static int devfs_gc_links(struct devfs_node *, struct devfs_node *, size_t);
101 static int devfs_create_all_dev_worker(struct devfs_node *);
102 static int devfs_create_dev_worker(cdev_t, uid_t, gid_t, int);
103 static int devfs_destroy_dev_worker(cdev_t);
104 static int devfs_destroy_subnames_worker(char *);
105 static int devfs_destroy_dev_by_ops_worker(struct dev_ops *, int);
106 static int devfs_propagate_dev(cdev_t, int);
107 static int devfs_unlink_dev(cdev_t dev);
109 static int devfs_chandler_add_worker(char *, d_clone_t *);
110 static int devfs_chandler_del_worker(char *);
112 static void devfs_msg_autofree_reply(lwkt_port_t, lwkt_msg_t);
113 static void devfs_msg_core(void *);
115 static int devfs_find_device_by_name_worker(devfs_msg_t);
116 static int devfs_find_device_by_udev_worker(devfs_msg_t);
118 static int devfs_apply_reset_rules_caller(char *, int);
119 static int devfs_apply_reset_rules_worker(struct devfs_node *, int);
121 static int devfs_scan_callback_worker(devfs_scan_t *);
123 static struct devfs_node *devfs_resolve_or_create_dir(struct devfs_node *, char *, size_t, int);
125 static int devfs_make_alias_worker(struct devfs_alias *);
126 static int devfs_alias_remove(cdev_t);
127 static int devfs_alias_reap(void);
128 static int devfs_alias_propagate(struct devfs_alias *);
129 static int devfs_alias_apply(struct devfs_node *, struct devfs_alias *);
130 static int devfs_alias_check_create(struct devfs_node *);
132 static int devfs_clr_subnames_flag_worker(char *, uint32_t);
133 static int devfs_destroy_subnames_without_flag_worker(char *, uint32_t);
136 * devfs_debug() is a SYSCTL and TUNABLE controlled debug output function using kvprintf
139 devfs_debug(int level, char *fmt, ...)
144 if (level <= devfs_debug_enable)
152 * devfs_allocp() Allocates a new devfs node with the specified
153 * parameters. The node is also automatically linked into the topology
154 * if a parent is specified. It also calls the rule and alias stuff to
155 * be applied on the new node
158 devfs_allocp(devfs_nodetype devfsnodetype, char *name,
159 struct devfs_node *parent, struct mount *mp, cdev_t dev)
161 struct devfs_node *node = NULL;
162 size_t namlen = strlen(name);
163 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocp -1- for %s\n", name?name:"NULL");
165 node = objcache_get(devfs_node_cache, M_WAITOK);
167 bzero(node, sizeof(*node));
169 atomic_add_int(&(DEVFS_MNTDATA(mp)->leak_count), 1);
174 node->d_dir.d_ino = devfs_fetch_ino();
175 node->cookie_jar = 2; /* Leave 0 and 1 for '.' and '..', respectively */
177 /* Access Control members */
178 node->mode = DEVFS_DEFAULT_MODE; /* files access mode and type */
179 node->uid = DEVFS_DEFAULT_UID; /* owner user id */
180 node->gid = DEVFS_DEFAULT_GID; /* owner group id */
182 switch (devfsnodetype) {
184 /* Ensure that we don't recycle the root vnode */
185 node->flags |= DEVFS_NODE_LINKED;
187 TAILQ_INIT(DEVFS_DENODE_HEAD(node));
188 node->d_dir.d_type = DT_DIR;
193 node->d_dir.d_type = DT_LNK;
197 node->d_dir.d_type = DT_REG;
202 node->d_dir.d_type = DT_CHR;
204 node->d_dir.d_ino = dev->si_inode;
206 node->mode = dev->si_perms; /* files access mode and type */
207 node->uid = dev->si_uid; /* owner user id */
208 node->gid = dev->si_gid; /* owner group id */
210 devfs_alias_check_create(node);
215 panic("devfs_allocp: unknown node type");
219 node->node_type = devfsnodetype;
221 /* Init the dirent structure of each devfs vnode */
222 KKASSERT(namlen < 256);
224 node->d_dir.d_namlen = namlen;
225 node->d_dir.d_name = kmalloc(namlen+1, M_DEVFS, M_WAITOK);
226 memcpy(node->d_dir.d_name, name, namlen);
227 node->d_dir.d_name[namlen] = '\0';
229 /* Initialize the parent node element */
230 node->parent = parent;
233 devfs_rule_check_apply(node);
236 nanotime(&node->atime);
237 node->mtime = node->ctime = node->atime;
240 * Associate with parent as last step, clean out namecache
243 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocp: about to insert node\n");
244 if ((parent != NULL) &&
245 ((parent->node_type == Proot) || (parent->node_type == Pdir))) {
246 devfs_debug(DEVFS_DEBUG_DEBUG,
247 "devfs_allocp: node inserted %p\n",
250 node->cookie = parent->cookie_jar++;
251 node->flags |= DEVFS_NODE_LINKED;
252 TAILQ_INSERT_TAIL(DEVFS_DENODE_HEAD(parent), node, link);
254 /* This forces negative namecache lookups to clear */
255 ++mp->mnt_namecache_gen;
258 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocp -end:2-\n");
263 * devfs_allocv() allocates a new vnode based on a devfs node.
266 devfs_allocv(struct vnode **vpp, struct devfs_node *node)
273 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -1-\n");
276 while ((vp = node->v_node) != NULL) {
277 error = vget(vp, LK_EXCLUSIVE);
278 if (error != ENOENT) {
280 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv, code path 2...\n");
284 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -3-\n");
286 if ((error = getnewvnode(VT_DEVFS, node->mp, vpp, 0, 0)) != 0)
291 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -4-\n");
293 if (node->v_node != NULL) {
301 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -5-\n");
303 switch (node->node_type) {
320 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -6-\n");
321 KKASSERT(node->d_dev);
324 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -7-\n");
325 vp->v_uminor = node->d_dev->si_uminor;
327 vp->v_rdev = node->d_dev;
328 vp->v_ops = &node->mp->mnt_vn_spec_ops;
329 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -8-\n");
331 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv: type is Pdev but d_dev is not set!!!!\n");
333 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -9-\n");
337 panic("devfs_allocv: unknown node type");
341 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -10-\n");
342 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocv -end:11-\n");
347 * devfs_allocvp allocates both a devfs node (with the given settings) and a vnode
348 * based on the newly created devfs node.
351 devfs_allocvp(struct mount *mp, struct vnode **vpp, devfs_nodetype devfsnodetype,
352 char *name, struct devfs_node *parent, cdev_t dev)
354 struct devfs_node *node;
356 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocvp -1-\n");
357 node = devfs_allocp(devfsnodetype, name, parent, mp, dev);
358 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocvp -2-\n");
360 devfs_allocv(vpp, node);
364 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_allocvp -end:3-\n");
370 * Destroy the devfs_node. The node must be unlinked from the topology.
372 * This function will also destroy any vnode association with the node
375 * The cdev_t itself remains intact.
378 devfs_freep(struct devfs_node *node)
383 KKASSERT(((node->flags & DEVFS_NODE_LINKED) == 0) ||
384 (node->node_type == Proot));
385 KKASSERT((node->flags & DEVFS_DESTROYED) == 0);
387 atomic_subtract_int(&(DEVFS_MNTDATA(node->mp)->leak_count), 1);
388 if (node->symlink_name) {
389 kfree(node->symlink_name, M_DEVFS);
390 node->symlink_name = NULL;
394 * Remove the node from the orphan list if it is still on it.
396 if (node->flags & DEVFS_ORPHANED)
397 devfs_tracer_del_orphan(node);
400 * Disassociate the vnode from the node. This also prevents the
401 * vnode's reclaim code from double-freeing the node.
403 if ((vp = node->v_node) != NULL) {
408 if (node->d_dir.d_name)
409 kfree(node->d_dir.d_name, M_DEVFS);
410 node->flags |= DEVFS_DESTROYED;
412 objcache_put(devfs_node_cache, node);
418 * Unlink the devfs node from the topology and add it to the orphan list.
419 * The node will later be destroyed by freep.
421 * Any vnode association, including the v_rdev and v_data, remains intact
425 devfs_unlinkp(struct devfs_node *node)
427 struct devfs_node *parent;
430 devfs_tracer_add_orphan(node);
431 devfs_debug(DEVFS_DEBUG_DEBUG,
432 "devfs_unlinkp for %s\n", node->d_dir.d_name);
433 parent = node->parent;
436 * If the parent is known we can unlink the node out of the topology
439 TAILQ_REMOVE(DEVFS_DENODE_HEAD(parent), node, link);
441 KKASSERT((parent->nchildren >= 0));
442 node->flags &= ~DEVFS_NODE_LINKED;
449 * devfs_reaperp() is a recursive function that iterates through all the
450 * topology, unlinking and freeing all devfs nodes.
453 devfs_reaperp(struct devfs_node *node)
455 struct devfs_node *node1, *node2;
457 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
458 devfs_debug(DEVFS_DEBUG_DEBUG,
459 "This node is Pdir or Proot; has %d children\n",
461 if (node->nchildren > 2) {
462 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node),
464 devfs_reaperp(node1);
475 * devfs_gc() is devfs garbage collector. It takes care of unlinking and
476 * freeing a node, but also removes empty directories and links that link
477 * via devfs auto-link mechanism to the node being deleted.
480 devfs_gc(struct devfs_node *node)
482 struct devfs_node *root_node = DEVFS_MNTDATA(node->mp)->root_node;
484 devfs_gc_links(root_node, node, node->nlinks);
486 devfs_gc_dirs(root_node);
494 * devfs_gc_dirs() is a helper function for devfs_gc, unlinking and freeing
498 devfs_gc_dirs(struct devfs_node *node)
500 struct devfs_node *node1, *node2;
502 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
503 devfs_debug(DEVFS_DEBUG_DEBUG,
504 "This node is Pdir or Proot; has %d children\n",
506 if (node->nchildren > 2) {
507 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node),
509 devfs_gc_dirs(node1);
513 if (node->nchildren == 2) {
514 devfs_debug(DEVFS_DEBUG_DEBUG,
515 "This node is called %s and it is empty\n",
526 * devfs_gc_links() is a helper function for devfs_gc, unlinking and freeing
527 * eauto-linked nodes linking to the node being deleted.
530 devfs_gc_links(struct devfs_node *node, struct devfs_node *target,
533 struct devfs_node *node1, *node2;
536 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
537 devfs_debug(DEVFS_DEBUG_DEBUG, "This node is Pdir or Proot; has %d children\n", node->nchildren);
538 if (node->nchildren > 2) {
539 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
540 nlinks = devfs_gc_links(node1, target, nlinks);
543 } else if (node->link_target == target) {
550 KKASSERT(nlinks >= 0);
556 * devfs_create_dev() is the asynchronous entry point for device creation.
557 * It just sends a message with the relevant details to the devfs core.
559 * This function will reference the passed device. The reference is owned
560 * by devfs and represents all of the device's node associations.
563 devfs_create_dev(cdev_t dev, uid_t uid, gid_t gid, int perms)
566 devfs_debug(DEVFS_DEBUG_DEBUG,
567 "devfs_create_dev -1-, name: %s (%p)\n",
570 id = devfs_msg_send_dev(DEVFS_DEVICE_CREATE, dev, uid, gid, perms);
571 devfs_debug(DEVFS_DEBUG_DEBUG,
572 "devfs_create_dev -end:2- (unique id: %x) / (%p)\n",
578 * devfs_destroy_dev() is the asynchronous entry point for device destruction.
579 * It just sends a message with the relevant details to the devfs core.
582 devfs_destroy_dev(cdev_t dev)
584 devfs_msg_send_dev(DEVFS_DEVICE_DESTROY, dev, 0, 0, 0);
589 * devfs_mount_add() is the synchronous entry point for adding a new devfs
590 * mount. It sends a synchronous message with the relevant details to the
594 devfs_mount_add(struct devfs_mnt_data *mnt)
598 msg = devfs_msg_get();
600 msg = devfs_msg_send_sync(DEVFS_MOUNT_ADD, msg);
607 * devfs_mount_del() is the synchronous entry point for removing a devfs mount.
608 * It sends a synchronous message with the relevant details to the devfs core.
611 devfs_mount_del(struct devfs_mnt_data *mnt)
615 msg = devfs_msg_get();
617 msg = devfs_msg_send_sync(DEVFS_MOUNT_DEL, msg);
624 * devfs_destroy_subnames() is the synchronous entry point for device destruction
625 * by subname. It just sends a message with the relevant details to the devfs core.
628 devfs_destroy_subnames(char *name)
632 msg = devfs_msg_get();
633 msg->mdv_load = name;
634 msg = devfs_msg_send_sync(DEVFS_DESTROY_SUBNAMES, msg);
640 devfs_clr_subnames_flag(char *name, uint32_t flag)
644 msg = devfs_msg_get();
645 msg->mdv_flags.name = name;
646 msg->mdv_flags.flag = flag;
647 msg = devfs_msg_send_sync(DEVFS_CLR_SUBNAMES_FLAG, msg);
654 devfs_destroy_subnames_without_flag(char *name, uint32_t flag)
658 msg = devfs_msg_get();
659 msg->mdv_flags.name = name;
660 msg->mdv_flags.flag = flag;
661 msg = devfs_msg_send_sync(DEVFS_DESTROY_SUBNAMES_WO_FLAG, msg);
668 * devfs_create_all_dev is the asynchronous entry point to trigger device
669 * node creation. It just sends a message with the relevant details to
673 devfs_create_all_dev(struct devfs_node *root)
675 devfs_msg_send_generic(DEVFS_CREATE_ALL_DEV, root);
680 * devfs_destroy_dev_by_ops is the asynchronous entry point to destroy all
681 * devices with a specific set of dev_ops and minor. It just sends a
682 * message with the relevant details to the devfs core.
685 devfs_destroy_dev_by_ops(struct dev_ops *ops, int minor)
687 devfs_msg_send_ops(DEVFS_DESTROY_DEV_BY_OPS, ops, minor);
692 * devfs_clone_handler_add is the synchronous entry point to add a new
693 * clone handler. It just sends a message with the relevant details to
697 devfs_clone_handler_add(char *name, d_clone_t *nhandler)
701 msg = devfs_msg_get();
702 msg->mdv_chandler.name = name;
703 msg->mdv_chandler.nhandler = nhandler;
704 msg = devfs_msg_send_sync(DEVFS_CHANDLER_ADD, msg);
710 * devfs_clone_handler_del is the synchronous entry point to remove a
711 * clone handler. It just sends a message with the relevant details to
715 devfs_clone_handler_del(char *name)
719 msg = devfs_msg_get();
720 msg->mdv_chandler.name = name;
721 msg->mdv_chandler.nhandler = NULL;
722 msg = devfs_msg_send_sync(DEVFS_CHANDLER_DEL, msg);
728 * devfs_find_device_by_name is the synchronous entry point to find a
729 * device given its name. It sends a synchronous message with the
730 * relevant details to the devfs core and returns the answer.
733 devfs_find_device_by_name(const char *fmt, ...)
737 char target[PATH_MAX+1];
746 i = kvcprintf(fmt, NULL, target, 10, ap);
751 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_find_device_by_name: %s -1-\n", target);
752 msg = devfs_msg_get();
753 msg->mdv_name = target;
754 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_NAME, msg);
755 found = msg->mdv_cdev;
758 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_find_device_by_name found? %s -end:2-\n", (found)?"YES":"NO");
763 * devfs_find_device_by_udev is the synchronous entry point to find a
764 * device given its udev number. It sends a synchronous message with
765 * the relevant details to the devfs core and returns the answer.
768 devfs_find_device_by_udev(udev_t udev)
773 msg = devfs_msg_get();
774 msg->mdv_udev = udev;
775 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_UDEV, msg);
776 found = msg->mdv_cdev;
779 devfs_debug(DEVFS_DEBUG_DEBUG,
780 "devfs_find_device_by_udev found? %s -end:3-\n",
781 ((found) ? found->si_name:"NO"));
786 * devfs_make_alias is the asynchronous entry point to register an alias
787 * for a device. It just sends a message with the relevant details to the
791 devfs_make_alias(char *name, cdev_t dev_target)
793 struct devfs_alias *alias;
795 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
796 memcpy(alias->name, name, strlen(name) + 1);
797 alias->dev_target = dev_target;
799 devfs_msg_send_generic(DEVFS_MAKE_ALIAS, alias);
804 * devfs_apply_rules is the asynchronous entry point to trigger application
805 * of all rules. It just sends a message with the relevant details to the
809 devfs_apply_rules(char *mntto)
814 namelen = strlen(mntto) + 1;
816 new_name = kmalloc(namelen, M_DEVFS, M_WAITOK);
818 memcpy(new_name, mntto, namelen);
820 devfs_msg_send_name(DEVFS_APPLY_RULES, new_name);
825 * devfs_reset_rules is the asynchronous entry point to trigger reset of all rules.
826 * It just sends a message with the relevant details to the devfs core.
829 devfs_reset_rules(char *mntto)
834 namelen = strlen(mntto) + 1;
836 new_name = kmalloc(namelen, M_DEVFS, M_WAITOK);
838 memcpy(new_name, mntto, namelen);
840 devfs_msg_send_name(DEVFS_RESET_RULES, new_name);
846 * devfs_scan_callback is the asynchronous entry point to call a callback
848 * It just sends a message with the relevant details to the devfs core.
851 devfs_scan_callback(devfs_scan_t *callback)
855 /* Make sure that function pointers have the size of a generic pointer (innecessary) */
856 KKASSERT(sizeof(callback) == sizeof(void *));
858 msg = devfs_msg_get();
859 msg->mdv_load = callback;
860 msg = devfs_msg_send_sync(DEVFS_SCAN_CALLBACK, msg);
868 * Acts as a message drain. Any message that is replied to here gets destroyed and
872 devfs_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
874 devfs_msg_put((devfs_msg_t)msg);
878 * devfs_msg_get allocates a new devfs msg and returns it.
883 return objcache_get(devfs_msg_cache, M_WAITOK);
887 * devfs_msg_put deallocates a given devfs msg.
890 devfs_msg_put(devfs_msg_t msg)
892 objcache_put(devfs_msg_cache, msg);
897 * devfs_msg_send is the generic asynchronous message sending facility
898 * for devfs. By default the reply port is the automatic disposal port.
901 devfs_msg_send(uint32_t cmd, devfs_msg_t devfs_msg)
903 lwkt_port_t port = &devfs_msg_port;
905 lwkt_initmsg(&devfs_msg->hdr, &devfs_dispose_port, 0);
907 devfs_msg->hdr.u.ms_result = cmd;
908 devfs_msg->id = atomic_fetchadd_int(&msg_id, 1);
910 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
912 return devfs_msg->id;
916 * devfs_msg_send_sync is the generic synchronous message sending
917 * facility for devfs. It initializes a local reply port and waits
918 * for the core's answer. This answer is then returned.
921 devfs_msg_send_sync(uint32_t cmd, devfs_msg_t devfs_msg)
923 struct lwkt_port rep_port;
924 devfs_msg_t msg_incoming;
925 lwkt_port_t port = &devfs_msg_port;
927 lwkt_initport_thread(&rep_port, curthread);
928 lwkt_initmsg(&devfs_msg->hdr, &rep_port, 0);
930 devfs_msg->hdr.u.ms_result = cmd;
931 devfs_msg->id = atomic_fetchadd_int(&msg_id, 1);
933 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
934 msg_incoming = lwkt_waitport(&rep_port, 0);
940 * sends a message with a generic argument.
943 devfs_msg_send_generic(uint32_t cmd, void *load)
945 devfs_msg_t devfs_msg = devfs_msg_get();
946 devfs_msg->mdv_load = load;
948 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_send_generic -1- (%p)\n", load);
950 return devfs_msg_send(cmd, devfs_msg);
954 * sends a message with a name argument.
957 devfs_msg_send_name(uint32_t cmd, char *name)
959 devfs_msg_t devfs_msg = devfs_msg_get();
960 devfs_msg->mdv_name = name;
962 return devfs_msg_send(cmd, devfs_msg);
966 * sends a message with a mount argument.
969 devfs_msg_send_mount(uint32_t cmd, struct devfs_mnt_data *mnt)
971 devfs_msg_t devfs_msg = devfs_msg_get();
972 devfs_msg->mdv_mnt = mnt;
974 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_send_mp -1- (%p)\n", mnt);
976 return devfs_msg_send(cmd, devfs_msg);
980 * sends a message with an ops argument.
983 devfs_msg_send_ops(uint32_t cmd, struct dev_ops *ops, int minor)
985 devfs_msg_t devfs_msg = devfs_msg_get();
986 devfs_msg->mdv_ops.ops = ops;
987 devfs_msg->mdv_ops.minor = minor;
989 return devfs_msg_send(cmd, devfs_msg);
993 * sends a message with a clone handler argument.
996 devfs_msg_send_chandler(uint32_t cmd, char *name, d_clone_t handler)
998 devfs_msg_t devfs_msg = devfs_msg_get();
999 devfs_msg->mdv_chandler.name = name;
1000 devfs_msg->mdv_chandler.nhandler = handler;
1002 return devfs_msg_send(cmd, devfs_msg);
1006 * sends a message with a device argument.
1009 devfs_msg_send_dev(uint32_t cmd, cdev_t dev, uid_t uid, gid_t gid, int perms)
1011 devfs_msg_t devfs_msg = devfs_msg_get();
1012 devfs_msg->mdv_dev.dev = dev;
1013 devfs_msg->mdv_dev.uid = uid;
1014 devfs_msg->mdv_dev.gid = gid;
1015 devfs_msg->mdv_dev.perms = perms;
1017 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_send_dev -1- (%p)\n", dev);
1019 return devfs_msg_send(cmd, devfs_msg);
1023 * sends a message with a link argument.
1026 devfs_msg_send_link(uint32_t cmd, char *name, char *target, struct mount *mp)
1028 devfs_msg_t devfs_msg = devfs_msg_get();
1029 devfs_msg->mdv_link.name = name;
1030 devfs_msg->mdv_link.target = target;
1031 devfs_msg->mdv_link.mp = mp;
1034 return devfs_msg_send(cmd, devfs_msg);
1038 * devfs_msg_core is the main devfs thread. It handles all incoming messages
1039 * and calls the relevant worker functions. By using messages it's assured
1040 * that events occur in the correct order.
1043 devfs_msg_core(void *arg)
1048 struct devfs_mnt_data *mnt;
1049 struct devfs_node *node;
1051 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_core -1-\n");
1052 lwkt_initport_thread(&devfs_msg_port, curthread);
1053 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_core -2-\n");
1054 wakeup(td_core/*devfs_id*/);
1055 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_core -3-\n");
1058 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_core -loop:4-\n");
1059 msg = (devfs_msg_t)lwkt_waitport(&devfs_msg_port, 0);
1060 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_core, new msg: %x (unique id: %x)\n", (unsigned int)msg->hdr.u.ms_result, msg->id);
1061 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1062 switch (msg->hdr.u.ms_result) {
1064 case DEVFS_DEVICE_CREATE:
1065 dev = msg->mdv_dev.dev;
1066 devfs_debug(DEVFS_DEBUG_DEBUG,
1067 "devfs_msg_core device create msg %s(%p)\n",
1069 devfs_create_dev_worker(dev,
1072 msg->mdv_dev.perms);
1075 case DEVFS_DEVICE_DESTROY:
1076 devfs_debug(DEVFS_DEBUG_DEBUG,
1077 "devfs_msg_core device destroy msg\n");
1078 dev = msg->mdv_dev.dev;
1079 devfs_destroy_dev_worker(dev);
1082 case DEVFS_DESTROY_SUBNAMES:
1083 devfs_destroy_subnames_worker(msg->mdv_load);
1086 case DEVFS_DESTROY_DEV_BY_OPS:
1087 devfs_destroy_dev_by_ops_worker(msg->mdv_ops.ops,
1088 msg->mdv_ops.minor);
1091 case DEVFS_CREATE_ALL_DEV:
1092 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_msg_core device create ALL msg\n");
1093 node = (struct devfs_node *)msg->mdv_load;
1094 devfs_create_all_dev_worker(node);
1097 case DEVFS_MOUNT_ADD:
1099 TAILQ_INSERT_TAIL(&devfs_mnt_list, mnt, link);
1100 devfs_create_all_dev_worker(mnt->root_node);
1103 case DEVFS_MOUNT_DEL:
1105 TAILQ_REMOVE(&devfs_mnt_list, mnt, link);
1106 devfs_reaperp(mnt->root_node);
1107 if (mnt->leak_count) {
1108 devfs_debug(DEVFS_DEBUG_SHOW,
1109 "Leaked %d devfs_node elements!\n",
1114 case DEVFS_CHANDLER_ADD:
1115 devfs_chandler_add_worker(msg->mdv_chandler.name, msg->mdv_chandler.nhandler);
1118 case DEVFS_CHANDLER_DEL:
1119 devfs_chandler_del_worker(msg->mdv_chandler.name);
1122 case DEVFS_FIND_DEVICE_BY_NAME:
1123 devfs_find_device_by_name_worker(msg);
1126 case DEVFS_FIND_DEVICE_BY_UDEV:
1127 devfs_find_device_by_udev_worker(msg);
1130 case DEVFS_MAKE_ALIAS:
1131 devfs_make_alias_worker((struct devfs_alias *)msg->mdv_load);
1134 case DEVFS_APPLY_RULES:
1135 devfs_apply_reset_rules_caller(msg->mdv_name, 1);
1138 case DEVFS_RESET_RULES:
1139 devfs_apply_reset_rules_caller(msg->mdv_name, 0);
1142 case DEVFS_SCAN_CALLBACK:
1143 devfs_scan_callback_worker((devfs_scan_t *)msg->mdv_load);
1146 case DEVFS_CLR_SUBNAMES_FLAG:
1147 devfs_clr_subnames_flag_worker(msg->mdv_flags.name,
1148 msg->mdv_flags.flag);
1151 case DEVFS_DESTROY_SUBNAMES_WO_FLAG:
1152 devfs_destroy_subnames_without_flag_worker(msg->mdv_flags.name,
1153 msg->mdv_flags.flag);
1156 case DEVFS_TERMINATE_CORE:
1162 devfs_debug(DEVFS_DEBUG_DEBUG,
1163 "devfs_msg_core: unknown message "
1164 "received at core\n");
1167 lockmgr(&devfs_lock, LK_RELEASE);
1169 lwkt_replymsg((lwkt_msg_t)msg, 0);
1171 wakeup(td_core/*devfs_id*/);
1176 * Worker function to insert a new dev into the dev list and initialize its
1177 * permissions. It also calls devfs_propagate_dev which in turn propagates
1178 * the change to all mount points.
1180 * The passed dev is already referenced. This reference is eaten by this
1181 * function and represents the dev's linkage into devfs_dev_list.
1184 devfs_create_dev_worker(cdev_t dev, uid_t uid, gid_t gid, int perms)
1187 devfs_debug(DEVFS_DEBUG_DEBUG,
1188 "devfs_create_dev_worker -1- -%s- (%p)\n",
1193 dev->si_perms = perms;
1195 devfs_link_dev(dev);
1196 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_dev_worker -2-\n");
1197 devfs_propagate_dev(dev, 1);
1199 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_dev_worker -end:3-\n");
1204 * Worker function to delete a dev from the dev list and free the cdev.
1205 * It also calls devfs_propagate_dev which in turn propagates the change
1206 * to all mount points.
1209 devfs_destroy_dev_worker(cdev_t dev)
1214 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1216 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_destroy_dev_worker -1- %s\n", dev->si_name);
1217 error = devfs_unlink_dev(dev);
1218 devfs_propagate_dev(dev, 0);
1220 release_dev(dev); /* link ref */
1224 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_destroy_dev_worker -end:5-\n");
1229 * Worker function to destroy all devices with a certain basename.
1230 * Calls devfs_destroy_dev_worker for the actual destruction.
1233 devfs_destroy_subnames_worker(char *name)
1236 size_t len = strlen(name);
1238 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1239 if (!strncmp(dev->si_name, name, len)) {
1240 if (dev->si_name[len] != '\0') {
1241 devfs_destroy_dev_worker(dev);
1242 /* release_dev(dev); */
1250 devfs_clr_subnames_flag_worker(char *name, uint32_t flag)
1253 size_t len = strlen(name);
1255 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1256 if (!strncmp(dev->si_name, name, len)) {
1257 if (dev->si_name[len] != '\0') {
1258 dev->si_flags &= ~flag;
1267 devfs_destroy_subnames_without_flag_worker(char *name, uint32_t flag)
1270 size_t len = strlen(name);
1272 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1273 if (!strncmp(dev->si_name, name, len)) {
1274 if (dev->si_name[len] != '\0') {
1275 if (!(dev->si_flags & flag)) {
1276 devfs_destroy_dev_worker(dev);
1286 * Worker function that creates all device nodes on top of a devfs
1290 devfs_create_all_dev_worker(struct devfs_node *root)
1295 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_all_dev_worker -1-\n");
1297 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1298 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_all_dev_worker -loop:2- -%s-\n", dev->si_name);
1299 devfs_create_device_node(root, dev, NULL, NULL);
1301 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_all_dev_worker -end:3-\n");
1306 * Worker function that destroys all devices that match a specific
1307 * dev_ops and/or minor. If minor is less than 0, it is not matched
1308 * against. It also propagates all changes.
1311 devfs_destroy_dev_by_ops_worker(struct dev_ops *ops, int minor)
1316 devfs_debug(DEVFS_DEBUG_DEBUG,
1317 "devfs_destroy_dev_by_ops_worker -1-\n");
1319 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1320 if (dev->si_ops != ops)
1322 if ((minor < 0) || (dev->si_uminor == minor)) {
1323 devfs_debug(DEVFS_DEBUG_DEBUG,
1324 "devfs_destroy_dev_by_ops_worker "
1327 devfs_destroy_dev_worker(dev);
1330 devfs_debug(DEVFS_DEBUG_DEBUG,
1331 "devfs_destroy_dev_by_ops_worker -end:3-\n");
1336 * Worker function that registers a new clone handler in devfs.
1339 devfs_chandler_add_worker(char *name, d_clone_t *nhandler)
1341 struct devfs_clone_handler *chandler = NULL;
1342 u_char len = strlen(name);
1347 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
1348 if (chandler->namlen == len) {
1349 if (!memcmp(chandler->name, name, len)) {
1350 /* Clonable basename already exists */
1356 chandler = kmalloc(sizeof(*chandler), M_DEVFS, M_WAITOK | M_ZERO);
1357 memcpy(chandler->name, name, len+1);
1358 chandler->namlen = len;
1359 chandler->nhandler = nhandler;
1361 TAILQ_INSERT_TAIL(&devfs_chandler_list, chandler, link);
1366 * Worker function that removes a given clone handler from the
1367 * clone handler list.
1370 devfs_chandler_del_worker(char *name)
1372 struct devfs_clone_handler *chandler, *chandler2;
1373 u_char len = strlen(name);
1378 TAILQ_FOREACH_MUTABLE(chandler, &devfs_chandler_list, link, chandler2) {
1379 if (chandler->namlen != len)
1381 if (memcmp(chandler->name, name, len))
1383 TAILQ_REMOVE(&devfs_chandler_list, chandler, link);
1384 kfree(chandler, M_DEVFS);
1391 * Worker function that finds a given device name and changes
1392 * the message received accordingly so that when replied to,
1393 * the answer is returned to the caller.
1396 devfs_find_device_by_name_worker(devfs_msg_t devfs_msg)
1399 cdev_t found = NULL;
1401 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1402 if (!strcmp(devfs_msg->mdv_name, dev->si_name)) {
1407 devfs_msg->mdv_cdev = found;
1413 * Worker function that finds a given device udev and changes
1414 * the message received accordingly so that when replied to,
1415 * the answer is returned to the caller.
1418 devfs_find_device_by_udev_worker(devfs_msg_t devfs_msg)
1421 cdev_t found = NULL;
1423 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1424 if (((udev_t)dev->si_inode) == devfs_msg->mdv_udev) {
1429 devfs_msg->mdv_cdev = found;
1435 * Worker function that inserts a given alias into the
1436 * alias list, and propagates the alias to all mount
1440 devfs_make_alias_worker(struct devfs_alias *alias)
1442 struct devfs_alias *alias2;
1443 size_t len = strlen(alias->name);
1446 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1447 if (!memcmp(alias->name, alias2->name, len)) {
1454 TAILQ_INSERT_TAIL(&devfs_alias_list, alias, link);
1455 devfs_alias_propagate(alias);
1457 devfs_debug(DEVFS_DEBUG_DEBUG,
1458 "Warning: duplicate devfs_make_alias for %s\n",
1460 kfree(alias, M_DEVFS);
1467 * Function that removes and frees all aliases.
1470 devfs_alias_reap(void)
1472 struct devfs_alias *alias, *alias2;
1474 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1475 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1476 kfree(alias, M_DEVFS);
1482 * Function that removes an alias matching a specific cdev and frees
1486 devfs_alias_remove(cdev_t dev)
1488 struct devfs_alias *alias, *alias2;
1490 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1491 if (alias->dev_target == dev) {
1492 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1493 kfree(alias, M_DEVFS);
1500 * This function propagates a new alias to all mount points.
1503 devfs_alias_propagate(struct devfs_alias *alias)
1505 struct devfs_mnt_data *mnt;
1507 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1508 devfs_alias_apply(mnt->root_node, alias);
1514 * This function is a recursive function iterating through
1515 * all device nodes in the topology and, if applicable,
1516 * creating the relevant alias for a device node.
1519 devfs_alias_apply(struct devfs_node *node, struct devfs_alias *alias)
1521 struct devfs_node *node1, *node2;
1523 KKASSERT(alias != NULL);
1525 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
1526 devfs_debug(DEVFS_DEBUG_DEBUG, "This node is Pdir or Proot; has %d children\n", node->nchildren);
1527 if (node->nchildren > 2) {
1528 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1529 devfs_alias_apply(node1, alias);
1533 if (node->d_dev == alias->dev_target)
1534 devfs_alias_create(alias->name, node);
1540 * This function checks if any alias possibly is applicable
1541 * to the given node. If so, the alias is created.
1544 devfs_alias_check_create(struct devfs_node *node)
1546 struct devfs_alias *alias;
1548 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1549 if (node->d_dev == alias->dev_target)
1550 devfs_alias_create(alias->name, node);
1556 * This function creates an alias with a given name
1557 * linking to a given devfs node. It also increments
1558 * the link count on the target node.
1561 devfs_alias_create(char *name_orig, struct devfs_node *target)
1563 struct mount *mp = target->mp;
1564 struct devfs_node *parent = DEVFS_MNTDATA(mp)->root_node;
1565 struct devfs_node *linknode;
1566 char *create_path = NULL;
1567 char *name, name_buf[PATH_MAX];
1569 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1571 devfs_resolve_name_path(name_orig, name_buf, &create_path, &name);
1574 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1577 if (devfs_find_device_node_by_name(parent, name)) {
1578 devfs_debug(DEVFS_DEBUG_DEBUG,
1579 "Node already exists: %s "
1580 "(devfs_make_alias_worker)!\n",
1586 linknode = devfs_allocp(Plink, name, parent, mp, NULL);
1587 if (linknode == NULL)
1590 linknode->link_target = target;
1593 linknode->flags |= DEVFS_LINK;
1600 * This function is called by the core and handles mount point
1601 * strings. It either calls the relevant worker (devfs_apply_
1602 * reset_rules_worker) on all mountpoints or only a specific
1606 devfs_apply_reset_rules_caller(char *mountto, int apply)
1608 struct devfs_mnt_data *mnt;
1609 size_t len = strlen(mountto);
1611 if (mountto[0] != '*') {
1612 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1613 if ((len == mnt->mntonnamelen) &&
1614 (!memcmp(mnt->mp->mnt_stat.f_mntonname, mountto, len))) {
1615 devfs_apply_reset_rules_worker(mnt->root_node, apply);
1620 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1621 devfs_apply_reset_rules_worker(mnt->root_node, apply);
1625 kfree(mountto, M_DEVFS);
1630 * This worker function applies or resets, depending on the arguments, a rule
1631 * to the whole given topology. *RECURSIVE*
1634 devfs_apply_reset_rules_worker(struct devfs_node *node, int apply)
1636 struct devfs_node *node1, *node2;
1638 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
1639 devfs_debug(DEVFS_DEBUG_DEBUG, "This node is Pdir or Proot; has %d children\n", node->nchildren);
1640 if (node->nchildren > 2) {
1641 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1642 devfs_apply_reset_rules_worker(node1, apply);
1648 devfs_rule_check_apply(node);
1650 devfs_rule_reset_node(node);
1657 * This function calls a given callback function for
1658 * every dev node in the devfs dev list.
1661 devfs_scan_callback_worker(devfs_scan_t *callback)
1665 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_scan_callback: %p -1-\n", callback);
1667 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1671 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_scan_callback: finished\n");
1677 * This function tries to resolve a given directory, or if not
1678 * found and creation requested, creates the given directory.
1680 static struct devfs_node *
1681 devfs_resolve_or_create_dir(struct devfs_node *parent, char *dir_name,
1682 size_t name_len, int create)
1684 struct devfs_node *node, *found = NULL;
1686 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1687 if (name_len == node->d_dir.d_namlen) {
1688 if (!memcmp(dir_name, node->d_dir.d_name, name_len)) {
1695 if ((found == NULL) && (create)) {
1696 found = devfs_allocp(Pdir, dir_name, parent, parent->mp, NULL);
1703 * This function tries to resolve a complete path. If creation is requested,
1704 * if a given part of the path cannot be resolved (because it doesn't exist),
1708 devfs_resolve_or_create_path(struct devfs_node *parent, char *path, int create)
1710 struct devfs_node *node = parent;
1719 for (; *path != '\0' ; path++) {
1724 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1731 return devfs_resolve_or_create_dir(node, buf, idx, create);
1735 * Takes a full path and strips it into a directory path and a name.
1736 * For a/b/c/foo, it returns foo in namep and a/b/c in pathp. It
1737 * requires a working buffer with enough size to keep the whole
1741 devfs_resolve_name_path(char *fullpath, char *buf, char **pathp, char **namep)
1745 size_t len = strlen(fullpath) + 1;
1748 KKASSERT((fullpath != NULL) && (buf != NULL) && (pathp != NULL) && (namep != NULL));
1750 memcpy(buf, fullpath, len);
1752 for (i = len-1; i>= 0; i--) {
1753 if (buf[i] == '/') {
1773 * This function creates a new devfs node for a given device. It can
1774 * handle a complete path as device name, and accordingly creates
1775 * the path and the final device node.
1777 * The reference count on the passed dev remains unchanged.
1780 devfs_create_device_node(struct devfs_node *root, cdev_t dev,
1781 char *dev_name, char *path_fmt, ...)
1783 struct devfs_node *parent, *node = NULL;
1785 char *name, name_buf[PATH_MAX];
1789 char *create_path = NULL;
1790 char *names = "pqrsPQRS";
1792 if (path_fmt != NULL) {
1793 path = kmalloc(PATH_MAX+1, M_DEVFS, M_WAITOK);
1795 __va_start(ap, path_fmt);
1796 i = kvcprintf(path_fmt, NULL, path, 10, ap);
1801 parent = devfs_resolve_or_create_path(root, path, 1);
1804 devfs_resolve_name_path(((dev_name == NULL) && (dev))?(dev->si_name):(dev_name), name_buf, &create_path, &name);
1807 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1810 if (devfs_find_device_node_by_name(parent, name)) {
1811 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_device_node: "
1812 "DEVICE %s ALREADY EXISTS!!! Ignoring creation request.\n", name);
1815 devfs_debug(DEVFS_DEBUG_DEBUG, "parent->d_dir.d_name=%s\n", parent->d_dir.d_name);
1816 node = devfs_allocp(Pdev, name, parent, parent->mp, dev);
1817 devfs_debug(DEVFS_DEBUG_DEBUG, "node->d_dir.d_name=%s\n", node->d_dir.d_name);
1820 /* Ugly unix98 pty magic, to hide pty master (ptm) devices and their directory */
1821 if ((dev) && (strlen(dev->si_name) >= 4) && (!memcmp(dev->si_name, "ptm/", 4))) {
1822 node->parent->flags |= DEVFS_HIDDEN;
1823 node->flags |= DEVFS_HIDDEN;
1826 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_device_node: marker A\n");
1827 /* Ugly pty magic, to tag pty devices as such and hide them if needed */
1828 if ((strlen(name) >= 3) && (!memcmp(name, "pty", 3)))
1829 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1831 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_device_node: marker B\n");
1832 if ((strlen(name) >= 3) && (!memcmp(name, "tty", 3))) {
1834 for (i = 0; i < strlen(names); i++) {
1835 if (name[3] == names[i]) {
1841 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1843 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_create_device_node: marker C\n");
1846 if (path_fmt != NULL)
1847 kfree(path, M_DEVFS);
1853 * This function finds a given device node in the topology with a given
1857 devfs_find_device_node(struct devfs_node *node, cdev_t target)
1859 struct devfs_node *node1, *node2, *found = NULL;
1861 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
1862 devfs_debug(DEVFS_DEBUG_DEBUG, "This node is Pdir or Proot; has %d children\n", node->nchildren);
1863 if (node->nchildren > 2) {
1864 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1865 if ((found = devfs_find_device_node(node1, target)))
1869 } else if (node->node_type == Pdev) {
1870 if (node->d_dev == target)
1878 * This function finds a device node in the topology by its
1879 * name and returns it.
1882 devfs_find_device_node_by_name(struct devfs_node *parent, char *target)
1884 struct devfs_node *node, *found = NULL;
1885 size_t len = strlen(target);
1887 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1888 if ((len == node->d_dir.d_namlen) && (!memcmp(node->d_dir.d_name, target, len))) {
1898 * This function takes a cdev and removes its devfs node in the
1899 * given topology. The cdev remains intact.
1902 devfs_destroy_device_node(struct devfs_node *root, cdev_t target)
1904 struct devfs_node *node, *parent;
1905 char *name, name_buf[PATH_MAX];
1906 char *create_path = NULL;
1910 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_destroy_device_node\n");
1911 memcpy(name_buf, target->si_name, strlen(target->si_name)+1);
1913 devfs_resolve_name_path(target->si_name, name_buf, &create_path, &name);
1914 devfs_debug(DEVFS_DEBUG_DEBUG, "create_path: %s\n", create_path);
1915 devfs_debug(DEVFS_DEBUG_DEBUG, "name: %s\n", name);
1918 parent = devfs_resolve_or_create_path(root, create_path, 0);
1921 devfs_debug(DEVFS_DEBUG_DEBUG, "-> marker <-\n");
1924 devfs_debug(DEVFS_DEBUG_DEBUG, "->d_dir.d_name=%s\n", parent->d_dir.d_name);
1925 node = devfs_find_device_node_by_name(parent, name);
1926 devfs_debug(DEVFS_DEBUG_DEBUG,
1927 "->d_dir.d_name=%s\n",
1928 ((node) ? (node->d_dir.d_name) : "SHIT!"));
1936 * Just set perms and ownership for given node.
1939 devfs_set_perms(struct devfs_node *node, uid_t uid, gid_t gid, u_short mode, u_long flags)
1941 node->mode = mode; /* files access mode and type */
1942 node->uid = uid; /* owner user id */
1943 node->gid = gid; /* owner group id */
1949 * Propagates a device attach/detach to all mount
1950 * points. Also takes care of automatic alias removal
1951 * for a deleted cdev.
1954 devfs_propagate_dev(cdev_t dev, int attach)
1956 struct devfs_mnt_data *mnt;
1958 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_propagate_dev -1-\n");
1959 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1960 devfs_debug(DEVFS_DEBUG_DEBUG,
1961 "devfs_propagate_dev -loop:2-\n");
1963 /* Device is being attached */
1964 devfs_create_device_node(mnt->root_node, dev,
1967 /* Device is being detached */
1968 devfs_alias_remove(dev);
1969 devfs_destroy_device_node(mnt->root_node, dev);
1972 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_propagate_dev -end:3-\n");
1977 * devfs_node_to_path takes a node and a buffer of a size of
1978 * at least PATH_MAX, resolves the full path from the root
1979 * node and writes it in a humanly-readable format into the
1981 * If DEVFS_STASH_DEPTH is less than the directory level up
1982 * to the root node, only the last DEVFS_STASH_DEPTH levels
1983 * of the path are resolved.
1986 devfs_node_to_path(struct devfs_node *node, char *buffer)
1988 #define DEVFS_STASH_DEPTH 32
1989 struct devfs_node *node_stash[DEVFS_STASH_DEPTH];
1991 memset(buffer, 0, PATH_MAX);
1993 for (i = 0; (i < DEVFS_STASH_DEPTH) && (node->node_type != Proot); i++) {
1994 node_stash[i] = node;
1995 node = node->parent;
1999 for (offset = 0; i >= 0; i--) {
2000 memcpy(buffer+offset, node_stash[i]->d_dir.d_name, node_stash[i]->d_dir.d_namlen);
2001 offset += node_stash[i]->d_dir.d_namlen;
2003 *(buffer+offset) = '/';
2007 #undef DEVFS_STASH_DEPTH
2012 * devfs_clone either returns a basename from a complete name by
2013 * returning the length of the name without trailing digits, or,
2014 * if clone != 0, calls the device's clone handler to get a new
2015 * device, which in turn is returned in devp.
2018 devfs_clone(char *name, size_t *namlenp, cdev_t *devp, int clone, struct ucred *cred)
2022 size_t len = *namlenp;
2024 struct devfs_clone_handler *chandler;
2025 struct dev_clone_args ap;
2028 for (; (len > 0) && (DEVFS_ISDIGIT(name[len-1])); len--);
2031 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
2032 devfs_debug(DEVFS_DEBUG_DEBUG, "len=%d, chandler->namlen=%d\n", len, chandler->namlen);
2033 devfs_debug(DEVFS_DEBUG_DEBUG, "name=%s, chandler->name=%s\n", name, chandler->name);
2034 if ((chandler->namlen == len) &&
2035 (!memcmp(chandler->name, name, len)) &&
2036 (chandler->nhandler)) {
2037 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_nclone: found clone handler for the base name at %p\n", chandler->nhandler);
2043 error = (chandler->nhandler)(&ap);
2060 * Registers a new orphan in the orphan list.
2063 devfs_tracer_add_orphan(struct devfs_node *node)
2065 struct devfs_orphan *orphan;
2068 orphan = kmalloc(sizeof(struct devfs_orphan), M_DEVFS, M_WAITOK);
2069 orphan->node = node;
2071 KKASSERT((node->flags & DEVFS_ORPHANED) == 0);
2072 node->flags |= DEVFS_ORPHANED;
2073 TAILQ_INSERT_TAIL(DEVFS_ORPHANLIST(node->mp), orphan, link);
2077 * Removes an orphan from the orphan list.
2080 devfs_tracer_del_orphan(struct devfs_node *node)
2082 struct devfs_orphan *orphan;
2086 TAILQ_FOREACH(orphan, DEVFS_ORPHANLIST(node->mp), link) {
2087 if (orphan->node == node) {
2088 node->flags &= ~DEVFS_ORPHANED;
2089 TAILQ_REMOVE(DEVFS_ORPHANLIST(node->mp), orphan, link);
2090 kfree(orphan, M_DEVFS);
2097 * Counts the orphans in the orphan list, and if cleanup
2098 * is specified, also frees the orphan and removes it from
2102 devfs_tracer_orphan_count(struct mount *mp, int cleanup)
2104 struct devfs_orphan *orphan, *orphan2;
2107 TAILQ_FOREACH_MUTABLE(orphan, DEVFS_ORPHANLIST(mp), link, orphan2) {
2110 TAILQ_REMOVE(DEVFS_ORPHANLIST(mp), orphan, link);
2111 orphan->node->flags &= ~DEVFS_ORPHANED;
2112 devfs_freep(orphan->node);
2113 kfree(orphan, M_DEVFS);
2121 * Fetch an ino_t from the global d_ino by increasing it
2125 devfs_fetch_ino(void)
2129 spin_lock_wr(&ino_lock);
2131 spin_unlock_wr(&ino_lock);
2137 * Allocates a new cdev and initializes it's most basic
2141 devfs_new_cdev(struct dev_ops *ops, int minor)
2143 cdev_t dev = sysref_alloc(&cdev_sysref_class);
2144 sysref_activate(&dev->si_sysref);
2146 devfs_debug(DEVFS_DEBUG_DEBUG,
2147 "new_cdev: clearing first %d bytes\n",
2148 offsetof(struct cdev, si_sysref));
2149 memset(dev, 0, offsetof(struct cdev, si_sysref));
2154 dev->si_drv1 = NULL;
2155 dev->si_drv2 = NULL;
2156 dev->si_lastread = 0; /* time_second */
2157 dev->si_lastwrite = 0; /* time_second */
2162 dev->si_uminor = minor;
2163 dev->si_inode = makeudev(devfs_reference_ops(ops), minor);
2169 devfs_cdev_terminate(cdev_t dev)
2173 /* Check if it is locked already. if not, we acquire the devfs lock */
2174 if (!(lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE) {
2175 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2179 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_cdev_terminate: Taking care of dev->si_name=%s\n", dev->si_name);
2181 /* Propagate destruction, just in case */
2182 devfs_propagate_dev(dev, 0);
2184 /* If we acquired the lock, we also get rid of it */
2186 lockmgr(&devfs_lock, LK_RELEASE);
2188 devfs_release_ops(dev->si_ops);
2190 /* Finally destroy the device */
2191 sysref_put(&dev->si_sysref);
2195 * Links a given cdev into the dev list.
2198 devfs_link_dev(cdev_t dev)
2200 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2201 dev->si_flags |= SI_DEVFS_LINKED;
2202 TAILQ_INSERT_TAIL(&devfs_dev_list, dev, link);
2208 * Removes a given cdev from the dev list. The caller is responsible for
2209 * releasing the reference on the device associated with the linkage.
2211 * Returns EALREADY if the dev has already been unlinked.
2214 devfs_unlink_dev(cdev_t dev)
2216 if ((dev->si_flags & SI_DEVFS_LINKED)) {
2217 TAILQ_REMOVE(&devfs_dev_list, dev, link);
2218 dev->si_flags &= ~SI_DEVFS_LINKED;
2225 devfs_node_is_accessible(struct devfs_node *node)
2227 if ((node) && (!(node->flags & DEVFS_HIDDEN)))
2234 devfs_reference_ops(struct dev_ops *ops)
2238 if (ops->head.refs == 0) {
2239 ops->head.id = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(ops_id), 255);
2240 if (ops->head.id == -1) {
2241 /* Ran out of unique ids */
2242 kprintf("devfs_reference_ops: WARNING: ran out of unique ids\n");
2245 unit = ops->head.id;
2252 devfs_release_ops(struct dev_ops *ops)
2256 if (ops->head.refs == 0) {
2257 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(ops_id), ops->head.id);
2262 devfs_config(void *arg)
2266 msg = devfs_msg_get();
2268 kprintf("devfs_config: sync'ing up\n");
2269 msg = devfs_msg_send_sync(DEVFS_SYNC, msg);
2274 * Called on init of devfs; creates the objcaches and
2275 * spawns off the devfs core thread. Also initializes
2281 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init() called\n");
2282 /* Create objcaches for nodes, msgs and devs */
2283 devfs_node_cache = objcache_create("devfs-node-cache", 0, 0,
2285 objcache_malloc_alloc,
2286 objcache_malloc_free,
2287 &devfs_node_malloc_args );
2289 devfs_msg_cache = objcache_create("devfs-msg-cache", 0, 0,
2291 objcache_malloc_alloc,
2292 objcache_malloc_free,
2293 &devfs_msg_malloc_args );
2295 devfs_dev_cache = objcache_create("devfs-dev-cache", 0, 0,
2297 objcache_malloc_alloc,
2298 objcache_malloc_free,
2299 &devfs_dev_malloc_args );
2301 devfs_clone_bitmap_init(&DEVFS_CLONE_BITMAP(ops_id));
2303 devfs_clone_bitmap_set(&DEVFS_CLONE_BITMAP(ops_id), 0);
2306 /* Initialize the reply-only port which acts as a message drain */
2307 lwkt_initport_replyonly(&devfs_dispose_port, devfs_msg_autofree_reply);
2309 /* Initialize *THE* devfs lock */
2310 lockinit(&devfs_lock, "devfs_core lock", 0, 0);
2313 lwkt_create(devfs_msg_core, /*args*/NULL, &td_core, NULL,
2314 0, 0, "devfs_msg_core");
2316 tsleep(td_core/*devfs_id*/, 0, "devfsc", 0);
2318 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init finished\n");
2322 * Called on unload of devfs; takes care of destroying the core
2323 * and the objcaches. Also removes aliases that are no longer needed.
2328 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_uninit() called\n");
2330 devfs_msg_send(DEVFS_TERMINATE_CORE, NULL);
2332 tsleep(td_core/*devfs_id*/, 0, "devfsc", 0);
2333 tsleep(td_core/*devfs_id*/, 0, "devfsc", 10000);
2335 devfs_clone_bitmap_uninit(&DEVFS_CLONE_BITMAP(ops_id));
2337 /* Destroy the objcaches */
2338 objcache_destroy(devfs_msg_cache);
2339 objcache_destroy(devfs_node_cache);
2340 objcache_destroy(devfs_dev_cache);
2346 * This is a sysctl handler to assist userland devname(3) to
2347 * find the device name for a given udev.
2350 devfs_sysctl_devname_helper(SYSCTL_HANDLER_ARGS)
2357 if ((error = SYSCTL_IN(req, &udev, sizeof(udev_t))))
2360 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs sysctl, received udev: %d\n", udev);
2365 if ((found = devfs_find_device_by_udev(udev)) == NULL)
2368 return(SYSCTL_OUT(req, found->si_name, strlen(found->si_name) + 1));
2372 SYSCTL_PROC(_kern, OID_AUTO, devname, CTLTYPE_OPAQUE|CTLFLAG_RW|CTLFLAG_ANYBODY,
2373 NULL, 0, devfs_sysctl_devname_helper, "", "helper for devname(3)");
2375 static SYSCTL_NODE(_vfs, OID_AUTO, devfs, CTLFLAG_RW, 0, "devfs");
2376 TUNABLE_INT("vfs.devfs.debug", &devfs_debug_enable);
2377 SYSCTL_INT(_vfs_devfs, OID_AUTO, debug, CTLFLAG_RW, &devfs_debug_enable, 0, "Enable DevFS debugging");
2379 SYSINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST, devfs_init, NULL);
2380 SYSUNINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY, devfs_uninit, NULL);