From nobody Tue Nov 04 11:12:53 2025 X-Original-To: dev-commits-src-main@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 4d15Qt1XHJz6FsS4; Tue, 04 Nov 2025 11:12:54 +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 4d15Qt0cF3z3fQn; Tue, 04 Nov 2025 11:12:54 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762254774; 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=FLKgaSX+juTeF63HDkJxpGyUVxSLotG869IuzsUjTDY=; b=FJwO14JMYdXKL6ja0AzfqQIzep+CdVheVWQHIyc/t56vCFw/qtjIrOsW8ht89zvNEQfR3I 0kokFwOXhS65JhQk0c7BCD1d7WtKMp1qHoUrR/jJQYcQD2epLa1ZB2vx65h4QIgRHJ+uPB 4Kyc+BWLiYZwhKhc3Hd64hN/6KS/dPEOl8IvLfNKbbaRiV3UGLhpGzsYl5hbqtdB6JayQJ x6EAUoCps2P1wG+VzqiY/sEielPvyKbOIVIWzRkOw+xHuIgIFl+ikAm7t88Q2yXDOtrceQ r0vHJA4tkB3fZl/CmCw3PgC2zcCiqVc/VtHEUWV6vPeB4r6Rlrjzxcptr3vUAw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762254774; 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=FLKgaSX+juTeF63HDkJxpGyUVxSLotG869IuzsUjTDY=; b=hGVfJsls4P4O/PbYOJpDq60GaLxMeM0fBYEvOV8F/aznHLwpiB+C739jo0joOqln+J5EsH bZb2m52XT3JatiVSSnVGa62/2ofx+/jpLkTv7OQ2C31j2bM5tnhkGp77VZgNTCa0VmiLvJ PdjUL+/7VIVilkm7Ob+SuHMECN/ITahHiMicEBCIzFkcGcYygnW0llobwjJ+nQGvvWV6x3 XYDgOvQ4J2F7OsBuYz2+cXKFj+KGEw+CFrzkx6M6udVsKVX/zdDkPYdBXjyRzVltgiaN96 dXRFIBdkFXvxzVnc+fpcsKkoUe8bvUvDUOgL0ZzFTO6CrytViIYVBvvJuENG4Q== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1762254774; a=rsa-sha256; cv=none; b=M4PqYrLEWpZnkWQ9eZqjbTYHDY1EaYXR53GwX/g5Cc+WMdUr++EKEgq+PjIzQEDboz1jB7 IbBiMYakLdxiMo8qEE8iDRUNmcMxnePHKLz1hi5HO45R1bpxJDMBxJXYg4e7gUqPmugvvJ QMVpjpTmoNEROoa08U4mRbg3WSL0o6ryJZx/CF6eFwOYXMLXJnyY4BRkJ7n70o9arF7G3n TkPm3Jg/CQ4RfUdIJADWVFoKXlxvrOcF83glMqygJ+9DojVtNR3v44Ur/8U8rhdQHw1k83 0ysBkuMKESFH6D5wN8Sfyhope/xQczyD+Lm2tCKIeVLmHEhtyU0TVKbkknwd1A== 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 4d15Qt0C9vzvSd; Tue, 04 Nov 2025 11:12:54 +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 5A4BCr0n026650; Tue, 4 Nov 2025 11:12:53 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 5A4BCrew026647; Tue, 4 Nov 2025 11:12:53 GMT (envelope-from git) Date: Tue, 4 Nov 2025 11:12:53 GMT Message-Id: <202511041112.5A4BCrew026647@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: 3ccb2d9513e6 - main - dtrace_callout_execute.4: Document the DTrace callout_execute provider List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@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: 3ccb2d9513e6a2e046e635c186da68acf8f8498b Auto-Submitted: auto-generated The branch main has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=3ccb2d9513e6a2e046e635c186da68acf8f8498b commit 3ccb2d9513e6a2e046e635c186da68acf8f8498b Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2025-11-04 11:10:55 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2025-11-04 11:10:55 +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 --- cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 | 3 +- share/man/man4/Makefile | 1 + share/man/man4/dtrace_callout_execute.4 | 68 ++++++++++++++++++++++++++++ share/man/man9/callout.9 | 4 +- 4 files changed, 74 insertions(+), 2 deletions(-) diff --git a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 index f09cbe1ac27b..456a9e319987 100644 --- a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 +++ b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 @@ -20,7 +20,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 3, 2025 +.Dd November 4, 2025 .Dt DTRACE 1 .Os .Sh NAME @@ -1292,6 +1292,7 @@ in .Xr cpp 1 , .Xr dwatch 1 , .Xr dtrace_audit 4 , +.Xr dtrace_callout_execute 4 , .Xr dtrace_dtrace 4 , .Xr dtrace_fbt 4 , .Xr dtrace_io 4 , diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 95618227a010..34edf6ad455d 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1005,6 +1005,7 @@ _ccd.4= ccd.4 .if ${MK_CDDL} != "no" _dtrace_provs= dtrace_audit.4 \ + dtrace_callout_execute.4 \ dtrace_dtrace.4 \ dtrace_fbt.4 \ dtrace_io.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 0e59ef8ab2b1..637049ec1ef5 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 January 22, 2024 +.Dd November 4, 2025 .Dt CALLOUT 9 .Os .Sh NAME @@ -789,6 +789,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