From nobody Mon Oct 28 12:46:11 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4XcY6D1JDtz5bKGR; Mon, 28 Oct 2024 12:46:12 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4XcY6D0gFJz4YbJ; Mon, 28 Oct 2024 12:46:12 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1730119572; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=1n+uk7GoCPXbMBOtf9p5UoS+FZ6lG+C7J+OSsDpi/0A=; b=Ubv9nwq5+INrO+/ksf/Yfvmv3CbIm796EIi1uIFL+zPM5wN8IMDeGI4mHplK+b2v8EChnU Y0scrPgAGCkETh1A35iz7C4y2LsD++0w7byOGi2tAB7CqGx8nI/YdzuuU7IZkGi8dPRKsW A1qeMEYSUq0Oqoco4//C6VLPb2N0l96Me3JZ5sU0SUIcr/btNM5K2n0dOfMc0kDbmNDYv/ pRMoOfLnFmNCpw9Bzche4W3hK8Ne1f1t7kAd2riqepbRZwViZDoq7dBEF1sKHSxZYlvqi5 NqjqQh+wezXB1cXy/vQHorFSnngJtnaCDHabAFwJu27PfLwVuNKbJFekErf/Gw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1730119572; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=1n+uk7GoCPXbMBOtf9p5UoS+FZ6lG+C7J+OSsDpi/0A=; b=czak1TqmyP3f9dlnVOiw6RD7FkoFwvJmRoVlWoRS2j/YYWkvYw4VHRSx+4QqwUmYtqin7U BSPZG0kihb5ledkpLg1nsqdnC9uX0qs86MVBCeF9eEl7/ZeM8sPKPcJ5UA9SkMkleS2hzR 51F2uaiDIjkGN2loaHgo9oBGBdrTD6DiDmol4qYmufIeE6vQuDTxfIG8j/zCHe56iKVqg0 0RaWMUZvlDUfUakWyK+mSOTZ9ZjANc7Sury8q1Nj+RewNvOKZoafhDjW6/wAFgsixTaUWP l89fLNNljRJCjQrurAMfYS4xpINW7/Ibk2VQ8YIbHFmh4eeHHdSrjYaCNRm+2A== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1730119572; a=rsa-sha256; cv=none; b=jh70ZSpkyha0DboJWnyVMO4UayuuFC2hTOPSru1UXwpyykREiMV41sHUXtjIkw/janZDek bvGTSjeGsZp3bRfsg6R/sUgB7r8eYADU1tpX0Lu63E12kf3xxr6YEveCoGdgtkwGcL9zl2 ZLeNbB87Xg+78FzxBzBd/w36xUv/1s6UvbAfHiqXZ+yIQAmJRjvPCNJqXwdY8nTVuC+Sk2 /pGuDHH+tK43UL6rWR9K2X2nv6X0K4H9+Ch0J2pm8GrBu0tFGgjd4LG7a8nq1EORbXTswh ALoSGEhNoR6sLvDCNTT5McLuEbKGRUCpu5j/BfWOuTaYKjqQjcsjuj1Ug/tGEw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4XcY6D0BgnzfxX; Mon, 28 Oct 2024 12:46:12 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 49SCkB8J075663; Mon, 28 Oct 2024 12:46:11 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 49SCkB94075660; Mon, 28 Oct 2024 12:46:11 GMT (envelope-from git) Date: Mon, 28 Oct 2024 12:46:11 GMT Message-Id: <202410281246.49SCkB94075660@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: a94328b63c20 - stable/14 - vnode.9: Document vnode_if.awk and vnode_if.src List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: a94328b63c20498d72672bb13d2bb4d89fdf274b Auto-Submitted: auto-generated The branch stable/14 has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=a94328b63c20498d72672bb13d2bb4d89fdf274b commit a94328b63c20498d72672bb13d2bb4d89fdf274b Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2024-10-09 10:04:36 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2024-10-28 12:45:53 +0000 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 (cherry picked from commit e018265679389cfcebe172d4bf61aa4fe4f58b0a) --- share/man/man9/vnode.9 | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/share/man/man9/vnode.9 b/share/man/man9/vnode.9 index 3d34b48c2ee0..5dd087725e92 100644 --- a/share/man/man9/vnode.9 +++ b/share/man/man9/vnode.9 @@ -24,7 +24,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd February 12, 2014 +.Dd October 9, 2024 .Dt VNODE 9 .Os .Sh NAME @@ -104,9 +104,21 @@ the vnode. The .Va v_op field is used by the -.Dv VOP_* -macros to call functions in the file system which implement the vnode's +.Fn VOP_* +functions to call functions in the file system which implement the vnode's functionality. +.Pp +The +.Fn VOP_* +function declarations and definitions are generated from +.Pa sys/kern/vnode_if.src +by the +.Pa sys/tools/vndoe_if.awk +script. +The interfaces are documented in their respective manual pages like +.Xr VOP_READ 9 +and +.Xr VOP_WRITE 9 . .Sh VNODE TYPES .Bl -tag -width VSOCK .It Dv VNON @@ -154,6 +166,16 @@ when holding a .Nm interlock, will cause a LOR (Lock Order Reversal) due to the intertwining of VM Objects and Vnodes. +.Sh FILES +.Bl -tag -width "sys/tools/vnode_if.awk" -compact +.It Pa sys/kern/vnode_if.src +The input file for +.Pa sys/tools/vnode_if.awk . +.It Pa sys/tools/vnode_if.awk +The script generating the source code of the +.Fn VOP_* +functions. +.El .Sh SEE ALSO .Xr malloc 9 , .Xr VFS 9 ,