Commit 87b83515 authored by SeongJae Park's avatar SeongJae Park Committed by Andrew Morton
Browse files

Docs/admin-guide/mm/damon/usage: document DAMOS quota goal path file 

A new DAMON sysfs interface file, namely 'path' has been added under DAMOS
quota goal directory, for specifying the cgroup for
DAMOS_QUOTA_NODE_MEMCG_{USED,FREE}_BP metrics.  Document it on the usage
document.

Link: https://lkml.kernel.org/r/20251017212706.183502-10-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 4cc00d41

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

+4 −4
Original line number Diff line number Diff line
@@ -81,7 +81,7 @@ comma (","). 
    │ │ │ │ │ │ │ :ref:`quotas <sysfs_quotas>`/ms,bytes,reset_interval_ms,effective_bytes

    │ │ │ │ │ │ │ │ weights/sz_permil,nr_accesses_permil,age_permil

    │ │ │ │ │ │ │ │ :ref:`goals <sysfs_schemes_quota_goals>`/nr_goals

    │ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value,nid

    │ │ │ │ │ │ │ │ │ 0/target_metric,target_value,current_value,nid,path

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

    │ │ │ │ │ │ │ :ref:`{core_,ops_,}filters <sysfs_filters>`/nr_filters

    │ │ │ │ │ │ │ │ 0/type,matching,allow,memcg_path,addr_start,addr_end,target_idx,min,max
@@ -402,9 +402,9 @@ number (``N``) to the file creates the number of child directories named ``0`` 
to ``N-1``.  Each directory represents each goal and current achievement.

Among the multiple feedback, the best one is used.



Each goal directory contains four files, namely ``target_metric``,

``target_value``, ``current_value`` and ``nid``.  Users can set and get the

four parameters for the quota auto-tuning goals that specified on the

Each goal directory contains five files, namely ``target_metric``,

``target_value``, ``current_value`` ``nid`` and ``path``.  Users can set and

get the five parameters for the quota auto-tuning goals that specified on the

:ref:`design doc <damon_design_damos_quotas_auto_tuning>` by writing to and

reading from each of the files.  Note that users should further write

``commit_schemes_quota_goals`` to the ``state`` file of the :ref:`kdamond