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

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: default avatarSeongJae Park <sj@kernel.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent da878780

Documentation/ABI/testing/sysfs-kernel-mm-damon

+4 −3
Original line number Diff line number Diff line
@@ -23,9 +23,10 @@ Date: Mar 2022 
Contact:	SeongJae Park <sj@kernel.org>

Description:	Writing 'on' or 'off' to this file makes the kdamond starts or

		stops, respectively.  Reading the file returns the keywords

		based on the current status.  Writing 'update_schemes_stats' to

		the file updates contents of schemes stats files of the

		kdamond.

		based on the current status.  Writing 'commit' to this file

		makes the kdamond reads the user inputs in the sysfs files

		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

Date:		Mar 2022

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

+5 −4
Original line number Diff line number Diff line
@@ -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

``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

contents of stats files for each DAMON-based operation scheme of the kdamond.

For details of the stats, please refer to :ref:`stats section

<sysfs_schemes_stats>`.

in the state.  Writing ``commit`` to the ``state`` file makes kdamond reads the

user inputs in the sysfs files except ``state`` file again.  Writing

``update_schemes_stats`` to ``state`` file updates the contents of stats files

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.