linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: SeongJae Park <sj@kernel.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: SeongJae Park <sj@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	damon@lists.linux.dev, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-mm@kvack.org
Subject: [PATCH 08/10] Docs/mm/damon/design: document DAMOS regions walking
Date: Fri,  3 Jan 2025 09:43:58 -0800	[thread overview]
Message-ID: <20250103174400.54890-9-sj@kernel.org> (raw)
In-Reply-To: <20250103174400.54890-1-sj@kernel.org>

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


  parent reply	other threads:[~2025-01-03 17:44 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-03 17:43 [PATCH 00/10] mm/damon: replace most damon_callback usages in sysfs with new core functions SeongJae Park
2025-01-03 17:43 ` [PATCH 01/10] mm/damon/sysfs-schemes: remove unnecessary schemes existence check in damon_sysfs_schemes_clear_regions() SeongJae Park
2025-01-03 17:43 ` [PATCH 02/10] mm/damon/sysfs: handle clear_schemes_tried_regions from DAMON sysfs context SeongJae Park
2025-01-03 17:43 ` [PATCH 03/10] mm/damon/core: introduce damon_call() SeongJae Park
2025-01-03 17:43 ` [PATCH 04/10] mm/damon/sysfs: use damon_call() for update_schemes_stats SeongJae Park
2025-01-03 17:43 ` [PATCH 05/10] mm/damon/sysfs: use damon_call() for commit_schemes_quota_goals SeongJae Park
2025-01-03 17:43 ` [PATCH 06/10] mm/damon/sysfs: use damon_call() for update_schemes_effective_quotas SeongJae Park
2025-01-03 17:43 ` [PATCH 07/10] mm/damon/core: implement damos_walk() SeongJae Park
2025-01-03 17:43 ` SeongJae Park [this message]
2025-01-03 17:43 ` [PATCH 09/10] mm/damon/sysfs: use damos_walk() for update_schemes_tried_{bytes,regions} SeongJae Park
2025-01-03 17:44 ` [PATCH 10/10] mm/damon/sysfs: remove unused code for schemes tried regions update SeongJae Park

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250103174400.54890-9-sj@kernel.org \
    --to=sj@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=damon@lists.linux.dev \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox