rust: add `Ownable` trait and `Owned` type
| From: | Andreas Hindborg <a.hindborg-AT-kernel.org> | |
| To: | Miguel Ojeda <ojeda-AT-kernel.org>, Gary Guo <gary-AT-garyguo.net>, Björn Roy Baron <bjorn3_gh-AT-protonmail.com>, Benno Lossin <lossin-AT-kernel.org>, Alice Ryhl <aliceryhl-AT-google.com>, Trevor Gross <tmgross-AT-umich.edu>, Danilo Krummrich <dakr-AT-kernel.org>, Greg Kroah-Hartman <gregkh-AT-linuxfoundation.org>, Dave Ertman <david.m.ertman-AT-intel.com>, Ira Weiny <ira.weiny-AT-intel.com>, Leon Romanovsky <leon-AT-kernel.org>, Paul Moore <paul-AT-paul-moore.com>, Serge Hallyn <sergeh-AT-kernel.org>, "Rafael J. Wysocki" <rafael-AT-kernel.org>, David Airlie <airlied-AT-gmail.com>, Simona Vetter <simona-AT-ffwll.ch>, Alexander Viro <viro-AT-zeniv.linux.org.uk>, Christian Brauner <brauner-AT-kernel.org>, Jan Kara <jack-AT-suse.cz>, Daniel Almeida <daniel.almeida-AT-collabora.com>, Viresh Kumar <vireshk-AT-kernel.org>, Nishanth Menon <nm-AT-ti.com>, Stephen Boyd <sboyd-AT-kernel.org>, Bjorn Helgaas <bhelgaas-AT-google.com>, Krzysztof Wilczyński <kwilczynski-AT-kernel.org>, Boqun Feng <boqun-AT-kernel.org>, Uladzislau Rezki <urezki-AT-gmail.com>, Lorenzo Stoakes <ljs-AT-kernel.org>, Vlastimil Babka <vbabka-AT-kernel.org>, "Liam R. Howlett" <liam-AT-infradead.org>, Igor Korotin <igor.korotin-AT-linux.dev>, Pavel Tikhomirov <ptikhomirov-AT-virtuozzo.com>, Boqun Feng <boqun-AT-kernel.org>, Igor Korotin <igor.korotin-AT-linux.dev>, Lorenzo Stoakes <ljs-AT-kernel.org>, "Liam R. Howlett" <liam-AT-infradead.org>, Vlastimil Babka <vbabka-AT-kernel.org> | |
| Subject: | [PATCH v17 00/10] rust: add `Ownable` trait and `Owned` type | |
| Date: | Thu, 04 Jun 2026 22:11:12 +0200 | |
| Message-ID: | <20260604-unique-ref-v17-0-7b4c3d2930b9@kernel.org> | |
| Cc: | linux-kernel-AT-vger.kernel.org, rust-for-linux-AT-vger.kernel.org, linux-block-AT-vger.kernel.org, linux-security-module-AT-vger.kernel.org, dri-devel-AT-lists.freedesktop.org, linux-fsdevel-AT-vger.kernel.org, linux-mm-AT-kvack.org, linux-pm-AT-vger.kernel.org, linux-pci-AT-vger.kernel.org, Andreas Hindborg <a.hindborg-AT-kernel.org>, driver-core-AT-lists.linux.dev, Asahi Lina <lina+kernel-AT-asahilina.net>, Oliver Mangold <oliver.mangold-AT-pm.me>, Viresh Kumar <viresh.kumar-AT-linaro.org>, Asahi Lina <lina+kernel-AT-asahilina.net>, Andreas Hindborg <a.hindborg-AT-kernel.org> | |
| Archive-link: | Article |
Add a new trait `Ownable` and type `Owned` for types that specify their own way of performing allocation and destruction. This is useful for types from the C side. Implement `ForeignOwnable` for `Owned`. Convert `Page` to be `Ownable` and add a `from_raw` method. Add the trait `OwnableRefCounted` that allows conversion between `ARef` and `Owned`. This is analogous to conversion between `Arc` and `UniqueArc`. Patches 1-5 implement `Ownable` and applies it to `Page`. These patches can be merged on their own. Patches 6-9 add `Ownable` -> `ARef` interop and can be merged later if consensus on their shape cannot be reached. Signed-off-by: Andreas Hindborg <a.hindborg@kernel.org> --- Changes in v17: - Rebase on v7.1-rc2. - Reorder patches so that `Ownable` can merge without `OwnableRefCounted` (Alice). - Add `#[inline]` directives to short functions added by the series (Gary). - Link to v16: https://msgid.link/20260224-unique-ref-v16-0-c21afcb118d3... Changes in v16: - Simplify pointer to reference cast in `Page::from_raw`. - Use `NonNull<Page>` rather than `Owned<Page>` for `BorrowedPage` internals. - Use "convertible to reference" wording when converting pointers to references. - Fix formatting for `Page::from_raw` docs. - Leave imports alone when adding safety comment to aref example. - Use `KBox::into_nonnull` for examples. - Add patch for `KBox::into_nonnull`. - Change invariants and safety comments of `Ownable` and make the trait safe. - Make `Ownable::release` take a mutable reference. - Fix error handling in example for `Ownable` - Link to v15: https://msgid.link/20260220-unique-ref-v15-0-893ed86b06cc... Changes in v15: - Update series with original SoB's. - Rename `AlwaysRefCounted` in `kernel::usb`. - Rename `Owned::get_pin_mut` to `Owned::as_pin_mut`. - Link to v14: https://msgid.link/20260204-unique-ref-v14-0-17cb29ebacbb... Changes in v14: - Rebase on v6.19-rc7. - Rewrite cover letter. - Update documentation and safety comments based on v13 feedback. - Update commit messages. - Reorder implementation blocks in owned.rs. - Update example in owned.rs to use try operator rather than `expect`. - Reformat use statements. - Add patch: rust: page: convert to `Ownable`. - Add patch: rust: implement `ForeignOwnable` for `Owned`. - Add patch: rust: page: add `from_raw()`. - Link to v13: https://lore.kernel.org/r/20251117-unique-ref-v13-0-b5b24... Changes in v13: - Rebase onto v6.18-rc1 (Andreas's work). - Documentation and style fixes contributed by Andreas - Link to v12: https://lore.kernel.org/r/20251001-unique-ref-v12-0-fa5c3... Changes in v12: - - Rebase onto v6.17-rc1 (Andreas's work). - moved kernel/types/ownable.rs to kernel/owned.rs - Drop OwnableMut, make DerefMut depend on Unpin instead. I understood ML discussion as that being okay, but probably needs further scrunity. - Lots of more documentation changes suggested by reviewers. - Usage example for Ownable/Owned. - Link to v11: https://lore.kernel.org/r/20250618-unique-ref-v11-0-49ead... Changes in v11: - Rework of documentation. I tried to honor all requests for changes "in spirit" plus some clearifications and corrections of my own. - Dropping `SimpleOwnedRefCounted` by request from Alice, as it creates a potentially problematic blanket implementation (which a derive macro that could be created later would not have). - Dropping Miguel's "kbuild: provide `RUSTC_HAS_DO_NOT_RECOMMEND` symbol" patch, as it is not needed anymore after dropping `SimpleOwnedRefCounted`. (I can add it again, if it is considered useful anyway). - Link to v10: https://lore.kernel.org/r/20250502-unique-ref-v10-0-25de6... Changes in v10: - Moved kernel/ownable.rs to kernel/types/ownable.rs - Fixes in documentation / comments as suggested by Andreas Hindborg - Added Reviewed-by comment for Andreas Hindborg - Fix rustfmt of pid_namespace.rs - Link to v9: https://lore.kernel.org/r/20250325-unique-ref-v9-0-e91618... Changes in v9: - Rebase onto v6.14-rc7 - Move Ownable/OwnedRefCounted/Ownable, etc., into separate module - Documentation fixes to Ownable/OwnableMut/OwnableRefCounted - Add missing SAFETY documentation to ARef example - Link to v8: https://lore.kernel.org/r/20250313-unique-ref-v8-0-3082ff... Changes in v8: - Fix Co-developed-by and Suggested-by tags as suggested by Miguel and Boqun - Some small documentation fixes in Owned/Ownable patch - removing redundant trait constraint on DerefMut for Owned as suggested by Boqun Feng - make SimpleOwnedRefCounted no longer implement RefCounted as suggested by Boqun Feng - documentation for RefCounted as suggested by Boqun Feng - Link to v7: https://lore.kernel.org/r/20250310-unique-ref-v7-0-4caddb... Changes in v7: - Squash patch to make Owned::from_raw/into_raw public into parent - Added Signed-off-by to other people's commits - Link to v6: https://lore.kernel.org/r/20250310-unique-ref-v6-0-1ff535... Changes in v6: - Changed comments/formatting as suggested by Miguel Ojeda - Included and used new config flag RUSTC_HAS_DO_NOT_RECOMMEND, thus no changes to types.rs will be needed when the attribute becomes available. - Fixed commit message for Owned patch. - Link to v5: https://lore.kernel.org/r/20250307-unique-ref-v5-0-bffeb6... Changes in v5: - Rebase the whole thing on top of the Ownable/Owned traits by Asahi Lina. - Rename AlwaysRefCounted to RefCounted and make AlwaysRefCounted a marker trait instead to allow to obtain an ARef<T> from an &T, which (as Alice pointed out) is unsound when combined with UniqueRef/Owned. - Change the Trait design and naming to implement this feature, UniqueRef/UniqueRefCounted is dropped in favor of Ownable/Owned and OwnableRefCounted is used to provide the functions to convert between Owned and ARef. - Link to v4: https://lore.kernel.org/r/20250305-unique-ref-v4-1-a8fdef... Changes in v4: - Just a minor change in naming by request from Andreas Hindborg, try_shared_to_unique() -> try_from_shared(), unique_to_shared() -> into_shared(), which is more in line with standard Rust naming conventions. - Link to v3: https://lore.kernel.org/r/Z8Wuud2UQX6Yukyr@mango To: Danilo Krummrich <dakr@kernel.org> To: Lorenzo Stoakes <ljs@kernel.org> To: Vlastimil Babka <vbabka@kernel.org> To: "Liam R. Howlett" <liam@infradead.org> To: Uladzislau Rezki <urezki@gmail.com> To: Miguel Ojeda <ojeda@kernel.org> To: Boqun Feng <boqun@kernel.org> To: Gary Guo <gary@garyguo.net> To: Björn Roy Baron <bjorn3_gh@protonmail.com> To: Benno Lossin <lossin@kernel.org> To: Andreas Hindborg <a.hindborg@kernel.org> To: Alice Ryhl <aliceryhl@google.com> To: Trevor Gross <tmgross@umich.edu> To: Greg Kroah-Hartman <gregkh@linuxfoundation.org> To: "Rafael J. Wysocki" <rafael@kernel.org> To: Dave Ertman <david.m.ertman@intel.com> To: Ira Weiny <ira.weiny@intel.com> To: Leon Romanovsky <leon@kernel.org> To: Paul Moore <paul@paul-moore.com> To: Serge Hallyn <sergeh@kernel.org> To: David Airlie <airlied@gmail.com> To: Simona Vetter <simona@ffwll.ch> To: Alexander Viro <viro@zeniv.linux.org.uk> To: Christian Brauner <brauner@kernel.org> To: Jan Kara <jack@suse.cz> To: Igor Korotin <igor.korotin@linux.dev> To: Daniel Almeida <daniel.almeida@collabora.com> To: Viresh Kumar <vireshk@kernel.org> To: Nishanth Menon <nm@ti.com> To: Stephen Boyd <sboyd@kernel.org> To: Bjorn Helgaas <bhelgaas@google.com> To: Krzysztof Wilczyński <kwilczynski@kernel.org> To: Pavel Tikhomirov <ptikhomirov@virtuozzo.com> Cc: rust-for-linux@vger.kernel.org Cc: linux-kernel@vger.kernel.org Cc: linux-mm@kvack.org Cc: driver-core@lists.linux.dev Cc: linux-block@vger.kernel.org Cc: linux-security-module@vger.kernel.org Cc: dri-devel@lists.freedesktop.org Cc: linux-fsdevel@vger.kernel.org Cc: linux-pm@vger.kernel.org Cc: linux-pci@vger.kernel.org --- Andreas Hindborg (5): rust: alloc: add `KBox::into_non_null` rust: implement `ForeignOwnable` for `Owned` rust: page: update formatting of `use` statements rust: aref: update formatting of use statements rust: page: add `from_raw()` Asahi Lina (2): rust: types: Add Ownable/Owned types rust: page: convert to `Ownable` Oliver Mangold (3): rust: rename `AlwaysRefCounted` to `RefCounted`. rust: Add missing SAFETY documentation for `ARef` example rust: Add `OwnableRefCounted` rust/kernel/alloc/kbox.rs | 9 + rust/kernel/auxiliary.rs | 7 +- rust/kernel/block/mq/request.rs | 15 +- rust/kernel/cred.rs | 13 +- rust/kernel/device.rs | 12 +- rust/kernel/device/property.rs | 11 +- rust/kernel/drm/device.rs | 9 +- rust/kernel/drm/gem/mod.rs | 16 +- rust/kernel/fs/file.rs | 16 +- rust/kernel/i2c.rs | 13 +- rust/kernel/lib.rs | 1 + rust/kernel/mm.rs | 15 +- rust/kernel/mm/mmput_async.rs | 9 +- rust/kernel/opp.rs | 10 +- rust/kernel/owned.rs | 361 ++++++++++++++++++++++++++++++++++++++++ rust/kernel/page.rs | 62 +++++-- rust/kernel/pci.rs | 10 +- rust/kernel/pid_namespace.rs | 12 +- rust/kernel/platform.rs | 7 +- rust/kernel/sync/aref.rs | 83 ++++++--- rust/kernel/task.rs | 13 +- rust/kernel/types.rs | 13 ++ rust/kernel/usb.rs | 17 +- 23 files changed, 652 insertions(+), 82 deletions(-) --- base-commit: 7fd2df204f342fc17d1a0bfcd474b24232fb0f32 change-id: 20250305-unique-ref-29fcd675f9e9 Best regards, -- Andreas Hindborg <a.hindborg@kernel.org>
