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;
229 %! write pre VOP_WRITE_PRE
230 %! write post VOP_WRITE_POST
234 INOUT struct uio *uio;
236 IN struct ucred *cred;
247 IN struct ucred *cred;
248 IN struct thread *td;
257 IN struct ucred *cred;
258 IN struct thread *td;
283 IN struct thread *td;
289 %! remove pre vop_remove_pre
290 %! remove post vop_remove_post
293 IN struct vnode *dvp;
295 IN struct componentname *cnp;
301 %! link pre vop_link_pre
302 %! link post vop_link_post
305 IN struct vnode *tdvp;
307 IN struct componentname *cnp;
311 %! rename pre vop_rename_pre
312 %! rename post vop_rename_post
315 IN WILLRELE struct vnode *fdvp;
316 IN WILLRELE struct vnode *fvp;
317 IN struct componentname *fcnp;
318 IN WILLRELE struct vnode *tdvp;
319 IN WILLRELE struct vnode *tvp;
320 IN struct componentname *tcnp;
326 %! mkdir pre vop_mkdir_pre
327 %! mkdir post vop_mkdir_post
330 IN struct vnode *dvp;
331 OUT struct vnode **vpp;
332 IN struct componentname *cnp;
333 IN struct vattr *vap;
339 %! rmdir pre vop_rmdir_pre
340 %! rmdir post vop_rmdir_post
343 IN struct vnode *dvp;
345 IN struct componentname *cnp;
351 %! symlink pre vop_symlink_pre
352 %! symlink post vop_symlink_post
355 IN struct vnode *dvp;
356 OUT struct vnode **vpp;
357 IN struct componentname *cnp;
358 IN struct vattr *vap;
359 IN const char *target;
364 %! readdir post vop_readdir_post
368 INOUT struct uio *uio;
369 IN struct ucred *cred;
372 INOUT u_long **cookies;
380 INOUT struct uio *uio;
381 IN struct ucred *cred;
389 IN struct thread *td;
392 %! need_inactive debugpre vop_need_inactive_debugpre
393 %! need_inactive debugpost vop_need_inactive_debugpost
400 %! reclaim post vop_reclaim_post
404 IN struct thread *td;
408 %! lock1 debugpre vop_lock_debugpre
409 %! lock1 debugpost vop_lock_debugpost
419 %! unlock debugpre vop_unlock_debugpre
431 OUT struct bufobj **bop;
439 %! strategy debugpre vop_strategy_debugpre
447 %% getwritemount vp = = =
451 OUT struct mount **mpp;
482 %% advlockasync vp U U U
490 IN struct task *task;
491 INOUT void **cookiep;
495 %% advlockpurge vp E E E
502 %% reallocblks vp E E E
506 IN struct cluster_save *buflist;
521 %% getpages_async vp L L L
529 IN vop_getpages_iodone_t *iodone;
550 OUT struct acl *aclp;
551 IN struct ucred *cred;
552 IN struct thread *td;
557 %! setacl pre vop_setacl_pre
558 %! setacl post vop_setacl_post
564 IN struct ucred *cred;
565 IN struct thread *td;
575 IN struct ucred *cred;
576 IN struct thread *td;
580 %% closeextattr vp L L L
585 IN struct ucred *cred;
586 IN struct thread *td;
590 %% getextattr vp L L L
594 IN int attrnamespace;
596 INOUT struct uio *uio;
598 IN struct ucred *cred;
599 IN struct thread *td;
603 %% listextattr vp L L L
607 IN int attrnamespace;
608 INOUT struct uio *uio;
610 IN struct ucred *cred;
611 IN struct thread *td;
615 %% openextattr vp L L L
619 IN struct ucred *cred;
620 IN struct thread *td;
624 %% deleteextattr vp E E E
625 %! deleteextattr pre vop_deleteextattr_pre
626 %! deleteextattr post vop_deleteextattr_post
630 IN int attrnamespace;
632 IN struct ucred *cred;
633 IN struct thread *td;
637 %% setextattr vp E E E
638 %! setextattr pre vop_setextattr_pre
639 %! setextattr post vop_setextattr_post
643 IN int attrnamespace;
645 INOUT struct uio *uio;
646 IN struct ucred *cred;
647 IN struct thread *td;
655 IN struct label *label;
656 IN struct ucred *cred;
657 IN struct thread *td;
674 OUT struct vnode **vpp;
675 IN struct ucred *cred;
677 INOUT size_t *buflen;
704 IN struct unpcb *unpcb;
708 %% unp_connect vp L L L
712 OUT struct unpcb **unpcb;
716 %% unp_detach vp = = =
737 %% vop_unset_text vp L L L
744 %% add_writecount vp L L L
752 %% fdatasync vp L L L
756 IN struct thread *td;
760 %% copy_file_range invp U U U
761 %% copy_file_range outvp U U U
763 vop_copy_file_range {
764 IN struct vnode *invp;
766 IN struct vnode *outvp;
767 INOUT off_t *outoffp;
769 IN unsigned int flags;
770 IN struct ucred *incred;
771 IN struct ucred *outcred;
772 IN struct thread *fsizetd;
776 # The VOPs below are spares at the end of the table to allow new VOPs to be
777 # added in stable branches without breaking the KBI. New VOPs in HEAD should
778 # be added above these spares. When merging a new VOP to a stable branch,
779 # the new VOP should replace one of the spares.