Documentation/vm: Rework and extend highmem.rst
v3 cover Documentation/vm: Rework and extend highmem.rst
Extend and rework the "Temporary Virtual Mappings" section of the highmem.rst documentation.
Do a partial rework of the paragraph related to kmap() and add a new paragraph in order to document the set of kmap_local_*() functions. Re-order paragraphs in decreasing order of preference of usage.
Include kerneldoc comments from include/linux/highmem.h and remove redundant and obsolete section about kmap_atomic().
v1-v2:
1/2 - According to comments on v1 by Mattew Wilcox and Ira Weiny,
correct a mistake in text, format paragraphs to stay within the 75 characters limit, re-order the flow of the same paragraphs in decreasing order of preference of usage.
2/2 - No patch.
v2->v3:
1/2 - No changes.
2/2 - Added patch to include kernel-doc to highmem.rst and
remove the now redundant section about kmap_atomic().
Fabio M. De Francesco (2):
Documentation/vm: Extend "Temporary Virtual Mappings" section in
highmem.rst
Documentation/vm: Include kernel-doc to highmem.rst
Documentation/vm/highmem.rst | 96 +++++++++++++++++++++--------------- 1 file changed, 56 insertions(+), 40 deletions(-)
Signature · 1 line
2.34.1
PATCH v3 1/2 Documentation/vm: Extend "Temporary Virtual Mappings" section
Extend and rework the "Temporary Virtual Mappings" section of the highmem.rst documentation.
Do a partial rework of the paragraph related to kmap() and add a new paragraph in order to document the set of kmap_local_*() functions. Re-order paragraphs in decreasing order of preference of usage.
Despite the local kmaps were introduced by Thomas Gleixner in October 2020, documentation was still missing information about them. These additions rely largely on Gleixner's patches, Jonathan Corbet's LWN articles, comments by Ira Weiny and Matthew Wilcox, and in-code comments from ./include/linux/highmem.h.
--- Documentation/vm/highmem.rst | 67 ++++++++++++++++++++++++++++++------ 1 file changed, 56 insertions(+), 11 deletions(-)
Documentation/vm/highmem.rst +56 -11
@@ -52,24 +52,69 @@ Temporary Virtual Mappings The kernel contains several ways of creating temporary mappings: -* vmap(). This can be used to make a long duration mapping of multiple - physical pages into a contiguous virtual space. It needs global - synchronization to unmap. - -* kmap(). This permits a short duration mapping of a single page. It needs - global synchronization, but is amortized somewhat. It is also prone to - deadlocks when using in a nested fashion, and so it is not recommended for - new code. +* kmap_local_*(). These provide a set of functions that are used to require + short term mappings. They can be invoked from any context (including + interrupts) but the mappings can only be used in the context which acquired + it. + + These mappings are per thread, CPU local (i.e., migration from one CPU to + another is disabled - this is why they are called "local"), but they don't + disable preemption. It's valid to take pagefaults in a local kmap region, + unless the context in which the local mapping is acquired does not allow + it for other reasons. + + If a task holding local kmaps is preempted, the maps are removed on context + switch and restored when the task comes back on the CPU. As the maps are + strictly CPU local, it is guaranteed that the task stays on the CPU and + that the CPU cannot be unplugged until the local kmaps are released. + + Nesting kmap_local.*() and kmap_atomic.*() mappings is allowed to a certain + extent (up to KMAP_TYPE_NR). Nested kmap_local.*() and kunmap_local.*() + invocations have to be strictly ordered because the map implementation is + stack based. * kmap_atomic(). This permits a very short duration mapping of a single page. Since the mapping is restricted to the CPU that issued it, it performs well, but the issuing task is therefore required to stay on that CPU until it has finished, lest some other task displace its mappings. - kmap_atomic() may also be used by interrupt contexts, since it is does not - sleep and the caller may not sleep until after kunmap_atomic() is called. + kmap_atomic() may also be used by interrupt contexts, since it does not + sleep and the caller too can not sleep until after kunmap_atomic() is called. + Each call of kmap_atomic() in the kernel creates a non-preemptible section and + disable pagefaults. + + This could be a source of unwanted latency, so it should be only used if it is + absolutely required, otherwise the corresponding kmap_local_*() variant should + be used if it is feasible. + + On 64-bit systems, calls to kmap() and kmap_atomic() have no real work to do + because a 64-bit address space is more than sufficient to address all the + physical memory, so all of physical memory appears in the direct mapping. + + It is assumed that k[un]map_atomic() won't fail. - It may be assumed that k[un]map_atomic() won't fail. +* kmap(). This should be used to make short duration mapping of a single + page with no restrictions on preemption or migration. It comes with an + overhead as mapping space is restricted and protected by a global lock + for synchronization. When mapping is no more needed, the address that + the page was mapped to must be released with kunmap(). + + Mapping changes must be propagated across all the CPUs. kmap() also + requires global TLB invalidation when the kmap's pool wraps and it might + block when the mapping space is fully utilized until a slot becomes + available. Therefore, kmap() is only callable from preemptible context. + + All the above work is necessary if a mapping must last for a relatively + long time but the bulk of high-memory mappings in the kernel are + short-lived and only used in one place. This means that the cost of + kmap() is mostly wasted in such cases. kmap() was not intended for long + term mappings but it has morphed in that direction and its use is + strongly discouraged in newer code and the set of the preceding functions + should be preferred. + +* vmap(). This can be used to make a long duration mapping of multiple + physical pages into a contiguous virtual space. It needs global + synchronization to unmap. Using kmap_atomic
Signature · 1 line
2.34.1
PATCH v3 2/2 Documentation/vm: Include kernel-doc to highmem.rst
In reply to Fabio M. De FrancescoInclude kernel-doc comments to highmem.rst from include/kernel/highmem.h.
From now on, the "Using kmap_atomic" section is redundant and obsolete, therefore remove it.
--- Documentation/vm/highmem.rst | 41 ++++++------------------------------ 1 file changed, 6 insertions(+), 35 deletions(-)
Documentation/vm/highmem.rst +6 -35
@@ -117,41 +117,6 @@ The kernel contains several ways of creating temporary mappings: synchronization to unmap. -Using kmap_atomic -================= - -When and where to use kmap_atomic() is straightforward. It is used when code -wants to access the contents of a page that might be allocated from high memory -(see __GFP_HIGHMEM), for example a page in the pagecache. The API has two -functions, and they can be used in a manner similar to the following:: - - /* Find the page of interest. */ - struct page *page = find_get_page(mapping, offset); - - /* Gain access to the contents of that page. */ - void *vaddr = kmap_atomic(page); - - /* Do something to the contents of that page. */ - memset(vaddr, 0, PAGE_SIZE); - - /* Unmap that page. */ - kunmap_atomic(vaddr); - -Note that the kunmap_atomic() call takes the result of the kmap_atomic() call -not the argument. - -If you need to map two pages because you want to copy from one page to -another you need to keep the kmap_atomic calls strictly nested, like:: - - vaddr1 = kmap_atomic(page1); - vaddr2 = kmap_atomic(page2); - - memcpy(vaddr1, vaddr2, PAGE_SIZE); - - kunmap_atomic(vaddr2); - kunmap_atomic(vaddr1); - - Cost of Temporary Mappings ==========================
@@ -190,3 +155,9 @@ The general recommendation is that you don't use more than 8GiB on a 32-bit machine - although more might work for you and your workload, you're pretty much on your own - don't expect kernel developers to really care much if things come apart. + + +Functions +========= + +.. kernel-doc:: include/linux/highmem.h
Signature · 1 line
2.34.1
Quoted 1 line · On sabato 16 aprile 2022 00:48:57 CEST Fabio M. De Francesco wrote:
Extend and rework the "Temporary Virtual Mappings" section of the
highmem.rst
Quoted 3 lines
documentation.
Do a partial rework of the paragraph related to
kmap()and add a new
paragraph
Quoted 1 line
in order to document the set of kmap_local_*() functions. Re-order
paragraphs
Quoted 7 lines
in decreasing order of preference of usage.
Include kerneldoc comments from
include/linux/highmem.hand remove redundant and obsolete section aboutkmap_atomic().v1-v2:
1/2 - According to comments on v1 by Matthew Wilcox and Ira
Weiny,
Quoted 10 lines
correct a mistake in text, format paragraphs to stay within the 75 characters limit, re-order the flow of the same paragraphs in decreasing order of preference of usage.
2/2 - No patch.
v2->v3:
1/2 - No changes.
2/2 - Added patch to include kernel-doc tohighmem.rstand
remove the now redundant section aboutkmap_atomic().
Quoted 10 lines
Fabio M. De Francesco (2):
Documentation/vm: Extend "Temporary Virtual Mappings" section in
highmem.rst
Documentation/vm: Include kernel-doc tohighmem.rstDocumentation/vm/highmem.rst | 96 +++++++++++++++++++++--------------- 1 file changed, 56 insertions(+), 40 deletions(-)Signature · 1 line
2.34.1
I'm sorry but I need to resend the whole series because for some reasons I forgot to CC the relevant lists.
Again, sorry for the noise,
Fabio M. De Francesco