diff mbox series

[04/20] Docs/ABI/damon: document effective_bytes sysfs file

Message ID	20240219194431.159606-5-sj@kernel.org
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel+bounces-71885-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161; From: SeongJae Park <sj@kernel.org> To: Andrew Morton <akpm@linux-foundation.org> Cc: SeongJae Park <sj@kernel.org>, damon@lists.linux.dev, linux-mm@kvack.org, linux-kernel@vger.kernel.org Subject: [PATCH 04/20] Docs/ABI/damon: document effective_bytes sysfs file Date: Mon, 19 Feb 2024 11:44:15 -0800 Message-Id: <20240219194431.159606-5-sj@kernel.org> In-Reply-To: <20240219194431.159606-1-sj@kernel.org> References: <20240219194431.159606-1-sj@kernel.org> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-getmail-retrieved-from-mailbox: INBOX
Series	mm/damon: let DAMOS feeds and tame/auto-tune itself \| [00/20] mm/damon: let DAMOS feeds and tame/auto-tune itself [01/20] mm/damon/core: Set damos_quota->esz as public field and document [02/20] mm/damon/sysfs-schemes: implement quota effective_bytes file [03/20] mm/damon/sysfs: implement a kdamond command for updating schemes' effective quotas [04/20] Docs/ABI/damon: document effective_bytes sysfs file [05/20] Docs/admin-guide/mm/damon/usage: document effective_bytes file [06/20] mm/damon: move comments and fields for damos-quota-prioritization to the end [07/20] mm/damon/core: split out quota goal related fields to a struct [08/20] mm/damon/core: add multiple goals per damos_quota and helpers for those [09/20] mm/damon/sysfs: use only quota->goals [10/20] mm/damon/core: remove ->goal field of damos_quota [11/20] mm/damon/core: let goal specified with only target and current values [12/20] mm/damon/core: support multiple metrics for quota goal [13/20] mm/damon/core: implement PSI metric DAMOS quota goal [14/20] mm/damon/sysfs-schemes: support PSI-based quota auto-tune [15/20] Docs/mm/damon/design: document quota goal self-tuning [16/20] Docs/ABI/damon: document quota goal metric file [17/20] Docs/admin-guide/mm/damon/usage: document quota goal metric file [18/20] mm/damon/reclaim: implement user-feedback driven quota auto-tuning [19/20] mm/damon/reclaim: implement memory PSI-driven quota self-tuning [20/20] Docs/admin-guide/mm/damon/reclaim: document auto-tuning parameters

Commit Message

SeongJae Park Feb. 19, 2024, 7:44 p.m. UTC

  Update the DAMON ABI doc for the effective_bytes sysfs file and the
kdamond state file input command for updating the content of the file.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/ABI/testing/sysfs-kernel-mm-damon | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-damon b/Documentation/ABI/testing/sysfs-kernel-mm-damon
index bfa5b8288d8d..a1e4fdb04f95 100644
--- a/Documentation/ABI/testing/sysfs-kernel-mm-damon
+++ b/Documentation/ABI/testing/sysfs-kernel-mm-damon
@@ -34,7 +34,9 @@  Description:	Writing 'on' or 'off' to this file makes the kdamond starts or
 		kdamond.  Writing 'update_schemes_tried_bytes' to the file
 		updates only '.../tried_regions/total_bytes' files of this
 		kdamond.  Writing 'clear_schemes_tried_regions' to the file
-		removes contents of the 'tried_regions' directory.
+		removes contents of the 'tried_regions' directory.  Writing
+		'update_schemes_effective_quotas' to the file updates
+		'.../quotas/effective_bytes' files of this kdamond.
 
 What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/pid
 Date:		Mar 2022
@@ -208,6 +210,12 @@  Contact:	SeongJae Park <sj@kernel.org>
 Description:	Writing to and reading from this file sets and gets the size
 		quota of the scheme in bytes.
 
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/effective_bytes
+Date:		Feb 2024
+Contact:	SeongJae Park <sj@kernel.org>
+Description:	Reading from this file gets the effective size quota of the
+		scheme in bytes, which adjusted for the time quota and goals.
+
 What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/reset_interval_ms
 Date:		Mar 2022
 Contact:	SeongJae Park <sj@kernel.org>