Docs/ABI/damon: sysfs ABI document fixes and additions
Subsystems (4)
SJ Park
maintainerv2 cover Docs/ABI/damon: sysfs ABI document fixes and additions
This series fixes typos and fills in missing entries in the DAMON sysfs ABI document (Documentation/ABI/testing/sysfs-kernel-mm-damon).
Patch 1 fixes a path typo, "intrvals_goal" -> "intervals_goal", in four What: entries; the documented path points to a non-existent directory, so it is Cc'ed to stable.
Patch 2 fixes two further typos ("WDate:", "manimum").
Patches 3 and 4 add ABI entries that exist in the kernel and are already described in usage.rst but are missing from the canonical ABI
document: the 'update_tuned_intervals' state command (patch 3) and the 'tried_regions/<R>/probes/<P>/hits' file (patch 4).
Changes from v1
- v1: https://lore.kernel.org/[email protected]
- Rebase to latest mm-new.
Song Hu (4):
Docs/ABI/damon: fix typo in intervals_goal sysfs path Docs/ABI/damon: fix typos
Docs/ABI/damon: document update_tuned_intervals state command Docs/ABI/damon: document tried_regions probe hits
.../ABI/testing/sysfs-kernel-mm-damon | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-)
base-commit: 4c3e511167ba60f3934a530fa5675143a09eb909
Signature · 1 line
2.47.3
SJ Park
maintainerPATCH v2 1/4 Docs/ABI/damon: fix typo in intervals_goal sysfs path
From: Song Hu <[email protected]>
The ABI document spells the DAMON sysfs directory as "intrvals_goal" (missing 'e') in four What: entries, but the kernel creates it as "intervals_goal" (mm/damon/sysfs.c). Following the documented path therefore yields a non-existent directory.
--- Documentation/ABI/testing/sysfs-kernel-mm-damon | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/ABI/testing/sysfs-kernel-mm-damon +4 -4
@@ -112,7 +112,7 @@ Description: Writing a value to this file sets the update interval of the DAMON context in microseconds as the value. Reading this file returns the value. -What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intrvals_goal/access_bp +What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intervals_goal/access_bp Date: Feb 2025 Contact: SJ Park <[email protected]> Description: Writing a value to this file sets the monitoring intervals
@@ -120,7 +120,7 @@ Description: Writing a value to this file sets the monitoring intervals the given time interval (aggrs in same directory), in bp (1/10,000). Reading this file returns the value. -What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intrvals_goal/aggrs +What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intervals_goal/aggrs Date: Feb 2025 Contact: SJ Park <[email protected]> Description: Writing a value to this file sets the time interval to achieve
@@ -128,14 +128,14 @@ Description: Writing a value to this file sets the time interval to achieve access events ratio (access_bp in same directory) within. Reading this file returns the value. -What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intrvals_goal/min_sample_us +What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intervals_goal/min_sample_us Date: Feb 2025 Contact: SJ Park <[email protected]> Description: Writing a value to this file sets the minimum value of auto-tuned sampling interval in microseconds. Reading this file returns the value. -What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intrvals_goal/max_sample_us +What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/intervals_goal/max_sample_us Date: Feb 2025 Contact: SJ Park <[email protected]> Description: Writing a value to this file sets the maximum value of
Signature · 1 line
2.47.3
SJ Park
maintainerPATCH v2 2/4 Docs/ABI/damon: fix typos
In reply to SJ ParkFrom: Song Hu <[email protected]>
Fix two typos in the DAMON sysfs ABI document:
- "WDate:" -> "Date:" on the nr_regions/min entry
- "manimum" -> "minimum" in the nr_accesses/min description
--- Documentation/ABI/testing/sysfs-kernel-mm-damon | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-kernel-mm-damon +2 -2
@@ -144,7 +144,7 @@ Description: Writing a value to this file sets the maximum value of What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/nr_regions/min -WDate: Mar 2022 +Date: Mar 2022 Contact: SJ Park <[email protected]> Description: Writing a value to this file sets the minimum number of monitoring regions of the DAMON context as the value. Reading
@@ -287,7 +287,7 @@ Description: Writing to and reading from this file sets and gets the maximum What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/nr_accesses/min Date: Mar 2022 Contact: SJ Park <[email protected]> -Description: Writing to and reading from this file sets and gets the manimum +Description: Writing to and reading from this file sets and gets the minimum 'nr_accesses' of the scheme's target regions. What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/nr_accesses/max
Signature · 1 line
2.47.3
SJ Park
maintainerPATCH v2 3/4 Docs/ABI/damon: document update_tuned_intervals state command
In reply to SJ ParkFrom: Song Hu <[email protected]>
The 'update_tuned_intervals' command of the 'state' file, added in commit 1077605396b4 ("mm/damon/sysfs: implement a command to update auto-tuned monitoring intervals"), is described in usage.rst but missing from the canonical ABI document. Add it.
--- Documentation/ABI/testing/sysfs-kernel-mm-damon | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-kernel-mm-damon +4 -1
@@ -36,7 +36,10 @@ Description: Writing 'on' or 'off' to this file makes the kdamond starts or kdamond. Writing 'clear_schemes_tried_regions' to the file removes contents of the 'tried_regions' directory. Writing 'update_schemes_effective_quotas' to the file updates - '.../quotas/effective_bytes' files of this kdamond. + '.../quotas/effective_bytes' files of this kdamond. Writing + 'update_tuned_intervals' to the file updates 'sample_us' and + 'aggr_us' files under 'monitoring_attrs/intervals' with the + auto-tuned sampling and aggregation intervals. What: /sys/kernel/mm/damon/admin/kdamonds/<K>/pid Date: Mar 2022
Signature · 1 line
2.47.3
SJ Park
maintainerPATCH v2 4/4 Docs/ABI/damon: document tried_regions probe hits
In reply to SJ ParkFrom: Song Hu <[email protected]>
The 'tried_regions/<R>/probes/<P>/hits' file, added in commit 5b0de1bc3325 ("mm/damon/sysfs-schemes: implement probe/hits file"), is described in usage.rst but missing from the canonical ABI document.
Document the 'probes/' directory and the 'probes/<P>/hits' file.
--- Documentation/ABI/testing/sysfs-kernel-mm-damon | 12 ++++++++++++ 1 file changed, 12 insertions(+)
Documentation/ABI/testing/sysfs-kernel-mm-damon +12 -0
@@ -650,3 +650,15 @@ Contact: SJ Park <[email protected]> Description: Reading this file returns the size of the memory in the region that passed DAMON operations layer-handled filters of the scheme in bytes. + +What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/tried_regions/<R>/probes/ +Date: May 2026 +Contact: SJ Park <[email protected]> +Description: Directory for DAMON data-attribute monitoring probes of the + region. + +What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/tried_regions/<R>/probes/<P>/hits +Date: May 2026 +Contact: SJ Park <[email protected]> +Description: Reading this file returns the number of data-attribute + monitoring probe-hit positive samples of the region.
Signature · 1 line
2.47.3