xref: /linux-6.15/drivers/base/devtmpfs.c (revision 80422738)
12b2af54aSKay Sievers /*
22b2af54aSKay Sievers  * devtmpfs - kernel-maintained tmpfs-based /dev
32b2af54aSKay Sievers  *
42b2af54aSKay Sievers  * Copyright (C) 2009, Kay Sievers <[email protected]>
52b2af54aSKay Sievers  *
62b2af54aSKay Sievers  * During bootup, before any driver core device is registered,
72b2af54aSKay Sievers  * devtmpfs, a tmpfs-based filesystem is created. Every driver-core
82b2af54aSKay Sievers  * device which requests a device node, will add a node in this
9e454cea2SKay Sievers  * filesystem.
10e454cea2SKay Sievers  * By default, all devices are named after the the name of the
11e454cea2SKay Sievers  * device, owned by root and have a default mode of 0600. Subsystems
12e454cea2SKay Sievers  * can overwrite the default setting if needed.
132b2af54aSKay Sievers  */
142b2af54aSKay Sievers 
152b2af54aSKay Sievers #include <linux/kernel.h>
162b2af54aSKay Sievers #include <linux/syscalls.h>
172b2af54aSKay Sievers #include <linux/mount.h>
182b2af54aSKay Sievers #include <linux/device.h>
192b2af54aSKay Sievers #include <linux/genhd.h>
202b2af54aSKay Sievers #include <linux/namei.h>
212b2af54aSKay Sievers #include <linux/fs.h>
222b2af54aSKay Sievers #include <linux/shmem_fs.h>
232b2af54aSKay Sievers #include <linux/cred.h>
24e454cea2SKay Sievers #include <linux/sched.h>
252b2af54aSKay Sievers #include <linux/init_task.h>
262b2af54aSKay Sievers 
272b2af54aSKay Sievers static struct vfsmount *dev_mnt;
282b2af54aSKay Sievers 
292b2af54aSKay Sievers #if defined CONFIG_DEVTMPFS_MOUNT
302b2af54aSKay Sievers static int dev_mount = 1;
312b2af54aSKay Sievers #else
322b2af54aSKay Sievers static int dev_mount;
332b2af54aSKay Sievers #endif
342b2af54aSKay Sievers 
35f1f76f86SThomas Gleixner static DEFINE_MUTEX(dirlock);
36ed413ae6SKay Sievers 
372b2af54aSKay Sievers static int __init mount_param(char *str)
382b2af54aSKay Sievers {
392b2af54aSKay Sievers 	dev_mount = simple_strtoul(str, NULL, 0);
402b2af54aSKay Sievers 	return 1;
412b2af54aSKay Sievers }
422b2af54aSKay Sievers __setup("devtmpfs.mount=", mount_param);
432b2af54aSKay Sievers 
442b2af54aSKay Sievers static int dev_get_sb(struct file_system_type *fs_type, int flags,
452b2af54aSKay Sievers 		      const char *dev_name, void *data, struct vfsmount *mnt)
462b2af54aSKay Sievers {
472b2af54aSKay Sievers 	return get_sb_single(fs_type, flags, data, shmem_fill_super, mnt);
482b2af54aSKay Sievers }
492b2af54aSKay Sievers 
502b2af54aSKay Sievers static struct file_system_type dev_fs_type = {
512b2af54aSKay Sievers 	.name = "devtmpfs",
522b2af54aSKay Sievers 	.get_sb = dev_get_sb,
532b2af54aSKay Sievers 	.kill_sb = kill_litter_super,
542b2af54aSKay Sievers };
552b2af54aSKay Sievers 
562b2af54aSKay Sievers #ifdef CONFIG_BLOCK
572b2af54aSKay Sievers static inline int is_blockdev(struct device *dev)
582b2af54aSKay Sievers {
592b2af54aSKay Sievers 	return dev->class == &block_class;
602b2af54aSKay Sievers }
612b2af54aSKay Sievers #else
622b2af54aSKay Sievers static inline int is_blockdev(struct device *dev) { return 0; }
632b2af54aSKay Sievers #endif
642b2af54aSKay Sievers 
652b2af54aSKay Sievers static int dev_mkdir(const char *name, mode_t mode)
662b2af54aSKay Sievers {
672b2af54aSKay Sievers 	struct nameidata nd;
682b2af54aSKay Sievers 	struct dentry *dentry;
692b2af54aSKay Sievers 	int err;
702b2af54aSKay Sievers 
712b2af54aSKay Sievers 	err = vfs_path_lookup(dev_mnt->mnt_root, dev_mnt,
722b2af54aSKay Sievers 			      name, LOOKUP_PARENT, &nd);
732b2af54aSKay Sievers 	if (err)
742b2af54aSKay Sievers 		return err;
752b2af54aSKay Sievers 
762b2af54aSKay Sievers 	dentry = lookup_create(&nd, 1);
772b2af54aSKay Sievers 	if (!IS_ERR(dentry)) {
782b2af54aSKay Sievers 		err = vfs_mkdir(nd.path.dentry->d_inode, dentry, mode);
79015bf43bSKay Sievers 		if (!err)
80015bf43bSKay Sievers 			/* mark as kernel-created inode */
81015bf43bSKay Sievers 			dentry->d_inode->i_private = &dev_mnt;
822b2af54aSKay Sievers 		dput(dentry);
832b2af54aSKay Sievers 	} else {
842b2af54aSKay Sievers 		err = PTR_ERR(dentry);
852b2af54aSKay Sievers 	}
862b2af54aSKay Sievers 
87015bf43bSKay Sievers 	mutex_unlock(&nd.path.dentry->d_inode->i_mutex);
882b2af54aSKay Sievers 	path_put(&nd.path);
892b2af54aSKay Sievers 	return err;
902b2af54aSKay Sievers }
912b2af54aSKay Sievers 
922b2af54aSKay Sievers static int create_path(const char *nodepath)
932b2af54aSKay Sievers {
94015bf43bSKay Sievers 	int err;
952b2af54aSKay Sievers 
96f1f76f86SThomas Gleixner 	mutex_lock(&dirlock);
97015bf43bSKay Sievers 	err = dev_mkdir(nodepath, 0755);
98015bf43bSKay Sievers 	if (err == -ENOENT) {
99ed413ae6SKay Sievers 		char *path;
1002b2af54aSKay Sievers 		char *s;
1012b2af54aSKay Sievers 
1022b2af54aSKay Sievers 		/* parent directories do not exist, create them */
103ed413ae6SKay Sievers 		path = kstrdup(nodepath, GFP_KERNEL);
104*80422738SKay Sievers 		if (!path) {
105*80422738SKay Sievers 			err = -ENOMEM;
106*80422738SKay Sievers 			goto out;
107*80422738SKay Sievers 		}
1082b2af54aSKay Sievers 		s = path;
109ed413ae6SKay Sievers 		for (;;) {
1102b2af54aSKay Sievers 			s = strchr(s, '/');
1112b2af54aSKay Sievers 			if (!s)
1122b2af54aSKay Sievers 				break;
1132b2af54aSKay Sievers 			s[0] = '\0';
1142b2af54aSKay Sievers 			err = dev_mkdir(path, 0755);
1152b2af54aSKay Sievers 			if (err && err != -EEXIST)
1162b2af54aSKay Sievers 				break;
1172b2af54aSKay Sievers 			s[0] = '/';
1182b2af54aSKay Sievers 			s++;
1192b2af54aSKay Sievers 		}
1202b2af54aSKay Sievers 		kfree(path);
121ed413ae6SKay Sievers 	}
122*80422738SKay Sievers out:
123f1f76f86SThomas Gleixner 	mutex_unlock(&dirlock);
1242b2af54aSKay Sievers 	return err;
1252b2af54aSKay Sievers }
1262b2af54aSKay Sievers 
1272b2af54aSKay Sievers int devtmpfs_create_node(struct device *dev)
1282b2af54aSKay Sievers {
1292b2af54aSKay Sievers 	const char *tmp = NULL;
1302b2af54aSKay Sievers 	const char *nodename;
1312b2af54aSKay Sievers 	const struct cred *curr_cred;
132e454cea2SKay Sievers 	mode_t mode = 0;
1332b2af54aSKay Sievers 	struct nameidata nd;
1342b2af54aSKay Sievers 	struct dentry *dentry;
1352b2af54aSKay Sievers 	int err;
1362b2af54aSKay Sievers 
1372b2af54aSKay Sievers 	if (!dev_mnt)
1382b2af54aSKay Sievers 		return 0;
1392b2af54aSKay Sievers 
140e454cea2SKay Sievers 	nodename = device_get_devnode(dev, &mode, &tmp);
1412b2af54aSKay Sievers 	if (!nodename)
1422b2af54aSKay Sievers 		return -ENOMEM;
1432b2af54aSKay Sievers 
144e454cea2SKay Sievers 	if (mode == 0)
145e454cea2SKay Sievers 		mode = 0600;
1462b2af54aSKay Sievers 	if (is_blockdev(dev))
147e454cea2SKay Sievers 		mode |= S_IFBLK;
1482b2af54aSKay Sievers 	else
149e454cea2SKay Sievers 		mode |= S_IFCHR;
1502b2af54aSKay Sievers 
1512b2af54aSKay Sievers 	curr_cred = override_creds(&init_cred);
15200926996SKay Sievers 
1532b2af54aSKay Sievers 	err = vfs_path_lookup(dev_mnt->mnt_root, dev_mnt,
1542b2af54aSKay Sievers 			      nodename, LOOKUP_PARENT, &nd);
1552b2af54aSKay Sievers 	if (err == -ENOENT) {
1562b2af54aSKay Sievers 		create_path(nodename);
1572b2af54aSKay Sievers 		err = vfs_path_lookup(dev_mnt->mnt_root, dev_mnt,
1582b2af54aSKay Sievers 				      nodename, LOOKUP_PARENT, &nd);
15900926996SKay Sievers 	}
1602b2af54aSKay Sievers 	if (err)
1612b2af54aSKay Sievers 		goto out;
1622b2af54aSKay Sievers 
1632b2af54aSKay Sievers 	dentry = lookup_create(&nd, 0);
1642b2af54aSKay Sievers 	if (!IS_ERR(dentry)) {
1652b2af54aSKay Sievers 		err = vfs_mknod(nd.path.dentry->d_inode,
1662b2af54aSKay Sievers 				dentry, mode, dev->devt);
16700926996SKay Sievers 		if (!err) {
16800926996SKay Sievers 			struct iattr newattrs;
16900926996SKay Sievers 
17000926996SKay Sievers 			/* fixup possibly umasked mode */
17100926996SKay Sievers 			newattrs.ia_mode = mode;
17200926996SKay Sievers 			newattrs.ia_valid = ATTR_MODE;
17300926996SKay Sievers 			mutex_lock(&dentry->d_inode->i_mutex);
17400926996SKay Sievers 			notify_change(dentry, &newattrs);
17500926996SKay Sievers 			mutex_unlock(&dentry->d_inode->i_mutex);
17600926996SKay Sievers 
17700926996SKay Sievers 			/* mark as kernel-created inode */
1782b2af54aSKay Sievers 			dentry->d_inode->i_private = &dev_mnt;
17900926996SKay Sievers 		}
1802b2af54aSKay Sievers 		dput(dentry);
1812b2af54aSKay Sievers 	} else {
1822b2af54aSKay Sievers 		err = PTR_ERR(dentry);
1832b2af54aSKay Sievers 	}
1842b2af54aSKay Sievers 
18500926996SKay Sievers 	mutex_unlock(&nd.path.dentry->d_inode->i_mutex);
1862b2af54aSKay Sievers 	path_put(&nd.path);
1872b2af54aSKay Sievers out:
1882b2af54aSKay Sievers 	kfree(tmp);
1892b2af54aSKay Sievers 	revert_creds(curr_cred);
1902b2af54aSKay Sievers 	return err;
1912b2af54aSKay Sievers }
1922b2af54aSKay Sievers 
1932b2af54aSKay Sievers static int dev_rmdir(const char *name)
1942b2af54aSKay Sievers {
1952b2af54aSKay Sievers 	struct nameidata nd;
1962b2af54aSKay Sievers 	struct dentry *dentry;
1972b2af54aSKay Sievers 	int err;
1982b2af54aSKay Sievers 
1992b2af54aSKay Sievers 	err = vfs_path_lookup(dev_mnt->mnt_root, dev_mnt,
2002b2af54aSKay Sievers 			      name, LOOKUP_PARENT, &nd);
2012b2af54aSKay Sievers 	if (err)
2022b2af54aSKay Sievers 		return err;
2032b2af54aSKay Sievers 
2042b2af54aSKay Sievers 	mutex_lock_nested(&nd.path.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
2052b2af54aSKay Sievers 	dentry = lookup_one_len(nd.last.name, nd.path.dentry, nd.last.len);
2062b2af54aSKay Sievers 	if (!IS_ERR(dentry)) {
207015bf43bSKay Sievers 		if (dentry->d_inode) {
208015bf43bSKay Sievers 			if (dentry->d_inode->i_private == &dev_mnt)
209015bf43bSKay Sievers 				err = vfs_rmdir(nd.path.dentry->d_inode,
210015bf43bSKay Sievers 						dentry);
2112b2af54aSKay Sievers 			else
212015bf43bSKay Sievers 				err = -EPERM;
213015bf43bSKay Sievers 		} else {
2142b2af54aSKay Sievers 			err = -ENOENT;
215015bf43bSKay Sievers 		}
2162b2af54aSKay Sievers 		dput(dentry);
2172b2af54aSKay Sievers 	} else {
2182b2af54aSKay Sievers 		err = PTR_ERR(dentry);
2192b2af54aSKay Sievers 	}
2202b2af54aSKay Sievers 
221015bf43bSKay Sievers 	mutex_unlock(&nd.path.dentry->d_inode->i_mutex);
2222b2af54aSKay Sievers 	path_put(&nd.path);
2232b2af54aSKay Sievers 	return err;
2242b2af54aSKay Sievers }
2252b2af54aSKay Sievers 
2262b2af54aSKay Sievers static int delete_path(const char *nodepath)
2272b2af54aSKay Sievers {
2282b2af54aSKay Sievers 	const char *path;
2292b2af54aSKay Sievers 	int err = 0;
2302b2af54aSKay Sievers 
2312b2af54aSKay Sievers 	path = kstrdup(nodepath, GFP_KERNEL);
2322b2af54aSKay Sievers 	if (!path)
2332b2af54aSKay Sievers 		return -ENOMEM;
2342b2af54aSKay Sievers 
235f1f76f86SThomas Gleixner 	mutex_lock(&dirlock);
236ed413ae6SKay Sievers 	for (;;) {
2372b2af54aSKay Sievers 		char *base;
2382b2af54aSKay Sievers 
2392b2af54aSKay Sievers 		base = strrchr(path, '/');
2402b2af54aSKay Sievers 		if (!base)
2412b2af54aSKay Sievers 			break;
2422b2af54aSKay Sievers 		base[0] = '\0';
2432b2af54aSKay Sievers 		err = dev_rmdir(path);
2442b2af54aSKay Sievers 		if (err)
2452b2af54aSKay Sievers 			break;
2462b2af54aSKay Sievers 	}
247f1f76f86SThomas Gleixner 	mutex_unlock(&dirlock);
2482b2af54aSKay Sievers 
2492b2af54aSKay Sievers 	kfree(path);
2502b2af54aSKay Sievers 	return err;
2512b2af54aSKay Sievers }
2522b2af54aSKay Sievers 
2532b2af54aSKay Sievers static int dev_mynode(struct device *dev, struct inode *inode, struct kstat *stat)
2542b2af54aSKay Sievers {
2552b2af54aSKay Sievers 	/* did we create it */
2562b2af54aSKay Sievers 	if (inode->i_private != &dev_mnt)
2572b2af54aSKay Sievers 		return 0;
2582b2af54aSKay Sievers 
2592b2af54aSKay Sievers 	/* does the dev_t match */
2602b2af54aSKay Sievers 	if (is_blockdev(dev)) {
2612b2af54aSKay Sievers 		if (!S_ISBLK(stat->mode))
2622b2af54aSKay Sievers 			return 0;
2632b2af54aSKay Sievers 	} else {
2642b2af54aSKay Sievers 		if (!S_ISCHR(stat->mode))
2652b2af54aSKay Sievers 			return 0;
2662b2af54aSKay Sievers 	}
2672b2af54aSKay Sievers 	if (stat->rdev != dev->devt)
2682b2af54aSKay Sievers 		return 0;
2692b2af54aSKay Sievers 
2702b2af54aSKay Sievers 	/* ours */
2712b2af54aSKay Sievers 	return 1;
2722b2af54aSKay Sievers }
2732b2af54aSKay Sievers 
2742b2af54aSKay Sievers int devtmpfs_delete_node(struct device *dev)
2752b2af54aSKay Sievers {
2762b2af54aSKay Sievers 	const char *tmp = NULL;
2772b2af54aSKay Sievers 	const char *nodename;
2782b2af54aSKay Sievers 	const struct cred *curr_cred;
2792b2af54aSKay Sievers 	struct nameidata nd;
2802b2af54aSKay Sievers 	struct dentry *dentry;
2812b2af54aSKay Sievers 	struct kstat stat;
2822b2af54aSKay Sievers 	int deleted = 1;
2832b2af54aSKay Sievers 	int err;
2842b2af54aSKay Sievers 
2852b2af54aSKay Sievers 	if (!dev_mnt)
2862b2af54aSKay Sievers 		return 0;
2872b2af54aSKay Sievers 
288e454cea2SKay Sievers 	nodename = device_get_devnode(dev, NULL, &tmp);
2892b2af54aSKay Sievers 	if (!nodename)
2902b2af54aSKay Sievers 		return -ENOMEM;
2912b2af54aSKay Sievers 
2922b2af54aSKay Sievers 	curr_cred = override_creds(&init_cred);
2932b2af54aSKay Sievers 	err = vfs_path_lookup(dev_mnt->mnt_root, dev_mnt,
2942b2af54aSKay Sievers 			      nodename, LOOKUP_PARENT, &nd);
2952b2af54aSKay Sievers 	if (err)
2962b2af54aSKay Sievers 		goto out;
2972b2af54aSKay Sievers 
2982b2af54aSKay Sievers 	mutex_lock_nested(&nd.path.dentry->d_inode->i_mutex, I_MUTEX_PARENT);
2992b2af54aSKay Sievers 	dentry = lookup_one_len(nd.last.name, nd.path.dentry, nd.last.len);
3002b2af54aSKay Sievers 	if (!IS_ERR(dentry)) {
3012b2af54aSKay Sievers 		if (dentry->d_inode) {
3022b2af54aSKay Sievers 			err = vfs_getattr(nd.path.mnt, dentry, &stat);
3032b2af54aSKay Sievers 			if (!err && dev_mynode(dev, dentry->d_inode, &stat)) {
3042b2af54aSKay Sievers 				err = vfs_unlink(nd.path.dentry->d_inode,
3052b2af54aSKay Sievers 						 dentry);
3062b2af54aSKay Sievers 				if (!err || err == -ENOENT)
3072b2af54aSKay Sievers 					deleted = 1;
3082b2af54aSKay Sievers 			}
3092b2af54aSKay Sievers 		} else {
3102b2af54aSKay Sievers 			err = -ENOENT;
3112b2af54aSKay Sievers 		}
3122b2af54aSKay Sievers 		dput(dentry);
3132b2af54aSKay Sievers 	} else {
3142b2af54aSKay Sievers 		err = PTR_ERR(dentry);
3152b2af54aSKay Sievers 	}
3162b2af54aSKay Sievers 	mutex_unlock(&nd.path.dentry->d_inode->i_mutex);
3172b2af54aSKay Sievers 
3182b2af54aSKay Sievers 	path_put(&nd.path);
3192b2af54aSKay Sievers 	if (deleted && strchr(nodename, '/'))
3202b2af54aSKay Sievers 		delete_path(nodename);
3212b2af54aSKay Sievers out:
3222b2af54aSKay Sievers 	kfree(tmp);
3232b2af54aSKay Sievers 	revert_creds(curr_cred);
3242b2af54aSKay Sievers 	return err;
3252b2af54aSKay Sievers }
3262b2af54aSKay Sievers 
3272b2af54aSKay Sievers /*
3282b2af54aSKay Sievers  * If configured, or requested by the commandline, devtmpfs will be
3292b2af54aSKay Sievers  * auto-mounted after the kernel mounted the root filesystem.
3302b2af54aSKay Sievers  */
331073120ccSKay Sievers int devtmpfs_mount(const char *mntdir)
3322b2af54aSKay Sievers {
3332b2af54aSKay Sievers 	int err;
3342b2af54aSKay Sievers 
3352b2af54aSKay Sievers 	if (!dev_mount)
3362b2af54aSKay Sievers 		return 0;
3372b2af54aSKay Sievers 
3382b2af54aSKay Sievers 	if (!dev_mnt)
3392b2af54aSKay Sievers 		return 0;
3402b2af54aSKay Sievers 
341073120ccSKay Sievers 	err = sys_mount("devtmpfs", (char *)mntdir, "devtmpfs", MS_SILENT, NULL);
3422b2af54aSKay Sievers 	if (err)
3432b2af54aSKay Sievers 		printk(KERN_INFO "devtmpfs: error mounting %i\n", err);
3442b2af54aSKay Sievers 	else
3452b2af54aSKay Sievers 		printk(KERN_INFO "devtmpfs: mounted\n");
3462b2af54aSKay Sievers 	return err;
3472b2af54aSKay Sievers }
3482b2af54aSKay Sievers 
3492b2af54aSKay Sievers /*
3502b2af54aSKay Sievers  * Create devtmpfs instance, driver-core devices will add their device
3512b2af54aSKay Sievers  * nodes here.
3522b2af54aSKay Sievers  */
3532b2af54aSKay Sievers int __init devtmpfs_init(void)
3542b2af54aSKay Sievers {
3552b2af54aSKay Sievers 	int err;
3562b2af54aSKay Sievers 	struct vfsmount *mnt;
3572b2af54aSKay Sievers 
3582b2af54aSKay Sievers 	err = register_filesystem(&dev_fs_type);
3592b2af54aSKay Sievers 	if (err) {
3602b2af54aSKay Sievers 		printk(KERN_ERR "devtmpfs: unable to register devtmpfs "
3612b2af54aSKay Sievers 		       "type %i\n", err);
3622b2af54aSKay Sievers 		return err;
3632b2af54aSKay Sievers 	}
3642b2af54aSKay Sievers 
36503d673e6SKay Sievers 	mnt = kern_mount_data(&dev_fs_type, "mode=0755");
3662b2af54aSKay Sievers 	if (IS_ERR(mnt)) {
3672b2af54aSKay Sievers 		err = PTR_ERR(mnt);
3682b2af54aSKay Sievers 		printk(KERN_ERR "devtmpfs: unable to create devtmpfs %i\n", err);
3692b2af54aSKay Sievers 		unregister_filesystem(&dev_fs_type);
3702b2af54aSKay Sievers 		return err;
3712b2af54aSKay Sievers 	}
3722b2af54aSKay Sievers 	dev_mnt = mnt;
3732b2af54aSKay Sievers 
3742b2af54aSKay Sievers 	printk(KERN_INFO "devtmpfs: initialized\n");
3752b2af54aSKay Sievers 	return 0;
3762b2af54aSKay Sievers }
377