diff mbox series

[v4,6/6] Docs/admin-guide/mm/damon/usage: Document hugepage filter type

Message ID 20250203225604.44742-7-usamaarif642@gmail.com (mailing list archive)
State New
Headers show
Series mm/damon: add support for hugepages | expand

Commit Message

Usama Arif Feb. 3, 2025, 10:55 p.m. UTC
This includes both the 'hugepage' filter type and the min/max
files used to decide range of sizes to filter on.

Signed-off-by: Usama Arif <usamaarif642@gmail.com>
---
 Documentation/admin-guide/mm/damon/usage.rst | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

Comments

SeongJae Park Feb. 4, 2025, 11:13 p.m. UTC | #1
On Mon,  3 Feb 2025 22:55:33 +0000 Usama Arif <usamaarif642@gmail.com> wrote:

> This includes both the 'hugepage' filter type and the min/max
> files used to decide range of sizes to filter on.
> 
> Signed-off-by: Usama Arif <usamaarif642@gmail.com>
> ---
>  Documentation/admin-guide/mm/damon/usage.rst | 17 +++++++++--------
>  1 file changed, 9 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
> index 47a44bd348ab..5765896aaa7e 100644
> --- a/Documentation/admin-guide/mm/damon/usage.rst
> +++ b/Documentation/admin-guide/mm/damon/usage.rst
> @@ -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`` for large folios of a specific size range [``min``,

I'd prefer naming it ``hugepage_size``.

> +``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
> -- 
> 2.43.5


Thanks,
SJ
diff mbox series

Patch

diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index 47a44bd348ab..5765896aaa7e 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -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`` 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