Docs/{ABI,admin-guide}/damon: Update for 'state' sysfs file input keyword, 'commit'

This commit documents the newly added 'state' sysfs file input keyword,
'commit', which allows online tuning of DAMON contexts.

Link: https://lkml.kernel.org/r/20220429160606.127307-13-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
SeongJae Park 2022-05-09 18:20:56 -07:00 committed by Andrew Morton
parent da87878010
commit adc286e6bd
2 changed files with 9 additions and 7 deletions

View file

@ -23,9 +23,10 @@ Date: Mar 2022
Contact: SeongJae Park <sj@kernel.org> Contact: SeongJae Park <sj@kernel.org>
Description: Writing 'on' or 'off' to this file makes the kdamond starts or Description: Writing 'on' or 'off' to this file makes the kdamond starts or
stops, respectively. Reading the file returns the keywords stops, respectively. Reading the file returns the keywords
based on the current status. Writing 'update_schemes_stats' to based on the current status. Writing 'commit' to this file
the file updates contents of schemes stats files of the makes the kdamond reads the user inputs in the sysfs files
kdamond. except 'state' again. Writing 'update_schemes_stats' to the
file updates contents of schemes stats files of the kdamond.
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/pid What: /sys/kernel/mm/damon/admin/kdamonds/<K>/pid
Date: Mar 2022 Date: Mar 2022

View file

@ -121,10 +121,11 @@ In each kdamond directory, two files (``state`` and ``pid``) and one directory
Reading ``state`` returns ``on`` if the kdamond is currently running, or Reading ``state`` returns ``on`` if the kdamond is currently running, or
``off`` if it is not running. Writing ``on`` or ``off`` makes the kdamond be ``off`` if it is not running. Writing ``on`` or ``off`` makes the kdamond be
in the state. Writing ``update_schemes_stats`` to ``state`` file updates the in the state. Writing ``commit`` to the ``state`` file makes kdamond reads the
contents of stats files for each DAMON-based operation scheme of the kdamond. user inputs in the sysfs files except ``state`` file again. Writing
For details of the stats, please refer to :ref:`stats section ``update_schemes_stats`` to ``state`` file updates the contents of stats files
<sysfs_schemes_stats>`. for each DAMON-based operation scheme of the kdamond. For details of the
stats, please refer to :ref:`stats section <sysfs_schemes_stats>`.
If the state is ``on``, reading ``pid`` shows the pid of the kdamond thread. If the state is ``on``, reading ``pid`` shows the pid of the kdamond thread.