From patchwork Mon Jul 15 22:11:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michal Rostecki X-Patchwork-Id: 13733930 Received: from mail-yw1-f194.google.com (mail-yw1-f194.google.com [209.85.128.194]) (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 C99CD3BBC2; Mon, 15 Jul 2024 22:13:54 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.194 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721081637; cv=none; b=ZG4y5GYjjcpsk5T9kIAiwBubTmOHwqGl6Fsa4nTOkS/eEcYULHDF79s1MTtgis21Bo2SiGZLzMWCxuyx8r26lO0WPMo64Fz6LkyR6dMhY+4qAQxZBpPqHqO3PMfxuuIWsYfDO+EUUWVNJAvjFHeqMzGcrrqtwZjSM5I/GmqL8DA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721081637; c=relaxed/simple; bh=0X8qLlzJqvWrNsyR7jCFaWTqWs6pVx5QNQA8xKeAS2c=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type; b=TgH3ZvMdoGldZeDYPEa75nJpIFKUryVxwC4GmtrjReS2/XvPTO1J9X8zIwa1qn3b/XZBoNVhjiUIbMk32g+QXlPvxE517H/0/CepdElPSyULRUoTRAZb1LLeNMfYHH/ACG15PnH5Kx1b6DxuE1COK95CTHf7/2mIXRJAYtcxRoU= 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=jtS4V7gO; arc=none smtp.client-ip=209.85.128.194 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="jtS4V7gO" Received: by mail-yw1-f194.google.com with SMTP id 00721157ae682-65f771485f2so23927707b3.0; Mon, 15 Jul 2024 15:13:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1721081633; x=1721686433; 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=rZHCUKK+K8WgRFJdrgu4HuGCZsPE6lpsyCAqXnnCQ6s=; b=jtS4V7gOsVSXMk1VSn14IHxyZKBu6zybsn3sCnwmDYKSfMhptErYEAqT92OjxOnnm9 Q4GvWMxe0UN9PCwtVQQJYu6Hpb7xcECqgyq3x794OsKVmKGAI6y0zYsgNRxUWy8Hrgsv qUBl582lb0Pa8nEneBUpJTBAQXf3FEk7QqyyhR7/d/FkW2mYMtvkNxnWOOh802km1pvQ WGIj76vnXpOAgOE/9Gwpbrg71Ke/bBTU2lXFIw9+yjtzCk06buIXy/clRJYEVs91qPCA hJmb/UCMsdgFS/m3u7mNWneMtnpd1HBDPUwfC5kW7zer1dupYEQ3irLKwjcyGS+z7J0r X3qQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721081633; x=1721686433; 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=rZHCUKK+K8WgRFJdrgu4HuGCZsPE6lpsyCAqXnnCQ6s=; b=xFCtfUVDmR2SzHuS9SFaM06AYFvYC5drM6PTVnT//h7pCNqbMoSRf8j4yp/FMtBU4y XDJ2VFsOC85+OgRM4vNxDLJLwE1BjkeS2PSBvqFmhMv0tzJMcEh2R4Oq4tVETdOeLwMY rVN41bKApWWJJ47vWOAdXSBI7toal6vD7KlecOGJTGhMICWTxecnKzp2CwEDfhnYfTn/ 2vztIn1qdAMy6BVNNB13gOfpnDgpx7jbdNJEtfS6SHSIJyccrZX00zXIrtBMr/kGk4Oj DAnDcxTAtwwcqLywrSsuNaLv5tyPare7TlLArx4fhV7vFyW86d3byy8MRxW4LBwOPbuU DQ/g== X-Forwarded-Encrypted: i=1; AJvYcCVCkXKjjtwNAEa+ScTu058Qr/AYm6qmes2jhgu7hDtJJ0uMYLV80HGLZbP+fpSNSSwZzRLv/PGuSMq16yVITDZ6Xcthy/f+s4o6FJTvihZ/be1DKZGeaOM3QYY0sOgsy7/s/ZSKSdwv80ZmLXndiWSTxkmLJTR+Tmqz2LlMB+zgMiMmYU8c2QrbIO3O01xSjpTLOLwlZLBJ8eVnWLJiZSY+iYgi1/I= X-Gm-Message-State: AOJu0Yy113EX2GzyfohiuPX98oI3GhTEuhfn1J4MJa5mcSQTcsxnMFWk IAVTkbZCMk0jPIr88BzJE/kAnoQGQZJKhAB+GA3bTN+BP5NLgSIn X-Google-Smtp-Source: AGHT+IFfMoSL3JKzCfH6N3ijgOQL6jOmuyD9r8Z1djFwSF9KCWmY7LxayhqVkeXBBcr0+r9V9rWdoQ== X-Received: by 2002:a0d:c747:0:b0:65f:9f0f:7912 with SMTP id 00721157ae682-6637f69c852mr4601007b3.20.1721081633271; Mon, 15 Jul 2024 15:13:53 -0700 (PDT) Received: from vadorovsky-macbookpro.fritz.box ([2607:fea8:fd50:8247::f272]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b761aa050csm25506086d6.138.2024.07.15.15.13.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Jul 2024 15:13:52 -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 , Asahi Lina , Yutaro Ohno , Danilo Krummrich , Charalampos Mitrodimas , Ben Gooding , Tejun Heo , 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 v3] rust: str: Use `core::CStr`, remove the custom `CStr` implementation Date: Tue, 16 Jul 2024 00:11:10 +0200 Message-ID: <20240715221126.487345-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` (but implements `Debug`). Therefore, by switching to `core::CStr`, we lose the `Display` implementation. - Lack of `Display` implementation impacted only rust/kernel/kunit.rs. In this change, we use `Debug` format there. The only difference between the removed `Display` output and `Debug` output are quotation marks present in the latter (`foo` vs `"foo"`). - It does not provide `from_bytes_with_nul_unchecked_mut` method. - It was used only in `DerefMut` implementation for `CString`. This change removes that implementation. - Otherwise, having such a method is not desirable. The rule in Rust std is that `str` is used only as an immutable reference (`&str`), while mutating strings is done with the owned `String` type. Similarly, we can introduce the rule that `CStr` should be used only as an immutable reference (`&CStr`), while mutating is done only with the owned `CString` type. - It has `as_ptr()` method instead of `as_char_ptr()`, which also returns `*const c_char`. 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. rust/kernel/error.rs | 7 +- rust/kernel/kunit.rs | 12 +- rust/kernel/net/phy.rs | 2 +- rust/kernel/prelude.rs | 4 +- rust/kernel/str.rs | 486 ++---------------------------------- 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, 44 insertions(+), 484 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..c08f9dddaa6f 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -56,9 +56,9 @@ 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() }; @@ -71,11 +71,11 @@ macro_rules! kunit_assert { // // This mimics KUnit's failed assertion format. $crate::kunit::err(format_args!( - " # {}: ASSERTION FAILED at {FILE}:{LINE}\n", + " # {:?}: ASSERTION FAILED at {FILE:?}:{LINE:?}\n", $name )); $crate::kunit::err(format_args!( - " Expected {CONDITION} to be true, but is false\n" + " Expected {CONDITION:?} to be true, but is false\n" )); $crate::kunit::err(format_args!( " Failure not reported to KUnit since this is a non-KUnit task\n" @@ -98,12 +98,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..e491a9803187 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!("