linux-stable.git/rust/kernel/init/macros.rs, branch linux-6.5.y

rust: init: update macro expansion example in docs

2023-05-31T16:53:10+00:00

Also improve the explaining comments.

Signed-off-by: Benno Lossin 
Reviewed-by: Gary Guo 
Reviewed-by: Alice Ryhl 
Reviewed-by: Martin Rodriguez Reboredo 
Link: https://lore.kernel.org/r/20230424081112.99890-4-benno.lossin@proton.me
Signed-off-by: Miguel Ojeda

rust: init: add `PinnedDrop` trait and macros

2023-04-12T16:41:05+00:00

The `PinnedDrop` trait that facilitates destruction of pinned types.
It has to be implemented via the `#[pinned_drop]` macro, since the
`drop` function should not be called by normal code, only by other
destructors. It also only works on structs that are annotated with
`#[pin_data(PinnedDrop)]`.

Co-developed-by: Gary Guo 
Signed-off-by: Gary Guo 
Signed-off-by: Benno Lossin 
Reviewed-by: Alice Ryhl 
Reviewed-by: Andreas Hindborg 
Link: https://lore.kernel.org/r/20230408122429.1103522-10-y86-dev@protonmail.com
Signed-off-by: Miguel Ojeda

rust: init: add initialization macros

2023-04-12T16:41:05+00:00

Add the following initializer macros:
- `#[pin_data]` to annotate structurally pinned fields of structs,
  needed for `pin_init!` and `try_pin_init!` to select the correct
  initializer of fields.
- `pin_init!` create a pin-initializer for a struct with the
  `Infallible` error type.
- `try_pin_init!` create a pin-initializer for a struct with a custom
  error type (`kernel::error::Error` is the default).
- `init!` create an in-place-initializer for a struct with the
  `Infallible` error type.
- `try_init!` create an in-place-initializer for a struct with a custom
  error type (`kernel::error::Error` is the default).

Also add their needed internal helper traits and structs.

Co-developed-by: Gary Guo 
Signed-off-by: Gary Guo 
Signed-off-by: Benno Lossin 
Reviewed-by: Alice Ryhl 
Reviewed-by: Andreas Hindborg 
Link: https://lore.kernel.org/r/20230408122429.1103522-8-y86-dev@protonmail.com
[ Fixed three typos. ]
Signed-off-by: Miguel Ojeda