diff mbox series

[08/10] Docs/mm/damon/design: document DAMOS regions walking

Message ID 20250103174400.54890-9-sj@kernel.org (mailing list archive)
State New
Headers show
Series mm/damon: replace most damon_callback usages in sysfs with new core functions | expand

Commit Message

SeongJae Park Jan. 3, 2025, 5:43 p.m. UTC 
DAMOS' regions walking is a feature for efficiently retrieving
monitoring results or DAMOS-internal behavior.  It can be useful for
multiple purposes including investigations and tuning.  Add a section
for 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 1c8a43b07b00..5385ea04c2fd 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
 ---------------------------------