From nobody Mon Oct 28 12:46:15 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 4XcY6J3P2nz5bK4w; Mon, 28 Oct 2024 12:46:16 +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 4XcY6J1H3Nz4YTS; Mon, 28 Oct 2024 12:46:16 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1730119576; 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=ubDqbl4PqZUgS1UtEXgo3cywX5ZTFltzGcpEdbwt434=; b=x8gqbOxUsfOhVeNG49B00k/oA2DgvU4nAR4kLU6jkHGSSZyB9uSubMy03Pm8CC8d3ygYZm 6If8zdPAb/YFpgKjWsFkPYPXayJmUot0oSIpNxCSeBhC3iLPFz8jRT67INJ9hFnUzx0wAq AZlF4LGggYsyRCCB8ew37zWK94rOObzxkWihq8+O4SjTkBxeZR5/eaEC14GzyYT1lgPiQT w14AyAFciV8qunoKaPgKmMelI2LYaAZfYi/0V2jvlkEmqPK7gUV8/DpqhnXNDXXPB2qnJO KfLQJhZR5vjG8vfFQNY089myekely+pqBhFRngKGxYT17gEzdlAEY6gQuQmwBQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1730119576; 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=ubDqbl4PqZUgS1UtEXgo3cywX5ZTFltzGcpEdbwt434=; b=Lf5ujI+LMwRl8MhM9WBxzXUIJHwyQ+qYGtv7+aLBLTAtE71dGLByglHF0ox8lbm3cyqKZq Jm5OQpgq1KCG46In97X4Yw5hbq/1nMRt86MwfojijEu1U+Ydfu/0kEOOiLPA72fqwtnCNX 5rpOscjlfvC1AP+hFsevg2eSx9e3fCwMaxtMDxbaKyQOGrf//geIhngs7B5rrh0rj18kOv YDzQeynOr4BQMccF7OfnsNwc2fUJasEZ7frIPN9t8SQEO/Q7fNTOIDjgKkJsNcOuMhYfec qBxVnNdSCT+ScvrdR1la64JrvxLUX8XObLu/TpI19cxswsjNDbewbPt6f76ijA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1730119576; a=rsa-sha256; cv=none; b=H3UQwwYesj3X+HNQwWYbvftCM12/g6fsQYIROP6QMLimwI473Tq35e7VRYgFzhgDuHjeBa RGB1cmt0yTmLMRO076yQkCP7oKVztwpqNBOdq6CeJDsUIyn07MqDHaTwnefp+LJ322if4/ SXYTB0iPOPRV92zrVapF7GmU0kkzQWKYBo/Vd4+T7pTkg1+IzHaKam3HM0aO4CxR5DAnQd g5xlaj2toVpZSIGMQs3JFODHugojAmcEyJ/CoFkM6wTQM2Y/VFcSkjyc3qs55a3chWQoOg SbIYCUkgwMfEit0R9R6fa//BAASQNpXlhROj1za6D/ZaLTFecPtfqqvKwN/DqQ== 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 4XcY6J0NW0zg0R; Mon, 28 Oct 2024 12:46:16 +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 49SCkFMO075853; Mon, 28 Oct 2024 12:46:15 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 49SCkFTT075850; Mon, 28 Oct 2024 12:46:15 GMT (envelope-from git) Date: Mon, 28 Oct 2024 12:46:15 GMT Message-Id: <202410281246.49SCkFTT075850@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: 7bdde516fc2b - stable/13 - 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/13 X-Git-Reftype: branch X-Git-Commit: 7bdde516fc2b1ab828e2c4a9c473ba30018b30c7 Auto-Submitted: auto-generated The branch stable/13 has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=7bdde516fc2b1ab828e2c4a9c473ba30018b30c7 commit 7bdde516fc2b1ab828e2c4a9c473ba30018b30c7 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:46:05 +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 6befe7337b94..c4bfab5f849f 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 ,