Commit 4ddb2092 authored by Usama Arif's avatar Usama Arif Committed by Andrew Morton
Browse files

Docs/admin-guide/mm/damon/usage: document hugepage_size filter type 

This includes both the 'hugepage_size' filter type and the min/max files
used to decide range of sizes to filter on.

Link: https://lkml.kernel.org/r/20250211124437.278873-5-usamaarif642@gmail.com


Signed-off-by: default avatarUsama Arif <usamaarif642@gmail.com>
Reviewed-by: default avatarSeongJae Park <sj@kernel.org>
Cc: David Hildenbrand <david@redhat.com>
Cc: Johannes Weiner <hannes@cmpxchg.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 807db03c

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

+9 −8
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ comma (","). 
    │ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value

    │ │ │ │ │ │ │ :ref:`watermarks <sysfs_watermarks>`/metric,interval_us,high,mid,low

    │ │ │ │ │ │ │ :ref:`filters <sysfs_filters>`/nr_filters

    │ │ │ │ │ │ │ │ 0/type,matching,allow,memcg_path,addr_start,addr_end,target_idx

    │ │ │ │ │ │ │ │ 0/type,matching,allow,memcg_path,addr_start,addr_end,target_idx,min,max

    │ │ │ │ │ │ │ :ref:`stats <sysfs_schemes_stats>`/nr_tried,sz_tried,nr_applied,sz_applied,sz_ops_filter_passed,qt_exceeds

    │ │ │ │ │ │ │ :ref:`tried_regions <sysfs_schemes_tried_regions>`/total_bytes

    │ │ │ │ │ │ │ │ 0/start,end,nr_accesses,age,sz_filter_passed
@@ -406,13 +406,14 @@ number (``N``) to the file creates the number of child directories named ``0`` 
to ``N-1``.  Each directory represents each filter.  The filters are evaluated

in the numeric order.



Each filter directory contains seven files, namely ``type``, ``matching``,

``allow``, ``memcg_path``, ``addr_start``, ``addr_end``, and ``target_idx``.

To ``type`` file, you can write one of five special keywords: ``anon`` for

anonymous pages, ``memcg`` for specific memory cgroup, ``young`` for young

pages, ``addr`` for specific address range (an open-ended interval), or

``target`` for specific DAMON monitoring target filtering.  Meaning of the

types are same to the description on the :ref:`design doc

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>`.



In case of the memory cgroup filtering, you can specify the memory cgroup of