Skip to content

Commit 516ea04

Browse files
xp4ns3akpm00
authored andcommitted
Documentation/mm: don't kmap*() pages which can't come from HIGHMEM
There is no need to kmap*() pages which are guaranteed to come from ZONE_NORMAL (or lower). Linux has currently several call sites of kmap{,_atomic,_local_page}() on pages which are clearly known which can't come from ZONE_HIGHMEM. Therefore, add a paragraph to highmem.rst, to explain better that a plain page_address() may be used for getting the address of pages which cannot come from ZONE_HIGHMEM, although it is always safe to use kmap_local_page() / kunmap_local() also on those pages. Link: https://lkml.kernel.org/r/20220728154844.10874-4-fmdefrancesco@gmail.com Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com> Suggested-by: Ira Weiny <ira.weiny@intel.com> Cc: Matthew Wilcox (Oracle) <willy@infradead.org> Cc: Mike Rapoport <rppt@linux.ibm.com> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Catalin Marinas <catalin.marinas@arm.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Peter Collingbourne <pcc@google.com> Cc: Vlastimil Babka <vbabka@suse.cz> Cc: Will Deacon <will@kernel.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
1 parent 383bbef commit 516ea04

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/mm/highmem.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ list shows them in order of preference of use.
7171
kmap_local_page() always returns a valid virtual address and it is assumed
7272
that kunmap_local() will never fail.
7373

74+
On CONFIG_HIGHMEM=n kernels and for low memory pages this returns the
75+
virtual address of the direct mapping. Only real highmem pages are
76+
temporarily mapped. Therefore, users may call a plain page_address()
77+
for pages which are known to not come from ZONE_HIGHMEM. However, it is
78+
always safe to use kmap_local_page() / kunmap_local().
79+
7480
Nesting kmap_local_page() and kmap_atomic() mappings is allowed to a certain
7581
extent (up to KMAP_TYPE_NR) but their invocations have to be strictly ordered
7682
because the map implementation is stack based. See kmap_local_page() kdocs

0 commit comments

Comments
 (0)