From: SJ Park <sj@kernel.org>
Cc: SJ Park <sj@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>,
Shuah Khan <skhan@linuxfoundation.org>,
damon@lists.linux.dev, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-mm@kvack.org
Subject: [RFC PATCH 10/27] Docs/admin-guide/mm/damon/usage: update for report producer sysfs
Date: Sun, 15 Nov 2026 12:28:28 -0800 [thread overview]
Message-ID: <20261115202849.99134-11-sj@kernel.org> (raw)
In-Reply-To: <20261115202849.99134-1-sj@kernel.org>
Update DAMON usage document for the newly added report producer control
sysfs files.
Signed-off-by: SJ Park <sj@kernel.org>
---
Documentation/admin-guide/mm/damon/usage.rst | 35 ++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index 6093b1c8fbfd9..644250c7bd681 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -115,6 +115,10 @@ comma (",").
│ │ │ │ │ │ ...
│ │ │ │ ...
│ │ ...
+ │ reports/
+ │ │ producers/nr_producers
+ │ │ │ 0/report_type,producer_state
+ │ │ │ ...
.. _sysfs_root:
@@ -729,6 +733,37 @@ Please note that it's highly recommended to use user space tools like `damo
<https://github.com/damonitor/damo>`_ rather than manually reading and writing
the files as above. Above is only for an example.
+.. _damon_usage_sysfs_reports_producers:
+
+reports/producers/
+------------------
+
+Under the `admin/` directory, ``reports/producers/`` directory exists. This
+directory is for configuring :ref:`DAMON report producers
+<damon_design_attr_reporting>`. The file below exists in the directory.
+
+``nr_producers`` file is for generating report producers setup files. Writing
+an integer ``N`` to the file creates the number of directories named ``0`` to
+``N-1``. Each number-named directory is for configuring each report producer
+and called "producer directory".
+
+reports/producers/<N>/
+----------------------
+
+Files below exist in each producer directory.
+
+``report_type`` file is for setting the type of the report to produce. Users
+can set the type by writing the type name to the file. Reading the file shows
+the last successfully written input. Refer to the :ref:`design document
+<damon_design_attr_reporting>` for the list of supported report types.
+
+``producer_state`` file is for reading and updating the state. Reading it
+shows ``on`` or ``off`` if the producer is enabled or disabled, respectively.
+Users can write below keywords for the producer to the file.
+
+- ``on``: Enable the producer.
+- ``off``: Disable the producer.
+
.. _tracepoint:
Tracepoints for Monitoring Results
--
2.47.3
next prev parent reply other threads:[~2026-11-15 20:29 UTC|newest]
Thread overview: 66+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-15 20:28 [RFC PATCH 00/27] mm/damon: let users report their data attribute findings SJ Park
2026-11-15 20:28 ` [RFC PATCH 01/27] mm/damon/api: introduce struct damon_report SJ Park
2026-11-15 20:34 ` sashiko-bot
2026-11-15 21:09 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 02/27] mm/damon/core: implement data attribute report queue SJ Park
2026-11-15 20:41 ` sashiko-bot
2026-11-15 21:17 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 03/27] mm/damon/core: introduce damon_submit_report() SJ Park
2026-11-15 20:42 ` sashiko-bot
2026-11-15 21:23 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 04/27] mm/damon/sysfs: add admin/reports/ directory SJ Park
2026-11-15 20:32 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 05/27] mm/damon/sysfs: add reports/producers/ directory SJ Park
2026-11-15 20:31 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 06/27] mm/damon/sysfs: add producers/nr_producers file SJ Park
2026-11-15 20:32 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 07/27] mm/damon/sysfs: implement report producer directory SJ Park
2026-11-15 20:33 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 08/27] mm/damon/sysfs: implement report producer type and state files SJ Park
2026-11-15 20:36 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 09/27] Docs/mm/damon/design: update for report system SJ Park
2026-11-15 20:36 ` sashiko-bot
2026-11-15 20:28 ` SJ Park [this message]
2026-11-15 20:31 ` [RFC PATCH 10/27] Docs/admin-guide/mm/damon/usage: update for report producer sysfs sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 11/27] Docs/ABI/damon: update for report producer sysfs files SJ Park
2026-11-15 20:31 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 12/27] mm/damon/core: introduce DAMON_FILTER_TYPE_REPORT_MADE SJ Park
2026-11-15 20:36 ` sashiko-bot
2026-11-15 21:27 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 13/27] mm/damon/core: introduce damon_report_exist() SJ Park
2026-11-15 20:37 ` sashiko-bot
2026-11-15 21:35 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 14/27] mm/damon/paddr: support REPORT_MADE type probe filter SJ Park
2026-11-15 20:41 ` sashiko-bot
2026-11-15 21:40 ` SJ Park
2026-11-16 7:43 ` Aveline Noir
2026-11-16 15:05 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 15/27] mm/damon/sysfs: add filter_report_type file under probe filter directory SJ Park
2026-11-15 20:32 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 16/27] mm/damon/sysfs: support REPORT_MADE type probe filter setup SJ Park
2026-11-15 20:41 ` sashiko-bot
2026-11-15 21:42 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 17/27] Docs/mm/damon/design: update for report_made probe filter type SJ Park
2026-11-15 20:32 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 18/27] Docs/admin-guide/mm/damon/usage: update for REPORT_MADE probe filter SJ Park
2026-11-15 20:32 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 19/27] Docs/ABI/damon: " SJ Park
2026-11-15 20:32 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 20/27] mm/damon/api: introduce user_report report type SJ Park
2026-11-15 20:33 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 21/27] mm/damon/sysfs: add user_report support for report type input SJ Park
2026-11-15 20:33 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 22/27] mm/damon/sysfs: implement report producer addr_{start,end} files SJ Park
2026-11-15 20:34 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 23/27] mm/damon/sysfs: implement submit command for report producer SJ Park
2026-11-15 20:43 ` sashiko-bot
2026-11-15 21:43 ` SJ Park
2026-11-15 20:28 ` [RFC PATCH 24/27] selftests/damon/sysfs.sh: add basic tests for admin/reports/ SJ Park
2026-11-15 20:37 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 25/27] Docs/mm/damon/design: update for user report support SJ Park
2026-11-15 20:33 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 26/27] Docs/admin-guide/mm/damon/usage: update for user_report " SJ Park
2026-11-15 20:34 ` sashiko-bot
2026-11-15 20:28 ` [RFC PATCH 27/27] Docs/ABI/damon: " SJ Park
2026-11-15 20:34 ` sashiko-bot
2026-11-15 20:55 ` [RFC PATCH 00/27] mm/damon: let users report their data attribute findings SJ Park
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261115202849.99134-11-sj@kernel.org \
--to=sj@kernel.org \
--cc=corbet@lwn.net \
--cc=damon@lists.linux.dev \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.