From nobody Wed May 01 18:43:55 2024 X-Original-To: dev-commits-doc-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 4VV5Z32fRdz5JrhD for ; Wed, 1 May 2024 18:43:55 +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 "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4VV5Z3291vz4XZf; Wed, 1 May 2024 18:43:55 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1714589035; 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=AM8jxVbzINiHk1E3Kh6TM9/0KjdJAfBpq6Q3pACt3Zg=; b=KBS1NnH/fnZTz6lXo9kzUWs5PxzF5DeDcuNbhaAhRj44/9rmU2adY7NNH2XGbZRg2GyNMD YmeEctoQKMS3P+XQOn3fjfzvKGszrWLuxhzj/YHYQE5h7e4Q8+UIrcnp3LKrqaISlvEWV8 i8RLJq2eF4FNeNvzu8pBHCsTzwrpZND7qd4wArZTicHWamBvx+Ulh7NIZ4feCdB72EUfrx iljFgC6zhLIITxBvjmZ9Txo1CEEptlg14lgSX297RUfpH3li2g41PIiYnxoxIRjWJIGWaC P4IXkJXFi+4+ah/d2PnpCGk7qpJfPTuH3YRa/l7mGVR35nx5Mt91UjZfoKz9Rw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1714589035; a=rsa-sha256; cv=none; b=jUoEyXkfE+OMwppdnajmWHM2OfAQrhmjhdTxWX1VFQP6DyGc2vCwztI4sc8EJzRR8swd9V 2k0dWWH2M4YJ/Ah1wCICa87vS+05maale75Paraod6TjIXexezU6Z9TzGAQ6/7JfzdP5kN KCvVE+20YcgGu2M+ztiHkq17Y3oT0GAuVIlRM4C7S3K6J8QNgF2BpSQBo7WM35JXTe5rE/ qAmTDUEnFhxs1fcB8LyZa9vNiwRU8JY3ExpYHQECdJMcmvZ+A/TvLBRzD9y+BMfGwTIOSo w863BLHVEoRlBykgaTyqDM5VonNQwFBTMNylyFnqzm03HeYYulh67toCsP4Yiw== 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=1714589035; 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=AM8jxVbzINiHk1E3Kh6TM9/0KjdJAfBpq6Q3pACt3Zg=; b=hJuScvUT2Rx6Wv+97UrF+z9p2JYcm1GrZYFBjUKhnDQz8Txdy6hE8y3HXibHkgiA57hmqC hQqoYHrhjaPw7AMIdKw0ktO2Y9W/LxncBvi3N4GzGrFArNtgvD06JyYI+t/9N9md0mOuV9 0Cd3u8stzPntW8Yu37UmfWPQwqcWQhyCeIuoAgg2b0Ed7wGip/cHzfVyTmhblzRV0Dx9K3 iqaOnRqgGEaiMNwFL/H189PAnYfbtgmcEmmGFM3c14bR1Jj1cyiXMiDPjnwu85ZNV5K9Ug uhnA1cG1OZl2IJSEPCfHtTOZUAEds7rNuR9AthxOg4EJfrbR9c3ethVhNQTAJw== 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 4VV5Z31mV2zWP8; Wed, 1 May 2024 18:43:55 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 441IhtfS081439; Wed, 1 May 2024 18:43:55 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 441IhtlP081436; Wed, 1 May 2024 18:43:55 GMT (envelope-from git) Date: Wed, 1 May 2024 18:43:55 GMT Message-Id: <202405011843.441IhtlP081436@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: "Danilo G. Baio" Subject: git: d80ad7dabb - main - handbook/dtrace: Add Out-of-Kernel Modules info List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: dbaio X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: d80ad7dabb8d9fe4afae3186c691bc86e751045a Auto-Submitted: auto-generated The branch main has been updated by dbaio: URL: https://cgit.FreeBSD.org/doc/commit/?id=d80ad7dabb8d9fe4afae3186c691bc86e751045a commit d80ad7dabb8d9fe4afae3186c691bc86e751045a Author: Danilo G. Baio AuthorDate: 2024-05-01 18:41:50 +0000 Commit: Danilo G. Baio CommitDate: 2024-05-01 18:41:50 +0000 handbook/dtrace: Add Out-of-Kernel Modules info Reviewed by: gnn --- documentation/content/en/books/handbook/dtrace/_index.adoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/documentation/content/en/books/handbook/dtrace/_index.adoc b/documentation/content/en/books/handbook/dtrace/_index.adoc index cf6e5e1c42..797d27606c 100644 --- a/documentation/content/en/books/handbook/dtrace/_index.adoc +++ b/documentation/content/en/books/handbook/dtrace/_index.adoc @@ -153,6 +153,19 @@ This language is called the D language and it is very similar to C++. An in depth discussion of the language is beyond the scope of this document. It is covered extensively in the http://www.dtrace.org/guide[Illumos Dynamic Tracing Guide]. +[[dtrace-out-of-kernel]] +== Enabling DTrace in Out-of-Kernel Modules + +To add DTrace support to an out-of-kernel module, which is useful for development and debugging, include the following line in the module's Makefile: + +[.programlisting] +.... +CFLAGS+= -DKDTRACE_HOOKS +.... + +This flag enables DTrace hooks during compilation, allowing for advanced debugging and monitoring of the module. +Ensure to recompile the module after this modification to activate DTrace functionality. + [[dtrace-using]] == Using DTrace