Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Docs/vm/damon: call low level monitoring primitives the operations

Patch series "Docs/damon: Update documents for better consistency".

Some of DAMON document are not properly updated for latest version. This
patchset updates such parts.

This patch (of 3):

DAMON code calls the low level monitoring primitives implementations the
monitoring operations. The documentation would have no problem at still
calling those primitives implementation because there is no real
difference in the concepts, but making it more consistent with the code
would make it better. This commit therefore convert sentences in the doc
specifically pointing the implementations of the primitives to call it
monitoring operations.

Link: https://lkml.kernel.org/r/20220222170100.17068-1-sj@kernel.org
Link: https://lkml.kernel.org/r/20220222170100.17068-2-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>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

SeongJae Park and committed by
Linus Torvalds
561f4fc4 3213a3c1

+13 -13
+12 -12
Documentation/vm/damon/design.rst
··· 13 13 the other hand, the accuracy and overhead tradeoff mechanism, which is the core 14 14 of DAMON, is in the pure logic space. DAMON separates the two parts in 15 15 different layers and defines its interface to allow various low level 16 - primitives implementations configurable with the core logic. 16 + primitives implementations configurable with the core logic. We call the low 17 + level primitives implementations monitoring operations. 17 18 18 19 Due to this separated design and the configurable interface, users can extend 19 - DAMON for any address space by configuring the core logics with appropriate low 20 - level primitive implementations. If appropriate one is not provided, users can 21 - implement the primitives on their own. 20 + DAMON for any address space by configuring the core logics with appropriate 21 + monitoring operations. If appropriate one is not provided, users can implement 22 + the operations on their own. 22 23 23 24 For example, physical memory, virtual memory, swap space, those for specific 24 25 processes, NUMA nodes, files, and backing memory devices would be supportable. ··· 27 26 primitives, those will be easily configurable. 28 27 29 28 30 - Reference Implementations of Address Space Specific Primitives 31 - ============================================================== 29 + Reference Implementations of Address Space Specific Monitoring Operations 30 + ========================================================================= 32 31 33 - The low level primitives for the fundamental access monitoring are defined in 34 - two parts: 32 + The monitoring operations are defined in two parts: 35 33 36 34 1. Identification of the monitoring target address range for the address space. 37 35 2. Access check of specific address range in the target space. 38 36 39 - DAMON currently provides the implementations of the primitives for the physical 37 + DAMON currently provides the implementations of the operations for the physical 40 38 and virtual address spaces. Below two subsections describe how those work. 41 39 42 40 43 41 VMA-based Target Address Range Construction 44 42 ------------------------------------------- 45 43 46 - This is only for the virtual address space primitives implementation. That for 47 - the physical address space simply asks users to manually set the monitoring 48 - target address ranges. 44 + This is only for the virtual address space monitoring operations 45 + implementation. That for the physical address space simply asks users to 46 + manually set the monitoring target address ranges. 49 47 50 48 Only small parts in the super-huge virtual address space of the processes are 51 49 mapped to the physical memory and accessed. Thus, tracking the unmapped
+1 -1
Documentation/vm/damon/faq.rst
··· 31 31 ======================================= 32 32 33 33 No. The core of the DAMON is address space independent. The address space 34 - specific low level primitive parts including monitoring target regions 34 + specific monitoring operations including monitoring target regions 35 35 constructions and actual access checks can be implemented and configured on the 36 36 DAMON core by the users. In this way, DAMON users can monitor any address 37 37 space with any access check technique.