From nobody Tue May 19 10:09:45 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 4gKVlf4S96z6dxFn for ; Tue, 19 May 2026 10:09:50 +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 4gKVlf3FCnz44m7 for ; Tue, 19 May 2026 10:09:50 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1779185390; 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=9AUazWR0y9HV0IA2Y3LOsdVKMSM0gesXavOlLvcasCw=; b=jhYIcFS1hzNqoMTQICP5lf16Z1prEMUXt7k++Qu/p0jskl5OcTtPB8KkIUntnt6jyYhecE v1ZYORtt7jf0CJnKNVzisqcJ2NLHM0GzvI4cvMnCmoY5JDJxUO8rHLN1r9CGyBrBSiQtBP 9dkhV8GlD/U7xTBkovoszVla5IWBOK6XV/UGbPD0/hU5YgZLC8FBMAAvIzyQ2MVty5CMUu tNBiVcQ28Eynko+fVkTvNzGOOYvhdrpc11Bj/IYcGhx5oqUHQxz6/bRg3H4LaB86GBfFxG 2ZjyL6gqkXBcuuKaQdPPSC94rXK6KZ/5vw9W1Ba9/2a4N1VUbkVungpfGayr0A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1779185390; a=rsa-sha256; cv=none; b=LrawEtTJz4q+sIwY1YkIiTzSL6q30Xf2zUiQ9sAXJoyHNSzrnMddPeu+r6s0UoB9+b4+t0 irT+0fasfZi9rhw9MWBkE6RQ8t4oHKbQQCm1biEtll4zBStCv85OlEa+HN0KYZcYC0gVt7 i2x/zfGUux8TZqxQq2aF510rp50L7hp8bfAFzWD2XoVcKPufoFEd9IcilrjHVOf+SbyUON XmdXy0Bov65rFAvNiVqDHm/+/1z1ROtWpCXDALRHNAougJXD/3CQI+T1GCNIZT7z8DNsfm 4RRqc7AldDDAQwlMXXCDm+dYfBl1KIiBoRmndUd0iJN1M1ZrgQ8Lr1+Ql2ZWTg== 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=1779185390; 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=9AUazWR0y9HV0IA2Y3LOsdVKMSM0gesXavOlLvcasCw=; b=C53k3cZ0xdZv6vB4ll/ASq6Nqj5iKWKXBd+IQFVjZkJ1eRhTcKcdFetgOHkFWTrOe+Eetu s97+6y6HW7AKYBm2Jo8YkdLlUaxNrkx/qm7lDCCjXagdcpmzVpNrHQW/bwC/mxoTTCVyYE 7EZbvgxMHwnAsA9nZ8/YuOrU3mk6Ffj5atszePFfIk/RLBGYY3+eXDS6NAr3970ZlqfgtP VPOeu/dZqNVhDWkjyEtsThbbNdb5JOmHhBSJx4lZZ8LvsLyc8BNjydujecO623JlWBaNYF b2EDqMv2KbcHmYIzrvoAI+fVtZhsMUdVVPpX8P4SfwCGxybtXz7AFOdSMBjfuA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4gKVlf2bvMz18jM for ; Tue, 19 May 2026 10:09:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 18cf8 by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Tue, 19 May 2026 10:09:45 +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: 94ab5b7a7c79 - stable/15 - 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/stable/15 X-Git-Reftype: branch X-Git-Commit: 94ab5b7a7c799df8614f566b30d0c20213e5c1bb Auto-Submitted: auto-generated Date: Tue, 19 May 2026 10:09:45 +0000 Message-Id: <6a0c36e9.18cf8.4a4b1cb4@gitrepo.freebsd.org> The branch stable/15 has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=94ab5b7a7c799df8614f566b30d0c20213e5c1bb commit 94ab5b7a7c799df8614f566b30d0c20213e5c1bb Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2025-07-17 20:55:49 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2026-05-19 10:09:41 +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 (cherry picked from commit 03bc95b060a91ed9d410270d00d1dd4f8edcdcc7) --- 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 34d7f7d32394..da99a288b231 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 @@ -1297,6 +1297,7 @@ in .Xr dwatch 1 , .Xr dtrace_audit 4 , .Xr dtrace_callout_execute 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 d81a6064c171..267703cc6bb9 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1009,6 +1009,7 @@ _ccd.4= ccd.4 .if ${MK_CDDL} != "no" _dtrace_provs= dtrace_audit.4 \ dtrace_callout_execute.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 ,