Home | History | Annotate | Line # | Download | only in procfs
procfs_subr.c revision 1.43
      1 /*	$NetBSD: procfs_subr.c,v 1.43 2003/01/18 09:18:06 thorpej Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1994 Christopher G. Demetriou.  All rights reserved.
      5  * Copyright (c) 1993 Jan-Simon Pendry
      6  * Copyright (c) 1993
      7  *	The Regents of the University of California.  All rights reserved.
      8  *
      9  * This code is derived from software contributed to Berkeley by
     10  * Jan-Simon Pendry.
     11  *
     12  * Redistribution and use in source and binary forms, with or without
     13  * modification, are permitted provided that the following conditions
     14  * are met:
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice, this list of conditions and the following disclaimer.
     17  * 2. Redistributions in binary form must reproduce the above copyright
     18  *    notice, this list of conditions and the following disclaimer in the
     19  *    documentation and/or other materials provided with the distribution.
     20  * 3. All advertising materials mentioning features or use of this software
     21  *    must display the following acknowledgement:
     22  *	This product includes software developed by the University of
     23  *	California, Berkeley and its contributors.
     24  * 4. Neither the name of the University nor the names of its contributors
     25  *    may be used to endorse or promote products derived from this software
     26  *    without specific prior written permission.
     27  *
     28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     38  * SUCH DAMAGE.
     39  *
     40  *	@(#)procfs_subr.c	8.6 (Berkeley) 5/14/95
     41  */
     42 
     43 #include <sys/cdefs.h>
     44 __KERNEL_RCSID(0, "$NetBSD: procfs_subr.c,v 1.43 2003/01/18 09:18:06 thorpej Exp $");
     45 
     46 #include <sys/param.h>
     47 #include <sys/systm.h>
     48 #include <sys/time.h>
     49 #include <sys/kernel.h>
     50 #include <sys/proc.h>
     51 #include <sys/vnode.h>
     52 #include <sys/malloc.h>
     53 #include <sys/stat.h>
     54 #include <sys/file.h>
     55 #include <sys/filedesc.h>
     56 
     57 #include <miscfs/procfs/procfs.h>
     58 
     59 void procfs_hashins __P((struct pfsnode *));
     60 void procfs_hashrem __P((struct pfsnode *));
     61 struct vnode *procfs_hashget __P((pid_t, pfstype, int, struct mount *));
     62 
     63 LIST_HEAD(pfs_hashhead, pfsnode) *pfs_hashtbl;
     64 u_long	pfs_ihash;	/* size of hash table - 1 */
     65 #define PFSPIDHASH(pid)	((pid) & pfs_ihash)
     66 
     67 struct lock pfs_hashlock;
     68 struct simplelock pfs_hash_slock;
     69 
     70 #define	ISSET(t, f)	((t) & (f))
     71 
     72 /*
     73  * allocate a pfsnode/vnode pair.  the vnode is
     74  * referenced, and locked.
     75  *
     76  * the pid, pfs_type, and mount point uniquely
     77  * identify a pfsnode.  the mount point is needed
     78  * because someone might mount this filesystem
     79  * twice.
     80  *
     81  * all pfsnodes are maintained on a singly-linked
     82  * list.  new nodes are only allocated when they cannot
     83  * be found on this list.  entries on the list are
     84  * removed when the vfs reclaim entry is called.
     85  *
     86  * a single lock is kept for the entire list.  this is
     87  * needed because the getnewvnode() function can block
     88  * waiting for a vnode to become free, in which case there
     89  * may be more than one process trying to get the same
     90  * vnode.  this lock is only taken if we are going to
     91  * call getnewvnode, since the kernel itself is single-threaded.
     92  *
     93  * if an entry is found on the list, then call vget() to
     94  * take a reference.  this is done because there may be
     95  * zero references to it and so it needs to removed from
     96  * the vnode free list.
     97  */
     98 int
     99 procfs_allocvp(mp, vpp, pid, pfs_type, fd)
    100 	struct mount *mp;
    101 	struct vnode **vpp;
    102 	pid_t pid;
    103 	pfstype pfs_type;
    104 	int fd;
    105 {
    106 	struct pfsnode *pfs;
    107 	struct vnode *vp;
    108 	int error;
    109 
    110 	do {
    111 		if ((*vpp = procfs_hashget(pid, pfs_type, fd, mp)) != NULL)
    112 			return (0);
    113 	} while (lockmgr(&pfs_hashlock, LK_EXCLUSIVE|LK_SLEEPFAIL, 0));
    114 
    115 	if ((error = getnewvnode(VT_PROCFS, mp, procfs_vnodeop_p, vpp)) != 0) {
    116 		*vpp = NULL;
    117 		lockmgr(&pfs_hashlock, LK_RELEASE, NULL);
    118 		return (error);
    119 	}
    120 	vp = *vpp;
    121 
    122 	MALLOC(pfs, void *, sizeof(struct pfsnode), M_TEMP, M_WAITOK);
    123 	vp->v_data = pfs;
    124 
    125 	pfs->pfs_pid = pid;
    126 	pfs->pfs_type = pfs_type;
    127 	pfs->pfs_vnode = vp;
    128 	pfs->pfs_flags = 0;
    129 	pfs->pfs_fileno = PROCFS_FILENO(pid, pfs_type, fd);
    130 	pfs->pfs_fd = fd;
    131 
    132 	switch (pfs_type) {
    133 	case Proot:	/* /proc = dr-xr-xr-x */
    134 		pfs->pfs_mode = S_IRUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
    135 		vp->v_type = VDIR;
    136 		vp->v_flag = VROOT;
    137 		break;
    138 
    139 	case Pcurproc:	/* /proc/curproc = lr-xr-xr-x */
    140 	case Pself:	/* /proc/self    = lr-xr-xr-x */
    141 		pfs->pfs_mode = S_IRUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
    142 		vp->v_type = VLNK;
    143 		break;
    144 
    145 	case Pproc:	/* /proc/N = dr-xr-xr-x */
    146 	case Pfd:
    147 		if (fd == -1) {	/* /proc/N/fd = dr-xr-xr-x */
    148 			pfs->pfs_mode =
    149 			    S_IRUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
    150 			vp->v_type = VDIR;
    151 		} else {	/* /proc/N/fd/M = [ps-]rw------- */
    152 			struct file *fp;
    153 			struct vnode *vxp;
    154 			if ((error = procfs_getfp(pfs, &fp)) != 0)
    155 				return error;
    156 			pfs->pfs_mode = S_IRUSR|S_IWUSR;
    157 			switch (fp->f_type) {
    158 			case DTYPE_VNODE:
    159 				vxp = (struct vnode *)fp->f_data;
    160 				vp->v_type = vxp->v_type;
    161 				break;
    162 			case DTYPE_PIPE:
    163 				vp->v_type = VFIFO;
    164 				break;
    165 			case DTYPE_SOCKET:
    166 				vp->v_type = VSOCK;
    167 				break;
    168 			case DTYPE_KQUEUE:
    169 			case DTYPE_MISC:
    170 				return EOPNOTSUPP;
    171 			default:
    172 				panic("unknown file type %d\n", fp->f_type);
    173 			}
    174 		}
    175 		break;
    176 
    177 	case Pfile:	/* /proc/N/file = -rw------- */
    178 	case Pmem:	/* /proc/N/mem = -rw------- */
    179 	case Pregs:	/* /proc/N/regs = -rw------- */
    180 	case Pfpregs:	/* /proc/N/fpregs = -rw------- */
    181 		pfs->pfs_mode = S_IRUSR|S_IWUSR;
    182 		vp->v_type = VREG;
    183 		break;
    184 
    185 	case Pctl:	/* /proc/N/ctl = --w------ */
    186 	case Pnote:	/* /proc/N/note = --w------ */
    187 	case Pnotepg:	/* /proc/N/notepg = --w------ */
    188 		pfs->pfs_mode = S_IWUSR;
    189 		vp->v_type = VREG;
    190 		break;
    191 
    192 	case Pmap:	/* /proc/N/map = -r--r--r-- */
    193 	case Pmaps:	/* /proc/N/maps = -r--r--r-- */
    194 	case Pstatus:	/* /proc/N/status = -r--r--r-- */
    195 	case Pcmdline:	/* /proc/N/cmdline = -r--r--r-- */
    196 	case Pmeminfo:	/* /proc/meminfo = -r--r--r-- */
    197 	case Pcpuinfo:	/* /proc/cpuinfo = -r--r--r-- */
    198 		pfs->pfs_mode = S_IRUSR|S_IRGRP|S_IROTH;
    199 		vp->v_type = VREG;
    200 		break;
    201 
    202 #ifdef __HAVE_PROCFS_MACHDEP
    203 	PROCFS_MACHDEP_NODETYPE_CASES
    204 		procfs_machdep_allocvp(vp);
    205 		break;
    206 #endif
    207 
    208 	default:
    209 		panic("procfs_allocvp");
    210 	}
    211 
    212 	procfs_hashins(pfs);
    213 	uvm_vnp_setsize(vp, 0);
    214 	lockmgr(&pfs_hashlock, LK_RELEASE, NULL);
    215 
    216 	return (error);
    217 }
    218 
    219 int
    220 procfs_freevp(vp)
    221 	struct vnode *vp;
    222 {
    223 	struct pfsnode *pfs = VTOPFS(vp);
    224 
    225 	procfs_hashrem(pfs);
    226 
    227 	FREE(vp->v_data, M_TEMP);
    228 	vp->v_data = 0;
    229 	return (0);
    230 }
    231 
    232 int
    233 procfs_rw(v)
    234 	void *v;
    235 {
    236 	struct vop_read_args *ap = v;
    237 	struct vnode *vp = ap->a_vp;
    238 	struct uio *uio = ap->a_uio;
    239 	struct proc *curp = uio->uio_procp;
    240 	struct pfsnode *pfs = VTOPFS(vp);
    241 	struct lwp *l;
    242 	struct proc *p;
    243 
    244 	p = PFIND(pfs->pfs_pid);
    245 	if (p == 0)
    246 		return (EINVAL);
    247 
    248 	/* XXX NJWLWP
    249 	 * The entire procfs interface needs work to be useful to
    250 	 * a process with multiple LWPs. For the moment, we'll
    251 	 * just kluge this and fail on others.
    252 	 */
    253 	l = proc_representative_lwp(p);
    254 
    255 	switch (pfs->pfs_type) {
    256 	case Pregs:
    257 	case Pfpregs:
    258 	case Pmem:
    259 #if defined(__HAVE_PROCFS_MACHDEP) && defined(PROCFS_MACHDEP_PROTECT_CASES)
    260 	PROCFS_MACHDEP_PROTECT_CASES
    261 #endif
    262 		/*
    263 		 * Do not allow init to be modified while in secure mode; it
    264 		 * could be duped into changing the security level.
    265 		 */
    266 		if (uio->uio_rw == UIO_WRITE &&
    267 		    p == initproc && securelevel > -1)
    268 			return (EPERM);
    269 		break;
    270 
    271 	default:
    272 		break;
    273 	}
    274 
    275 	switch (pfs->pfs_type) {
    276 	case Pnote:
    277 	case Pnotepg:
    278 		return (procfs_donote(curp, p, pfs, uio));
    279 
    280 	case Pregs:
    281 		return (procfs_doregs(curp, l, pfs, uio));
    282 
    283 	case Pfpregs:
    284 		return (procfs_dofpregs(curp, l, pfs, uio));
    285 
    286 	case Pctl:
    287 		return (procfs_doctl(curp, l, pfs, uio));
    288 
    289 	case Pstatus:
    290 		return (procfs_dostatus(curp, l, pfs, uio));
    291 
    292 	case Pmap:
    293 		return (procfs_domap(curp, p, pfs, uio, 0));
    294 
    295 	case Pmaps:
    296 		return (procfs_domap(curp, p, pfs, uio, 1));
    297 
    298 	case Pmem:
    299 		return (procfs_domem(curp, p, pfs, uio));
    300 
    301 	case Pcmdline:
    302 		return (procfs_docmdline(curp, p, pfs, uio));
    303 
    304 	case Pmeminfo:
    305 		return (procfs_domeminfo(curp, p, pfs, uio));
    306 
    307 	case Pcpuinfo:
    308 		return (procfs_docpuinfo(curp, p, pfs, uio));
    309 
    310 	case Pfd:
    311 		return (procfs_dofd(curp, p, pfs, uio));
    312 
    313 #ifdef __HAVE_PROCFS_MACHDEP
    314 	PROCFS_MACHDEP_NODETYPE_CASES
    315 		return (procfs_machdep_rw(curp, l, pfs, uio));
    316 #endif
    317 
    318 	default:
    319 		return (EOPNOTSUPP);
    320 	}
    321 }
    322 
    323 /*
    324  * Get a string from userland into (buf).  Strip a trailing
    325  * nl character (to allow easy access from the shell).
    326  * The buffer should be *buflenp + 1 chars long.  vfs_getuserstr
    327  * will automatically add a nul char at the end.
    328  *
    329  * Returns 0 on success or the following errors
    330  *
    331  * EINVAL:    file offset is non-zero.
    332  * EMSGSIZE:  message is longer than kernel buffer
    333  * EFAULT:    user i/o buffer is not addressable
    334  */
    335 int
    336 vfs_getuserstr(uio, buf, buflenp)
    337 	struct uio *uio;
    338 	char *buf;
    339 	int *buflenp;
    340 {
    341 	int xlen;
    342 	int error;
    343 
    344 	if (uio->uio_offset != 0)
    345 		return (EINVAL);
    346 
    347 	xlen = *buflenp;
    348 
    349 	/* must be able to read the whole string in one go */
    350 	if (xlen < uio->uio_resid)
    351 		return (EMSGSIZE);
    352 	xlen = uio->uio_resid;
    353 
    354 	if ((error = uiomove(buf, xlen, uio)) != 0)
    355 		return (error);
    356 
    357 	/* allow multiple writes without seeks */
    358 	uio->uio_offset = 0;
    359 
    360 	/* cleanup string and remove trailing newline */
    361 	buf[xlen] = '\0';
    362 	xlen = strlen(buf);
    363 	if (xlen > 0 && buf[xlen-1] == '\n')
    364 		buf[--xlen] = '\0';
    365 	*buflenp = xlen;
    366 
    367 	return (0);
    368 }
    369 
    370 const vfs_namemap_t *
    371 vfs_findname(nm, buf, buflen)
    372 	const vfs_namemap_t *nm;
    373 	const char *buf;
    374 	int buflen;
    375 {
    376 
    377 	for (; nm->nm_name; nm++)
    378 		if (memcmp(buf, nm->nm_name, buflen+1) == 0)
    379 			return (nm);
    380 
    381 	return (0);
    382 }
    383 
    384 /*
    385  * Initialize pfsnode hash table.
    386  */
    387 void
    388 procfs_hashinit()
    389 {
    390 	lockinit(&pfs_hashlock, PINOD, "pfs_hashlock", 0, 0);
    391 	pfs_hashtbl = hashinit(desiredvnodes / 4, HASH_LIST, M_UFSMNT,
    392 	    M_WAITOK, &pfs_ihash);
    393 	simple_lock_init(&pfs_hash_slock);
    394 }
    395 
    396 void
    397 procfs_hashreinit()
    398 {
    399 	struct pfsnode *pp;
    400 	struct pfs_hashhead *oldhash, *hash;
    401 	u_long i, oldmask, mask, val;
    402 
    403 	hash = hashinit(desiredvnodes / 4, HASH_LIST, M_UFSMNT, M_WAITOK,
    404 	    &mask);
    405 
    406 	simple_lock(&pfs_hash_slock);
    407 	oldhash = pfs_hashtbl;
    408 	oldmask = pfs_ihash;
    409 	pfs_hashtbl = hash;
    410 	pfs_ihash = mask;
    411 	for (i = 0; i <= oldmask; i++) {
    412 		while ((pp = LIST_FIRST(&oldhash[i])) != NULL) {
    413 			LIST_REMOVE(pp, pfs_hash);
    414 			val = PFSPIDHASH(pp->pfs_pid);
    415 			LIST_INSERT_HEAD(&hash[val], pp, pfs_hash);
    416 		}
    417 	}
    418 	simple_unlock(&pfs_hash_slock);
    419 	hashdone(oldhash, M_UFSMNT);
    420 }
    421 
    422 /*
    423  * Free pfsnode hash table.
    424  */
    425 void
    426 procfs_hashdone()
    427 {
    428 	hashdone(pfs_hashtbl, M_UFSMNT);
    429 }
    430 
    431 struct vnode *
    432 procfs_hashget(pid, type, fd, mp)
    433 	pid_t pid;
    434 	pfstype type;
    435 	int fd;
    436 	struct mount *mp;
    437 {
    438 	struct pfs_hashhead *ppp;
    439 	struct pfsnode *pp;
    440 	struct vnode *vp;
    441 
    442 loop:
    443 	simple_lock(&pfs_hash_slock);
    444 	ppp = &pfs_hashtbl[PFSPIDHASH(pid)];
    445 	LIST_FOREACH(pp, ppp, pfs_hash) {
    446 		vp = PFSTOV(pp);
    447 		if (pid == pp->pfs_pid && pp->pfs_type == type &&
    448 		    pp->pfs_fd == fd && vp->v_mount == mp) {
    449 			simple_lock(&vp->v_interlock);
    450 			simple_unlock(&pfs_hash_slock);
    451 			if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK))
    452 				goto loop;
    453 			return (vp);
    454 		}
    455 	}
    456 	simple_unlock(&pfs_hash_slock);
    457 	return (NULL);
    458 }
    459 
    460 /*
    461  * Insert the pfsnode into the hash table and lock it.
    462  */
    463 void
    464 procfs_hashins(pp)
    465 	struct pfsnode *pp;
    466 {
    467 	struct pfs_hashhead *ppp;
    468 
    469 	/* lock the pfsnode, then put it on the appropriate hash list */
    470 	lockmgr(&pp->pfs_vnode->v_lock, LK_EXCLUSIVE, (struct simplelock *)0);
    471 
    472 	simple_lock(&pfs_hash_slock);
    473 	ppp = &pfs_hashtbl[PFSPIDHASH(pp->pfs_pid)];
    474 	LIST_INSERT_HEAD(ppp, pp, pfs_hash);
    475 	simple_unlock(&pfs_hash_slock);
    476 }
    477 
    478 /*
    479  * Remove the pfsnode from the hash table.
    480  */
    481 void
    482 procfs_hashrem(pp)
    483 	struct pfsnode *pp;
    484 {
    485 	simple_lock(&pfs_hash_slock);
    486 	LIST_REMOVE(pp, pfs_hash);
    487 	simple_unlock(&pfs_hash_slock);
    488 }
    489 
    490 void
    491 procfs_revoke_vnodes(p, arg)
    492 	struct proc *p;
    493 	void *arg;
    494 {
    495 	struct pfsnode *pfs, *pnext;
    496 	struct vnode *vp;
    497 	struct mount *mp = (struct mount *)arg;
    498 	struct pfs_hashhead *ppp;
    499 
    500 	if (!(p->p_flag & P_SUGID))
    501 		return;
    502 
    503 	ppp = &pfs_hashtbl[PFSPIDHASH(p->p_pid)];
    504 	for (pfs = LIST_FIRST(ppp); pfs; pfs = pnext) {
    505 		vp = PFSTOV(pfs);
    506 		pnext = LIST_NEXT(pfs, pfs_hash);
    507 		if (vp->v_usecount > 0 && pfs->pfs_pid == p->p_pid &&
    508 		    vp->v_mount == mp)
    509 			VOP_REVOKE(vp, REVOKEALL);
    510 	}
    511 }
    512 
    513 int
    514 procfs_getfp(pfs, fp)
    515 	struct pfsnode *pfs;
    516 	struct file **fp;
    517 {
    518 	struct proc *p = PFIND(pfs->pfs_pid);
    519 
    520 	if (p == NULL)
    521 		return ESRCH;
    522 
    523 	if (pfs->pfs_fd == -1)
    524 		return EINVAL;
    525 
    526 	if ((*fp = p->p_fd->fd_ofiles[pfs->pfs_fd]) == NULL)
    527 		return EBADF;
    528 	return 0;
    529 }
    530