1 /* -*- linux-c -*- --------------------------------------------------------- *
3 * linux/fs/devpts/inode.c
5 * Copyright 1998-2004 H. Peter Anvin -- All Rights Reserved
7 * This file is part of the Linux kernel and is made available under
8 * the terms of the GNU General Public License, version 2, or at your
9 * option, any later version, incorporated herein by reference.
11 * ------------------------------------------------------------------------- */
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/module.h>
16 #include <linux/init.h>
18 #include <linux/sched.h>
19 #include <linux/namei.h>
20 #include <linux/slab.h>
21 #include <linux/mount.h>
22 #include <linux/tty.h>
23 #include <linux/mutex.h>
24 #include <linux/magic.h>
25 #include <linux/idr.h>
26 #include <linux/devpts_fs.h>
27 #include <linux/parser.h>
28 #include <linux/fsnotify.h>
29 #include <linux/seq_file.h>
31 #define DEVPTS_DEFAULT_MODE 0600
33 * ptmx is a new node in /dev/pts and will be unused in legacy (single-
34 * instance) mode. To prevent surprises in user space, set permissions of
35 * ptmx to 0. Use 'chmod' or remount with '-o ptmxmode' to set meaningful
38 #define DEVPTS_DEFAULT_PTMX_MODE 0000
42 * sysctl support for setting limits on the number of Unix98 ptys allocated.
43 * Otherwise one can eat up all kernel memory by opening /dev/ptmx repeatedly.
45 static int pty_limit = NR_UNIX98_PTY_DEFAULT;
46 static int pty_reserve = NR_UNIX98_PTY_RESERVE;
47 static int pty_limit_min;
48 static int pty_limit_max = INT_MAX;
51 static struct ctl_table pty_table[] = {
54 .maxlen = sizeof(int),
57 .proc_handler = proc_dointvec_minmax,
58 .extra1 = &pty_limit_min,
59 .extra2 = &pty_limit_max,
61 .procname = "reserve",
62 .maxlen = sizeof(int),
65 .proc_handler = proc_dointvec_minmax,
66 .extra1 = &pty_limit_min,
67 .extra2 = &pty_limit_max,
70 .maxlen = sizeof(int),
73 .proc_handler = proc_dointvec,
78 static struct ctl_table pty_kern_table[] = {
87 static struct ctl_table pty_root_table[] = {
91 .child = pty_kern_table,
96 static DEFINE_MUTEX(allocated_ptys_lock);
98 struct pts_mount_opts {
110 Opt_uid, Opt_gid, Opt_mode, Opt_ptmxmode, Opt_newinstance, Opt_max,
114 static const match_table_t tokens = {
117 {Opt_mode, "mode=%o"},
118 {Opt_ptmxmode, "ptmxmode=%o"},
119 {Opt_newinstance, "newinstance"},
125 struct ida allocated_ptys;
126 struct pts_mount_opts mount_opts;
127 struct super_block *sb;
128 struct dentry *ptmx_dentry;
131 static inline struct pts_fs_info *DEVPTS_SB(struct super_block *sb)
133 return sb->s_fs_info;
136 static int devpts_ptmx_path(struct path *path)
138 struct super_block *sb;
141 /* Is a devpts filesystem at "pts" in the same directory? */
142 err = path_pts(path);
146 /* Is the path the root of a devpts filesystem? */
147 sb = path->mnt->mnt_sb;
148 if ((sb->s_magic != DEVPTS_SUPER_MAGIC) ||
149 (path->mnt->mnt_root != sb->s_root))
155 struct vfsmount *devpts_mntget(struct file *filp, struct pts_fs_info *fsi)
163 /* Walk upward while the start point is a bind mount of
166 while (path.mnt->mnt_root == path.dentry)
167 if (follow_up(&path) == 0)
170 /* devpts_ptmx_path() finds a devpts fs or returns an error. */
171 if ((path.mnt->mnt_sb->s_magic != DEVPTS_SUPER_MAGIC) ||
172 (DEVPTS_SB(path.mnt->mnt_sb) != fsi))
173 err = devpts_ptmx_path(&path);
176 if (DEVPTS_SB(path.mnt->mnt_sb) == fsi)
186 struct pts_fs_info *devpts_acquire(struct file *filp)
188 struct pts_fs_info *result;
190 struct super_block *sb;
195 /* Has the devpts filesystem already been found? */
196 if (path.mnt->mnt_sb->s_magic != DEVPTS_SUPER_MAGIC) {
199 err = devpts_ptmx_path(&path);
201 result = ERR_PTR(err);
207 * pty code needs to hold extra references in case of last /dev/tty close
209 sb = path.mnt->mnt_sb;
210 atomic_inc(&sb->s_active);
211 result = DEVPTS_SB(sb);
218 void devpts_release(struct pts_fs_info *fsi)
220 deactivate_super(fsi->sb);
223 #define PARSE_MOUNT 0
224 #define PARSE_REMOUNT 1
227 * parse_mount_options():
228 * Set @opts to mount options specified in @data. If an option is not
229 * specified in @data, set it to its default value.
231 * Note: @data may be NULL (in which case all options are set to default).
233 static int parse_mount_options(char *data, int op, struct pts_mount_opts *opts)
241 opts->uid = GLOBAL_ROOT_UID;
242 opts->gid = GLOBAL_ROOT_GID;
243 opts->mode = DEVPTS_DEFAULT_MODE;
244 opts->ptmxmode = DEVPTS_DEFAULT_PTMX_MODE;
245 opts->max = NR_UNIX98_PTY_MAX;
247 /* Only allow instances mounted from the initial mount
248 * namespace to tap the reserve pool of ptys.
250 if (op == PARSE_MOUNT)
252 (current->nsproxy->mnt_ns == init_task.nsproxy->mnt_ns);
254 while ((p = strsep(&data, ",")) != NULL) {
255 substring_t args[MAX_OPT_ARGS];
262 token = match_token(p, tokens, args);
265 if (match_int(&args[0], &option))
267 uid = make_kuid(current_user_ns(), option);
274 if (match_int(&args[0], &option))
276 gid = make_kgid(current_user_ns(), option);
283 if (match_octal(&args[0], &option))
285 opts->mode = option & S_IALLUGO;
288 if (match_octal(&args[0], &option))
290 opts->ptmxmode = option & S_IALLUGO;
292 case Opt_newinstance:
295 if (match_int(&args[0], &option) ||
296 option < 0 || option > NR_UNIX98_PTY_MAX)
301 pr_err("called with bogus options\n");
309 static int mknod_ptmx(struct super_block *sb)
313 struct dentry *dentry;
315 struct dentry *root = sb->s_root;
316 struct pts_fs_info *fsi = DEVPTS_SB(sb);
317 struct pts_mount_opts *opts = &fsi->mount_opts;
318 kuid_t ptmx_uid = current_fsuid();
319 kgid_t ptmx_gid = current_fsgid();
321 inode_lock(d_inode(root));
323 /* If we have already created ptmx node, return */
324 if (fsi->ptmx_dentry) {
329 dentry = d_alloc_name(root, "ptmx");
331 pr_err("Unable to alloc dentry for ptmx node\n");
336 * Create a new 'ptmx' node in this mount of devpts.
338 inode = new_inode(sb);
340 pr_err("Unable to alloc inode for ptmx node\n");
346 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
348 mode = S_IFCHR|opts->ptmxmode;
349 init_special_inode(inode, mode, MKDEV(TTYAUX_MAJOR, 2));
350 inode->i_uid = ptmx_uid;
351 inode->i_gid = ptmx_gid;
353 d_add(dentry, inode);
355 fsi->ptmx_dentry = dentry;
358 inode_unlock(d_inode(root));
362 static void update_ptmx_mode(struct pts_fs_info *fsi)
365 if (fsi->ptmx_dentry) {
366 inode = d_inode(fsi->ptmx_dentry);
367 inode->i_mode = S_IFCHR|fsi->mount_opts.ptmxmode;
371 static int devpts_remount(struct super_block *sb, int *flags, char *data)
374 struct pts_fs_info *fsi = DEVPTS_SB(sb);
375 struct pts_mount_opts *opts = &fsi->mount_opts;
377 err = parse_mount_options(data, PARSE_REMOUNT, opts);
380 * parse_mount_options() restores options to default values
381 * before parsing and may have changed ptmxmode. So, update the
382 * mode in the inode too. Bogus options don't fail the remount,
383 * so do this even on error return.
385 update_ptmx_mode(fsi);
390 static int devpts_show_options(struct seq_file *seq, struct dentry *root)
392 struct pts_fs_info *fsi = DEVPTS_SB(root->d_sb);
393 struct pts_mount_opts *opts = &fsi->mount_opts;
396 seq_printf(seq, ",uid=%u",
397 from_kuid_munged(&init_user_ns, opts->uid));
399 seq_printf(seq, ",gid=%u",
400 from_kgid_munged(&init_user_ns, opts->gid));
401 seq_printf(seq, ",mode=%03o", opts->mode);
402 seq_printf(seq, ",ptmxmode=%03o", opts->ptmxmode);
403 if (opts->max < NR_UNIX98_PTY_MAX)
404 seq_printf(seq, ",max=%d", opts->max);
409 static const struct super_operations devpts_sops = {
410 .statfs = simple_statfs,
411 .remount_fs = devpts_remount,
412 .show_options = devpts_show_options,
415 static void *new_pts_fs_info(struct super_block *sb)
417 struct pts_fs_info *fsi;
419 fsi = kzalloc(sizeof(struct pts_fs_info), GFP_KERNEL);
423 ida_init(&fsi->allocated_ptys);
424 fsi->mount_opts.mode = DEVPTS_DEFAULT_MODE;
425 fsi->mount_opts.ptmxmode = DEVPTS_DEFAULT_PTMX_MODE;
432 devpts_fill_super(struct super_block *s, void *data, int silent)
437 s->s_iflags &= ~SB_I_NODEV;
438 s->s_blocksize = 1024;
439 s->s_blocksize_bits = 10;
440 s->s_magic = DEVPTS_SUPER_MAGIC;
441 s->s_op = &devpts_sops;
442 s->s_d_op = &simple_dentry_operations;
446 s->s_fs_info = new_pts_fs_info(s);
450 error = parse_mount_options(data, PARSE_MOUNT, &DEVPTS_SB(s)->mount_opts);
455 inode = new_inode(s);
459 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
460 inode->i_mode = S_IFDIR | S_IRUGO | S_IXUGO | S_IWUSR;
461 inode->i_op = &simple_dir_inode_operations;
462 inode->i_fop = &simple_dir_operations;
465 s->s_root = d_make_root(inode);
467 pr_err("get root dentry failed\n");
471 error = mknod_ptmx(s);
486 * Mount a new (private) instance of devpts. PTYs created in this
487 * instance are independent of the PTYs in other devpts instances.
489 static struct dentry *devpts_mount(struct file_system_type *fs_type,
490 int flags, const char *dev_name, void *data)
492 return mount_nodev(fs_type, flags, data, devpts_fill_super);
495 static void devpts_kill_sb(struct super_block *sb)
497 struct pts_fs_info *fsi = DEVPTS_SB(sb);
500 ida_destroy(&fsi->allocated_ptys);
502 kill_litter_super(sb);
505 static struct file_system_type devpts_fs_type = {
507 .mount = devpts_mount,
508 .kill_sb = devpts_kill_sb,
509 .fs_flags = FS_USERNS_MOUNT,
513 * The normal naming convention is simply /dev/pts/<number>; this conforms
514 * to the System V naming convention
517 int devpts_new_index(struct pts_fs_info *fsi)
523 if (!ida_pre_get(&fsi->allocated_ptys, GFP_KERNEL))
526 mutex_lock(&allocated_ptys_lock);
527 if (pty_count >= (pty_limit -
528 (fsi->mount_opts.reserve ? 0 : pty_reserve))) {
529 mutex_unlock(&allocated_ptys_lock);
533 ida_ret = ida_get_new(&fsi->allocated_ptys, &index);
535 mutex_unlock(&allocated_ptys_lock);
536 if (ida_ret == -EAGAIN)
541 if (index >= fsi->mount_opts.max) {
542 ida_remove(&fsi->allocated_ptys, index);
543 mutex_unlock(&allocated_ptys_lock);
547 mutex_unlock(&allocated_ptys_lock);
551 void devpts_kill_index(struct pts_fs_info *fsi, int idx)
553 mutex_lock(&allocated_ptys_lock);
554 ida_remove(&fsi->allocated_ptys, idx);
556 mutex_unlock(&allocated_ptys_lock);
560 * devpts_pty_new -- create a new inode in /dev/pts/
561 * @ptmx_inode: inode of the master
562 * @device: major+minor of the node to be created
563 * @index: used as a name of the node
564 * @priv: what's given back by devpts_get_priv
566 * The created inode is returned. Remove it from /dev/pts/ by devpts_pty_kill.
568 struct dentry *devpts_pty_new(struct pts_fs_info *fsi, int index, void *priv)
570 struct dentry *dentry;
571 struct super_block *sb = fsi->sb;
574 struct pts_mount_opts *opts;
578 opts = &fsi->mount_opts;
580 inode = new_inode(sb);
582 return ERR_PTR(-ENOMEM);
584 inode->i_ino = index + 3;
585 inode->i_uid = opts->setuid ? opts->uid : current_fsuid();
586 inode->i_gid = opts->setgid ? opts->gid : current_fsgid();
587 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
588 init_special_inode(inode, S_IFCHR|opts->mode, MKDEV(UNIX98_PTY_SLAVE_MAJOR, index));
590 sprintf(s, "%d", index);
592 dentry = d_alloc_name(root, s);
594 dentry->d_fsdata = priv;
595 d_add(dentry, inode);
596 fsnotify_create(d_inode(root), dentry);
599 dentry = ERR_PTR(-ENOMEM);
606 * devpts_get_priv -- get private data for a slave
607 * @pts_inode: inode of the slave
609 * Returns whatever was passed as priv in devpts_pty_new for a given inode.
611 void *devpts_get_priv(struct dentry *dentry)
613 if (dentry->d_sb->s_magic != DEVPTS_SUPER_MAGIC)
615 return dentry->d_fsdata;
619 * devpts_pty_kill -- remove inode form /dev/pts/
620 * @inode: inode of the slave to be removed
622 * This is an inverse operation of devpts_pty_new.
624 void devpts_pty_kill(struct dentry *dentry)
626 WARN_ON_ONCE(dentry->d_sb->s_magic != DEVPTS_SUPER_MAGIC);
628 dentry->d_fsdata = NULL;
629 drop_nlink(dentry->d_inode);
631 dput(dentry); /* d_alloc_name() in devpts_pty_new() */
634 static int __init init_devpts_fs(void)
636 int err = register_filesystem(&devpts_fs_type);
638 register_sysctl_table(pty_root_table);
642 module_init(init_devpts_fs)