1 /*- 2 * Copyright (c) 1992, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software donated to Berkeley by 6 * Jan-Simon Pendry. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 4. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)fdesc_vnops.c 8.9 (Berkeley) 1/21/94 33 * 34 * $FreeBSD$ 35 */ 36 37 /* 38 * /dev/fd Filesystem 39 */ 40 41 #include <sys/param.h> 42 #include <sys/systm.h> 43 #include <sys/capsicum.h> 44 #include <sys/conf.h> 45 #include <sys/dirent.h> 46 #include <sys/filedesc.h> 47 #include <sys/kernel.h> /* boottime */ 48 #include <sys/lock.h> 49 #include <sys/mutex.h> 50 #include <sys/malloc.h> 51 #include <sys/file.h> /* Must come after sys/malloc.h */ 52 #include <sys/mount.h> 53 #include <sys/namei.h> 54 #include <sys/proc.h> 55 #include <sys/stat.h> 56 #include <sys/vnode.h> 57 58 #include <fs/fdescfs/fdesc.h> 59 60 #define NFDCACHE 4 61 #define FD_NHASH(ix) \ 62 (&fdhashtbl[(ix) & fdhash]) 63 static LIST_HEAD(fdhashhead, fdescnode) *fdhashtbl; 64 static u_long fdhash; 65 66 struct mtx fdesc_hashmtx; 67 68 static vop_getattr_t fdesc_getattr; 69 static vop_lookup_t fdesc_lookup; 70 static vop_open_t fdesc_open; 71 static vop_readdir_t fdesc_readdir; 72 static vop_reclaim_t fdesc_reclaim; 73 static vop_setattr_t fdesc_setattr; 74 75 static struct vop_vector fdesc_vnodeops = { 76 .vop_default = &default_vnodeops, 77 78 .vop_access = VOP_NULL, 79 .vop_getattr = fdesc_getattr, 80 .vop_lookup = fdesc_lookup, 81 .vop_open = fdesc_open, 82 .vop_pathconf = vop_stdpathconf, 83 .vop_readdir = fdesc_readdir, 84 .vop_reclaim = fdesc_reclaim, 85 .vop_setattr = fdesc_setattr, 86 }; 87 88 static void fdesc_insmntque_dtr(struct vnode *, void *); 89 static void fdesc_remove_entry(struct fdescnode *); 90 91 /* 92 * Initialise cache headers 93 */ 94 int 95 fdesc_init(vfsp) 96 struct vfsconf *vfsp; 97 { 98 99 mtx_init(&fdesc_hashmtx, "fdescfs_hash", NULL, MTX_DEF); 100 fdhashtbl = hashinit(NFDCACHE, M_CACHE, &fdhash); 101 return (0); 102 } 103 104 /* 105 * Uninit ready for unload. 106 */ 107 int 108 fdesc_uninit(vfsp) 109 struct vfsconf *vfsp; 110 { 111 112 hashdestroy(fdhashtbl, M_CACHE, fdhash); 113 mtx_destroy(&fdesc_hashmtx); 114 return (0); 115 } 116 117 /* 118 * If allocating vnode fails, call this. 119 */ 120 static void 121 fdesc_insmntque_dtr(struct vnode *vp, void *arg) 122 { 123 124 vgone(vp); 125 vput(vp); 126 } 127 128 /* 129 * Remove an entry from the hash if it exists. 130 */ 131 static void 132 fdesc_remove_entry(struct fdescnode *fd) 133 { 134 struct fdhashhead *fc; 135 struct fdescnode *fd2; 136 137 fc = FD_NHASH(fd->fd_ix); 138 mtx_lock(&fdesc_hashmtx); 139 LIST_FOREACH(fd2, fc, fd_hash) { 140 if (fd == fd2) { 141 LIST_REMOVE(fd, fd_hash); 142 break; 143 } 144 } 145 mtx_unlock(&fdesc_hashmtx); 146 } 147 148 int 149 fdesc_allocvp(ftype, fd_fd, ix, mp, vpp) 150 fdntype ftype; 151 unsigned fd_fd; 152 int ix; 153 struct mount *mp; 154 struct vnode **vpp; 155 { 156 struct fdescmount *fmp; 157 struct fdhashhead *fc; 158 struct fdescnode *fd, *fd2; 159 struct vnode *vp, *vp2; 160 struct thread *td; 161 int error = 0; 162 163 td = curthread; 164 fc = FD_NHASH(ix); 165 loop: 166 mtx_lock(&fdesc_hashmtx); 167 /* 168 * If a forced unmount is progressing, we need to drop it. The flags are 169 * protected by the hashmtx. 170 */ 171 fmp = (struct fdescmount *)mp->mnt_data; 172 if (fmp == NULL || fmp->flags & FMNT_UNMOUNTF) { 173 mtx_unlock(&fdesc_hashmtx); 174 return (-1); 175 } 176 177 LIST_FOREACH(fd, fc, fd_hash) { 178 if (fd->fd_ix == ix && fd->fd_vnode->v_mount == mp) { 179 /* Get reference to vnode in case it's being free'd */ 180 vp = fd->fd_vnode; 181 VI_LOCK(vp); 182 mtx_unlock(&fdesc_hashmtx); 183 if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, td)) 184 goto loop; 185 *vpp = vp; 186 return (0); 187 } 188 } 189 mtx_unlock(&fdesc_hashmtx); 190 191 fd = malloc(sizeof(struct fdescnode), M_TEMP, M_WAITOK); 192 193 error = getnewvnode("fdescfs", mp, &fdesc_vnodeops, &vp); 194 if (error) { 195 free(fd, M_TEMP); 196 return (error); 197 } 198 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY); 199 vp->v_data = fd; 200 fd->fd_vnode = vp; 201 fd->fd_type = ftype; 202 fd->fd_fd = fd_fd; 203 fd->fd_ix = ix; 204 error = insmntque1(vp, mp, fdesc_insmntque_dtr, NULL); 205 if (error != 0) { 206 *vpp = NULLVP; 207 return (error); 208 } 209 210 /* Make sure that someone didn't beat us when inserting the vnode. */ 211 mtx_lock(&fdesc_hashmtx); 212 /* 213 * If a forced unmount is progressing, we need to drop it. The flags are 214 * protected by the hashmtx. 215 */ 216 fmp = (struct fdescmount *)mp->mnt_data; 217 if (fmp == NULL || fmp->flags & FMNT_UNMOUNTF) { 218 mtx_unlock(&fdesc_hashmtx); 219 vgone(vp); 220 vput(vp); 221 *vpp = NULLVP; 222 return (-1); 223 } 224 225 LIST_FOREACH(fd2, fc, fd_hash) { 226 if (fd2->fd_ix == ix && fd2->fd_vnode->v_mount == mp) { 227 /* Get reference to vnode in case it's being free'd */ 228 vp2 = fd2->fd_vnode; 229 VI_LOCK(vp2); 230 mtx_unlock(&fdesc_hashmtx); 231 error = vget(vp2, LK_EXCLUSIVE | LK_INTERLOCK, td); 232 /* Someone beat us, dec use count and wait for reclaim */ 233 vgone(vp); 234 vput(vp); 235 /* If we didn't get it, return no vnode. */ 236 if (error) 237 vp2 = NULLVP; 238 *vpp = vp2; 239 return (error); 240 } 241 } 242 243 /* If we came here, we can insert it safely. */ 244 LIST_INSERT_HEAD(fc, fd, fd_hash); 245 mtx_unlock(&fdesc_hashmtx); 246 *vpp = vp; 247 return (0); 248 } 249 250 struct fdesc_get_ino_args { 251 fdntype ftype; 252 unsigned fd_fd; 253 int ix; 254 struct file *fp; 255 struct thread *td; 256 }; 257 258 static int 259 fdesc_get_ino_alloc(struct mount *mp, void *arg, int lkflags, 260 struct vnode **rvp) 261 { 262 struct fdesc_get_ino_args *a; 263 int error; 264 265 a = arg; 266 error = fdesc_allocvp(a->ftype, a->fd_fd, a->ix, mp, rvp); 267 fdrop(a->fp, a->td); 268 return (error); 269 } 270 271 272 /* 273 * vp is the current namei directory 274 * ndp is the name to locate in that directory... 275 */ 276 static int 277 fdesc_lookup(ap) 278 struct vop_lookup_args /* { 279 struct vnode * a_dvp; 280 struct vnode ** a_vpp; 281 struct componentname * a_cnp; 282 } */ *ap; 283 { 284 struct vnode **vpp = ap->a_vpp; 285 struct vnode *dvp = ap->a_dvp; 286 struct componentname *cnp = ap->a_cnp; 287 char *pname = cnp->cn_nameptr; 288 struct thread *td = cnp->cn_thread; 289 struct file *fp; 290 struct fdesc_get_ino_args arg; 291 cap_rights_t rights; 292 int nlen = cnp->cn_namelen; 293 u_int fd, fd1; 294 int error; 295 struct vnode *fvp; 296 297 if ((cnp->cn_flags & ISLASTCN) && 298 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) { 299 error = EROFS; 300 goto bad; 301 } 302 303 if (cnp->cn_namelen == 1 && *pname == '.') { 304 *vpp = dvp; 305 VREF(dvp); 306 return (0); 307 } 308 309 if (VTOFDESC(dvp)->fd_type != Froot) { 310 error = ENOTDIR; 311 goto bad; 312 } 313 314 fd = 0; 315 /* the only time a leading 0 is acceptable is if it's "0" */ 316 if (*pname == '0' && nlen != 1) { 317 error = ENOENT; 318 goto bad; 319 } 320 while (nlen--) { 321 if (*pname < '0' || *pname > '9') { 322 error = ENOENT; 323 goto bad; 324 } 325 fd1 = 10 * fd + *pname++ - '0'; 326 if (fd1 < fd) { 327 error = ENOENT; 328 goto bad; 329 } 330 fd = fd1; 331 } 332 333 /* 334 * No rights to check since 'fp' isn't actually used. 335 */ 336 if ((error = fget(td, fd, cap_rights_init(&rights), &fp)) != 0) 337 goto bad; 338 339 /* Check if we're looking up ourselves. */ 340 if (VTOFDESC(dvp)->fd_ix == FD_DESC + fd) { 341 /* 342 * In case we're holding the last reference to the file, the dvp 343 * will be re-acquired. 344 */ 345 vhold(dvp); 346 VOP_UNLOCK(dvp, 0); 347 fdrop(fp, td); 348 349 /* Re-aquire the lock afterwards. */ 350 vn_lock(dvp, LK_RETRY | LK_EXCLUSIVE); 351 vdrop(dvp); 352 fvp = dvp; 353 if ((dvp->v_iflag & VI_DOOMED) != 0) 354 error = ENOENT; 355 } else { 356 /* 357 * Unlock our root node (dvp) when doing this, since we might 358 * deadlock since the vnode might be locked by another thread 359 * and the root vnode lock will be obtained afterwards (in case 360 * we're looking up the fd of the root vnode), which will be the 361 * opposite lock order. Vhold the root vnode first so we don't 362 * lose it. 363 */ 364 arg.ftype = Fdesc; 365 arg.fd_fd = fd; 366 arg.ix = FD_DESC + fd; 367 arg.fp = fp; 368 arg.td = td; 369 error = vn_vget_ino_gen(dvp, fdesc_get_ino_alloc, &arg, 370 LK_EXCLUSIVE, &fvp); 371 } 372 373 if (error) 374 goto bad; 375 *vpp = fvp; 376 return (0); 377 378 bad: 379 *vpp = NULL; 380 return (error); 381 } 382 383 static int 384 fdesc_open(ap) 385 struct vop_open_args /* { 386 struct vnode *a_vp; 387 int a_mode; 388 struct ucred *a_cred; 389 struct thread *a_td; 390 } */ *ap; 391 { 392 struct vnode *vp = ap->a_vp; 393 394 if (VTOFDESC(vp)->fd_type == Froot) 395 return (0); 396 397 /* 398 * XXX Kludge: set td->td_proc->p_dupfd to contain the value of the file 399 * descriptor being sought for duplication. The error return ensures 400 * that the vnode for this device will be released by vn_open. Open 401 * will detect this special error and take the actions in dupfdopen. 402 * Other callers of vn_open or VOP_OPEN will simply report the 403 * error. 404 */ 405 ap->a_td->td_dupfd = VTOFDESC(vp)->fd_fd; /* XXX */ 406 return (ENODEV); 407 } 408 409 static int 410 fdesc_getattr(ap) 411 struct vop_getattr_args /* { 412 struct vnode *a_vp; 413 struct vattr *a_vap; 414 struct ucred *a_cred; 415 } */ *ap; 416 { 417 struct vnode *vp = ap->a_vp; 418 struct vattr *vap = ap->a_vap; 419 420 vap->va_mode = S_IRUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH; 421 vap->va_fileid = VTOFDESC(vp)->fd_ix; 422 vap->va_uid = 0; 423 vap->va_gid = 0; 424 vap->va_blocksize = DEV_BSIZE; 425 vap->va_atime.tv_sec = boottime.tv_sec; 426 vap->va_atime.tv_nsec = 0; 427 vap->va_mtime = vap->va_atime; 428 vap->va_ctime = vap->va_mtime; 429 vap->va_gen = 0; 430 vap->va_flags = 0; 431 vap->va_bytes = 0; 432 vap->va_filerev = 0; 433 434 switch (VTOFDESC(vp)->fd_type) { 435 case Froot: 436 vap->va_type = VDIR; 437 vap->va_nlink = 2; 438 vap->va_size = DEV_BSIZE; 439 vap->va_rdev = NODEV; 440 break; 441 442 case Fdesc: 443 vap->va_type = VCHR; 444 vap->va_nlink = 1; 445 vap->va_size = 0; 446 vap->va_rdev = makedev(0, vap->va_fileid); 447 break; 448 449 default: 450 panic("fdesc_getattr"); 451 break; 452 } 453 454 vp->v_type = vap->va_type; 455 return (0); 456 } 457 458 static int 459 fdesc_setattr(ap) 460 struct vop_setattr_args /* { 461 struct vnode *a_vp; 462 struct vattr *a_vap; 463 struct ucred *a_cred; 464 } */ *ap; 465 { 466 struct vattr *vap = ap->a_vap; 467 struct vnode *vp; 468 struct mount *mp; 469 struct file *fp; 470 struct thread *td = curthread; 471 cap_rights_t rights; 472 unsigned fd; 473 int error; 474 475 /* 476 * Can't mess with the root vnode 477 */ 478 if (VTOFDESC(ap->a_vp)->fd_type == Froot) 479 return (EACCES); 480 481 fd = VTOFDESC(ap->a_vp)->fd_fd; 482 483 /* 484 * Allow setattr where there is an underlying vnode. 485 */ 486 error = getvnode(td, fd, 487 cap_rights_init(&rights, CAP_EXTATTR_SET), &fp); 488 if (error) { 489 /* 490 * getvnode() returns EINVAL if the file descriptor is not 491 * backed by a vnode. Silently drop all changes except 492 * chflags(2) in this case. 493 */ 494 if (error == EINVAL) { 495 if (vap->va_flags != VNOVAL) 496 error = EOPNOTSUPP; 497 else 498 error = 0; 499 } 500 return (error); 501 } 502 vp = fp->f_vnode; 503 if ((error = vn_start_write(vp, &mp, V_WAIT | PCATCH)) == 0) { 504 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY); 505 error = VOP_SETATTR(vp, ap->a_vap, ap->a_cred); 506 VOP_UNLOCK(vp, 0); 507 vn_finished_write(mp); 508 } 509 fdrop(fp, td); 510 return (error); 511 } 512 513 #define UIO_MX 16 514 515 static int 516 fdesc_readdir(ap) 517 struct vop_readdir_args /* { 518 struct vnode *a_vp; 519 struct uio *a_uio; 520 struct ucred *a_cred; 521 int *a_eofflag; 522 u_long *a_cookies; 523 int a_ncookies; 524 } */ *ap; 525 { 526 struct uio *uio = ap->a_uio; 527 struct filedesc *fdp; 528 struct dirent d; 529 struct dirent *dp = &d; 530 int error, i, off, fcnt; 531 532 if (VTOFDESC(ap->a_vp)->fd_type != Froot) 533 panic("fdesc_readdir: not dir"); 534 535 if (ap->a_ncookies != NULL) 536 *ap->a_ncookies = 0; 537 538 off = (int)uio->uio_offset; 539 if (off != uio->uio_offset || off < 0 || (u_int)off % UIO_MX != 0 || 540 uio->uio_resid < UIO_MX) 541 return (EINVAL); 542 i = (u_int)off / UIO_MX; 543 fdp = uio->uio_td->td_proc->p_fd; 544 error = 0; 545 546 fcnt = i - 2; /* The first two nodes are `.' and `..' */ 547 548 FILEDESC_SLOCK(fdp); 549 while (i < fdp->fd_nfiles + 2 && uio->uio_resid >= UIO_MX) { 550 bzero((caddr_t)dp, UIO_MX); 551 switch (i) { 552 case 0: /* `.' */ 553 case 1: /* `..' */ 554 dp->d_fileno = i + FD_ROOT; 555 dp->d_namlen = i + 1; 556 dp->d_reclen = UIO_MX; 557 bcopy("..", dp->d_name, dp->d_namlen); 558 dp->d_name[i + 1] = '\0'; 559 dp->d_type = DT_DIR; 560 break; 561 default: 562 if (fdp->fd_ofiles[fcnt].fde_file == NULL) 563 break; 564 dp->d_namlen = sprintf(dp->d_name, "%d", fcnt); 565 dp->d_reclen = UIO_MX; 566 dp->d_type = DT_CHR; 567 dp->d_fileno = i + FD_DESC; 568 break; 569 } 570 if (dp->d_namlen != 0) { 571 /* 572 * And ship to userland 573 */ 574 FILEDESC_SUNLOCK(fdp); 575 error = uiomove(dp, UIO_MX, uio); 576 if (error) 577 goto done; 578 FILEDESC_SLOCK(fdp); 579 } 580 i++; 581 fcnt++; 582 } 583 FILEDESC_SUNLOCK(fdp); 584 585 done: 586 uio->uio_offset = i * UIO_MX; 587 return (error); 588 } 589 590 static int 591 fdesc_reclaim(ap) 592 struct vop_reclaim_args /* { 593 struct vnode *a_vp; 594 } */ *ap; 595 { 596 struct vnode *vp; 597 struct fdescnode *fd; 598 599 vp = ap->a_vp; 600 fd = VTOFDESC(vp); 601 fdesc_remove_entry(fd); 602 free(vp->v_data, M_TEMP); 603 vp->v_data = NULL; 604 return (0); 605 } 606