sys/emulation/linux/i386/linprocfs/linprocfs_subr.c

   1 /*
   2  * Copyright (c) 2000 Dag-Erling Coïdan Smørgrav
   3  * Copyright (c) 1999 Pierre Beyssac
   4  * Copyright (c) 1993 Jan-Simon Pendry
   5  * Copyright (c) 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Jan-Simon Pendry.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      @(#)procfs_subr.c       8.6 (Berkeley) 5/14/95
  40  *
  41  * $FreeBSD: src/sys/i386/linux/linprocfs/linprocfs_subr.c,v 1.3.2.4 2001/06/25 19:46:47 pirzyk Exp $
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/kernel.h>
  47 #include <sys/proc.h>
  48 #include <sys/vnode.h>
  49 #include <sys/malloc.h>
  50 #include <sys/mount.h>
  51 #include "linprocfs.h"
  52
  53 #define PFSHSIZE        256
  54 #define PFSHMASK        (PFSHSIZE - 1)
  55
  56 static struct pfsnode *pfshead[PFSHSIZE];
  57 static struct lwkt_token pfs_token;
  58 static int pfsvplock;
  59
  60 extern int procfs_domem (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
  61
  62 /*
  63  * allocate a pfsnode/vnode pair.  the vnode is
  64  * referenced, but not locked.
  65  *
  66  * the pid, pfs_type, and mount point uniquely
  67  * identify a pfsnode.  the mount point is needed
  68  * because someone might mount this filesystem
  69  * twice.
  70  *
  71  * all pfsnodes are maintained on a singly-linked
  72  * list.  new nodes are only allocated when they cannot
  73  * be found on this list.  entries on the list are
  74  * removed when the vfs reclaim entry is called.
  75  *
  76  * a single lock is kept for the entire list.  this is
  77  * needed because the getnewvnode() function can block
  78  * waiting for a vnode to become free, in which case there
  79  * may be more than one process trying to get the same
  80  * vnode.  this lock is only taken if we are going to
  81  * call getnewvnode, since the kernel itself is single-threaded.
  82  *
  83  * if an entry is found on the list, then call vget() to
  84  * take a reference.  this is done because there may be
  85  * zero references to it and so it needs to removed from
  86  * the vnode free list.
  87  */
  88 int
  89 linprocfs_allocvp(struct mount *mp, struct vnode **vpp, long pid,
  90                   pfstype pfs_type)
  91 {
  92         struct pfsnode *pfs;
  93         struct vnode *vp;
  94         struct pfsnode **pp;
  95         int error;
  96
  97         lwkt_gettoken(&pfs_token);
  98 loop:
  99         for (pfs = pfshead[pid & PFSHMASK]; pfs; pfs = pfs->pfs_next) {
 100                 vp = PFSTOV(pfs);
 101                 if (pfs->pfs_pid == pid &&
 102                     pfs->pfs_type == pfs_type &&
 103                     vp->v_mount == mp) {
 104                         if (vget(vp, LK_EXCLUSIVE|LK_SLEEPFAIL))
 105                                 goto loop;
 106                         *vpp = vp;
 107                         lwkt_reltoken(&pfs_token);
 108                         return (0);
 109                 }
 110         }
 111
 112         /*
 113          * otherwise lock the vp list while we call getnewvnode
 114          * since that can block.
 115          */
 116         if (pfsvplock & PROCFS_LOCKED) {
 117                 pfsvplock |= PROCFS_WANT;
 118                 (void) tsleep((caddr_t) &pfsvplock, 0, "pfsavp", 0);
 119                 goto loop;
 120         }
 121         pfsvplock |= PROCFS_LOCKED;
 122
 123         /*
 124          * Do the MALLOC before the getnewvnode since doing so afterward
 125          * might cause a bogus v_data pointer to get dereferenced
 126          * elsewhere if MALLOC should block.
 127          */
 128         pfs = kmalloc(sizeof(struct pfsnode), M_TEMP, M_WAITOK);
 129
 130         error = getnewvnode(VT_PROCFS, mp, vpp, 0, 0);
 131         if (error) {
 132                 kfree(pfs, M_TEMP);
 133                 goto out;
 134         }
 135         vp = *vpp;
 136
 137         vp->v_data = pfs;
 138
 139         pfs->pfs_next = 0;
 140         pfs->pfs_pid = (pid_t) pid;
 141         pfs->pfs_type = pfs_type;
 142         pfs->pfs_vnode = vp;
 143         pfs->pfs_flags = 0;
 144         pfs->pfs_lockowner = NULL;
 145         pfs->pfs_fileno = PROCFS_FILENO(pid, pfs_type);
 146
 147         switch (pfs_type) {
 148         case Proot:     /* /proc = dr-xr-xr-x */
 149                 vsetflags(vp, VROOT);
 150                 /* fallthrough */
 151         case Pnet:
 152         case Psys:
 153         case Psyskernel:
 154                 pfs->pfs_mode = (VREAD|VEXEC) |
 155                                 (VREAD|VEXEC) >> 3 |
 156                                 (VREAD|VEXEC) >> 6;
 157                 vp->v_type = VDIR;
 158                 break;
 159
 160         case Pself:     /* /proc/self = lr--r--r-- */
 161                 pfs->pfs_mode = (VREAD) |
 162                                 (VREAD >> 3) |
 163                                 (VREAD >> 6);
 164                 vp->v_type = VLNK;
 165                 break;
 166
 167         case Pproc:
 168                 pfs->pfs_mode = (VREAD|VEXEC) |
 169                                 (VREAD|VEXEC) >> 3 |
 170                                 (VREAD|VEXEC) >> 6;
 171                 vp->v_type = VDIR;
 172                 break;
 173
 174         case Pexe:
 175         case Pcwd:
 176         case Pprocroot:
 177         case Pfd:
 178                 pfs->pfs_mode = (VREAD|VEXEC) |
 179                                 (VREAD|VEXEC) >> 3 |
 180                                 (VREAD|VEXEC) >> 6;
 181                 vp->v_type = VLNK;
 182                 break;
 183
 184         case Pmem:
 185                 pfs->pfs_mode = (VREAD|VWRITE) |
 186                                 (VREAD) >> 3;
 187                 vp->v_type = VREG;
 188                 break;
 189
 190         case Pprocstat:
 191         case Pprocstatus:
 192         case Pcmdline:
 193         case Penviron:
 194         case Pstatm:
 195                 /* fallthrough */
 196         case Pmaps:
 197         case Pmeminfo:
 198         case Pcpuinfo:
 199         case Pmounts:
 200         case Pstat:
 201         case Puptime:
 202         case Pversion:
 203         case Ploadavg:
 204         case Pdevices:
 205         case Pnetdev:
 206         case Posrelease:
 207         case Postype:
 208         case Ppidmax:
 209                 pfs->pfs_mode = (VREAD) |
 210                                 (VREAD >> 3) |
 211                                 (VREAD >> 6);
 212                 vp->v_type = VREG;
 213                 break;
 214
 215         default:
 216                 panic("linprocfs_allocvp");
 217         }
 218
 219         /* add to procfs vnode list */
 220         for (pp = &pfshead[pid & PFSHMASK]; *pp; pp = &(*pp)->pfs_next)
 221                 continue;
 222         *pp = pfs;
 223
 224 out:
 225         pfsvplock &= ~PROCFS_LOCKED;
 226
 227         if (pfsvplock & PROCFS_WANT) {
 228                 pfsvplock &= ~PROCFS_WANT;
 229                 wakeup((caddr_t) &pfsvplock);
 230         }
 231         lwkt_reltoken(&pfs_token);
 232
 233         return (error);
 234 }
 235
 236 int
 237 linprocfs_freevp(struct vnode *vp)
 238 {
 239         struct pfsnode **pfspp;
 240         struct pfsnode *pfs = VTOPFS(vp);
 241
 242         lwkt_gettoken(&pfs_token);
 243         pfspp = &pfshead[pfs->pfs_pid & PFSHMASK];
 244         while (*pfspp != pfs) {
 245                 KKASSERT(*pfspp != NULL);
 246                 pfspp = &(*pfspp)->pfs_next;
 247         }
 248         *pfspp = pfs->pfs_next;
 249         lwkt_reltoken(&pfs_token);
 250         kfree(vp->v_data, M_TEMP);
 251         vp->v_data = NULL;
 252         return (0);
 253 }
 254
 255 /*
 256  * Try to find the calling pid. Note that pfind()
 257  * now references the proc structure to be returned
 258  * and needs to be released later with PRELE().
 259  */
 260 struct proc *
 261 linprocfs_pfind(pid_t pfs_pid)
 262 {
 263         struct proc *p = NULL;
 264
 265         if (pfs_pid == 0) {
 266                 p = &proc0;
 267                 PHOLD(p);
 268         } else {
 269                 p = pfind(pfs_pid);
 270         }
 271
 272         return p;
 273 }
 274
 275 int
 276 linprocfs_rw(struct vop_read_args *ap)
 277 {
 278         struct vnode *vp = ap->a_vp;
 279         struct uio *uio = ap->a_uio;
 280         struct thread *td = uio->uio_td;
 281         struct pfsnode *pfs = VTOPFS(vp);
 282         struct proc *p;
 283         struct proc *curp;
 284         struct lwp *lp;
 285         int rtval;
 286
 287         curp = td->td_proc;
 288         KKASSERT(curp);
 289
 290         p = linprocfs_pfind(pfs->pfs_pid);
 291         if (p == NULL) {
 292                 rtval = EINVAL;
 293                 goto out;
 294         }
 295         if (p->p_pid == 1 && securelevel > 0 && uio->uio_rw == UIO_WRITE) {
 296                 rtval = EACCES;
 297                 goto out;
 298         }
 299         lp = FIRST_LWP_IN_PROC(p);
 300         LWPHOLD(lp);
 301
 302         lwkt_gettoken(&pfs_token);
 303         while (pfs->pfs_lockowner) {
 304                 tsleep(&pfs->pfs_lockowner, 0, "pfslck", 0);
 305         }
 306         pfs->pfs_lockowner = curthread;
 307         lwkt_reltoken(&pfs_token);
 308
 309         switch (pfs->pfs_type) {
 310         case Pmem:
 311                 rtval = procfs_domem(curp, lp, pfs, uio);
 312                 break;
 313         case Pprocstat:
 314                 rtval = linprocfs_doprocstat(curp, p, pfs, uio);
 315                 break;
 316         case Pprocstatus:
 317                 rtval = linprocfs_doprocstatus(curp, p, pfs, uio);
 318                 break;
 319         case Pmeminfo:
 320                 rtval = linprocfs_domeminfo(curp, p, pfs, uio);
 321                 break;
 322         case Pcpuinfo:
 323                 rtval = linprocfs_docpuinfo(curp, p, pfs, uio);
 324                 break;
 325         case Pmounts:
 326                 rtval = linprocfs_domounts(curp, p, pfs, uio);
 327                 break;
 328         case Pstat:
 329                 rtval = linprocfs_dostat(curp, p, pfs, uio);
 330                 break;
 331         case Puptime:
 332                 rtval = linprocfs_douptime(curp, p, pfs, uio);
 333                 break;
 334         case Pversion:
 335                 rtval = linprocfs_doversion(curp, p, pfs, uio);
 336                 break;
 337         case Ploadavg:
 338                 rtval = linprocfs_doloadavg(curp, p, pfs, uio);
 339                 break;
 340         case Pnetdev:
 341                 rtval = linprocfs_donetdev(curp, p, pfs, uio);
 342                 break;
 343         case Pdevices:
 344                 rtval = linprocfs_dodevices(curp, p, pfs, uio);
 345                 break;
 346         case Posrelease:
 347                 rtval = linprocfs_doosrelease(curp, p, pfs, uio);
 348                 break;
 349         case Postype:
 350                 rtval = linprocfs_doostype(curp, p, pfs, uio);
 351                 break;
 352         case Ppidmax:
 353                 rtval = linprocfs_dopidmax(curp, p, pfs, uio);
 354                 break;
 355         case Pmaps:
 356                 rtval = linprocfs_domaps(curp, p, pfs, uio);
 357                 break;
 358         case Pstatm:
 359                 rtval = linprocfs_dostatm(curp, p, pfs, uio);
 360                 break;
 361         default:
 362                 rtval = EOPNOTSUPP;
 363                 break;
 364         }
 365         LWPRELE(lp);
 366
 367         lwkt_gettoken(&pfs_token);
 368         pfs->pfs_lockowner = NULL;
 369         wakeup(&pfs->pfs_lockowner);
 370         lwkt_reltoken(&pfs_token);
 371 out:
 372         if (p)
 373                 PRELE(p);
 374
 375         return rtval;
 376 }
 377
 378 #if 0
 379 /*
 380  * Get a string from userland into (buf).  Strip a trailing
 381  * nl character (to allow easy access from the shell).
 382  * The buffer should be *buflenp + 1 chars long.  vfs_getuserstr
 383  * will automatically add a nul char at the end.
 384  *
 385  * Returns 0 on success or the following errors
 386  *
 387  * EINVAL:    file offset is non-zero.
 388  * EMSGSIZE:  message is longer than kernel buffer
 389  * EFAULT:    user i/o buffer is not addressable
 390  */
 391 int
 392 vfs_getuserstr(struct uio *uio, char *buf, int *buflenp)
 393 {
 394         int xlen;
 395         int error;
 396
 397         if (uio->uio_offset != 0)
 398                 return (EINVAL);
 399
 400         xlen = *buflenp;
 401
 402         /* must be able to read the whole string in one go */
 403         if (xlen < uio->uio_resid)
 404                 return (EMSGSIZE);
 405         xlen = uio->uio_resid;
 406
 407         if ((error = uiomove(buf, xlen, uio)) != 0)
 408                 return (error);
 409
 410         /* allow multiple writes without seeks */
 411         uio->uio_offset = 0;
 412
 413         /* cleanup string and remove trailing newline */
 414         buf[xlen] = '\0';
 415         xlen = strlen(buf);
 416         if (xlen > 0 && buf[xlen-1] == '\n')
 417                 buf[--xlen] = '\0';
 418         *buflenp = xlen;
 419
 420         return (0);
 421 }
 422
 423 vfs_namemap_t *
 424 vfs_findname(vfs_namemap_t *nm, char *buf, int buflen)
 425 {
 426
 427         for (; nm->nm_name; nm++)
 428                 if (bcmp(buf, nm->nm_name, buflen+1) == 0)
 429                         return (nm);
 430
 431         return (0);
 432 }
 433 #endif
 434
 435 static void
 436 linprocfs_init(void *arg __unused)
 437 {
 438         lwkt_token_init(&pfs_token, "linprocfs");
 439 }
 440 SYSINIT(linprocfs_init, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST,
 441         linprocfs_init, NULL);
 442
 443 void
 444 linprocfs_exit(struct thread *td)
 445 {
 446         struct pfsnode *pfs;
 447         struct vnode *vp;
 448         pid_t pid;
 449
 450         KKASSERT(td->td_proc);
 451         pid = td->td_proc->p_pid;
 452
 453         /*
 454          * Remove all the procfs vnodes associated with an exiting process.
 455          */
 456         lwkt_gettoken(&pfs_token);
 457 restart:
 458         for (pfs = pfshead[pid & PFSHMASK]; pfs; pfs = pfs->pfs_next) {
 459                 if (pfs->pfs_pid == pid) {
 460                         vp = PFSTOV(pfs);
 461                         vx_get(vp);
 462                         pfs->pfs_pid |= PFS_DEAD;
 463                         vx_put(vp);
 464                         goto restart;
 465                 }
 466         }
 467         lwkt_reltoken(&pfs_token);
 468         lwkt_token_uninit(&pfs_token);
 469 }
 470