summaryrefslogtreecommitdiff
path: root/Documentation/mm/damon
diff options
context:
space:
mode:
authorSeongJae Park <sj@kernel.org>2023-05-26 00:43:13 +0300
committerAndrew Morton <akpm@linux-foundation.org>2023-06-10 02:25:48 +0300
commitf508a0fbd3807b9aa157612bba7cf2bafa9dbc97 (patch)
tree124a0a7ea229ef02ffd45085b79b7236cd92e504 /Documentation/mm/damon
parentb138878609be31615309af6400bf05937e076525 (diff)
downloadlinux-f508a0fbd3807b9aa157612bba7cf2bafa9dbc97.tar.xz
Docs/mm/damon/design: add a section for DAMON core API
Add a section covering the API of DAMON core layer on the design document. Link: https://lkml.kernel.org/r/20230525214314.5204-10-sj@kernel.org Signed-off-by: SeongJae Park <sj@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Diffstat (limited to 'Documentation/mm/damon')
-rw-r--r--Documentation/mm/damon/design.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index 706dbc17c6cb..0ccdd2f6af9f 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -358,3 +358,15 @@ example, the memory cgroup filter type asks users to specify the file path of
the memory cgroup for the filter. Hence, users can apply specific schemes to
only anonymous pages, non-anonymous pages, pages of specific cgroups, all pages
excluding those of specific cgroups, and any combination of those.
+
+
+Application Programming Interface
+---------------------------------
+
+The programming interface for kernel space data access-aware applications.
+DAMON is a framework, so it does nothing by itself. Instead, it only helps
+other kernel components such as subsystems and modules building their data
+access-aware applications using DAMON's core features. For this, DAMON exposes
+its all features to other kernel components via its application programming
+interface, namely ``include/linux/damon.h``. Please refer to the API
+:doc:`document </mm/damon/api>` for details of the interface.