From patchwork Sun Feb 2 16:31:19 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tamir Duberstein X-Patchwork-Id: 13956544 Received: from mail-pj1-f44.google.com (mail-pj1-f44.google.com [209.85.216.44]) (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 7DDBF10E0; Sun, 2 Feb 2025 16:39:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.44 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738514363; cv=none; b=emssu05Cn2WjauuzQEdgeBYN3B58L6wpD8rMwiV+GWg+kgkFzBhrMty3WQP2CGDO6V3LBTqmtK411KjOi3zw//tYEVnOzFe74T00X/X4JKV/jVq39VrNKIHHxRo86Xo68jI0TBj/+xohjNQp/tQADopDhZWa/okb94LshR/dScs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738514363; c=relaxed/simple; bh=eOh2rpdDyjrO4tsEi/ljquHrLIfisg7RinqcV+HVncs=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=TQIPyxc2w/WiVyMUIrdpyg9taFXHi2v2IDlX1ZmlXMKvH2SnLDmvSCI4XLpjKWtcvhUim5aelKJFoVFAT4t+VPaJ2gcCdt8/FM6esElx25tLx2li5ZmpqEiyzyFfcghHF3vRH0T0WiV1GO5SwomoN6ZC90ogzDvBZJUtyjIRCpI= 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=EGJcON4F; arc=none smtp.client-ip=209.85.216.44 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="EGJcON4F" Received: by mail-pj1-f44.google.com with SMTP id 98e67ed59e1d1-2f441904a42so6128009a91.1; Sun, 02 Feb 2025 08:39:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738514360; x=1739119160; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=Asgf1xelIrx+SrLj7fQhqz+2lJCzsMJqTI2bB/U+95g=; b=EGJcON4FXAbrIlBatVJZHl8ugX0c+CLRjA/90zpdNUa7gpCMvaRejgzf/L933JnSnw UGADNE2MHKw2JWacEKZP7S97a/2QVvf3ufHqJBMjevuVxVC+bo25f4fQiEpTv7pDM6p2 SdZ+S6yNyiITkr+EJUf3sZDM5HmS20KyKhnZLhBqzuMIe5bKHJIB9mv2/8DIQ0XW5V6k IK0g/SnB2bkv+BxaOpcwtqfP8+e3+9iTx+M6v2v6WtNQj9dqxDR7GKB5wWP8UcpXcwDe NR1zyxNYyk4dmbdi4DO9vlD6WBAVglK7pam+DEuARkWrnaR79WDo+FFaWex7NPvqngb/ VU2g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738514360; x=1739119160; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Asgf1xelIrx+SrLj7fQhqz+2lJCzsMJqTI2bB/U+95g=; b=Dfcl8pYmesgYdJZr4qlj4AGWL7B7yR+GLppkD0L5lk/1uUfKF5bC9R0mst+ISVDDoq E58vpdTAIfkyZMTEl8ANlpFPf7dqP0ov3o2tso2FPcg1L7QGyHnCA/2sAjIZuBHk5Xql ALGD/zjJKfZTcSNa7gOmtTJHahiqlEkXWx38A16UtToNta6bN1R18xSrntOG1DbG8LCN h5wwIL/EjAEoRr1EbQTW1bmfbLULWEtEg07EYt8U1bK7FPVcmGAmFgcMAsAVeKeUB6cx fGZbwR7uzUsYxuvOt0Z2y/ghv9UXPC9VrTdoIb33eRBw8iYx1dgPtAN+FDNUlw4blP1Q Hhtw== X-Forwarded-Encrypted: i=1; AJvYcCVjIbLLS10tvqSI3C0Z6xjNXBJWQNzumbeZtJQQCbMAZd8XC6AZcnjK8HqaV0ejOOJHh1Hls5m9D/s6Cmw=@vger.kernel.org X-Gm-Message-State: AOJu0YzpBwlO/j6ffmBx+vnl3EkF2qCccyroTl2oecSjgrJikp3tzBPd 0O65bn245tSWfYFVnFFdoROCXU8eJjhGOxgzvi4wnJoxWVUlhsz4YJOxs8oVgZA= X-Gm-Gg: ASbGncupsLCUNwx5NyxwADFKEjTRoYBTNGB3zcdsaXBCpxNIxkHOHkGDjALfHzWnaRv LM4cUnCg4mwiOjU05Q2PkXWde2snO2WWrvlSyVvqCBXsvBWEFCtymle7dJ5WKMNcQwoqXknLN9r 927W8OKzP5DKCPXRImZuiHZiGambkQki6fvRfNHsJJ6wGVu5Wq9N5x3YqeBx9tNV2dfsV2LCnNX MMZcZ2p/wkw91Jw6FxUNzL9ucSGBL62mF+LtJYTD/HPFKHNP0o9mG4UQ4dGTIkddjDaET2l2zH6 LC8P0w6HoMyZGMPFkWL7IWSRZzJFIpu++QqiQT4= X-Google-Smtp-Source: AGHT+IFxtgkcG/S32dK4vtrKshUXTNx0djiHQHVyEy9QEer1Jg+04U2o3oFmWOE1ClXqY57TU12v2w== X-Received: by 2002:a05:620a:258b:b0:7b6:dac1:cb73 with SMTP id af79cd13be357-7bffcda901cmr2986013385a.56.1738513891738; Sun, 02 Feb 2025 08:31:31 -0800 (PST) Received: from tamird-mac.local ([2600:4041:5be7:7c00:f07f:fb14:288d:6f1e]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7c00a8bb957sm421307485a.14.2025.02.02.08.31.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 02 Feb 2025 08:31:30 -0800 (PST) From: Tamir Duberstein Date: Sun, 02 Feb 2025 11:31:19 -0500 Subject: [PATCH v7 2/4] rust: replace `CStr` with `core::ffi::CStr` Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20250202-cstr-core-v7-2-da1802520438@gmail.com> References: <20250202-cstr-core-v7-0-da1802520438@gmail.com> In-Reply-To: <20250202-cstr-core-v7-0-da1802520438@gmail.com> To: Michal Rostecki , Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Tamir Duberstein X-Mailer: b4 0.15-dev `std::ffi::CStr` was moved to `core::ffi::CStr` in Rust 1.64. Replace `kernel::str::CStr` with `core::ffi::CStr` now that we can. `kernel::str::CStr::{from,as}_char_ptr` live on as free functions in `kernel::str` to paper over the difference between `core::ffi::c_char` and `kernel::ffi::char`; see the code comment on the latter type for details. C-String literals were added in Rust 1.77. Opportunistically replace instances of `kernel::c_str!` with C-String literals where other code changes were already necessary; the rest will be done in a later commit. Signed-off-by: Tamir Duberstein --- drivers/gpu/drm/drm_panic_qr.rs | 2 +- rust/kernel/device.rs | 12 +- rust/kernel/error.rs | 4 +- rust/kernel/firmware.rs | 2 +- rust/kernel/kunit.rs | 4 +- rust/kernel/miscdevice.rs | 2 +- rust/kernel/net/phy.rs | 2 +- rust/kernel/of.rs | 2 +- rust/kernel/pci.rs | 8 +- rust/kernel/platform.rs | 2 +- rust/kernel/prelude.rs | 5 +- rust/kernel/seq_file.rs | 4 +- rust/kernel/str.rs | 446 ++++++++++------------------------------ rust/kernel/sync/condvar.rs | 2 +- rust/kernel/sync/lock.rs | 2 +- rust/kernel/sync/lock/global.rs | 2 +- rust/kernel/workqueue.rs | 2 +- 17 files changed, 138 insertions(+), 365 deletions(-) diff --git a/drivers/gpu/drm/drm_panic_qr.rs b/drivers/gpu/drm/drm_panic_qr.rs index bcf248f69252..ef294017888e 100644 --- a/drivers/gpu/drm/drm_panic_qr.rs +++ b/drivers/gpu/drm/drm_panic_qr.rs @@ -958,7 +958,7 @@ fn draw_all(&mut self, data: impl Iterator) { } else { // SAFETY: The caller ensures that `url` is a valid pointer to a // nul-terminated string. - let url_cstr: &CStr = unsafe { CStr::from_char_ptr(url) }; + let url_cstr: &CStr = unsafe { kernel::str::from_char_ptr(url) }; let segments = &[ &Segment::Binary(url_cstr.as_bytes()), &Segment::Numeric(&data_slice[0..data_len]), diff --git a/rust/kernel/device.rs b/rust/kernel/device.rs index db2d9658ba47..9554921368c0 100644 --- a/rust/kernel/device.rs +++ b/rust/kernel/device.rs @@ -11,9 +11,6 @@ }; use core::{fmt, ptr}; -#[cfg(CONFIG_PRINTK)] -use crate::c_str; - /// A reference-counted device. /// /// This structure represents the Rust abstraction for a C `struct device`. This implementation @@ -176,7 +173,7 @@ unsafe fn printk(&self, klevel: &[u8], msg: fmt::Arguments<'_>) { bindings::_dev_printk( klevel as *const _ as *const crate::ffi::c_char, self.as_raw(), - c_str!("%pA").as_char_ptr(), + crate::str::as_char_ptr(c"%pA"), &msg as *const _ as *const crate::ffi::c_void, ) }; @@ -185,7 +182,12 @@ unsafe fn printk(&self, klevel: &[u8], msg: fmt::Arguments<'_>) { /// Checks if property is present or not. pub fn property_present(&self, name: &CStr) -> bool { // SAFETY: By the invariant of `CStr`, `name` is null-terminated. - unsafe { bindings::device_property_present(self.as_raw().cast_const(), name.as_char_ptr()) } + unsafe { + bindings::device_property_present( + self.as_raw().cast_const(), + crate::str::as_char_ptr(name), + ) + } } } diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs index f6ecf09cb65f..51c5e0f0a0bc 100644 --- a/rust/kernel/error.rs +++ b/rust/kernel/error.rs @@ -164,7 +164,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 { crate::str::from_char_ptr(ptr) }) } } @@ -187,7 +187,7 @@ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { Some(name) => f .debug_tuple( // SAFETY: These strings are ASCII-only. - unsafe { core::str::from_utf8_unchecked(name) }, + unsafe { core::str::from_utf8_unchecked(name.to_bytes()) }, ) .finish(), } diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs index c5162fdc95ff..e75db4d825ce 100644 --- a/rust/kernel/firmware.rs +++ b/rust/kernel/firmware.rs @@ -61,7 +61,7 @@ fn request_internal(name: &CStr, dev: &Device, func: FwFunc) -> Result { // SAFETY: `pfw` is a valid pointer to a NULL initialized `bindings::firmware` pointer. // `name` and `dev` are valid as by their type invariants. - let ret = unsafe { func.0(pfw as _, name.as_char_ptr(), dev.as_raw()) }; + let ret = unsafe { func.0(pfw as _, crate::str::as_char_ptr(name), dev.as_raw()) }; if ret != 0 { return Err(Error::from_errno(ret)); } diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 630b947c708c..9f40ea744fc2 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -101,12 +101,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: $crate::str::as_char_ptr(FILE), line: LINE, }); static ASSERTION: UnaryAssert = UnaryAssert($crate::bindings::kunit_unary_assert { assert: $crate::bindings::kunit_assert {}, - condition: CONDITION.as_char_ptr(), + condition: $crate::str::as_char_ptr(CONDITION), expected_true: true, }); diff --git a/rust/kernel/miscdevice.rs b/rust/kernel/miscdevice.rs index e14433b2ab9d..65f70ff61eb3 100644 --- a/rust/kernel/miscdevice.rs +++ b/rust/kernel/miscdevice.rs @@ -34,7 +34,7 @@ pub const fn into_raw(self) -> bindings::miscdevice { // SAFETY: All zeros is valid for this C type. let mut result: bindings::miscdevice = unsafe { MaybeUninit::zeroed().assume_init() }; result.minor = bindings::MISC_DYNAMIC_MINOR as _; - result.name = self.name.as_char_ptr(); + result.name = crate::str::as_char_ptr(self.name); result.fops = create_vtable::(); result } diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs index bb654a28dab3..c60205606aee 100644 --- a/rust/kernel/net/phy.rs +++ b/rust/kernel/net/phy.rs @@ -504,7 +504,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: crate::str::as_char_ptr(T::NAME), 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/of.rs b/rust/kernel/of.rs index 04f2d8ef29cb..12ea65df46de 100644 --- a/rust/kernel/of.rs +++ b/rust/kernel/of.rs @@ -29,7 +29,7 @@ fn index(&self) -> usize { impl DeviceId { /// Create a new device id from an OF 'compatible' string. pub const fn new(compatible: &'static CStr) -> Self { - let src = compatible.as_bytes_with_nul(); + let src = compatible.to_bytes_with_nul(); // Replace with `bindings::of_device_id::default()` once stabilized for `const`. // SAFETY: FFI type is valid to be zero-initialized. let mut of: bindings::of_device_id = unsafe { core::mem::zeroed() }; diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs index 4c98b5b9aa1e..af36ddac80ff 100644 --- a/rust/kernel/pci.rs +++ b/rust/kernel/pci.rs @@ -35,7 +35,7 @@ unsafe fn register( ) -> Result { // SAFETY: It's safe to set the fields of `struct pci_driver` on initialization. unsafe { - (*pdrv.get()).name = name.as_char_ptr(); + (*pdrv.get()).name = crate::str::as_char_ptr(name); (*pdrv.get()).probe = Some(Self::probe_callback); (*pdrv.get()).remove = Some(Self::remove_callback); (*pdrv.get()).id_table = T::ID_TABLE.as_ptr(); @@ -43,7 +43,7 @@ unsafe fn register( // SAFETY: `pdrv` is guaranteed to be a valid `RegType`. to_result(unsafe { - bindings::__pci_register_driver(pdrv.get(), module.0, name.as_char_ptr()) + bindings::__pci_register_driver(pdrv.get(), module.0, crate::str::as_char_ptr(name)) }) } @@ -275,7 +275,9 @@ fn new(pdev: Device, num: u32, name: &CStr) -> Result { // `pdev` is valid by the invariants of `Device`. // `num` is checked for validity by a previous call to `Device::resource_len`. // `name` is always valid. - let ret = unsafe { bindings::pci_request_region(pdev.as_raw(), num, name.as_char_ptr()) }; + let ret = unsafe { + bindings::pci_request_region(pdev.as_raw(), num, crate::str::as_char_ptr(name)) + }; if ret != 0 { return Err(EBUSY); } diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs index 50e6b0421813..d1752a978af4 100644 --- a/rust/kernel/platform.rs +++ b/rust/kernel/platform.rs @@ -36,7 +36,7 @@ unsafe fn register( // SAFETY: It's safe to set the fields of `struct platform_driver` on initialization. unsafe { - (*pdrv.get()).driver.name = name.as_char_ptr(); + (*pdrv.get()).driver.name = crate::str::as_char_ptr(name); (*pdrv.get()).probe = Some(Self::probe_callback); (*pdrv.get()).remove = Some(Self::remove_callback); (*pdrv.get()).driver.of_match_table = of_table; diff --git a/rust/kernel/prelude.rs b/rust/kernel/prelude.rs index dde2e0649790..96e7029c27da 100644 --- a/rust/kernel/prelude.rs +++ b/rust/kernel/prelude.rs @@ -34,7 +34,10 @@ pub use super::error::{code::*, Error, Result}; -pub use super::{str::CStr, ThisModule}; +pub use super::{ + str::{CStr, CStrExt as _}, + ThisModule, +}; pub use super::init::{InPlaceInit, InPlaceWrite, Init, PinInit}; diff --git a/rust/kernel/seq_file.rs b/rust/kernel/seq_file.rs index 04947c672979..bb3c49fd4ef3 100644 --- a/rust/kernel/seq_file.rs +++ b/rust/kernel/seq_file.rs @@ -4,7 +4,7 @@ //! //! C header: [`include/linux/seq_file.h`](srctree/include/linux/seq_file.h) -use crate::{bindings, c_str, types::NotThreadSafe, types::Opaque}; +use crate::{bindings, types::NotThreadSafe, types::Opaque}; /// A utility for generating the contents of a seq file. #[repr(transparent)] @@ -35,7 +35,7 @@ pub fn call_printf(&self, args: core::fmt::Arguments<'_>) { unsafe { bindings::seq_printf( self.inner.get(), - c_str!("%pA").as_char_ptr(), + crate::str::as_char_ptr(c"%pA"), &args as *const _ as *const crate::ffi::c_void, ); } diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs index c273f1367607..0c4189a478b4 100644 --- a/rust/kernel/str.rs +++ b/rust/kernel/str.rs @@ -4,7 +4,7 @@ use crate::alloc::{flags::*, AllocError, KVec}; use core::fmt::{self, Write}; -use core::ops::{self, Deref, DerefMut, Index}; +use core::ops::{Deref, DerefMut}; use crate::error::{code::*, Error}; @@ -45,11 +45,11 @@ pub const fn from_bytes(bytes: &[u8]) -> &Self { /// # use kernel::{fmt, b_str, str::CString}; /// let ascii = b_str!("Hello, BStr!"); /// let s = CString::try_from_fmt(fmt!("{}", ascii.display()))?; - /// assert_eq!(s.as_bytes(), "Hello, BStr!".as_bytes()); + /// assert_eq!(s.to_bytes(), "Hello, BStr!".as_bytes()); /// /// let non_ascii = b_str!("