]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/fs/fdescfs/fdesc_vnops.c
zfs: merge openzfs/zfs@a9d6b0690
[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         /* Cannot set v_type to VCHR */
194         if (ftype == Fdesc && (fmp->flags & FMNT_LINRDLNKF) != 0)
195                 vp->v_type = VLNK;
196         error = insmntque1(vp, mp);
197         if (error != 0) {
198                 vgone(vp);
199                 vput(vp);
200                 *vpp = NULLVP;
201                 return (error);
202         }
203
204         /* Make sure that someone didn't beat us when inserting the vnode. */
205         mtx_lock(&fdesc_hashmtx);
206         /*
207          * If a forced unmount is progressing, we need to drop it. The flags are
208          * protected by the hashmtx.
209          */
210         fmp = mp->mnt_data;
211         if (fmp == NULL || fmp->flags & FMNT_UNMOUNTF) {
212                 mtx_unlock(&fdesc_hashmtx);
213                 vgone(vp);
214                 vput(vp);
215                 *vpp = NULLVP;
216                 return (-1);
217         }
218
219         LIST_FOREACH(fd2, fc, fd_hash) {
220                 if (fd2->fd_ix == ix && fd2->fd_vnode->v_mount == mp) {
221                         /* Get reference to vnode in case it's being free'd */
222                         vp2 = fd2->fd_vnode;
223                         vgs = vget_prep(vp2);
224                         mtx_unlock(&fdesc_hashmtx);
225                         error = vget_finish(vp2, LK_EXCLUSIVE, vgs);
226                         /* Someone beat us, dec use count and wait for reclaim */
227                         vgone(vp);
228                         vput(vp);
229                         /* If we didn't get it, return no vnode. */
230                         if (error)
231                                 vp2 = NULLVP;
232                         *vpp = vp2;
233                         return (error);
234                 }
235         }
236
237         /* If we came here, we can insert it safely. */
238         LIST_INSERT_HEAD(fc, fd, fd_hash);
239         mtx_unlock(&fdesc_hashmtx);
240         vn_set_state(vp, VSTATE_CONSTRUCTED);
241         *vpp = vp;
242         return (0);
243 }
244
245 struct fdesc_get_ino_args {
246         fdntype ftype;
247         unsigned fd_fd;
248         int ix;
249         struct file *fp;
250         struct thread *td;
251         bool fdropped;
252 };
253
254 static int
255 fdesc_get_ino_alloc(struct mount *mp, void *arg, int lkflags,
256     struct vnode **rvp)
257 {
258         struct fdesc_get_ino_args *a;
259         struct fdescmount *fdm;
260         struct vnode *vp;
261         int error;
262
263         a = arg;
264         fdm = VFSTOFDESC(mp);
265         if ((fdm->flags & FMNT_NODUP) != 0 && a->fp->f_type == DTYPE_VNODE) {
266                 vp = a->fp->f_vnode;
267                 vget(vp, lkflags | LK_RETRY);
268                 *rvp = vp;
269                 error = 0;
270         } else {
271                 error = fdesc_allocvp(a->ftype, a->fd_fd, a->ix, mp, rvp);
272         }
273         fdrop(a->fp, a->td);
274         a->fdropped = true;
275         return (error);
276 }
277
278 /*
279  * vp is the current namei directory
280  * ndp is the name to locate in that directory...
281  */
282 static int
283 fdesc_lookup(struct vop_lookup_args *ap)
284 {
285         struct vnode **vpp = ap->a_vpp;
286         struct vnode *dvp = ap->a_dvp;
287         struct componentname *cnp = ap->a_cnp;
288         char *pname = cnp->cn_nameptr;
289         struct thread *td = curthread;
290         struct file *fp;
291         struct fdesc_get_ino_args arg;
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_no_rights, &fp)) != 0)
337                 goto bad;
338
339         /*
340          * Make sure we do not deadlock looking up the dvp itself.
341          *
342          * Unlock our root node (dvp) when doing this, since we might
343          * deadlock since the vnode might be locked by another thread
344          * and the root vnode lock will be obtained afterwards (in case
345          * we're looking up the fd of the root vnode), which will be the
346          * opposite lock order.
347          */
348         arg.ftype = Fdesc;
349         arg.fd_fd = fd;
350         arg.ix = FD_DESC + fd;
351         arg.fp = fp;
352         arg.td = td;
353         arg.fdropped = false;
354         error = vn_vget_ino_gen(dvp, fdesc_get_ino_alloc, &arg,
355             LK_EXCLUSIVE, &fvp);
356
357         if (!arg.fdropped) {
358                 /*
359                  * In case we're holding the last reference to the file, the dvp
360                  * will be re-acquired.
361                  */
362                 VOP_UNLOCK(dvp);
363                 fdrop(fp, td);
364
365                 vn_lock(dvp, LK_RETRY | LK_EXCLUSIVE);
366                 fvp = dvp;
367                 if (error == 0 && VN_IS_DOOMED(dvp))
368                         error = ENOENT;
369         }
370
371         if (error)
372                 goto bad;
373         *vpp = fvp;
374         return (0);
375
376 bad:
377         *vpp = NULL;
378         return (error);
379 }
380
381 static int
382 fdesc_open(struct vop_open_args *ap)
383 {
384         struct vnode *vp = ap->a_vp;
385
386         if (VTOFDESC(vp)->fd_type == Froot)
387                 return (0);
388
389         /*
390          * XXX Kludge: set td->td_proc->p_dupfd to contain the value of the file
391          * descriptor being sought for duplication. The error return ensures
392          * that the vnode for this device will be released by vn_open. Open
393          * will detect this special error and take the actions in dupfdopen.
394          * Other callers of vn_open or VOP_OPEN will simply report the
395          * error.
396          */
397         ap->a_td->td_dupfd = VTOFDESC(vp)->fd_fd;       /* XXX */
398         return (ENODEV);
399 }
400
401 static int
402 fdesc_pathconf(struct vop_pathconf_args *ap)
403 {
404         struct vnode *vp = ap->a_vp;
405         int error;
406
407         switch (ap->a_name) {
408         case _PC_NAME_MAX:
409                 *ap->a_retval = NAME_MAX;
410                 return (0);
411         case _PC_LINK_MAX:
412                 if (VTOFDESC(vp)->fd_type == Froot)
413                         *ap->a_retval = 2;
414                 else
415                         *ap->a_retval = 1;
416                 return (0);
417         default:
418                 if (VTOFDESC(vp)->fd_type == Froot)
419                         return (vop_stdpathconf(ap));
420                 vref(vp);
421                 VOP_UNLOCK(vp);
422                 error = kern_fpathconf(curthread, VTOFDESC(vp)->fd_fd,
423                     ap->a_name, ap->a_retval);
424                 vn_lock(vp, LK_SHARED | LK_RETRY);
425                 vunref(vp);
426                 return (error);
427         }
428 }
429
430 static int
431 fdesc_getattr(struct vop_getattr_args *ap)
432 {
433         struct vnode *vp = ap->a_vp;
434         struct vattr *vap = ap->a_vap;
435         struct timeval boottime;
436
437         getboottime(&boottime);
438         vap->va_mode = S_IRUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
439         vap->va_fileid = VTOFDESC(vp)->fd_ix;
440         vap->va_uid = 0;
441         vap->va_gid = 0;
442         vap->va_blocksize = DEV_BSIZE;
443         vap->va_atime.tv_sec = boottime.tv_sec;
444         vap->va_atime.tv_nsec = 0;
445         vap->va_mtime = vap->va_atime;
446         vap->va_ctime = vap->va_mtime;
447         vap->va_gen = 0;
448         vap->va_flags = 0;
449         vap->va_bytes = 0;
450         vap->va_filerev = 0;
451
452         switch (VTOFDESC(vp)->fd_type) {
453         case Froot:
454                 vap->va_type = VDIR;
455                 vap->va_nlink = 2;
456                 vap->va_size = DEV_BSIZE;
457                 vap->va_rdev = NODEV;
458                 break;
459
460         case Fdesc:
461                 vap->va_type = (VFSTOFDESC(vp->v_mount)->flags &
462                     FMNT_LINRDLNKF) == 0 ? VCHR : VLNK;
463                 vap->va_nlink = 1;
464                 vap->va_size = 0;
465                 vap->va_rdev = makedev(0, vap->va_fileid);
466                 break;
467
468         default:
469                 panic("fdesc_getattr");
470                 break;
471         }
472
473         vp->v_type = vap->va_type;
474         return (0);
475 }
476
477 static int
478 fdesc_setattr(struct vop_setattr_args *ap)
479 {
480         struct vattr *vap = ap->a_vap;
481         struct vnode *vp;
482         struct mount *mp;
483         struct file *fp;
484         struct thread *td = curthread;
485         cap_rights_t rights;
486         unsigned fd;
487         int error;
488
489         /*
490          * Can't mess with the root vnode
491          */
492         if (VTOFDESC(ap->a_vp)->fd_type == Froot)
493                 return (EACCES);
494
495         fd = VTOFDESC(ap->a_vp)->fd_fd;
496
497         /*
498          * Allow setattr where there is an underlying vnode.
499          * For O_PATH descriptors, disallow truncate.
500          */
501         if (vap->va_size != VNOVAL) {
502                 error = getvnode(td, fd,
503                     cap_rights_init_one(&rights, CAP_EXTATTR_SET), &fp);
504         } else {
505                 error = getvnode_path(td, fd,
506                     cap_rights_init_one(&rights, CAP_EXTATTR_SET), &fp);
507         }
508         if (error) {
509                 /*
510                  * getvnode() returns EINVAL if the file descriptor is not
511                  * backed by a vnode.  Silently drop all changes except
512                  * chflags(2) in this case.
513                  */
514                 if (error == EINVAL) {
515                         if (vap->va_flags != VNOVAL)
516                                 error = EOPNOTSUPP;
517                         else
518                                 error = 0;
519                 }
520                 return (error);
521         }
522         vp = fp->f_vnode;
523         if ((error = vn_start_write(vp, &mp, V_WAIT | V_PCATCH)) == 0) {
524                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
525                 error = VOP_SETATTR(vp, ap->a_vap, ap->a_cred);
526                 VOP_UNLOCK(vp);
527                 vn_finished_write(mp);
528         }
529         fdrop(fp, td);
530         return (error);
531 }
532
533 #define UIO_MX _GENERIC_DIRLEN(10) /* number of symbols in INT_MAX printout */
534
535 static int
536 fdesc_readdir(struct vop_readdir_args *ap)
537 {
538         struct fdescmount *fmp;
539         struct uio *uio = ap->a_uio;
540         struct filedesc *fdp;
541         struct dirent d;
542         struct dirent *dp = &d;
543         int error, i, off, fcnt;
544
545         if (VTOFDESC(ap->a_vp)->fd_type != Froot)
546                 panic("fdesc_readdir: not dir");
547
548         fmp = VFSTOFDESC(ap->a_vp->v_mount);
549         if (ap->a_ncookies != NULL)
550                 *ap->a_ncookies = 0;
551
552         off = (int)uio->uio_offset;
553         if (off != uio->uio_offset || off < 0 || (u_int)off % UIO_MX != 0 ||
554             uio->uio_resid < UIO_MX)
555                 return (EINVAL);
556         i = (u_int)off / UIO_MX;
557         fdp = uio->uio_td->td_proc->p_fd;
558         error = 0;
559
560         fcnt = i - 2;           /* The first two nodes are `.' and `..' */
561
562         FILEDESC_SLOCK(fdp);
563         while (i < fdp->fd_nfiles + 2 && uio->uio_resid >= UIO_MX) {
564                 bzero((caddr_t)dp, UIO_MX);
565                 switch (i) {
566                 case 0: /* `.' */
567                 case 1: /* `..' */
568                         dp->d_fileno = i + FD_ROOT;
569                         dp->d_namlen = i + 1;
570                         dp->d_reclen = UIO_MX;
571                         bcopy("..", dp->d_name, dp->d_namlen);
572                         dp->d_type = DT_DIR;
573                         dirent_terminate(dp);
574                         break;
575                 default:
576                         if (fdp->fd_ofiles[fcnt].fde_file == NULL)
577                                 break;
578                         dp->d_namlen = sprintf(dp->d_name, "%d", fcnt);
579                         dp->d_reclen = UIO_MX;
580                         dp->d_type = (fmp->flags & FMNT_LINRDLNKF) == 0 ?
581                             DT_CHR : DT_LNK;
582                         dp->d_fileno = i + FD_DESC;
583                         dirent_terminate(dp);
584                         break;
585                 }
586                 /* NOTE: d_off is the offset of the *next* entry. */
587                 dp->d_off = UIO_MX * (i + 1);
588                 if (dp->d_namlen != 0) {
589                         /*
590                          * And ship to userland
591                          */
592                         FILEDESC_SUNLOCK(fdp);
593                         error = uiomove(dp, UIO_MX, uio);
594                         if (error)
595                                 goto done;
596                         FILEDESC_SLOCK(fdp);
597                 }
598                 i++;
599                 fcnt++;
600         }
601         FILEDESC_SUNLOCK(fdp);
602
603 done:
604         uio->uio_offset = i * UIO_MX;
605         return (error);
606 }
607
608 static int
609 fdesc_reclaim(struct vop_reclaim_args *ap)
610 {
611         struct vnode *vp;
612         struct fdescnode *fd;
613
614         vp = ap->a_vp;
615         fd = VTOFDESC(vp);
616         fdesc_remove_entry(fd);
617         free(vp->v_data, M_TEMP);
618         vp->v_data = NULL;
619         return (0);
620 }
621
622 static int
623 fdesc_readlink(struct vop_readlink_args *va)
624 {
625         struct vnode *vp, *vn;
626         struct thread *td;
627         struct uio *uio;
628         struct file *fp;
629         char *freepath, *fullpath;
630         size_t pathlen;
631         int lockflags, fd_fd;
632         int error;
633
634         freepath = NULL;
635         vn = va->a_vp;
636         if (VTOFDESC(vn)->fd_type != Fdesc)
637                 panic("fdesc_readlink: not fdescfs link");
638         fd_fd = ((struct fdescnode *)vn->v_data)->fd_fd;
639         lockflags = VOP_ISLOCKED(vn);
640         VOP_UNLOCK(vn);
641
642         td = curthread;
643         error = fget_cap(td, fd_fd, &cap_no_rights, &fp, NULL);
644         if (error != 0)
645                 goto out;
646
647         switch (fp->f_type) {
648         case DTYPE_VNODE:
649                 vp = fp->f_vnode;
650                 error = vn_fullpath(vp, &fullpath, &freepath);
651                 break;
652         default:
653                 fullpath = "anon_inode:[unknown]";
654                 break;
655         }
656         if (error == 0) {
657                 uio = va->a_uio;
658                 pathlen = strlen(fullpath);
659                 error = uiomove(fullpath, pathlen, uio);
660         }
661         if (freepath != NULL)
662                 free(freepath, M_TEMP);
663         fdrop(fp, td);
664
665 out:
666         vn_lock(vn, lockflags | LK_RETRY);
667         return (error);
668 }