From nobody Mon Nov 10 09:48:22 2025 X-Original-To: dev-commits-src-branches@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 4d4lGb09pSz6GTQX; Mon, 10 Nov 2025 09:48:23 +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 "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4d4lGZ2Pgtz3LYQ; Mon, 10 Nov 2025 09:48:22 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762768102; 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=t4AMfzebPBydvPd1uEFq7ziHyYtRuOxATeVkYsy3Kyk=; b=h2dF/B9aZFInuSiOFPsRQnop1C/rKgiKdp0ZgPnOAASAMjOxr4MButO1NjH56t68UUie++ kMXYaOPCeq4crO3Ak7QI5zE83zMGANAJiFXJh8ys888flmWM13KUkkWnCtdfuR+1Cpl6LL zmmRpoXOvfmQ6KHiWhgJC0Mc01sRA/lRtznHmZsSkeoMAmm19Y10o5GjppFe7CbqPgTZrX aSY3LhWMPzNLM+XYrhy0g5PrRi66u+59UXFIwrF80ypoMFIsH1yeJQ4RSQ3V7eqjVOHDox eu3AjSLcrZuLxjPIKSfWye1aWo14Zw3Jcf6HtQOG25ybNUZZyCkYLskCbf5+Cw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762768102; 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=t4AMfzebPBydvPd1uEFq7ziHyYtRuOxATeVkYsy3Kyk=; b=dE1AB96l3bfOmpMhvXaBuYLfrZEWBqE7EFXWOTeWOLsjcuoPGdhzjkp3YCnkpW7QcMPBpV QcabumjVhRc5wR8wzqzkdbDJsIxpALg9c6eS0taPmolG42al9JxmYsjCxw6Vzl5UtXjSrh HMDPgs4FXLdKmcZSFqfD5f+A7ahpLQ0zkvvFcFrwZgUzci+wYFzoZEDxtvAFbCntUT8fJ/ gUIjfJao/m2nfxLYJUztr7nth7STU2jW7jZ/xxzy/naO1CjG+Xz9m6u7FVh69dcqEFyu50 2SuYG7BXT4WZMi6bnTc2+Pp6SwmuZpr6RTBtLj7uquyA4ZRKrdx9wT1F+EfYyw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1762768102; a=rsa-sha256; cv=none; b=JspoumsL39m8dghge7mY/Tth0xGo7x6WSKWty2bctfnCKPHm4DgPqBSB4+io1THp2OCZ9/ F2lmOSBc1qAylYo83Ef+G6sCHhodYtG1KLKpB9uRQcxRBljk8/yAcVIU1sRgM1eH+45+oC Rzw/hfzSlKR6mdGs7r3Kg3NmU3cUD0HurW5GCrjYAY2CtEpLtpJ+LExRBr5mMMmtSJmT4d bbqwsHtLAIoje1H8koVo3lC06cSwpsOiCqWHGkEQWvRSmAs60Ji8O3wsU+tW86IvmhLzkF C9Jwi0hQRkcWYKIW24iqu+RgRMrDuMwUjgoohGVxSnaYMPNSEp4HWBrmZipW6g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4d4lGZ1rFGz1C0y; Mon, 10 Nov 2025 09:48:22 +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 5AA9mMZS060532; Mon, 10 Nov 2025 09:48:22 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 5AA9mM7t060529; Mon, 10 Nov 2025 09:48:22 GMT (envelope-from git) Date: Mon, 10 Nov 2025 09:48:22 GMT Message-Id: <202511100948.5AA9mM7t060529@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: 1b5d2fc026d3 - stable/13 - dtrace_vfs.4: Document the DTrace vfs provider List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@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: 1b5d2fc026d35d96ac65995e32cfef9e968f9a99 Auto-Submitted: auto-generated The branch stable/13 has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=1b5d2fc026d35d96ac65995e32cfef9e968f9a99 commit 1b5d2fc026d35d96ac65995e32cfef9e968f9a99 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2025-11-03 15:54:10 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2025-11-10 09:48:14 +0000 dtrace_vfs.4: Document the DTrace vfs provider Reviewed by: bcr MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D51317 (cherry picked from commit 2020e76450e2705d33d673a3d183c8f0a3910e28) --- cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 | 3 +- share/man/man4/Makefile | 3 +- share/man/man4/dtrace_vfs.4 | 97 ++++++++++++++++++++++++++++ share/man/man9/VFS.9 | 3 +- 4 files changed, 103 insertions(+), 3 deletions(-) diff --git a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 index 7b80435c03e0..121c87323eba 100644 --- a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 +++ b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 @@ -20,7 +20,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 30, 2025 +.Dd November 3, 2025 .Dt DTRACE 1 .Os .Sh NAME @@ -885,6 +885,7 @@ in .Xr dtrace_tcp 4 , .Xr dtrace_udp 4 , .Xr dtrace_udplite 4 , +.Xr dtrace_vfs 4 , .Xr elf 5 , .Xr SDT 9 .Rs diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 5f576c391086..332670598905 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -969,7 +969,8 @@ _dtrace_provs= dtrace_audit.4 \ dtrace_sctp.4 \ dtrace_tcp.4 \ dtrace_udp.4 \ - dtrace_udplite.4 + dtrace_udplite.4 \ + dtrace_vfs.4 MLINKS+= dtrace_audit.4 dtaudit.4 .endif diff --git a/share/man/man4/dtrace_vfs.4 b/share/man/man4/dtrace_vfs.4 new file mode 100644 index 000000000000..528d5da42f3d --- /dev/null +++ b/share/man/man4/dtrace_vfs.4 @@ -0,0 +1,97 @@ +.\" +.\" Copyright (c) 2025 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.Dd November 3, 2025 +.Dt DTRACE_VFS 4 +.Os +.Sh NAME +.Nm dtrace_vfs +.Nd a DTrace provider for Virtual File System +.Sh SYNOPSIS +.Sm off +.Nm vfs Cm : fplookup : Ar function Cm : Ar name +.Nm vfs Cm : namecache : Ar function Cm : Ar name +.Nm vfs Cm : namei : Ar function Cm : Ar name +.Nm vfs Cm : vop : Ar function Cm : Ar name +.Sm on +.Sh DESCRIPTION +The DTrace +.Nm vfs +provider allows users to trace events in the +.Xr VFS 9 +layer, the kernel interface for file systems on +.Fx . +.Pp +Run +.Ql dtrace -l -P vfs +to list all +.Nm vfs +probes. +Add +.Fl v +to generate program stability reports, +which contain information about the number of probe arguments and their types. +.Pp +The +.Cm fplookup +module defines a single probe, +.Fn vfs:fplookup:lookup:done "struct nameidata *ndp" "int line" "bool status_code" , +that instruments the fast path lookup code in +.Xr VFS 9 . +.Pp +The +.Cm namecache +module provides probes related to the +.Xr VFS 9 +cache. +Consult the source code in +.Pa src/sys/kern/vfs_cache.c +for more details. +.Pp +The +.Cm namei +module manages probes related to pathname translation and lookup operations. +Refer to +.Xr namei 9 +to learn more. +.Pp +The +.Cm vop +module contains probes related to the functions responsible for +.Xr vnode 9 +operations. +.Sh COMPATIBILITY +This provider is specific to +.Fx . +.Sh EXAMPLES +Check what lookups failed to be handled in a lockless manner: +.Bd -literal -offset 2n +# dtrace -n 'vfs:fplookup:lookup:done { @[arg1, arg2] = count(); }' +.Ed +.Sh SEE ALSO +.Xr dtrace 1 , +.Xr d 7 , +.Xr SDT 9 , +.Xr namei 9 , +.Xr VFS 9 +.Rs +.%A Brendan Gregg +.%A Jim Mauro +.%B DTrace: Dynamic Tracing in Oracle Solaris, Mac OS X and FreeBSD +.%I Prentice Hall +.%P pp. 335\(en351 +.%D 2011 +.%U https://www.brendangregg.com/dtracebook/ +.Re +.Sh AUTHORS +.An -nosplit +The +.Fx +.Nm vfs +provider was written by +.An Robert Watson Aq Mt rwatson@FreeBSD.org . +.Pp +This manual page was written by +.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org . diff --git a/share/man/man9/VFS.9 b/share/man/man9/VFS.9 index a269d8d070cf..fcb07afa478d 100644 --- a/share/man/man9/VFS.9 +++ b/share/man/man9/VFS.9 @@ -26,7 +26,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 9, 2010 +.Dd November 3, 2025 .Dt VFS 9 .Os .Sh NAME @@ -42,6 +42,7 @@ function from rather than implementing empty functions or casting to .Fa eopnotsupp . .Sh SEE ALSO +.Xr dtrace_vfs 4 , .Xr VFS_CHECKEXP 9 , .Xr VFS_FHTOVP 9 , .Xr VFS_INIT 9 ,