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