Commit e85e965b authored by SeongJae Park's avatar SeongJae Park Committed by Andrew Morton
Browse files

Docs/admin-guide/mm/damon/usage: document refresh_ms file 

Document the new DAMON sysfs file, refresh_ms, on the usage document.

Link: https://lkml.kernel.org/r/20250717055448.56976-4-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent d809a7c6

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

+10 −3
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ comma (","). 


    :ref:`/sys/kernel/mm/damon <sysfs_root>`/admin

    │ :ref:`kdamonds <sysfs_kdamonds>`/nr_kdamonds

    │ │ :ref:`0 <sysfs_kdamond>`/state,pid

    │ │ :ref:`0 <sysfs_kdamond>`/state,pid,refresh_ms

    │ │ │ :ref:`contexts <sysfs_contexts>`/nr_contexts

    │ │ │ │ :ref:`0 <sysfs_context>`/avail_operations,operations

    │ │ │ │ │ :ref:`monitoring_attrs <sysfs_monitoring_attrs>`/
@@ -123,8 +123,8 @@ kdamond. 
kdamonds/<N>/

-------------



In each kdamond directory, two files (``state`` and ``pid``) and one directory

(``contexts``) exist.

In each kdamond directory, three files (``state``, ``pid`` and ``refresh_ms``)

and one directory (``contexts``) exist.



Reading ``state`` returns ``on`` if the kdamond is currently running, or

``off`` if it is not running.
@@ -161,6 +161,13 @@ Users can write below commands for the kdamond to the ``state`` file. 


If the state is ``on``, reading ``pid`` shows the pid of the kdamond thread.



Users can ask the kernel to periodically update files showing auto-tuned

parameters and DAMOS stats instead of manually writing

``update_tuned_intervals`` like keywords to ``state`` file.  For this, users

should write the desired update time interval in milliseconds to ``refresh_ms``

file.  If the interval is zero, the periodic update is disabled.  Reading the

file shows currently set time interval.



``contexts`` directory contains files for controlling the monitoring contexts

that this kdamond will execute.