Docs/ABI/damon: document DAMOS quota goals
authorSeongJae Park <sj@kernel.org>
Thu, 30 Nov 2023 02:36:51 +0000 (02:36 +0000)
committerAndrew Morton <akpm@linux-foundation.org>
Tue, 12 Dec 2023 18:57:04 +0000 (10:57 -0800)
Update DAMON ABI document for the newly added DAMON sysfs files and inputs
for DAMOS quota goals.

Link: https://lkml.kernel.org/r/20231130023652.50284-9-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Cc: Brendan Higgins <brendanhiggins@google.com>
Cc: David Gow <davidgow@google.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Documentation/ABI/testing/sysfs-kernel-mm-damon

index b35649a46a2f04cf423164f850a9b0bce4687716..bfa5b8288d8d1161669961b999a2a89de3c0eb6d 100644 (file)
@@ -25,12 +25,14 @@ Description:        Writing 'on' or 'off' to this file makes the kdamond starts or
                stops, respectively.  Reading the file returns the keywords
                based on the current status.  Writing 'commit' to this file
                makes the kdamond reads the user inputs in the sysfs files
-               except 'state' again.  Writing 'update_schemes_stats' to the
-               file updates contents of schemes stats files of the kdamond.
-               Writing 'update_schemes_tried_regions' to the file updates
-               contents of 'tried_regions' directory of every scheme directory
-               of this kdamond.  Writing 'update_schemes_tried_bytes' to the
-               file updates only '.../tried_regions/total_bytes' files of this
+               except 'state' again.  Writing 'commit_schemes_quota_goals' to
+               this file makes the kdamond reads the quota goal files again.
+               Writing 'update_schemes_stats' to the file updates contents of
+               schemes stats files of the kdamond.  Writing
+               'update_schemes_tried_regions' to the file updates contents of
+               'tried_regions' directory of every scheme directory of this
+               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.
 
@@ -212,6 +214,25 @@ Contact:   SeongJae Park <sj@kernel.org>
 Description:   Writing to and reading from this file sets and gets the quotas
                charge reset interval of the scheme in milliseconds.
 
+What:          /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/goals/nr_goals
+Date:          Nov 2023
+Contact:       SeongJae Park <sj@kernel.org>
+Description:   Writing a number 'N' to this file creates the number of
+               directories for setting automatic tuning of the scheme's
+               aggressiveness named '0' to 'N-1' under the goals/ directory.
+
+What:          /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/goals/<G>/target_value
+Date:          Nov 2023
+Contact:       SeongJae Park <sj@kernel.org>
+Description:   Writing to and reading from this file sets and gets the target
+               value of the goal metric.
+
+What:          /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/goals/<G>/current_value
+Date:          Nov 2023
+Contact:       SeongJae Park <sj@kernel.org>
+Description:   Writing to and reading from this file sets and gets the current
+               value of the goal metric.
+
 What:          /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/sz_permil
 Date:          Mar 2022
 Contact:       SeongJae Park <sj@kernel.org>