linux-kernel - Re: [PATCH v2] rust: check type of `$ptr` in `container

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: <D96CSLWM105M.9P395XQ2ZWR4@proton.me>
Date: Mon, 14 Apr 2025 12:17:15 +0000
From: Benno Lossin <benno.lossin@...ton.me>
To: Tamir Duberstein <tamird@...il.com>, 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: rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] rust: check type of `$ptr` in `container_of!`

On Sat Apr 12, 2025 at 8:16 PM CEST, Tamir Duberstein wrote:
> Add a compile-time check that `*$ptr` is of the type of `$type->$($f)*`.
>
> Given the incorrect usage:
>
> ; diff --git a/rust/kernel/rbtree.rs b/rust/kernel/rbtree.rs
> ; index 8d978c896747..6a7089149878 100644
> ; --- a/rust/kernel/rbtree.rs
> ; +++ b/rust/kernel/rbtree.rs
> ; @@ -329,7 +329,7 @@ fn raw_entry(&mut self, key: &K) -> RawEntry<'_, K, V> {
> ;          while !(*child_field_of_parent).is_null() {
> ;              let curr = *child_field_of_parent;
> ;              // SAFETY: All links fields we create are in a `Node<K, V>`.
> ; -            let node = unsafe { container_of!(curr, Node<K, V>, links) };
> ; +            let node = unsafe { container_of!(curr, Node<K, V>, key) };
> ;
> ;              // SAFETY: `node` is a non-null node so it is valid by the type invariants.
> ;              match key.cmp(unsafe { &(*node).key }) {
>
> this patch produces the compilation error:
>
> ; error[E0308]: mismatched types
> ;    --> rust/kernel/lib.rs:206:26
> ;     |
> ; 206 |             [$field_ptr, field_ptr]; // typeof(`$ptr_to_field`) == typeof(`$Container.$($fields)*`)
> ;     |                          ^^^^^^^^^ expected `*mut rb_node`, found `*mut K`
> ;     |
> ;    ::: rust/kernel/rbtree.rs:270:6
> ;     |
> ; 270 | impl<K, V> RBTree<K, V>
> ;     |      - found this type parameter
> ; ...
> ; 332 |             let node = unsafe { container_of!(curr, Node<K, V>, key) };
> ;     |                                 ------------------------------------ in this macro invocation
> ;     |
> ;     = note: expected raw pointer `*mut bindings::rb_node`
> ;                found raw pointer `*mut K`
> ;     = note: this error originates in the macro `container_of` (in Nightly builds, run with -Z macro-backtrace for more info)
> ;
> ; error: aborting due to 1 previous error
>
> Suggested-by: Alice Ryhl <aliceryhl@...gle.com>
> Link: https://lore.kernel.org/all/CAH5fLgh6gmqGBhPMi2SKn7mCmMWfOSiS0WP5wBuGPYh9ZTAiww@mail.gmail.com/
> Signed-off-by: Tamir Duberstein <tamird@...il.com>

Reviewed-by: Benno Lossin <benno.lossin@...ton.me>

> ---
> I also considered an implementation using a function, but the resulting
> compilation error was not as concise:

Thanks for checking :)

---
Cheers,
Benno