From nobody Mon Oct 14 10:31:07 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 4XRtmr1Pdnz5YKxs; Mon, 14 Oct 2024 10:31:08 +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 "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4XRtmq6932z4tnJ; Mon, 14 Oct 2024 10:31:07 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1728901867; 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=ZnDZMW0OcavhWvjSRAsoEmaMStdzUhh/4UA5vhjzMhM=; b=OPo5x6BLNR0AJpks3LLko/PS6mNkp6vQuBwxeXBuoD+fkSthj0KX2rV6frve71h1hsKoAk d85PO0Wf3A6bpUxvvseQ/f2FZ0ITv5PS45zkifRZXNWNKAVTumsX9cWYT3AUp5A1QPeFQq htsEiNhdU41doV3lxBRrZo8r0E/uhTfs8UEENFKKkSam5ZyNMffknhHl7jX0EUHp3vBZar MAJYVFhxScy5+u5RCayHJFEMi9t0KwObOQemltfdOLs+QdaivmKdzwo6jbwnGLYbOD+JIx mrsJ1PPfkWLXX5Ltu2K2oQnwzuNAh6TBp0aH3lZoqln89V5uYkdWoJCY6iTouA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1728901867; 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=ZnDZMW0OcavhWvjSRAsoEmaMStdzUhh/4UA5vhjzMhM=; b=UXHvbdqsgWB7CiAenRrwZGDaT1+XqAjWgJkH0CTaVuwclgbTf5d5+ujmXO1GjG6Q7s450C tc+SkQCjY23XE/b0rkwIJJisarT3SbVQO51s4BO8m9LOp85ZoKkjsJD2yWNTjM6BfJ3TXD K2lrknrsr8txsee5ZvTU/dVEqjIHum8MNas19jZ5CvxjWh9BbtJje62Lhh73mlH17PXW4n 8awKBF/6l9hEYHqpj3epPuxXhILmksX2QLDj6JSwyu3LcUYULu6Pu8RXB85FOrlugQKvp+ vczrpbe7o0QSMIs1dRRdM3CZcEYtxzy5+d+qAKYeTGjRnolj+rA1sHZb4hS91A== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1728901867; a=rsa-sha256; cv=none; b=e7rgS5/lA8YdIGPtnH5GxFYDXtEb+DCPODFqou+uxNOf07ORn6KFhXe3g+dnKUPJETXDjo BOqYWiKr+JdhUv7OrZNzjCR+Iu8wRdIr/XUeNfwjCzO90PLwaLWvaXaTlWJNAad93ZJCrh 9jhLV/h3GHLP211QhAOkzoiWdA/VTZyvq8BkXoVamFYdSxcNRAe9bGQ8GtgQMhmfg/7rGx q7v0QiR8DuD3zPjaRJw2QTQ4OYLcuC9xf0fd2iY2NxYfCEqW5chPo91qHPPLupEavIEHkz 1WFOUYH52P74FHpBQzy60Iyw9+QvEPHuhzFL5JO7TxC++yNRXGxmlMDLyuD3Qg== 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 4XRtmq5mVKzb5S; Mon, 14 Oct 2024 10:31:07 +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 49EAV78e079692; Mon, 14 Oct 2024 10:31:07 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 49EAV77u079689; Mon, 14 Oct 2024 10:31:07 GMT (envelope-from git) Date: Mon, 14 Oct 2024 10:31:07 GMT Message-Id: <202410141031.49EAV77u079689@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: e01826567938 - main - 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/main X-Git-Reftype: branch X-Git-Commit: e018265679389cfcebe172d4bf61aa4fe4f58b0a Auto-Submitted: auto-generated The branch main has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=e018265679389cfcebe172d4bf61aa4fe4f58b0a commit e018265679389cfcebe172d4bf61aa4fe4f58b0a Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2024-10-09 10:04:36 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2024-10-14 10:25:58 +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 --- 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 ,