Replace `kernel::str::CStr` by `core::ffi::CStr` #1075

y86-dev · 2024-04-12T22:04:55Z

std::ffi::CStr was moved to core::ffi::CStr in rust 1.64, making it available to the kernel. We have our own version of CStr in kernel::str, since the standard library one wasn't available. Rust 1.77 also added C-string literals c"abc" that automatically terminate strings with \0. The kernel has a c_str! macro for this purpose. We should use the types from the standard library and remove our own versions. The things to do would be

change uses of kernel::str::CStr to core::ffi::CStr and also change c_str!("...") into c"..."
remove kernel::str::CStr and the macro

This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes, to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and so on. Please see https://docs.kernel.org/process/submitting-patches.html and https://rust-for-linux.com/contributing for details.

Please take this issue only if you are new to the kernel development process and you would like to use it as a test to submit your first patch to the kernel. Please do not take it if you do not plan to make other contributions to the kernel.

The text was updated successfully, but these errors were encountered:

vincenzopalazzo · 2024-04-13T11:06:19Z

I will look into it 😸

y86-dev · 2024-04-13T11:41:25Z

We try to give good-first-issues to people who do not yet have commits in the kernel. It helps folks getting familiar with the kernel development process. We also try to pick easy/trivial fixes as good-first-issues. AFAIK you already submitted a good-first-issue, so it would be best to leave this up to someone else :)

vincenzopalazzo · 2024-04-13T11:46:10Z

Make sense!

vadorovsky · 2024-04-13T13:20:02Z

I can take it.

Steffo99 · 2024-07-09T15:52:25Z

Hi!

I'd be interested in taking this issue to both learn to contribute to Rust for Linux and to submit my first patch to the Linux kernel, which is a requirement to pass the Kernel Hacking university course I've been attending.

@vadorovsky, are you still working on it?
(I'm sending you a ping on the Fediverse too as soon as I post this, just to make sure that you see it...)

Can I take this issue?

Steffo99 · 2024-07-10T08:36:53Z

Got an answer by @vadorovsky on the Fediverse!

Seems like he's still working on it :)

I'll look for another issue!

vadorovsky · 2024-07-12T12:15:58Z

Yes, I'm still working on it. Here is my WIP branch: https://gitlab.com/vadorovsky/linux/-/commits/rust-cstr

Before sending it, I still want to polish it a bit. I'm also thinking how to handle the fact that alloc::CString doesn't have any equivalent of try_from_fmt, but my idea for now is to add CStringExt. I'm coding it right now. If I'm happy from the result, I will add it and send it to the ML.

vadorovsky · 2024-07-14T16:07:04Z

Sent a patch, only with CStr removal:

https://lore.kernel.org/rust-for-linux/[email protected]/T/#u

This picks up from Michal Rostecki's work[0]. Link: https://lore.kernel.org/rust-for-linux/[email protected]/t/#u [0] Closes: Rust-for-Linux#1075 # Describe the purpose of this series. The information you put here # will be used by the project maintainer to make a decision whether # your patches should be reviewed, and in what priority order. Please be # very detailed and link to any relevant discussions or sites that the # maintainer can review to better understand your proposed changes. If you # only have a single patch in your series, the contents of the cover # letter will be appended to the "under-the-cut" portion of the patch. # Lines starting with # will be removed from the cover letter. You can # use them to add notes or reminders to yourself. If you want to use # markdown headers in your cover letter, start the line with ">#". # You can add trailers to the cover letter. Any email addresses found in # these trailers will be added to the addresses specified/generated # during the b4 send stage. You can also run "b4 prep --auto-to-cc" to # auto-populate the To: and Cc: trailers based on the code being # modified. Signed-off-by: Tamir Duberstein <[email protected]> --- Changes in v6: - Split the work into several commits for ease of review. - Restore `{from,as}_char_ptr` to allow building on ARM (see commit message). - Add `CStrExt` to `kernel::prelude`. (Alice Ryhl) - Remove `CStrExt::from_bytes_with_nul_unchecked_mut` and restore `DerefMut for CString`. (Alice Ryhl) - Rename and hide `kernel::c_str!` to encourage use of C-String literals. - Drop implementation and invocation changes in kunit.rs. (Trevor Gross) - Drop docs on `Display` impl. (Trevor Gross) - Rewrite docs in the style of the standard library. Changes in v5: - Keep the `test_cstr_display*` unit tests. Changes in v4: - Provide the `CStrExt` trait with `display()` method, which returns a `CStrDisplay` wrapper with `Display` implementation. This addresses the lack of `Display` implementation for `core::ffi::CStr`. - Provide `from_bytes_with_nul_unchecked_mut()` method in `CStrExt`, which might be useful and is going to prevent manual, unsafe casts. - Fix a typo (s/preffered/prefered/). Changes in v3: - Fix the commit message. - Remove redundant braces in `use`, when only one item is imported. Changes in v2: - Do not remove `c_str` macro. While it's preferred to use C-string literals, there are two cases where `c_str` is helpful: - When working with macros, which already return a Rust string literal (e.g. `stringify!`). - When building macros, where we want to take a Rust string literal as an argument (for caller's convenience), but still use it as a C-string internally. - Use Rust literals as arguments in macros (`new_mutex`, `new_condvar`, `new_mutex`). Use the `c_str` macro to convert these literals to C-string literals. - Use `c_str` in kunit.rs for converting the output of `stringify!` to a `CStr`. - Remove `DerefMut` implementation for `CString`. --- b4-submit-tracking --- # This section is used internally by b4 prep for tracking purposes. { "series": { "revision": 6, "change-id": "20250201-cstr-core-d4b9b69120cf", "prefixes": [], "from-thread": "[email protected]" } }

C-String literals were added in Rust 1.77. Replace instances of `kernel::c_str!` with C-String literals where possible and rename `kernel::c_str!` to `c_str_use_only_in_macros` to clarify its intended use only in macros. Closes: Rust-for-Linux#1075 Signed-off-by: Tamir Duberstein <[email protected]>

This picks up from Michal Rostecki's work[0]. Per Michal's guidance I have omitted Co-authored tags, as the end result is quite different. Link: https://lore.kernel.org/rust-for-linux/[email protected]/t/#u [0] Closes: Rust-for-Linux#1075 # Describe the purpose of this series. The information you put here # will be used by the project maintainer to make a decision whether # your patches should be reviewed, and in what priority order. Please be # very detailed and link to any relevant discussions or sites that the # maintainer can review to better understand your proposed changes. If you # only have a single patch in your series, the contents of the cover # letter will be appended to the "under-the-cut" portion of the patch. # Lines starting with # will be removed from the cover letter. You can # use them to add notes or reminders to yourself. If you want to use # markdown headers in your cover letter, start the line with ">#". # You can add trailers to the cover letter. Any email addresses found in # these trailers will be added to the addresses specified/generated # during the b4 send stage. You can also run "b4 prep --auto-to-cc" to # auto-populate the To: and Cc: trailers based on the code being # modified. To: Michal Rostecki <[email protected]> To: Miguel Ojeda <[email protected]> To: Alex Gaynor <[email protected]> To: Boqun Feng <[email protected]> To: Gary Guo <[email protected]> To: Björn Roy Baron <[email protected]> To: Benno Lossin <[email protected]> To: Andreas Hindborg <[email protected]> To: Alice Ryhl <[email protected]> To: Trevor Gross <[email protected]> Cc: [email protected] Cc: [email protected] Signed-off-by: Tamir Duberstein <[email protected]> --- Changes in v8: - Move `{from,as}_char_ptr` back to `CStrExt`. This reduces the diff some. - Restore `from_bytes_with_nul_unchecked_mut`, `to_cstring`. - Link to v7: https://lore.kernel.org/r/[email protected] Changes in v7: - Rebased on mainline. - Restore functionality added in commit a321f3a ("rust: str: add {make,to}_{upper,lower}case() to CString"). - Used `diff.algorithm patience` to improve diff readability. - Link to v6: https://lore.kernel.org/r/[email protected] Changes in v6: - Split the work into several commits for ease of review. - Restore `{from,as}_char_ptr` to allow building on ARM (see commit message). - Add `CStrExt` to `kernel::prelude`. (Alice Ryhl) - Remove `CStrExt::from_bytes_with_nul_unchecked_mut` and restore `DerefMut for CString`. (Alice Ryhl) - Rename and hide `kernel::c_str!` to encourage use of C-String literals. - Drop implementation and invocation changes in kunit.rs. (Trevor Gross) - Drop docs on `Display` impl. (Trevor Gross) - Rewrite docs in the style of the standard library. - Restore the `test_cstr_debug` unit tests to demonstrate that the implementation has changed. Changes in v5: - Keep the `test_cstr_display*` unit tests. Changes in v4: - Provide the `CStrExt` trait with `display()` method, which returns a `CStrDisplay` wrapper with `Display` implementation. This addresses the lack of `Display` implementation for `core::ffi::CStr`. - Provide `from_bytes_with_nul_unchecked_mut()` method in `CStrExt`, which might be useful and is going to prevent manual, unsafe casts. - Fix a typo (s/preffered/prefered/). Changes in v3: - Fix the commit message. - Remove redundant braces in `use`, when only one item is imported. Changes in v2: - Do not remove `c_str` macro. While it's preferred to use C-string literals, there are two cases where `c_str` is helpful: - When working with macros, which already return a Rust string literal (e.g. `stringify!`). - When building macros, where we want to take a Rust string literal as an argument (for caller's convenience), but still use it as a C-string internally. - Use Rust literals as arguments in macros (`new_mutex`, `new_condvar`, `new_mutex`). Use the `c_str` macro to convert these literals to C-string literals. - Use `c_str` in kunit.rs for converting the output of `stringify!` to a `CStr`. - Remove `DerefMut` implementation for `CString`. --- b4-submit-tracking --- # This section is used internally by b4 prep for tracking purposes. { "series": { "revision": 8, "change-id": "20250201-cstr-core-d4b9b69120cf", "prefixes": [], "from-thread": "[email protected]", "history": { "v6": [ "[email protected]" ], "v7": [ "[email protected]" ] } } }

C-String literals were added in Rust 1.77. Replace instances of `kernel::c_str!` with C-String literals where possible and rename `kernel::c_str!` to `c_str_avoid_literals` to clarify its intended use. Closes: Rust-for-Linux#1075 Signed-off-by: Tamir Duberstein <[email protected]>

This picks up from Michal Rostecki's work[0]. Per Michal's guidance I have omitted Co-authored tags, as the end result is quite different. Link: https://lore.kernel.org/rust-for-linux/[email protected]/t/#u [0] Closes: Rust-for-Linux#1075 # Describe the purpose of this series. The information you put here # will be used by the project maintainer to make a decision whether # your patches should be reviewed, and in what priority order. Please be # very detailed and link to any relevant discussions or sites that the # maintainer can review to better understand your proposed changes. If you # only have a single patch in your series, the contents of the cover # letter will be appended to the "under-the-cut" portion of the patch. # Lines starting with # will be removed from the cover letter. You can # use them to add notes or reminders to yourself. If you want to use # markdown headers in your cover letter, start the line with ">#". # You can add trailers to the cover letter. Any email addresses found in # these trailers will be added to the addresses specified/generated # during the b4 send stage. You can also run "b4 prep --auto-to-cc" to # auto-populate the To: and Cc: trailers based on the code being # modified. To: Michal Rostecki <[email protected]> To: Miguel Ojeda <[email protected]> To: Alex Gaynor <[email protected]> To: Boqun Feng <[email protected]> To: Gary Guo <[email protected]> To: Björn Roy Baron <[email protected]> To: Benno Lossin <[email protected]> To: Andreas Hindborg <[email protected]> To: Alice Ryhl <[email protected]> To: Trevor Gross <[email protected]> Cc: [email protected] Cc: [email protected] Signed-off-by: Tamir Duberstein <[email protected]> --- Changes in v9: - EDITME: describe what is new in this series revision. - EDITME: use bulletpoints and terse descriptions. - Link to v8: https://lore.kernel.org/r/[email protected] Changes in v8: - Move `{from,as}_char_ptr` back to `CStrExt`. This reduces the diff some. - Restore `from_bytes_with_nul_unchecked_mut`, `to_cstring`. - Link to v7: https://lore.kernel.org/r/[email protected] Changes in v7: - Rebased on mainline. - Restore functionality added in commit a321f3a ("rust: str: add {make,to}_{upper,lower}case() to CString"). - Used `diff.algorithm patience` to improve diff readability. - Link to v6: https://lore.kernel.org/r/[email protected] Changes in v6: - Split the work into several commits for ease of review. - Restore `{from,as}_char_ptr` to allow building on ARM (see commit message). - Add `CStrExt` to `kernel::prelude`. (Alice Ryhl) - Remove `CStrExt::from_bytes_with_nul_unchecked_mut` and restore `DerefMut for CString`. (Alice Ryhl) - Rename and hide `kernel::c_str!` to encourage use of C-String literals. - Drop implementation and invocation changes in kunit.rs. (Trevor Gross) - Drop docs on `Display` impl. (Trevor Gross) - Rewrite docs in the style of the standard library. - Restore the `test_cstr_debug` unit tests to demonstrate that the implementation has changed. Changes in v5: - Keep the `test_cstr_display*` unit tests. Changes in v4: - Provide the `CStrExt` trait with `display()` method, which returns a `CStrDisplay` wrapper with `Display` implementation. This addresses the lack of `Display` implementation for `core::ffi::CStr`. - Provide `from_bytes_with_nul_unchecked_mut()` method in `CStrExt`, which might be useful and is going to prevent manual, unsafe casts. - Fix a typo (s/preffered/prefered/). Changes in v3: - Fix the commit message. - Remove redundant braces in `use`, when only one item is imported. Changes in v2: - Do not remove `c_str` macro. While it's preferred to use C-string literals, there are two cases where `c_str` is helpful: - When working with macros, which already return a Rust string literal (e.g. `stringify!`). - When building macros, where we want to take a Rust string literal as an argument (for caller's convenience), but still use it as a C-string internally. - Use Rust literals as arguments in macros (`new_mutex`, `new_condvar`, `new_mutex`). Use the `c_str` macro to convert these literals to C-string literals. - Use `c_str` in kunit.rs for converting the output of `stringify!` to a `CStr`. - Remove `DerefMut` implementation for `CString`. --- b4-submit-tracking --- # This section is used internally by b4 prep for tracking purposes. { "series": { "revision": 9, "change-id": "20250201-cstr-core-d4b9b69120cf", "prefixes": [], "from-thread": "[email protected]", "history": { "v6": [ "[email protected]" ], "v7": [ "[email protected]" ], "v8": [ "[email protected]" ] } } }

C-String literals were added in Rust 1.77. Replace instances of `kernel::c_str!` with C-String literals where possible and rename `kernel::c_str!` to `c_str_avoid_literals` to clarify its intended use. Closes: Rust-for-Linux#1075 Signed-off-by: Tamir Duberstein <[email protected]>

tamird · 2025-02-14T19:05:39Z

Could someone assign this to me? I've sent https://lore.kernel.org/all/[email protected]/t/#u with @vadorovsky's permission.

This produces a deref chain of `CStr` -> `BStr` -> `[u8]` which is present in the Rust-for-Linux analogues of these types. Link: rust-lang#134915 Link: Rust-for-Linux/linux#1075 Link: https://lore.kernel.org/all/20250221142816.0c015e9f@eugeo/ Link: Rust-for-Linux/linux#1146

This picks up from Michal Rostecki's work[0]. Per Michal's guidance I have omitted Co-authored tags, as the end result is quite different. Link: https://lore.kernel.org/rust-for-linux/[email protected]/t/#u [0] Closes: Rust-for-Linux#1075 # Describe the purpose of this series. The information you put here # will be used by the project maintainer to make a decision whether # your patches should be reviewed, and in what priority order. Please be # very detailed and link to any relevant discussions or sites that the # maintainer can review to better understand your proposed changes. If you # only have a single patch in your series, the contents of the cover # letter will be appended to the "under-the-cut" portion of the patch. # Lines starting with # will be removed from the cover letter. You can # use them to add notes or reminders to yourself. If you want to use # markdown headers in your cover letter, start the line with ">#". # You can add trailers to the cover letter. Any email addresses found in # these trailers will be added to the addresses specified/generated # during the b4 send stage. You can also run "b4 prep --auto-to-cc" to # auto-populate the To: and Cc: trailers based on the code being # modified. To: Michal Rostecki <[email protected]> To: Miguel Ojeda <[email protected]> To: Alex Gaynor <[email protected]> To: Boqun Feng <[email protected]> To: Gary Guo <[email protected]> To: Björn Roy Baron <[email protected]> To: Benno Lossin <[email protected]> To: Andreas Hindborg <[email protected]> To: Alice Ryhl <[email protected]> To: Trevor Gross <[email protected]> To: Brendan Higgins <[email protected]> To: David Gow <[email protected]> To: Rae Moar <[email protected]> To: Danilo Krummrich <[email protected]> To: Maarten Lankhorst <[email protected]> To: Maxime Ripard <[email protected]> To: Thomas Zimmermann <[email protected]> To: David Airlie <[email protected]> To: Simona Vetter <[email protected]> To: Greg Kroah-Hartman <[email protected]> To: "Rafael J. Wysocki" <[email protected]> To: Luis Chamberlain <[email protected]> To: Russ Weight <[email protected]> To: FUJITA Tomonori <[email protected]> To: Rob Herring <[email protected]> To: Saravana Kannan <[email protected]> To: Peter Zijlstra <[email protected]> To: Ingo Molnar <[email protected]> To: Will Deacon <[email protected]> To: Waiman Long <[email protected]> To: Nathan Chancellor <[email protected]> To: Nick Desaulniers <[email protected]> To: Bill Wendling <[email protected]> To: Justin Stitt <[email protected]> To: Andrew Lunn <[email protected]> To: Heiner Kallweit <[email protected]> To: Russell King <[email protected]> To: "David S. Miller" <[email protected]> To: Eric Dumazet <[email protected]> To: Jakub Kicinski <[email protected]> To: Paolo Abeni <[email protected]> To: Bjorn Helgaas <[email protected]> To: Arnd Bergmann <[email protected]> Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Signed-off-by: Tamir Duberstein <[email protected]> --- Changes in v9: - Rebase on rust-next. - Link to v8: https://lore.kernel.org/r/[email protected] Changes in v8: - Move `{from,as}_char_ptr` back to `CStrExt`. This reduces the diff some. - Restore `from_bytes_with_nul_unchecked_mut`, `to_cstring`. - Link to v7: https://lore.kernel.org/r/[email protected] Changes in v7: - Rebased on mainline. - Restore functionality added in commit a321f3a ("rust: str: add {make,to}_{upper,lower}case() to CString"). - Used `diff.algorithm patience` to improve diff readability. - Link to v6: https://lore.kernel.org/r/[email protected] Changes in v6: - Split the work into several commits for ease of review. - Restore `{from,as}_char_ptr` to allow building on ARM (see commit message). - Add `CStrExt` to `kernel::prelude`. (Alice Ryhl) - Remove `CStrExt::from_bytes_with_nul_unchecked_mut` and restore `DerefMut for CString`. (Alice Ryhl) - Rename and hide `kernel::c_str!` to encourage use of C-String literals. - Drop implementation and invocation changes in kunit.rs. (Trevor Gross) - Drop docs on `Display` impl. (Trevor Gross) - Rewrite docs in the style of the standard library. - Restore the `test_cstr_debug` unit tests to demonstrate that the implementation has changed. Changes in v5: - Keep the `test_cstr_display*` unit tests. Changes in v4: - Provide the `CStrExt` trait with `display()` method, which returns a `CStrDisplay` wrapper with `Display` implementation. This addresses the lack of `Display` implementation for `core::ffi::CStr`. - Provide `from_bytes_with_nul_unchecked_mut()` method in `CStrExt`, which might be useful and is going to prevent manual, unsafe casts. - Fix a typo (s/preffered/prefered/). Changes in v3: - Fix the commit message. - Remove redundant braces in `use`, when only one item is imported. Changes in v2: - Do not remove `c_str` macro. While it's preferred to use C-string literals, there are two cases where `c_str` is helpful: - When working with macros, which already return a Rust string literal (e.g. `stringify!`). - When building macros, where we want to take a Rust string literal as an argument (for caller's convenience), but still use it as a C-string internally. - Use Rust literals as arguments in macros (`new_mutex`, `new_condvar`, `new_mutex`). Use the `c_str` macro to convert these literals to C-string literals. - Use `c_str` in kunit.rs for converting the output of `stringify!` to a `CStr`. - Remove `DerefMut` implementation for `CString`. --- b4-submit-tracking --- # This section is used internally by b4 prep for tracking purposes. { "series": { "revision": 9, "change-id": "20250201-cstr-core-d4b9b69120cf", "prefixes": [], "from-thread": "[email protected]", "history": { "v6": [ "[email protected]" ], "v7": [ "[email protected]" ], "v8": [ "[email protected]" ] } } }

C-String literals were added in Rust 1.77. Replace instances of `kernel::c_str!` with C-String literals where possible and rename `kernel::c_str!` to `c_str_avoid_literals` to clarify its intended use. Closes: Rust-for-Linux#1075 Signed-off-by: Tamir Duberstein <[email protected]>

This produces a deref chain of `CStr` -> `BStr` -> `[u8]` which is present in the Rust-for-Linux analogues of these types. Link: rust-lang#134915 Link: Rust-for-Linux/linux#1075 Link: https://lore.kernel.org/all/20250221142816.0c015e9f@eugeo/ Link: Rust-for-Linux/linux#1146

This produces a deref chain of `CStr` -> `BStr` -> `[u8]` which is present in the Rust-for-Linux analogues of these types. Add `AsRef<ByteStr>` as well. Link: rust-lang#134915 Link: Rust-for-Linux/linux#1075 Link: https://lore.kernel.org/all/20250221142816.0c015e9f@eugeo/ Link: Rust-for-Linux/linux#1146

This picks up from Michal Rostecki's work[0]. Per Michal's guidance I have omitted Co-authored tags, as the end result is quite different. Link: https://lore.kernel.org/rust-for-linux/[email protected]/t/#u [0] Closes: Rust-for-Linux#1075 # Describe the purpose of this series. The information you put here # will be used by the project maintainer to make a decision whether # your patches should be reviewed, and in what priority order. Please be # very detailed and link to any relevant discussions or sites that the # maintainer can review to better understand your proposed changes. If you # only have a single patch in your series, the contents of the cover # letter will be appended to the "under-the-cut" portion of the patch. # Lines starting with # will be removed from the cover letter. You can # use them to add notes or reminders to yourself. If you want to use # markdown headers in your cover letter, start the line with ">#". # You can add trailers to the cover letter. Any email addresses found in # these trailers will be added to the addresses specified/generated # during the b4 send stage. You can also run "b4 prep --auto-to-cc" to # auto-populate the To: and Cc: trailers based on the code being # modified. To: Michal Rostecki <[email protected]> To: Miguel Ojeda <[email protected]> To: Alex Gaynor <[email protected]> To: Boqun Feng <[email protected]> To: Gary Guo <[email protected]> To: Björn Roy Baron <[email protected]> To: Benno Lossin <[email protected]> To: Andreas Hindborg <[email protected]> To: Alice Ryhl <[email protected]> To: Trevor Gross <[email protected]> To: Brendan Higgins <[email protected]> To: David Gow <[email protected]> To: Rae Moar <[email protected]> To: Danilo Krummrich <[email protected]> To: Maarten Lankhorst <[email protected]> To: Maxime Ripard <[email protected]> To: Thomas Zimmermann <[email protected]> To: David Airlie <[email protected]> To: Simona Vetter <[email protected]> To: Greg Kroah-Hartman <[email protected]> To: "Rafael J. Wysocki" <[email protected]> To: Luis Chamberlain <[email protected]> To: Russ Weight <[email protected]> To: FUJITA Tomonori <[email protected]> To: Rob Herring <[email protected]> To: Saravana Kannan <[email protected]> To: Peter Zijlstra <[email protected]> To: Ingo Molnar <[email protected]> To: Will Deacon <[email protected]> To: Waiman Long <[email protected]> To: Nathan Chancellor <[email protected]> To: Nick Desaulniers <[email protected]> To: Bill Wendling <[email protected]> To: Justin Stitt <[email protected]> To: Andrew Lunn <[email protected]> To: Heiner Kallweit <[email protected]> To: Russell King <[email protected]> To: "David S. Miller" <[email protected]> To: Eric Dumazet <[email protected]> To: Jakub Kicinski <[email protected]> To: Paolo Abeni <[email protected]> To: Bjorn Helgaas <[email protected]> To: Arnd Bergmann <[email protected]> Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Signed-off-by: Tamir Duberstein <[email protected]> --- Changes in v10: - Rebase on v6.15-rc1. - Link to v9: https://lore.kernel.org/r/[email protected] Changes in v9: - Rebase on rust-next. - Restore `impl Display for BStr` which exists upstream[1]. - Link: https://doc.rust-lang.org/nightly/std/bstr/struct.ByteStr.html#impl-Display-for-ByteStr [1] - Link to v8: https://lore.kernel.org/r/[email protected] Changes in v8: - Move `{from,as}_char_ptr` back to `CStrExt`. This reduces the diff some. - Restore `from_bytes_with_nul_unchecked_mut`, `to_cstring`. - Link to v7: https://lore.kernel.org/r/[email protected] Changes in v7: - Rebased on mainline. - Restore functionality added in commit a321f3a ("rust: str: add {make,to}_{upper,lower}case() to CString"). - Used `diff.algorithm patience` to improve diff readability. - Link to v6: https://lore.kernel.org/r/[email protected] Changes in v6: - Split the work into several commits for ease of review. - Restore `{from,as}_char_ptr` to allow building on ARM (see commit message). - Add `CStrExt` to `kernel::prelude`. (Alice Ryhl) - Remove `CStrExt::from_bytes_with_nul_unchecked_mut` and restore `DerefMut for CString`. (Alice Ryhl) - Rename and hide `kernel::c_str!` to encourage use of C-String literals. - Drop implementation and invocation changes in kunit.rs. (Trevor Gross) - Drop docs on `Display` impl. (Trevor Gross) - Rewrite docs in the style of the standard library. - Restore the `test_cstr_debug` unit tests to demonstrate that the implementation has changed. Changes in v5: - Keep the `test_cstr_display*` unit tests. Changes in v4: - Provide the `CStrExt` trait with `display()` method, which returns a `CStrDisplay` wrapper with `Display` implementation. This addresses the lack of `Display` implementation for `core::ffi::CStr`. - Provide `from_bytes_with_nul_unchecked_mut()` method in `CStrExt`, which might be useful and is going to prevent manual, unsafe casts. - Fix a typo (s/preffered/prefered/). Changes in v3: - Fix the commit message. - Remove redundant braces in `use`, when only one item is imported. Changes in v2: - Do not remove `c_str` macro. While it's preferred to use C-string literals, there are two cases where `c_str` is helpful: - When working with macros, which already return a Rust string literal (e.g. `stringify!`). - When building macros, where we want to take a Rust string literal as an argument (for caller's convenience), but still use it as a C-string internally. - Use Rust literals as arguments in macros (`new_mutex`, `new_condvar`, `new_mutex`). Use the `c_str` macro to convert these literals to C-string literals. - Use `c_str` in kunit.rs for converting the output of `stringify!` to a `CStr`. - Remove `DerefMut` implementation for `CString`. --- b4-submit-tracking --- # This section is used internally by b4 prep for tracking purposes. { "series": { "revision": 10, "change-id": "20250201-cstr-core-d4b9b69120cf", "prefixes": [], "from-thread": "[email protected]", "history": { "v6": [ "[email protected]" ], "v7": [ "[email protected]" ], "v8": [ "[email protected]" ], "v9": [ "[email protected]" ] } } }

C-String literals were added in Rust 1.77. Replace instances of `kernel::c_str!` with C-String literals where possible and rename `kernel::c_str!` to `c_str_avoid_literals` to clarify its intended use. Closes: Rust-for-Linux#1075 Signed-off-by: Tamir Duberstein <[email protected]>

brambhattabhishek · 2025-04-09T02:22:10Z

Could some one assign to me this ?

tamird · 2025-04-09T14:22:46Z

I have already done this work, the patches are pending review.

y86-dev added good first issue Good for newcomers • lib Related to the `rust/` library. labels Apr 12, 2024

ojeda added the medium Expected to be an issue of medium difficulty to resolve. label Nov 25, 2024

tgross35 assigned tamird Feb 14, 2025

tamird mentioned this issue Mar 6, 2025

Replace kernel::str::BStr with core::bstr::ByteStr #1146

Open

tamird mentioned this issue Mar 14, 2025

Implement Deref<Target=ByteStr> for CStr rust-lang/rust#138498

Open

ojeda mentioned this issue Apr 10, 2025

core wanted features & bugfixes #514

Open

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace `kernel::str::CStr` by `core::ffi::CStr` #1075

Replace `kernel::str::CStr` by `core::ffi::CStr` #1075

y86-dev commented Apr 12, 2024 •

edited by ojeda

Loading

vincenzopalazzo commented Apr 13, 2024

y86-dev commented Apr 13, 2024

vincenzopalazzo commented Apr 13, 2024

vadorovsky commented Apr 13, 2024

Steffo99 commented Jul 9, 2024

Steffo99 commented Jul 10, 2024

vadorovsky commented Jul 12, 2024

vadorovsky commented Jul 14, 2024

tamird commented Feb 14, 2025

brambhattabhishek commented Apr 9, 2025

tamird commented Apr 9, 2025

Replace kernel::str::CStr by core::ffi::CStr #1075

Replace kernel::str::CStr by core::ffi::CStr #1075

Comments

y86-dev commented Apr 12, 2024 • edited by ojeda Loading

vincenzopalazzo commented Apr 13, 2024

y86-dev commented Apr 13, 2024

vincenzopalazzo commented Apr 13, 2024

vadorovsky commented Apr 13, 2024

Steffo99 commented Jul 9, 2024

Steffo99 commented Jul 10, 2024

vadorovsky commented Jul 12, 2024

vadorovsky commented Jul 14, 2024

tamird commented Feb 14, 2025

brambhattabhishek commented Apr 9, 2025

tamird commented Apr 9, 2025

Replace `kernel::str::CStr` by `core::ffi::CStr` #1075

Replace `kernel::str::CStr` by `core::ffi::CStr` #1075

y86-dev commented Apr 12, 2024 •

edited by ojeda

Loading