d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update errors in documentation for various VOP_ calls. Specifically,

Browse Source 
describe the correct locking state expected on entry and return.
This commit is contained in:
Matthew Dillon 1999-09-24 07:07:02 +00:00
parent 011afabb7a
commit fe11eb74af
5 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
share/man/man9/VOP_ABORTOP.9
View File

@ -66,6 +66,9 @@ vop_abortop(struct vnode *dvp, struct componentname *cnp)
return 0;
}
.Ed
.Sh LOCKS
.Fa dvp
should be locked on entry and remain locked on return.
.Sh SEE ALSO
.Xr vnode 9
.Sh AUTHORS

2
share/man/man9/VOP_CREATE.9
View File

@ -88,7 +88,7 @@ flag is specified in
.Sh LOCKS
The directory,
.Fa dvp
should be locked on entry and will be unlocked and released on exit.
will be locked on entry and must remain locked on return.
If the call is successful, the new object will be returned locked,
unless the call is
.Xr VOP_MKNOD 9

9
share/man/man9/VOP_INACTIVE.9
View File

@ -59,6 +59,14 @@ It can be used to reclaim space for 'open but deleted' files.
is called when a vnode is being reused for a different filesystem.
Any filesystem specific resources associated with the vnode should be
freed.
.Sh LOCKS
.Pp
For VOP_INACTIVE, the vp will be locked on entry. Your VOP_INACTIVE code
must unlock the vp prior to returning.
.Pp
For VOP_RECLAIM, the vp will not be locked on entry and should be left
unlocked on return.
.Pp
.Sh PSEUDOCODE
.Bd -literal
int
@ -70,6 +78,7 @@ vop_inactive(struct vnode *vp)
*/
...;
}
VOP_UNLOCK(vp, 0, p);
return 0;
}

9
share/man/man9/VOP_LINK.9
View File

@ -57,13 +57,12 @@ file vnodes should NOT be released on exit.
.Sh LOCKS
The directory,
.Fa dvp
is locked on entry. The caller will unlock and release the directory
on return. The VOP routine should not try to unlock or release
the directory.
is locked on entry and should remain locked on return.
The file
.Fa vp
is not locked on entry. If the VOP routine locks it, it must remember
to unlock it prior to returning.
is not locked on entry and should be left unlocked on return.
If the VOP routine locks the file, it must remember to unlock it
prior to returning.
.Sh RETURN VALUES
Zero is returned if the file was linked successfully, otherwise an
error is returned.

2
share/man/man9/VOP_REMOVE.9
View File

@ -59,7 +59,7 @@ Both
.Fa dvp
and
.Fa vp
should be locked on entry and are unlocked and released on exit.
should be locked on entry and remain locked on return.
.Sh RETURN VALUES
Zero is returned on success, otherwise an error code is returned.
.Sh PSEUDOCODE