From patchwork Thu Dec 9 13:18:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 12666551 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id C9B5CC433F5 for ; Thu, 9 Dec 2021 13:19:29 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id D3FF26B0075; Thu, 9 Dec 2021 08:18:29 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id D2D306B0074; Thu, 9 Dec 2021 08:18:29 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id B56EA6B0078; Thu, 9 Dec 2021 08:18:29 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0119.hostedemail.com [216.40.44.119]) by kanga.kvack.org (Postfix) with ESMTP id A731A6B0074 for ; Thu, 9 Dec 2021 08:18:29 -0500 (EST) Received: from smtpin18.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay03.hostedemail.com (Postfix) with ESMTP id 6CA438248076 for ; Thu, 9 Dec 2021 13:18:19 +0000 (UTC) X-FDA: 78898309518.18.D7339DD Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by imf30.hostedemail.com (Postfix) with ESMTP id B5E5D80003 for ; Thu, 9 Dec 2021 13:18:18 +0000 (UTC) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 9F958B82461; Thu, 9 Dec 2021 13:18:17 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id D78F2C341C3; Thu, 9 Dec 2021 13:18:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1639055896; bh=/ttFN3eSciKNUE5fSV4TMsI/toseuwV9QrzeM0zwrU0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=KpTcUDjvvrtIOZanOTBRCQ+o1lqYG9W3U2hVeDd6SuXDDtkyTFXole99UZi3alFUM VuOthHNIbLiel0ZXwdWPN2eiolX5cRVO9vNkBG94Pr7yKC344oeq935U8mwFP1nE+3 epzZM5FTHYpqVUPTZAAFp78z081PeK78R3WLnx95RNtYtjmDLHd0Gy/Zk/UAXSbpIM rv6W6GSPWyDDnGt9xOEjyNDgfiAEOZhG40LjybR/E2ugNCDdMqrBgjUAzv/JkRxG2q 92wBuHA9yMgNFGb051/Fl0uitxzWyAtdoWk6VLVBqsm5UUyOVl2Kw9fKaa5Ik+7BaW 0BtpzzXzWXP7w== From: SeongJae Park To: akpm@linux-foundation.org Cc: corbet@lwn.net, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, SeongJae Park Subject: [PATCH 4/6] Docs/admin-guide/mm/damon/usage: Mention tracepoint at the beginning Date: Thu, 9 Dec 2021 13:18:04 +0000 Message-Id: <20211209131806.19317-5-sj@kernel.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20211209131806.19317-1-sj@kernel.org> References: <20211209131806.19317-1-sj@kernel.org> Authentication-Results: imf30.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=KpTcUDjv; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf30.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 as permitted sender) smtp.mailfrom=sj@kernel.org X-Rspamd-Server: rspam08 X-Rspamd-Queue-Id: B5E5D80003 X-Stat-Signature: esftrzi5fyakdktdizdtte81doayciia X-HE-Tag: 1639055898-900999 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: To get detailed monitoring results from the user space, users need to use the damon_aggregated tracepoint. This commit adds a brief mention of it at the beginning of the usage document. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 24137312f601..846c85bf4b9d 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -21,7 +21,10 @@ DAMON provides below three interfaces for different users. you can write and use your personalized DAMON debugfs wrapper programs that reads/writes the debugfs files instead of you. The `DAMON user space tool `_ is one example of such programs. It - supports both virtual and physical address spaces monitoring. + supports both virtual and physical address spaces monitoring. Note that this + interface provides only simple :ref:`statistics ` for the + monitoring results. For detailed monitoring results, DAMON provides a + :ref:`tracepoint `. - *Kernel Space Programming Interface.* :doc:`This ` is for kernel space programmers. Using this, users can utilize every feature of DAMON most flexibly and efficiently by @@ -215,6 +218,8 @@ If the value is higher than ```` or lower than ````, the scheme is deactivated. If the value is lower than ````, the scheme is activated. +.. _damos_stats: + Statistics ~~~~~~~~~~ @@ -268,6 +273,8 @@ the monitoring is turned on. If you write to the files while DAMON is running, an error code such as ``-EBUSY`` will be returned. +.. _tracepoint: + Tracepoint for Monitoring Results =================================