Docs/damon: move DAMOS filter type names and meaning to design doc

DAMON sysfs usage doc is describing DAMOS filter type names and their
meanings in short.  The design doc is providing the short meaning and
detailed descriptions, too.  This is unnecessary duplicates and confuses
where to document new DAMOS filter types and features.  Move the details
from usage to design doc.

Link: https://lkml.kernel.org/r/20250218223708.53437-4-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
SeongJae Park 2025-02-18 14:37:06 -08:00 committed by Andrew Morton
parent e52a942b47
commit 0f28583b28
2 changed files with 18 additions and 20 deletions

View File

@ -408,21 +408,19 @@ in the numeric order.
Each filter directory contains nine files, namely ``type``, ``matching``,
``allow``, ``memcg_path``, ``addr_start``, ``addr_end``, ``min``, ``max``
and ``target_idx``. To ``type`` file, you can write one of six special
keywords: ``anon`` for anonymous pages, ``memcg`` for specific memory cgroup,
``young`` for young pages, ``addr`` for specific address range (an open-ended
interval), ``hugepage_size`` for large folios of a specific size range [``min``,
``max``] or ``target`` for specific DAMON monitoring target filtering. Meaning
of the types are same to the description on the :ref:`design doc
<damon_design_damos_filters>`.
and ``target_idx``. To ``type`` file, you can write the type of the filter.
Refer to :ref:`the design doc <damon_design_damos_filters>` for available type
names and their meanings.
In case of the memory cgroup filtering, you can specify the memory cgroup of
the interest by writing the path of the memory cgroup from the cgroups mount
point to ``memcg_path`` file. In case of the address range filtering, you can
specify the start and end address of the range to ``addr_start`` and
``addr_end`` files, respectively. For the DAMON monitoring target filtering,
you can specify the index of the target between the list of the DAMON context's
monitoring targets list to ``target_idx`` file.
For ``memcg`` type, you can specify the memory cgroup of the interest by
writing the path of the memory cgroup from the cgroups mount point to
``memcg_path`` file. For ``addr`` type, you can specify the start and end
address of the range (open-ended interval) to ``addr_start`` and ``addr_end``
files, respectively. For ``hugepage_size`` type, you can specify the minimum
and maximum size of the range (closed interval) to ``min`` and ``max`` files,
respectively. For ``target`` type, you can specify the index of the target
between the list of the DAMON context's monitoring targets list to
``target_idx`` file.
You can write ``Y`` or ``N`` to ``matching`` file to specify whether the filter
is for memory that matches the ``type``. You can write ``Y`` or ``N`` to

View File

@ -600,23 +600,23 @@ counted as the scheme has tried. This difference affects the statistics.
Below ``type`` of filters are currently supported.
- anonymous page
- anon
- Applied to pages that containing data that not stored in files.
- Handled by operations set layer. Supported by only ``paddr`` set.
- memory cgroup
- memcg
- Applied to pages that belonging to a given cgroup.
- Handled by operations set layer. Supported by only ``paddr`` set.
- young page
- young
- Applied to pages that are accessed after the last access check from the
scheme.
- Handled by operations set layer. Supported by only ``paddr`` set.
- pages that managed in a given size range
- hugepage_size
- Applied to pages that managed in a given size range.
- Handled by operations set layer. Supported by only ``paddr`` set.
- address range
- addr
- Applied to pages that belonging to a given address range.
- Handled by the core logic.
- DAMON monitoring target
- target
- Applied to pages that belonging to a given DAMON monitoring target.
- Handled by the core logic.