linux-kernel - Re: [PATCH] rust: add `assert

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <2531463d-fa6e-430c-a3a6-b179654cfbbe@gmail.com>
Date: Sat, 7 Jun 2025 17:54:52 +0200
From: Christian Schrefl <chrisi.schrefl@...il.com>
To: Benno Lossin <lossin@...nel.org>, Miguel Ojeda <ojeda@...nel.org>,
 Alex Gaynor <alex.gaynor@...il.com>, Boqun Feng <boqun.feng@...il.com>,
 Gary Guo <gary@...yguo.net>, Björn Roy Baron
 <bjorn3_gh@...tonmail.com>, Andreas Hindborg <a.hindborg@...nel.org>,
 Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>,
 Danilo Krummrich <dakr@...nel.org>
Cc: linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org
Subject: Re: [PATCH] rust: add `assert_sync` function

On 07.06.25 5:42 PM, Benno Lossin wrote:
> On Sat Jun 7, 2025 at 3:02 PM CEST, Christian Schrefl wrote:
>> Adds a new file `compile_assert.rs` for asserts during compile time and
>> add the `assert_sync` function to this file.
>>
>> This will be used in `miscdevice` to avoid regression in case a `: Send`
>> bound falsely gets dropped in the future.
>>
>> Suggested-by: Benno Lossin <lossin@...nel.org>
>> Link: https://lore.kernel.org/rust-for-linux/20250530-b4-rust_miscdevice_registrationdata-v4-0-d313aafd7e59@gmail.com/T/#mdf3328834ce1d136daf836c9e089b5a8627a6d53
>> Signed-off-by: Christian Schrefl <chrisi.schrefl@...il.com>
> 
> Thanks!
> 
>> ---
>> For now I've only added the function.
>>
>> Some things that might make sense to do as well:
>> - Move `static_assert` into `compile_assert.rs`.
> 
> Sounds reasonable.
> 
>> - Add `assert_sync` to prelude.
> 
> I don't think we need to do that. At least not yet.

Alright

>> - Add `assert_send` as well.
> 
> Sounds like a good idea.

Should I already add this in V2 for this series?

> 
>> - Use these asserts in various places around the kernel. (I'm not sure
>> where it would make sense)
>> ---
>>  rust/kernel/compile_assert.rs | 24 ++++++++++++++++++++++++
>>  rust/kernel/lib.rs            |  1 +
>>  2 files changed, 25 insertions(+)
>>
>> diff --git a/rust/kernel/compile_assert.rs b/rust/kernel/compile_assert.rs
>> new file mode 100644
>> index 0000000000000000000000000000000000000000..2a99de1ba919dc3952d7a1585869567a44106b44
>> --- /dev/null
>> +++ b/rust/kernel/compile_assert.rs
>> @@ -0,0 +1,24 @@
>> +// SPDX-License-Identifier: GPL-2.0
>> +
>> +//! Compile-time asserts.
>> +
>> +/// Asserts that the given type is [`Sync`]. This check is done at compile time and does nothing
>> +/// at runtime.
>> +///
>> +/// Note that this is only intended to avoid regressions and for sanity checks.
>> +///
>> +/// # Examples
>> +/// ```
>> +/// # use kernel::compile_assert::assert_sync;
>> +/// # use kernel::types::NotThreadSafe;
>> +///
>> +///
>> +/// // Do the assertion in a const block to make sure it won't be executed at runtime.
>> +/// const _:() = {
> 
> s/_:()/_: ()/

Fixed.

> 
>> +///     assert_sync::<i32>(); // Succeeds because `i32` is Sync
>> +///     // assert_sync::<NotThreadSafe>(); // Fails because `NotThreadSafe` is not `Sync`.
> 
> Can you split this into two examples and mark the failing one with
> `compile_fail`?

I've tried it with `compile_fail` and it didn't work, I think
that's not supported in (kernel) doc tests yet. 

> 
> We also could provide a macro similar to [1].
>
> [1]: https://docs.rs/static_assertions/latest/static_assertions/

You mean the `assert_impl_*!` macros?

That might make sense, with macros we would not need to write
a const block to ensure its not executed at runtime (although
it's probably optimized out anyways). It would also mean that
we won't need a assert for every Trait, which seems nice.
So a macro sounds pretty good to me.

Cheers
Christian