Skip to content

Commit 4f6717f

Browse files
sjp38sj-aws
authored andcommitted
Docs/admin-guide/mm/damon/usage: update the ways for getting monitoring results
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. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: SeongJae Park <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Andrew Morton <[email protected]>
1 parent f7c7f5d commit 4f6717f

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Documentation/admin-guide/mm/damon/usage.rst

+12-8
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,7 @@ DAMON provides below interfaces for different users.
1919
features by reading from and writing to special sysfs files. Therefore,
2020
you can write and use your personalized DAMON sysfs wrapper programs that
2121
reads/writes the sysfs files instead of you. The `DAMON user space tool
22-
<https://github.com/awslabs/damo>`_ is one example of such programs. Note
23-
that this interface provides only simple :ref:`statistics <damos_stats>` for
24-
the monitoring results. For detailed monitoring results, DAMON provides a
25-
:ref:`tracepoint <tracepoint>`.
22+
<https://github.com/awslabs/damo>`_ is one example of such programs.
2623
- *debugfs interface. (DEPRECATED!)*
2724
:ref:`This <debugfs_interface>` is almost identical to :ref:`sysfs interface
2825
<sysfs_interface>`. This is deprecated, so users should move to the
@@ -421,6 +418,11 @@ The directories will be removed when another special keyword,
421418
``clear_schemes_tried_regions``, is written to the relevant
422419
``kdamonds/<N>/state`` file.
423420

421+
The expected usage of this directory is investigations of schemes' behaviors,
422+
and query-like efficient data access monitoring results retrievals. For the
423+
latter use case, in particular, users can set the ``action`` as ``stat`` and
424+
set the ``access pattern`` as their interested pattern that they want to query.
425+
424426
tried_regions/<N>/
425427
------------------
426428

@@ -771,10 +773,12 @@ root directory only.
771773
Tracepoint for Monitoring Results
772774
=================================
773775

774-
DAMON provides the monitoring results via a tracepoint,
775-
``damon:damon_aggregated``. While the monitoring is turned on, you could
776-
record the tracepoint events and show results using tracepoint supporting tools
777-
like ``perf``. For example::
776+
Users can get the monitoring results via the :ref:`tried_regions
777+
<sysfs_schemes_tried_regions>` or a tracepoint, ``damon:damon_aggregated``.
778+
While the tried regions directory is useful for getting a snapshot, the
779+
tracepoint is useful for getting a full record of the results. While the
780+
monitoring is turned on, you could record the tracepoint events and show
781+
results using tracepoint supporting tools like ``perf``. For example::
778782

779783
# echo on > monitor_on
780784
# perf record -e damon:damon_aggregated &

0 commit comments

Comments
 (0)