2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)vfs_vnops.c 8.2 (Berkeley) 1/21/94
39 * $FreeBSD: src/sys/kern/vfs_vnops.c,v 1.87.2.13 2002/12/29 18:19:53 dillon Exp $
40 * $DragonFly: src/sys/kern/vfs_vnops.c,v 1.28 2004/11/30 18:59:52 dillon Exp $
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/fcntl.h>
49 #include <sys/mount.h>
50 #include <sys/nlookup.h>
51 #include <sys/vnode.h>
53 #include <sys/filio.h>
54 #include <sys/ttycom.h>
56 #include <sys/syslog.h>
58 static int vn_closefile (struct file *fp, struct thread *td);
59 static int vn_ioctl (struct file *fp, u_long com, caddr_t data,
61 static int vn_read (struct file *fp, struct uio *uio,
62 struct ucred *cred, int flags, struct thread *td);
63 static int svn_read (struct file *fp, struct uio *uio,
64 struct ucred *cred, int flags, struct thread *td);
65 static int vn_poll (struct file *fp, int events, struct ucred *cred,
67 static int vn_kqfilter (struct file *fp, struct knote *kn);
68 static int vn_statfile (struct file *fp, struct stat *sb, struct thread *td);
69 static int vn_write (struct file *fp, struct uio *uio,
70 struct ucred *cred, int flags, struct thread *td);
71 static int svn_write (struct file *fp, struct uio *uio,
72 struct ucred *cred, int flags, struct thread *td);
74 struct fileops vnode_fileops = {
77 vn_read, vn_write, vn_ioctl, vn_poll, vn_kqfilter,
78 vn_statfile, vn_closefile
81 struct fileops specvnode_fileops = {
84 svn_read, svn_write, vn_ioctl, vn_poll, vn_kqfilter,
85 vn_statfile, vn_closefile
89 * Shortcut the device read/write. This avoids a lot of vnode junk.
90 * Basically the specfs vnops for read and write take the locked vnode,
91 * unlock it (because we can't hold the vnode locked while reading or writing
92 * a device which may block indefinitely), issues the device operation, then
93 * relock the vnode before returning, plus other junk. This bypasses all
94 * of that and just does the device operation.
97 vn_setspecops(struct file *fp)
99 if (vfs_fastdev && fp->f_ops == &vnode_fileops) {
100 fp->f_ops = &specvnode_fileops;
105 * Common code for vnode open operations. Check permissions, and call
106 * the VOP_NOPEN or VOP_NCREATE routine.
108 * The caller is responsible for setting up nd with nlookup_init() and
109 * for cleaning it up with nlookup_done(), whether we return an error
112 * On success nd->nl_open_vp will hold a referenced and, if requested,
113 * locked vnode. A locked vnode is requested via NLC_LOCKVP. If fp
114 * is non-NULL the vnode will be installed in the file pointer.
116 * NOTE: The vnode is referenced just once on return whether or not it
117 * is also installed in the file pointer.
120 vn_open(struct nlookupdata *nd, struct file *fp, int fmode, int cmode)
123 struct thread *td = nd->nl_td;
124 struct ucred *cred = nd->nl_cred;
126 struct vattr *vap = &vat;
127 struct namecache *ncp;
131 * Lookup the path and create or obtain the vnode. After a
132 * successful lookup a locked nd->nl_ncp will be returned.
134 * The result of this section should be a locked vnode.
136 * XXX with only a little work we should be able to avoid locking
137 * the vnode if FWRITE, O_CREAT, and O_TRUNC are *not* set.
139 if (fmode & O_CREAT) {
141 * CONDITIONAL CREATE FILE CASE
143 * Setting NLC_CREATE causes a negative hit to store
144 * the negative hit ncp and not return an error. Then
145 * nc_error or nc_vp may be checked to see if the ncp
146 * represents a negative hit. NLC_CREATE also requires
147 * write permission on the governing directory or EPERM
150 if ((fmode & O_EXCL) == 0 && (fmode & O_NOFOLLOW) == 0)
151 nd->nl_flags |= NLC_FOLLOW;
152 nd->nl_flags |= NLC_CREATE;
157 * NORMAL OPEN FILE CASE
167 * split case to allow us to re-resolve and retry the ncp in case
171 if (fmode & O_CREAT) {
172 if (ncp->nc_vp == NULL) {
175 vap->va_mode = cmode;
177 vap->va_vaflags |= VA_EXCLUSIVE;
178 error = VOP_NCREATE(ncp, &vp, nd->nl_cred, vap);
182 ASSERT_VOP_LOCKED(vp, "create");
183 /* locked vnode is returned */
185 if (fmode & O_EXCL) {
188 error = cache_vget(ncp, cred,
196 error = cache_vget(ncp, cred, LK_EXCLUSIVE, &vp);
202 * We have a locked vnode and ncp now. Note that the ncp will
203 * be cleaned up by the caller if nd->nl_ncp is left intact.
205 if (vp->v_type == VLNK) {
209 if (vp->v_type == VSOCK) {
213 if ((fmode & O_CREAT) == 0) {
215 if (fmode & (FWRITE | O_TRUNC)) {
216 if (vp->v_type == VDIR) {
220 error = vn_writechk(vp);
223 * Special stale handling, re-resolve the
226 if (error == ESTALE) {
229 cache_setunresolved(ncp);
230 error = cache_resolve(ncp, cred);
241 error = VOP_ACCESS(vp, mode, cred, td);
244 * Special stale handling, re-resolve the
247 if (error == ESTALE) {
250 cache_setunresolved(ncp);
251 error = cache_resolve(ncp, cred);
259 if (fmode & O_TRUNC) {
260 VOP_UNLOCK(vp, 0, td); /* XXX */
261 VOP_LEASE(vp, td, cred, LEASE_WRITE);
262 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td); /* XXX */
265 error = VOP_SETATTR(vp, vap, cred, td);
271 * Setup the fp so VOP_OPEN can override it. No descriptor has been
272 * associated with the fp yet so we own it clean. f_data will inherit
273 * our vp reference as long as we do not shift f_ops to &badfileops.
274 * f_ncp inherits nl_ncp .
277 fp->f_data = (caddr_t)vp;
278 fp->f_flag = fmode & FMASK;
279 fp->f_ops = &vnode_fileops;
280 fp->f_type = (vp->v_type == VFIFO ? DTYPE_FIFO : DTYPE_VNODE);
281 if (vp->v_type == VDIR) {
282 fp->f_ncp = nd->nl_ncp;
284 cache_unlock(fp->f_ncp);
289 * Get rid of nl_ncp. vn_open does not return it (it returns the
290 * vnode or the file pointer). Note: we can't leave nl_ncp locked
291 * through the VOP_OPEN anyway since the VOP_OPEN may block, e.g.
295 cache_put(nd->nl_ncp);
299 error = VOP_OPEN(vp, fmode, cred, fp, td);
302 * setting f_ops to &badfileops will prevent the descriptor
303 * code from trying to close and release the vnode, since
304 * the open failed we do not want to call close.
308 fp->f_ops = &badfileops;
316 * Make sure that a VM object is created for VMIO support. If this
317 * fails we have to be sure to match VOP_CLOSE's with VOP_OPEN's.
318 * Cleanup the fp so we can just vput() the vp in 'bad'.
320 if (vn_canvmio(vp) == TRUE) {
321 if ((error = vfs_object_create(vp, td)) != 0) {
324 fp->f_ops = &badfileops;
326 VOP_CLOSE(vp, fmode, td);
332 * Return the vnode. XXX needs some cleaning up. The vnode is
333 * only returned in the fp == NULL case, otherwise the vnode ref
334 * is inherited by the fp and we unconditionally unlock it.
338 nd->nl_vp_fmode = fmode;
339 if ((nd->nl_flags & NLC_LOCKVP) == 0)
340 VOP_UNLOCK(vp, 0, td);
342 VOP_UNLOCK(vp, 0, td);
352 * Check for write permissions on the specified vnode.
353 * Prototype text segments cannot be written.
361 * If there's shared text associated with
362 * the vnode, try to free it up once. If
363 * we fail, we can't allow writing.
365 if (vp->v_flag & VTEXT)
374 vn_close(struct vnode *vp, int flags, struct thread *td)
380 if ((error = vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td)) == 0) {
381 error = VOP_CLOSE(vp, flags, td);
382 VOP_UNLOCK(vp, 0, td);
390 sequential_heuristic(struct uio *uio, struct file *fp)
393 * Sequential heuristic - detect sequential operation
395 if ((uio->uio_offset == 0 && fp->f_seqcount > 0) ||
396 uio->uio_offset == fp->f_nextoff) {
397 int tmpseq = fp->f_seqcount;
399 * XXX we assume that the filesystem block size is
400 * the default. Not true, but still gives us a pretty
401 * good indicator of how sequential the read operations
404 tmpseq += (uio->uio_resid + BKVASIZE - 1) / BKVASIZE;
405 if (tmpseq > IO_SEQMAX)
407 fp->f_seqcount = tmpseq;
408 return(fp->f_seqcount << IO_SEQSHIFT);
412 * Not sequential, quick draw-down of seqcount
414 if (fp->f_seqcount > 1)
422 * Package up an I/O request on a vnode into a uio and do it.
424 * We are going to assume the caller has done the appropriate
425 * VOP_LEASE() call before calling vn_rdwr()
428 vn_rdwr(rw, vp, base, len, offset, segflg, ioflg, cred, aresid, td)
444 if ((ioflg & IO_NODELOCKED) == 0)
445 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td);
446 auio.uio_iov = &aiov;
448 aiov.iov_base = base;
450 auio.uio_resid = len;
451 auio.uio_offset = offset;
452 auio.uio_segflg = segflg;
455 if (rw == UIO_READ) {
456 error = VOP_READ(vp, &auio, ioflg, cred);
458 error = VOP_WRITE(vp, &auio, ioflg, cred);
461 *aresid = auio.uio_resid;
463 if (auio.uio_resid && error == 0)
465 if ((ioflg & IO_NODELOCKED) == 0)
466 VOP_UNLOCK(vp, 0, td);
471 * Package up an I/O request on a vnode into a uio and do it. The I/O
472 * request is split up into smaller chunks and we try to avoid saturating
473 * the buffer cache while potentially holding a vnode locked, so we
474 * check bwillwrite() before calling vn_rdwr(). We also call uio_yield()
475 * to give other processes a chance to lock the vnode (either other processes
476 * core'ing the same binary, or unrelated processes scanning the directory).
479 vn_rdwr_inchunks(rw, vp, base, len, offset, segflg, ioflg, cred, aresid, td)
497 * Force `offset' to a multiple of MAXBSIZE except possibly
498 * for the first chunk, so that filesystems only need to
499 * write full blocks except possibly for the first and last
502 chunk = MAXBSIZE - (uoff_t)offset % MAXBSIZE;
506 if (rw != UIO_READ && vp->v_type == VREG)
508 error = vn_rdwr(rw, vp, base, chunk, offset, segflg,
509 ioflg, cred, aresid, td);
510 len -= chunk; /* aresid calc already includes length */
523 * File table vnode read routine.
526 vn_read(fp, uio, cred, flags, td)
536 KASSERT(uio->uio_td == td, ("uio_td %p is not td %p", uio->uio_td, td));
537 vp = (struct vnode *)fp->f_data;
539 if (fp->f_flag & FNONBLOCK)
541 if (fp->f_flag & O_DIRECT)
543 VOP_LEASE(vp, td, cred, LEASE_READ);
544 vn_lock(vp, LK_SHARED | LK_NOPAUSE | LK_RETRY, td);
545 if ((flags & FOF_OFFSET) == 0)
546 uio->uio_offset = fp->f_offset;
548 ioflag |= sequential_heuristic(uio, fp);
550 error = VOP_READ(vp, uio, ioflag, cred);
551 if ((flags & FOF_OFFSET) == 0)
552 fp->f_offset = uio->uio_offset;
553 fp->f_nextoff = uio->uio_offset;
554 VOP_UNLOCK(vp, 0, td);
559 * Device-optimized file table vnode read routine.
561 * This bypasses the VOP table and talks directly to the device. Most
562 * filesystems just route to specfs and can make this optimization.
565 svn_read(fp, uio, cred, flags, td)
577 KASSERT(uio->uio_td == td, ("uio_td %p is not td %p", uio->uio_td, td));
579 vp = (struct vnode *)fp->f_data;
580 if (vp == NULL || vp->v_type == VBAD)
583 if ((dev = vp->v_rdev) == NULL)
587 if (uio->uio_resid == 0)
589 if ((flags & FOF_OFFSET) == 0)
590 uio->uio_offset = fp->f_offset;
593 if (fp->f_flag & FNONBLOCK)
595 if (fp->f_flag & O_DIRECT)
597 ioflag |= sequential_heuristic(uio, fp);
599 error = dev_dread(dev, uio, ioflag);
602 if ((flags & FOF_OFFSET) == 0)
603 fp->f_offset = uio->uio_offset;
604 fp->f_nextoff = uio->uio_offset;
609 * File table vnode write routine.
612 vn_write(fp, uio, cred, flags, td)
622 KASSERT(uio->uio_td == td, ("uio_procp %p is not p %p",
624 vp = (struct vnode *)fp->f_data;
625 if (vp->v_type == VREG)
627 vp = (struct vnode *)fp->f_data; /* XXX needed? */
629 if (vp->v_type == VREG && (fp->f_flag & O_APPEND))
631 if (fp->f_flag & FNONBLOCK)
633 if (fp->f_flag & O_DIRECT)
635 if ((fp->f_flag & O_FSYNC) ||
636 (vp->v_mount && (vp->v_mount->mnt_flag & MNT_SYNCHRONOUS)))
638 VOP_LEASE(vp, td, cred, LEASE_WRITE);
639 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td);
640 if ((flags & FOF_OFFSET) == 0)
641 uio->uio_offset = fp->f_offset;
642 ioflag |= sequential_heuristic(uio, fp);
643 error = VOP_WRITE(vp, uio, ioflag, cred);
644 if ((flags & FOF_OFFSET) == 0)
645 fp->f_offset = uio->uio_offset;
646 fp->f_nextoff = uio->uio_offset;
647 VOP_UNLOCK(vp, 0, td);
652 * Device-optimized file table vnode write routine.
654 * This bypasses the VOP table and talks directly to the device. Most
655 * filesystems just route to specfs and can make this optimization.
658 svn_write(fp, uio, cred, flags, td)
670 KASSERT(uio->uio_td == td, ("uio_procp %p is not p %p",
673 vp = (struct vnode *)fp->f_data;
674 if (vp == NULL || vp->v_type == VBAD)
676 if (vp->v_type == VREG)
678 vp = (struct vnode *)fp->f_data; /* XXX needed? */
680 if ((dev = vp->v_rdev) == NULL)
684 if ((flags & FOF_OFFSET) == 0)
685 uio->uio_offset = fp->f_offset;
688 if (vp->v_type == VREG && (fp->f_flag & O_APPEND))
690 if (fp->f_flag & FNONBLOCK)
692 if (fp->f_flag & O_DIRECT)
694 if ((fp->f_flag & O_FSYNC) ||
695 (vp->v_mount && (vp->v_mount->mnt_flag & MNT_SYNCHRONOUS)))
697 ioflag |= sequential_heuristic(uio, fp);
699 error = dev_dwrite(dev, uio, ioflag);
702 if ((flags & FOF_OFFSET) == 0)
703 fp->f_offset = uio->uio_offset;
704 fp->f_nextoff = uio->uio_offset;
710 * File table vnode stat routine.
713 vn_statfile(struct file *fp, struct stat *sb, struct thread *td)
715 struct vnode *vp = (struct vnode *)fp->f_data;
717 return vn_stat(vp, sb, td);
721 vn_stat(struct vnode *vp, struct stat *sb, struct thread *td)
729 error = VOP_GETATTR(vp, vap, td);
734 * Zero the spare stat fields
737 sb->st_qspare[0] = 0;
738 sb->st_qspare[1] = 0;
741 * Copy from vattr table
743 if (vap->va_fsid != VNOVAL)
744 sb->st_dev = vap->va_fsid;
746 sb->st_dev = vp->v_mount->mnt_stat.f_fsid.val[0];
747 sb->st_ino = vap->va_fileid;
749 switch (vap->va_type) {
764 /* This is a cosmetic change, symlinks do not have a mode. */
765 if (vp->v_mount->mnt_flag & MNT_NOSYMFOLLOW)
766 sb->st_mode &= ~ACCESSPERMS; /* 0000 */
768 sb->st_mode |= ACCESSPERMS; /* 0777 */
780 sb->st_nlink = vap->va_nlink;
781 sb->st_uid = vap->va_uid;
782 sb->st_gid = vap->va_gid;
783 sb->st_rdev = vap->va_rdev;
784 sb->st_size = vap->va_size;
785 sb->st_atimespec = vap->va_atime;
786 sb->st_mtimespec = vap->va_mtime;
787 sb->st_ctimespec = vap->va_ctime;
790 * According to www.opengroup.org, the meaning of st_blksize is
791 * "a filesystem-specific preferred I/O block size for this
792 * object. In some filesystem types, this may vary from file
794 * Default to PAGE_SIZE after much discussion.
797 if (vap->va_type == VREG) {
798 sb->st_blksize = vap->va_blocksize;
799 } else if (vn_isdisk(vp, NULL)) {
801 * XXX this is broken. If the device is not yet open (aka
802 * stat() call, aka v_rdev == NULL), how are we supposed
803 * to get a valid block size out of it?
807 if ((dev = vp->v_rdev) == NULL)
808 dev = udev2dev(vp->v_udev, vp->v_type == VBLK);
809 sb->st_blksize = dev->si_bsize_best;
810 if (sb->st_blksize < dev->si_bsize_phys)
811 sb->st_blksize = dev->si_bsize_phys;
812 if (sb->st_blksize < BLKDEV_IOSIZE)
813 sb->st_blksize = BLKDEV_IOSIZE;
815 sb->st_blksize = PAGE_SIZE;
818 sb->st_flags = vap->va_flags;
822 sb->st_gen = vap->va_gen;
824 #if (S_BLKSIZE == 512)
825 /* Optimize this case */
826 sb->st_blocks = vap->va_bytes >> 9;
828 sb->st_blocks = vap->va_bytes / S_BLKSIZE;
834 * File table vnode ioctl routine.
837 vn_ioctl(struct file *fp, u_long com, caddr_t data, struct thread *td)
839 struct vnode *vp = ((struct vnode *)fp->f_data);
845 KKASSERT(td->td_proc != NULL);
846 ucred = td->td_proc->p_ucred;
848 switch (vp->v_type) {
851 if (com == FIONREAD) {
852 error = VOP_GETATTR(vp, &vattr, td);
855 *(int *)data = vattr.va_size - fp->f_offset;
858 if (com == FIONBIO || com == FIOASYNC) /* XXX */
859 return (0); /* XXX */
868 if (com == FIODTYPE) {
869 if (vp->v_type != VCHR && vp->v_type != VBLK)
871 *(int *)data = dev_dflags(vp->v_rdev) & D_TYPEMASK;
874 error = VOP_IOCTL(vp, com, data, fp->f_flag, ucred, td);
875 if (error == 0 && com == TIOCSCTTY) {
876 struct session *sess = td->td_proc->p_session;
878 /* Do nothing if reassigning same control tty */
879 if (sess->s_ttyvp == vp)
882 /* Get rid of reference to old control tty */
894 * File table vnode poll routine.
897 vn_poll(struct file *fp, int events, struct ucred *cred, struct thread *td)
899 return (VOP_POLL(((struct vnode *)fp->f_data), events, cred, td));
903 * Check that the vnode is still valid, and if so
904 * acquire requested lock.
908 vn_lock(struct vnode *vp, int flags, struct thread *td)
910 debug_vn_lock(struct vnode *vp, int flags, struct thread *td,
911 const char *filename, int line)
918 vp->filename = filename;
921 error = VOP_LOCK(vp, flags | LK_NOPAUSE, td);
924 } while (flags & LK_RETRY);
927 * Because we (had better!) have a ref on the vnode, once it
928 * goes to VRECLAIMED state it will not be recycled until all
929 * refs go away. So we can just check the flag.
931 if (error == 0 && (vp->v_flag & VRECLAIMED)) {
932 VOP_UNLOCK(vp, 0, td);
939 * File table vnode close routine.
942 vn_closefile(struct file *fp, struct thread *td)
946 fp->f_ops = &badfileops;
947 err = vn_close(((struct vnode *)fp->f_data), fp->f_flag, td);
952 vn_kqfilter(struct file *fp, struct knote *kn)
955 return (VOP_KQFILTER(((struct vnode *)fp->f_data), kn));