Skip to content

Commit 038d471

Browse files
sjp38aahmed71
authored andcommitted
Docs/admin-guide/mm/damon/usage: clarify quotas and watermarks sysfs interface
Explanation of DAMOS quotas and watermarks are not clearly explaining the meaning and expectation of each file. Add more clarification for those. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: SeongJae Park <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Andrew Morton <[email protected]>
1 parent 167e7b2 commit 038d471

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

Documentation/admin-guide/mm/damon/usage.rst

+9-2
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,8 @@ Under the ``access_pattern`` directory, three directories (``sz``,
306306
``nr_accesses``, and ``age``) each having two files (``min`` and ``max``)
307307
exist. You can set and get the access pattern for the given scheme by writing
308308
to and reading from the ``min`` and ``max`` files under ``sz``,
309-
``nr_accesses``, and ``age`` directories, respectively.
309+
``nr_accesses``, and ``age`` directories, respectively. Note that the ``min``
310+
and the ``max`` form a closed interval.
310311

311312
schemes/<N>/quotas/
312313
-------------------
@@ -320,7 +321,13 @@ Under ``quotas`` directory, three files (``ms``, ``bytes``,
320321

321322
You can set the ``time quota`` in milliseconds, ``size quota`` in bytes, and
322323
``reset interval`` in milliseconds by writing the values to the three files,
323-
respectively. You can also set the :ref:`prioritization weights
324+
respectively. Then, DAMON tries to use only up to ``time quota`` milliseconds
325+
for applying the ``action`` to memory regions of the ``access_pattern``, and to
326+
apply the action to only up to ``bytes`` bytes of memory regions within the
327+
``reset_interval_ms``. Setting both ``ms`` and ``bytes`` zero disables the
328+
quota limits.
329+
330+
You can also set the :ref:`prioritization weights
324331
<damon_design_damos_quotas_prioritization>` for size, access frequency, and age
325332
in per-thousand unit by writing the values to the three files under the
326333
``weights`` directory.

0 commit comments

Comments
 (0)