2 # Copyright (c) 1992, 1993
3 # The Regents of the University of California. All rights reserved.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
8 # 1. Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 # 2. Redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution.
13 # 3. Neither the name of the University nor the names of its contributors
14 # may be used to endorse or promote products derived from this software
15 # without specific prior written permission.
17 # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 # ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 # @(#)vnode_if.src 8.12 (Berkeley) 5/14/95
34 # Above each of the vop descriptors in lines starting with %%
35 # is a specification of the locking protocol used by each vop call.
36 # The first column is the name of the variable, the remaining three
37 # columns are in, out and error respectively. The "in" column defines
38 # the lock state on input, the "out" column defines the state on successful
39 # return, and the "error" column defines the locking state on error exit.
41 # The locking value can take the following values:
42 # L: locked; not converted to type of lock.
43 # E: locked with exclusive lock for this process.
45 # -: not applicable. vnode does not yet (or no longer) exists.
46 # =: the same on input and output, may be either L or U.
48 # The parameter named "vpp" is assumed to be always used with double
49 # indirection (**vpp) and that name is hard-coded in vnode_if.awk !
51 # Lines starting with %! specify a pre or post-condition function
52 # to call before/after the vop call.
54 # If other such parameters are introduced, they have to be added to
55 # the AWK script at the head of the definition of "add_debug_code()".
66 # XXX - the lookup locking protocol defies simple description and depends
67 # on the flags and operation fields in the (cnp) structure. Note
68 # especially that *vpp may equal dvp and both may be locked.
72 INOUT struct vnode **vpp;
73 IN struct componentname *cnp;
77 %% cachedlookup dvp L L L
78 %% cachedlookup vpp - L -
80 # This must be an exact copy of lookup. See kern/vfs_cache.c for details.
84 INOUT struct vnode **vpp;
85 IN struct componentname *cnp;
91 %! create pre vop_create_pre
92 %! create post vop_create_post
96 OUT struct vnode **vpp;
97 IN struct componentname *cnp;
102 %% whiteout dvp E E E
103 %! whiteout pre vop_whiteout_pre
104 %! whiteout post vop_whiteout_post
107 IN struct vnode *dvp;
108 IN struct componentname *cnp;
115 %! mknod pre vop_mknod_pre
116 %! mknod post vop_mknod_post
119 IN struct vnode *dvp;
120 OUT struct vnode **vpp;
121 IN struct componentname *cnp;
122 IN struct vattr *vap;
127 %! open post vop_open_post
132 IN struct ucred *cred;
133 IN struct thread *td;
139 %! close post vop_close_post
144 IN struct ucred *cred;
145 IN struct thread *td;
149 %% fplookup_vexec vp - - -
150 %! fplookup_vexec debugpre vop_fplookup_vexec_debugpre
151 %! fplookup_vexec debugpost vop_fplookup_vexec_debugpost
155 IN struct ucred *cred;
159 %% fplookup_symlink vp - - -
160 %! fplookup_symlink debugpre vop_fplookup_symlink_debugpre
161 %! fplookup_symlink debugpost vop_fplookup_symlink_debugpost
163 vop_fplookup_symlink {
165 IN struct cache_fpl *fpl;
173 IN accmode_t accmode;
174 IN struct ucred *cred;
175 IN struct thread *td;
183 IN accmode_t accmode;
184 IN struct ucred *cred;
185 IN struct thread *td;
194 IN struct ucred *active_cred;
195 IN struct ucred *file_cred;
203 OUT struct vattr *vap;
204 IN struct ucred *cred;
209 %! setattr pre vop_setattr_pre
210 %! setattr post vop_setattr_post
214 IN struct vattr *vap;
215 IN struct ucred *cred;
227 %! read post vop_read_post
231 INOUT struct uio *uio;
233 IN struct ucred *cred;
237 %% read_pgcache vp - - -
238 %! read_pgcache post vop_read_pgcache_post
242 INOUT struct uio *uio;
244 IN struct ucred *cred;
249 %! write pre VOP_WRITE_PRE
250 %! write post VOP_WRITE_POST
254 INOUT struct uio *uio;
256 IN struct ucred *cred;
267 IN struct ucred *cred;
268 IN struct thread *td;
277 IN struct ucred *cred;
278 IN struct thread *td;
299 %! fsync pre vop_fsync_debugpre
300 %! fsync post vop_fsync_debugpost
305 IN struct thread *td;
311 %! remove pre vop_remove_pre
312 %! remove post vop_remove_post
315 IN struct vnode *dvp;
317 IN struct componentname *cnp;
323 %! link pre vop_link_pre
324 %! link post vop_link_post
327 IN struct vnode *tdvp;
329 IN struct componentname *cnp;
333 %! rename pre vop_rename_pre
334 %! rename post vop_rename_post
337 IN WILLRELE struct vnode *fdvp;
338 IN WILLRELE struct vnode *fvp;
339 IN struct componentname *fcnp;
340 IN WILLRELE struct vnode *tdvp;
341 IN WILLRELE struct vnode *tvp;
342 IN struct componentname *tcnp;
348 %! mkdir pre vop_mkdir_pre
349 %! mkdir post vop_mkdir_post
350 %! mkdir debugpost vop_mkdir_debugpost
353 IN struct vnode *dvp;
354 OUT struct vnode **vpp;
355 IN struct componentname *cnp;
356 IN struct vattr *vap;
362 %! rmdir pre vop_rmdir_pre
363 %! rmdir post vop_rmdir_post
366 IN struct vnode *dvp;
368 IN struct componentname *cnp;
374 %! symlink pre vop_symlink_pre
375 %! symlink post vop_symlink_post
378 IN struct vnode *dvp;
379 OUT struct vnode **vpp;
380 IN struct componentname *cnp;
381 IN struct vattr *vap;
382 IN const char *target;
387 %! readdir post vop_readdir_post
391 INOUT struct uio *uio;
392 IN struct ucred *cred;
395 INOUT uint64_t **cookies;
403 INOUT struct uio *uio;
404 IN struct ucred *cred;
414 %! need_inactive debugpre vop_need_inactive_debugpre
415 %! need_inactive debugpost vop_need_inactive_debugpost
422 %! reclaim post vop_reclaim_post
429 %! lock1 debugpre vop_lock_debugpre
430 %! lock1 debugpost vop_lock_debugpost
440 %! unlock debugpre vop_unlock_debugpre
452 OUT struct bufobj **bop;
460 %! strategy debugpre vop_strategy_debugpre
468 %% getwritemount vp = = =
472 OUT struct mount **mpp;
503 %% advlockasync vp U U U
511 IN struct task *task;
512 INOUT void **cookiep;
516 %% advlockpurge vp E E E
523 %% reallocblks vp E E E
527 IN struct cluster_save *buflist;
542 %% getpages_async vp L L L
550 IN vop_getpages_iodone_t *iodone;
571 OUT struct acl *aclp;
572 IN struct ucred *cred;
573 IN struct thread *td;
578 %! setacl pre vop_setacl_pre
579 %! setacl post vop_setacl_post
585 IN struct ucred *cred;
586 IN struct thread *td;
596 IN struct ucred *cred;
597 IN struct thread *td;
601 %% closeextattr vp L L L
606 IN struct ucred *cred;
607 IN struct thread *td;
611 %% getextattr vp L L L
615 IN int attrnamespace;
617 INOUT struct uio *uio;
619 IN struct ucred *cred;
620 IN struct thread *td;
624 %% listextattr vp L L L
628 IN int attrnamespace;
629 INOUT struct uio *uio;
631 IN struct ucred *cred;
632 IN struct thread *td;
636 %% openextattr vp L L L
640 IN struct ucred *cred;
641 IN struct thread *td;
645 %% deleteextattr vp E E E
646 %! deleteextattr pre vop_deleteextattr_pre
647 %! deleteextattr post vop_deleteextattr_post
651 IN int attrnamespace;
653 IN struct ucred *cred;
654 IN struct thread *td;
658 %% setextattr vp E E E
659 %! setextattr pre vop_setextattr_pre
660 %! setextattr post vop_setextattr_post
664 IN int attrnamespace;
666 INOUT struct uio *uio;
667 IN struct ucred *cred;
668 IN struct thread *td;
676 IN struct label *label;
677 IN struct ucred *cred;
678 IN struct thread *td;
695 OUT struct vnode **vpp;
697 INOUT size_t *buflen;
708 IN struct ucred *cred;
726 IN struct unpcb *unpcb;
730 %% unp_connect vp L L L
734 OUT struct unpcb **unpcb;
738 %% unp_detach vp = = =
759 %% vop_unset_text vp L L L
766 %% add_writecount vp L L L
774 %% fdatasync vp - - -
775 %! fdatasync pre vop_fdatasync_debugpre
776 %! fdatasync post vop_fdatasync_debugpost
780 IN struct thread *td;
784 %% copy_file_range invp U U U
785 %% copy_file_range outvp U U U
787 vop_copy_file_range {
788 IN struct vnode *invp;
790 IN struct vnode *outvp;
791 INOUT off_t *outoffp;
793 IN unsigned int flags;
794 IN struct ucred *incred;
795 IN struct ucred *outcred;
796 IN struct thread *fsizetd;
800 %% vput_pair dvp E - -
803 IN struct vnode *dvp;
804 INOUT struct vnode **vpp;
809 %% deallocate vp L L L
817 IN struct ucred *cred;
821 # The VOPs below are spares at the end of the table to allow new VOPs to be
822 # added in stable branches without breaking the KBI. New VOPs in HEAD should
823 # be added above these spares. When merging a new VOP to a stable branch,
824 # the new VOP should replace one of the spares.