documentation-add-documents-for-damon.patch removed from -mm tree
The patch titled
Subject: Documentation: add documents for DAMON
has been removed from the -mm tree. Its filename was
documentation-add-documents-for-damon.patch
This patch was dropped because it was merged into mainline or a subsystem tree
------------------------------------------------------
From: SeongJae Park <[email protected]>
Subject: Documentation: add documents for DAMON
This commit adds documents for DAMON under Documentation/admin-guide/mm/damon/ and Documentation/vm/damon/.
Signed-off-by SeongJae Park <[email protected]>
Reviewed-by Fernand Sieber <[email protected]>
Reviewed-by Markus Boehme <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Amit Shah <[email protected]>
Cc Benjamin Herrenschmidt <[email protected]>
Cc Brendan Higgins <[email protected]>
Cc David Hildenbrand <[email protected]>
Cc David Rientjes <[email protected]>
Cc David Woodhouse <[email protected]>
Cc Fan Du <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc Greg Thelen <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Joe Perches <[email protected]>
Cc Jonathan Cameron <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Leonard Foerster <[email protected]>
Cc Marco Elver <[email protected]>
Cc Maximilian Heyne <[email protected]>
Cc Mel Gorman <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Rik van Riel <[email protected]>
Cc Shakeel Butt <[email protected]>
Cc Shuah Khan <[email protected]>
Cc Steven Rostedt (VMware) <[email protected]>
Cc Vladimir Davydov <[email protected]>
Cc Vlastimil Babka <[email protected]>
Signed-off-by Andrew Morton <[email protected]>
---
Documentation/admin-guide/mm/damon/index.rst | 15 + Documentation/admin-guide/mm/damon/start.rst | 114 +++++++++++ Documentation/admin-guide/mm/damon/usage.rst | 112 +++++++++++ Documentation/admin-guide/mm/index.rst | 1 Documentation/vm/damon/api.rst | 20 ++ Documentation/vm/damon/design.rst | 166 +++++++++++++++++ Documentation/vm/damon/faq.rst | 51 +++++ Documentation/vm/damon/index.rst | 30 +++ Documentation/vm/index.rst | 1 9 files changed, 510 insertions(+)
Documentation/admin-guide/mm/damon/index.rst new file +15 -0
@@ -0,0 +1,15 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================== +Monitoring Data Accesses +======================== + +:doc:`DAMON </vm/damon/index>` allows light-weight data access monitoring. +Using DAMON, users can analyze the memory access patterns of their systems and +optimize those. + +.. toctree:: + :maxdepth: 2 + + start + usage
Documentation/admin-guide/mm/damon/start.rst new file +114 -0
114 lines not on this page · raw message
Documentation/admin-guide/mm/damon/usage.rst new file +112 -0
112 lines not on this page · raw message
Documentation/admin-guide/mm/index.rst renamed from Documentation/admin-guide/mm/index.rst~documentation-add-documents-for-damon +1 -0
@@ -27,6 +27,7 @@ the Linux memory management. concepts cma_debugfs + damon/index hugetlbpage idle_page_tracking ksm
Documentation/vm/damon/api.rst new file +20 -0
@@ -0,0 +1,20 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============= +API Reference +============= + +Kernel space programs can use every feature of DAMON using below APIs. All you +need to do is including ``damon.h``, which is located in ``include/linux/`` of +the source tree. + +Structures +========== + +.. kernel-doc:: include/linux/damon.h + + +Functions +========= + +.. kernel-doc:: mm/damon/core.c
Documentation/vm/damon/design.rst new file +166 -0
166 lines not on this page · raw message
Documentation/vm/damon/faq.rst new file +51 -0
51 lines not on this page · raw message
Documentation/vm/damon/index.rst new file +30 -0
@@ -0,0 +1,30 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========================== +DAMON: Data Access MONitor +========================== + +DAMON is a data access monitoring framework subsystem for the Linux kernel. +The core mechanisms of DAMON (refer to :doc:`design` for the detail) 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's memory management mechanisms can +make advanced decisions. Experimental memory management optimization works +that incurring high data accesses monitoring overhead could implemented again. +In user space, meanwhile, users who have some special workloads can write +personalized applications for better understanding and optimizations of their +workloads and systems. + +.. toctree:: + :maxdepth: 2 + + faq + design + api + plans
Documentation/vm/index.rst renamed from Documentation/vm/index.rst~documentation-add-documents-for-damon +1 -0
@@ -32,6 +32,7 @@ descriptions of data structures and algo arch_pgtable_helpers balance cleancache + damon/index free_page_reporting frontswap highmem
_
Patches currently in -mm which might be from [email protected] are