From nobody Tue Nov 18 13:36:00 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 4d9lxX6X87z6H8Tk for ; Tue, 18 Nov 2025 13:36:00 +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 4d9lxX1L7Dz3mWl for ; Tue, 18 Nov 2025 13:36:00 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1763472960; 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=/UgJ+6nW3FDC6cKFGmKpjhgqIkYcQRzSCuBjFSkIOKI=; b=MGDgsJUs6CJ0U9l05mYYlD88QHBBGWjMlDxqigd3dfeFZIuYMuDgtQ9XF2FY0DNCMd5jTV Pd8Sid7ny17GLJQAqcZ4meN5jSg67Xg6aJX191EbEnVZddwjXIvSAC/Z+gsjVwE0mRodww yEKt04b862XJaAac7tNnd4RAhoI5V6CdMylGfODjMr7ZY/uaB71JyJSSmRPJ8YVkgSgwxc gQHwMXnNmYurcM1CrrVHijYefhpOWBNNfXTSN7jWxhPiaR49DADfUI9c/NdJi/Xi6y82nj AVu72zqKJIhvYg8hACakhDsCV25HGBx4BCkt6sY0ep0F0BQC1ek6WG2UkzMZVA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1763472960; 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=/UgJ+6nW3FDC6cKFGmKpjhgqIkYcQRzSCuBjFSkIOKI=; b=q6SFghI8pBjxPF/2UEqFlVu3HjPhwbP+o2Bc0m4olxisYnm5L0kARdEU814igWRbsJheUg F+XybrSTQMQ92HvRzH0s66lQ/E4zURsgs75QAhJ6r5JcJNtb7G3XjZiotP21+oPly3ztvL 1qsEAF3IogULSAY859tuel0EGdulxpk2czJQ7o8675PKfoJBF6Ihue3qt/uQxAsYGEkXBb tganM/joHrV7RL7U+dZlft6yGwAVGOlR/wDgLDQkURO9s4brdI5x2FXGVkR/ebKxpnu6Zl lsgGWGe31wHm6JAUqpG4oXcK5F6gciTs0ViAVBrCyVICdYiV4n514KzByBijng== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1763472960; a=rsa-sha256; cv=none; b=iq9sj+QaSsprfxtjflccNa+MX1o1JpN5OshkeQp4KwJH1KB8N6q3mzO3ZM26bwM04sC3GR ThhLmSgymgF/UfDM60Vx3t7VRKEdOiabw/4+SANqVviN6alvd1R7OntKFo+/wz7a6BHtRh 1nb8frlwSmVgjT8sKLOArtd/9b5FKz3SsHOEpgkCEe+e9Yo5zDkEXuKlIpLwn2TDk83dN5 7/2VV7kmFqE2FFgXzv2i1hxr+63HWP/yPUfScy2Yu3dLrsxtm1I6nqu8zVHByq1VqnZrFR eMxraBjeJ2N3R5XmRPByH/TTBsIv6zQmMB8vU+7YZbBXzsjlwX3LtFG1QkjwhA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4d9lxX0pJQzwpQ for ; Tue, 18 Nov 2025 13:36:00 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 2f41b by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Tue, 18 Nov 2025 13:36:00 +0000 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: 7d43404485bf - stable/14 - dtrace_callout_execute.4: Document the DTrace callout_execute 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/14 X-Git-Reftype: branch X-Git-Commit: 7d43404485bf2e306e54bdfdb0ae937d6921df39 Auto-Submitted: auto-generated Date: Tue, 18 Nov 2025 13:36:00 +0000 Message-Id: <691c7640.2f41b.3f5c6a9d@gitrepo.freebsd.org> The branch stable/14 has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=7d43404485bf2e306e54bdfdb0ae937d6921df39 commit 7d43404485bf2e306e54bdfdb0ae937d6921df39 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2025-11-04 11:10:55 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2025-11-18 13:35:54 +0000 dtrace_callout_execute.4: Document the DTrace callout_execute provider MFC after: 2 weeks Fixes: 91dd9aae1ab8 Add explicit static DTrace tracing to the callout mechanism Differential Revision: https://reviews.freebsd.org/D51397 (cherry picked from commit 3ccb2d9513e6a2e046e635c186da68acf8f8498b) --- cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 | 1 + share/man/man4/Makefile | 1 + share/man/man4/dtrace_callout_execute.4 | 68 ++++++++++++++++++++++++++++ share/man/man9/callout.9 | 4 +- 4 files changed, 73 insertions(+), 1 deletion(-) diff --git a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 index 68b3a7f5f9bc..ce01b2c4c017 100644 --- a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 +++ b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 @@ -1299,6 +1299,7 @@ in .Sh SEE ALSO .Xr cpp 1 , .Xr dtrace_audit 4 , +.Xr dtrace_callout_execute 4 , .Xr dtrace_fbt 4 , .Xr dtrace_io 4 , .Xr dtrace_ip 4 , diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 627ca85d1fff..2dda6b937dc2 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -939,6 +939,7 @@ _ccd.4= ccd.4 .if ${MK_CDDL} != "no" _dtrace_provs= dtrace_audit.4 \ + dtrace_callout_execute.4 \ dtrace_fbt.4 \ dtrace_io.4 \ dtrace_ip.4 \ diff --git a/share/man/man4/dtrace_callout_execute.4 b/share/man/man4/dtrace_callout_execute.4 new file mode 100644 index 000000000000..1154ed066b97 --- /dev/null +++ b/share/man/man4/dtrace_callout_execute.4 @@ -0,0 +1,68 @@ +.\" +.\" Copyright (c) 2025 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.Dd November 4, 2025 +.Dt DTRACE_CALLOUT_EXECUTE 4 +.Os +.Sh NAME +.Nm dtrace_callout_execute +.Nd a DTrace provider for the callout API +.Sh SYNOPSIS +.Nm callout_execute Ns Cm :kernel::callout_start +.Nm callout_execute Ns Cm :kernel::callout_end +.Sh DESCRIPTION +The +.Nm callout_execute +provider allows for tracing the +.Xr callout 9 +mechanism. +.Pp +The +.Nm callout_execute Ns Cm :kernel::callout_start +probe fires just before a callout. +.Pp +The +.Nm callout_execute Ns Cm :kernel::callout_end +probe fires right after a callout. +.Pp +The only argument to the +.Nm callout_execute +probes, +.Fa args[0] , +is a callout handler +.Ft struct callout * +of the invoked callout. +.Sh EXAMPLES +.Ss Example 1: Graph of Callout Execution Time +The following +.Xr d 7 +script generates a distribution graph of +.Xr callout 9 +execution times: +.Bd -literal -offset 2n +callout_execute:::callout_start +{ + self->cstart = timestamp; +} + +callout_execute:::callout_end +{ + @length = quantize(timestamp - self->cstart); +} +.Ed +.Sh SEE ALSO +.Xr dtrace 1 , +.Xr tracing 7 , +.Xr callout 9 , +.Xr SDT 9 +.Sh AUTHORS +.An -nosplit +The +.Nm callout_execute +provider was written by +.An Robert N. M. 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/callout.9 b/share/man/man9/callout.9 index 96b93283bfc2..97d9f4138742 100644 --- a/share/man/man9/callout.9 +++ b/share/man/man9/callout.9 @@ -27,7 +27,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd September 1, 2021 +.Dd November 4, 2025 .Dt CALLOUT 9 .Os .Sh NAME @@ -816,6 +816,8 @@ and functions return a value of one if the callout was still pending when it was called, a zero if the callout could not be stopped and a negative one is it was either not running or has already completed. +.Sh SEE ALSO +.Xr dtrace_callout_execute 4 .Sh HISTORY .Fx initially used the long standing