Skip to content

Commit 4492bf4

Browse files
sjp38torvalds
authored andcommitted
Docs/admin-guide/mm/damon/usage: mention tracepoint at the beginning
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. 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]> Signed-off-by: Linus Torvalds <[email protected]>
1 parent 35b43d4 commit 4492bf4

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ DAMON provides below three interfaces for different users.
2121
you can write and use your personalized DAMON debugfs wrapper programs that
2222
reads/writes the debugfs files instead of you. The `DAMON user space tool
2323
<https://github.com/awslabs/damo>`_ is one example of such programs. It
24-
supports both virtual and physical address spaces monitoring.
24+
supports both virtual and physical address spaces monitoring. Note that this
25+
interface provides only simple :ref:`statistics <damos_stats>` for the
26+
monitoring results. For detailed monitoring results, DAMON provides a
27+
:ref:`tracepoint <tracepoint>`.
2528
- *Kernel Space Programming Interface.*
2629
:doc:`This </vm/damon/api>` is for kernel space programmers. Using this,
2730
users can utilize every feature of DAMON most flexibly and efficiently by
@@ -215,6 +218,8 @@ If the value is higher than ``<high mark>`` or lower than ``<low mark>``, the
215218
scheme is deactivated. If the value is lower than ``<mid mark>``, the scheme
216219
is activated.
217220

221+
.. _damos_stats:
222+
218223
Statistics
219224
~~~~~~~~~~
220225

@@ -268,6 +273,8 @@ the monitoring is turned on. If you write to the files while DAMON is running,
268273
an error code such as ``-EBUSY`` will be returned.
269274

270275

276+
.. _tracepoint:
277+
271278
Tracepoint for Monitoring Results
272279
=================================
273280

0 commit comments

Comments
 (0)