[PATCH] include/uapi/linux/swab: Fix potentially missing __always_inline

From: Florian Fainelli <f.fainelli@gmail.com>
To: linux-kernel@vger.kernel.org
Cc: "Matt Redfearn" <matt.redfearn@mips.com>,
	"Petr Vaněk" <arkamar@atlas.cz>,
	"Florian Fainelli" <f.fainelli@gmail.com>,
	"Nathan Chancellor" <nathan@kernel.org>,
	"Nick Desaulniers" <ndesaulniers@google.com>,
	"Tom Rix" <trix@redhat.com>, "Justin Stitt" <jstitt007@gmail.com>,
	"Andrew Morton" <akpm@linux-foundation.org>,
	"Denys Vlasenko" <dvlasenk@redhat.com>,
	"Ingo Molnar" <mingo@kernel.org>,
	llvm@lists.linux.dev (open list:CLANG/LLVM BUILD SUPPORT),
	"Peter Zijlstra" <peterz@infradead.org>,
	"Ingo Molnar" <mingo@redhat.com>,
	"Arnaldo Carvalho de Melo" <acme@kernel.org>,
	"Mark Rutland" <mark.rutland@arm.com>,
	"Alexander Shishkin" <alexander.shishkin@linux.intel.com>,
	"Jiri Olsa" <jolsa@kernel.org>,
	"Namhyung Kim" <namhyung@kernel.org>,
	linux-perf-users@vger.kernel.org (open list:PERFORMANCE EVENTS
	SUBSYSTEM), mmayer@broadcom.com, "Khem Raj" <raj.khem@gmail.com>,
	"Philippe Ombredanne" <pombredanne@nexb.com>,
	"Kate Stewart" <kstewart@linuxfoundation.org>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Thomas Gleixner" <tglx@linutronix.de>
Subject: [PATCH] include/uapi/linux/swab: Fix potentially missing __always_inline
Date: Tue, 27 Sep 2022 14:52:56 -0700	[thread overview]
Message-ID: <20220927215256.528619-1-f.fainelli@gmail.com> (raw)

From: Matt Redfearn <matt.redfearn@mips.com>

Commit bc27fb68aaad ("include/uapi/linux/byteorder, swab: force inlining
of some byteswap operations") added __always_inline to swab functions
and commit 283d75737837 ("uapi/linux/stddef.h: Provide __always_inline to
userspace headers") added a definition of __always_inline for use in
exported headers when the kernel's compiler.h is not available.

However, since swab.h does not include stddef.h, if the header soup does
not indirectly include it, the definition of __always_inline is missing,
resulting in a compilation failure, which was observed compiling the
perf tool using exported headers containing this commit:

In file included from /usr/include/linux/byteorder/little_endian.h:12:0,
                 from /usr/include/asm/byteorder.h:14,
                 from tools/include/uapi/linux/perf_event.h:20,
                 from perf.h:8,
                 from builtin-bench.c:18:
/usr/include/linux/swab.h:160:8: error: unknown type name `__always_inline'
 static __always_inline __u16 __swab16p(const __u16 *p)

Fix this by replacing the inclusion of linux/compiler.h with
linux/stddef.h to ensure that we pick up that definition if required,
without relying on it's indirect inclusion. compiler.h is then included
indirectly, via stddef.h.

Fixes: 283d75737837 ("uapi/linux/stddef.h: Provide __always_inline to userspace headers")
Signed-off-by: Matt Redfearn <matt.redfearn@mips.com>
Reviewed-by: Petr Vaněk <arkamar@atlas.cz>
Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
---
Apologies for the insanely long CC list. I encountered this problem
again while attempting to build perf with a LLVM 13 toolchain using
musl-libc. Not sure why it did not get picked up last time?

Khem did submit an alternative patch a few years ago, too which also did
not get picked up:

https://lore.kernel.org/lkml/20180913005654.39976-1-raj.khem@gmail.com/

 include/uapi/linux/swab.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/uapi/linux/swab.h b/include/uapi/linux/swab.h
index 0723a9cce747..01717181339e 100644
--- a/include/uapi/linux/swab.h
+++ b/include/uapi/linux/swab.h
@@ -3,7 +3,7 @@
 #define _UAPI_LINUX_SWAB_H
 
 #include <linux/types.h>
-#include <linux/compiler.h>
+#include <linux/stddef.h>
 #include <asm/bitsperlong.h>
 #include <asm/swab.h>
 
-- 
2.25.1

