ARM: mm: Make virt_to_pfn() a static inline
authorLinus Walleij <linus.walleij@linaro.org>
Thu, 2 Jun 2022 08:18:32 +0000 (10:18 +0200)
committerLinus Walleij <linus.walleij@linaro.org>
Mon, 29 May 2023 09:27:08 +0000 (11:27 +0200)
commita9ff6961601d9aa0c42b6eb7d850371f31b1f5e6
tree4f685558e06fb4667cb7634285d4d5eff4d1e7d8
parent2d78057f0dd41c5e24b824a3ea254a0672ec73eb
ARM: mm: Make virt_to_pfn() a static inline

Making virt_to_pfn() a static inline taking a strongly typed
(const void *) makes the contract of a passing a pointer of that
type to the function explicit and exposes any misuse of the
macro virt_to_pfn() acting polymorphic and accepting many types
such as (void *), (unitptr_t) or (unsigned long) as arguments
without warnings.

Doing this is a bit intrusive: virt_to_pfn() requires
PHYS_PFN_OFFSET and PAGE_SHIFT to be defined, and this is defined in
<asm/page.h>, so this must be included *before* <asm/memory.h>.

The use of macros were obscuring the unclear inclusion order here,
as the macros would eventually be resolved, but a static inline
like this cannot be compiled with unresolved macros.

The naive solution to include <asm/page.h> at the top of
<asm/memory.h> does not work, because <asm/memory.h> sometimes
includes <asm/page.h> at the end of itself, which would create a
confusing inclusion loop. So instead, take the approach to always
unconditionally include <asm/page.h> at the end of <asm/memory.h>

arch/arm uses <asm/memory.h> explicitly in a lot of places,
however it turns out that if we just unconditionally include
<asm/memory.h> into <asm/page.h> and switch all inclusions of
<asm/memory.h> to <asm/page.h> instead, we enforce the right
order and <asm/memory.h> will always have access to the
definitions.

Put an inclusion guard in place making it impossible to include
<asm/memory.h> explicitly.

Link: https://lore.kernel.org/linux-mm/20220701160004.2ffff4e5ab59a55499f4c736@linux-foundation.org/
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
46 files changed:
arch/arm/common/sharpsl_param.c
arch/arm/include/asm/delay.h
arch/arm/include/asm/io.h
arch/arm/include/asm/memory.h
arch/arm/include/asm/page.h
arch/arm/include/asm/pgtable.h
arch/arm/include/asm/proc-fns.h
arch/arm/include/asm/sparsemem.h
arch/arm/include/asm/uaccess-asm.h
arch/arm/include/asm/uaccess.h
arch/arm/kernel/asm-offsets.c
arch/arm/kernel/entry-armv.S
arch/arm/kernel/entry-common.S
arch/arm/kernel/entry-v7m.S
arch/arm/kernel/head-nommu.S
arch/arm/kernel/head.S
arch/arm/kernel/hibernate.c
arch/arm/kernel/suspend.c
arch/arm/kernel/tcm.c
arch/arm/kernel/vmlinux-xip.lds.S
arch/arm/kernel/vmlinux.lds.S
arch/arm/mach-berlin/platsmp.c
arch/arm/mach-keystone/keystone.c
arch/arm/mach-omap2/sleep33xx.S
arch/arm/mach-omap2/sleep43xx.S
arch/arm/mach-omap2/sleep44xx.S
arch/arm/mach-pxa/gumstix.c
arch/arm/mach-rockchip/sleep.S
arch/arm/mach-sa1100/pm.c
arch/arm/mach-shmobile/headsmp-scu.S
arch/arm/mach-shmobile/headsmp.S
arch/arm/mach-socfpga/headsmp.S
arch/arm/mach-spear/spear.h
arch/arm/mm/cache-fa.S
arch/arm/mm/cache-v4wb.S
arch/arm/mm/dma-mapping.c
arch/arm/mm/dump.c
arch/arm/mm/init.c
arch/arm/mm/kasan_init.c
arch/arm/mm/mmu.c
arch/arm/mm/physaddr.c
arch/arm/mm/pmsa-v8.c
arch/arm/mm/proc-v7.S
arch/arm/mm/proc-v7m.S
arch/arm/mm/pv-fixup-asm.S
drivers/memory/ti-emif-sram-pm.S