diff mbox series

[RFC,02/18] Docs/mm/damon/design: document DAMOS regions walking

Message ID 20241219040327.61902-3-sj@kernel.org (mailing list archive)
State New
Headers show
Series mm/damon: enable page level properties based access pattern monitoring | expand

Commit Message

SeongJae Park Dec. 19, 2024, 4:03 a.m. UTC 
DAMOS' regions walking feature is an important feature for efficiently
retrieving monitoring results or DAMOS-internal behavior.  Document it
on the design document.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/mm/damon/design.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index f9c50525bdbf..a577ae40e71c 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -540,6 +540,17 @@  To know how user-space can set the watermarks via :ref:`DAMON sysfs interface
 documentation.
 
 
+Regions Walking
+~~~~~~~~~~~~~~~
+
+DAMOS feature allowing users access each region that a DAMOS action has just
+applied.  Using this feature, DAMON :ref:`API <damon_design_api>` allows users
+access full properties of the regions including the access monitoring results.
+:ref:`DAMON sysfs interface <sysfs_interface>` also allows users read the data
+via special :ref:`files <sysfs_schemes_tried_regions>`.
+
+.. _damon_design_api:
+
 Application Programming Interface
 ---------------------------------