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.12 2004/08/28 19:02:04 dillon 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 static struct pfsnode *pfshead;
  54 static int pfsvplock;
  55
  56 extern int procfs_domem (struct proc *, struct proc *, struct pfsnode *pfsp, struct uio *uio);
  57
  58 /*
  59  * allocate a pfsnode/vnode pair.  the vnode is
  60  * referenced, but not locked.
  61  *
  62  * the pid, pfs_type, and mount point uniquely
  63  * identify a pfsnode.  the mount point is needed
  64  * because someone might mount this filesystem
  65  * twice.
  66  *
  67  * all pfsnodes are maintained on a singly-linked
  68  * list.  new nodes are only allocated when they cannot
  69  * be found on this list.  entries on the list are
  70  * removed when the vfs reclaim entry is called.
  71  *
  72  * a single lock is kept for the entire list.  this is
  73  * needed because the getnewvnode() function can block
  74  * waiting for a vnode to become free, in which case there
  75  * may be more than one process trying to get the same
  76  * vnode.  this lock is only taken if we are going to
  77  * call getnewvnode, since the kernel itself is single-threaded.
  78  *
  79  * if an entry is found on the list, then call vget() to
  80  * take a reference.  this is done because there may be
  81  * zero references to it and so it needs to removed from
  82  * the vnode free list.
  83  */
  84 int
  85 linprocfs_allocvp(mp, vpp, pid, pfs_type)
  86         struct mount *mp;
  87         struct vnode **vpp;
  88         long pid;
  89         pfstype pfs_type;
  90 {
  91         struct thread *td = curthread;  /* XXX */
  92         struct pfsnode *pfs;
  93         struct vnode *vp;
  94         struct pfsnode **pp;
  95         int error;
  96
  97 loop:
  98         for (pfs = pfshead; pfs != 0; pfs = pfs->pfs_next) {
  99                 vp = PFSTOV(pfs);
 100                 if (pfs->pfs_pid == pid &&
 101                     pfs->pfs_type == pfs_type &&
 102                     vp->v_mount == mp) {
 103                         if (vget(vp, NULL, 0, td))
 104                                 goto loop;
 105                         *vpp = vp;
 106                         return (0);
 107                 }
 108         }
 109
 110         /*
 111          * otherwise lock the vp list while we call getnewvnode
 112          * since that can block.
 113          */
 114         if (pfsvplock & PROCFS_LOCKED) {
 115                 pfsvplock |= PROCFS_WANT;
 116                 (void) tsleep((caddr_t) &pfsvplock, 0, "pfsavp", 0);
 117                 goto loop;
 118         }
 119         pfsvplock |= PROCFS_LOCKED;
 120
 121         /*
 122          * Do the MALLOC before the getnewvnode since doing so afterward
 123          * might cause a bogus v_data pointer to get dereferenced
 124          * elsewhere if MALLOC should block.
 125          */
 126         MALLOC(pfs, struct pfsnode *, sizeof(struct pfsnode), M_TEMP, M_WAITOK);
 127
 128         error = getnewvnode(VT_PROCFS, mp, mp->mnt_vn_ops, vpp, 0, 0);
 129         if (error) {
 130                 FREE(pfs, M_TEMP);
 131                 goto out;
 132         }
 133         vp = *vpp;
 134
 135         vp->v_data = pfs;
 136
 137         pfs->pfs_next = 0;
 138         pfs->pfs_pid = (pid_t) pid;
 139         pfs->pfs_type = pfs_type;
 140         pfs->pfs_vnode = vp;
 141         pfs->pfs_flags = 0;
 142         pfs->pfs_lockowner = NULL;
 143         pfs->pfs_fileno = PROCFS_FILENO(pid, pfs_type);
 144
 145         switch (pfs_type) {
 146         case Proot:     /* /proc = dr-xr-xr-x */
 147                 pfs->pfs_mode = (VREAD|VEXEC) |
 148                                 (VREAD|VEXEC) >> 3 |
 149                                 (VREAD|VEXEC) >> 6;
 150                 vp->v_type = VDIR;
 151                 vp->v_flag = VROOT;
 152                 break;
 153
 154         case Pself:     /* /proc/self = lr--r--r-- */
 155                 pfs->pfs_mode = (VREAD) |
 156                                 (VREAD >> 3) |
 157                                 (VREAD >> 6);
 158                 vp->v_type = VLNK;
 159                 break;
 160
 161         case Pproc:
 162                 pfs->pfs_mode = (VREAD|VEXEC) |
 163                                 (VREAD|VEXEC) >> 3 |
 164                                 (VREAD|VEXEC) >> 6;
 165                 vp->v_type = VDIR;
 166                 break;
 167
 168         case Pexe:
 169                 pfs->pfs_mode = (VREAD|VEXEC) |
 170                                 (VREAD|VEXEC) >> 3 |
 171                                 (VREAD|VEXEC) >> 6;
 172                 vp->v_type = VLNK;
 173                 break;
 174
 175         case Pmem:
 176                 pfs->pfs_mode = (VREAD|VWRITE) |
 177                                 (VREAD) >> 3;;
 178                 vp->v_type = VREG;
 179                 break;
 180
 181         case Pprocstat:
 182         case Pprocstatus:
 183                 /* fallthrough */
 184
 185         case Pmeminfo:
 186         case Pcpuinfo:
 187         case Pstat:
 188         case Puptime:
 189         case Pversion:
 190         case Ploadavg:
 191                 pfs->pfs_mode = (VREAD) |
 192                                 (VREAD >> 3) |
 193                                 (VREAD >> 6);
 194                 vp->v_type = VREG;
 195                 break;
 196
 197         default:
 198                 panic("linprocfs_allocvp");
 199         }
 200
 201         /* add to procfs vnode list */
 202         for (pp = &pfshead; *pp; pp = &(*pp)->pfs_next)
 203                 continue;
 204         *pp = pfs;
 205
 206 out:
 207         pfsvplock &= ~PROCFS_LOCKED;
 208
 209         if (pfsvplock & PROCFS_WANT) {
 210                 pfsvplock &= ~PROCFS_WANT;
 211                 wakeup((caddr_t) &pfsvplock);
 212         }
 213
 214         return (error);
 215 }
 216
 217 int
 218 linprocfs_freevp(vp)
 219         struct vnode *vp;
 220 {
 221         struct pfsnode **pfspp;
 222         struct pfsnode *pfs = VTOPFS(vp);
 223
 224         for (pfspp = &pfshead; *pfspp != 0; pfspp = &(*pfspp)->pfs_next) {
 225                 if (*pfspp == pfs) {
 226                         *pfspp = pfs->pfs_next;
 227                         break;
 228                 }
 229         }
 230
 231         FREE(vp->v_data, M_TEMP);
 232         vp->v_data = 0;
 233         return (0);
 234 }
 235
 236 int
 237 linprocfs_rw(ap)
 238         struct vop_read_args *ap;
 239 {
 240         struct vnode *vp = ap->a_vp;
 241         struct uio *uio = ap->a_uio;
 242         struct thread *td = uio->uio_td;
 243         struct pfsnode *pfs = VTOPFS(vp);
 244         struct proc *p;
 245         struct proc *curp;
 246         int rtval;
 247
 248         curp = td->td_proc;
 249         KKASSERT(curp);
 250
 251         p = PFIND(pfs->pfs_pid);
 252         if (p == 0)
 253                 return (EINVAL);
 254         if (p->p_pid == 1 && securelevel > 0 && uio->uio_rw == UIO_WRITE)
 255                 return (EACCES);
 256
 257         while (pfs->pfs_lockowner) {
 258                 tsleep(&pfs->pfs_lockowner, 0, "pfslck", 0);
 259         }
 260         pfs->pfs_lockowner = curthread;
 261
 262         switch (pfs->pfs_type) {
 263         case Pmem:
 264                 rtval = procfs_domem(curp, p, pfs, uio);
 265                 break;
 266         case Pprocstat:
 267                 rtval = linprocfs_doprocstat(curp, p, pfs, uio);
 268                 break;
 269         case Pprocstatus:
 270                 rtval = linprocfs_doprocstatus(curp, p, pfs, uio);
 271                 break;
 272         case Pmeminfo:
 273                 rtval = linprocfs_domeminfo(curp, p, pfs, uio);
 274                 break;
 275         case Pcpuinfo:
 276                 rtval = linprocfs_docpuinfo(curp, p, pfs, uio);
 277                 break;
 278         case Pstat:
 279                 rtval = linprocfs_dostat(curp, p, pfs, uio);
 280                 break;
 281         case Puptime:
 282                 rtval = linprocfs_douptime(curp, p, pfs, uio);
 283                 break;
 284         case Pversion:
 285                 rtval = linprocfs_doversion(curp, p, pfs, uio);
 286                 break;
 287         case Ploadavg:
 288                 rtval = linprocfs_doloadavg(curp, p, pfs, uio);
 289                 break;
 290         default:
 291                 rtval = EOPNOTSUPP;
 292                 break;
 293         }
 294         pfs->pfs_lockowner = NULL;
 295         wakeup(&pfs->pfs_lockowner);
 296         return rtval;
 297 }
 298
 299 #if 0
 300 /*
 301  * Get a string from userland into (buf).  Strip a trailing
 302  * nl character (to allow easy access from the shell).
 303  * The buffer should be *buflenp + 1 chars long.  vfs_getuserstr
 304  * will automatically add a nul char at the end.
 305  *
 306  * Returns 0 on success or the following errors
 307  *
 308  * EINVAL:    file offset is non-zero.
 309  * EMSGSIZE:  message is longer than kernel buffer
 310  * EFAULT:    user i/o buffer is not addressable
 311  */
 312 int
 313 vfs_getuserstr(uio, buf, buflenp)
 314         struct uio *uio;
 315         char *buf;
 316         int *buflenp;
 317 {
 318         int xlen;
 319         int error;
 320
 321         if (uio->uio_offset != 0)
 322                 return (EINVAL);
 323
 324         xlen = *buflenp;
 325
 326         /* must be able to read the whole string in one go */
 327         if (xlen < uio->uio_resid)
 328                 return (EMSGSIZE);
 329         xlen = uio->uio_resid;
 330
 331         if ((error = uiomove(buf, xlen, uio)) != 0)
 332                 return (error);
 333
 334         /* allow multiple writes without seeks */
 335         uio->uio_offset = 0;
 336
 337         /* cleanup string and remove trailing newline */
 338         buf[xlen] = '\0';
 339         xlen = strlen(buf);
 340         if (xlen > 0 && buf[xlen-1] == '\n')
 341                 buf[--xlen] = '\0';
 342         *buflenp = xlen;
 343
 344         return (0);
 345 }
 346
 347 vfs_namemap_t *
 348 vfs_findname(nm, buf, buflen)
 349         vfs_namemap_t *nm;
 350         char *buf;
 351         int buflen;
 352 {
 353
 354         for (; nm->nm_name; nm++)
 355                 if (bcmp(buf, nm->nm_name, buflen+1) == 0)
 356                         return (nm);
 357
 358         return (0);
 359 }
 360 #endif
 361
 362 void
 363 linprocfs_exit(struct thread *td)
 364 {
 365         struct pfsnode *pfs;
 366         pid_t pid = (td->td_proc) ? td->td_proc->p_pid : -1; /* YYY */
 367
 368         /*
 369          * The reason for this loop is not obvious -- basicly,
 370          * linprocfs_freevp(), which is called via vgone() (eventually),
 371          * removes the specified procfs node from the pfshead list.
 372          * It does this by *pfsp = pfs->pfs_next, meaning that it
 373          * overwrites the node.  So when we do pfs = pfs->next, we
 374          * end up skipping the node that replaces the one that was
 375          * vgone'd.  Since it may have been the last one on the list,
 376          * it may also have been set to null -- but *our* pfs pointer,
 377          * here, doesn't see this.  So the loop starts from the beginning
 378          * again.
 379          *
 380          * This is not a for() loop because the final event
 381          * would be "pfs = pfs->pfs_next"; in the case where
 382          * pfs is set to pfshead again, that would mean that
 383          * pfshead is skipped over.
 384          *
 385          */
 386         pfs = pfshead;
 387         while (pfs) {
 388                 if (pfs->pfs_pid == pid) {
 389                         vgone(PFSTOV(pfs));
 390                         pfs = pfshead;
 391                 } else
 392                         pfs = pfs->pfs_next;
 393         }
 394 }