Docs/mm/damon: update intro, modules, maintainer profile, and misc
Subsystems (4)
SeongJae Park
maintainercover Docs/mm/damon: update intro, modules, maintainer profile, and misc
Update DAMON documentations for wordsmithing, clarifications, and miscellaneous outdated things with eight patches. Patch 1 simplifies the brief introduction of DAMON. Patch 2 updates DAMON user-space tool packaged distros information on design doc to include not only Fedora, but refer to repology. Three following patches update design and usage documents for clarifying DAMON sample modules purposes (patch 3), and outdated information about usages of DAMON modules (patches 4 and 5). Final three patches update usage and maintainer-profile for sysfs refresh_ms feature behavior (patch 6), synchronize DAMON MAINTAINERS section name (patch 7), and broken damon-tests performance tests (patch 8).
SeongJae Park (8):
Docs/mm/damon/index: simplify the intro Docs/mm/damon/design: link repology instead of Fedora package Docs/mm/damon/design: document DAMON sample modules Docs/mm/damon/design: add reference to DAMON_STAT usage Docs/admin-guide/mm/damon/usage: introduce DAMON modules at the
beginning
Docs/admin-guide/mm/damon/usage: update stats update process for
refresh_ms
Docs/mm/damon/maintainer-profile: fix wrong MAITNAINERS section name Docs/mm/damon/maintainer-profile: remove damon-tests/perf suggestion
Documentation/admin-guide/mm/damon/usage.rst | 16 +++++++--- Documentation/mm/damon/design.rst | 21 +++++++++++-- Documentation/mm/damon/index.rst | 31 ++++++------------- Documentation/mm/damon/maintainer-profile.rst | 7 ++--- 4 files changed, 42 insertions(+), 33 deletions(-)
base-commit: 4bdd7e0e4afe2bb6bc27862130f1cd365f3cbbef
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 1/8 Docs/mm/damon/index: simplify the intro
The intro is a bit verbose and redundant. Simplify it by replacing details with more links to the design docs, and refining the design points list.
--- Documentation/mm/damon/index.rst | 31 +++++++++---------------------- 1 file changed, 9 insertions(+), 22 deletions(-)
Documentation/mm/damon/index.rst +9 -22
@@ -4,28 +4,15 @@ DAMON: Data Access MONitoring and Access-aware System Operations ================================================================ -DAMON is a Linux kernel subsystem that provides a framework for data access -monitoring and the monitoring results based system operations. The core -monitoring :ref:`mechanisms <damon_design_monitoring>` of DAMON make it - - - *accurate* (the monitoring output is useful enough for DRAM level memory - management; It might not appropriate for CPU Cache levels, though), - - *light-weight* (the monitoring overhead is low enough to be applied online), - and - - *scalable* (the upper-bound of the overhead is in constant range regardless - of the size of target workloads). - -Using this framework, therefore, the kernel can operate system in an -access-aware fashion. Because the features are also exposed to the :doc:`user -space </admin-guide/mm/damon/index>`, users who have special information about -their workloads can write personalized applications for better understanding -and optimizations of their workloads and systems. - -For easier development of such systems, DAMON provides a feature called -:ref:`DAMOS <damon_design_damos>` (DAMon-based Operation Schemes) in addition -to the monitoring. Using the feature, DAMON users in both kernel and :doc:`user -spaces </admin-guide/mm/damon/index>` can do access-aware system operations -with no code but simple configurations. +DAMON is a Linux kernel subsystem for efficient :ref:`data access monitoring +<damon_design_monitoring>` and :ref:`access-aware system operations +<damon_design_damos>`. It is designed for being + + - *accurate* (for DRAM level memory management), + - *light-weight* (for production online usages), + - *scalable* (in terms of memory size), + - *tunable* (for flexible usages), and + - *autoamted* (for production operation without manual tunings). .. toctree:: :maxdepth: 2
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 2/8 Docs/mm/damon/design: link repology instead of Fedora package
In reply to SeongJae ParkThe document is introducing Fedora as one way to get DAMON user-space tool (damo) from OS-providing packaging system. Linux distros more than Fedora are providing damo with their packaging systems, though. Replace the Fedora part with the repology.org page that shows damo packaging status for multiple Linux distros.
--- Documentation/mm/damon/design.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/mm/damon/design.rst +2 -2
@@ -809,8 +809,8 @@ The ABIs are designed to be used for user space applications development, rather than human beings' fingers. Human users are recommended to use such user space tools. One such Python-written user space tool is available at Github (https://github.com/damonitor/damo), Pypi -(https://pypistats.org/packages/damo), and Fedora -(https://packages.fedoraproject.org/pkgs/python-damo/damo/). +(https://pypistats.org/packages/damo), and multiple distros +(https://repology.org/project/damo/versions). Currently, one module for this type, namely 'DAMON sysfs interface' is available. Please refer to the ABI :ref:`doc <sysfs_interface>` for details of
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 3/8 Docs/mm/damon/design: document DAMON sample modules
In reply to SeongJae ParkPeople sometimes get confused about the purposes of DAMON special-purpose modules and sample modules. Clarify those on the design document by adding a section describing their existence and purposes.
--- Documentation/mm/damon/design.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+)
Documentation/mm/damon/design.rst +13 -0
@@ -836,3 +836,16 @@ modules for proactive reclamation and LRU lists manipulation are provided. For more detail, please read the usage documents for those (:doc:`/admin-guide/mm/damon/reclaim` and :doc:`/admin-guide/mm/damon/lru_sort`). + + +Sample DAMON Modules +-------------------- + +DAMON modules that provides example DAMON kernel API usages. + +kernel programmers can build their own special or general purpose DAMON modules +using DAMON kernel API. To help them easily understand how DAMON kernel API +can be used, a few sample modules are provided under ``samples/damon/`` of the +linux source tree. Please note that these modules are not developed for being +used on real products, but only for showing how DAMON kernel API can be used in +simple ways.
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 4/8 Docs/mm/damon/design: add reference to DAMON_STAT usage
In reply to SeongJae ParkDesign document's special-purpose DAMON modules section is providing the list of links to the usage documents of existing DAMON modules. It is missing the link for DAMON_STAT, though. Add the missed link.
--- Documentation/mm/damon/design.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/mm/damon/design.rst +1 -1
@@ -834,7 +834,7 @@ To support such cases, yet more DAMON API user kernel modules that provide more simple and optimized user space interfaces are available. Currently, two modules for proactive reclamation and LRU lists manipulation are provided. For more detail, please read the usage documents for those -(:doc:`/admin-guide/mm/damon/reclaim` and +(:doc:`/admin-guide/mm/damon/stat`, :doc:`/admin-guide/mm/damon/reclaim` and :doc:`/admin-guide/mm/damon/lru_sort`).
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 5/8 Docs/admin-guide/mm/damon/usage: introduce DAMON modules at the beginning
In reply to SeongJae ParkDAMON usage document provides a list of available DAMON interfaces with brief introduction at the beginning of the doc. The list is missing DAMON modules for special purposes, while it is one of the major suggested interfaces. Add an item for those to the list.
--- Documentation/admin-guide/mm/damon/usage.rst | 5 +++++ Documentation/mm/damon/design.rst | 2 ++ 2 files changed, 7 insertions(+)
Documentation/admin-guide/mm/damon/usage.rst +5 -0
@@ -6,6 +6,11 @@ Detailed Usages DAMON provides below interfaces for different users. +- *Special-purpose DAMON modules.* + :ref:`This <damon_modules_special_purpose>` is for people who are building, + distributing, and/or administrating the kernel with special-purpose DAMON + usages. Using this, users can use DAMON's major features for the given + purposes in build, boot, or runtime in simple ways. - *DAMON user space tool.* `This <https://github.com/damonitor/damo>`_ is for privileged people such as system administrators who want a just-working human-friendly interface.
Documentation/mm/damon/design.rst +2 -0
@@ -817,6 +817,8 @@ available. Please refer to the ABI :ref:`doc <sysfs_interface>` for details of the interfaces. +.. _damon_modules_special_purpose: + Special-Purpose Access-aware Kernel Modules -------------------------------------------
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 6/8 Docs/admin-guide/mm/damon/usage: update stats update process for refresh_ms
In reply to SeongJae ParkDAMOS stats on sysfs was only manually updated. Recent addition of 'refresh_ms' knob enabled periodic and automated updates of the stats. The document for stats update process is not updated for the change, however. Update.
--- Documentation/admin-guide/mm/damon/usage.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)
Documentation/admin-guide/mm/damon/usage.rst +7 -4
@@ -549,10 +549,13 @@ online analysis or tuning of the schemes. Refer to :ref:`design doc The statistics can be retrieved by reading the files under ``stats`` directory (``nr_tried``, ``sz_tried``, ``nr_applied``, ``sz_applied``, ``sz_ops_filter_passed``, ``qt_exceeds``, ``nr_snapshots`` and -``max_nr_snapshots``), respectively. The files are not updated in real time, -so you should ask DAMON sysfs interface to update the content of the files for -the stats by writing a special keyword, ``update_schemes_stats`` to the -relevant ``kdamonds/<N>/state`` file. +``max_nr_snapshots``), respectively. + +The files are not updated in real time by default. Users should ask DAMON +sysfs interface to periodically update those using ``refresh_ms``, or do a one +time update by writing a special keyword, ``update_schemes_stats`` to the +relevant ``kdamonds/<N>/state`` file. Refer to :ref:`kdamond directory +<sysfs_kdamond>` for more details. .. _sysfs_schemes_tried_regions:
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 7/8 Docs/mm/damon/maintainer-profile: fix wrong MAITNAINERS section name
In reply to SeongJae ParkCommit 9044cbe50a70 ("MAINTAINERS: rename DAMON section") renamed the section for DAMON from "DATA ACCESS MONITOR" to "DAMON". But the commit forgot updating the name on the maintainer-profile document. Update.
--- Documentation/mm/damon/maintainer-profile.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/mm/damon/maintainer-profile.rst +2 -2
@@ -3,8 +3,8 @@ DAMON Maintainer Entry Profile ============================== -The DAMON subsystem covers the files that are listed in 'DATA ACCESS MONITOR' -section of 'MAINTAINERS' file. +The DAMON subsystem covers the files that are listed in 'DAMON' section of +'MAINTAINERS' file. The mailing lists for the subsystem are [email protected] and [email protected]. Patches should be made against the `mm-new tree
Signature · 1 line
2.47.3
SeongJae Park
maintainerPATCH 8/8 Docs/mm/damon/maintainer-profile: remove damon-tests/perf suggestion
In reply to SeongJae ParkThe DAMON performance tests [1] use PARSEC 3.0 as its major test workloads. But the official web site for PARSEC 3.0 has gone, so there is no easy way to get the benchmark. Mainly due to the fact, DAMON performance tests are difficult to run, and effectively broken. Do not request running it for now. Instead, suggest running any benchmarks or real world workloads that make sense for performance changes.
[1] https://github.com/damonitor/damon-tests/tree/master/perf
--- Documentation/mm/damon/maintainer-profile.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
Documentation/mm/damon/maintainer-profile.rst +1 -2
@@ -48,8 +48,7 @@ Further doing below and putting the results will be helpful. - Run `damon-tests/corr <https://github.com/damonitor/damon-tests/tree/master/corr>`_ for normal changes. -- Run `damon-tests/perf - <https://github.com/damonitor/damon-tests/tree/master/perf>`_ for performance +- Measure impacts on benchmarks or real world workloads for performance changes. Key cycle dates
Signature · 1 line
2.47.3