iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs/admin-guide/mm/damon/usage: update for monitor_on renaming

Browse Source 
Update DAMON debugfs interface sections on the usage document to reflect
the fact that 'monitor_on' file has renamed to 'monitor_on_DEPRECATED'.

Link: https://lkml.kernel.org/r/20240130013549.89538-9-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Cc: Alex Shi <alexs@kernel.org>
Cc: Hu Haowen <2023002089@link.tyut.edu.cn>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Yanteng Si <siyanteng@loongson.cn>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
SeongJae Park
2024-01-29 17:35:47 -08:00
committed by Andrew Morton
parent 772333cb2a
commit ec28cf530c
1 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Documentation/admin-guide/mm/damon/usage.rst
View File

@ -629,8 +629,9 @@ debugfs Interface (DEPRECATED!)
linux-mm@kvack.org. linux-mm@kvack.org.
DAMON exports nine files, ``DEPRECATED``, ``attrs``, ``target_ids``, DAMON exports nine files, ``DEPRECATED``, ``attrs``, ``target_ids``,
``init_regions``, ``schemes``, ``monitor_on``, ``kdamond_pid``, ``mk_contexts`` ``init_regions``, ``schemes``, ``monitor_on_DEPRECATED``, ``kdamond_pid``,
and ``rm_contexts`` under its debugfs directory, ``<debugfs>/damon/``. ``mk_contexts`` and ``rm_contexts`` under its debugfs directory,
``<debugfs>/damon/``.
``DEPRECATED`` is a read-only file for the DAMON debugfs interface deprecation ``DEPRECATED`` is a read-only file for the DAMON debugfs interface deprecation
@ -855,16 +856,16 @@ Turning On/Off
Setting the files as described above doesn't incur effect unless you explicitly Setting the files as described above doesn't incur effect unless you explicitly
start the monitoring. You can start, stop, and check the current status of the start the monitoring. You can start, stop, and check the current status of the
monitoring by writing to and reading from the ``monitor_on`` file. Writing monitoring by writing to and reading from the ``monitor_on_DEPRECATED`` file.
``on`` to the file starts the monitoring of the targets with the attributes. Writing ``on`` to the file starts the monitoring of the targets with the
Writing ``off`` to the file stops those. DAMON also stops if every target attributes. Writing ``off`` to the file stops those. DAMON also stops if
process is terminated. Below example commands turn on, off, and check the every target process is terminated. Below example commands turn on, off, and
status of DAMON:: check the status of DAMON::
# cd <debugfs>/damon # cd <debugfs>/damon
# echo on > monitor_on # echo on > monitor_on_DEPRECATED
# echo off > monitor_on # echo off > monitor_on_DEPRECATED
# cat monitor_on # cat monitor_on_DEPRECATED
off off
Please note that you cannot write to the above-mentioned debugfs files while Please note that you cannot write to the above-mentioned debugfs files while
@ -880,11 +881,11 @@ can get the pid of the thread by reading the ``kdamond_pid`` file. When the
monitoring is turned off, reading the file returns ``none``. :: monitoring is turned off, reading the file returns ``none``. ::
# cd <debugfs>/damon # cd <debugfs>/damon
# cat monitor_on # cat monitor_on_DEPRECATED
off off
# cat kdamond_pid # cat kdamond_pid
none none
# echo on > monitor_on # echo on > monitor_on_DEPRECATED
# cat kdamond_pid # cat kdamond_pid
18594 18594
@ -914,5 +915,5 @@ directory by putting the name of the context to the ``rm_contexts`` file. ::
# ls foo # ls foo
# ls: cannot access 'foo': No such file or directory # ls: cannot access 'foo': No such file or directory
Note that ``mk_contexts``, ``rm_contexts``, and ``monitor_on`` files are in the Note that ``mk_contexts``, ``rm_contexts``, and ``monitor_on_DEPRECATED`` files
root directory only. are in the root directory only.