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-codeed 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()".
69 %! lookup pre vop_lookup_pre
70 %! lookup post vop_lookup_post
72 # XXX - the lookup locking protocol defies simple description and depends
73 # on the flags and operation fields in the (cnp) structure. Note
74 # especially that *vpp may equal dvp and both may be locked.
78 INOUT struct vnode **vpp;
79 IN struct componentname *cnp;
82 %% cachedlookup dvp L ? ?
83 %% cachedlookup vpp - L -
85 # This must be an exact copy of lookup. See kern/vfs_cache.c for details.
89 INOUT struct vnode **vpp;
90 IN struct componentname *cnp;
95 %! create post vop_create_post
99 OUT struct vnode **vpp;
100 IN struct componentname *cnp;
101 IN struct vattr *vap;
105 %% whiteout dvp E E E
108 IN struct vnode *dvp;
109 IN struct componentname *cnp;
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;
131 IN struct ucred *cred;
132 IN struct thread *td;
142 IN struct ucred *cred;
143 IN struct thread *td;
152 IN struct ucred *cred;
153 IN struct thread *td;
161 OUT struct vattr *vap;
162 IN struct ucred *cred;
163 IN struct thread *td;
168 %! setattr post vop_setattr_post
172 IN struct vattr *vap;
173 IN struct ucred *cred;
174 IN struct thread *td;
182 INOUT struct uio *uio;
184 IN struct ucred *cred;
189 %! write pre VOP_WRITE_PRE
190 %! write post VOP_WRITE_POST
194 INOUT struct uio *uio;
196 IN struct ucred *cred;
204 IN struct thread *td;
205 IN struct ucred *cred;
217 IN struct ucred *cred;
218 IN struct thread *td;
227 IN struct ucred *cred;
228 IN struct thread *td;
253 IN struct thread *td;
259 %! remove post vop_remove_post
262 IN struct vnode *dvp;
264 IN struct componentname *cnp;
270 %! link post vop_link_post
273 IN struct vnode *tdvp;
275 IN struct componentname *cnp;
279 %! rename pre vop_rename_pre
280 %! rename post vop_rename_post
283 IN WILLRELE struct vnode *fdvp;
284 IN WILLRELE struct vnode *fvp;
285 IN struct componentname *fcnp;
286 IN WILLRELE struct vnode *tdvp;
287 IN WILLRELE struct vnode *tvp;
288 IN struct componentname *tcnp;
294 %! mkdir post vop_mkdir_post
297 IN struct vnode *dvp;
298 OUT struct vnode **vpp;
299 IN struct componentname *cnp;
300 IN struct vattr *vap;
306 %! rmdir post vop_rmdir_post
309 IN struct vnode *dvp;
311 IN struct componentname *cnp;
317 %! symlink post vop_symlink_post
320 IN struct vnode *dvp;
321 OUT struct vnode **vpp;
322 IN struct componentname *cnp;
323 IN struct vattr *vap;
332 INOUT struct uio *uio;
333 IN struct ucred *cred;
336 INOUT u_long **cookies;
344 INOUT struct uio *uio;
345 IN struct ucred *cred;
353 IN struct thread *td;
361 IN struct thread *td;
365 %! lock pre vop_lock_pre
366 %! lock post vop_lock_post
371 IN struct thread *td;
377 %! unlock pre vop_unlock_pre
378 %! unlock post vop_unlock_post
383 IN struct thread *td;
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 %% reallocblks vp E E E
447 IN struct cluster_save *buflist;
458 IN vm_ooffset_t offset;
470 IN vm_ooffset_t offset;
479 OUT struct acl *aclp;
480 IN struct ucred *cred;
481 IN struct thread *td;
491 IN struct ucred *cred;
492 IN struct thread *td;
502 IN struct ucred *cred;
503 IN struct thread *td;
507 %% closeextattr vp L L L
512 IN struct ucred *cred;
513 IN struct thread *td;
517 %% getextattr vp L L L
521 IN int attrnamespace;
523 INOUT struct uio *uio;
525 IN struct ucred *cred;
526 IN struct thread *td;
530 %% listextattr vp L L L
534 IN int attrnamespace;
535 INOUT struct uio *uio;
537 IN struct ucred *cred;
538 IN struct thread *td;
542 %% openextattr vp L L L
546 IN struct ucred *cred;
547 IN struct thread *td;
551 %% deleteextattr vp E E E
555 IN int attrnamespace;
557 IN struct ucred *cred;
558 IN struct thread *td;
562 %% setextattr vp E E E
566 IN int attrnamespace;
568 INOUT struct uio *uio;
569 IN struct ucred *cred;
570 IN struct thread *td;
578 IN struct label *label;
579 IN struct ucred *cred;
580 IN struct thread *td;