| From: SeongJae Park <sj@kernel.org> |
| Subject: 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/20211209131806.19317-5-sj@kernel.org |
| Signed-off-by: SeongJae Park <sj@kernel.org> |
| Cc: Jonathan Corbet <corbet@lwn.net> |
| Signed-off-by: Andrew Morton <akpm@linux-foundation.org> |
| --- |
| |
| Documentation/admin-guide/mm/damon/usage.rst | 9 ++++++++- |
| 1 file changed, 8 insertions(+), 1 deletion(-) |
| |
| --- a/Documentation/admin-guide/mm/damon/usage.rst~docs-admin-guide-mm-damon-usage-mention-tracepoint-at-the-beginning |
| +++ a/Documentation/admin-guide/mm/damon/usage.rst |
| @@ -21,7 +21,10 @@ DAMON provides below three interfaces fo |
| you can write and use your personalized DAMON debugfs wrapper programs that |
| reads/writes the debugfs files instead of you. The `DAMON user space tool |
| <https://github.com/awslabs/damo>`_ is one example of such programs. It |
| - supports both virtual and physical address spaces monitoring. |
| + supports both virtual and physical address spaces monitoring. Note that this |
| + interface provides only simple :ref:`statistics <damos_stats>` for the |
| + monitoring results. For detailed monitoring results, DAMON provides a |
| + :ref:`tracepoint <tracepoint>`. |
| - *Kernel Space Programming Interface.* |
| :doc:`This </vm/damon/api>` is for kernel space programmers. Using this, |
| users can utilize every feature of DAMON most flexibly and efficiently by |
| @@ -215,6 +218,8 @@ If the value is higher than ``<high mark |
| scheme is deactivated. If the value is lower than ``<mid mark>``, the scheme |
| is activated. |
| |
| +.. _damos_stats: |
| + |
| Statistics |
| ~~~~~~~~~~ |
| |
| @@ -268,6 +273,8 @@ the monitoring is turned on. If you wri |
| an error code such as ``-EBUSY`` will be returned. |
| |
| |
| +.. _tracepoint: |
| + |
| Tracepoint for Monitoring Results |
| ================================= |
| |
| _ |
