Home | History | Annotate | Line # | Download | only in ptyfs
ptyfs_vfsops.c revision 1.46 
      1 /*	$NetBSD: ptyfs_vfsops.c,v 1.46 2014/03/19 18:09:00 christos Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1992, 1993, 1995
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * This code is derived from software donated to Berkeley by
      8  * Jan-Simon Pendry.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. Neither the name of the University nor the names of its contributors
     19  *    may be used to endorse or promote products derived from this software
     20  *    without specific prior written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32  * SUCH DAMAGE.
     33  *
     34  */
     35 
     36 /*
     37  * Pseudo-tty Filesystem
     38  */
     39 
     40 #include <sys/cdefs.h>
     41 __KERNEL_RCSID(0, "$NetBSD: ptyfs_vfsops.c,v 1.46 2014/03/19 18:09:00 christos Exp $");
     42 
     43 #include <sys/param.h>
     44 #include <sys/systm.h>
     45 #include <sys/sysctl.h>
     46 #include <sys/conf.h>
     47 #include <sys/proc.h>
     48 #include <sys/vnode.h>
     49 #include <sys/mount.h>
     50 #include <sys/namei.h>
     51 #include <sys/stat.h>
     52 #include <sys/dirent.h>
     53 #include <sys/malloc.h>
     54 #include <sys/syslog.h>
     55 #include <sys/select.h>
     56 #include <sys/filedesc.h>
     57 #include <sys/tty.h>
     58 #include <sys/pty.h>
     59 #include <sys/kauth.h>
     60 #include <sys/module.h>
     61 
     62 #include <fs/ptyfs/ptyfs.h>
     63 #include <miscfs/genfs/genfs.h>
     64 #include <miscfs/specfs/specdev.h>
     65 
     66 MODULE(MODULE_CLASS_VFS, ptyfs, NULL);
     67 
     68 MALLOC_JUSTDEFINE(M_PTYFSMNT, "ptyfs mount", "ptyfs mount structures");
     69 MALLOC_JUSTDEFINE(M_PTYFSTMP, "ptyfs temp", "ptyfs temporary structures");
     70 
     71 VFS_PROTOS(ptyfs);
     72 
     73 static struct sysctllog *ptyfs_sysctl_log;
     74 
     75 static int ptyfs__allocvp(struct ptm_pty *, struct lwp *, struct vnode **,
     76     dev_t, char);
     77 static int ptyfs__makename(struct ptm_pty *, struct lwp *, char *, size_t,
     78     dev_t, char);
     79 static void ptyfs__getvattr(struct ptm_pty *, struct lwp *, struct vattr *);
     80 
     81 /*
     82  * ptm glue: When we mount, we make ptm point to us.
     83  */
     84 struct ptm_pty *ptyfs_save_ptm;
     85 static int ptyfs_count;
     86 
     87 struct ptm_pty ptm_ptyfspty = {
     88 	ptyfs__allocvp,
     89 	ptyfs__makename,
     90 	ptyfs__getvattr,
     91 	NULL
     92 };
     93 
     94 static const char *
     95 ptyfs__getpath(struct lwp *l, const struct mount *mp)
     96 {
     97 #define MAXBUF (sizeof(mp->mnt_stat.f_mntonname) + 32)
     98 	struct cwdinfo *cwdi = l->l_proc->p_cwdi;
     99 	char *buf;
    100 	const char *rv;
    101 	size_t len;
    102 	char *bp;
    103 	int error;
    104 
    105 	rv = mp->mnt_stat.f_mntonname;
    106 	if (cwdi->cwdi_rdir == NULL)
    107 		return rv;
    108 
    109 	buf = malloc(MAXBUF, M_TEMP, M_WAITOK);
    110 	bp = buf + MAXBUF;
    111 	*--bp = '\0';
    112 	error = getcwd_common(mp->mnt_vnodecovered, cwdi->cwdi_rdir, &bp,
    113 	    buf, MAXBUF / 2, 0, l);
    114 	if (error) {	/* Mount point is out of rdir */
    115 		rv = NULL;
    116 		goto out;
    117 	}
    118 
    119 	len = strlen(bp);
    120 	if (len < sizeof(mp->mnt_stat.f_mntonname))	/* XXX */
    121 		rv += strlen(rv) - len;
    122 out:
    123 	free(buf, M_TEMP);
    124 	return rv;
    125 }
    126 
    127 static int
    128 ptyfs__makename(struct ptm_pty *pt, struct lwp *l, char *tbuf, size_t bufsiz,
    129     dev_t dev, char ms)
    130 {
    131 	struct mount *mp = pt->arg;
    132 	size_t len;
    133 	const char *np;
    134 
    135 	switch (ms) {
    136 	case 'p':
    137 		/* We don't provide access to the master, should we? */
    138 		len = snprintf(tbuf, bufsiz, "/dev/null");
    139 		break;
    140 	case 't':
    141 		np = ptyfs__getpath(l, mp);
    142 		if (np == NULL)
    143 			return EOPNOTSUPP;
    144 		len = snprintf(tbuf, bufsiz, "%s/%llu", np,
    145 			(unsigned long long)minor(dev));
    146 		break;
    147 	default:
    148 		return EINVAL;
    149 	}
    150 
    151 	return len >= bufsiz ? ENOSPC : 0;
    152 }
    153 
    154 
    155 static int
    156 /*ARGSUSED*/
    157 ptyfs__allocvp(struct ptm_pty *pt, struct lwp *l, struct vnode **vpp,
    158     dev_t dev, char ms)
    159 {
    160 	struct mount *mp = pt->arg;
    161 	ptyfstype type;
    162 
    163 	switch (ms) {
    164 	case 'p':
    165 		type = PTYFSptc;
    166 		break;
    167 	case 't':
    168 		type = PTYFSpts;
    169 		break;
    170 	default:
    171 		return EINVAL;
    172 	}
    173 
    174 	return ptyfs_allocvp(mp, vpp, type, minor(dev), l);
    175 }
    176 
    177 
    178 static void
    179 ptyfs__getvattr(struct ptm_pty *pt, struct lwp *l, struct vattr *vattr)
    180 {
    181 	struct mount *mp = pt->arg;
    182 	struct ptyfsmount *pmnt = VFSTOPTY(mp);
    183 	vattr_null(vattr);
    184 	/* get real uid */
    185 	vattr->va_uid = kauth_cred_getuid(l->l_cred);
    186 	vattr->va_gid = pmnt->pmnt_gid;
    187 	vattr->va_mode = pmnt->pmnt_mode;
    188 }
    189 
    190 
    191 void
    192 ptyfs_init(void)
    193 {
    194 
    195 	malloc_type_attach(M_PTYFSMNT);
    196 	malloc_type_attach(M_PTYFSTMP);
    197 	ptyfs_hashinit();
    198 }
    199 
    200 void
    201 ptyfs_reinit(void)
    202 {
    203 	ptyfs_hashreinit();
    204 }
    205 
    206 void
    207 ptyfs_done(void)
    208 {
    209 
    210 	ptyfs_hashdone();
    211 	malloc_type_detach(M_PTYFSTMP);
    212 	malloc_type_detach(M_PTYFSMNT);
    213 }
    214 
    215 #define OSIZE sizeof(struct { int f; gid_t g; mode_t m; })
    216 /*
    217  * Mount the Pseudo tty params filesystem
    218  */
    219 int
    220 ptyfs_mount(struct mount *mp, const char *path, void *data, size_t *data_len)
    221 {
    222 	struct lwp *l = curlwp;
    223 	int error = 0;
    224 	struct ptyfsmount *pmnt;
    225 	struct ptyfs_args *args = data;
    226 
    227 	if (*data_len != sizeof *args && *data_len != OSIZE)
    228 		return EINVAL;
    229 
    230 	if (UIO_MX & (UIO_MX - 1)) {
    231 		log(LOG_ERR, "ptyfs: invalid directory entry size");
    232 		return EINVAL;
    233 	}
    234 
    235 	if (mp->mnt_flag & MNT_GETARGS) {
    236 		pmnt = VFSTOPTY(mp);
    237 		if (pmnt == NULL)
    238 			return EIO;
    239 		args->mode = pmnt->pmnt_mode;
    240 		args->gid = pmnt->pmnt_gid;
    241 		if (args->version >= PTYFS_ARGSVERSION) {
    242 			args->flags = pmnt->pmnt_flags;
    243 			*data_len = sizeof *args;
    244 		} else {
    245 			*data_len = OSIZE;
    246 		}
    247 		return 0;
    248 	}
    249 
    250 #if 0
    251 	/* Don't allow more than one mount */
    252 	if (ptyfs_count)
    253 		return EBUSY;
    254 #endif
    255 
    256 	if (mp->mnt_flag & MNT_UPDATE)
    257 		return EOPNOTSUPP;
    258 
    259 	if (args->version > PTYFS_ARGSVERSION)
    260 		return EINVAL;
    261 
    262 	pmnt = malloc(sizeof(struct ptyfsmount), M_PTYFSMNT, M_WAITOK);
    263 
    264 	mp->mnt_data = pmnt;
    265 	pmnt->pmnt_gid = args->gid;
    266 	pmnt->pmnt_mode = args->mode;
    267 	if (args->version >= PTYFS_ARGSVERSION)
    268 		pmnt->pmnt_flags = args->flags;
    269 	else
    270 		pmnt->pmnt_flags = 0;
    271 	mp->mnt_flag |= MNT_LOCAL;
    272 	vfs_getnewfsid(mp);
    273 
    274 	if ((error = set_statvfs_info(path, UIO_USERSPACE, "ptyfs",
    275 	    UIO_SYSSPACE, mp->mnt_op->vfs_name, mp, l)) != 0) {
    276 		free(pmnt, M_PTYFSMNT);
    277 		return error;
    278 	}
    279 
    280 	/* Point pty access to us */
    281 	if (ptyfs_count == 0) {
    282 		ptm_ptyfspty.arg = mp;
    283 		ptyfs_save_ptm = pty_sethandler(&ptm_ptyfspty);
    284 	}
    285 	ptyfs_count++;
    286 	return 0;
    287 }
    288 
    289 /*ARGSUSED*/
    290 int
    291 ptyfs_start(struct mount *mp, int flags)
    292 {
    293 	return 0;
    294 }
    295 
    296 /*ARGSUSED*/
    297 int
    298 ptyfs_unmount(struct mount *mp, int mntflags)
    299 {
    300 	int error;
    301 	int flags = 0;
    302 
    303 	if (mntflags & MNT_FORCE)
    304 		flags |= FORCECLOSE;
    305 
    306 	if ((error = vflush(mp, 0, flags)) != 0)
    307 		return error;
    308 
    309 	ptyfs_count--;
    310 	if (ptyfs_count == 0) {
    311 		/* Restore where pty access was pointing */
    312 		(void)pty_sethandler(ptyfs_save_ptm);
    313 		ptyfs_save_ptm = NULL;
    314 		ptm_ptyfspty.arg = NULL;
    315 	}
    316 
    317 	/*
    318 	 * Finally, throw away the ptyfsmount structure
    319 	 */
    320 	free(mp->mnt_data, M_PTYFSMNT);
    321 	mp->mnt_data = NULL;
    322 
    323 	return 0;
    324 }
    325 
    326 int
    327 ptyfs_root(struct mount *mp, struct vnode **vpp)
    328 {
    329 	/* setup "." */
    330 	return ptyfs_allocvp(mp, vpp, PTYFSroot, 0, NULL);
    331 }
    332 
    333 /*ARGSUSED*/
    334 int
    335 ptyfs_sync(struct mount *mp, int waitfor,
    336     kauth_cred_t uc)
    337 {
    338 	return 0;
    339 }
    340 
    341 /*
    342  * Kernfs flat namespace lookup.
    343  * Currently unsupported.
    344  */
    345 /*ARGSUSED*/
    346 int
    347 ptyfs_vget(struct mount *mp, ino_t ino,
    348     struct vnode **vpp)
    349 {
    350 	return EOPNOTSUPP;
    351 }
    352 
    353 extern const struct vnodeopv_desc ptyfs_vnodeop_opv_desc;
    354 
    355 const struct vnodeopv_desc * const ptyfs_vnodeopv_descs[] = {
    356 	&ptyfs_vnodeop_opv_desc,
    357 	NULL,
    358 };
    359 
    360 struct vfsops ptyfs_vfsops = {
    361 	MOUNT_PTYFS,
    362 	sizeof (struct ptyfs_args),
    363 	ptyfs_mount,
    364 	ptyfs_start,
    365 	ptyfs_unmount,
    366 	ptyfs_root,
    367 	(void *)eopnotsupp,		/* vfs_quotactl */
    368 	genfs_statvfs,
    369 	ptyfs_sync,
    370 	ptyfs_vget,
    371 	(void *)eopnotsupp,		/* vfs_fhtovp */
    372 	(void *)eopnotsupp,		/* vfs_vptofp */
    373 	ptyfs_init,
    374 	ptyfs_reinit,
    375 	ptyfs_done,
    376 	NULL,				/* vfs_mountroot */
    377 	(void *)eopnotsupp,
    378 	(void *)eopnotsupp,
    379 	(void *)eopnotsupp,		/* vfs_suspendctl */
    380 	genfs_renamelock_enter,
    381 	genfs_renamelock_exit,
    382 	(void *)eopnotsupp,
    383 	ptyfs_vnodeopv_descs,
    384 	0,
    385 	{ NULL, NULL },
    386 };
    387 
    388 static int
    389 ptyfs_modcmd(modcmd_t cmd, void *arg)
    390 {
    391 	int error;
    392 
    393 	switch (cmd) {
    394 	case MODULE_CMD_INIT:
    395 		error = vfs_attach(&ptyfs_vfsops);
    396 		if (error != 0)
    397 			break;
    398 		sysctl_createv(&ptyfs_sysctl_log, 0, NULL, NULL,
    399 			       CTLFLAG_PERMANENT,
    400 			       CTLTYPE_NODE, "ptyfs",
    401 			       SYSCTL_DESCR("Pty file system"),
    402 			       NULL, 0, NULL, 0,
    403 			       CTL_VFS, 23, CTL_EOL);
    404 		/*
    405 		 * XXX the "23" above could be dynamic, thereby eliminating
    406 		 * one more instance of the "number to vfs" mapping problem,
    407 		 * but "23" is the order as taken from sys/mount.h
    408 		 */
    409 		break;
    410 	case MODULE_CMD_FINI:
    411 		error = vfs_detach(&ptyfs_vfsops);
    412 		if (error != 0)
    413 			break;
    414 		sysctl_teardown(&ptyfs_sysctl_log);
    415 		break;
    416 	default:
    417 		error = ENOTTY;
    418 		break;
    419 	}
    420 
    421 	return (error);
    422 }
    423