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

Docs/admin-guide/mm/damon/usage: document 'nid' file 

Add description of 'nid' file, which is optionally used for specific DAMOS
quota goal metrics such as node_mem_{used,free}_bp on DAMON usage
document.

Link: https://lkml.kernel.org/r/20250420194030.75838-6-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Yunjeong Mun <yunjeong.mun@sk.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent b3b95a35

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

+6 −6
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

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

    │ │ │ │ │ │ │ :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
@@ -390,11 +390,11 @@ 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 three files, namely ``target_metric``,

``target_value`` and ``current_value``.  Users can set and get the three

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

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

: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

directory <sysfs_kdamond>` to pass the feedback to DAMON.