From patchwork Fri Jun 16 19:17:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13283226 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 74330EB64D7 for ; Fri, 16 Jun 2023 19:18:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 43D4E6B0078; Fri, 16 Jun 2023 15:17:56 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 3E6878E0007; Fri, 16 Jun 2023 15:17:56 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 275146B0078; Fri, 16 Jun 2023 15:17:56 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 133678E0007 for ; Fri, 16 Jun 2023 15:17:56 -0400 (EDT) Received: from smtpin29.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id C889B1A0CCB for ; Fri, 16 Jun 2023 19:17:55 +0000 (UTC) X-FDA: 80909570910.29.7FE642D Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf05.hostedemail.com (Postfix) with ESMTP id 24E9E100015 for ; Fri, 16 Jun 2023 19:17:53 +0000 (UTC) Authentication-Results: imf05.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=fdKFp883; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf05.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1686943074; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=+mSq/4AWy/4TnT9T1nriQ/s6vOHvvzPNwXTrEuXGx5I=; b=XR0ttgEQ7lyqSjQCXcN8DI/9OTlMn+dwFH839ybpA2t7y57YQncEO5yTiM3wUlMcOPVGTi NBLOzsgoRzfldRmyN3/9BbPUbdCgm2Gy8sbFYX+IcOe78BOPyQCJ8Xl6fiRPVDzgImjNdh CTS23UdLimMunh6LDfDYi0dAaAzkHoQ= ARC-Authentication-Results: i=1; imf05.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=fdKFp883; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf05.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1686943074; a=rsa-sha256; cv=none; b=CujT77lvrhWNE/4Q/ZkCFZ+VoVbjyR0AeSVAYvNq5CUbRlbVWzaXDlBt9fI3GI5rcO7h+I CmFXtlx3VAN6y/8oCVOM0dwEMDkRjb9PsHsw5InmbDjijPiQeqED2F7i9E7qKVecpZrIOy Ayi3d1Lz4Kwnxz5kU6jmYyUWBp9l+t0= Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 5572963F10; Fri, 16 Jun 2023 19:17:53 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id A20C1C433C0; Fri, 16 Jun 2023 19:17:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1686943073; bh=wbuN7e/qxUK5fsj+ITNoDIFCanTeV9WF0LmR4CSecxI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fdKFp883AX88acKBHDx48kRiVvHf4vAnGts4dIlATFRaFiA+jw/b7JTmej8wv2nhF HNbZZS3cQgg3JeifwfCRmjCkyLbNgHokw7l14YBc1W2QjC0dhcZgUIKcKWwfXFcLvH 69ycl4hpVUSjoQDMDElEryIHjZISCmTUvke0cJVNE+ywuLfC5iH++zJ47DoSvBw4VQ 16Ur5CKlNnFjr9iJrW5tItSl+nLXpCJORhNcfdX40xdf5Yl7dIHLMsJMm3pvtc7qQB kMK9J6K5Q7hD8z9RqnEbNYU7Y5q7LdpgIuLtJrmQ5SZEHD+yumUVhge1LlUB9anGxN GW22IDZWslXvQ== From: SeongJae Park To: Andrew Morton Cc: SeongJae Park , Jonathan Corbet , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 7/7] Docs/admin-guide/mm/damon/usage: update the ways for getting monitoring results Date: Fri, 16 Jun 2023 19:17:42 +0000 Message-Id: <20230616191742.87531-8-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230616191742.87531-1-sj@kernel.org> References: <20230616191742.87531-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: 24E9E100015 X-Rspam-User: X-Rspamd-Server: rspam02 X-Stat-Signature: g9my4b4ue7qe4amr5gwsphnmq11m4b1n X-HE-Tag: 1686943073-256170 X-HE-Meta: U2FsdGVkX18L76B4yFaPR55P61+YWg+JqACugGT1JkyI96hyMBEiJb4wO4a1xb2g2WMoiX1aOcN8QzF3/MOIdNhdIMrtG/BuZth0Bb7ERGvlhztsPfpFoQo/d5c9jvG9k01iP9+KS5ojJkbDYO4/Ztxmr8m/JuGF3ZwB7J/Jy6RetYdu0Uihtq6xZzLYWZA0uIy7Jw6hXLBomPcks45MaCbdkDeiRRJ6eURWxP55J9oTeDNZdIo61nmuNSyRNa8N3LKMXXMQSJSbBJkFz6h/8XPI8yqyyQCXky/3rXYaGIbnHgJN/faAINJqPPYFeWqrj0lvNxIEdVV1sQv/divDMJ+Wh0M/tgprHmx5pP/peIe2A2C4Cc6ZkIcD2lgLyjqdkruLpYTngO7Heu4X8KNhQi42kG+t9t4j1DXJ2QGByQU28iWp6KtRKYxoFKWeJnJNtjrBlrNvID2o88nL0EcEwkuy9mcFmICOMDSlXFxYhEDWuzygqKJFDKeiIPNncdY29f4CCUea6MvCSFtaLWovIAyV1YhOA8roH+XnHfila/0PqtX6yIZuFT49+4rPPXtm+HblFFMcLKiQbT7zD0DOlqqXp2uC904RV73LaJT7870ZHlp32EpfYLnxWysu0rSGus7LesbL088w/AL8idzbI7hPQ8ZgLKn6vSCBS3aneABUg/7CHkELS+vNTnogNWhoB2MT0H1Jc8Z7NOS/LXmPbshjOjCYumwD+91aHlAqcI8WtRyLLtYugQ07URkBQcHPdX2SM0dYiYwZwxFaQxt3auxykppZZlXGBY2obEWkfW2WZkDbbedFRkmOiujCTIDp5+llpAxSZ/otZhK/VkKreBEwzV7BSh3qL5bm/ARu6PKN/J1Vlw56wHSGW9/Ex/d1ko18zJMGZtj1/Ib1hYkXP2jYh2ix/K3RqjWcDVoKomJxChpBGXM04zCmCPYuD/6veYO+00p80/1RI4aANLa Zm9TJIho 6mwvz6HCPaWFgPvCccLLqhHlh0hfWoYhE31EuXyONn7RMbOVdXXZDMxPaDCSUg3bAM9fmRMwjSk18raUXBt8eAC6IPvPaU42esbqKk1EyUZcDIsHFL3OYOkvBPbYmO8VqBFBCXIimNg+k3NYPI/j0shPnDuDQzjtBNxf2k0iGn3qKZM+zlGkwCbsOqH2FOm8i8sVYiDDoI8G4a6vqZqIP0E1/zGrHc5p6KceEY06C2OVnpnB1G6j0TSdSnZS+F6ALiYnkqbts27rL1zytWwcHog230Sg/uor7WEtjKdQXIWiS+geJBGidg6Ti3WXJ9oGgjV6Nw5aDUokUm8TkFsoNWzhXqN+QUb1oRcyAgjRfRtbtECI= 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: The recommended ways for getting DAMON monitoring results are using tried_regions sysfs directory for partial snapshot of the results, and DAMON tracepoint for full record of the results. However, the tried_regions sysfs directory usage has not sufficiently updated on some sections of the DAMON usage document. Update those. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 9d3ebd70772f..2d495fa85a0e 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -19,10 +19,7 @@ DAMON provides below interfaces for different users. features by reading from and writing to special sysfs files. Therefore, you can write and use your personalized DAMON sysfs wrapper programs that reads/writes the sysfs files instead of you. The `DAMON user space tool - `_ is one example of such programs. Note - that this interface provides only simple :ref:`statistics ` for - the monitoring results. For detailed monitoring results, DAMON provides a - :ref:`tracepoint `. + `_ is one example of such programs. - *debugfs interface. (DEPRECATED!)* :ref:`This ` is almost identical to :ref:`sysfs interface `. This is deprecated, so users should move to the @@ -421,6 +418,11 @@ The directories will be removed when another special keyword, ``clear_schemes_tried_regions``, is written to the relevant ``kdamonds//state`` file. +The expected usage of this directory is investigations of schemes' behaviors, +and query-like efficient data access monitoring results retrievals. For the +latter use case, in particular, users can set the ``action`` as ``stat`` and +set the ``access pattern`` as their interested pattern that they want to query. + tried_regions// ------------------ @@ -771,10 +773,12 @@ root directory only. Tracepoint for Monitoring Results ================================= -DAMON provides the monitoring results via a tracepoint, -``damon:damon_aggregated``. While the monitoring is turned on, you could -record the tracepoint events and show results using tracepoint supporting tools -like ``perf``. For example:: +Users can get the monitoring results via the :ref:`tried_regions +` or a tracepoint, ``damon:damon_aggregated``. +While the tried regions directory is useful for getting a snapshot, the +tracepoint is useful for getting a full record of the results. While the +monitoring is turned on, you could record the tracepoint events and show +results using tracepoint supporting tools like ``perf``. For example:: # echo on > monitor_on # perf record -e damon:damon_aggregated &