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 struct pts_fs_info
*devpts_acquire(struct file
*filp
)
138 struct pts_fs_info
*result
;
140 struct super_block
*sb
;
146 /* Has the devpts filesystem already been found? */
147 sb
= path
.mnt
->mnt_sb
;
148 if (sb
->s_magic
!= DEVPTS_SUPER_MAGIC
) {
149 /* Is a devpts filesystem at "pts" in the same directory? */
150 err
= path_pts(&path
);
152 result
= ERR_PTR(err
);
156 /* Is the path the root of a devpts filesystem? */
157 result
= ERR_PTR(-ENODEV
);
158 sb
= path
.mnt
->mnt_sb
;
159 if ((sb
->s_magic
!= DEVPTS_SUPER_MAGIC
) ||
160 (path
.mnt
->mnt_root
!= sb
->s_root
))
165 * pty code needs to hold extra references in case of last /dev/tty close
167 atomic_inc(&sb
->s_active
);
168 result
= DEVPTS_SB(sb
);
175 void devpts_release(struct pts_fs_info
*fsi
)
177 deactivate_super(fsi
->sb
);
180 #define PARSE_MOUNT 0
181 #define PARSE_REMOUNT 1
184 * parse_mount_options():
185 * Set @opts to mount options specified in @data. If an option is not
186 * specified in @data, set it to its default value.
188 * Note: @data may be NULL (in which case all options are set to default).
190 static int parse_mount_options(char *data
, int op
, struct pts_mount_opts
*opts
)
198 opts
->uid
= GLOBAL_ROOT_UID
;
199 opts
->gid
= GLOBAL_ROOT_GID
;
200 opts
->mode
= DEVPTS_DEFAULT_MODE
;
201 opts
->ptmxmode
= DEVPTS_DEFAULT_PTMX_MODE
;
202 opts
->max
= NR_UNIX98_PTY_MAX
;
204 /* Only allow instances mounted from the initial mount
205 * namespace to tap the reserve pool of ptys.
207 if (op
== PARSE_MOUNT
)
209 (current
->nsproxy
->mnt_ns
== init_task
.nsproxy
->mnt_ns
);
211 while ((p
= strsep(&data
, ",")) != NULL
) {
212 substring_t args
[MAX_OPT_ARGS
];
219 token
= match_token(p
, tokens
, args
);
222 if (match_int(&args
[0], &option
))
224 uid
= make_kuid(current_user_ns(), option
);
231 if (match_int(&args
[0], &option
))
233 gid
= make_kgid(current_user_ns(), option
);
240 if (match_octal(&args
[0], &option
))
242 opts
->mode
= option
& S_IALLUGO
;
245 if (match_octal(&args
[0], &option
))
247 opts
->ptmxmode
= option
& S_IALLUGO
;
249 case Opt_newinstance
:
252 if (match_int(&args
[0], &option
) ||
253 option
< 0 || option
> NR_UNIX98_PTY_MAX
)
258 pr_err("called with bogus options\n");
266 static int mknod_ptmx(struct super_block
*sb
)
270 struct dentry
*dentry
;
272 struct dentry
*root
= sb
->s_root
;
273 struct pts_fs_info
*fsi
= DEVPTS_SB(sb
);
274 struct pts_mount_opts
*opts
= &fsi
->mount_opts
;
278 root_uid
= make_kuid(current_user_ns(), 0);
279 root_gid
= make_kgid(current_user_ns(), 0);
280 if (!uid_valid(root_uid
) || !gid_valid(root_gid
))
283 inode_lock(d_inode(root
));
285 /* If we have already created ptmx node, return */
286 if (fsi
->ptmx_dentry
) {
291 dentry
= d_alloc_name(root
, "ptmx");
293 pr_err("Unable to alloc dentry for ptmx node\n");
298 * Create a new 'ptmx' node in this mount of devpts.
300 inode
= new_inode(sb
);
302 pr_err("Unable to alloc inode for ptmx node\n");
308 inode
->i_mtime
= inode
->i_atime
= inode
->i_ctime
= CURRENT_TIME
;
310 mode
= S_IFCHR
|opts
->ptmxmode
;
311 init_special_inode(inode
, mode
, MKDEV(TTYAUX_MAJOR
, 2));
312 inode
->i_uid
= root_uid
;
313 inode
->i_gid
= root_gid
;
315 d_add(dentry
, inode
);
317 fsi
->ptmx_dentry
= dentry
;
320 inode_unlock(d_inode(root
));
324 static void update_ptmx_mode(struct pts_fs_info
*fsi
)
327 if (fsi
->ptmx_dentry
) {
328 inode
= d_inode(fsi
->ptmx_dentry
);
329 inode
->i_mode
= S_IFCHR
|fsi
->mount_opts
.ptmxmode
;
333 static int devpts_remount(struct super_block
*sb
, int *flags
, char *data
)
336 struct pts_fs_info
*fsi
= DEVPTS_SB(sb
);
337 struct pts_mount_opts
*opts
= &fsi
->mount_opts
;
340 err
= parse_mount_options(data
, PARSE_REMOUNT
, opts
);
343 * parse_mount_options() restores options to default values
344 * before parsing and may have changed ptmxmode. So, update the
345 * mode in the inode too. Bogus options don't fail the remount,
346 * so do this even on error return.
348 update_ptmx_mode(fsi
);
353 static int devpts_show_options(struct seq_file
*seq
, struct dentry
*root
)
355 struct pts_fs_info
*fsi
= DEVPTS_SB(root
->d_sb
);
356 struct pts_mount_opts
*opts
= &fsi
->mount_opts
;
359 seq_printf(seq
, ",uid=%u",
360 from_kuid_munged(&init_user_ns
, opts
->uid
));
362 seq_printf(seq
, ",gid=%u",
363 from_kgid_munged(&init_user_ns
, opts
->gid
));
364 seq_printf(seq
, ",mode=%03o", opts
->mode
);
365 seq_printf(seq
, ",ptmxmode=%03o", opts
->ptmxmode
);
366 if (opts
->max
< NR_UNIX98_PTY_MAX
)
367 seq_printf(seq
, ",max=%d", opts
->max
);
372 static const struct super_operations devpts_sops
= {
373 .statfs
= simple_statfs
,
374 .remount_fs
= devpts_remount
,
375 .show_options
= devpts_show_options
,
378 static void *new_pts_fs_info(struct super_block
*sb
)
380 struct pts_fs_info
*fsi
;
382 fsi
= kzalloc(sizeof(struct pts_fs_info
), GFP_KERNEL
);
386 ida_init(&fsi
->allocated_ptys
);
387 fsi
->mount_opts
.mode
= DEVPTS_DEFAULT_MODE
;
388 fsi
->mount_opts
.ptmxmode
= DEVPTS_DEFAULT_PTMX_MODE
;
395 devpts_fill_super(struct super_block
*s
, void *data
, int silent
)
399 s
->s_blocksize
= 1024;
400 s
->s_blocksize_bits
= 10;
401 s
->s_magic
= DEVPTS_SUPER_MAGIC
;
402 s
->s_op
= &devpts_sops
;
405 s
->s_fs_info
= new_pts_fs_info(s
);
409 inode
= new_inode(s
);
413 inode
->i_mtime
= inode
->i_atime
= inode
->i_ctime
= CURRENT_TIME
;
414 inode
->i_mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
| S_IWUSR
;
415 inode
->i_op
= &simple_dir_inode_operations
;
416 inode
->i_fop
= &simple_dir_operations
;
419 s
->s_root
= d_make_root(inode
);
423 pr_err("get root dentry failed\n");
432 * Mount a new (private) instance of devpts. PTYs created in this
433 * instance are independent of the PTYs in other devpts instances.
435 static struct dentry
*devpts_mount(struct file_system_type
*fs_type
,
436 int flags
, const char *dev_name
, void *data
)
439 struct pts_mount_opts opts
;
440 struct super_block
*s
;
442 error
= parse_mount_options(data
, PARSE_MOUNT
, &opts
);
444 return ERR_PTR(error
);
446 s
= sget(fs_type
, NULL
, set_anon_super
, flags
, NULL
);
451 error
= devpts_fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
454 s
->s_flags
|= MS_ACTIVE
;
457 memcpy(&(DEVPTS_SB(s
))->mount_opts
, &opts
, sizeof(opts
));
459 error
= mknod_ptmx(s
);
463 return dget(s
->s_root
);
466 deactivate_locked_super(s
);
467 return ERR_PTR(error
);
470 static void devpts_kill_sb(struct super_block
*sb
)
472 struct pts_fs_info
*fsi
= DEVPTS_SB(sb
);
474 ida_destroy(&fsi
->allocated_ptys
);
476 kill_litter_super(sb
);
479 static struct file_system_type devpts_fs_type
= {
481 .mount
= devpts_mount
,
482 .kill_sb
= devpts_kill_sb
,
483 .fs_flags
= FS_USERNS_MOUNT
| FS_USERNS_DEV_MOUNT
,
487 * The normal naming convention is simply /dev/pts/<number>; this conforms
488 * to the System V naming convention
491 int devpts_new_index(struct pts_fs_info
*fsi
)
497 if (!ida_pre_get(&fsi
->allocated_ptys
, GFP_KERNEL
))
500 mutex_lock(&allocated_ptys_lock
);
501 if (pty_count
>= (pty_limit
-
502 (fsi
->mount_opts
.reserve
? 0 : pty_reserve
))) {
503 mutex_unlock(&allocated_ptys_lock
);
507 ida_ret
= ida_get_new(&fsi
->allocated_ptys
, &index
);
509 mutex_unlock(&allocated_ptys_lock
);
510 if (ida_ret
== -EAGAIN
)
515 if (index
>= fsi
->mount_opts
.max
) {
516 ida_remove(&fsi
->allocated_ptys
, index
);
517 mutex_unlock(&allocated_ptys_lock
);
521 mutex_unlock(&allocated_ptys_lock
);
525 void devpts_kill_index(struct pts_fs_info
*fsi
, int idx
)
527 mutex_lock(&allocated_ptys_lock
);
528 ida_remove(&fsi
->allocated_ptys
, idx
);
530 mutex_unlock(&allocated_ptys_lock
);
534 * devpts_pty_new -- create a new inode in /dev/pts/
535 * @ptmx_inode: inode of the master
536 * @device: major+minor of the node to be created
537 * @index: used as a name of the node
538 * @priv: what's given back by devpts_get_priv
540 * The created inode is returned. Remove it from /dev/pts/ by devpts_pty_kill.
542 struct dentry
*devpts_pty_new(struct pts_fs_info
*fsi
, int index
, void *priv
)
544 struct dentry
*dentry
;
545 struct super_block
*sb
= fsi
->sb
;
548 struct pts_mount_opts
*opts
;
552 opts
= &fsi
->mount_opts
;
554 inode
= new_inode(sb
);
556 return ERR_PTR(-ENOMEM
);
558 inode
->i_ino
= index
+ 3;
559 inode
->i_uid
= opts
->setuid
? opts
->uid
: current_fsuid();
560 inode
->i_gid
= opts
->setgid
? opts
->gid
: current_fsgid();
561 inode
->i_mtime
= inode
->i_atime
= inode
->i_ctime
= CURRENT_TIME
;
562 init_special_inode(inode
, S_IFCHR
|opts
->mode
, MKDEV(UNIX98_PTY_SLAVE_MAJOR
, index
));
564 sprintf(s
, "%d", index
);
566 dentry
= d_alloc_name(root
, s
);
568 dentry
->d_fsdata
= priv
;
569 d_add(dentry
, inode
);
570 fsnotify_create(d_inode(root
), dentry
);
573 dentry
= ERR_PTR(-ENOMEM
);
580 * devpts_get_priv -- get private data for a slave
581 * @pts_inode: inode of the slave
583 * Returns whatever was passed as priv in devpts_pty_new for a given inode.
585 void *devpts_get_priv(struct dentry
*dentry
)
587 WARN_ON_ONCE(dentry
->d_sb
->s_magic
!= DEVPTS_SUPER_MAGIC
);
588 return dentry
->d_fsdata
;
592 * devpts_pty_kill -- remove inode form /dev/pts/
593 * @inode: inode of the slave to be removed
595 * This is an inverse operation of devpts_pty_new.
597 void devpts_pty_kill(struct dentry
*dentry
)
599 WARN_ON_ONCE(dentry
->d_sb
->s_magic
!= DEVPTS_SUPER_MAGIC
);
601 dentry
->d_fsdata
= NULL
;
602 drop_nlink(dentry
->d_inode
);
604 dput(dentry
); /* d_alloc_name() in devpts_pty_new() */
607 static int __init
init_devpts_fs(void)
609 int err
= register_filesystem(&devpts_fs_type
);
611 register_sysctl_table(pty_root_table
);
615 module_init(init_devpts_fs
)