sys/vfs/procfs/procfs_subr.c

   1 /*
   2  * Copyright (c) 1993 Jan-Simon Pendry
   3  * Copyright (c) 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * Jan-Simon Pendry.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the University of
  20  *      California, Berkeley and its contributors.
  21  * 4. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  *      @(#)procfs_subr.c       8.6 (Berkeley) 5/14/95
  38  *
  39  * $FreeBSD: src/sys/miscfs/procfs/procfs_subr.c,v 1.26.2.3 2002/02/18 21:28:04 des Exp $
  40  * $DragonFly: src/sys/vfs/procfs/procfs_subr.c,v 1.18 2007/08/25 23:27:02 corecode Exp $
  41  */
  42
  43 #include <sys/param.h>
  44 #include <sys/systm.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/proc.h>
  47 #include <sys/mount.h>
  48 #include <sys/vnode.h>
  49 #include <sys/malloc.h>
  50 #include <sys/thread2.h>
  51
  52 #include <vfs/procfs/procfs.h>
  53
  54 #define PFS_HSIZE       256
  55 #define PFS_HMASK       (PFS_HSIZE - 1)
  56
  57 static struct pfsnode *pfshead[PFS_HSIZE];
  58 static int pfsvplock;
  59
  60 #define PFSHASH(pid)    &pfshead[(pid) & PFS_HMASK]
  61
  62 /*
  63  * Allocate a pfsnode/vnode pair.  If no error occurs the returned vnode
  64  * will be referenced and exclusively locked.
  65  *
  66  * The pid, pfs_type, and mount point uniquely identify a pfsnode.
  67  * The mount point is needed because someone might mount this filesystem
  68  * twice.
  69  *
  70  * All pfsnodes are maintained on a singly-linked list.  new nodes are
  71  * only allocated when they cannot be found on this list.  entries on
  72  * the list are removed when the vfs reclaim entry is called.
  73  *
  74  * A single lock is kept for the entire list.  this is needed because the
  75  * getnewvnode() function can block waiting for a vnode to become free,
  76  * in which case there may be more than one process trying to get the same
  77  * vnode.  this lock is only taken if we are going to call getnewvnode,
  78  * since the kernel itself is single-threaded.
  79  *
  80  * If an entry is found on the list, then call vget() to take a reference
  81  * and obtain the lock.  This will properly re-reference the vnode if it
  82  * had gotten onto the free list.
  83  */
  84 int
  85 procfs_allocvp(struct mount *mp, struct vnode **vpp, long pid, pfstype pfs_type)
  86 {
  87         struct pfsnode *pfs;
  88         struct vnode *vp;
  89         struct pfsnode **pp;
  90         int error;
  91
  92         pp = PFSHASH(pid);
  93 loop:
  94         for (pfs = *pp; pfs; pfs = pfs->pfs_next) {
  95                 if (pfs->pfs_pid == pid && pfs->pfs_type == pfs_type &&
  96                     PFSTOV(pfs)->v_mount == mp) {
  97                         vp = PFSTOV(pfs);
  98                         if (vget(vp, LK_EXCLUSIVE))
  99                                 goto loop;
 100
 101                         /*
 102                          * Make sure the vnode is still in the cache after
 103                          * getting the interlock to avoid racing a free.
 104                          */
 105                         for (pfs = *pp; pfs; pfs = pfs->pfs_next) {
 106                                 if (PFSTOV(pfs) == vp &&
 107                                     pfs->pfs_pid == pid &&
 108                                     pfs->pfs_type == pfs_type &&
 109                                     PFSTOV(pfs)->v_mount == mp) {
 110                                         break;
 111                                 }
 112                         }
 113                         if (pfs == NULL || PFSTOV(pfs) != vp) {
 114                                 vput(vp);
 115                                 goto loop;
 116
 117                         }
 118                         *vpp = vp;
 119                         return (0);
 120                 }
 121         }
 122
 123         /*
 124          * otherwise lock the vp list while we call getnewvnode
 125          * since that can block.
 126          */
 127         if (pfsvplock & PROCFS_LOCKED) {
 128                 pfsvplock |= PROCFS_WANT;
 129                 (void) tsleep((caddr_t) &pfsvplock, 0, "pfsavp", 0);
 130                 goto loop;
 131         }
 132         pfsvplock |= PROCFS_LOCKED;
 133
 134         /*
 135          * Do the MALLOC before the getnewvnode since doing so afterward
 136          * might cause a bogus v_data pointer to get dereferenced
 137          * elsewhere if MALLOC should block.
 138          *
 139          * XXX this may not matter anymore since getnewvnode now returns
 140          * a VX locked vnode.
 141          */
 142         MALLOC(pfs, struct pfsnode *, sizeof(struct pfsnode), M_TEMP, M_WAITOK);
 143
 144         error = getnewvnode(VT_PROCFS, mp, vpp, 0, 0);
 145         if (error) {
 146                 kfree(pfs, M_TEMP);
 147                 goto out;
 148         }
 149         vp = *vpp;
 150
 151         vp->v_data = pfs;
 152
 153         pfs->pfs_next = 0;
 154         pfs->pfs_pid = (pid_t) pid;
 155         pfs->pfs_type = pfs_type;
 156         pfs->pfs_vnode = vp;
 157         pfs->pfs_flags = 0;
 158         pfs->pfs_lockowner = 0;
 159         pfs->pfs_fileno = PROCFS_FILENO(pid, pfs_type);
 160
 161         switch (pfs_type) {
 162         case Proot:     /* /proc = dr-xr-xr-x */
 163                 pfs->pfs_mode = (VREAD|VEXEC) |
 164                                 (VREAD|VEXEC) >> 3 |
 165                                 (VREAD|VEXEC) >> 6;
 166                 vp->v_type = VDIR;
 167                 vp->v_flag = VROOT;
 168                 break;
 169
 170         case Pcurproc:  /* /proc/curproc = lr--r--r-- */
 171                 pfs->pfs_mode = (VREAD) |
 172                                 (VREAD >> 3) |
 173                                 (VREAD >> 6);
 174                 vp->v_type = VLNK;
 175                 break;
 176
 177         case Pproc:
 178                 pfs->pfs_mode = (VREAD|VEXEC) |
 179                                 (VREAD|VEXEC) >> 3 |
 180                                 (VREAD|VEXEC) >> 6;
 181                 vp->v_type = VDIR;
 182                 break;
 183
 184         case Pfile:
 185                 pfs->pfs_mode = (VREAD|VEXEC) |
 186                                 (VREAD|VEXEC) >> 3 |
 187                                 (VREAD|VEXEC) >> 6;
 188                 vp->v_type = VLNK;
 189                 break;
 190
 191         case Pmem:
 192                 pfs->pfs_mode = (VREAD|VWRITE);
 193                 vp->v_type = VREG;
 194                 break;
 195
 196         case Pregs:
 197         case Pfpregs:
 198         case Pdbregs:
 199                 pfs->pfs_mode = (VREAD|VWRITE);
 200                 vp->v_type = VREG;
 201                 break;
 202
 203         case Pctl:
 204         case Pnote:
 205         case Pnotepg:
 206                 pfs->pfs_mode = (VWRITE);
 207                 vp->v_type = VREG;
 208                 break;
 209
 210         case Ptype:
 211         case Pmap:
 212         case Pstatus:
 213         case Pcmdline:
 214         case Prlimit:
 215                 pfs->pfs_mode = (VREAD) |
 216                                 (VREAD >> 3) |
 217                                 (VREAD >> 6);
 218                 vp->v_type = VREG;
 219                 break;
 220
 221         default:
 222                 panic("procfs_allocvp");
 223         }
 224
 225         /* add to procfs vnode list */
 226         pfs->pfs_next = *pp;
 227         *pp = pfs;
 228
 229 out:
 230         pfsvplock &= ~PROCFS_LOCKED;
 231
 232         if (pfsvplock & PROCFS_WANT) {
 233                 pfsvplock &= ~PROCFS_WANT;
 234                 wakeup((caddr_t) &pfsvplock);
 235         }
 236
 237         return (error);
 238 }
 239
 240 int
 241 procfs_freevp(struct vnode *vp)
 242 {
 243         struct pfsnode **pfspp;
 244         struct pfsnode *pfs;
 245
 246         pfs = VTOPFS(vp);
 247         vp->v_data = NULL;
 248
 249         pfspp = PFSHASH(pfs->pfs_pid);
 250         while (*pfspp != pfs && *pfspp)
 251                 pfspp = &(*pfspp)->pfs_next;
 252         KKASSERT(*pfspp);
 253         *pfspp = pfs->pfs_next;
 254         pfs->pfs_next = NULL;
 255         kfree(pfs, M_TEMP);
 256         return (0);
 257 }
 258
 259 /*
 260  * Try to find the calling pid. Note that pfind()
 261  * now references the proc structure to be returned
 262  * and needs to be released later with PRELE().
 263  */
 264 struct proc *
 265 pfs_pfind(pid_t pfs_pid)
 266 {
 267         struct proc *p = NULL;
 268
 269         if (pfs_pid == 0) {
 270                 p = &proc0;
 271                 PHOLD(p);
 272         } else {
 273                 p = pfind(pfs_pid);
 274         }
 275
 276         /*
 277          * Make sure the process is not in the middle of exiting (where
 278          * a lot of its structural members may wind up being NULL).  If it
 279          * is we give up on it.
 280          */
 281         if (p) {
 282                 lwkt_gettoken(&p->p_token);
 283                 if (p->p_flags & P_WEXIT) {
 284                         lwkt_reltoken(&p->p_token);
 285                         PRELE(p);
 286                         p = NULL;
 287                 }
 288         }
 289         return p;
 290 }
 291
 292 void
 293 pfs_pdone(struct proc *p)
 294 {
 295         if (p) {
 296                 lwkt_reltoken(&p->p_token);
 297                 PRELE(p);
 298         }
 299 }
 300
 301 int
 302 procfs_rw(struct vop_read_args *ap)
 303 {
 304         struct vnode *vp = ap->a_vp;
 305         struct uio *uio = ap->a_uio;
 306         struct thread *curtd = uio->uio_td;
 307         struct proc *curp;
 308         struct pfsnode *pfs = VTOPFS(vp);
 309         struct proc *p;
 310         struct lwp *lp;
 311         int rtval;
 312
 313         if (curtd == NULL)
 314                 return (EINVAL);
 315         if ((curp = curtd->td_proc) == NULL)    /* XXX */
 316                 return (EINVAL);
 317
 318         lwkt_gettoken(&proc_token);
 319         p = pfs_pfind(pfs->pfs_pid);
 320         if (p == NULL) {
 321                 rtval = (EINVAL);
 322                 goto out;
 323         }
 324         if (p->p_pid == 1 && securelevel > 0 && uio->uio_rw == UIO_WRITE) {
 325                 rtval = (EACCES);
 326                 goto out;
 327         }
 328         /* XXX lwp */
 329         lp = FIRST_LWP_IN_PROC(p);
 330         LWPHOLD(lp);
 331
 332         while (pfs->pfs_lockowner) {
 333                 tsleep(&pfs->pfs_lockowner, 0, "pfslck", 0);
 334         }
 335         pfs->pfs_lockowner = curproc->p_pid;
 336
 337         switch (pfs->pfs_type) {
 338         case Pnote:
 339         case Pnotepg:
 340                 rtval = procfs_donote(curp, lp, pfs, uio);
 341                 break;
 342
 343         case Pregs:
 344                 rtval = procfs_doregs(curp, lp, pfs, uio);
 345                 break;
 346
 347         case Pfpregs:
 348                 rtval = procfs_dofpregs(curp, lp, pfs, uio);
 349                 break;
 350
 351         case Pdbregs:
 352                 rtval = procfs_dodbregs(curp, lp, pfs, uio);
 353                 break;
 354
 355         case Pctl:
 356                 rtval = procfs_doctl(curp, lp, pfs, uio);
 357                 break;
 358
 359         case Pstatus:
 360                 rtval = procfs_dostatus(curp, lp, pfs, uio);
 361                 break;
 362
 363         case Pmap:
 364                 rtval = procfs_domap(curp, lp, pfs, uio);
 365                 break;
 366
 367         case Pmem:
 368                 rtval = procfs_domem(curp, lp, pfs, uio);
 369                 break;
 370
 371         case Ptype:
 372                 rtval = procfs_dotype(curp, lp, pfs, uio);
 373                 break;
 374
 375         case Pcmdline:
 376                 rtval = procfs_docmdline(curp, lp, pfs, uio);
 377                 break;
 378
 379         case Prlimit:
 380                 rtval = procfs_dorlimit(curp, lp, pfs, uio);
 381                 break;
 382
 383         default:
 384                 rtval = EOPNOTSUPP;
 385                 break;
 386         }
 387         LWPRELE(lp);
 388
 389         pfs->pfs_lockowner = 0;
 390         wakeup(&pfs->pfs_lockowner);
 391
 392 out:
 393         pfs_pdone(p);
 394         lwkt_reltoken(&proc_token);
 395
 396         return rtval;
 397 }
 398
 399 /*
 400  * Get a string from userland into (buf).  Strip a trailing
 401  * nl character (to allow easy access from the shell).
 402  * The buffer should be *buflenp + 1 chars long.  vfs_getuserstr
 403  * will automatically add a nul char at the end.
 404  *
 405  * Returns 0 on success or the following errors
 406  *
 407  * EINVAL:    file offset is non-zero.
 408  * EMSGSIZE:  message is longer than kernel buffer
 409  * EFAULT:    user i/o buffer is not addressable
 410  */
 411 int
 412 vfs_getuserstr(struct uio *uio, char *buf, int *buflenp)
 413 {
 414         int xlen;
 415         int error;
 416
 417         if (uio->uio_offset != 0)
 418                 return (EINVAL);
 419
 420         xlen = *buflenp;
 421
 422         /* must be able to read the whole string in one go */
 423         if (xlen < uio->uio_resid)
 424                 return (EMSGSIZE);
 425         xlen = uio->uio_resid;
 426
 427         if ((error = uiomove(buf, xlen, uio)) != 0)
 428                 return (error);
 429
 430         /* allow multiple writes without seeks */
 431         uio->uio_offset = 0;
 432
 433         /* cleanup string and remove trailing newline */
 434         buf[xlen] = '\0';
 435         xlen = strlen(buf);
 436         if (xlen > 0 && buf[xlen-1] == '\n')
 437                 buf[--xlen] = '\0';
 438         *buflenp = xlen;
 439
 440         return (0);
 441 }
 442
 443 vfs_namemap_t *
 444 vfs_findname(vfs_namemap_t *nm, char *buf, int buflen)
 445 {
 446
 447         for (; nm->nm_name; nm++)
 448                 if (bcmp(buf, nm->nm_name, buflen+1) == 0)
 449                         return (nm);
 450
 451         return (0);
 452 }
 453
 454 void
 455 procfs_exit(struct thread *td)
 456 {
 457         struct pfsnode *pfs;
 458         struct vnode *vp;
 459         pid_t pid;
 460
 461         KKASSERT(td->td_proc);
 462         pid = td->td_proc->p_pid;
 463
 464         /*
 465          * NOTE: We can't just vgone() the vnode any more, not while
 466          *       it may potentially still be active.  This will clean
 467          *       the vp and clear the mount and cause the new VOP subsystem
 468          *       to assert or panic when someone tries to do an operation
 469          *       on an open (exited) procfs descriptor.
 470          *
 471          * Prevent further operations on this pid by setting pfs_pid to -1.
 472          * Note that a pfs_pid of 0 is used for nodes which do not track
 473          * any particular pid.
 474          *
 475          * Use vx_get() to properly ref/lock a vp which may not have any
 476          * refs and which may or may not already be reclaimed.  vx_put()
 477          * will then properly deactivate it and cause it to be recycled.
 478          *
 479          * The hash table can also get ripped out from under us when
 480          * we block so take the easy way out and restart the scan.
 481          */
 482 again:
 483         pfs = *PFSHASH(pid);
 484         while (pfs) {
 485                 if (pfs->pfs_pid == pid) {
 486                         vp = PFSTOV(pfs);
 487                         vx_get(vp);
 488                         pfs->pfs_pid |= PFS_DEAD; /* does not effect hash */
 489                         vx_put(vp);
 490                         goto again;
 491                 }
 492                 pfs = pfs->pfs_next;
 493         }
 494 }
 495