The patch titled Subject: Docs/admin-guide/mm/damon/usage: mention tracepoint at the beginning has been added to the -mm tree. Its filename is docs-admin-guide-mm-damon-usage-mention-tracepoint-at-the-beginning.patch This patch should soon appear at https://ozlabs.org/~akpm/mmots/broken-out/docs-admin-guide-mm-damon-usage-mention-tracepoint-at-the-beginning.patch and later at https://ozlabs.org/~akpm/mmotm/broken-out/docs-admin-guide-mm-damon-usage-mention-tracepoint-at-the-beginning.patch Before you just go and hit "reply", please: a) Consider who else should be cc'ed b) Prefer to cc a suitable mailing list as well c) Ideally: find the original patch on the mailing list and do a reply-to-all to that, adding suitable additional cc's *** Remember to use Documentation/process/submit-checklist.rst when testing your code *** The -mm tree is included into linux-next and is updated there every 3-4 working days ------------------------------------------------------ From: SeongJae Park <sj@xxxxxxxxxx> 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@xxxxxxxxxx Signed-off-by: SeongJae Park <sj@xxxxxxxxxx> Cc: Jonathan Corbet <corbet@xxxxxxx> Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx> --- 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 ================================= _ Patches currently in -mm which might be from sj@xxxxxxxxxx are timers-implement-usleep_idle_range.patch mm-damon-core-fix-fake-load-reports-due-to-uninterruptible-sleeps.patch mm-damon-core-use-better-timer-mechanisms-selection-threshold.patch mm-damon-dbgfs-remove-an-unnecessary-error-message.patch mm-damon-core-remove-unnecessary-error-messages.patch mm-damon-vaddr-remove-an-unnecessary-warning-message.patch mm-damon-vaddr-test-split-a-test-function-having-1024-bytes-frame-size.patch mm-damon-vaddr-test-remove-unnecessary-variables.patch selftests-damon-skip-test-if-damon-is-running.patch selftests-damon-test-damon-enabling-with-empty-target_ids-case.patch selftests-damon-test-wrong-damos-condition-ranges-input.patch selftests-damon-test-debugfs-file-reads-writes-with-huge-count.patch selftests-damon-split-test-cases.patch mm-damon-remove-some-no-need-func-definitions-in-damonh-file-fix.patch mm-damon-convert-macro-functions-to-static-inline-functions.patch docs-admin-guide-mm-damon-usage-update-for-scheme-quotas-and-watermarks.patch docs-admin-guide-mm-damon-usage-remove-redundant-information.patch docs-admin-guide-mm-damon-usage-mention-tracepoint-at-the-beginning.patch docs-admin-guide-mm-damon-usage-update-for-kdamond_pid-and-mkrm_contexts.patch mm-damon-remove-a-mistakenly-added-comment-for-a-future-feature.patch