diff mbox series

arm64: sysreg: Generate C compiler warnings on {read,write}_sysreg_s arguments

Message ID 20230815140639.614769-1-james.clark@arm.com (mailing list archive)
State New, archived
Headers show
Series arm64: sysreg: Generate C compiler warnings on {read,write}_sysreg_s arguments | expand

Commit Message

James Clark Aug. 15, 2023, 2:06 p.m. UTC
Evaluate the register before the asm section so that the C compiler
generates warnings when there is an issue with the register argument.

This will prevent possible future issues such as the one seen here [1]
where a missing bracket caused the shift and addition operators to be
evaluated in the wrong order, but no warning was emitted. The GNU
assembler has no warning for when expressions evaluate differently to C
due to different operator precedence, but the C compiler has some
warnings that may suggest something is wrong. For example in this case
the following warning would have been emitted:

  error: operator '>>' has lower precedence than '+'; '+' will be evaluated first [-Werror,-Wshift-op-parentheses]

There are currently no existing warnings that need to be fixed.

[1]: https://lore.kernel.org/linux-perf-users/20230728162011.GA22050@willie-the-truck/
Signed-off-by: James Clark <james.clark@arm.com>
---
 arch/arm64/include/asm/sysreg.h | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Will Deacon Aug. 16, 2023, 6:25 p.m. UTC | #1
On Tue, 15 Aug 2023 15:06:39 +0100, James Clark wrote:
> Evaluate the register before the asm section so that the C compiler
> generates warnings when there is an issue with the register argument.
> 
> This will prevent possible future issues such as the one seen here [1]
> where a missing bracket caused the shift and addition operators to be
> evaluated in the wrong order, but no warning was emitted. The GNU
> assembler has no warning for when expressions evaluate differently to C
> due to different operator precedence, but the C compiler has some
> warnings that may suggest something is wrong. For example in this case
> the following warning would have been emitted:
> 
> [...]

Applied to arm64 (for-next/misc), thanks!

[1/1] arm64: sysreg: Generate C compiler warnings on {read,write}_sysreg_s arguments
      https://git.kernel.org/arm64/c/18b8f57a7f51

Cheers,
diff mbox series

Patch

diff --git a/arch/arm64/include/asm/sysreg.h b/arch/arm64/include/asm/sysreg.h
index 0c07b03d511f..71eb8ea7c795 100644
--- a/arch/arm64/include/asm/sysreg.h
+++ b/arch/arm64/include/asm/sysreg.h
@@ -777,15 +777,21 @@ 
 /*
  * For registers without architectural names, or simply unsupported by
  * GAS.
+ *
+ * __check_r forces warnings to be generated by the compiler when
+ * evaluating r which wouldn't normally happen due to being passed to
+ * the assembler via __stringify(r).
  */
 #define read_sysreg_s(r) ({						\
 	u64 __val;							\
+	u32 __maybe_unused __check_r = (u32)(r);			\
 	asm volatile(__mrs_s("%0", r) : "=r" (__val));			\
 	__val;								\
 })
 
 #define write_sysreg_s(v, r) do {					\
 	u64 __val = (u64)(v);						\
+	u32 __maybe_unused __check_r = (u32)(r);			\
 	asm volatile(__msr_s(r, "%x0") : : "rZ" (__val));		\
 } while (0)