Commit ea7f03a4 authored by SeongJae Park's avatar SeongJae Park Committed by Andrew Morton

Docs/admin-guide/mm/damon/usage: update for tried_regions/total_bytes

Update the DAMON usage document for newly added
schemes/.../tried_regions/total_bytes file and the
update_schemes_tried_bytes command.

Link: https://lkml.kernel.org/r/20230802213222.109841-6-sj@kernel.orgSigned-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent e91b5ccf
...@@ -87,7 +87,7 @@ comma (","). :: ...@@ -87,7 +87,7 @@ comma (","). ::
│ │ │ │ │ │ │ filters/nr_filters │ │ │ │ │ │ │ filters/nr_filters
│ │ │ │ │ │ │ │ 0/type,matching,memcg_id │ │ │ │ │ │ │ │ 0/type,matching,memcg_id
│ │ │ │ │ │ │ stats/nr_tried,sz_tried,nr_applied,sz_applied,qt_exceeds │ │ │ │ │ │ │ stats/nr_tried,sz_tried,nr_applied,sz_applied,qt_exceeds
│ │ │ │ │ │ │ tried_regions/ │ │ │ │ │ │ │ tried_regions/total_bytes
│ │ │ │ │ │ │ │ 0/start,end,nr_accesses,age │ │ │ │ │ │ │ │ 0/start,end,nr_accesses,age
│ │ │ │ │ │ │ │ ... │ │ │ │ │ │ │ │ ...
│ │ │ │ │ │ ... │ │ │ │ │ │ ...
...@@ -127,14 +127,18 @@ in the state. Writing ``commit`` to the ``state`` file makes kdamond reads the ...@@ -127,14 +127,18 @@ in the state. Writing ``commit`` to the ``state`` file makes kdamond reads the
user inputs in the sysfs files except ``state`` file again. Writing user inputs in the sysfs files except ``state`` file again. Writing
``update_schemes_stats`` to ``state`` file updates the contents of stats files ``update_schemes_stats`` to ``state`` file updates the contents of stats files
for each DAMON-based operation scheme of the kdamond. For details of the for each DAMON-based operation scheme of the kdamond. For details of the
stats, please refer to :ref:`stats section <sysfs_schemes_stats>`. Writing stats, please refer to :ref:`stats section <sysfs_schemes_stats>`.
``update_schemes_tried_regions`` to ``state`` file updates the DAMON-based
operation scheme action tried regions directory for each DAMON-based operation Writing ``update_schemes_tried_regions`` to ``state`` file updates the
scheme of the kdamond. Writing ``clear_schemes_tried_regions`` to ``state`` DAMON-based operation scheme action tried regions directory for each
file clears the DAMON-based operating scheme action tried regions directory for DAMON-based operation scheme of the kdamond. Writing
each DAMON-based operation scheme of the kdamond. For details of the ``update_schemes_tried_bytes`` to ``state`` file updates only
DAMON-based operation scheme action tried regions directory, please refer to ``.../tried_regions/total_bytes`` files. Writing
:ref:`tried_regions section <sysfs_schemes_tried_regions>`. ``clear_schemes_tried_regions`` to ``state`` file clears the DAMON-based
operating scheme action tried regions directory for each DAMON-based operation
scheme of the kdamond. For details of the DAMON-based operation scheme action
tried regions directory, please refer to :ref:`tried_regions section
<sysfs_schemes_tried_regions>`.
If the state is ``on``, reading ``pid`` shows the pid of the kdamond thread. If the state is ``on``, reading ``pid`` shows the pid of the kdamond thread.
...@@ -406,13 +410,21 @@ stats by writing a special keyword, ``update_schemes_stats`` to the relevant ...@@ -406,13 +410,21 @@ stats by writing a special keyword, ``update_schemes_stats`` to the relevant
schemes/<N>/tried_regions/ schemes/<N>/tried_regions/
-------------------------- --------------------------
This directory initially has one file, ``total_bytes``.
When a special keyword, ``update_schemes_tried_regions``, is written to the When a special keyword, ``update_schemes_tried_regions``, is written to the
relevant ``kdamonds/<N>/state`` file, DAMON creates directories named integer relevant ``kdamonds/<N>/state`` file, DAMON updates the ``total_bytes`` file so
starting from ``0`` under this directory. Each directory contains files that reading it returns the total size of the scheme tried regions, and creates
exposing detailed information about each of the memory region that the directories named integer starting from ``0`` under this directory. Each
corresponding scheme's ``action`` has tried to be applied under this directory, directory contains files exposing detailed information about each of the memory
during next :ref:`aggregation interval <sysfs_monitoring_attrs>`. The region that the corresponding scheme's ``action`` has tried to be applied under
information includes address range, ``nr_accesses``, and ``age`` of the region. this directory, during next :ref:`aggregation interval
<sysfs_monitoring_attrs>`. The information includes address range,
``nr_accesses``, and ``age`` of the region.
Writing ``update_schemes_tried_bytes`` to the relevant ``kdamonds/<N>/state``
file will only update the ``total_bytes`` file, and will not create the
subdirectories.
The directories will be removed when another special keyword, The directories will be removed when another special keyword,
``clear_schemes_tried_regions``, is written to the relevant ``clear_schemes_tried_regions``, is written to the relevant
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment