Skip to contentSkip to conversation

rust: devres: fix leaking call to devm_add_action()

PATCH Applied Danilo Krummrich 3 participants 6 messages Aug 12, 2025 – Aug 14, 2025

Subsystems (2)
lore
Share & tools
lore

Danilo Krummrich

author maintainer
#0 lore raw

PATCH v2 1/1 rust: devres: fix leaking call to devm_add_action()

When the data argument of Devres::new() is Err(), we leak the preceding call to devm_add_action().

In order to fix this, call devm_add_action() in a unit type initializer in try_pin_init!() after the initializers of all other fields.

Fixes f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")

---
Changes in v2:
- Drop inner in-place when devm_add_action() fails.
- Document to remove drop_in_place() once we can switch to UnsafePinned.

---
 rust/kernel/devres.rs | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)
rust/kernel/devres.rs +18 -9
index da18091143a6..d04e3fcebafb 100644
@@ -115,10 +115,11 @@ pub struct Devres<T: Send> {
     /// Contains all the fields shared with [`Self::callback`].
     // TODO: Replace with `UnsafePinned`, once available.
     //
-    // Subsequently, the `drop_in_place()` in `Devres::drop` and the explicit `Send` and `Sync'
-    // impls can be removed.
+    // Subsequently, the `drop_in_place()` in `Devres::drop` and `Devres::new` as well as the
+    // explicit `Send` and `Sync' impls can be removed.
     #[pin]
     inner: Opaque<Inner<T>>,
+    _add_action: (),
 }
 
 impl<T: Send> Devres<T> {
@@ -140,7 +141,15 @@ pub fn new<'a, E>(
             dev: dev.into(),
             callback,
             // INVARIANT: `inner` is properly initialized.
-            inner <- {
+            inner <- Opaque::pin_init(try_pin_init!(Inner {
+                    devm <- Completion::new(),
+                    revoke <- Completion::new(),
+                    data <- Revocable::new(data),
+            })),
+            // TODO: Replace with "initializer code blocks" [1] once available.
+            //
+            // [1] https://github.com/Rust-for-Linux/pin-init/pull/69
+            _add_action: {
                 // SAFETY: `this` is a valid pointer to uninitialized memory.
                 let inner = unsafe { &raw mut (*this.as_ptr()).inner };
 
@@ -152,13 +161,13 @@ pub fn new<'a, E>(
                 //    live at least as long as the returned `impl PinInit<Self, Error>`.
                 to_result(unsafe {
                     bindings::devm_add_action(dev.as_raw(), Some(callback), inner.cast())
-                })?;
+                }).inspect_err(|_| {
+                    let inner = Opaque::cast_into(inner);
 
-                Opaque::pin_init(try_pin_init!(Inner {
-                    devm <- Completion::new(),
-                    revoke <- Completion::new(),
-                    data <- Revocable::new(data),
-                }))
+                    // SAFETY: `inner` is a valid pointer to an `Inner<T>` and valid for both reads
+                    // and writes.
+                    unsafe { core::ptr::drop_in_place(inner) };
+                })?;
             },
         })
     }

base-commit: 8f5ae30d69d7543eee0d70083daf4de8fe15d585

Signature · 1 line
2.50.1
reviewer Reviewed-by on v2 1/1
#1 lore raw
Quoted 8 lines · Danilo Krummrich

When the data argument of Devres::new() is Err(), we leak the preceding call to devm_add_action().

In order to fix this, call devm_add_action() in a unit type initializer in try_pin_init!() after the initializers of all other fields.

Fixes f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")

---
Cheers,
Benno

Quoted 7 lines

---
Changes in v2:
- Drop inner in-place when devm_add_action() fails.
- Document to remove drop_in_place() once we can switch to UnsafePinned.

---
 rust/kernel/devres.rs | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)
reviewer Reviewed-by on v2 1/1
#2 lore raw
In reply to Danilo Krummrich
Quoted 8 lines · Danilo Krummrich

When the data argument of Devres::new() is Err(), we leak the preceding call to devm_add_action().

In order to fix this, call devm_add_action() in a unit type initializer in try_pin_init!() after the initializers of all other fields.

Fixes f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")

This looks ok:

But can't we do it like this instead?
1. Allocate devm job.
2. Initialize inner field.
3. Use allocation from (1.) to devm_add_action() infallibly.

This way, there's no risk that the inner value may get dropped, which could be an expensive operation.

Alice

author maintainer
#3 lore raw
Quoted 10 lines · Alice Ryhl
Quoted 8 lines · Danilo Krummrich

When the data argument of Devres::new() is Err(), we leak the preceding call to devm_add_action().

In order to fix this, call devm_add_action() in a unit type initializer in try_pin_init!() after the initializers of all other fields.

Fixes f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")
Quoted 8 lines

This looks ok:

But can't we do it like this instead?
1. Allocate devm job.
2. Initialize inner field.
3. Use allocation from (1.) to devm_add_action() infallibly.

Theoretically, we could with a few additions to the C API. But I don't think it's worth and I don't think we should do it in the context of this patch.

Quoted 2 lines

This way, there's no risk that the inner value may get dropped, which could be an expensive operation.

If we actually fail to allocate a devres node on the C side, I'm not that concerned about having to drop data.

However, there's also another reason why I think there's no need to consider it
now: I still have the rework on my list to get devres callbacks in place such that we can first revoke the Revocable objects of all corresponding Devres objects, call synchronize_rcu() once, and then drop the contained data in-place.

In this context I also plan to directly embedd a struct devres_node in the Rust Devres type, such that the *only* allocation that remains is the final one when the user of Devres allocates for the final impl PinInit, that directly or indirectly contains the Devres.

Once we have that, adding the devres node will also always be infallible.

reviewer
#4 lore raw
Quoted 34 lines · Danilo Krummrich
Quoted 10 lines · Alice Ryhl
Quoted 8 lines · Danilo Krummrich

When the data argument of Devres::new() is Err(), we leak the preceding call to devm_add_action().

In order to fix this, call devm_add_action() in a unit type initializer in try_pin_init!() after the initializers of all other fields.

Fixes f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")
Quoted 8 lines

This looks ok:

But can't we do it like this instead?
1. Allocate devm job.
2. Initialize inner field.
3. Use allocation from (1.) to devm_add_action() infallibly.

Theoretically, we could with a few additions to the C API. But I don't think it's worth and I don't think we should do it in the context of this patch.

Quoted 2 lines

This way, there's no risk that the inner value may get dropped, which could be an expensive operation.

If we actually fail to allocate a devres node on the C side, I'm not that concerned about having to drop data.

However, there's also another reason why I think there's no need to consider it
now: I still have the rework on my list to get devres callbacks in place such that we can first revoke the Revocable objects of all corresponding Devres objects, call synchronize_rcu() once, and then drop the contained data in-place.

Quoted 6 lines

In this context I also plan to directly embedd a struct devres_node in the Rust Devres type, such that the *only* allocation that remains is the final one when the user of Devres allocates for the final impl PinInit, that directly or indirectly contains the Devres.

Once we have that, adding the devres node will also always be infallible.

Embedding devres_node in Devres sounds look a good plan.

Alice

author maintainer Applied
#5 lore raw
In reply to Danilo Krummrich
Quoted 8 lines · Danilo Krummrich

When the data argument of Devres::new() is Err(), we leak the preceding call to devm_add_action().

In order to fix this, call devm_add_action() in a unit type initializer in try_pin_init!() after the initializers of all other fields.

Fixes f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")

Applied to driver-core-linus, thanks!