From nobody Tue May 12 18:12:09 2026 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 4gFPnP6DJrz6crHS for ; Tue, 12 May 2026 18:12:09 +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 "R13" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4gFPnP54tFz3H5M for ; Tue, 12 May 2026 18:12:09 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1778609529; 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=R74bwGvD1oS5FxUcA3n3s2tiS/rgNXcExiB7+6iCfvg=; b=rWeh0MDasl3KvRrazZbyjpZsaKbDQuz0vAMNw88Lu9DVgyq8exxGAQp6lHwZsE5RgfWvh7 dAvOI4TdotRX4EqElzmOuOnT/dJqDCwe23pyHqx1Z4Fg96zwOotLFMAy7YFFVZcqow77X6 ym9t4fgziZTlmtWDlcqtme0HSN2/oDnG6o6cw5dh2hC7gF1GpJVxf0eiTztb+3YQ+BAaHZ ZzAeQIFJMrekjYHyIPIT3CuDXZcqo3mc9FszeM4ExkOc4nEnzHjQVBSJKjeF/3uAjnkUZy HjE4q6oJcyAvYbfeXoo7nrqiTGekDDtajumjxELVuYs026idY6krgK4/AP4V8w== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1778609529; a=rsa-sha256; cv=none; b=UzRkJpsKr1r2+WoRzYw1VFxaz9osIaI0pYQqh90uI/avLe9E4ntV0Yvw+4kO/ytmxD9ZUJ gdWhWbgI/syz9FG+KTzah8+f3H0MFINZJRb+P1iCS0Iv0AYEZtGxykvLmZXs+2eqfB9H46 7ep8Bb8oAxf8rVJS4ez4IaKq5xU4qxmdHIpfWeFH5zAp1BUmOXNKM/4WR8PoMYiVeM42Zm YXCA+ToBUx02Q0x8U2Pgw2xZfqbmQkXge9RWVro3gZbRXc36YpZZH6Qp+XNtVfyCy1ksBs RbVhuLo1lNPqKmjCQwOItgp7Tu3sSRGdq7fnlmRldI90jLE5yyo5FJd8PnrEBQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1778609529; 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=R74bwGvD1oS5FxUcA3n3s2tiS/rgNXcExiB7+6iCfvg=; b=UR1VuvSNlOxqMch6UxuskBdInwhbE+ULW/gyyiwMe9FvipZ2NI8nrcGZC1gcIduQKjMGlW YFwndcj6afEHWo8vSChNReP5sJQd4XfhByF3vxtT1rQabIjRs9/0W7ACb/EYMH9+zQVWyA 7l7n4irl4i65KRNqflOeYVn7nsjR/MizQMEz+EBre75ymDSFWWmVQhfV7YgYbULzG/pZda JP3B3uOR8O4Z/c/iO0rXLcJGIhqD8bfz+aZEzK7yGdBI7g6y508UHqccFl0mCLPCfALmPP qQD3BN3GzxgUDetebV9M5otT3fKtlbhw5tP6rRKFZItArXhG4XRpgEyHKXNgOg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4gFPnP4YTcz9X for ; Tue, 12 May 2026 18:12:09 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 45867 by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Tue, 12 May 2026 18:12:09 +0000 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: 03bc95b060a9 - main - dtrace_dtmalloc.4: Document the DTrace dtmalloc provider 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 List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list 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: 03bc95b060a91ed9d410270d00d1dd4f8edcdcc7 Auto-Submitted: auto-generated Date: Tue, 12 May 2026 18:12:09 +0000 Message-Id: <6a036d79.45867.754c40cd@gitrepo.freebsd.org> The branch main has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=03bc95b060a91ed9d410270d00d1dd4f8edcdcc7 commit 03bc95b060a91ed9d410270d00d1dd4f8edcdcc7 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2025-07-17 20:55:49 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2026-05-12 18:03:11 +0000 dtrace_dtmalloc.4: Document the DTrace dtmalloc provider MFC after: 1 week Discussed with: christos, markj, ziaee Differential Revision: https://reviews.freebsd.org/D51396 --- cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 | 3 +- share/man/man4/Makefile | 1 + share/man/man4/dtrace_dtmalloc.4 | 132 +++++++++++++++++++++++++++ share/man/man9/malloc.9 | 3 +- 4 files changed, 137 insertions(+), 2 deletions(-) diff --git a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 index e78b6e1875ae..ad639f337a72 100644 --- a/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 +++ b/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 @@ -20,7 +20,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 7, 2026 +.Dd May 12, 2026 .Dt DTRACE 1 .Os .Sh NAME @@ -1298,6 +1298,7 @@ in .Xr dtrace_audit 4 , .Xr dtrace_callout_execute 4 , .Xr dtrace_cam 4 , +.Xr dtrace_dtmalloc 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 b9c441e97597..4f067f3ef757 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1017,6 +1017,7 @@ _ccd.4= ccd.4 _dtrace_provs= dtrace_audit.4 \ dtrace_callout_execute.4 \ dtrace_cam.4 \ + dtrace_dtmalloc.4 \ dtrace_dtrace.4 \ dtrace_fbt.4 \ dtrace_io.4 \ diff --git a/share/man/man4/dtrace_dtmalloc.4 b/share/man/man4/dtrace_dtmalloc.4 new file mode 100644 index 000000000000..97b4ffd8a057 --- /dev/null +++ b/share/man/man4/dtrace_dtmalloc.4 @@ -0,0 +1,132 @@ +.\" +.\" Copyright (c) 2025-2026 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.Dd May 12, 2026 +.Dt DTRACE_DTMALLOC 4 +.Os +.Sh NAME +.Nm dtrace_dtmalloc +.Nd a DTrace provider for tracing kernel memory allocations by type +.Sh SYNOPSIS +.Nm dtmalloc Ns Cm :: Ns Ar function Ns Cm :malloc +.Nm dtmalloc Ns Cm :: Ns Ar function Ns Cm :free +.Sh DESCRIPTION +The +.Nm dtmalloc +provider instruments +.Xr malloc 9 +and +.Xr free 9 +kernel functions to trace memory allocations by type. +Refer to +.Xr malloc 9 +for more details about malloc types. +.Pp +The +.Nm dtmalloc Ns Cm :: Ns Ar function Ns Cm :malloc +probe fires upon a successful allocation. +Its probe arguments are: +.Bl -column -offset indent "malloc Probe Argument" "Definition" +.It Sy Probe Argument Ta Sy Definition +.It Fa args[0] Ta Ft struct malloc_type *mtp +.It Fa args[1] Ta Ft struct malloc_type_internal *mtip +.It Fa args[2] Ta Ft struct malloc_type_stats *mtsp +.It Fa args[3] Ta Ft unsigned long size +.It Fa args[4] Ta Ft int zindx +.El +.Pp +The +.Nm dtmalloc Ns Cm :: Ns Ar function Ns Cm :free +probe fires upon a free operation. +Its probe arguments are: +.Bl -column -offset indent "free Probe Argument" "Definition" +.It Sy free Probe Argument Ta Sy Definition +.It Fa args[0] Ta Ft struct malloc_type *mtp +.It Fa args[1] Ta Ft struct malloc_type_internal *mtip +.It Fa args[2] Ta Ft struct malloc_type_stats *mtsp +.It Fa args[3] Ta Ft unsigned long size +.It Fa args[4] Ta Always 0 +.El +.Pp +The first three arguments for each probe +.Po i.e., +.Fa mtp , mtip , +and +.Fa mtsp Pc +provide references to the +.Xr malloc 9 +type internals; +.Fa size +is the size of the allocation; +.Fa zindx +is the index into the +.Va kmemzones[] +array used for the allocation. +In practice, +.Fa size +is the most useful parameter to trace. +.Sh IMPLEMENTATION NOTES +The +.Ar function +part of the probe description in the +.Nm dtmalloc +provider is the +.Xr malloc 9 +type short description with all whitespace characters replaced +with underscores. +For example, a malloc type defined by +.Bd -literal -offset indent +MALLOC_DEFINE(M_FOO_BAR, "foo bar", "FooBar subsystem"); +.Ed +.Pp +will have probes called +.Bd -literal -offset indent +dtmalloc::foo_bar: +.Ed +.Sh FILES +.Bl -tag -width "" +.It In sys/malloc.h +The header where +.Vt struct malloc_type +is defined. +.El +.Sh EXAMPLES +.Ss Example 1 : Counting Successful Memory Allocations by Type +.Bd -literal -offset 2n +# dtrace -n 'dtmalloc:::malloc {@[stringof args[0]->ks_shortdesc] = count()}' +dtrace: description 'dtmalloc:::malloc ' matched 480 probes +^C + 80211node 1 + CAM CCB 1 + CAM periph 1 + ioctlops 1 + netlink 1 + soname 4 + sysctltmp 4 + solaris 5 + acpica 16 + temp 36 + lkpikmalloc 44 + iov 100 + selfd 648 +.Ed +.Sh SEE ALSO +.Xr dtrace 1 , +.Xr tracing 7 , +.Xr malloc 9 +.Sh AUTHORS +.An -nosplit +.Nm +was written by +.An John Birrell Aq Mt jb@FreeBSD.org . +.Pp +This manual page was written by +.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org . +.Sh CAVEATS +The +.Nm dtmalloc +provider does not trace +.Xr uma 9 +allocations. diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index 06f5ed4ef360..269a766e6168 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -28,7 +28,7 @@ .\" .\" $NetBSD: malloc.9,v 1.3 1996/11/11 00:05:11 lukem Exp $ .\" -.Dd August 4, 2024 +.Dd May 12, 2026 .Dt MALLOC 9 .Os .Sh NAME @@ -394,6 +394,7 @@ functions. Failing consistency checks will cause a panic or a system console message. .Sh SEE ALSO +.Xr dtrace_dtmalloc 4 , .Xr numa 4 , .Xr vmstat 8 , .Xr contigmalloc 9 ,