| From: SeongJae Park <sj@kernel.org> |
| Subject: Docs/admin-guide/mm/damon/usage: document addr_unit file |
| Date: Thu, 28 Aug 2025 10:12:40 -0700 |
| |
| Document addr_unit DAMON sysfs file on DAMON usage document. |
| |
| Link: https://lkml.kernel.org/r/20250828171242.59810-10-sj@kernel.org |
| Signed-off-by: SeongJae Park <sj@kernel.org> |
| Signed-off-by: Quanmin Yan <yanquanmin1@huawei.com> |
| Reviewed-by: SeongJae Park <sj@kernel.org> |
| Cc: David Hildenbrand <david@redhat.com> |
| Cc: Jonathan Corbet <corbet@lwn.net> |
| Cc: Kefeng Wang <wangkefeng.wang@huawei.com> |
| Cc: Liam Howlett <liam.howlett@oracle.com> |
| Cc: Lorenzo Stoakes <lorenzo.stoakes@oracle.com> |
| Cc: Michal Hocko <mhocko@suse.com> |
| Cc: Mike Rapoport <rppt@kernel.org> |
| Cc: Suren Baghdasaryan <surenb@google.com> |
| Cc: Vlastimil Babka <vbabka@suse.cz> |
| Cc: ze zuo <zuoze1@huawei.com> |
| Signed-off-by: Andrew Morton <akpm@linux-foundation.org> |
| --- |
| |
| Documentation/admin-guide/mm/damon/usage.rst | 11 +++++++---- |
| Documentation/mm/damon/design.rst | 2 ++ |
| 2 files changed, 9 insertions(+), 4 deletions(-) |
| |
| --- a/Documentation/admin-guide/mm/damon/usage.rst~docs-admin-guide-mm-damon-usage-document-addr_unit-file |
| +++ a/Documentation/admin-guide/mm/damon/usage.rst |
| @@ -61,7 +61,7 @@ comma (","). |
| │ :ref:`kdamonds <sysfs_kdamonds>`/nr_kdamonds |
| │ │ :ref:`0 <sysfs_kdamond>`/state,pid,refresh_ms |
| │ │ │ :ref:`contexts <sysfs_contexts>`/nr_contexts |
| - │ │ │ │ :ref:`0 <sysfs_context>`/avail_operations,operations |
| + │ │ │ │ :ref:`0 <sysfs_context>`/avail_operations,operations,addr_unit |
| │ │ │ │ │ :ref:`monitoring_attrs <sysfs_monitoring_attrs>`/ |
| │ │ │ │ │ │ intervals/sample_us,aggr_us,update_us |
| │ │ │ │ │ │ │ intervals_goal/access_bp,aggrs,min_sample_us,max_sample_us |
| @@ -188,9 +188,9 @@ details). At the moment, only one conte |
| contexts/<N>/ |
| ------------- |
| |
| -In each context directory, two files (``avail_operations`` and ``operations``) |
| -and three directories (``monitoring_attrs``, ``targets``, and ``schemes``) |
| -exist. |
| +In each context directory, three files (``avail_operations``, ``operations`` |
| +and ``addr_unit``) and three directories (``monitoring_attrs``, ``targets``, |
| +and ``schemes``) exist. |
| |
| DAMON supports multiple types of :ref:`monitoring operations |
| <damon_design_configurable_operations_set>`, including those for virtual address |
| @@ -205,6 +205,9 @@ You can set and get what type of monitor |
| context by writing one of the keywords listed in ``avail_operations`` file and |
| reading from the ``operations`` file. |
| |
| +``addr_unit`` file is for setting and getting the :ref:`address unit |
| +<damon_design_addr_unit>` parameter of the operations set. |
| + |
| .. _sysfs_monitoring_attrs: |
| |
| contexts/<N>/monitoring_attrs/ |
| --- a/Documentation/mm/damon/design.rst~docs-admin-guide-mm-damon-usage-document-addr_unit-file |
| +++ a/Documentation/mm/damon/design.rst |
| @@ -135,6 +135,8 @@ the interference is the responsibility o |
| conflict with the reclaim logic using ``PG_idle`` and ``PG_young`` page flags, |
| as Idle page tracking does. |
| |
| +.. _damon_design_addr_unit: |
| + |
| Address Unit |
| ------------ |
| |
| _ |