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 <sys/devfs.h>
50 #include <sys/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 =
84 TAILQ_HEAD_INITIALIZER(devfs_dev_list);
85 static struct devfs_mnt_head devfs_mnt_list =
86 TAILQ_HEAD_INITIALIZER(devfs_mnt_list);
87 static struct devfs_chandler_head devfs_chandler_list =
88 TAILQ_HEAD_INITIALIZER(devfs_chandler_list);
89 static struct devfs_alias_head devfs_alias_list =
90 TAILQ_HEAD_INITIALIZER(devfs_alias_list);
91 static struct devfs_dev_ops_head devfs_dev_ops_list =
92 TAILQ_HEAD_INITIALIZER(devfs_dev_ops_list);
94 struct lock devfs_lock;
95 static struct lwkt_port devfs_dispose_port;
96 static struct lwkt_port devfs_msg_port;
97 static struct thread *td_core;
99 static struct spinlock ino_lock;
101 static int devfs_debug_enable;
102 static int devfs_run;
104 static ino_t devfs_fetch_ino(void);
105 static int devfs_create_all_dev_worker(struct devfs_node *);
106 static int devfs_create_dev_worker(cdev_t, uid_t, gid_t, int);
107 static int devfs_destroy_dev_worker(cdev_t);
108 static int devfs_destroy_subnames_worker(char *);
109 static int devfs_destroy_dev_by_ops_worker(struct dev_ops *, int);
110 static int devfs_propagate_dev(cdev_t, int);
111 static int devfs_unlink_dev(cdev_t dev);
112 static void devfs_msg_exec(devfs_msg_t msg);
114 static int devfs_chandler_add_worker(const char *, d_clone_t *);
115 static int devfs_chandler_del_worker(const char *);
117 static void devfs_msg_autofree_reply(lwkt_port_t, lwkt_msg_t);
118 static void devfs_msg_core(void *);
120 static int devfs_find_device_by_name_worker(devfs_msg_t);
121 static int devfs_find_device_by_udev_worker(devfs_msg_t);
123 static int devfs_apply_reset_rules_caller(char *, int);
125 static int devfs_scan_callback_worker(devfs_scan_t *);
127 static struct devfs_node *devfs_resolve_or_create_dir(struct devfs_node *,
128 char *, size_t, int);
130 static int devfs_make_alias_worker(struct devfs_alias *);
131 static int devfs_alias_remove(cdev_t);
132 static int devfs_alias_reap(void);
133 static int devfs_alias_propagate(struct devfs_alias *);
134 static int devfs_alias_apply(struct devfs_node *, struct devfs_alias *);
135 static int devfs_alias_check_create(struct devfs_node *);
137 static int devfs_clr_subnames_flag_worker(char *, uint32_t);
138 static int devfs_destroy_subnames_without_flag_worker(char *, uint32_t);
140 static void *devfs_reaperp_callback(struct devfs_node *, void *);
141 static void *devfs_gc_dirs_callback(struct devfs_node *, void *);
142 static void *devfs_gc_links_callback(struct devfs_node *, struct devfs_node *);
144 devfs_inode_to_vnode_worker_callback(struct devfs_node *, ino_t *);
147 * devfs_debug() is a SYSCTL and TUNABLE controlled debug output function
151 devfs_debug(int level, char *fmt, ...)
156 if (level <= devfs_debug_enable)
164 * devfs_allocp() Allocates a new devfs node with the specified
165 * parameters. The node is also automatically linked into the topology
166 * if a parent is specified. It also calls the rule and alias stuff to
167 * be applied on the new node
170 devfs_allocp(devfs_nodetype devfsnodetype, char *name,
171 struct devfs_node *parent, struct mount *mp, cdev_t dev)
173 struct devfs_node *node = NULL;
174 size_t namlen = strlen(name);
176 node = objcache_get(devfs_node_cache, M_WAITOK);
177 bzero(node, sizeof(*node));
179 atomic_add_long(&(DEVFS_MNTDATA(mp)->leak_count), 1);
184 node->d_dir.d_ino = devfs_fetch_ino();
187 * Cookie jar for children. Leave 0 and 1 for '.' and '..' entries
190 node->cookie_jar = 2;
193 * Access Control members
195 node->mode = DEVFS_DEFAULT_MODE;
196 node->uid = DEVFS_DEFAULT_UID;
197 node->gid = DEVFS_DEFAULT_GID;
199 switch (devfsnodetype) {
202 * Ensure that we don't recycle the root vnode by marking it as
203 * linked into the topology.
205 node->flags |= DEVFS_NODE_LINKED;
207 TAILQ_INIT(DEVFS_DENODE_HEAD(node));
208 node->d_dir.d_type = DT_DIR;
213 node->d_dir.d_type = DT_LNK;
217 node->d_dir.d_type = DT_REG;
222 node->d_dir.d_type = DT_CHR;
225 node->mode = dev->si_perms;
226 node->uid = dev->si_uid;
227 node->gid = dev->si_gid;
229 devfs_alias_check_create(node);
234 panic("devfs_allocp: unknown node type");
238 node->node_type = devfsnodetype;
240 /* Initialize the dirent structure of each devfs vnode */
241 KKASSERT(namlen < 256);
242 node->d_dir.d_namlen = namlen;
243 node->d_dir.d_name = kmalloc(namlen+1, M_DEVFS, M_WAITOK);
244 memcpy(node->d_dir.d_name, name, namlen);
245 node->d_dir.d_name[namlen] = '\0';
247 /* Initialize the parent node element */
248 node->parent = parent;
251 devfs_rule_check_apply(node, NULL);
253 /* Initialize *time members */
254 nanotime(&node->atime);
255 node->mtime = node->ctime = node->atime;
258 * Associate with parent as last step, clean out namecache
261 if ((parent != NULL) &&
262 ((parent->node_type == Proot) || (parent->node_type == Pdir))) {
264 node->cookie = parent->cookie_jar++;
265 node->flags |= DEVFS_NODE_LINKED;
266 TAILQ_INSERT_TAIL(DEVFS_DENODE_HEAD(parent), node, link);
268 /* This forces negative namecache lookups to clear */
269 ++mp->mnt_namecache_gen;
276 * devfs_allocv() allocates a new vnode based on a devfs node.
279 devfs_allocv(struct vnode **vpp, struct devfs_node *node)
287 while ((vp = node->v_node) != NULL) {
288 error = vget(vp, LK_EXCLUSIVE);
289 if (error != ENOENT) {
295 if ((error = getnewvnode(VT_DEVFS, node->mp, vpp, 0, 0)) != 0)
300 if (node->v_node != NULL) {
309 switch (node->node_type) {
326 KKASSERT(node->d_dev);
328 vp->v_uminor = node->d_dev->si_uminor;
331 v_associate_rdev(vp, node->d_dev);
332 vp->v_ops = &node->mp->mnt_vn_spec_ops;
336 panic("devfs_allocv: unknown node type");
344 * devfs_allocvp allocates both a devfs node (with the given settings) and a vnode
345 * based on the newly created devfs node.
348 devfs_allocvp(struct mount *mp, struct vnode **vpp, devfs_nodetype devfsnodetype,
349 char *name, struct devfs_node *parent, cdev_t dev)
351 struct devfs_node *node;
353 node = devfs_allocp(devfsnodetype, name, parent, mp, dev);
356 devfs_allocv(vpp, node);
364 * Destroy the devfs_node. The node must be unlinked from the topology.
366 * This function will also destroy any vnode association with the node
369 * The cdev_t itself remains intact.
372 devfs_freep(struct devfs_node *node)
377 KKASSERT(((node->flags & DEVFS_NODE_LINKED) == 0) ||
378 (node->node_type == Proot));
379 KKASSERT((node->flags & DEVFS_DESTROYED) == 0);
381 atomic_subtract_long(&(DEVFS_MNTDATA(node->mp)->leak_count), 1);
382 if (node->symlink_name) {
383 kfree(node->symlink_name, M_DEVFS);
384 node->symlink_name = NULL;
388 * Remove the node from the orphan list if it is still on it.
390 if (node->flags & DEVFS_ORPHANED)
391 devfs_tracer_del_orphan(node);
394 * Disassociate the vnode from the node. This also prevents the
395 * vnode's reclaim code from double-freeing the node.
397 * The vget is needed to safely modify the vp. It also serves
398 * to cycle the refs and terminate the vnode if it happens to
399 * be inactive, otherwise namecache references may not get cleared.
401 while ((vp = node->v_node) != NULL) {
402 if (vget(vp, LK_EXCLUSIVE | LK_RETRY) != 0)
407 cache_inval_vp(vp, CINV_DESTROY);
410 if (node->d_dir.d_name) {
411 kfree(node->d_dir.d_name, M_DEVFS);
412 node->d_dir.d_name = NULL;
414 node->flags |= DEVFS_DESTROYED;
416 objcache_put(devfs_node_cache, node);
422 * Unlink the devfs node from the topology and add it to the orphan list.
423 * The node will later be destroyed by freep.
425 * Any vnode association, including the v_rdev and v_data, remains intact
429 devfs_unlinkp(struct devfs_node *node)
431 struct devfs_node *parent;
435 * Add the node to the orphan list, so it is referenced somewhere, to
436 * so we don't leak it.
438 devfs_tracer_add_orphan(node);
440 parent = node->parent;
443 * If the parent is known we can unlink the node out of the topology
446 TAILQ_REMOVE(DEVFS_DENODE_HEAD(parent), node, link);
448 KKASSERT((parent->nchildren >= 0));
449 node->flags &= ~DEVFS_NODE_LINKED;
456 devfs_iterate_topology(struct devfs_node *node,
457 devfs_iterate_callback_t *callback, void *arg1)
459 struct devfs_node *node1, *node2;
462 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
463 if (node->nchildren > 2) {
464 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node),
466 if ((ret = devfs_iterate_topology(node1, callback, arg1)))
472 ret = callback(node, arg1);
477 * devfs_reaperp() is a recursive function that iterates through all the
478 * topology, unlinking and freeing all devfs nodes.
481 devfs_reaperp_callback(struct devfs_node *node, void *unused)
490 devfs_gc_dirs_callback(struct devfs_node *node, void *unused)
492 if (node->node_type == Pdir) {
493 if (node->nchildren == 2) {
503 devfs_gc_links_callback(struct devfs_node *node, struct devfs_node *target)
505 if ((node->node_type == Plink) && (node->link_target == target)) {
514 * devfs_gc() is devfs garbage collector. It takes care of unlinking and
515 * freeing a node, but also removes empty directories and links that link
516 * via devfs auto-link mechanism to the node being deleted.
519 devfs_gc(struct devfs_node *node)
521 struct devfs_node *root_node = DEVFS_MNTDATA(node->mp)->root_node;
523 if (node->nlinks > 0)
524 devfs_iterate_topology(root_node,
525 (devfs_iterate_callback_t *)devfs_gc_links_callback, node);
528 devfs_iterate_topology(root_node,
529 (devfs_iterate_callback_t *)devfs_gc_dirs_callback, NULL);
537 * devfs_create_dev() is the asynchronous entry point for device creation.
538 * It just sends a message with the relevant details to the devfs core.
540 * This function will reference the passed device. The reference is owned
541 * by devfs and represents all of the device's node associations.
544 devfs_create_dev(cdev_t dev, uid_t uid, gid_t gid, int perms)
547 devfs_msg_send_dev(DEVFS_DEVICE_CREATE, dev, uid, gid, perms);
553 * devfs_destroy_dev() is the asynchronous entry point for device destruction.
554 * It just sends a message with the relevant details to the devfs core.
557 devfs_destroy_dev(cdev_t dev)
559 devfs_msg_send_dev(DEVFS_DEVICE_DESTROY, dev, 0, 0, 0);
564 * devfs_mount_add() is the synchronous entry point for adding a new devfs
565 * mount. It sends a synchronous message with the relevant details to the
569 devfs_mount_add(struct devfs_mnt_data *mnt)
573 msg = devfs_msg_get();
575 msg = devfs_msg_send_sync(DEVFS_MOUNT_ADD, msg);
582 * devfs_mount_del() is the synchronous entry point for removing a devfs mount.
583 * It sends a synchronous message with the relevant details to the devfs core.
586 devfs_mount_del(struct devfs_mnt_data *mnt)
590 msg = devfs_msg_get();
592 msg = devfs_msg_send_sync(DEVFS_MOUNT_DEL, msg);
599 * devfs_destroy_subnames() is the synchronous entry point for device
600 * destruction by subname. It just sends a message with the relevant details to
604 devfs_destroy_subnames(char *name)
608 msg = devfs_msg_get();
609 msg->mdv_load = name;
610 msg = devfs_msg_send_sync(DEVFS_DESTROY_SUBNAMES, msg);
616 devfs_clr_subnames_flag(char *name, uint32_t flag)
620 msg = devfs_msg_get();
621 msg->mdv_flags.name = name;
622 msg->mdv_flags.flag = flag;
623 msg = devfs_msg_send_sync(DEVFS_CLR_SUBNAMES_FLAG, msg);
630 devfs_destroy_subnames_without_flag(char *name, uint32_t flag)
634 msg = devfs_msg_get();
635 msg->mdv_flags.name = name;
636 msg->mdv_flags.flag = flag;
637 msg = devfs_msg_send_sync(DEVFS_DESTROY_SUBNAMES_WO_FLAG, msg);
644 * devfs_create_all_dev is the asynchronous entry point to trigger device
645 * node creation. It just sends a message with the relevant details to
649 devfs_create_all_dev(struct devfs_node *root)
651 devfs_msg_send_generic(DEVFS_CREATE_ALL_DEV, root);
656 * devfs_destroy_dev_by_ops is the asynchronous entry point to destroy all
657 * devices with a specific set of dev_ops and minor. It just sends a
658 * message with the relevant details to the devfs core.
661 devfs_destroy_dev_by_ops(struct dev_ops *ops, int minor)
663 devfs_msg_send_ops(DEVFS_DESTROY_DEV_BY_OPS, ops, minor);
668 * devfs_clone_handler_add is the synchronous entry point to add a new
669 * clone handler. It just sends a message with the relevant details to
673 devfs_clone_handler_add(const char *name, d_clone_t *nhandler)
677 msg = devfs_msg_get();
678 msg->mdv_chandler.name = name;
679 msg->mdv_chandler.nhandler = nhandler;
680 msg = devfs_msg_send_sync(DEVFS_CHANDLER_ADD, msg);
686 * devfs_clone_handler_del is the synchronous entry point to remove a
687 * clone handler. It just sends a message with the relevant details to
691 devfs_clone_handler_del(const char *name)
695 msg = devfs_msg_get();
696 msg->mdv_chandler.name = name;
697 msg->mdv_chandler.nhandler = NULL;
698 msg = devfs_msg_send_sync(DEVFS_CHANDLER_DEL, msg);
704 * devfs_find_device_by_name is the synchronous entry point to find a
705 * device given its name. It sends a synchronous message with the
706 * relevant details to the devfs core and returns the answer.
709 devfs_find_device_by_name(const char *fmt, ...)
713 char target[PATH_MAX+1];
721 i = kvcprintf(fmt, NULL, target, 10, ap);
725 msg = devfs_msg_get();
726 msg->mdv_name = target;
727 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_NAME, msg);
728 found = msg->mdv_cdev;
735 * devfs_find_device_by_udev is the synchronous entry point to find a
736 * device given its udev number. It sends a synchronous message with
737 * the relevant details to the devfs core and returns the answer.
740 devfs_find_device_by_udev(udev_t udev)
745 msg = devfs_msg_get();
746 msg->mdv_udev = udev;
747 msg = devfs_msg_send_sync(DEVFS_FIND_DEVICE_BY_UDEV, msg);
748 found = msg->mdv_cdev;
751 devfs_debug(DEVFS_DEBUG_DEBUG,
752 "devfs_find_device_by_udev found? %s -end:3-\n",
753 ((found) ? found->si_name:"NO"));
758 devfs_inode_to_vnode(struct mount *mp, ino_t target)
760 struct vnode *vp = NULL;
766 msg = devfs_msg_get();
767 msg->mdv_ino.mp = mp;
768 msg->mdv_ino.ino = target;
769 msg = devfs_msg_send_sync(DEVFS_INODE_TO_VNODE, msg);
770 vp = msg->mdv_ino.vp;
771 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
778 * devfs_make_alias is the asynchronous entry point to register an alias
779 * for a device. It just sends a message with the relevant details to the
783 devfs_make_alias(const char *name, cdev_t dev_target)
785 struct devfs_alias *alias;
790 alias = kmalloc(sizeof(struct devfs_alias), M_DEVFS, M_WAITOK);
791 alias->name = kstrdup(name, M_DEVFS);
793 alias->dev_target = dev_target;
795 devfs_msg_send_generic(DEVFS_MAKE_ALIAS, alias);
800 * devfs_apply_rules is the asynchronous entry point to trigger application
801 * of all rules. It just sends a message with the relevant details to the
805 devfs_apply_rules(char *mntto)
809 new_name = kstrdup(mntto, M_DEVFS);
810 devfs_msg_send_name(DEVFS_APPLY_RULES, new_name);
816 * devfs_reset_rules is the asynchronous entry point to trigger reset of all
817 * rules. It just sends a message with the relevant details to the devfs core.
820 devfs_reset_rules(char *mntto)
824 new_name = kstrdup(mntto, M_DEVFS);
825 devfs_msg_send_name(DEVFS_RESET_RULES, new_name);
832 * devfs_scan_callback is the asynchronous entry point to call a callback
834 * It just sends a message with the relevant details to the devfs core.
837 devfs_scan_callback(devfs_scan_t *callback)
841 KKASSERT(sizeof(callback) == sizeof(void *));
843 msg = devfs_msg_get();
844 msg->mdv_load = callback;
845 msg = devfs_msg_send_sync(DEVFS_SCAN_CALLBACK, msg);
853 * Acts as a message drain. Any message that is replied to here gets destroyed
854 * and the memory freed.
857 devfs_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
859 devfs_msg_put((devfs_msg_t)msg);
863 * devfs_msg_get allocates a new devfs msg and returns it.
868 return objcache_get(devfs_msg_cache, M_WAITOK);
872 * devfs_msg_put deallocates a given devfs msg.
875 devfs_msg_put(devfs_msg_t msg)
877 objcache_put(devfs_msg_cache, msg);
882 * devfs_msg_send is the generic asynchronous message sending facility
883 * for devfs. By default the reply port is the automatic disposal port.
885 * If the current thread is the devfs_msg_port thread we execute the
886 * operation synchronously.
889 devfs_msg_send(uint32_t cmd, devfs_msg_t devfs_msg)
891 lwkt_port_t port = &devfs_msg_port;
893 lwkt_initmsg(&devfs_msg->hdr, &devfs_dispose_port, 0);
895 devfs_msg->hdr.u.ms_result = cmd;
897 if (port->mpu_td == curthread) {
898 devfs_msg_exec(devfs_msg);
899 lwkt_replymsg(&devfs_msg->hdr, 0);
901 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
906 * devfs_msg_send_sync is the generic synchronous message sending
907 * facility for devfs. It initializes a local reply port and waits
908 * for the core's answer. This answer is then returned.
911 devfs_msg_send_sync(uint32_t cmd, devfs_msg_t devfs_msg)
913 struct lwkt_port rep_port;
914 devfs_msg_t msg_incoming;
915 lwkt_port_t port = &devfs_msg_port;
917 lwkt_initport_thread(&rep_port, curthread);
918 lwkt_initmsg(&devfs_msg->hdr, &rep_port, 0);
920 devfs_msg->hdr.u.ms_result = cmd;
922 lwkt_sendmsg(port, (lwkt_msg_t)devfs_msg);
923 msg_incoming = lwkt_waitport(&rep_port, 0);
929 * sends a message with a generic argument.
932 devfs_msg_send_generic(uint32_t cmd, void *load)
934 devfs_msg_t devfs_msg = devfs_msg_get();
936 devfs_msg->mdv_load = load;
937 devfs_msg_send(cmd, devfs_msg);
941 * sends a message with a name argument.
944 devfs_msg_send_name(uint32_t cmd, char *name)
946 devfs_msg_t devfs_msg = devfs_msg_get();
948 devfs_msg->mdv_name = name;
949 devfs_msg_send(cmd, devfs_msg);
953 * sends a message with a mount argument.
956 devfs_msg_send_mount(uint32_t cmd, struct devfs_mnt_data *mnt)
958 devfs_msg_t devfs_msg = devfs_msg_get();
960 devfs_msg->mdv_mnt = mnt;
961 devfs_msg_send(cmd, devfs_msg);
965 * sends a message with an ops argument.
968 devfs_msg_send_ops(uint32_t cmd, struct dev_ops *ops, int minor)
970 devfs_msg_t devfs_msg = devfs_msg_get();
972 devfs_msg->mdv_ops.ops = ops;
973 devfs_msg->mdv_ops.minor = minor;
974 devfs_msg_send(cmd, devfs_msg);
978 * sends a message with a clone handler argument.
981 devfs_msg_send_chandler(uint32_t cmd, char *name, d_clone_t handler)
983 devfs_msg_t devfs_msg = devfs_msg_get();
985 devfs_msg->mdv_chandler.name = name;
986 devfs_msg->mdv_chandler.nhandler = handler;
987 devfs_msg_send(cmd, devfs_msg);
991 * sends a message with a device argument.
994 devfs_msg_send_dev(uint32_t cmd, cdev_t dev, uid_t uid, gid_t gid, int perms)
996 devfs_msg_t devfs_msg = devfs_msg_get();
998 devfs_msg->mdv_dev.dev = dev;
999 devfs_msg->mdv_dev.uid = uid;
1000 devfs_msg->mdv_dev.gid = gid;
1001 devfs_msg->mdv_dev.perms = perms;
1003 devfs_msg_send(cmd, devfs_msg);
1007 * sends a message with a link argument.
1010 devfs_msg_send_link(uint32_t cmd, char *name, char *target, struct mount *mp)
1012 devfs_msg_t devfs_msg = devfs_msg_get();
1014 devfs_msg->mdv_link.name = name;
1015 devfs_msg->mdv_link.target = target;
1016 devfs_msg->mdv_link.mp = mp;
1017 devfs_msg_send(cmd, devfs_msg);
1021 * devfs_msg_core is the main devfs thread. It handles all incoming messages
1022 * and calls the relevant worker functions. By using messages it's assured
1023 * that events occur in the correct order.
1026 devfs_msg_core(void *arg)
1031 lwkt_initport_thread(&devfs_msg_port, curthread);
1035 msg = (devfs_msg_t)lwkt_waitport(&devfs_msg_port, 0);
1036 devfs_debug(DEVFS_DEBUG_DEBUG,
1037 "devfs_msg_core, new msg: %x\n",
1038 (unsigned int)msg->hdr.u.ms_result);
1039 devfs_msg_exec(msg);
1040 lwkt_replymsg(&msg->hdr, 0);
1047 devfs_msg_exec(devfs_msg_t msg)
1049 struct devfs_mnt_data *mnt;
1050 struct devfs_node *node;
1054 * Acquire the devfs lock to ensure safety of all called functions
1056 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1058 switch (msg->hdr.u.ms_result) {
1059 case DEVFS_DEVICE_CREATE:
1060 dev = msg->mdv_dev.dev;
1061 devfs_create_dev_worker(dev,
1064 msg->mdv_dev.perms);
1066 case DEVFS_DEVICE_DESTROY:
1067 dev = msg->mdv_dev.dev;
1068 devfs_destroy_dev_worker(dev);
1070 case DEVFS_DESTROY_SUBNAMES:
1071 devfs_destroy_subnames_worker(msg->mdv_load);
1073 case DEVFS_DESTROY_DEV_BY_OPS:
1074 devfs_destroy_dev_by_ops_worker(msg->mdv_ops.ops,
1075 msg->mdv_ops.minor);
1077 case DEVFS_CREATE_ALL_DEV:
1078 node = (struct devfs_node *)msg->mdv_load;
1079 devfs_create_all_dev_worker(node);
1081 case DEVFS_MOUNT_ADD:
1083 TAILQ_INSERT_TAIL(&devfs_mnt_list, mnt, link);
1084 devfs_create_all_dev_worker(mnt->root_node);
1086 case DEVFS_MOUNT_DEL:
1088 TAILQ_REMOVE(&devfs_mnt_list, mnt, link);
1089 devfs_iterate_topology(mnt->root_node, devfs_reaperp_callback,
1091 if (mnt->leak_count) {
1092 devfs_debug(DEVFS_DEBUG_SHOW,
1093 "Leaked %ld devfs_node elements!\n",
1097 case DEVFS_CHANDLER_ADD:
1098 devfs_chandler_add_worker(msg->mdv_chandler.name,
1099 msg->mdv_chandler.nhandler);
1101 case DEVFS_CHANDLER_DEL:
1102 devfs_chandler_del_worker(msg->mdv_chandler.name);
1104 case DEVFS_FIND_DEVICE_BY_NAME:
1105 devfs_find_device_by_name_worker(msg);
1107 case DEVFS_FIND_DEVICE_BY_UDEV:
1108 devfs_find_device_by_udev_worker(msg);
1110 case DEVFS_MAKE_ALIAS:
1111 devfs_make_alias_worker((struct devfs_alias *)msg->mdv_load);
1113 case DEVFS_APPLY_RULES:
1114 devfs_apply_reset_rules_caller(msg->mdv_name, 1);
1116 case DEVFS_RESET_RULES:
1117 devfs_apply_reset_rules_caller(msg->mdv_name, 0);
1119 case DEVFS_SCAN_CALLBACK:
1120 devfs_scan_callback_worker((devfs_scan_t *)msg->mdv_load);
1122 case DEVFS_CLR_SUBNAMES_FLAG:
1123 devfs_clr_subnames_flag_worker(msg->mdv_flags.name,
1124 msg->mdv_flags.flag);
1126 case DEVFS_DESTROY_SUBNAMES_WO_FLAG:
1127 devfs_destroy_subnames_without_flag_worker(msg->mdv_flags.name,
1128 msg->mdv_flags.flag);
1130 case DEVFS_INODE_TO_VNODE:
1131 msg->mdv_ino.vp = devfs_iterate_topology(
1132 DEVFS_MNTDATA(msg->mdv_ino.mp)->root_node,
1133 (devfs_iterate_callback_t *)devfs_inode_to_vnode_worker_callback,
1136 case DEVFS_TERMINATE_CORE:
1142 devfs_debug(DEVFS_DEBUG_WARNING,
1143 "devfs_msg_core: unknown message "
1144 "received at core\n");
1147 lockmgr(&devfs_lock, LK_RELEASE);
1151 * Worker function to insert a new dev into the dev list and initialize its
1152 * permissions. It also calls devfs_propagate_dev which in turn propagates
1153 * the change to all mount points.
1155 * The passed dev is already referenced. This reference is eaten by this
1156 * function and represents the dev's linkage into devfs_dev_list.
1159 devfs_create_dev_worker(cdev_t dev, uid_t uid, gid_t gid, int perms)
1165 dev->si_perms = perms;
1167 devfs_link_dev(dev);
1168 devfs_propagate_dev(dev, 1);
1174 * Worker function to delete a dev from the dev list and free the cdev.
1175 * It also calls devfs_propagate_dev which in turn propagates the change
1176 * to all mount points.
1179 devfs_destroy_dev_worker(cdev_t dev)
1184 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1186 error = devfs_unlink_dev(dev);
1187 devfs_propagate_dev(dev, 0);
1189 release_dev(dev); /* link ref */
1197 * Worker function to destroy all devices with a certain basename.
1198 * Calls devfs_destroy_dev_worker for the actual destruction.
1201 devfs_destroy_subnames_worker(char *name)
1204 size_t len = strlen(name);
1206 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1207 if ((!strncmp(dev->si_name, name, len)) &&
1208 (dev->si_name[len] != '\0')) {
1209 devfs_destroy_dev_worker(dev);
1216 devfs_clr_subnames_flag_worker(char *name, uint32_t flag)
1219 size_t len = strlen(name);
1221 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1222 if ((!strncmp(dev->si_name, name, len)) &&
1223 (dev->si_name[len] != '\0')) {
1224 dev->si_flags &= ~flag;
1232 devfs_destroy_subnames_without_flag_worker(char *name, uint32_t flag)
1235 size_t len = strlen(name);
1237 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1238 if ((!strncmp(dev->si_name, name, len)) &&
1239 (dev->si_name[len] != '\0')) {
1240 if (!(dev->si_flags & flag)) {
1241 devfs_destroy_dev_worker(dev);
1250 * Worker function that creates all device nodes on top of a devfs
1254 devfs_create_all_dev_worker(struct devfs_node *root)
1260 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1261 devfs_create_device_node(root, dev, NULL, NULL);
1268 * Worker function that destroys all devices that match a specific
1269 * dev_ops and/or minor. If minor is less than 0, it is not matched
1270 * against. It also propagates all changes.
1273 devfs_destroy_dev_by_ops_worker(struct dev_ops *ops, int minor)
1279 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1280 if (dev->si_ops != ops)
1282 if ((minor < 0) || (dev->si_uminor == minor)) {
1283 devfs_destroy_dev_worker(dev);
1291 * Worker function that registers a new clone handler in devfs.
1294 devfs_chandler_add_worker(const char *name, d_clone_t *nhandler)
1296 struct devfs_clone_handler *chandler = NULL;
1297 u_char len = strlen(name);
1302 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
1303 if (chandler->namlen != len)
1306 if (!memcmp(chandler->name, name, len)) {
1307 /* Clonable basename already exists */
1312 chandler = kmalloc(sizeof(*chandler), M_DEVFS, M_WAITOK | M_ZERO);
1313 chandler->name = kstrdup(name, M_DEVFS);
1314 chandler->namlen = len;
1315 chandler->nhandler = nhandler;
1317 TAILQ_INSERT_TAIL(&devfs_chandler_list, chandler, link);
1322 * Worker function that removes a given clone handler from the
1323 * clone handler list.
1326 devfs_chandler_del_worker(const char *name)
1328 struct devfs_clone_handler *chandler, *chandler2;
1329 u_char len = strlen(name);
1334 TAILQ_FOREACH_MUTABLE(chandler, &devfs_chandler_list, link, chandler2) {
1335 if (chandler->namlen != len)
1337 if (memcmp(chandler->name, name, len))
1340 TAILQ_REMOVE(&devfs_chandler_list, chandler, link);
1341 kfree(chandler->name, M_DEVFS);
1342 kfree(chandler, M_DEVFS);
1350 * Worker function that finds a given device name and changes
1351 * the message received accordingly so that when replied to,
1352 * the answer is returned to the caller.
1355 devfs_find_device_by_name_worker(devfs_msg_t devfs_msg)
1357 struct devfs_alias *alias;
1359 cdev_t found = NULL;
1361 TAILQ_FOREACH(dev, &devfs_dev_list, link) {
1362 if (strcmp(devfs_msg->mdv_name, dev->si_name) == 0) {
1367 if (found == NULL) {
1368 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1369 if (strcmp(devfs_msg->mdv_name, alias->name) == 0) {
1370 found = alias->dev_target;
1375 devfs_msg->mdv_cdev = found;
1381 * Worker function that finds a given device udev and changes
1382 * the message received accordingly so that when replied to,
1383 * the answer is returned to the caller.
1386 devfs_find_device_by_udev_worker(devfs_msg_t devfs_msg)
1389 cdev_t found = NULL;
1391 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1392 if (((udev_t)dev->si_inode) == devfs_msg->mdv_udev) {
1397 devfs_msg->mdv_cdev = found;
1403 * Worker function that inserts a given alias into the
1404 * alias list, and propagates the alias to all mount
1408 devfs_make_alias_worker(struct devfs_alias *alias)
1410 struct devfs_alias *alias2;
1411 size_t len = strlen(alias->name);
1414 TAILQ_FOREACH(alias2, &devfs_alias_list, link) {
1415 if (len != alias2->namlen)
1418 if (!memcmp(alias->name, alias2->name, len)) {
1426 * The alias doesn't exist yet, so we add it to the alias list
1428 TAILQ_INSERT_TAIL(&devfs_alias_list, alias, link);
1429 devfs_alias_propagate(alias);
1431 devfs_debug(DEVFS_DEBUG_WARNING,
1432 "Warning: duplicate devfs_make_alias for %s\n",
1434 kfree(alias->name, M_DEVFS);
1435 kfree(alias, M_DEVFS);
1442 * Function that removes and frees all aliases.
1445 devfs_alias_reap(void)
1447 struct devfs_alias *alias, *alias2;
1449 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1450 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1451 kfree(alias, M_DEVFS);
1457 * Function that removes an alias matching a specific cdev and frees
1461 devfs_alias_remove(cdev_t dev)
1463 struct devfs_alias *alias, *alias2;
1465 TAILQ_FOREACH_MUTABLE(alias, &devfs_alias_list, link, alias2) {
1466 if (alias->dev_target == dev) {
1467 TAILQ_REMOVE(&devfs_alias_list, alias, link);
1468 kfree(alias, M_DEVFS);
1475 * This function propagates a new alias to all mount points.
1478 devfs_alias_propagate(struct devfs_alias *alias)
1480 struct devfs_mnt_data *mnt;
1482 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1483 devfs_alias_apply(mnt->root_node, alias);
1489 * This function is a recursive function iterating through
1490 * all device nodes in the topology and, if applicable,
1491 * creating the relevant alias for a device node.
1494 devfs_alias_apply(struct devfs_node *node, struct devfs_alias *alias)
1496 struct devfs_node *node1, *node2;
1498 KKASSERT(alias != NULL);
1500 if ((node->node_type == Proot) || (node->node_type == Pdir)) {
1501 if (node->nchildren > 2) {
1502 TAILQ_FOREACH_MUTABLE(node1, DEVFS_DENODE_HEAD(node), link, node2) {
1503 devfs_alias_apply(node1, alias);
1507 if (node->d_dev == alias->dev_target)
1508 devfs_alias_create(alias->name, node, 0);
1514 * This function checks if any alias possibly is applicable
1515 * to the given node. If so, the alias is created.
1518 devfs_alias_check_create(struct devfs_node *node)
1520 struct devfs_alias *alias;
1522 TAILQ_FOREACH(alias, &devfs_alias_list, link) {
1523 if (node->d_dev == alias->dev_target)
1524 devfs_alias_create(alias->name, node, 0);
1530 * This function creates an alias with a given name
1531 * linking to a given devfs node. It also increments
1532 * the link count on the target node.
1535 devfs_alias_create(char *name_orig, struct devfs_node *target, int rule_based)
1537 struct mount *mp = target->mp;
1538 struct devfs_node *parent = DEVFS_MNTDATA(mp)->root_node;
1539 struct devfs_node *linknode;
1540 char *create_path = NULL;
1541 char *name, name_buf[PATH_MAX];
1543 KKASSERT((lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE);
1545 devfs_resolve_name_path(name_orig, name_buf, &create_path, &name);
1548 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1551 if (devfs_find_device_node_by_name(parent, name)) {
1552 devfs_debug(DEVFS_DEBUG_WARNING,
1553 "Node already exists: %s "
1554 "(devfs_make_alias_worker)!\n",
1560 linknode = devfs_allocp(Plink, name, parent, mp, NULL);
1561 if (linknode == NULL)
1564 linknode->link_target = target;
1568 linknode->flags |= DEVFS_RULE_CREATED;
1574 * This function is called by the core and handles mount point
1575 * strings. It either calls the relevant worker (devfs_apply_
1576 * reset_rules_worker) on all mountpoints or only a specific
1580 devfs_apply_reset_rules_caller(char *mountto, int apply)
1582 struct devfs_mnt_data *mnt;
1583 size_t len = strlen(mountto);
1585 if (mountto[0] == '*') {
1586 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1587 devfs_iterate_topology(mnt->root_node,
1588 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1592 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1593 if (!strcmp(mnt->mp->mnt_stat.f_mntonname, mountto)) {
1594 devfs_iterate_topology(mnt->root_node,
1595 (apply)?(devfs_rule_check_apply):(devfs_rule_reset_node),
1602 kfree(mountto, M_DEVFS);
1607 * This function calls a given callback function for
1608 * every dev node in the devfs dev list.
1611 devfs_scan_callback_worker(devfs_scan_t *callback)
1615 TAILQ_FOREACH_MUTABLE(dev, &devfs_dev_list, link, dev1) {
1623 * This function tries to resolve a given directory, or if not
1624 * found and creation requested, creates the given directory.
1626 static struct devfs_node *
1627 devfs_resolve_or_create_dir(struct devfs_node *parent, char *dir_name,
1628 size_t name_len, int create)
1630 struct devfs_node *node, *found = NULL;
1632 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1633 if (name_len != node->d_dir.d_namlen)
1636 if (!memcmp(dir_name, node->d_dir.d_name, name_len)) {
1642 if ((found == NULL) && (create)) {
1643 found = devfs_allocp(Pdir, dir_name, parent, parent->mp, NULL);
1650 * This function tries to resolve a complete path. If creation is requested,
1651 * if a given part of the path cannot be resolved (because it doesn't exist),
1655 devfs_resolve_or_create_path(struct devfs_node *parent, char *path, int create)
1657 struct devfs_node *node = parent;
1666 for (; *path != '\0' ; path++) {
1671 node = devfs_resolve_or_create_dir(node, buf, idx, create);
1678 return devfs_resolve_or_create_dir(node, buf, idx, create);
1682 * Takes a full path and strips it into a directory path and a name.
1683 * For a/b/c/foo, it returns foo in namep and a/b/c in pathp. It
1684 * requires a working buffer with enough size to keep the whole
1688 devfs_resolve_name_path(char *fullpath, char *buf, char **pathp, char **namep)
1692 size_t len = strlen(fullpath) + 1;
1695 KKASSERT((fullpath != NULL) && (buf != NULL));
1696 KKASSERT((pathp != NULL) && (namep != NULL));
1698 memcpy(buf, fullpath, len);
1700 for (i = len-1; i>= 0; i--) {
1701 if (buf[i] == '/') {
1721 * This function creates a new devfs node for a given device. It can
1722 * handle a complete path as device name, and accordingly creates
1723 * the path and the final device node.
1725 * The reference count on the passed dev remains unchanged.
1728 devfs_create_device_node(struct devfs_node *root, cdev_t dev,
1729 char *dev_name, char *path_fmt, ...)
1731 struct devfs_node *parent, *node = NULL;
1733 char *name, name_buf[PATH_MAX];
1737 char *create_path = NULL;
1738 char *names = "pqrsPQRS";
1740 if (path_fmt != NULL) {
1741 path = kmalloc(PATH_MAX+1, M_DEVFS, M_WAITOK);
1743 __va_start(ap, path_fmt);
1744 i = kvcprintf(path_fmt, NULL, path, 10, ap);
1749 parent = devfs_resolve_or_create_path(root, path, 1);
1752 devfs_resolve_name_path(
1753 ((dev_name == NULL) && (dev))?(dev->si_name):(dev_name),
1754 name_buf, &create_path, &name);
1757 parent = devfs_resolve_or_create_path(parent, create_path, 1);
1760 if (devfs_find_device_node_by_name(parent, name)) {
1761 devfs_debug(DEVFS_DEBUG_WARNING, "devfs_create_device_node: "
1762 "DEVICE %s ALREADY EXISTS!!! Ignoring creation request.\n", name);
1766 node = devfs_allocp(Pdev, name, parent, parent->mp, dev);
1767 nanotime(&parent->mtime);
1770 * Ugly unix98 pty magic, to hide pty master (ptm) devices and their
1773 if ((dev) && (strlen(dev->si_name) >= 4) &&
1774 (!memcmp(dev->si_name, "ptm/", 4))) {
1775 node->parent->flags |= DEVFS_HIDDEN;
1776 node->flags |= DEVFS_HIDDEN;
1780 * Ugly pty magic, to tag pty devices as such and hide them if needed.
1782 if ((strlen(name) >= 3) && (!memcmp(name, "pty", 3)))
1783 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1785 if ((strlen(name) >= 3) && (!memcmp(name, "tty", 3))) {
1787 for (i = 0; i < strlen(names); i++) {
1788 if (name[3] == names[i]) {
1794 node->flags |= (DEVFS_PTY | DEVFS_INVISIBLE);
1798 if (path_fmt != NULL)
1799 kfree(path, M_DEVFS);
1805 * This function finds a given device node in the topology with a given
1809 devfs_find_device_node_callback(struct devfs_node *node, cdev_t target)
1811 if ((node->node_type == Pdev) && (node->d_dev == target)) {
1819 * This function finds a device node in the given parent directory by its
1820 * name and returns it.
1823 devfs_find_device_node_by_name(struct devfs_node *parent, char *target)
1825 struct devfs_node *node, *found = NULL;
1826 size_t len = strlen(target);
1828 TAILQ_FOREACH(node, DEVFS_DENODE_HEAD(parent), link) {
1829 if (len != node->d_dir.d_namlen)
1832 if (!memcmp(node->d_dir.d_name, target, len)) {
1842 devfs_inode_to_vnode_worker_callback(struct devfs_node *node, ino_t *inop)
1844 struct vnode *vp = NULL;
1845 ino_t target = *inop;
1847 if (node->d_dir.d_ino == target) {
1850 vget(vp, LK_EXCLUSIVE | LK_RETRY);
1853 devfs_allocv(&vp, node);
1862 * This function takes a cdev and removes its devfs node in the
1863 * given topology. The cdev remains intact.
1866 devfs_destroy_device_node(struct devfs_node *root, cdev_t target)
1868 struct devfs_node *node, *parent;
1869 char *name, name_buf[PATH_MAX];
1870 char *create_path = NULL;
1874 memcpy(name_buf, target->si_name, strlen(target->si_name)+1);
1876 devfs_resolve_name_path(target->si_name, name_buf, &create_path, &name);
1879 parent = devfs_resolve_or_create_path(root, create_path, 0);
1886 node = devfs_find_device_node_by_name(parent, name);
1889 nanotime(&node->parent->mtime);
1897 * Just set perms and ownership for given node.
1900 devfs_set_perms(struct devfs_node *node, uid_t uid, gid_t gid,
1901 u_short mode, u_long flags)
1911 * Propagates a device attach/detach to all mount
1912 * points. Also takes care of automatic alias removal
1913 * for a deleted cdev.
1916 devfs_propagate_dev(cdev_t dev, int attach)
1918 struct devfs_mnt_data *mnt;
1920 TAILQ_FOREACH(mnt, &devfs_mnt_list, link) {
1922 /* Device is being attached */
1923 devfs_create_device_node(mnt->root_node, dev,
1926 /* Device is being detached */
1927 devfs_alias_remove(dev);
1928 devfs_destroy_device_node(mnt->root_node, dev);
1935 * devfs_node_to_path takes a node and a buffer of a size of
1936 * at least PATH_MAX, resolves the full path from the root
1937 * node and writes it in a humanly-readable format into the
1939 * If DEVFS_STASH_DEPTH is less than the directory level up
1940 * to the root node, only the last DEVFS_STASH_DEPTH levels
1941 * of the path are resolved.
1944 devfs_node_to_path(struct devfs_node *node, char *buffer)
1946 #define DEVFS_STASH_DEPTH 32
1947 struct devfs_node *node_stash[DEVFS_STASH_DEPTH];
1949 memset(buffer, 0, PATH_MAX);
1951 for (i = 0; (i < DEVFS_STASH_DEPTH) && (node->node_type != Proot); i++) {
1952 node_stash[i] = node;
1953 node = node->parent;
1957 for (offset = 0; i >= 0; i--) {
1958 memcpy(buffer+offset, node_stash[i]->d_dir.d_name,
1959 node_stash[i]->d_dir.d_namlen);
1960 offset += node_stash[i]->d_dir.d_namlen;
1962 *(buffer+offset) = '/';
1966 #undef DEVFS_STASH_DEPTH
1971 * devfs_clone either returns a basename from a complete name by
1972 * returning the length of the name without trailing digits, or,
1973 * if clone != 0, calls the device's clone handler to get a new
1974 * device, which in turn is returned in devp.
1977 devfs_clone(cdev_t dev, const char *name, size_t len, int mode,
1981 struct devfs_clone_handler *chandler;
1982 struct dev_clone_args ap;
1984 TAILQ_FOREACH(chandler, &devfs_chandler_list, link) {
1985 if (chandler->namlen != len)
1987 if ((!memcmp(chandler->name, name, len)) && (chandler->nhandler)) {
1988 lockmgr(&devfs_lock, LK_RELEASE);
1990 lockmgr(&devfs_lock, LK_EXCLUSIVE);
1992 ap.a_head.a_dev = dev;
1998 error = (chandler->nhandler)(&ap);
2011 * Registers a new orphan in the orphan list.
2014 devfs_tracer_add_orphan(struct devfs_node *node)
2016 struct devfs_orphan *orphan;
2019 orphan = kmalloc(sizeof(struct devfs_orphan), M_DEVFS, M_WAITOK);
2020 orphan->node = node;
2022 KKASSERT((node->flags & DEVFS_ORPHANED) == 0);
2023 node->flags |= DEVFS_ORPHANED;
2024 TAILQ_INSERT_TAIL(DEVFS_ORPHANLIST(node->mp), orphan, link);
2028 * Removes an orphan from the orphan list.
2031 devfs_tracer_del_orphan(struct devfs_node *node)
2033 struct devfs_orphan *orphan;
2037 TAILQ_FOREACH(orphan, DEVFS_ORPHANLIST(node->mp), link) {
2038 if (orphan->node == node) {
2039 node->flags &= ~DEVFS_ORPHANED;
2040 TAILQ_REMOVE(DEVFS_ORPHANLIST(node->mp), orphan, link);
2041 kfree(orphan, M_DEVFS);
2048 * Counts the orphans in the orphan list, and if cleanup
2049 * is specified, also frees the orphan and removes it from
2053 devfs_tracer_orphan_count(struct mount *mp, int cleanup)
2055 struct devfs_orphan *orphan, *orphan2;
2058 TAILQ_FOREACH_MUTABLE(orphan, DEVFS_ORPHANLIST(mp), link, orphan2) {
2061 * If we are instructed to clean up, we do so.
2064 TAILQ_REMOVE(DEVFS_ORPHANLIST(mp), orphan, link);
2065 orphan->node->flags &= ~DEVFS_ORPHANED;
2066 devfs_freep(orphan->node);
2067 kfree(orphan, M_DEVFS);
2075 * Fetch an ino_t from the global d_ino by increasing it
2079 devfs_fetch_ino(void)
2083 spin_lock_wr(&ino_lock);
2085 spin_unlock_wr(&ino_lock);
2091 * Allocates a new cdev and initializes it's most basic
2095 devfs_new_cdev(struct dev_ops *ops, int minor)
2097 cdev_t dev = sysref_alloc(&cdev_sysref_class);
2098 sysref_activate(&dev->si_sysref);
2100 memset(dev, 0, offsetof(struct cdev, si_sysref));
2105 dev->si_drv1 = NULL;
2106 dev->si_drv2 = NULL;
2107 dev->si_lastread = 0; /* time_second */
2108 dev->si_lastwrite = 0; /* time_second */
2113 dev->si_uminor = minor;
2114 dev->si_inode = makeudev(devfs_reference_ops(ops), minor);
2120 devfs_cdev_terminate(cdev_t dev)
2124 /* Check if it is locked already. if not, we acquire the devfs lock */
2125 if (!(lockstatus(&devfs_lock, curthread)) == LK_EXCLUSIVE) {
2126 lockmgr(&devfs_lock, LK_EXCLUSIVE);
2130 /* Propagate destruction, just in case */
2131 devfs_propagate_dev(dev, 0);
2133 /* If we acquired the lock, we also get rid of it */
2135 lockmgr(&devfs_lock, LK_RELEASE);
2137 devfs_release_ops(dev->si_ops);
2139 /* Finally destroy the device */
2140 sysref_put(&dev->si_sysref);
2144 * Links a given cdev into the dev list.
2147 devfs_link_dev(cdev_t dev)
2149 KKASSERT((dev->si_flags & SI_DEVFS_LINKED) == 0);
2150 dev->si_flags |= SI_DEVFS_LINKED;
2151 TAILQ_INSERT_TAIL(&devfs_dev_list, dev, link);
2157 * Removes a given cdev from the dev list. The caller is responsible for
2158 * releasing the reference on the device associated with the linkage.
2160 * Returns EALREADY if the dev has already been unlinked.
2163 devfs_unlink_dev(cdev_t dev)
2165 if ((dev->si_flags & SI_DEVFS_LINKED)) {
2166 TAILQ_REMOVE(&devfs_dev_list, dev, link);
2167 dev->si_flags &= ~SI_DEVFS_LINKED;
2174 devfs_node_is_accessible(struct devfs_node *node)
2176 if ((node) && (!(node->flags & DEVFS_HIDDEN)))
2183 devfs_reference_ops(struct dev_ops *ops)
2186 struct devfs_dev_ops *found = NULL;
2187 struct devfs_dev_ops *devops;
2189 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2190 if (devops->ops == ops) {
2197 found = kmalloc(sizeof(struct devfs_dev_ops), M_DEVFS, M_WAITOK);
2199 found->ref_count = 0;
2200 TAILQ_INSERT_TAIL(&devfs_dev_ops_list, found, link);
2205 if (found->ref_count == 0) {
2206 found->id = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(ops_id), 255);
2207 if (found->id == -1) {
2208 /* Ran out of unique ids */
2209 devfs_debug(DEVFS_DEBUG_WARNING,
2210 "devfs_reference_ops: WARNING: ran out of unique ids\n");
2220 devfs_release_ops(struct dev_ops *ops)
2222 struct devfs_dev_ops *found = NULL;
2223 struct devfs_dev_ops *devops;
2225 TAILQ_FOREACH(devops, &devfs_dev_ops_list, link) {
2226 if (devops->ops == ops) {
2236 if (found->ref_count == 0) {
2237 TAILQ_REMOVE(&devfs_dev_ops_list, found, link);
2238 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(ops_id), found->id);
2239 kfree(found, M_DEVFS);
2248 msg = devfs_msg_get();
2249 msg = devfs_msg_send_sync(DEVFS_SYNC, msg);
2254 * Called on init of devfs; creates the objcaches and
2255 * spawns off the devfs core thread. Also initializes
2261 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init() called\n");
2262 /* Create objcaches for nodes, msgs and devs */
2263 devfs_node_cache = objcache_create("devfs-node-cache", 0, 0,
2265 objcache_malloc_alloc,
2266 objcache_malloc_free,
2267 &devfs_node_malloc_args );
2269 devfs_msg_cache = objcache_create("devfs-msg-cache", 0, 0,
2271 objcache_malloc_alloc,
2272 objcache_malloc_free,
2273 &devfs_msg_malloc_args );
2275 devfs_dev_cache = objcache_create("devfs-dev-cache", 0, 0,
2277 objcache_malloc_alloc,
2278 objcache_malloc_free,
2279 &devfs_dev_malloc_args );
2281 devfs_clone_bitmap_init(&DEVFS_CLONE_BITMAP(ops_id));
2283 /* Initialize the reply-only port which acts as a message drain */
2284 lwkt_initport_replyonly(&devfs_dispose_port, devfs_msg_autofree_reply);
2286 /* Initialize *THE* devfs lock */
2287 lockinit(&devfs_lock, "devfs_core lock", 0, 0);
2290 lwkt_create(devfs_msg_core, /*args*/NULL, &td_core, NULL,
2291 0, 0, "devfs_msg_core");
2293 tsleep(td_core/*devfs_id*/, 0, "devfsc", 0);
2295 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_init finished\n");
2299 * Called on unload of devfs; takes care of destroying the core
2300 * and the objcaches. Also removes aliases that are no longer needed.
2305 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs_uninit() called\n");
2307 devfs_msg_send(DEVFS_TERMINATE_CORE, NULL);
2309 tsleep(td_core/*devfs_id*/, 0, "devfsc", 0);
2310 tsleep(td_core/*devfs_id*/, 0, "devfsc", 10000);
2312 devfs_clone_bitmap_uninit(&DEVFS_CLONE_BITMAP(ops_id));
2314 /* Destroy the objcaches */
2315 objcache_destroy(devfs_msg_cache);
2316 objcache_destroy(devfs_node_cache);
2317 objcache_destroy(devfs_dev_cache);
2323 * This is a sysctl handler to assist userland devname(3) to
2324 * find the device name for a given udev.
2327 devfs_sysctl_devname_helper(SYSCTL_HANDLER_ARGS)
2334 if ((error = SYSCTL_IN(req, &udev, sizeof(udev_t))))
2337 devfs_debug(DEVFS_DEBUG_DEBUG, "devfs sysctl, received udev: %d\n", udev);
2342 if ((found = devfs_find_device_by_udev(udev)) == NULL)
2345 return(SYSCTL_OUT(req, found->si_name, strlen(found->si_name) + 1));
2349 SYSCTL_PROC(_kern, OID_AUTO, devname, CTLTYPE_OPAQUE|CTLFLAG_RW|CTLFLAG_ANYBODY,
2350 NULL, 0, devfs_sysctl_devname_helper, "", "helper for devname(3)");
2352 static SYSCTL_NODE(_vfs, OID_AUTO, devfs, CTLFLAG_RW, 0, "devfs");
2353 TUNABLE_INT("vfs.devfs.debug", &devfs_debug_enable);
2354 SYSCTL_INT(_vfs_devfs, OID_AUTO, debug, CTLFLAG_RW, &devfs_debug_enable,
2355 0, "Enable DevFS debugging");
2357 SYSINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
2359 SYSUNINIT(vfs_devfs_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY,
2360 devfs_uninit, NULL);