Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Docs/admin-guide/mm/damon/usage: document goal_tuner sysfs file
Update the DAMON usage document for the new sysfs file for the goal based
quota auto-tuning algorithm selection.
Link: https://lkml.kernel.org/r/20260310010529.91162-7-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
authored by
SeongJae Park
and committed by
Andrew Morton
d9cfe515
5a242f9d
+12
-4
+12
-4
Documentation/admin-guide/mm/damon/usage.rst
+12
-4
Documentation/admin-guide/mm/damon/usage.rst
···
83
83
│ │ │ │ │ │ │ │ sz/min,max
84
84
│ │ │ │ │ │ │ │ nr_accesses/min,max
85
85
│ │ │ │ │ │ │ │ age/min,max
86
-
│ │ │ │ │ │ │ :ref:`quotas <sysfs_quotas>`/ms,bytes,reset_interval_ms,effective_bytes
86
+
│ │ │ │ │ │ │ :ref:`quotas <sysfs_quotas>`/ms,bytes,reset_interval_ms,effective_bytes,goal_tuner
87
87
│ │ │ │ │ │ │ │ weights/sz_permil,nr_accesses_permil,age_permil
88
88
│ │ │ │ │ │ │ │ :ref:`goals <sysfs_schemes_quota_goals>`/nr_goals
89
89
│ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value,nid,path
···
377
377
The directory for the :ref:`quotas <damon_design_damos_quotas>` of the given
378
378
DAMON-based operation scheme.
379
379
380
-
Under ``quotas`` directory, four files (``ms``, ``bytes``,
381
-
``reset_interval_ms``, ``effective_bytes``) and two directories (``weights`` and
382
-
``goals``) exist.
380
+
Under ``quotas`` directory, five files (``ms``, ``bytes``,
381
+
``reset_interval_ms``, ``effective_bytes`` and ``goal_tuner``) and two
382
+
directories (``weights`` and ``goals``) exist.
383
383
384
384
You can set the ``time quota`` in milliseconds, ``size quota`` in bytes, and
385
385
``reset interval`` in milliseconds by writing the values to the three files,
···
389
389
``reset_interval_ms``. Setting both ``ms`` and ``bytes`` zero disables the
390
390
quota limits unless at least one :ref:`goal <sysfs_schemes_quota_goals>` is
391
391
set.
392
+
393
+
You can set the goal-based effective quota auto-tuning algorithm to use, by
394
+
writing the algorithm name to ``goal_tuner`` file. Reading the file returns
395
+
the currently selected tuner algorithm. Refer to the design documentation of
396
+
:ref:`automatic quota tuning goals <damon_design_damos_quotas_auto_tuning>` for
397
+
the background design of the feature and the name of the selectable algorithms.
398
+
Refer to :ref:`goals directory <sysfs_schemes_quota_goals>` for the goals
399
+
setup.
392
400
393
401
The time quota is internally transformed to a size quota. Between the
394
402
transformed size quota and user-specified size quota, smaller one is applied.