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;
163 IN accmode_t accmode;
164 IN struct ucred *cred;
165 IN struct thread *td;
173 IN accmode_t accmode;
174 IN struct ucred *cred;
175 IN struct thread *td;
184 IN struct ucred *active_cred;
185 IN struct ucred *file_cred;
186 IN struct thread *td;
194 OUT struct vattr *vap;
195 IN struct ucred *cred;
200 %! setattr pre vop_setattr_pre
201 %! setattr post vop_setattr_post
205 IN struct vattr *vap;
206 IN struct ucred *cred;
218 %! read post vop_read_post
222 INOUT struct uio *uio;
224 IN struct ucred *cred;
228 %% read_pgcache vp - - -
229 %! read_pgcache post vop_read_pgcache_post
233 INOUT struct uio *uio;
235 IN struct ucred *cred;
240 %! write pre VOP_WRITE_PRE
241 %! write post VOP_WRITE_POST
245 INOUT struct uio *uio;
247 IN struct ucred *cred;
258 IN struct ucred *cred;
259 IN struct thread *td;
268 IN struct ucred *cred;
269 IN struct thread *td;
294 IN struct thread *td;
300 %! remove pre vop_remove_pre
301 %! remove post vop_remove_post
304 IN struct vnode *dvp;
306 IN struct componentname *cnp;
312 %! link pre vop_link_pre
313 %! link post vop_link_post
316 IN struct vnode *tdvp;
318 IN struct componentname *cnp;
322 %! rename pre vop_rename_pre
323 %! rename post vop_rename_post
326 IN WILLRELE struct vnode *fdvp;
327 IN WILLRELE struct vnode *fvp;
328 IN struct componentname *fcnp;
329 IN WILLRELE struct vnode *tdvp;
330 IN WILLRELE struct vnode *tvp;
331 IN struct componentname *tcnp;
337 %! mkdir pre vop_mkdir_pre
338 %! mkdir post vop_mkdir_post
341 IN struct vnode *dvp;
342 OUT struct vnode **vpp;
343 IN struct componentname *cnp;
344 IN struct vattr *vap;
350 %! rmdir pre vop_rmdir_pre
351 %! rmdir post vop_rmdir_post
354 IN struct vnode *dvp;
356 IN struct componentname *cnp;
362 %! symlink pre vop_symlink_pre
363 %! symlink post vop_symlink_post
366 IN struct vnode *dvp;
367 OUT struct vnode **vpp;
368 IN struct componentname *cnp;
369 IN struct vattr *vap;
370 IN const char *target;
375 %! readdir post vop_readdir_post
379 INOUT struct uio *uio;
380 IN struct ucred *cred;
383 INOUT u_long **cookies;
391 INOUT struct uio *uio;
392 IN struct ucred *cred;
402 %! need_inactive debugpre vop_need_inactive_debugpre
403 %! need_inactive debugpost vop_need_inactive_debugpost
410 %! reclaim post vop_reclaim_post
417 %! lock1 debugpre vop_lock_debugpre
418 %! lock1 debugpost vop_lock_debugpost
428 %! unlock debugpre vop_unlock_debugpre
440 OUT struct bufobj **bop;
448 %! strategy debugpre vop_strategy_debugpre
456 %% getwritemount vp = = =
460 OUT struct mount **mpp;
491 %% advlockasync vp U U U
499 IN struct task *task;
500 INOUT void **cookiep;
504 %% advlockpurge vp E E E
511 %% reallocblks vp E E E
515 IN struct cluster_save *buflist;
530 %% getpages_async vp L L L
538 IN vop_getpages_iodone_t *iodone;
559 OUT struct acl *aclp;
560 IN struct ucred *cred;
561 IN struct thread *td;
566 %! setacl pre vop_setacl_pre
567 %! setacl post vop_setacl_post
573 IN struct ucred *cred;
574 IN struct thread *td;
584 IN struct ucred *cred;
585 IN struct thread *td;
589 %% closeextattr vp L L L
594 IN struct ucred *cred;
595 IN struct thread *td;
599 %% getextattr vp L L L
603 IN int attrnamespace;
605 INOUT struct uio *uio;
607 IN struct ucred *cred;
608 IN struct thread *td;
612 %% listextattr vp L L L
616 IN int attrnamespace;
617 INOUT struct uio *uio;
619 IN struct ucred *cred;
620 IN struct thread *td;
624 %% openextattr vp L L L
628 IN struct ucred *cred;
629 IN struct thread *td;
633 %% deleteextattr vp E E E
634 %! deleteextattr pre vop_deleteextattr_pre
635 %! deleteextattr post vop_deleteextattr_post
639 IN int attrnamespace;
641 IN struct ucred *cred;
642 IN struct thread *td;
646 %% setextattr vp E E E
647 %! setextattr pre vop_setextattr_pre
648 %! setextattr post vop_setextattr_post
652 IN int attrnamespace;
654 INOUT struct uio *uio;
655 IN struct ucred *cred;
656 IN struct thread *td;
664 IN struct label *label;
665 IN struct ucred *cred;
666 IN struct thread *td;
683 OUT struct vnode **vpp;
685 INOUT size_t *buflen;
712 IN struct unpcb *unpcb;
716 %% unp_connect vp L L L
720 OUT struct unpcb **unpcb;
724 %% unp_detach vp = = =
745 %% vop_unset_text vp L L L
752 %% add_writecount vp L L L
760 %% fdatasync vp L L L
764 IN struct thread *td;
768 %% copy_file_range invp U U U
769 %% copy_file_range outvp U U U
771 vop_copy_file_range {
772 IN struct vnode *invp;
774 IN struct vnode *outvp;
775 INOUT off_t *outoffp;
777 IN unsigned int flags;
778 IN struct ucred *incred;
779 IN struct ucred *outcred;
780 IN struct thread *fsizetd;
784 # The VOPs below are spares at the end of the table to allow new VOPs to be
785 # added in stable branches without breaking the KBI. New VOPs in HEAD should
786 # be added above these spares. When merging a new VOP to a stable branch,
787 # the new VOP should replace one of the spares.