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

Docs/mm/damon/design: add links from overall architecture to sections of details 

DAMON design document briefly explains the overall layers architecture
first, and then provides detailed explanations of each layer with
dedicated sections.  Letting readers go directly to the detailed sections
for specific layers could help easy browsing of the not-very-short
document.  Add links from the overall summary to the sections of details.

Link: https://lkml.kernel.org/r/20240701192706.51415-5-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 752f18b9

Documentation/mm/damon/design.rst

+13 −7
Original line number Diff line number Diff line
@@ -22,13 +22,15 @@ Overall Architecture 


DAMON subsystem is configured with three layers including



- Operations Set: Implements fundamental operations for DAMON that depends on

  the given monitoring target address-space and available set of

  software/hardware primitives,

- Core: Implements core logics including monitoring overhead/accuracy control

  and access-aware system operations on top of the operations set layer, and

- Modules: Implements kernel modules for various purposes that provides

  interfaces for the user space, on top of the core layer.

- :ref:`Operations Set <damon_operations_set>`: Implements fundamental

  operations for DAMON that depends on the given monitoring target

  address-space and available set of software/hardware primitives,

- :ref:`Core <damon_core_logic>`: Implements core logics including monitoring

  overhead/accuracy control and access-aware system operations on top of the

  operations set layer, and

- :ref:`Modules <damon_modules>`: Implements kernel modules for various

  purposes that provides interfaces for the user space, on top of the core

  layer.





.. _damon_design_configurable_operations_set:
@@ -140,6 +142,8 @@ conflict with the reclaim logic using ``PG_idle`` and ``PG_young`` page flags, 
as Idle page tracking does.





.. _damon_core_logic:



Core Logics

===========
@@ -512,6 +516,8 @@ interface, namely ``include/linux/damon.h``. Please refer to the API 
:doc:`document </mm/damon/api>` for details of the interface.





.. _damon_modules:



Modules

=======