diff mbox series

[07/10] Docs/mm/damon/design: document pass/block filters behaviors

Message ID 20250107201739.79484-8-sj@kernel.org (mailing list archive)
State New
Headers show
Series mm/damon: extend DAMOS filters for inclusion | expand

Commit Message

SeongJae Park Jan. 7, 2025, 8:17 p.m. UTC
Update DAMOS filters design document to describe the pass/block
behavior of filters.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/mm/damon/design.rst | 34 +++++++++++++++++++++++++++----
 1 file changed, 30 insertions(+), 4 deletions(-)

Comments

SeongJae Park Jan. 8, 2025, 4:04 a.m. UTC | #1
On Tue, 7 Jan 2025 12:17:36 -0800 SeongJae Park <sj@kernel.org> wrote:

> Update DAMOS filters design document to describe the pass/block
> behavior of filters.
> 
> Signed-off-by: SeongJae Park <sj@kernel.org>
> ---
>  Documentation/mm/damon/design.rst | 34 +++++++++++++++++++++++++++----
>  1 file changed, 30 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
> index 449eb33688c2..3682e719b8a6 100644
> --- a/Documentation/mm/damon/design.rst
> +++ b/Documentation/mm/damon/design.rst
> @@ -504,9 +504,35 @@ have a list of latency-critical processes.
>  
>  To let users optimize DAMOS schemes with such special knowledge, DAMOS provides
>  a feature called DAMOS filters.  The feature allows users to set an arbitrary
> -number of filters for each scheme.  Each filter specifies the type of target
> -memory, and whether it should exclude the memory of the type (filter-out), or
> -all except the memory of the type (filter-in).
> +number of filters for each scheme.  Each filter specifies
> +
> +- a type of memory (``type``),
> +- whether it is for the memory of the type or all except the type
> +  (``matching``), and
> +- whether it is to allow (pass through the filter) or reject (block) applying
> +  the scheme's action to the memory (``pass``).
> +
> +When multiple filters are installed, each filter is evaluated in the installed
> +order.  If a part of memory is matched to one of the filter, next filters are
> +ignored.  If a part of memory is not matched to any of the filters, the default
> +behavior is applied.  That is, as long as it fulfills other conditions of the
> +scheme including the access pattern and quotas, the action will be applied to
> +the part of the memory.
> +
> +For example, let's assume 1) a filter for passing anonymous pages and 2)
> +another filter for blocking young pages are installed in the order.  If a page
> +of a region that eligible to apply the scheme's action is an anonymous page,
> +the scheme's action will be applied to the page regardless of whether it is
> +young or not, since it matches with the first filter.  If the page is not
> +anonymous but young, the scheme's action will not be applied, since the second
> +filter blocks it.  If the page is neither anonymous nor young, no filter is
> +involved, so the action will be applied to the page.
> +
> +The fact that the action can be applied to any memory as long as no block
> +filter explicitly excluded it means that installing pass filters without any
> +block filter after those is same to not installing the pass filters, in terms
> +of the ``action`` applying.  Statistics for DAMOS filters will still be
> +accounted, though.

The above last sentence is right in a sense, but not useful and could only
confuse readers.  The statistics for DAMOS filters are filters passed size
stat, which is provided as per-scheme accumulated stat and per-region instant
information.  The stat is for any memory that be able to apply the DAMOS action
after the filters check stage.  Hence, whether it has passed the stage due to
existence of a pass filter that matches the memory, or the absence of any
matching filter is distinguishable.

> It is therefore still useful for monitoring purpose.

Hence, the above sentence is completely wrong.  The case (installing pass
filtrs without any block filter after those) is not useful even for monitoring
purpose.

The RFC version of this patch was mentioning it correctly, but was not clearly
describing why it is not also useless for even monitoring purpose.  I was also
confused due to the absence of the context.  I will rewrite this part and send
the whole series again as v2.


Thanks,
SJ

[...]
SeongJae Park Jan. 8, 2025, 5:26 p.m. UTC | #2
On Tue, 7 Jan 2025 20:04:54 -0800 SeongJae Park <sj@kernel.org> wrote:

> On Tue, 7 Jan 2025 12:17:36 -0800 SeongJae Park <sj@kernel.org> wrote:
> 
[...]
> > +The fact that the action can be applied to any memory as long as no block
> > +filter explicitly excluded it means that installing pass filters without any
> > +block filter after those is same to not installing the pass filters, in terms
> > +of the ``action`` applying.  Statistics for DAMOS filters will still be
> > +accounted, though.
> 
> The above last sentence is right in a sense, but not useful and could only
> confuse readers.  The statistics for DAMOS filters are filters passed size
> stat, which is provided as per-scheme accumulated stat and per-region instant
> information.  The stat is for any memory that be able to apply the DAMOS action
> after the filters check stage.  Hence, whether it has passed the stage due to
> existence of a pass filter that matches the memory, or the absence of any
> matching filter is distinguishable.
> 
> > It is therefore still useful for monitoring purpose.
> 
> Hence, the above sentence is completely wrong.  The case (installing pass
> filtrs without any block filter after those) is not useful even for monitoring
> purpose.
> 
> The RFC version of this patch was mentioning it correctly, but was not clearly
> describing why it is not also useless for even monitoring purpose.  I was also
> confused due to the absence of the context.  I will rewrite this part and send
> the whole series again as v2.

Another reason that I was confused is the conflict of the term.  The term
'pass' at sz_filters_passed stat means passing through the filters checking
stage.  The same term 'pass' at "DAMOS pass filter" means it will let the
memory that matches to its criteria pass the stage.  Hence, the term for
'sz_filters_passed' is a superset of it for 'DAMOS pass filter'.  This is
obviously confusing.

I will rename things that introduced by this series to be called "allow"
instead of "pass" in v2.


Thanks,
SJ

> 
> 
> Thanks,
> SJ
> 
> [...]
diff mbox series

Patch

diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index 449eb33688c2..3682e719b8a6 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -504,9 +504,35 @@  have a list of latency-critical processes.
 
 To let users optimize DAMOS schemes with such special knowledge, DAMOS provides
 a feature called DAMOS filters.  The feature allows users to set an arbitrary
-number of filters for each scheme.  Each filter specifies the type of target
-memory, and whether it should exclude the memory of the type (filter-out), or
-all except the memory of the type (filter-in).
+number of filters for each scheme.  Each filter specifies
+
+- a type of memory (``type``),
+- whether it is for the memory of the type or all except the type
+  (``matching``), and
+- whether it is to allow (pass through the filter) or reject (block) applying
+  the scheme's action to the memory (``pass``).
+
+When multiple filters are installed, each filter is evaluated in the installed
+order.  If a part of memory is matched to one of the filter, next filters are
+ignored.  If a part of memory is not matched to any of the filters, the default
+behavior is applied.  That is, as long as it fulfills other conditions of the
+scheme including the access pattern and quotas, the action will be applied to
+the part of the memory.
+
+For example, let's assume 1) a filter for passing anonymous pages and 2)
+another filter for blocking young pages are installed in the order.  If a page
+of a region that eligible to apply the scheme's action is an anonymous page,
+the scheme's action will be applied to the page regardless of whether it is
+young or not, since it matches with the first filter.  If the page is not
+anonymous but young, the scheme's action will not be applied, since the second
+filter blocks it.  If the page is neither anonymous nor young, no filter is
+involved, so the action will be applied to the page.
+
+The fact that the action can be applied to any memory as long as no block
+filter explicitly excluded it means that installing pass filters without any
+block filter after those is same to not installing the pass filters, in terms
+of the ``action`` applying.  Statistics for DAMOS filters will still be
+accounted, though.  It is therefore still useful for monitoring purpose.
 
 For efficient handling of filters, some types of filters are handled by the
 core layer, while others are handled by operations set.  In the latter case,
@@ -516,7 +542,7 @@  filter are not counted as the scheme has tried to the region.  In contrast, if
 a memory regions is filtered by an operations set layer-handled filter, it is
 counted as the scheme has tried.  This difference affects the statistics.
 
-Below types of filters are currently supported.
+Below ``type`` of filters are currently supported.
 
 - anonymous page
     - Applied to pages that containing data that not stored in files.