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 # 4. 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 succesful
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.
44 # S: locked with shared lock.
45 # E: locked with exclusive lock for this process.
46 # O: locked with exclusive lock for other process.
48 # -: not applicable. vnode does not yet (or no longer) exists.
49 # =: the same on input and output, may be either L or U.
50 # X: locked if not nil.
52 # The paramater named "vpp" is assumed to be always used with double
53 # indirection (**vpp) and that name is hard-coded in vnode_if.awk !
55 # Lines starting with %! specify a pre or post-condition function
56 # to call before/after the vop call.
58 # If other such parameters are introduced, they have to be added to
59 # the AWK script at the head of the definition of "add_debug_code()".
68 %! lookup pre vop_lookup_pre
69 %! lookup post vop_lookup_post
71 # XXX - the lookup locking protocol defies simple description and depends
72 # on the flags and operation fields in the (cnp) structure. Note
73 # especially that *vpp may equal dvp and both may be locked.
77 INOUT struct vnode **vpp;
78 IN struct componentname *cnp;
81 %% cachedlookup dvp L L L
82 %% cachedlookup vpp - L -
84 # This must be an exact copy of lookup. See kern/vfs_cache.c for details.
88 INOUT struct vnode **vpp;
89 IN struct componentname *cnp;
94 %! create post vop_create_post
98 OUT struct vnode **vpp;
99 IN struct componentname *cnp;
100 IN struct vattr *vap;
104 %% whiteout dvp E E E
107 IN struct vnode *dvp;
108 IN struct componentname *cnp;
115 %! mknod post vop_mknod_post
118 IN struct vnode *dvp;
119 OUT struct vnode **vpp;
120 IN struct componentname *cnp;
121 IN struct vattr *vap;
130 IN struct ucred *cred;
131 IN struct thread *td;
141 IN struct ucred *cred;
142 IN struct thread *td;
150 IN accmode_t accmode;
151 IN struct ucred *cred;
152 IN struct thread *td;
160 IN accmode_t accmode;
161 IN struct ucred *cred;
162 IN struct thread *td;
170 OUT struct vattr *vap;
171 IN struct ucred *cred;
176 %! setattr post vop_setattr_post
180 IN struct vattr *vap;
181 IN struct ucred *cred;
184 %% markatime vp L L L
194 INOUT struct uio *uio;
196 IN struct ucred *cred;
201 %! write pre VOP_WRITE_PRE
202 %! write post VOP_WRITE_POST
206 INOUT struct uio *uio;
208 IN struct ucred *cred;
219 IN struct ucred *cred;
220 IN struct thread *td;
229 IN struct ucred *cred;
230 IN struct thread *td;
255 IN struct thread *td;
261 %! remove post vop_remove_post
264 IN struct vnode *dvp;
266 IN struct componentname *cnp;
272 %! link post vop_link_post
275 IN struct vnode *tdvp;
277 IN struct componentname *cnp;
281 %! rename pre vop_rename_pre
282 %! rename post vop_rename_post
285 IN WILLRELE struct vnode *fdvp;
286 IN WILLRELE struct vnode *fvp;
287 IN struct componentname *fcnp;
288 IN WILLRELE struct vnode *tdvp;
289 IN WILLRELE struct vnode *tvp;
290 IN struct componentname *tcnp;
296 %! mkdir post vop_mkdir_post
299 IN struct vnode *dvp;
300 OUT struct vnode **vpp;
301 IN struct componentname *cnp;
302 IN struct vattr *vap;
308 %! rmdir post vop_rmdir_post
311 IN struct vnode *dvp;
313 IN struct componentname *cnp;
319 %! symlink post vop_symlink_post
322 IN struct vnode *dvp;
323 OUT struct vnode **vpp;
324 IN struct componentname *cnp;
325 IN struct vattr *vap;
334 INOUT struct uio *uio;
335 IN struct ucred *cred;
338 INOUT u_long **cookies;
346 INOUT struct uio *uio;
347 IN struct ucred *cred;
355 IN struct thread *td;
363 IN struct thread *td;
367 %! lock1 pre vop_lock_pre
368 %! lock1 post vop_lock_post
378 %! unlock pre vop_unlock_pre
379 %! unlock post vop_unlock_post
392 OUT struct bufobj **bop;
400 %! strategy pre vop_strategy_pre
408 %% getwritemount vp = = =
412 OUT struct mount **mpp;
428 OUT register_t *retval;
443 %% advlockasync vp U U U
451 IN struct task *task;
452 INOUT void **cookiep;
456 %% advlockpurge vp E E E
463 %% reallocblks vp E E E
467 IN struct cluster_save *buflist;
478 IN vm_ooffset_t offset;
490 IN vm_ooffset_t offset;
499 OUT struct acl *aclp;
500 IN struct ucred *cred;
501 IN struct thread *td;
511 IN struct ucred *cred;
512 IN struct thread *td;
522 IN struct ucred *cred;
523 IN struct thread *td;
527 %% closeextattr vp L L L
532 IN struct ucred *cred;
533 IN struct thread *td;
537 %% getextattr vp L L L
541 IN int attrnamespace;
543 INOUT struct uio *uio;
545 IN struct ucred *cred;
546 IN struct thread *td;
550 %% listextattr vp L L L
554 IN int attrnamespace;
555 INOUT struct uio *uio;
557 IN struct ucred *cred;
558 IN struct thread *td;
562 %% openextattr vp L L L
566 IN struct ucred *cred;
567 IN struct thread *td;
571 %% deleteextattr vp E E E
572 %! deleteextattr post vop_deleteextattr_post
576 IN int attrnamespace;
578 IN struct ucred *cred;
579 IN struct thread *td;
583 %% setextattr vp E E E
584 %! setextattr post vop_setextattr_post
588 IN int attrnamespace;
590 INOUT struct uio *uio;
591 IN struct ucred *cred;
592 IN struct thread *td;
600 IN struct label *label;
601 IN struct ucred *cred;
602 IN struct thread *td;
619 OUT struct vnode **vpp;
620 IN struct ucred *cred;
647 IN struct socket *socket;
650 %% unp_connect vp L L L
654 OUT struct socket **socket;
657 %% unp_detach vp = = =
675 %% vop_unset_text vp E E E
681 %% get_writecount vp L L L
688 %% add_writecount vp E E E
695 # The VOPs below are spares at the end of the table to allow new VOPs to be
696 # added in stable branches without breaking the KBI. New VOPs in HEAD should
697 # be added above these spares. When merging a new VOP to a stable branch,
698 # the new VOP should replace one of the spares.