From patchwork Wed Jul 17 16:03:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michal Rostecki X-Patchwork-Id: 13735597 Received: from mail-qk1-f196.google.com (mail-qk1-f196.google.com [209.85.222.196]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4B66C1EA8F; Wed, 17 Jul 2024 16:08:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.196 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721232497; cv=none; b=YrV+jzXSNb/xQmsoDhM0z61TloQUM7klSeSXpfsCY98MmB3DzF1BJVRz/VJXYsQ988HeLZZJCj4457TlF828yyfBQ49d4eh2CTKI4jWh3FCMo2TVUNjaBHOYLss3rzxt6yfU0geEyIJQxwliEW2IDLnFux2B/j08JfnYk5CzG7U= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721232497; c=relaxed/simple; bh=Cir7PtBkqzprUyh4dRpZbI26ZL3zh8JUq4cPuo59FSI=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type; b=abA9fMyrvJhN5nk1KFRdFsYjm8ffp/f7bjmaaiCGXp7ylYXbc0adok1OC0BHv5eANtYbS9To9VEM1ilJUZFl9KOHETDUEMZ1cAuYc+Z8gKjg/MfmAqK7oMt5b3ndIt1jB6MXLwnU4kk7rUNNC06fuc2u1Wa9vKXtYKjxxgxuQCI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=f2mZbO/4; arc=none smtp.client-ip=209.85.222.196 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="f2mZbO/4" Received: by mail-qk1-f196.google.com with SMTP id af79cd13be357-79ef72bb8c8so333566885a.2; Wed, 17 Jul 2024 09:08:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1721232494; x=1721837294; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=IkScJAcru/K6RBR8z1rhsYI4LkcE4Lk5k0sY93k1JvI=; b=f2mZbO/4rX5kJ2N1S5WcSjghAil8Ho0gLqXZV1kKCfAam4xa+dlk804OX5Yx6BCAPm NxCDRoFWin3lGhNda+hXVGc9I7PEDq3E2lmtkxnyhqJiffTeGoWX8mhMASAb/4EJ7Lok ORZ2zRIZPjjy5QkNZOlAd8jSvZ3GJr6bxx7QVcniXWNDAKLHbyvzQ/GedGYcTpSNiKXn Q8HgwcM177Nu9W0pYbEpXiBLhqPEhFc6kymU+ZjI7FpdbVf0vLpo79iQ+Usc1E6tDCSv 98gmuRolo1Muy9Pfw0g69JNuX8I9z/pwnqhWpu/1cpNm+5sNkOAeJ7BdL5qobQXDKsau xryA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721232494; x=1721837294; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=IkScJAcru/K6RBR8z1rhsYI4LkcE4Lk5k0sY93k1JvI=; b=OX731DROipY3zfWq4g3gbH9rFErNixvx5fzGtt0oXuQbMBd5EvFLyMApQRnQlzkzk7 jCwHdzKlEXRwb2iceBVYt4F4oJvSmn03vBHmeOLZ3ZO9pU/AEiGU7ZDCDmhjtJHG9gZ7 8P/GqnbF5IO5h3G7mAvJAdjRCRJylfP7+GAhlW2HMOpyDcR+WOSGkrzRUJsb3h111hja 5KsvRtayqWtBm7dL1zhSj4GnJqoYuFcJIkQKJaQnzX0EoYMLVE4Iw0UeqX1b2enFVtSc 1NiKfLyY98GYJPKxUcY0/OGAA8Uyiaary0vQER0zTbbWE0ns3FFnRRpfsTJgTaOnYfy1 keRQ== X-Forwarded-Encrypted: i=1; AJvYcCXC/L+i8QjrMuWers8lHIg3k3XXYeL4uMmDxNfZf8tLFvr2tTfIEd4SMtETHkXHSKpJ2Wu/Tp7VoySaRfi4K5fKzO/yCQeRGQfHQFYv3MtMXDJItM2jLm9YKb9AYP/zlB1Cz5KZ0MqHXyMp8KFeUGUtdKtuZP9FNgnmem7UfPX10YwDcxLKx7lY/p4HveLiXJ/CSUV73evxbAmiIf+sUFzpQW9dbM4= X-Gm-Message-State: AOJu0YzkNItIUO0FiYj8oEJSCDkT6F3i8WtJ6pRuFJhpOzPlOVKaDWmf gASqkzuDRG2ijazx+fOaaeSfsPflaMy770tQK0yi5r+PzQ8CM0hd X-Google-Smtp-Source: AGHT+IGcN+VCFWsaaiUtnuIb1FQICj4w40IwZqFmqW91Hq3zR6vaQ1zM3WZO8d79zDZSZ5nRDs7taQ== X-Received: by 2002:a05:620a:2905:b0:79f:a32:a69d with SMTP id af79cd13be357-7a1874f6815mr227712885a.58.1721232493700; Wed, 17 Jul 2024 09:08:13 -0700 (PDT) Received: from vadorovsky-macbookpro.. ([207.35.255.94]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7a160c63880sm417253585a.72.2024.07.17.09.08.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Jul 2024 09:08:12 -0700 (PDT) From: Michal Rostecki To: Cc: Michal Rostecki , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Brendan Higgins , David Gow , Rae Moar , FUJITA Tomonori , Trevor Gross , Nathan Chancellor , Nick Desaulniers , Bill Wendling , Justin Stitt , Martin Rodriguez Reboredo , Manmohan Shukla , Valentin Obst , Yutaro Ohno , Danilo Krummrich , Charalampos Mitrodimas , Ben Gooding , Tejun Heo , Nell Shamrell-Harrington , Roland Xu , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, netdev@vger.kernel.org, llvm@lists.linux.dev Subject: [PATCH v5] rust: str: Use `core::CStr`, remove the custom `CStr` implementation Date: Wed, 17 Jul 2024 18:03:23 +0200 Message-ID: <20240717160339.146371-2-vadorovsky@gmail.com> X-Mailer: git-send-email 2.45.2 Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 `CStr` became a part of `core` library in Rust 1.75. This change replaces the custom `CStr` implementation with the one from `core`. `core::CStr` behaves generally the same as the removed implementation, with the following differences: - It does not implement `Display`. - It does not provide `from_bytes_with_nul_unchecked_mut` method. - It has `as_ptr()` method instead of `as_char_ptr()`, which also returns `*const c_char`. The first two differences are handled by providing the `CStrExt` trait, with `display()` and `from_bytes_with_nul_unchecked_mut()` methods. `display()` returns a `CStrDisplay` wrapper, with a custom `Display` implementation. `DerefMut` implementation for `CString` is removed here, as it's not being used anywhere. Signed-off-by: Michal Rostecki --- v1 -> 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`. v2 -> v3: - Fix the commit message. - Remove redundant braces in `use`, when only one item is imported. v3 -> 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/). v4 -> v5: - Keep the `test_cstr_display*` unit tests. rust/kernel/error.rs | 7 +- rust/kernel/kunit.rs | 18 +- rust/kernel/net/phy.rs | 2 +- rust/kernel/prelude.rs | 4 +- rust/kernel/str.rs | 501 ++++++------------------------------ rust/kernel/sync/condvar.rs | 5 +- rust/kernel/sync/lock.rs | 6 +- rust/kernel/workqueue.rs | 2 +- scripts/rustdoc_test_gen.rs | 4 +- 9 files changed, 111 insertions(+), 438 deletions(-) diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs index 55280ae9fe40..18808b29604d 100644 --- a/rust/kernel/error.rs +++ b/rust/kernel/error.rs @@ -4,10 +4,11 @@ //! //! C header: [`include/uapi/asm-generic/errno-base.h`](srctree/include/uapi/asm-generic/errno-base.h) -use crate::{alloc::AllocError, str::CStr}; +use crate::alloc::AllocError; use alloc::alloc::LayoutError; +use core::ffi::CStr; use core::fmt; use core::num::TryFromIntError; use core::str::Utf8Error; @@ -142,7 +143,7 @@ pub fn name(&self) -> Option<&'static CStr> { None } else { // SAFETY: The string returned by `errname` is static and `NUL`-terminated. - Some(unsafe { CStr::from_char_ptr(ptr) }) + Some(unsafe { CStr::from_ptr(ptr) }) } } @@ -164,7 +165,7 @@ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { None => f.debug_tuple("Error").field(&-self.0).finish(), // SAFETY: These strings are ASCII-only. Some(name) => f - .debug_tuple(unsafe { core::str::from_utf8_unchecked(name) }) + .debug_tuple(unsafe { core::str::from_utf8_unchecked(name.to_bytes()) }) .finish(), } } diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 0ba77276ae7e..79a50ab59af0 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -56,13 +56,15 @@ macro_rules! kunit_assert { break 'out; } - static FILE: &'static $crate::str::CStr = $crate::c_str!($file); + static FILE: &'static core::ffi::CStr = $file; static LINE: i32 = core::line!() as i32 - $diff; - static CONDITION: &'static $crate::str::CStr = $crate::c_str!(stringify!($condition)); + static CONDITION: &'static core::ffi::CStr = $crate::c_str!(stringify!($condition)); // SAFETY: FFI call without safety requirements. let kunit_test = unsafe { $crate::bindings::kunit_get_current_test() }; if kunit_test.is_null() { + use kernel::str::CStrExt; + // The assertion failed but this task is not running a KUnit test, so we cannot call // KUnit, but at least print an error to the kernel log. This may happen if this // macro is called from an spawned thread in a test (see @@ -71,11 +73,13 @@ macro_rules! kunit_assert { // // This mimics KUnit's failed assertion format. $crate::kunit::err(format_args!( - " # {}: ASSERTION FAILED at {FILE}:{LINE}\n", - $name + " # {}: ASSERTION FAILED at {}:{LINE}\n", + $name.display(), + FILE.display(), )); $crate::kunit::err(format_args!( - " Expected {CONDITION} to be true, but is false\n" + " Expected {} to be true, but is false\n", + CONDITION.display(), )); $crate::kunit::err(format_args!( " Failure not reported to KUnit since this is a non-KUnit task\n" @@ -98,12 +102,12 @@ unsafe impl Sync for Location {} unsafe impl Sync for UnaryAssert {} static LOCATION: Location = Location($crate::bindings::kunit_loc { - file: FILE.as_char_ptr(), + file: FILE.as_ptr(), line: LINE, }); static ASSERTION: UnaryAssert = UnaryAssert($crate::bindings::kunit_unary_assert { assert: $crate::bindings::kunit_assert {}, - condition: CONDITION.as_char_ptr(), + condition: CONDITION.as_ptr(), expected_true: true, }); diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs index fd40b703d224..19f45922ec42 100644 --- a/rust/kernel/net/phy.rs +++ b/rust/kernel/net/phy.rs @@ -502,7 +502,7 @@ unsafe impl Sync for DriverVTable {} pub const fn create_phy_driver() -> DriverVTable { // INVARIANT: All the fields of `struct phy_driver` are initialized properly. DriverVTable(Opaque::new(bindings::phy_driver { - name: T::NAME.as_char_ptr().cast_mut(), + name: T::NAME.as_ptr().cast_mut(), flags: T::FLAGS, phy_id: T::PHY_DEVICE_ID.id, phy_id_mask: T::PHY_DEVICE_ID.mask_as_int(), diff --git a/rust/kernel/prelude.rs b/rust/kernel/prelude.rs index b37a0b3180fb..b0969ca78f10 100644 --- a/rust/kernel/prelude.rs +++ b/rust/kernel/prelude.rs @@ -12,7 +12,7 @@ //! ``` #[doc(no_inline)] -pub use core::pin::Pin; +pub use core::{ffi::CStr, pin::Pin}; pub use crate::alloc::{box_ext::BoxExt, flags::*, vec_ext::VecExt}; @@ -35,7 +35,7 @@ pub use super::error::{code::*, Error, Result}; -pub use super::{str::CStr, ThisModule}; +pub use super::ThisModule; pub use super::init::{InPlaceInit, Init, PinInit}; diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs index bb8d4f41475b..f1acaa377694 100644 --- a/rust/kernel/str.rs +++ b/rust/kernel/str.rs @@ -4,8 +4,9 @@ use crate::alloc::{flags::*, vec_ext::VecExt, AllocError}; use alloc::vec::Vec; +use core::ffi::CStr; use core::fmt::{self, Write}; -use core::ops::{self, Deref, DerefMut, Index}; +use core::ops::Deref; use crate::error::{code::*, Error}; @@ -41,11 +42,11 @@ impl fmt::Display for BStr { /// # use kernel::{fmt, b_str, str::{BStr, CString}}; /// let ascii = b_str!("Hello, BStr!"); /// let s = CString::try_from_fmt(fmt!("{}", ascii)).unwrap(); - /// assert_eq!(s.as_bytes(), "Hello, BStr!".as_bytes()); + /// assert_eq!(s.to_bytes(), "Hello, BStr!".as_bytes()); /// /// let non_ascii = b_str!("