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 paramater 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;
303 IN struct thread *td;
309 %! remove pre vop_remove_pre
310 %! remove post vop_remove_post
313 IN struct vnode *dvp;
315 IN struct componentname *cnp;
321 %! link pre vop_link_pre
322 %! link post vop_link_post
325 IN struct vnode *tdvp;
327 IN struct componentname *cnp;
331 %! rename pre vop_rename_pre
332 %! rename post vop_rename_post
335 IN WILLRELE struct vnode *fdvp;
336 IN WILLRELE struct vnode *fvp;
337 IN struct componentname *fcnp;
338 IN WILLRELE struct vnode *tdvp;
339 IN WILLRELE struct vnode *tvp;
340 IN struct componentname *tcnp;
346 %! mkdir pre vop_mkdir_pre
347 %! mkdir post vop_mkdir_post
348 %! mkdir debugpost vop_mkdir_debugpost
351 IN struct vnode *dvp;
352 OUT struct vnode **vpp;
353 IN struct componentname *cnp;
354 IN struct vattr *vap;
360 %! rmdir pre vop_rmdir_pre
361 %! rmdir post vop_rmdir_post
364 IN struct vnode *dvp;
366 IN struct componentname *cnp;
372 %! symlink pre vop_symlink_pre
373 %! symlink post vop_symlink_post
376 IN struct vnode *dvp;
377 OUT struct vnode **vpp;
378 IN struct componentname *cnp;
379 IN struct vattr *vap;
380 IN const char *target;
385 %! readdir post vop_readdir_post
389 INOUT struct uio *uio;
390 IN struct ucred *cred;
393 INOUT u_long **cookies;
401 INOUT struct uio *uio;
402 IN struct ucred *cred;
412 %! need_inactive debugpre vop_need_inactive_debugpre
413 %! need_inactive debugpost vop_need_inactive_debugpost
420 %! reclaim post vop_reclaim_post
427 %! lock1 debugpre vop_lock_debugpre
428 %! lock1 debugpost vop_lock_debugpost
438 %! unlock debugpre vop_unlock_debugpre
450 OUT struct bufobj **bop;
458 %! strategy debugpre vop_strategy_debugpre
466 %% getwritemount vp = = =
470 OUT struct mount **mpp;
501 %% advlockasync vp U U U
509 IN struct task *task;
510 INOUT void **cookiep;
514 %% advlockpurge vp E E E
521 %% reallocblks vp E E E
525 IN struct cluster_save *buflist;
540 %% getpages_async vp L L L
548 IN vop_getpages_iodone_t *iodone;
569 OUT struct acl *aclp;
570 IN struct ucred *cred;
571 IN struct thread *td;
576 %! setacl pre vop_setacl_pre
577 %! setacl post vop_setacl_post
583 IN struct ucred *cred;
584 IN struct thread *td;
594 IN struct ucred *cred;
595 IN struct thread *td;
599 %% closeextattr vp L L L
604 IN struct ucred *cred;
605 IN struct thread *td;
609 %% getextattr vp L L L
613 IN int attrnamespace;
615 INOUT struct uio *uio;
617 IN struct ucred *cred;
618 IN struct thread *td;
622 %% listextattr vp L L L
626 IN int attrnamespace;
627 INOUT struct uio *uio;
629 IN struct ucred *cred;
630 IN struct thread *td;
634 %% openextattr vp L L L
638 IN struct ucred *cred;
639 IN struct thread *td;
643 %% deleteextattr vp E E E
644 %! deleteextattr pre vop_deleteextattr_pre
645 %! deleteextattr post vop_deleteextattr_post
649 IN int attrnamespace;
651 IN struct ucred *cred;
652 IN struct thread *td;
656 %% setextattr vp E E E
657 %! setextattr pre vop_setextattr_pre
658 %! setextattr post vop_setextattr_post
662 IN int attrnamespace;
664 INOUT struct uio *uio;
665 IN struct ucred *cred;
666 IN struct thread *td;
674 IN struct label *label;
675 IN struct ucred *cred;
676 IN struct thread *td;
693 OUT struct vnode **vpp;
695 INOUT size_t *buflen;
722 IN struct unpcb *unpcb;
726 %% unp_connect vp L L L
730 OUT struct unpcb **unpcb;
734 %% unp_detach vp = = =
755 %% vop_unset_text vp L L L
762 %% add_writecount vp L L L
770 %% fdatasync vp L L L
774 IN struct thread *td;
778 %% copy_file_range invp U U U
779 %% copy_file_range outvp U U U
781 vop_copy_file_range {
782 IN struct vnode *invp;
784 IN struct vnode *outvp;
785 INOUT off_t *outoffp;
787 IN unsigned int flags;
788 IN struct ucred *incred;
789 IN struct ucred *outcred;
790 IN struct thread *fsizetd;
794 %% vput_pair dvp E - -
797 IN struct vnode *dvp;
798 INOUT struct vnode **vpp;
803 %% deallocate vp L L L
811 IN struct ucred *cred;
815 # The VOPs below are spares at the end of the table to allow new VOPs to be
816 # added in stable branches without breaking the KBI. New VOPs in HEAD should
817 # be added above these spares. When merging a new VOP to a stable branch,
818 # the new VOP should replace one of the spares.