]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/fs/fdescfs/fdesc_vnops.c
Upgrade to version 3.1.5
[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_insmntque_dtr(struct vnode *, void *);
97 static void fdesc_remove_entry(struct fdescnode *);
98
99 /*
100  * Initialise cache headers
101  */
102 int
103 fdesc_init(struct vfsconf *vfsp)
104 {
105
106         mtx_init(&fdesc_hashmtx, "fdescfs_hash", NULL, MTX_DEF);
107         fdhashtbl = hashinit(NFDCACHE, M_CACHE, &fdhash);
108         return (0);
109 }
110
111 /*
112  * Uninit ready for unload.
113  */
114 int
115 fdesc_uninit(struct vfsconf *vfsp)
116 {
117
118         hashdestroy(fdhashtbl, M_CACHE, fdhash);
119         mtx_destroy(&fdesc_hashmtx);
120         return (0);
121 }
122
123 /*
124  * If allocating vnode fails, call this.
125  */
126 static void
127 fdesc_insmntque_dtr(struct vnode *vp, void *arg)
128 {
129
130         vgone(vp);
131         vput(vp);
132 }
133
134 /*
135  * Remove an entry from the hash if it exists.
136  */
137 static void
138 fdesc_remove_entry(struct fdescnode *fd)
139 {
140         struct fdhashhead *fc;
141         struct fdescnode *fd2;
142
143         fc = FD_NHASH(fd->fd_ix);
144         mtx_lock(&fdesc_hashmtx);
145         LIST_FOREACH(fd2, fc, fd_hash) {
146                 if (fd == fd2) {
147                         LIST_REMOVE(fd, fd_hash);
148                         break;
149                 }
150         }
151         mtx_unlock(&fdesc_hashmtx);
152 }
153
154 int
155 fdesc_allocvp(fdntype ftype, unsigned fd_fd, int ix, struct mount *mp,
156     struct vnode **vpp)
157 {
158         struct fdescmount *fmp;
159         struct fdhashhead *fc;
160         struct fdescnode *fd, *fd2;
161         struct vnode *vp, *vp2;
162         struct thread *td;
163         int error;
164
165         td = curthread;
166         fc = FD_NHASH(ix);
167 loop:
168         mtx_lock(&fdesc_hashmtx);
169         /*
170          * If a forced unmount is progressing, we need to drop it. The flags are
171          * protected by the hashmtx.
172          */
173         fmp = mp->mnt_data;
174         if (fmp == NULL || fmp->flags & FMNT_UNMOUNTF) {
175                 mtx_unlock(&fdesc_hashmtx);
176                 return (-1);
177         }
178
179         LIST_FOREACH(fd, fc, fd_hash) {
180                 if (fd->fd_ix == ix && fd->fd_vnode->v_mount == mp) {
181                         /* Get reference to vnode in case it's being free'd */
182                         vp = fd->fd_vnode;
183                         VI_LOCK(vp);
184                         mtx_unlock(&fdesc_hashmtx);
185                         if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, td))
186                                 goto loop;
187                         *vpp = vp;
188                         return (0);
189                 }
190         }
191         mtx_unlock(&fdesc_hashmtx);
192
193         fd = malloc(sizeof(struct fdescnode), M_TEMP, M_WAITOK);
194
195         error = getnewvnode("fdescfs", mp, &fdesc_vnodeops, &vp);
196         if (error) {
197                 free(fd, M_TEMP);
198                 return (error);
199         }
200         vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
201         vp->v_data = fd;
202         fd->fd_vnode = vp;
203         fd->fd_type = ftype;
204         fd->fd_fd = fd_fd;
205         fd->fd_ix = ix;
206         if (ftype == Fdesc && fmp->flags & FMNT_LINRDLNKF)
207                 vp->v_vflag |= VV_READLINK;
208         error = insmntque1(vp, mp, fdesc_insmntque_dtr, NULL);
209         if (error != 0) {
210                 *vpp = NULLVP;
211                 return (error);
212         }
213
214         /* Make sure that someone didn't beat us when inserting the vnode. */
215         mtx_lock(&fdesc_hashmtx);
216         /*
217          * If a forced unmount is progressing, we need to drop it. The flags are
218          * protected by the hashmtx.
219          */
220         fmp = mp->mnt_data;
221         if (fmp == NULL || fmp->flags & FMNT_UNMOUNTF) {
222                 mtx_unlock(&fdesc_hashmtx);
223                 vgone(vp);
224                 vput(vp);
225                 *vpp = NULLVP;
226                 return (-1);
227         }
228
229         LIST_FOREACH(fd2, fc, fd_hash) {
230                 if (fd2->fd_ix == ix && fd2->fd_vnode->v_mount == mp) {
231                         /* Get reference to vnode in case it's being free'd */
232                         vp2 = fd2->fd_vnode;
233                         VI_LOCK(vp2);
234                         mtx_unlock(&fdesc_hashmtx);
235                         error = vget(vp2, LK_EXCLUSIVE | LK_INTERLOCK, td);
236                         /* Someone beat us, dec use count and wait for reclaim */
237                         vgone(vp);
238                         vput(vp);
239                         /* If we didn't get it, return no vnode. */
240                         if (error)
241                                 vp2 = NULLVP;
242                         *vpp = vp2;
243                         return (error);
244                 }
245         }
246
247         /* If we came here, we can insert it safely. */
248         LIST_INSERT_HEAD(fc, fd, fd_hash);
249         mtx_unlock(&fdesc_hashmtx);
250         *vpp = vp;
251         return (0);
252 }
253
254 struct fdesc_get_ino_args {
255         fdntype ftype;
256         unsigned fd_fd;
257         int ix;
258         struct file *fp;
259         struct thread *td;
260 };
261
262 static int
263 fdesc_get_ino_alloc(struct mount *mp, void *arg, int lkflags,
264     struct vnode **rvp)
265 {
266         struct fdesc_get_ino_args *a;
267         int error;
268
269         a = arg;
270         error = fdesc_allocvp(a->ftype, a->fd_fd, a->ix, mp, rvp);
271         fdrop(a->fp, a->td);
272         return (error);
273 }
274
275
276 /*
277  * vp is the current namei directory
278  * ndp is the name to locate in that directory...
279  */
280 static int
281 fdesc_lookup(struct vop_lookup_args *ap)
282 {
283         struct vnode **vpp = ap->a_vpp;
284         struct vnode *dvp = ap->a_dvp;
285         struct componentname *cnp = ap->a_cnp;
286         char *pname = cnp->cn_nameptr;
287         struct thread *td = cnp->cn_thread;
288         struct file *fp;
289         struct fdesc_get_ino_args arg;
290         int nlen = cnp->cn_namelen;
291         u_int fd, fd1;
292         int error;
293         struct vnode *fvp;
294
295         if ((cnp->cn_flags & ISLASTCN) &&
296             (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
297                 error = EROFS;
298                 goto bad;
299         }
300
301         if (cnp->cn_namelen == 1 && *pname == '.') {
302                 *vpp = dvp;
303                 VREF(dvp);
304                 return (0);
305         }
306
307         if (VTOFDESC(dvp)->fd_type != Froot) {
308                 error = ENOTDIR;
309                 goto bad;
310         }
311
312         fd = 0;
313         /* the only time a leading 0 is acceptable is if it's "0" */
314         if (*pname == '0' && nlen != 1) {
315                 error = ENOENT;
316                 goto bad;
317         }
318         while (nlen--) {
319                 if (*pname < '0' || *pname > '9') {
320                         error = ENOENT;
321                         goto bad;
322                 }
323                 fd1 = 10 * fd + *pname++ - '0';
324                 if (fd1 < fd) {
325                         error = ENOENT;
326                         goto bad;
327                 }
328                 fd = fd1;
329         }
330
331         /*
332          * No rights to check since 'fp' isn't actually used.
333          */
334         if ((error = fget(td, fd, &cap_no_rights, &fp)) != 0)
335                 goto bad;
336
337         /* Check if we're looking up ourselves. */
338         if (VTOFDESC(dvp)->fd_ix == FD_DESC + fd) {
339                 /*
340                  * In case we're holding the last reference to the file, the dvp
341                  * will be re-acquired.
342                  */
343                 vhold(dvp);
344                 VOP_UNLOCK(dvp);
345                 fdrop(fp, td);
346
347                 /* Re-aquire the lock afterwards. */
348                 vn_lock(dvp, LK_RETRY | LK_EXCLUSIVE);
349                 vdrop(dvp);
350                 fvp = dvp;
351                 if (VN_IS_DOOMED(dvp))
352                         error = ENOENT;
353         } else {
354                 /*
355                  * Unlock our root node (dvp) when doing this, since we might
356                  * deadlock since the vnode might be locked by another thread
357                  * and the root vnode lock will be obtained afterwards (in case
358                  * we're looking up the fd of the root vnode), which will be the
359                  * opposite lock order. Vhold the root vnode first so we don't
360                  * lose it.
361                  */
362                 arg.ftype = Fdesc;
363                 arg.fd_fd = fd;
364                 arg.ix = FD_DESC + fd;
365                 arg.fp = fp;
366                 arg.td = td;
367                 error = vn_vget_ino_gen(dvp, fdesc_get_ino_alloc, &arg,
368                     LK_EXCLUSIVE, &fvp);
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 = (vp->v_vflag & VV_READLINK) == 0 ? VCHR : VLNK;
462                 vap->va_nlink = 1;
463                 vap->va_size = 0;
464                 vap->va_rdev = makedev(0, vap->va_fileid);
465                 break;
466
467         default:
468                 panic("fdesc_getattr");
469                 break;
470         }
471
472         vp->v_type = vap->va_type;
473         return (0);
474 }
475
476 static int
477 fdesc_setattr(struct vop_setattr_args *ap)
478 {
479         struct vattr *vap = ap->a_vap;
480         struct vnode *vp;
481         struct mount *mp;
482         struct file *fp;
483         struct thread *td = curthread;
484         cap_rights_t rights;
485         unsigned fd;
486         int error;
487
488         /*
489          * Can't mess with the root vnode
490          */
491         if (VTOFDESC(ap->a_vp)->fd_type == Froot)
492                 return (EACCES);
493
494         fd = VTOFDESC(ap->a_vp)->fd_fd;
495
496         /*
497          * Allow setattr where there is an underlying vnode.
498          */
499         error = getvnode(td, fd,
500             cap_rights_init(&rights, CAP_EXTATTR_SET), &fp);
501         if (error) {
502                 /*
503                  * getvnode() returns EINVAL if the file descriptor is not
504                  * backed by a vnode.  Silently drop all changes except
505                  * chflags(2) in this case.
506                  */
507                 if (error == EINVAL) {
508                         if (vap->va_flags != VNOVAL)
509                                 error = EOPNOTSUPP;
510                         else
511                                 error = 0;
512                 }
513                 return (error);
514         }
515         vp = fp->f_vnode;
516         if ((error = vn_start_write(vp, &mp, V_WAIT | PCATCH)) == 0) {
517                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
518                 error = VOP_SETATTR(vp, ap->a_vap, ap->a_cred);
519                 VOP_UNLOCK(vp);
520                 vn_finished_write(mp);
521         }
522         fdrop(fp, td);
523         return (error);
524 }
525
526 #define UIO_MX _GENERIC_DIRLEN(10) /* number of symbols in INT_MAX printout */
527
528 static int
529 fdesc_readdir(struct vop_readdir_args *ap)
530 {
531         struct fdescmount *fmp;
532         struct uio *uio = ap->a_uio;
533         struct filedesc *fdp;
534         struct dirent d;
535         struct dirent *dp = &d;
536         int error, i, off, fcnt;
537
538         if (VTOFDESC(ap->a_vp)->fd_type != Froot)
539                 panic("fdesc_readdir: not dir");
540
541         fmp = VFSTOFDESC(ap->a_vp->v_mount);
542         if (ap->a_ncookies != NULL)
543                 *ap->a_ncookies = 0;
544
545         off = (int)uio->uio_offset;
546         if (off != uio->uio_offset || off < 0 || (u_int)off % UIO_MX != 0 ||
547             uio->uio_resid < UIO_MX)
548                 return (EINVAL);
549         i = (u_int)off / UIO_MX;
550         fdp = uio->uio_td->td_proc->p_fd;
551         error = 0;
552
553         fcnt = i - 2;           /* The first two nodes are `.' and `..' */
554
555         FILEDESC_SLOCK(fdp);
556         while (i < fdp->fd_nfiles + 2 && uio->uio_resid >= UIO_MX) {
557                 bzero((caddr_t)dp, UIO_MX);
558                 switch (i) {
559                 case 0: /* `.' */
560                 case 1: /* `..' */
561                         dp->d_fileno = i + FD_ROOT;
562                         dp->d_namlen = i + 1;
563                         dp->d_reclen = UIO_MX;
564                         bcopy("..", dp->d_name, dp->d_namlen);
565                         dp->d_type = DT_DIR;
566                         dirent_terminate(dp);
567                         break;
568                 default:
569                         if (fdp->fd_ofiles[fcnt].fde_file == NULL)
570                                 break;
571                         dp->d_namlen = sprintf(dp->d_name, "%d", fcnt);
572                         dp->d_reclen = UIO_MX;
573                         dp->d_type = (fmp->flags & FMNT_LINRDLNKF) == 0 ?
574                             DT_CHR : DT_LNK;
575                         dp->d_fileno = i + FD_DESC;
576                         dirent_terminate(dp);
577                         break;
578                 }
579                 /* NOTE: d_off is the offset of the *next* entry. */
580                 dp->d_off = UIO_MX * (i + 1);
581                 if (dp->d_namlen != 0) {
582                         /*
583                          * And ship to userland
584                          */
585                         FILEDESC_SUNLOCK(fdp);
586                         error = uiomove(dp, UIO_MX, uio);
587                         if (error)
588                                 goto done;
589                         FILEDESC_SLOCK(fdp);
590                 }
591                 i++;
592                 fcnt++;
593         }
594         FILEDESC_SUNLOCK(fdp);
595
596 done:
597         uio->uio_offset = i * UIO_MX;
598         return (error);
599 }
600
601 static int
602 fdesc_reclaim(struct vop_reclaim_args *ap)
603 {
604         struct vnode *vp;
605         struct fdescnode *fd;
606
607         vp = ap->a_vp;
608         fd = VTOFDESC(vp);
609         fdesc_remove_entry(fd);
610         free(vp->v_data, M_TEMP);
611         vp->v_data = NULL;
612         return (0);
613 }
614
615 static int
616 fdesc_readlink(struct vop_readlink_args *va)
617 {
618         struct vnode *vp, *vn;
619         struct thread *td;
620         struct uio *uio;
621         struct file *fp;
622         char *freepath, *fullpath;
623         size_t pathlen;
624         int lockflags, fd_fd;
625         int error;
626
627         freepath = NULL;
628         vn = va->a_vp;
629         if (VTOFDESC(vn)->fd_type != Fdesc)
630                 panic("fdesc_readlink: not fdescfs link");
631         fd_fd = ((struct fdescnode *)vn->v_data)->fd_fd;
632         lockflags = VOP_ISLOCKED(vn);
633         VOP_UNLOCK(vn);
634
635         td = curthread;
636         error = fget_cap(td, fd_fd, &cap_no_rights, &fp, NULL);
637         if (error != 0)
638                 goto out;
639
640         switch (fp->f_type) {
641         case DTYPE_VNODE:
642                 vp = fp->f_vnode;
643                 error = vn_fullpath(td, vp, &fullpath, &freepath);
644                 break;
645         default:
646                 fullpath = "anon_inode:[unknown]";
647                 break;
648         }
649         if (error == 0) {
650                 uio = va->a_uio;
651                 pathlen = strlen(fullpath);
652                 error = uiomove(fullpath, pathlen, uio);
653         }
654         if (freepath != NULL)
655                 free(freepath, M_TEMP);
656         fdrop(fp, td);
657
658 out:
659         vn_lock(vn, lockflags | LK_RETRY);
660         return (error);
661 }