From: SJ Park <sj@kernel.org>
Cc: SJ Park <sj@kernel.org>, "Liam R. Howlett" <liam@infradead.org>,
Andrew Morton <akpm@linux-foundation.org>,
David Hildenbrand <david@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Lorenzo Stoakes <ljs@kernel.org>, Michal Hocko <mhocko@suse.com>,
Mike Rapoport <rppt@kernel.org>,
Shuah Khan <skhan@linuxfoundation.org>,
Suren Baghdasaryan <surenb@google.com>,
Vlastimil Babka <vbabka@kernel.org>,
damon@lists.linux.dev, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-mm@kvack.org
Subject: [RFC PATCH v2 16/17] Docs/admin-guide/mm/damon/usage: document probe preps sysfs files
Date: Sun, 26 Jul 2026 10:39:32 -0700 [thread overview]
Message-ID: <20260726173935.94046-17-sj@kernel.org> (raw)
In-Reply-To: <20260726173935.94046-1-sj@kernel.org>
Update DAMON usage document for the newly added DAMON probe preps sysfs
files.
Signed-off-by: SJ Park <sj@kernel.org>
---
Documentation/admin-guide/mm/damon/usage.rst | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index da5f9afd08aef..e4fdec3fa5059 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -74,6 +74,9 @@ comma (",").
│ │ │ │ │ │ nr_regions/min,max
│ │ │ │ │ │ :ref:`probes <damon_usage_sysfs_probes>`/nr_probes
│ │ │ │ │ │ │ 0/weight
+ │ │ │ │ │ │ │ │ preps/nr_preps
+ │ │ │ │ │ │ │ │ │ 0/prep_action
+ │ │ │ │ │ │ │ │ │ ...
│ │ │ │ │ │ │ │ filters/nr_filters
│ │ │ │ │ │ │ │ │ 0/type,matching,allow,path
│ │ │ │ │ │ │ │ │ ...
@@ -283,9 +286,18 @@ In the beginning, this directory has only one file, ``nr_probes``. Writing a
number (``N``) to the file creates the number of child directories named ``0``
to ``N-1``. Each directory represents each monitoring probe.
-In each probe directory, one directory, ``filters`` exists. The directory
-contains files for installing filters for the probe, that is used to determine
-the data attribute for the probe.
+In each probe directory, two directories, ``preps`` and ``filters`` exist. The
+directories contain files for installing probing preparation actions and
+filters for the probe, that is used to determine the data attribute for the
+probe.
+
+In the beginning, ``preps`` directory has only one file, ``nr_preps``.
+Writing a number (``N``) to the file creates the number of child directories
+names ``0`` to ``N-1``. Each directory represents each preparation action.
+Each directory has one file, ``prep_action``. The preparation action can be
+selected by writing the name of the action to the ``prep_action`` file. Refer
+to the :ref:`design doc <damon_design_data_attrs_monitoring>` for the list of
+supported actions.
Each probe directory also contains ``weight`` file. Reading from and writing
to the file gets and sets the :ref:`attributes-only monitoring
--
2.47.3
next prev parent reply other threads:[~2026-07-26 17:39 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-26 17:39 [RFC PATCH v2 00/17] mm/damon: introduce data access-as-a-data attribute SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 01/17] mm/damon/core: introduce DAMON_FILTER_TYPE_PGIDLE_UNSET SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 02/17] mm/damon/paddr: support PGIDLE_UNSET probe filter type SJ Park
2026-07-26 17:53 ` sashiko-bot
2026-07-26 18:42 ` SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 03/17] mm/damon/sysfs: support pgidle_unset " SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 04/17] Docs/mm/damon/design: document " SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 05/17] mm/damon/core: introduce damon_prep struct SJ Park
2026-07-26 17:52 ` sashiko-bot
2026-07-26 18:45 ` SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 06/17] mm/damon/core: commit preps SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 07/17] mm/damon/core: introduce damon_operations->prep_probes() SJ Park
2026-07-26 17:57 ` sashiko-bot
2026-07-26 18:52 ` SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 08/17] mm/damon/paddr: support damon_prep SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 09/17] mm/damon/sysfs: implement preps directory SJ Park
2026-07-26 17:46 ` sashiko-bot
2026-07-26 18:54 ` SJ Park
2026-07-26 19:41 ` SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 10/17] mm/damon/sysfs: create probe " SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 11/17] mm/damon/sysfs: implement probe prep directory SJ Park
2026-07-26 17:47 ` sashiko-bot
2026-07-26 18:57 ` SJ Park
2026-07-26 19:42 ` SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 12/17] mm/damon/sysfs: create probe prep files for preps/nr file write SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 13/17] mm/damon/sysfs: pass preps to DAMON core SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 14/17] selftests/damon/sysfs.sh: test probe prep sysfs files SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 15/17] Docs/mm/damon/design: document probe preps SJ Park
2026-07-26 17:39 ` SJ Park [this message]
2026-07-26 17:45 ` [RFC PATCH v2 16/17] Docs/admin-guide/mm/damon/usage: document probe preps sysfs files sashiko-bot
2026-07-26 18:58 ` SJ Park
2026-07-26 17:39 ` [RFC PATCH v2 17/17] Docs/ABI/damon: document probe prep " SJ Park
2026-07-26 17:45 ` sashiko-bot
2026-07-26 19:01 ` 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=20260726173935.94046-17-sj@kernel.org \
--to=sj@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=damon@lists.linux.dev \
--cc=david@kernel.org \
--cc=liam@infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=ljs@kernel.org \
--cc=mhocko@suse.com \
--cc=rppt@kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=surenb@google.com \
--cc=vbabka@kernel.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.