xref: /openbmc/linux/fs/devpts/inode.c (revision b87a267e)
11da177e4SLinus Torvalds /* -*- linux-c -*- --------------------------------------------------------- *
21da177e4SLinus Torvalds  *
31da177e4SLinus Torvalds  * linux/fs/devpts/inode.c
41da177e4SLinus Torvalds  *
51da177e4SLinus Torvalds  *  Copyright 1998-2004 H. Peter Anvin -- All Rights Reserved
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  * This file is part of the Linux kernel and is made available under
81da177e4SLinus Torvalds  * the terms of the GNU General Public License, version 2, or at your
91da177e4SLinus Torvalds  * option, any later version, incorporated herein by reference.
101da177e4SLinus Torvalds  *
111da177e4SLinus Torvalds  * ------------------------------------------------------------------------- */
121da177e4SLinus Torvalds 
131da177e4SLinus Torvalds #include <linux/module.h>
141da177e4SLinus Torvalds #include <linux/init.h>
151da177e4SLinus Torvalds #include <linux/fs.h>
161da177e4SLinus Torvalds #include <linux/sched.h>
171da177e4SLinus Torvalds #include <linux/namei.h>
181da177e4SLinus Torvalds #include <linux/mount.h>
191da177e4SLinus Torvalds #include <linux/tty.h>
201da177e4SLinus Torvalds #include <linux/devpts_fs.h>
217a673c6bSDomen Puncer #include <linux/parser.h>
223972b7f6SFlorin Malita #include <linux/fsnotify.h>
23b87a267eSMiklos Szeredi #include <linux/seq_file.h>
241da177e4SLinus Torvalds 
251da177e4SLinus Torvalds #define DEVPTS_SUPER_MAGIC 0x1cd1
261da177e4SLinus Torvalds 
27b87a267eSMiklos Szeredi #define DEVPTS_DEFAULT_MODE 0600
28b87a267eSMiklos Szeredi 
291da177e4SLinus Torvalds static struct vfsmount *devpts_mnt;
301da177e4SLinus Torvalds static struct dentry *devpts_root;
311da177e4SLinus Torvalds 
321da177e4SLinus Torvalds static struct {
331da177e4SLinus Torvalds 	int setuid;
341da177e4SLinus Torvalds 	int setgid;
351da177e4SLinus Torvalds 	uid_t   uid;
361da177e4SLinus Torvalds 	gid_t   gid;
371da177e4SLinus Torvalds 	umode_t mode;
38b87a267eSMiklos Szeredi } config = {.mode = DEVPTS_DEFAULT_MODE};
391da177e4SLinus Torvalds 
407a673c6bSDomen Puncer enum {
417a673c6bSDomen Puncer 	Opt_uid, Opt_gid, Opt_mode,
427a673c6bSDomen Puncer 	Opt_err
437a673c6bSDomen Puncer };
447a673c6bSDomen Puncer 
457a673c6bSDomen Puncer static match_table_t tokens = {
467a673c6bSDomen Puncer 	{Opt_uid, "uid=%u"},
477a673c6bSDomen Puncer 	{Opt_gid, "gid=%u"},
487a673c6bSDomen Puncer 	{Opt_mode, "mode=%o"},
497a673c6bSDomen Puncer 	{Opt_err, NULL}
507a673c6bSDomen Puncer };
517a673c6bSDomen Puncer 
521da177e4SLinus Torvalds static int devpts_remount(struct super_block *sb, int *flags, char *data)
531da177e4SLinus Torvalds {
547a673c6bSDomen Puncer 	char *p;
551da177e4SLinus Torvalds 
567a673c6bSDomen Puncer 	config.setuid  = 0;
577a673c6bSDomen Puncer 	config.setgid  = 0;
587a673c6bSDomen Puncer 	config.uid     = 0;
597a673c6bSDomen Puncer 	config.gid     = 0;
60b87a267eSMiklos Szeredi 	config.mode    = DEVPTS_DEFAULT_MODE;
617a673c6bSDomen Puncer 
627a673c6bSDomen Puncer 	while ((p = strsep(&data, ",")) != NULL) {
637a673c6bSDomen Puncer 		substring_t args[MAX_OPT_ARGS];
647a673c6bSDomen Puncer 		int token;
657a673c6bSDomen Puncer 		int option;
667a673c6bSDomen Puncer 
677a673c6bSDomen Puncer 		if (!*p)
681da177e4SLinus Torvalds 			continue;
697a673c6bSDomen Puncer 
707a673c6bSDomen Puncer 		token = match_token(p, tokens, args);
717a673c6bSDomen Puncer 		switch (token) {
727a673c6bSDomen Puncer 		case Opt_uid:
737a673c6bSDomen Puncer 			if (match_int(&args[0], &option))
747a673c6bSDomen Puncer 				return -EINVAL;
757a673c6bSDomen Puncer 			config.uid = option;
767a673c6bSDomen Puncer 			config.setuid = 1;
777a673c6bSDomen Puncer 			break;
787a673c6bSDomen Puncer 		case Opt_gid:
797a673c6bSDomen Puncer 			if (match_int(&args[0], &option))
807a673c6bSDomen Puncer 				return -EINVAL;
817a673c6bSDomen Puncer 			config.gid = option;
827a673c6bSDomen Puncer 			config.setgid = 1;
837a673c6bSDomen Puncer 			break;
847a673c6bSDomen Puncer 		case Opt_mode:
857a673c6bSDomen Puncer 			if (match_octal(&args[0], &option))
867a673c6bSDomen Puncer 				return -EINVAL;
87b87a267eSMiklos Szeredi 			config.mode = option & S_IALLUGO;
887a673c6bSDomen Puncer 			break;
897a673c6bSDomen Puncer 		default:
907a673c6bSDomen Puncer 			printk(KERN_ERR "devpts: called with bogus options\n");
911da177e4SLinus Torvalds 			return -EINVAL;
921da177e4SLinus Torvalds 		}
931da177e4SLinus Torvalds 	}
941da177e4SLinus Torvalds 
951da177e4SLinus Torvalds 	return 0;
961da177e4SLinus Torvalds }
971da177e4SLinus Torvalds 
98b87a267eSMiklos Szeredi static int devpts_show_options(struct seq_file *seq, struct vfsmount *vfs)
99b87a267eSMiklos Szeredi {
100b87a267eSMiklos Szeredi 	if (config.setuid)
101b87a267eSMiklos Szeredi 		seq_printf(seq, ",uid=%u", config.uid);
102b87a267eSMiklos Szeredi 	if (config.setgid)
103b87a267eSMiklos Szeredi 		seq_printf(seq, ",gid=%u", config.gid);
104b87a267eSMiklos Szeredi 	seq_printf(seq, ",mode=%03o", config.mode);
105b87a267eSMiklos Szeredi 
106b87a267eSMiklos Szeredi 	return 0;
107b87a267eSMiklos Szeredi }
108b87a267eSMiklos Szeredi 
109ee9b6d61SJosef 'Jeff' Sipek static const struct super_operations devpts_sops = {
1101da177e4SLinus Torvalds 	.statfs		= simple_statfs,
1111da177e4SLinus Torvalds 	.remount_fs	= devpts_remount,
112b87a267eSMiklos Szeredi 	.show_options	= devpts_show_options,
1131da177e4SLinus Torvalds };
1141da177e4SLinus Torvalds 
1151da177e4SLinus Torvalds static int
1161da177e4SLinus Torvalds devpts_fill_super(struct super_block *s, void *data, int silent)
1171da177e4SLinus Torvalds {
1181da177e4SLinus Torvalds 	struct inode * inode;
1191da177e4SLinus Torvalds 
1201da177e4SLinus Torvalds 	s->s_blocksize = 1024;
1211da177e4SLinus Torvalds 	s->s_blocksize_bits = 10;
1221da177e4SLinus Torvalds 	s->s_magic = DEVPTS_SUPER_MAGIC;
1231da177e4SLinus Torvalds 	s->s_op = &devpts_sops;
1241da177e4SLinus Torvalds 	s->s_time_gran = 1;
1251da177e4SLinus Torvalds 
1261da177e4SLinus Torvalds 	inode = new_inode(s);
1271da177e4SLinus Torvalds 	if (!inode)
1281da177e4SLinus Torvalds 		goto fail;
1291da177e4SLinus Torvalds 	inode->i_ino = 1;
1301da177e4SLinus Torvalds 	inode->i_mtime = inode->i_atime = inode->i_ctime = CURRENT_TIME;
1311da177e4SLinus Torvalds 	inode->i_blocks = 0;
1321da177e4SLinus Torvalds 	inode->i_uid = inode->i_gid = 0;
1331da177e4SLinus Torvalds 	inode->i_mode = S_IFDIR | S_IRUGO | S_IXUGO | S_IWUSR;
1341da177e4SLinus Torvalds 	inode->i_op = &simple_dir_inode_operations;
1351da177e4SLinus Torvalds 	inode->i_fop = &simple_dir_operations;
1361da177e4SLinus Torvalds 	inode->i_nlink = 2;
1371da177e4SLinus Torvalds 
1381da177e4SLinus Torvalds 	devpts_root = s->s_root = d_alloc_root(inode);
1391da177e4SLinus Torvalds 	if (s->s_root)
1401da177e4SLinus Torvalds 		return 0;
1411da177e4SLinus Torvalds 
1421da177e4SLinus Torvalds 	printk("devpts: get root dentry failed\n");
1431da177e4SLinus Torvalds 	iput(inode);
1441da177e4SLinus Torvalds fail:
1451da177e4SLinus Torvalds 	return -ENOMEM;
1461da177e4SLinus Torvalds }
1471da177e4SLinus Torvalds 
148454e2398SDavid Howells static int devpts_get_sb(struct file_system_type *fs_type,
149454e2398SDavid Howells 	int flags, const char *dev_name, void *data, struct vfsmount *mnt)
1501da177e4SLinus Torvalds {
151454e2398SDavid Howells 	return get_sb_single(fs_type, flags, data, devpts_fill_super, mnt);
1521da177e4SLinus Torvalds }
1531da177e4SLinus Torvalds 
1541da177e4SLinus Torvalds static struct file_system_type devpts_fs_type = {
1551da177e4SLinus Torvalds 	.owner		= THIS_MODULE,
1561da177e4SLinus Torvalds 	.name		= "devpts",
1571da177e4SLinus Torvalds 	.get_sb		= devpts_get_sb,
1581da177e4SLinus Torvalds 	.kill_sb	= kill_anon_super,
1591da177e4SLinus Torvalds };
1601da177e4SLinus Torvalds 
1611da177e4SLinus Torvalds /*
1621da177e4SLinus Torvalds  * The normal naming convention is simply /dev/pts/<number>; this conforms
1631da177e4SLinus Torvalds  * to the System V naming convention
1641da177e4SLinus Torvalds  */
1651da177e4SLinus Torvalds 
1661da177e4SLinus Torvalds static struct dentry *get_node(int num)
1671da177e4SLinus Torvalds {
1681da177e4SLinus Torvalds 	char s[12];
1691da177e4SLinus Torvalds 	struct dentry *root = devpts_root;
1701b1dcc1bSJes Sorensen 	mutex_lock(&root->d_inode->i_mutex);
1711da177e4SLinus Torvalds 	return lookup_one_len(s, root, sprintf(s, "%d", num));
1721da177e4SLinus Torvalds }
1731da177e4SLinus Torvalds 
1741da177e4SLinus Torvalds int devpts_pty_new(struct tty_struct *tty)
1751da177e4SLinus Torvalds {
1761da177e4SLinus Torvalds 	int number = tty->index;
1771da177e4SLinus Torvalds 	struct tty_driver *driver = tty->driver;
1781da177e4SLinus Torvalds 	dev_t device = MKDEV(driver->major, driver->minor_start+number);
1791da177e4SLinus Torvalds 	struct dentry *dentry;
1801da177e4SLinus Torvalds 	struct inode *inode = new_inode(devpts_mnt->mnt_sb);
1811da177e4SLinus Torvalds 
1821da177e4SLinus Torvalds 	/* We're supposed to be given the slave end of a pty */
1831da177e4SLinus Torvalds 	BUG_ON(driver->type != TTY_DRIVER_TYPE_PTY);
1841da177e4SLinus Torvalds 	BUG_ON(driver->subtype != PTY_TYPE_SLAVE);
1851da177e4SLinus Torvalds 
1861da177e4SLinus Torvalds 	if (!inode)
1871da177e4SLinus Torvalds 		return -ENOMEM;
1881da177e4SLinus Torvalds 
1891da177e4SLinus Torvalds 	inode->i_ino = number+2;
1901da177e4SLinus Torvalds 	inode->i_uid = config.setuid ? config.uid : current->fsuid;
1911da177e4SLinus Torvalds 	inode->i_gid = config.setgid ? config.gid : current->fsgid;
1921da177e4SLinus Torvalds 	inode->i_mtime = inode->i_atime = inode->i_ctime = CURRENT_TIME;
1931da177e4SLinus Torvalds 	init_special_inode(inode, S_IFCHR|config.mode, device);
1948e18e294STheodore Ts'o 	inode->i_private = tty;
1951da177e4SLinus Torvalds 
1961da177e4SLinus Torvalds 	dentry = get_node(number);
1973972b7f6SFlorin Malita 	if (!IS_ERR(dentry) && !dentry->d_inode) {
1981da177e4SLinus Torvalds 		d_instantiate(dentry, inode);
1993972b7f6SFlorin Malita 		fsnotify_create(devpts_root->d_inode, dentry);
2003972b7f6SFlorin Malita 	}
2011da177e4SLinus Torvalds 
2021b1dcc1bSJes Sorensen 	mutex_unlock(&devpts_root->d_inode->i_mutex);
2031da177e4SLinus Torvalds 
2041da177e4SLinus Torvalds 	return 0;
2051da177e4SLinus Torvalds }
2061da177e4SLinus Torvalds 
2071da177e4SLinus Torvalds struct tty_struct *devpts_get_tty(int number)
2081da177e4SLinus Torvalds {
2091da177e4SLinus Torvalds 	struct dentry *dentry = get_node(number);
2101da177e4SLinus Torvalds 	struct tty_struct *tty;
2111da177e4SLinus Torvalds 
2121da177e4SLinus Torvalds 	tty = NULL;
2131da177e4SLinus Torvalds 	if (!IS_ERR(dentry)) {
2141da177e4SLinus Torvalds 		if (dentry->d_inode)
2158e18e294STheodore Ts'o 			tty = dentry->d_inode->i_private;
2161da177e4SLinus Torvalds 		dput(dentry);
2171da177e4SLinus Torvalds 	}
2181da177e4SLinus Torvalds 
2191b1dcc1bSJes Sorensen 	mutex_unlock(&devpts_root->d_inode->i_mutex);
2201da177e4SLinus Torvalds 
2211da177e4SLinus Torvalds 	return tty;
2221da177e4SLinus Torvalds }
2231da177e4SLinus Torvalds 
2241da177e4SLinus Torvalds void devpts_pty_kill(int number)
2251da177e4SLinus Torvalds {
2261da177e4SLinus Torvalds 	struct dentry *dentry = get_node(number);
2271da177e4SLinus Torvalds 
2281da177e4SLinus Torvalds 	if (!IS_ERR(dentry)) {
2291da177e4SLinus Torvalds 		struct inode *inode = dentry->d_inode;
2301da177e4SLinus Torvalds 		if (inode) {
2311da177e4SLinus Torvalds 			inode->i_nlink--;
2321da177e4SLinus Torvalds 			d_delete(dentry);
2331da177e4SLinus Torvalds 			dput(dentry);
2341da177e4SLinus Torvalds 		}
2351da177e4SLinus Torvalds 		dput(dentry);
2361da177e4SLinus Torvalds 	}
2371b1dcc1bSJes Sorensen 	mutex_unlock(&devpts_root->d_inode->i_mutex);
2381da177e4SLinus Torvalds }
2391da177e4SLinus Torvalds 
2401da177e4SLinus Torvalds static int __init init_devpts_fs(void)
2411da177e4SLinus Torvalds {
2421da177e4SLinus Torvalds 	int err = register_filesystem(&devpts_fs_type);
2431da177e4SLinus Torvalds 	if (!err) {
2441da177e4SLinus Torvalds 		devpts_mnt = kern_mount(&devpts_fs_type);
2451da177e4SLinus Torvalds 		if (IS_ERR(devpts_mnt))
2461da177e4SLinus Torvalds 			err = PTR_ERR(devpts_mnt);
2471da177e4SLinus Torvalds 	}
2481da177e4SLinus Torvalds 	return err;
2491da177e4SLinus Torvalds }
2501da177e4SLinus Torvalds 
2511da177e4SLinus Torvalds static void __exit exit_devpts_fs(void)
2521da177e4SLinus Torvalds {
2531da177e4SLinus Torvalds 	unregister_filesystem(&devpts_fs_type);
2541da177e4SLinus Torvalds 	mntput(devpts_mnt);
2551da177e4SLinus Torvalds }
2561da177e4SLinus Torvalds 
2571da177e4SLinus Torvalds module_init(init_devpts_fs)
2581da177e4SLinus Torvalds module_exit(exit_devpts_fs)
2591da177e4SLinus Torvalds MODULE_LICENSE("GPL");
260