Skip to contentSkip to conversation

fixup DAMOS_MIGRATE_{HOT,COLD} patchset documentation

PATCH New SeongJae Park 1 participant 3 messages Jun 18, 2024

Subsystems (4)
lore
Share & tools
lore

SeongJae Park

author maintainer
#0 lore raw

cover fixup DAMOS_MIGRATE_{HOT,COLD} patchset documentation

DAMOS_MIGRATE_{HOT,COLD} documentation[1], which is currently merged in the mm-unstable tree, has two trivial problems.

Firstly, the usage document. It missed updating some parts of the document, and the layout of some paragraphs could be more consistent. Secondly, DAMON sysfs ABI document is not updated. Fix the two trivial problems with two patches, respectively.

Andrew, could you plaese squash the first patch for usage document fixup into the original patch[1]? Meanwhile, I'd prefer keeping the second patch as separate one, since I prefer having individual commit to touch single file if possible.

[1] c100fc71858a ("Docs/damon: document damos_migrate_{hot,cold}") # mm-unstable

SeongJae Park (2):
Docs/admin-guide/damon/usage: trivial fixups for
DAMOS_MIGRATE_{HOT,COLD} documetnation
Docs/ABI/damon: document target_nid file

 Documentation/ABI/testing/sysfs-kernel-mm-damon |  6 ++++++
 Documentation/admin-guide/mm/damon/usage.rst    | 12 ++++++------
 2 files changed, 12 insertions(+), 6 deletions(-)

base-commit: 4ab13e9dfbc0134b95cfbaa2f9696b8e496dab6d

Signature · 1 line
2.39.2
author maintainer
#1 lore raw

PATCH 1/2 Docs/admin-guide/damon/usage: trivial fixups for DAMOS_MIGRATE_{HOT,COLD} documetnation

Fixup below three trivial issues in DAMOS_MIGRATE_{HOT,COLD} usage documentation[1,2].

1. Add target_nid on sysfs files hierarchy
2. Fix scheme directory section to mention target_nid file
3. Explain target_nid before apply_interval_us

Fixes c100fc71858a ("Docs/damon: document damos_migrate_{hot,cold}") # mm-unstable [1]
---
 Documentation/admin-guide/mm/damon/usage.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
Documentation/admin-guide/mm/damon/usage.rst +6 -6
index 98804e34448b..26df6cfa4441 100644
@@ -78,7 +78,7 @@ comma (",").
     │ │ │ │ │ │ │ │ ...
     │ │ │ │ │ │ ...
     │ │ │ │ │ :ref:`schemes <sysfs_schemes>`/nr_schemes
-    │ │ │ │ │ │ :ref:`0 <sysfs_scheme>`/action,apply_interval_us
+    │ │ │ │ │ │ :ref:`0 <sysfs_scheme>`/action,target_nid,apply_interval_us
     │ │ │ │ │ │ │ :ref:`access_pattern <sysfs_access_pattern>`/
     │ │ │ │ │ │ │ │ sz/min,max
     │ │ │ │ │ │ │ │ nr_accesses/min,max
@@ -289,21 +289,21 @@ schemes/<N>/
 ------------
 
 In each scheme directory, five directories (``access_pattern``, ``quotas``,
-``watermarks``, ``filters``, ``stats``, and ``tried_regions``) and two files
-(``action`` and ``apply_interval``) exist.
+``watermarks``, ``filters``, ``stats``, and ``tried_regions``) and three files
+(``action``, ``target_nid`` and ``apply_interval``) exist.
 
 The ``action`` file is for setting and getting the scheme's :ref:`action
 <damon_design_damos_action>`.  The keywords that can be written to and read
 from the file and their meaning are same to those of the list on
 :ref:`design doc <damon_design_damos_action>`.
 
-The ``apply_interval_us`` file is for setting and getting the scheme's
-:ref:`apply_interval <damon_design_damos>` in microseconds.
-
 The ``target_nid`` file is for setting the migration target node, which is
 only meaningful when the ``action`` is either ``migrate_hot`` or
 ``migrate_cold``.
 
+The ``apply_interval_us`` file is for setting and getting the scheme's
+:ref:`apply_interval <damon_design_damos>` in microseconds.
+
 .. _sysfs_access_pattern:
 
 schemes/<N>/access_pattern/
Signature · 1 line
2.39.2
author maintainer
#2 lore raw

PATCH 2/2 Docs/ABI/damon: document target_nid file

In reply to SeongJae Park

Document target_nid DAMON sysfs file that introduced for DAMOS_MIGRATE_{HOT,COLD}.

---
 Documentation/ABI/testing/sysfs-kernel-mm-damon | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/ABI/testing/sysfs-kernel-mm-damon +6 -0
index cef6e1d20b18..f1b90cf1249b 100644
@@ -155,6 +155,12 @@ Contact:	SeongJae Park <[email protected]>
 Description:	Writing to and reading from this file sets and gets the action
 		of the scheme.
 
+What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/target_nid
+Date:		Jun 2024
+Contact:	SeongJae Park <[email protected]>
+Description:	Action's target NUMA node id.  Supported by only relevant
+		actions.
+
 What:		/sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/apply_interval_us
 Date:		Sep 2023
 Contact:	SeongJae Park <[email protected]>
Signature · 1 line
2.39.2