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  * $DragonFly: src/sys/emulation/linux/i386/linprocfs/linprocfs_subr.c,v 1.23 2007/08/25 23:27:02 corecode Exp $
  43  */
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.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         lwkt_tokref ilock;
  96         int error;
  97
  98         lwkt_gettoken(&ilock, &pfs_token);
  99 loop:
 100         for (pfs = pfshead[pid & PFSHMASK]; pfs; pfs = pfs->pfs_next) {
 101                 vp = PFSTOV(pfs);
 102                 if (pfs->pfs_pid == pid &&
 103                     pfs->pfs_type == pfs_type &&
 104                     vp->v_mount == mp) {
 105                         if (vget(vp, LK_EXCLUSIVE|LK_SLEEPFAIL))
 106                                 goto loop;
 107                         *vpp = vp;
 108                         lwkt_reltoken(&ilock);
 109                         return (0);
 110                 }
 111         }
 112
 113         /*
 114          * otherwise lock the vp list while we call getnewvnode
 115          * since that can block.
 116          */
 117         if (pfsvplock & PROCFS_LOCKED) {
 118                 pfsvplock |= PROCFS_WANT;
 119                 (void) tsleep((caddr_t) &pfsvplock, 0, "pfsavp", 0);
 120                 goto loop;
 121         }
 122         pfsvplock |= PROCFS_LOCKED;
 123
 124         /*
 125          * Do the MALLOC before the getnewvnode since doing so afterward
 126          * might cause a bogus v_data pointer to get dereferenced
 127          * elsewhere if MALLOC should block.
 128          */
 129         MALLOC(pfs, struct pfsnode *, sizeof(struct pfsnode), M_TEMP, M_WAITOK);
 130
 131         error = getnewvnode(VT_PROCFS, mp, vpp, 0, 0);
 132         if (error) {
 133                 FREE(pfs, M_TEMP);
 134                 goto out;
 135         }
 136         vp = *vpp;
 137
 138         vp->v_data = pfs;
 139
 140         pfs->pfs_next = 0;
 141         pfs->pfs_pid = (pid_t) pid;
 142         pfs->pfs_type = pfs_type;
 143         pfs->pfs_vnode = vp;
 144         pfs->pfs_flags = 0;
 145         pfs->pfs_lockowner = NULL;
 146         pfs->pfs_fileno = PROCFS_FILENO(pid, pfs_type);
 147
 148         switch (pfs_type) {
 149         case Proot:     /* /proc = dr-xr-xr-x */
 150                 vsetflags(vp, VROOT);
 151                 /* fallthrough */
 152         case Pnet:
 153         case Psys:
 154         case Psyskernel:
 155                 pfs->pfs_mode = (VREAD|VEXEC) |
 156                                 (VREAD|VEXEC) >> 3 |
 157                                 (VREAD|VEXEC) >> 6;
 158                 vp->v_type = VDIR;
 159                 break;
 160
 161         case Pself:     /* /proc/self = lr--r--r-- */
 162                 pfs->pfs_mode = (VREAD) |
 163                                 (VREAD >> 3) |
 164                                 (VREAD >> 6);
 165                 vp->v_type = VLNK;
 166                 break;
 167
 168         case Pproc:
 169                 pfs->pfs_mode = (VREAD|VEXEC) |
 170                                 (VREAD|VEXEC) >> 3 |
 171                                 (VREAD|VEXEC) >> 6;
 172                 vp->v_type = VDIR;
 173                 break;
 174
 175         case Pexe:
 176         case Pcwd:
 177         case Pprocroot:
 178         case Pfd:
 179                 pfs->pfs_mode = (VREAD|VEXEC) |
 180                                 (VREAD|VEXEC) >> 3 |
 181                                 (VREAD|VEXEC) >> 6;
 182                 vp->v_type = VLNK;
 183                 break;
 184
 185         case Pmem:
 186                 pfs->pfs_mode = (VREAD|VWRITE) |
 187                                 (VREAD) >> 3;
 188                 vp->v_type = VREG;
 189                 break;
 190
 191         case Pprocstat:
 192         case Pprocstatus:
 193         case Pcmdline:
 194         case Penviron:
 195         case Pstatm:
 196                 /* fallthrough */
 197         case Pmaps:
 198         case Pmeminfo:
 199         case Pcpuinfo:
 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         vx_unlock(vp);  /* vnode ready to roll! */
 225
 226 out:
 227         pfsvplock &= ~PROCFS_LOCKED;
 228
 229         if (pfsvplock & PROCFS_WANT) {
 230                 pfsvplock &= ~PROCFS_WANT;
 231                 wakeup((caddr_t) &pfsvplock);
 232         }
 233         lwkt_reltoken(&ilock);
 234
 235         return (error);
 236 }
 237
 238 int
 239 linprocfs_freevp(struct vnode *vp)
 240 {
 241         struct pfsnode **pfspp;
 242         struct pfsnode *pfs = VTOPFS(vp);
 243         lwkt_tokref ilock;
 244
 245         lwkt_gettoken(&ilock, &pfs_token);
 246         pfspp = &pfshead[pfs->pfs_pid & PFSHMASK];
 247         while (*pfspp != pfs) {
 248                 KKASSERT(*pfspp != NULL);
 249                 pfspp = &(*pfspp)->pfs_next;
 250         }
 251         *pfspp = pfs->pfs_next;
 252         lwkt_reltoken(&ilock);
 253         FREE(vp->v_data, M_TEMP);
 254         vp->v_data = NULL;
 255         return (0);
 256 }
 257
 258 int
 259 linprocfs_rw(struct vop_read_args *ap)
 260 {
 261         struct vnode *vp = ap->a_vp;
 262         struct uio *uio = ap->a_uio;
 263         struct thread *td = uio->uio_td;
 264         struct pfsnode *pfs = VTOPFS(vp);
 265         struct proc *p;
 266         struct proc *curp;
 267         struct lwp *lp;
 268         int rtval;
 269
 270         curp = td->td_proc;
 271         KKASSERT(curp);
 272
 273         p = PFIND(pfs->pfs_pid);
 274         if (p == 0)
 275                 return (EINVAL);
 276         if (p->p_pid == 1 && securelevel > 0 && uio->uio_rw == UIO_WRITE)
 277                 return (EACCES);
 278         lp = FIRST_LWP_IN_PROC(p);
 279         LWPHOLD(lp);
 280
 281         while (pfs->pfs_lockowner) {
 282                 tsleep(&pfs->pfs_lockowner, 0, "pfslck", 0);
 283         }
 284         pfs->pfs_lockowner = curthread;
 285         switch (pfs->pfs_type) {
 286         case Pmem:
 287                 rtval = procfs_domem(curp, lp, pfs, uio);
 288                 break;
 289         case Pprocstat:
 290                 rtval = linprocfs_doprocstat(curp, p, pfs, uio);
 291                 break;
 292         case Pprocstatus:
 293                 rtval = linprocfs_doprocstatus(curp, p, pfs, uio);
 294                 break;
 295         case Pmeminfo:
 296                 rtval = linprocfs_domeminfo(curp, p, pfs, uio);
 297                 break;
 298         case Pcpuinfo:
 299                 rtval = linprocfs_docpuinfo(curp, p, pfs, uio);
 300                 break;
 301         case Pstat:
 302                 rtval = linprocfs_dostat(curp, p, pfs, uio);
 303                 break;
 304         case Puptime:
 305                 rtval = linprocfs_douptime(curp, p, pfs, uio);
 306                 break;
 307         case Pversion:
 308                 rtval = linprocfs_doversion(curp, p, pfs, uio);
 309                 break;
 310         case Ploadavg:
 311                 rtval = linprocfs_doloadavg(curp, p, pfs, uio);
 312                 break;
 313         case Pnetdev:
 314                 rtval = linprocfs_donetdev(curp, p, pfs, uio);
 315                 break;
 316         case Pdevices:
 317                 rtval = linprocfs_dodevices(curp, p, pfs, uio);
 318                 break;
 319         case Posrelease:
 320                 rtval = linprocfs_doosrelease(curp, p, pfs, uio);
 321                 break;
 322         case Postype:
 323                 rtval = linprocfs_doostype(curp, p, pfs, uio);
 324                 break;
 325         case Ppidmax:
 326                 rtval = linprocfs_dopidmax(curp, p, pfs, uio);
 327                 break;
 328         case Pmaps:
 329                 rtval = linprocfs_domaps(curp, p, pfs, uio);
 330                 break;
 331         case Pstatm:
 332                 rtval = linprocfs_dostatm(curp, p, pfs, uio);
 333                 break;
 334         default:
 335                 rtval = EOPNOTSUPP;
 336                 break;
 337         }
 338         LWPRELE(lp);
 339         pfs->pfs_lockowner = NULL;
 340         wakeup(&pfs->pfs_lockowner);
 341         return rtval;
 342 }
 343
 344 #if 0
 345 /*
 346  * Get a string from userland into (buf).  Strip a trailing
 347  * nl character (to allow easy access from the shell).
 348  * The buffer should be *buflenp + 1 chars long.  vfs_getuserstr
 349  * will automatically add a nul char at the end.
 350  *
 351  * Returns 0 on success or the following errors
 352  *
 353  * EINVAL:    file offset is non-zero.
 354  * EMSGSIZE:  message is longer than kernel buffer
 355  * EFAULT:    user i/o buffer is not addressable
 356  */
 357 int
 358 vfs_getuserstr(struct uio *uio, char *buf, int *buflenp)
 359 {
 360         int xlen;
 361         int error;
 362
 363         if (uio->uio_offset != 0)
 364                 return (EINVAL);
 365
 366         xlen = *buflenp;
 367
 368         /* must be able to read the whole string in one go */
 369         if (xlen < uio->uio_resid)
 370                 return (EMSGSIZE);
 371         xlen = uio->uio_resid;
 372
 373         if ((error = uiomove(buf, xlen, uio)) != 0)
 374                 return (error);
 375
 376         /* allow multiple writes without seeks */
 377         uio->uio_offset = 0;
 378
 379         /* cleanup string and remove trailing newline */
 380         buf[xlen] = '\0';
 381         xlen = strlen(buf);
 382         if (xlen > 0 && buf[xlen-1] == '\n')
 383                 buf[--xlen] = '\0';
 384         *buflenp = xlen;
 385
 386         return (0);
 387 }
 388
 389 vfs_namemap_t *
 390 vfs_findname(vfs_namemap_t *nm, char *buf, int buflen)
 391 {
 392
 393         for (; nm->nm_name; nm++)
 394                 if (bcmp(buf, nm->nm_name, buflen+1) == 0)
 395                         return (nm);
 396
 397         return (0);
 398 }
 399 #endif
 400
 401 void
 402 linprocfs_init(void)
 403 {
 404         lwkt_token_init(&pfs_token);
 405 }
 406
 407 void
 408 linprocfs_exit(struct thread *td)
 409 {
 410         lwkt_tokref ilock;
 411         struct pfsnode *pfs;
 412         struct vnode *vp;
 413         pid_t pid;
 414
 415         KKASSERT(td->td_proc);
 416         pid = td->td_proc->p_pid;
 417
 418         /*
 419          * Remove all the procfs vnodes associated with an exiting process.
 420          */
 421         lwkt_gettoken(&ilock, &pfs_token);
 422 restart:
 423         for (pfs = pfshead[pid & PFSHMASK]; pfs; pfs = pfs->pfs_next) {
 424                 if (pfs->pfs_pid == pid) {
 425                         vp = PFSTOV(pfs);
 426                         vx_get(vp);
 427                         vgone_vxlocked(vp);
 428                         vx_put(vp);
 429                         goto restart;
 430                 }
 431         }
 432         lwkt_reltoken(&ilock);
 433         lwkt_token_uninit(&pfs_token);
 434 }
 435