Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

rust: build_assert: add instructions for use with function arguments

`build_assert` relies on the compiler to optimize out its error path,
lest build fails with the dreaded error:

ERROR: modpost: "rust_build_error" [path/to/module.ko] undefined!

It has been observed that very trivial code performing I/O accesses
(sometimes even using an immediate value) would seemingly randomly fail
with this error whenever `CLIPPY=1` was set. The same behavior was also
observed until different, very similar conditions [1][2].

The cause appears to be that the failing function is eventually using
`build_assert` with its argument, but is only annotated with
`#[inline]`. This gives the compiler freedom to not inline the function,
which it notably did when Clippy was active, triggering the error.

The fix is to annotate functions passing their argument to
`build_assert` with `#[inline(always)]`, telling the compiler to be as
aggressive as possible with their inlining. This is also the correct
behavior as inlining is mandatory for correct behavior in these cases.

Add a paragraph instructing to annotate such functions with
`#[inline(always)]` in `build_assert`'s documentation, and split its
example to illustrate.

Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com>
Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
Link: https://patch.msgid.link/20251208-io-build-assert-v3-1-98aded02c1ea@nvidia.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

authored by

Alexandre Courbot and committed by
Miguel Ojeda
1b18b37a 9fa7153c

+6 -1
+6 -1
rust/kernel/build_assert.rs
··· 61 61 /// build_assert!(N > 1); // Build-time check 62 62 /// assert!(N > 1); // Run-time check 63 63 /// } 64 + /// ``` 64 65 /// 65 - /// #[inline] 66 + /// When a condition depends on a function argument, the function must be annotated with 67 + /// `#[inline(always)]`. Without this attribute, the compiler may choose to not inline the 68 + /// function, preventing it from optimizing out the error path. 69 + /// ``` 70 + /// #[inline(always)] 66 71 /// fn bar(n: usize) { 67 72 /// // `static_assert!(n > 1);` is not allowed 68 73 /// build_assert!(n > 1); // Build-time check