Skip to content

Commit e018265

Browse files
committed
vnode.9: Document vnode_if.awk and vnode_if.src
Discussed with: bjk, imp Reviewed by: kib MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D27196
1 parent 4851376 commit e018265

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

share/man/man9/vnode.9

+25-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2525
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2626
.\"
27-
.Dd February 12, 2014
27+
.Dd October 9, 2024
2828
.Dt VNODE 9
2929
.Os
3030
.Sh NAME
@@ -104,9 +104,21 @@ the vnode.
104104
The
105105
.Va v_op
106106
field is used by the
107-
.Dv VOP_*
108-
macros to call functions in the file system which implement the vnode's
107+
.Fn VOP_*
108+
functions to call functions in the file system which implement the vnode's
109109
functionality.
110+
.Pp
111+
The
112+
.Fn VOP_*
113+
function declarations and definitions are generated from
114+
.Pa sys/kern/vnode_if.src
115+
by the
116+
.Pa sys/tools/vndoe_if.awk
117+
script.
118+
The interfaces are documented in their respective manual pages like
119+
.Xr VOP_READ 9
120+
and
121+
.Xr VOP_WRITE 9 .
110122
.Sh VNODE TYPES
111123
.Bl -tag -width VSOCK
112124
.It Dv VNON
@@ -154,6 +166,16 @@ when holding a
154166
.Nm
155167
interlock, will cause a LOR (Lock Order Reversal) due to the
156168
intertwining of VM Objects and Vnodes.
169+
.Sh FILES
170+
.Bl -tag -width "sys/tools/vnode_if.awk" -compact
171+
.It Pa sys/kern/vnode_if.src
172+
The input file for
173+
.Pa sys/tools/vnode_if.awk .
174+
.It Pa sys/tools/vnode_if.awk
175+
The script generating the source code of the
176+
.Fn VOP_*
177+
functions.
178+
.El
157179
.Sh SEE ALSO
158180
.Xr malloc 9 ,
159181
.Xr VFS 9 ,

0 commit comments

Comments
 (0)