2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * @(#)vnode.h 8.7 (Berkeley) 2/4/94
38 #include <sys/bufobj.h>
39 #include <sys/queue.h>
41 #include <sys/lockmgr.h>
42 #include <sys/mutex.h>
43 #include <sys/rangelock.h>
44 #include <sys/selinfo.h>
50 * The vnode is the focus of all file activity in UNIX. There is a
51 * unique vnode allocated for each active file, each current directory,
52 * each mounted-on file, text file, and the root.
56 * Vnode types. VNON means no type.
58 enum vtype { VNON, VREG, VDIR, VBLK, VCHR, VLNK, VSOCK, VFIFO, VBAD,
61 enum vgetstate { VGET_HOLDCNT, VGET_USECOUNT };
63 * Each underlying filesystem allocates its own private area and hangs
64 * it from v_data. If non-null, this area is freed in getnewvnode().
70 struct mtx vpi_lock; /* lock to protect below */
71 struct selinfo vpi_selinfo; /* identity of poller(s) */
72 short vpi_events; /* what they are looking for */
73 short vpi_revents; /* what has happened */
77 * Reading or writing any of these items requires holding the appropriate lock.
82 * l - mp mnt_listmtx or freelist mutex
83 * I - updated with atomics, 0->1 and 1->0 transitions with interlock held
84 * m - mount point interlock
86 * u - Only a reference to the vnode is needed to read.
89 * Vnodes may be found on many lists. The general way to deal with operating
90 * on a vnode that is on a list is:
91 * 1) Lock the list and find the vnode.
92 * 2) Lock interlock so that the vnode does not go away.
93 * 3) Unlock the list to avoid lock order reversals.
94 * 4) vget with LK_INTERLOCK and check for ENOENT, or
95 * 5) Check for DOOMED if the vnode lock is not required.
96 * 6) Perform your operation, then vput().
99 #if defined(_KERNEL) || defined(_KVM_VNODE)
103 * Fields which define the identity of the vnode. These fields are
104 * owned by the filesystem (XXX: and vgone() ?)
106 const char *v_tag; /* u type of underlying data */
107 struct vop_vector *v_op; /* u vnode operations vector */
108 void *v_data; /* u private data for fs */
111 * Filesystem instance stuff
113 struct mount *v_mount; /* u ptr to vfs we are in */
114 TAILQ_ENTRY(vnode) v_nmntvnodes; /* m vnodes for mount point */
117 * Type specific fields, only one applies to any given vnode.
120 struct mount *v_mountedhere; /* v ptr to mountpoint (VDIR) */
121 struct unpcb *v_unpcb; /* v unix domain net (VSOCK) */
122 struct cdev *v_rdev; /* v device (VCHR, VBLK) */
123 struct fifoinfo *v_fifoinfo; /* v fifo (VFIFO) */
127 * vfs_hash: (mount + inode) -> vnode hash. The hash value
128 * itself is grouped with other int fields, to avoid padding.
130 LIST_ENTRY(vnode) v_hashlist;
133 * VFS_namecache stuff
135 LIST_HEAD(, namecache) v_cache_src; /* c Cache entries from us */
136 TAILQ_HEAD(, namecache) v_cache_dst; /* c Cache entries to us */
137 struct namecache *v_cache_dd; /* c Cache entry for .. vnode */
142 struct lock v_lock; /* u (if fs don't have one) */
143 struct mtx v_interlock; /* lock for "i" things */
144 struct lock *v_vnlock; /* u pointer to vnode lock */
147 * The machinery of being a vnode
149 TAILQ_ENTRY(vnode) v_actfreelist; /* l vnode active/free lists */
150 struct bufobj v_bufobj; /* * Buffer cache object */
153 * Hooks for various subsystems and features.
155 struct vpollinfo *v_pollinfo; /* i Poll events, p for *v_pi */
156 struct label *v_label; /* MAC label for vnode */
157 struct lockf *v_lockf; /* Byte-level advisory lock list */
158 struct rangelock v_rl; /* Byte-range lock */
163 daddr_t v_cstart; /* v start block of cluster */
164 daddr_t v_lasta; /* v last allocation */
165 daddr_t v_lastw; /* v last write */
166 int v_clen; /* v length of cur. cluster */
168 u_int v_holdcnt; /* I prevents recycling. */
169 u_int v_usecount; /* I ref count of users */
170 u_int v_iflag; /* i vnode flags (see below) */
171 u_int v_vflag; /* v vnode flags */
172 u_int v_mflag; /* l mnt-specific vnode flags */
173 int v_writecount; /* I ref count of writers or
174 (negative) text users */
176 enum vtype v_type; /* u vnode type */
179 #endif /* defined(_KERNEL) || defined(_KVM_VNODE) */
181 #define bo2vnode(bo) __containerof((bo), struct vnode, v_bufobj)
183 /* XXX: These are temporary to avoid a source sweep at this time */
184 #define v_object v_bufobj.bo_object
187 * Userland version of struct vnode, for sysctl.
190 size_t xv_size; /* sizeof(struct xvnode) */
191 void *xv_vnode; /* address of real vnode */
192 u_long xv_flag; /* vnode vflags */
193 int xv_usecount; /* reference count of users */
194 int xv_writecount; /* reference count of writers */
195 int xv_holdcnt; /* page & buffer references */
196 u_long xv_id; /* capability identifier */
197 void *xv_mount; /* address of parent mount */
198 long xv_numoutput; /* num of writes in progress */
199 enum vtype xv_type; /* vnode type */
201 void *xvu_socket; /* unpcb, if VSOCK */
202 void *xvu_fifo; /* fifo, if VFIFO */
203 dev_t xvu_rdev; /* maj/min, if VBLK/VCHR */
205 dev_t xvu_dev; /* device, if VDIR/VREG/VLNK */
206 ino_t xvu_ino; /* id, if VDIR/VREG/VLNK */
210 #define xv_socket xv_un.xvu_socket
211 #define xv_fifo xv_un.xvu_fifo
212 #define xv_rdev xv_un.xvu_rdev
213 #define xv_dev xv_un.xv_uns.xvu_dev
214 #define xv_ino xv_un.xv_uns.xvu_ino
216 /* We don't need to lock the knlist */
217 #define VN_KNLIST_EMPTY(vp) ((vp)->v_pollinfo == NULL || \
218 KNLIST_EMPTY(&(vp)->v_pollinfo->vpi_selinfo.si_note))
220 #define VN_KNOTE(vp, b, a) \
222 if (!VN_KNLIST_EMPTY(vp)) \
223 KNOTE(&vp->v_pollinfo->vpi_selinfo.si_note, (b), \
224 (a) | KNF_NOKQLOCK); \
226 #define VN_KNOTE_LOCKED(vp, b) VN_KNOTE(vp, b, KNF_LISTLOCKED)
227 #define VN_KNOTE_UNLOCKED(vp, b) VN_KNOTE(vp, b, 0)
231 * VI flags are protected by interlock and live in v_iflag
232 * VV flags are protected by the vnode lock and live in v_vflag
234 * VI_DOOMED is doubly protected by the interlock and vnode lock. Both
235 * are required for writing but the status may be checked with either.
237 #define VI_TEXT_REF 0x0001 /* Text ref grabbed use ref */
238 #define VI_MOUNT 0x0020 /* Mount in progress */
239 #define VI_DOOMED 0x0080 /* This vnode is being recycled */
240 #define VI_FREE 0x0100 /* This vnode is on the freelist */
241 #define VI_ACTIVE 0x0200 /* This vnode is on the active list */
242 #define VI_DOINGINACT 0x0800 /* VOP_INACTIVE is in progress */
243 #define VI_OWEINACT 0x1000 /* Need to call inactive */
245 #define VV_ROOT 0x0001 /* root of its filesystem */
246 #define VV_ISTTY 0x0002 /* vnode represents a tty */
247 #define VV_NOSYNC 0x0004 /* unlinked, stop syncing */
248 #define VV_ETERNALDEV 0x0008 /* device that is never destroyed */
249 #define VV_CACHEDLABEL 0x0010 /* Vnode has valid cached MAC label */
250 #define VV_COPYONWRITE 0x0040 /* vnode is doing copy-on-write */
251 #define VV_SYSTEM 0x0080 /* vnode being used by kernel */
252 #define VV_PROCDEP 0x0100 /* vnode is process dependent */
253 #define VV_NOKNOTE 0x0200 /* don't activate knotes on this vnode */
254 #define VV_DELETED 0x0400 /* should be removed */
255 #define VV_MD 0x0800 /* vnode backs the md device */
256 #define VV_FORCEINSMQ 0x1000 /* force the insmntque to succeed */
257 #define VV_READLINK 0x2000 /* fdescfs linux vnode */
259 #define VMP_TMPMNTFREELIST 0x0001 /* Vnode is on mnt's tmp free list */
262 * Vnode attributes. A field value of VNOVAL represents a field whose value
263 * is unavailable (getattr) or which is not to be changed (setattr).
266 enum vtype va_type; /* vnode type (for create) */
267 u_short va_mode; /* files access mode and type */
269 uid_t va_uid; /* owner user id */
270 gid_t va_gid; /* owner group id */
271 nlink_t va_nlink; /* number of references to file */
272 dev_t va_fsid; /* filesystem id */
273 ino_t va_fileid; /* file id */
274 u_quad_t va_size; /* file size in bytes */
275 long va_blocksize; /* blocksize preferred for i/o */
276 struct timespec va_atime; /* time of last access */
277 struct timespec va_mtime; /* time of last modification */
278 struct timespec va_ctime; /* time file changed */
279 struct timespec va_birthtime; /* time file created */
280 u_long va_gen; /* generation number of file */
281 u_long va_flags; /* flags defined for file */
282 dev_t va_rdev; /* device the special file represents */
283 u_quad_t va_bytes; /* bytes of disk space held by file */
284 u_quad_t va_filerev; /* file modification number */
285 u_int va_vaflags; /* operations flags, see below */
286 long va_spare; /* remain quad aligned */
290 * Flags for va_vaflags.
292 #define VA_UTIMES_NULL 0x01 /* utimes argument was NULL */
293 #define VA_EXCLUSIVE 0x02 /* exclusive create request */
294 #define VA_SYNC 0x04 /* O_SYNC truncation */
297 * Flags for ioflag. (high 16 bits used to ask for read-ahead and
298 * help with write clustering)
299 * NB: IO_NDELAY and IO_DIRECT are linked to fcntl.h
301 #define IO_UNIT 0x0001 /* do I/O as atomic unit */
302 #define IO_APPEND 0x0002 /* append write to end */
303 #define IO_NDELAY 0x0004 /* FNDELAY flag set in file table */
304 #define IO_NODELOCKED 0x0008 /* underlying node already locked */
305 #define IO_ASYNC 0x0010 /* bawrite rather then bdwrite */
306 #define IO_VMIO 0x0020 /* data already in VMIO space */
307 #define IO_INVAL 0x0040 /* invalidate after I/O */
308 #define IO_SYNC 0x0080 /* do I/O synchronously */
309 #define IO_DIRECT 0x0100 /* attempt to bypass buffer cache */
310 #define IO_NOREUSE 0x0200 /* VMIO data won't be reused */
311 #define IO_EXT 0x0400 /* operate on external attributes */
312 #define IO_NORMAL 0x0800 /* operate on regular data */
313 #define IO_NOMACCHECK 0x1000 /* MAC checks unnecessary */
314 #define IO_BUFLOCKED 0x2000 /* ffs flag; indir buf is locked */
315 #define IO_RANGELOCKED 0x4000 /* range locked */
317 #define IO_SEQMAX 0x7F /* seq heuristic max value */
318 #define IO_SEQSHIFT 16 /* seq heuristic in upper 16 bits */
321 * Flags for accmode_t.
323 #define VEXEC 000000000100 /* execute/search permission */
324 #define VWRITE 000000000200 /* write permission */
325 #define VREAD 000000000400 /* read permission */
326 #define VADMIN 000000010000 /* being the file owner */
327 #define VAPPEND 000000040000 /* permission to write/append */
329 * VEXPLICIT_DENY makes VOP_ACCESSX(9) return EPERM or EACCES only
330 * if permission was denied explicitly, by a "deny" rule in NFSv4 ACL,
331 * and 0 otherwise. This never happens with ordinary unix access rights
332 * or POSIX.1e ACLs. Obviously, VEXPLICIT_DENY must be OR-ed with
333 * some other V* constant.
335 #define VEXPLICIT_DENY 000000100000
336 #define VREAD_NAMED_ATTRS 000000200000 /* not used */
337 #define VWRITE_NAMED_ATTRS 000000400000 /* not used */
338 #define VDELETE_CHILD 000001000000
339 #define VREAD_ATTRIBUTES 000002000000 /* permission to stat(2) */
340 #define VWRITE_ATTRIBUTES 000004000000 /* change {m,c,a}time */
341 #define VDELETE 000010000000
342 #define VREAD_ACL 000020000000 /* read ACL and file mode */
343 #define VWRITE_ACL 000040000000 /* change ACL and/or file mode */
344 #define VWRITE_OWNER 000100000000 /* change file owner */
345 #define VSYNCHRONIZE 000200000000 /* not used */
346 #define VCREAT 000400000000 /* creating new file */
347 #define VVERIFY 001000000000 /* verification required */
350 * Permissions that were traditionally granted only to the file owner.
352 #define VADMIN_PERMS (VADMIN | VWRITE_ATTRIBUTES | VWRITE_ACL | \
356 * Permissions that were traditionally granted to everyone.
358 #define VSTAT_PERMS (VREAD_ATTRIBUTES | VREAD_ACL)
361 * Permissions that allow to change the state of the file in any way.
363 #define VMODIFY_PERMS (VWRITE | VAPPEND | VADMIN_PERMS | VDELETE_CHILD | \
367 * Token indicating no attribute value yet assigned.
372 * LK_TIMELOCK timeout for vnode locks (used mainly by the pageout daemon)
374 #define VLKTIMEOUT (hz / 20 + 1)
378 #ifdef MALLOC_DECLARE
379 MALLOC_DECLARE(M_VNODE);
382 extern u_int ncsizefactor;
385 * Convert between vnode types and inode formats (since POSIX.1
386 * defines mode word of stat structure in terms of inode formats).
388 extern enum vtype iftovt_tab[];
389 extern int vttoif_tab[];
390 #define IFTOVT(mode) (iftovt_tab[((mode) & S_IFMT) >> 12])
391 #define VTTOIF(indx) (vttoif_tab[(int)(indx)])
392 #define MAKEIMODE(indx, mode) (int)(VTTOIF(indx) | (mode))
395 * Flags to various vnode functions.
397 #define SKIPSYSTEM 0x0001 /* vflush: skip vnodes marked VSYSTEM */
398 #define FORCECLOSE 0x0002 /* vflush: force file closure */
399 #define WRITECLOSE 0x0004 /* vflush: only close writable files */
400 #define EARLYFLUSH 0x0008 /* vflush: early call for ffs_flushfiles */
401 #define V_SAVE 0x0001 /* vinvalbuf: sync file first */
402 #define V_ALT 0x0002 /* vinvalbuf: invalidate only alternate bufs */
403 #define V_NORMAL 0x0004 /* vinvalbuf: invalidate only regular bufs */
404 #define V_CLEANONLY 0x0008 /* vinvalbuf: invalidate only clean bufs */
405 #define V_VMIO 0x0010 /* vinvalbuf: called during pageout */
406 #define V_ALLOWCLEAN 0x0020 /* vinvalbuf: allow clean buffers after flush */
407 #define REVOKEALL 0x0001 /* vop_revoke: revoke all aliases */
408 #define V_WAIT 0x0001 /* vn_start_write: sleep for suspend */
409 #define V_NOWAIT 0x0002 /* vn_start_write: don't sleep for suspend */
410 #define V_XSLEEP 0x0004 /* vn_start_write: just return after sleep */
411 #define V_MNTREF 0x0010 /* vn_start_write: mp is already ref-ed */
413 #define VR_START_WRITE 0x0001 /* vfs_write_resume: start write atomically */
414 #define VR_NO_SUSPCLR 0x0002 /* vfs_write_resume: do not clear suspension */
416 #define VS_SKIP_UNMOUNT 0x0001 /* vfs_write_suspend: fail if the
417 filesystem is being unmounted */
419 #define VREF(vp) vref(vp)
422 #define VATTR_NULL(vap) vattr_null(vap)
424 #define VATTR_NULL(vap) (*(vap) = va_null) /* initialize a vattr */
425 #endif /* DIAGNOSTIC */
427 #define NULLVP ((struct vnode *)NULL)
432 extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
433 extern struct mount *rootdevmp; /* "/dev" mount */
434 extern int desiredvnodes; /* number of vnodes desired */
435 extern struct uma_zone *namei_zone;
436 extern struct vattr va_null; /* predefined null vattr structure */
438 #define VI_LOCK(vp) mtx_lock(&(vp)->v_interlock)
439 #define VI_LOCK_FLAGS(vp, flags) mtx_lock_flags(&(vp)->v_interlock, (flags))
440 #define VI_TRYLOCK(vp) mtx_trylock(&(vp)->v_interlock)
441 #define VI_UNLOCK(vp) mtx_unlock(&(vp)->v_interlock)
442 #define VI_MTX(vp) (&(vp)->v_interlock)
444 #define VN_LOCK_AREC(vp) lockallowrecurse((vp)->v_vnlock)
445 #define VN_LOCK_ASHARE(vp) lockallowshare((vp)->v_vnlock)
446 #define VN_LOCK_DSHARE(vp) lockdisableshare((vp)->v_vnlock)
451 * Mods for extensibility.
455 * Flags for vdesc_flags:
457 #define VDESC_MAX_VPS 16
458 /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
459 #define VDESC_VP0_WILLRELE 0x0001
460 #define VDESC_VP1_WILLRELE 0x0002
461 #define VDESC_VP2_WILLRELE 0x0004
462 #define VDESC_VP3_WILLRELE 0x0008
463 #define VDESC_NOMAP_VPP 0x0100
464 #define VDESC_VPP_WILLRELE 0x0200
467 * A generic structure.
468 * This can be used by bypass routines to identify generic arguments.
470 struct vop_generic_args {
471 struct vnodeop_desc *a_desc;
472 /* other random data follows, presumably */
475 typedef int vop_bypass_t(struct vop_generic_args *);
478 * VDESC_NO_OFFSET is used to identify the end of the offset list
479 * and in places where no such field exists.
481 #define VDESC_NO_OFFSET -1
484 * This structure describes the vnode operation taking place.
486 struct vnodeop_desc {
487 char *vdesc_name; /* a readable name for debugging */
488 int vdesc_flags; /* VDESC_* flags */
489 int vdesc_vop_offset;
490 vop_bypass_t *vdesc_call; /* Function to call */
493 * These ops are used by bypass routines to map and locate arguments.
494 * Creds and procs are not needed in bypass routines, but sometimes
495 * they are useful to (for example) transport layers.
496 * Nameidata is useful because it has a cred in it.
498 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */
499 int vdesc_vpp_offset; /* return vpp location */
500 int vdesc_cred_offset; /* cred location, if any */
501 int vdesc_thread_offset; /* thread location, if any */
502 int vdesc_componentname_offset; /* if any */
507 * A list of all the operation descs.
509 extern struct vnodeop_desc *vnodeop_descs[];
511 #define VOPARG_OFFSETOF(s_type, field) __offsetof(s_type, field)
512 #define VOPARG_OFFSETTO(s_type, s_offset, struct_p) \
513 ((s_type)(((char*)(struct_p)) + (s_offset)))
516 #ifdef DEBUG_VFS_LOCKS
518 * Support code to aid in debugging VFS locking problems. Not totally
519 * reliable since if the thread sleeps between changing the lock
520 * state and checking it with the assert, some other thread could
521 * change the state. They are good enough for debugging a single
522 * filesystem using a single-threaded test. Note that the unreliability is
523 * limited to false negatives; efforts were made to ensure that false
524 * positives cannot occur.
526 void assert_vi_locked(struct vnode *vp, const char *str);
527 void assert_vi_unlocked(struct vnode *vp, const char *str);
528 void assert_vop_elocked(struct vnode *vp, const char *str);
529 void assert_vop_locked(struct vnode *vp, const char *str);
530 void assert_vop_unlocked(struct vnode *vp, const char *str);
532 #define ASSERT_VI_LOCKED(vp, str) assert_vi_locked((vp), (str))
533 #define ASSERT_VI_UNLOCKED(vp, str) assert_vi_unlocked((vp), (str))
534 #define ASSERT_VOP_ELOCKED(vp, str) assert_vop_elocked((vp), (str))
535 #define ASSERT_VOP_LOCKED(vp, str) assert_vop_locked((vp), (str))
536 #define ASSERT_VOP_UNLOCKED(vp, str) assert_vop_unlocked((vp), (str))
538 #else /* !DEBUG_VFS_LOCKS */
540 #define ASSERT_VI_LOCKED(vp, str) ((void)0)
541 #define ASSERT_VI_UNLOCKED(vp, str) ((void)0)
542 #define ASSERT_VOP_ELOCKED(vp, str) ((void)0)
543 #define ASSERT_VOP_LOCKED(vp, str) ((void)0)
544 #define ASSERT_VOP_UNLOCKED(vp, str) ((void)0)
545 #endif /* DEBUG_VFS_LOCKS */
549 * This call works for vnodes in the kernel.
551 #define VCALL(c) ((c)->a_desc->vdesc_call(c))
553 #define DOINGASYNC(vp) \
554 (((vp)->v_mount->mnt_kern_flag & MNTK_ASYNC) != 0 && \
555 ((curthread->td_pflags & TDP_SYNCIO) == 0))
558 * VMIO support inline
561 extern int vmiodirenable;
564 vn_canvmio(struct vnode *vp)
566 if (vp && (vp->v_type == VREG || (vmiodirenable && vp->v_type == VDIR)))
572 * Finally, include the default set of vnode operations.
574 typedef void vop_getpages_iodone_t(void *, vm_page_t *, int, int);
575 #include "vnode_if.h"
578 #define VN_OPEN_NOAUDIT 0x00000001
579 #define VN_OPEN_NOCAPCHECK 0x00000002
580 #define VN_OPEN_NAMECACHE 0x00000004
583 * Public vnode manipulation functions.
585 struct componentname;
590 struct freebsd11_stat;
601 typedef int (*vn_get_ino_t)(struct mount *, void *, int, struct vnode **);
603 int bnoreuselist(struct bufv *bufv, struct bufobj *bo, daddr_t startn,
605 /* cache_* may belong in namei.h. */
606 void cache_changesize(int newhashsize);
607 #define cache_enter(dvp, vp, cnp) \
608 cache_enter_time(dvp, vp, cnp, NULL, NULL)
609 void cache_enter_time(struct vnode *dvp, struct vnode *vp,
610 struct componentname *cnp, struct timespec *tsp,
611 struct timespec *dtsp);
612 int cache_lookup(struct vnode *dvp, struct vnode **vpp,
613 struct componentname *cnp, struct timespec *tsp, int *ticksp);
614 void cache_purge(struct vnode *vp);
615 void cache_purge_negative(struct vnode *vp);
616 void cache_purgevfs(struct mount *mp, bool force);
617 int change_dir(struct vnode *vp, struct thread *td);
618 void cvtstat(struct stat *st, struct ostat *ost);
619 void freebsd11_cvtnstat(struct stat *sb, struct nstat *nsb);
620 int freebsd11_cvtstat(struct stat *st, struct freebsd11_stat *ost);
621 int getnewvnode(const char *tag, struct mount *mp, struct vop_vector *vops,
623 void getnewvnode_reserve(u_int count);
624 void getnewvnode_drop_reserve(void);
625 int insmntque1(struct vnode *vp, struct mount *mp,
626 void (*dtr)(struct vnode *, void *), void *dtr_arg);
627 int insmntque(struct vnode *vp, struct mount *mp);
628 u_quad_t init_va_filerev(void);
629 int speedup_syncer(void);
630 int vn_vptocnp(struct vnode **vp, struct ucred *cred, char *buf,
632 int vn_fullpath(struct thread *td, struct vnode *vn,
633 char **retbuf, char **freebuf);
634 int vn_fullpath_global(struct thread *td, struct vnode *vn,
635 char **retbuf, char **freebuf);
637 vn_dir_dd_ino(struct vnode *vp);
638 int vn_commname(struct vnode *vn, char *buf, u_int buflen);
639 int vn_path_to_global_path(struct thread *td, struct vnode *vp,
640 char *path, u_int pathlen);
641 int vaccess(enum vtype type, mode_t file_mode, uid_t file_uid,
642 gid_t file_gid, accmode_t accmode, struct ucred *cred,
644 int vaccess_acl_nfs4(enum vtype type, uid_t file_uid, gid_t file_gid,
645 struct acl *aclp, accmode_t accmode, struct ucred *cred,
647 int vaccess_acl_posix1e(enum vtype type, uid_t file_uid,
648 gid_t file_gid, struct acl *acl, accmode_t accmode,
649 struct ucred *cred, int *privused);
650 void vattr_null(struct vattr *vap);
651 int vcount(struct vnode *vp);
652 #define vdrop(vp) _vdrop((vp), 0)
653 #define vdropl(vp) _vdrop((vp), 1)
654 void _vdrop(struct vnode *, bool);
655 int vflush(struct mount *mp, int rootrefs, int flags, struct thread *td);
656 int vget(struct vnode *vp, int flags, struct thread *td);
657 enum vgetstate vget_prep(struct vnode *vp);
658 int vget_finish(struct vnode *vp, int flags, enum vgetstate vs);
659 void vgone(struct vnode *vp);
660 #define vhold(vp) _vhold((vp), 0)
661 #define vholdl(vp) _vhold((vp), 1)
662 void _vhold(struct vnode *, bool);
663 void vholdnz(struct vnode *);
664 void vinactive(struct vnode *, struct thread *);
665 int vinvalbuf(struct vnode *vp, int save, int slpflag, int slptimeo);
666 int vtruncbuf(struct vnode *vp, off_t length, int blksize);
667 void v_inval_buf_range(struct vnode *vp, daddr_t startlbn, daddr_t endlbn,
669 void vunref(struct vnode *);
670 void vn_printf(struct vnode *vp, const char *fmt, ...) __printflike(2,3);
671 int vrecycle(struct vnode *vp);
672 int vrecyclel(struct vnode *vp);
673 int vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off,
675 int vn_close(struct vnode *vp,
676 int flags, struct ucred *file_cred, struct thread *td);
677 int vn_copy_file_range(struct vnode *invp, off_t *inoffp,
678 struct vnode *outvp, off_t *outoffp, size_t *lenp,
679 unsigned int flags, struct ucred *incred, struct ucred *outcred,
680 struct thread *fsize_td);
681 void vn_finished_write(struct mount *mp);
682 void vn_finished_secondary_write(struct mount *mp);
683 int vn_fsync_buf(struct vnode *vp, int waitfor);
684 int vn_generic_copy_file_range(struct vnode *invp, off_t *inoffp,
685 struct vnode *outvp, off_t *outoffp, size_t *lenp,
686 unsigned int flags, struct ucred *incred, struct ucred *outcred,
687 struct thread *fsize_td);
688 int vn_need_pageq_flush(struct vnode *vp);
689 int vn_isdisk(struct vnode *vp, int *errp);
690 int _vn_lock(struct vnode *vp, int flags, char *file, int line);
691 #define vn_lock(vp, flags) _vn_lock(vp, flags, __FILE__, __LINE__)
692 int vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp);
693 int vn_open_cred(struct nameidata *ndp, int *flagp, int cmode,
694 u_int vn_open_flags, struct ucred *cred, struct file *fp);
695 int vn_open_vnode(struct vnode *vp, int fmode, struct ucred *cred,
696 struct thread *td, struct file *fp);
697 void vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end);
698 int vn_pollrecord(struct vnode *vp, struct thread *p, int events);
699 int vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base,
700 int len, off_t offset, enum uio_seg segflg, int ioflg,
701 struct ucred *active_cred, struct ucred *file_cred, ssize_t *aresid,
703 int vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base,
704 size_t len, off_t offset, enum uio_seg segflg, int ioflg,
705 struct ucred *active_cred, struct ucred *file_cred, size_t *aresid,
707 int vn_rlimit_fsize(const struct vnode *vn, const struct uio *uio,
709 int vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
710 struct ucred *file_cred, struct thread *td);
711 int vn_start_write(struct vnode *vp, struct mount **mpp, int flags);
712 int vn_start_secondary_write(struct vnode *vp, struct mount **mpp,
714 int vn_truncate_locked(struct vnode *vp, off_t length, bool sync,
716 int vn_writechk(struct vnode *vp);
717 int vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
718 const char *attrname, int *buflen, char *buf, struct thread *td);
719 int vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
720 const char *attrname, int buflen, char *buf, struct thread *td);
721 int vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
722 const char *attrname, struct thread *td);
723 int vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags,
725 int vn_vget_ino_gen(struct vnode *vp, vn_get_ino_t alloc,
726 void *alloc_arg, int lkflags, struct vnode **rvp);
727 int vn_utimes_perm(struct vnode *vp, struct vattr *vap,
728 struct ucred *cred, struct thread *td);
730 int vn_io_fault_uiomove(char *data, int xfersize, struct uio *uio);
731 int vn_io_fault_pgmove(vm_page_t ma[], vm_offset_t offset, int xfersize,
734 #define vn_rangelock_unlock(vp, cookie) \
735 rangelock_unlock(&(vp)->v_rl, (cookie), VI_MTX(vp))
736 #define vn_rangelock_unlock_range(vp, cookie, start, end) \
737 rangelock_unlock_range(&(vp)->v_rl, (cookie), (start), (end), \
739 #define vn_rangelock_rlock(vp, start, end) \
740 rangelock_rlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
741 #define vn_rangelock_tryrlock(vp, start, end) \
742 rangelock_tryrlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
743 #define vn_rangelock_wlock(vp, start, end) \
744 rangelock_wlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
745 #define vn_rangelock_trywlock(vp, start, end) \
746 rangelock_trywlock(&(vp)->v_rl, (start), (end), VI_MTX(vp))
748 int vfs_cache_lookup(struct vop_lookup_args *ap);
749 int vfs_cache_root(struct mount *mp, int flags, struct vnode **vpp);
750 void vfs_timestamp(struct timespec *);
751 void vfs_write_resume(struct mount *mp, int flags);
752 int vfs_write_suspend(struct mount *mp, int flags);
753 int vfs_write_suspend_umnt(struct mount *mp);
754 void vnlru_free(int, struct vfsops *);
755 int vop_stdbmap(struct vop_bmap_args *);
756 int vop_stdfdatasync_buf(struct vop_fdatasync_args *);
757 int vop_stdfsync(struct vop_fsync_args *);
758 int vop_stdgetwritemount(struct vop_getwritemount_args *);
759 int vop_stdgetpages(struct vop_getpages_args *);
760 int vop_stdinactive(struct vop_inactive_args *);
761 int vop_stdneed_inactive(struct vop_need_inactive_args *);
762 int vop_stdislocked(struct vop_islocked_args *);
763 int vop_stdkqfilter(struct vop_kqfilter_args *);
764 int vop_stdlock(struct vop_lock1_args *);
765 int vop_stdputpages(struct vop_putpages_args *);
766 int vop_stdunlock(struct vop_unlock_args *);
767 int vop_nopoll(struct vop_poll_args *);
768 int vop_stdaccess(struct vop_access_args *ap);
769 int vop_stdaccessx(struct vop_accessx_args *ap);
770 int vop_stdadvise(struct vop_advise_args *ap);
771 int vop_stdadvlock(struct vop_advlock_args *ap);
772 int vop_stdadvlockasync(struct vop_advlockasync_args *ap);
773 int vop_stdadvlockpurge(struct vop_advlockpurge_args *ap);
774 int vop_stdallocate(struct vop_allocate_args *ap);
775 int vop_stdset_text(struct vop_set_text_args *ap);
776 int vop_stdpathconf(struct vop_pathconf_args *);
777 int vop_stdpoll(struct vop_poll_args *);
778 int vop_stdvptocnp(struct vop_vptocnp_args *ap);
779 int vop_stdvptofh(struct vop_vptofh_args *ap);
780 int vop_stdunp_bind(struct vop_unp_bind_args *ap);
781 int vop_stdunp_connect(struct vop_unp_connect_args *ap);
782 int vop_stdunp_detach(struct vop_unp_detach_args *ap);
783 int vop_eopnotsupp(struct vop_generic_args *ap);
784 int vop_ebadf(struct vop_generic_args *ap);
785 int vop_einval(struct vop_generic_args *ap);
786 int vop_enoent(struct vop_generic_args *ap);
787 int vop_enotty(struct vop_generic_args *ap);
788 int vop_null(struct vop_generic_args *ap);
789 int vop_panic(struct vop_generic_args *ap);
790 int dead_poll(struct vop_poll_args *ap);
791 int dead_read(struct vop_read_args *ap);
792 int dead_write(struct vop_write_args *ap);
794 /* These are called from within the actual VOPS. */
795 void vop_close_post(void *a, int rc);
796 void vop_create_post(void *a, int rc);
797 void vop_deleteextattr_post(void *a, int rc);
798 void vop_link_post(void *a, int rc);
799 void vop_lookup_post(void *a, int rc);
800 void vop_lookup_pre(void *a);
801 void vop_mkdir_post(void *a, int rc);
802 void vop_mknod_post(void *a, int rc);
803 void vop_open_post(void *a, int rc);
804 void vop_read_post(void *a, int rc);
805 void vop_readdir_post(void *a, int rc);
806 void vop_reclaim_post(void *a, int rc);
807 void vop_remove_post(void *a, int rc);
808 void vop_rename_post(void *a, int rc);
809 void vop_rename_pre(void *a);
810 void vop_rmdir_post(void *a, int rc);
811 void vop_setattr_post(void *a, int rc);
812 void vop_setextattr_post(void *a, int rc);
813 void vop_symlink_post(void *a, int rc);
814 int vop_sigdefer(struct vop_vector *vop, struct vop_generic_args *a);
816 #ifdef DEBUG_VFS_LOCKS
817 void vop_strategy_pre(void *a);
818 void vop_lock_pre(void *a);
819 void vop_lock_post(void *a, int rc);
820 void vop_unlock_pre(void *a);
821 void vop_unlock_post(void *a, int rc);
822 void vop_need_inactive_pre(void *a);
823 void vop_need_inactive_post(void *a, int rc);
825 #define vop_strategy_pre(x) do { } while (0)
826 #define vop_lock_pre(x) do { } while (0)
827 #define vop_lock_post(x, y) do { } while (0)
828 #define vop_unlock_pre(x) do { } while (0)
829 #define vop_unlock_post(x, y) do { } while (0)
830 #define vop_need_inactive_pre(x) do { } while (0)
831 #define vop_need_inactive_post(x, y) do { } while (0)
834 void vop_rename_fail(struct vop_rename_args *ap);
836 #define VOP_WRITE_PRE(ap) \
839 off_t osize, ooffset, noffset; \
841 osize = ooffset = noffset = 0; \
842 if (!VN_KNLIST_EMPTY((ap)->a_vp)) { \
843 error = VOP_GETATTR((ap)->a_vp, &va, (ap)->a_cred); \
846 ooffset = (ap)->a_uio->uio_offset; \
847 osize = (off_t)va.va_size; \
850 #define VOP_WRITE_POST(ap, ret) \
851 noffset = (ap)->a_uio->uio_offset; \
852 if (noffset > ooffset && !VN_KNLIST_EMPTY((ap)->a_vp)) { \
853 VFS_KNOTE_LOCKED((ap)->a_vp, NOTE_WRITE \
854 | (noffset > osize ? NOTE_EXTEND : 0)); \
857 #define VOP_LOCK(vp, flags) VOP_LOCK1(vp, flags, __FILE__, __LINE__)
860 #define VOP_ADD_WRITECOUNT_CHECKED(vp, cnt) \
864 error_ = VOP_ADD_WRITECOUNT((vp), (cnt)); \
865 VNASSERT(error_ == 0, (vp), ("VOP_ADD_WRITECOUNT returned %d", \
868 #define VOP_SET_TEXT_CHECKED(vp) \
872 error_ = VOP_SET_TEXT((vp)); \
873 VNASSERT(error_ == 0, (vp), ("VOP_SET_TEXT returned %d", \
876 #define VOP_UNSET_TEXT_CHECKED(vp) \
880 error_ = VOP_UNSET_TEXT((vp)); \
881 VNASSERT(error_ == 0, (vp), ("VOP_UNSET_TEXT returned %d", \
885 #define VOP_ADD_WRITECOUNT_CHECKED(vp, cnt) VOP_ADD_WRITECOUNT((vp), (cnt))
886 #define VOP_SET_TEXT_CHECKED(vp) VOP_SET_TEXT((vp))
887 #define VOP_UNSET_TEXT_CHECKED(vp) VOP_UNSET_TEXT((vp))
890 void vput(struct vnode *vp);
891 void vrele(struct vnode *vp);
892 void vref(struct vnode *vp);
893 void vrefl(struct vnode *vp);
894 void vrefact(struct vnode *vp);
895 int vrefcnt(struct vnode *vp);
896 void v_addpollinfo(struct vnode *vp);
898 int vnode_create_vobject(struct vnode *vp, off_t size, struct thread *td);
899 void vnode_destroy_vobject(struct vnode *vp);
901 extern struct vop_vector fifo_specops;
902 extern struct vop_vector dead_vnodeops;
903 extern struct vop_vector default_vnodeops;
905 #define VOP_PANIC ((void*)(uintptr_t)vop_panic)
906 #define VOP_NULL ((void*)(uintptr_t)vop_null)
907 #define VOP_EBADF ((void*)(uintptr_t)vop_ebadf)
908 #define VOP_ENOTTY ((void*)(uintptr_t)vop_enotty)
909 #define VOP_EINVAL ((void*)(uintptr_t)vop_einval)
910 #define VOP_ENOENT ((void*)(uintptr_t)vop_enoent)
911 #define VOP_EOPNOTSUPP ((void*)(uintptr_t)vop_eopnotsupp)
914 int fifo_printinfo(struct vnode *);
917 typedef int vfs_hash_cmp_t(struct vnode *vp, void *arg);
919 void vfs_hash_changesize(int newhashsize);
920 int vfs_hash_get(const struct mount *mp, u_int hash, int flags,
921 struct thread *td, struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
922 u_int vfs_hash_index(struct vnode *vp);
923 int vfs_hash_insert(struct vnode *vp, u_int hash, int flags, struct thread *td,
924 struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
925 void vfs_hash_ref(const struct mount *mp, u_int hash, struct thread *td,
926 struct vnode **vpp, vfs_hash_cmp_t *fn, void *arg);
927 void vfs_hash_rehash(struct vnode *vp, u_int hash);
928 void vfs_hash_remove(struct vnode *vp);
930 int vfs_kqfilter(struct vop_kqfilter_args *);
931 void vfs_mark_atime(struct vnode *vp, struct ucred *cred);
933 int vfs_read_dirent(struct vop_readdir_args *ap, struct dirent *dp, off_t off);
934 int vfs_emptydir(struct vnode *vp);
936 int vfs_unixify_accmode(accmode_t *accmode);
938 void vfs_unp_reclaim(struct vnode *vp);
940 int setfmode(struct thread *td, struct ucred *cred, struct vnode *vp, int mode);
941 int setfown(struct thread *td, struct ucred *cred, struct vnode *vp, uid_t uid,
943 int vn_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
945 int vn_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
948 void vn_fsid(struct vnode *vp, struct vattr *va);
952 #endif /* !_SYS_VNODE_H_ */