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

Docs/mm/damon/design: update for removal of DAMON debugfs interface 

It's time to remove DAMON debugfs interface, which has deprecated long
before in February 2023.  Read the cover letter of this patch series for
more details.

Update DAMON design documentation to stop mentioning about the interface,
to avoid unnecessary confuses.

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


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Alex Shi <alexs@kernel.org>
Cc: Brendan Higgins <brendan.higgins@linux.dev>
Cc: David Gow <davidgow@google.com>
Cc: Hu Haowen <2023002089@link.tyut.edu.cn>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Rae Moar <rmoar@google.com>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 38c433bc

Documentation/mm/damon/design.rst

+10 −13
Original line number Diff line number Diff line
@@ -627,15 +627,11 @@ General Purpose User Interface Modules 
DAMON modules that provide user space ABIs for general purpose DAMON usage in

runtime.



DAMON user interface modules, namely 'DAMON sysfs interface' and 'DAMON debugfs

interface' are DAMON API user kernel modules that provide ABIs to the

user-space.  Please note that DAMON debugfs interface is currently deprecated.



Like many other ABIs, the modules create files on sysfs and debugfs, allow

users to specify their requests to and get the answers from DAMON by writing to

and reading from the files.  As a response to such I/O, DAMON user interface

modules control DAMON and retrieve the results as user requested via the DAMON

API, and return the results to the user-space.

Like many other ABIs, the modules create files on pseudo file systems like

'sysfs', allow users to specify their requests to and get the answers from

DAMON by writing to and reading from the files.  As a response to such I/O,

DAMON user interface modules control DAMON and retrieve the results as user

requested via the DAMON API, and return the results to the user-space.



The ABIs are designed to be used for user space applications development,

rather than human beings' fingers.  Human users are recommended to use such
@@ -644,8 +640,9 @@ Github (https://github.com/damonitor/damo), Pypi 
(https://pypistats.org/packages/damo), and Fedora

(https://packages.fedoraproject.org/pkgs/python-damo/damo/).



Please refer to the ABI :doc:`document </admin-guide/mm/damon/usage>` for

details of the interfaces.

Currently, one module for this type, namely 'DAMON sysfs interface' is

available.  Please refer to the ABI :ref:`doc <sysfs_interface>` for details of

the interfaces.





Special-Purpose Access-aware Kernel Modules
@@ -653,8 +650,8 @@ Special-Purpose Access-aware Kernel Modules 


DAMON modules that provide user space ABI for specific purpose DAMON usage.



DAMON sysfs/debugfs user interfaces are for full control of all DAMON features

in runtime.  For each special-purpose system-wide data access-aware system

DAMON user interface modules are for full control of all DAMON features in

runtime.  For each special-purpose system-wide data access-aware system

operations such as proactive reclamation or LRU lists balancing, the interfaces

could be simplified by removing unnecessary knobs for the specific purpose, and

extended for boot-time and even compile time control.  Default values of DAMON