From patchwork Sun Feb 2 16:31:18 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tamir Duberstein X-Patchwork-Id: 13956541 Received: from mail-qk1-f179.google.com (mail-qk1-f179.google.com [209.85.222.179]) (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 6EBED14A0BC; Sun, 2 Feb 2025 16:31:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738513893; cv=none; b=ibXO7LoOIOUJzDcKIp9rQUQhQOnFDuR3frJzOXdl52nT2gsqFS+cvzLlfwwQFKr9zsz5qQ88cmsDwvHqsAp2RFE76qp5+q9rSqGqJ40CHVdjO/PIFQSNvkX2+S6ygiZ9jrUpHPkHZw0wKGF7uMu1mv0GzpPIqr1h6wCIHNDt72g= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738513893; c=relaxed/simple; bh=eORAKQVLowETgizLa4/np6sYZbSCzYW5ILAB+ErjH1o=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=mYfvjMqOVNkfqXGJqkYLTNUQTmxkCyMArUxX+6e47Yc1GWWoD8TDnQundR7hJApGQLPrGh7Fcjp66j0u/sCLKCvie5rh74UgEKaKdZJiRAGhq5MNaDLDLbbKk0GYoXB4IIteNP6Zlk5+j5XzVnobz7DMgBNCJv3Xd9vGSdaBYlk= 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=LVgRGhNE; arc=none smtp.client-ip=209.85.222.179 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="LVgRGhNE" Received: by mail-qk1-f179.google.com with SMTP id af79cd13be357-7b6e9586b82so326548085a.1; Sun, 02 Feb 2025 08:31:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738513890; x=1739118690; 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=NNPwVnOFpCLxp1yviLIHuAXCLL7HWNGaSzEhnwzmXGQ=; b=LVgRGhNEhHu+ziMZ5wiZQRA54tn61Oj/e3f86Q1EOURGxycIXCrqREuxXR+0QmO3xZ K5MBC9yeg8u0Vs234ZNTqj1z1ZIBqbNGrAapa1J6CGrb7NXRmWttk9206qumW9uujoIw UAY8ajtph4Z/cv1qZ9uTKBTDZQyQpl0h2CKRQNFJ18W/C8zqRsv2LbfFLGDh2L/LCj1I alUeUf/L5rmq9Wy2sXAtBJYg5xtAkc7oZhMIqKXsdhRct7lcLZ+D6zYkdNSLfMRDRSRI 5vi5tzn6arw8L1dRXZV2pLBboke1fl2tJ6e2zCVzqTzojBvHRP4Xv1Km56ZwBaZmm66a 5eAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738513890; x=1739118690; 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=NNPwVnOFpCLxp1yviLIHuAXCLL7HWNGaSzEhnwzmXGQ=; b=wSZrukGJIhy84A+xNxx1Hv9NHJ2GK3XiKyJ7wOD0K1xPfVZY1Y2xttivzWbLig+Ie6 EKBxj6M3Ul6koovZ7ZFFoSVTDHUIbbNGccySJuVrNKh4yesr8drA66YTxZWyUKuIeM/2 UWkraq4R59LPMkO+Gd5BUPTldA6B9O2lwjHKK6vcnFMKkTsR8+yw79cOFoksrLUEAhWx nPn22cw+Lywx5aEck8h0E/mZzMgfe8QsvAh2QAjXcbaQmIx9euJe8NNpGBtKdGJKpY3H IC77cZpWZ/qH72aBN8vt/uqO9smr332qRqDcBtL9HZ95jXJsts1edCiTOLypNZYN96vM DG2A== X-Forwarded-Encrypted: i=1; AJvYcCX62X0BaPOhVUem4I4akYUuN+PxAvG5q/N0kHcJrvIerjOdhoahGibyXw3r+Z1z4B3/UKJaa2JkDXkVtsM=@vger.kernel.org X-Gm-Message-State: AOJu0YyvXNWE5rg8Uqv+PGa8AAx0Ztgi3qUUoZ4VGYVrb2D2D6M3SeoV 4PiTezhQdEwIKUUW4ceD/a0xzLXkgBDvX12wmjBlRrLPDTeY5hKs X-Gm-Gg: ASbGncvBRSX2BbWSfVPCKHv9xwtF+Tvs3ZLSzKbJU/7EwZY0YhAu6UqopatLupAU0Ig TszfzLsZ8eaJiTF0YO/Fllsv/iTiFBSqa4zo9iZxsVNi+60KI7vDlpynGMTNQZ9ge3uvB55ckzg jAuXXSzzFTQFCyidc6DoJ/KUWpeokRxWJgRkoj7FWNAqJFQuq5KEPFd3h3sOGeFAZgvi7xODv6v CqgA9gsbYyZRlYzbHYUu/qo8Z0QZOYlIsCvmRJpx9E2rCKugFlcN4t64jd/iCCDnbZF2MMdywWJ j02NXRIGOgDMPsPydK0xupKriJ5vCHKuN6i5rFo= X-Google-Smtp-Source: AGHT+IEes9eO+bJuPS3zvGHvmJfTHUSdf4XUV5B/BFGf41lmM9FcZHrhiLL5OSOlyBkrzjvJwrNnzg== X-Received: by 2002:a05:620a:6081:b0:7b6:f1be:4f68 with SMTP id af79cd13be357-7bffcda57femr2959387485a.46.1738513890150; Sun, 02 Feb 2025 08:31:30 -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.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 02 Feb 2025 08:31:28 -0800 (PST) From: Tamir Duberstein Date: Sun, 02 Feb 2025 11:31:18 -0500 Subject: [PATCH v7 1/4] rust: move BStr,CStr Display impls behind method 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-1-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 There are two reasons for doing this: - Moving the Display impl behind a display method matches the style used in the standard library for printing non-Unicode data. - The standard library's core::ffi::CStr doesn't implement Display; moving Display to a helper struct is a necessary step toward using it. Signed-off-by: Tamir Duberstein --- rust/kernel/kunit.rs | 9 ++-- rust/kernel/str.rs | 121 +++++++++++++++++++++++++++++++++++---------------- 2 files changed, 90 insertions(+), 40 deletions(-) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 824da0e9738a..630b947c708c 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -56,6 +56,7 @@ macro_rules! kunit_assert { break 'out; } + static NAME: &'static $crate::str::CStr = $crate::c_str!($name); static FILE: &'static $crate::str::CStr = $crate::c_str!($file); static LINE: i32 = core::line!() as i32 - $diff; static CONDITION: &'static $crate::str::CStr = $crate::c_str!(stringify!($condition)); @@ -71,11 +72,13 @@ macro_rules! kunit_assert { // // This mimics KUnit's failed assertion format. $crate::kunit::err(format_args!( - " # {}: ASSERTION FAILED at {FILE}:{LINE}\n", - $name + " # {NAME}: ASSERTION FAILED at {FILE}:{LINE}\n", + NAME = NAME.display(), + FILE = FILE.display(), )); $crate::kunit::err(format_args!( - " Expected {CONDITION} to be true, but is false\n" + " Expected {CONDITION} to be true, but is false\n", + CONDITION = CONDITION.display(), )); $crate::kunit::err(format_args!( " Failure not reported to KUnit since this is a non-KUnit task\n" diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs index 28e2201604d6..c273f1367607 100644 --- a/rust/kernel/str.rs +++ b/rust/kernel/str.rs @@ -31,29 +31,77 @@ pub const fn from_bytes(bytes: &[u8]) -> &Self { // SAFETY: `BStr` is transparent to `[u8]`. unsafe { &*(bytes as *const [u8] as *const BStr) } } -} -impl fmt::Display for BStr { - /// Formats printable ASCII characters, escaping the rest. + /// Returns an object that implements [`Display`] for safely printing a [`BStr`] that may + /// contain non-Unicode data. If you would like an implementation which escapes the [`BStr`] + /// please use [`Debug`] instead. + /// + /// [`Display`]: fmt::Display + /// [`Debug`]: fmt::Debug + /// + /// # Examples /// /// ``` - /// # use kernel::{fmt, b_str, str::{BStr, CString}}; + /// # use kernel::{fmt, b_str, str::CString}; /// let ascii = b_str!("Hello, BStr!"); - /// let s = CString::try_from_fmt(fmt!("{}", ascii))?; + /// let s = CString::try_from_fmt(fmt!("{}", ascii.display()))?; /// assert_eq!(s.as_bytes(), "Hello, BStr!".as_bytes()); /// /// let non_ascii = b_str!(" 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!(" From patchwork Sun Feb 2 16:31:20 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tamir Duberstein X-Patchwork-Id: 13956542 Received: from mail-qk1-f173.google.com (mail-qk1-f173.google.com [209.85.222.173]) (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 7CF071FBC83; Sun, 2 Feb 2025 16:31:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.173 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738513896; cv=none; b=kiUwFbF8hsgnGEmykYJW+mnco0np2JsqkWiNlZIpw0PWF+TwrehfdJykun8wLBuw4XG/GpmvGZzmnH+ahupDrRFF6q2JAM+9GpnE6CCV9/q5a4j0QYV3ok3wBEOYM3ExB7uR8/jfHoQW4ZGJonJHHdB44fwnEkhpozwEobSuqyo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738513896; c=relaxed/simple; bh=I8KHV9qqtP8XO38JFSzGPLiRuygDD4fZVIlB80rmzL4=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=l2wgnm4Du2llx7mksc3KIlwPv6xSyFDfUKh+0sBNfGBCDLm7NeH1K2lS34Ad4JaUeIicO3j/cZPxximHINHEcIvJNc7Aj0z23+C8FoGROr5C9j3wNd2O67ZFQy92yy8bQexBVABIFKslj09d67rvhN1FW2tZH3D6YxiNoeouSyc= 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=FI8mgijs; arc=none smtp.client-ip=209.85.222.173 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="FI8mgijs" Received: by mail-qk1-f173.google.com with SMTP id af79cd13be357-7b6e9317a2aso409443985a.0; Sun, 02 Feb 2025 08:31:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738513893; x=1739118693; 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=Wy2ZrB6fja+LbsX27rvFHvMz2FLWlQCHNF4NZp66JmE=; b=FI8mgijsKDJzzI5waNaYAB0Mo7+h/kZ2Th/ksc1Dw2pRDHS/YekFpC6Ffs78bR9OxI x7sqK88ssTMiyJ6VjMynMoADqrNqNhK327PxQIbFqRCMdXCtljZBLDuK477qZa6En2fQ Onnz1iu1Gq6j4o8sc8042K7HqVodPVdT/dZDfHIA/6g1QrUs0TGjv49gyHVvkxGQGork CchqZ8YvLC2pKG/IauvWZ+fnSNeA9cw6BfJtdd4OkmMV5fNEVTtGf3xj+6CFUfUW/Uvx 8ZpmCa4TPGZt1POHFBByA7aNNgIVRBIvoIH8LZX02pAC5f/sbnGwoXo5+tv5c2cNMkar P85A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738513893; x=1739118693; 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=Wy2ZrB6fja+LbsX27rvFHvMz2FLWlQCHNF4NZp66JmE=; b=vb5EKdWVuAZU1uVM+ti5O/35BhajPikvtqI+S/iivFiMJnMPO/DpyD8Rrqd7SBlxOf E4++DqqXyF7S/nxTUAnZzjPPESL9Thw8Iwxb745k4nzdXWo0hfDtEa7L6IsUrspZeafX euR5iVscEsgmXikEuRdxwK3QThZW5TjIAns7jC+XxThgnoUmJqMCnVU7/4/ucVfYXccF w9HLHBABhcbrBd+RNaJQ+QgNybms83XiC822QJl6DTMiYmgauV7K4zxZ/jaBpuPkI6u+ QjzyncwkJMEkExeQZVHl6eN4VVAN3He6wAXx6tRUjFQ8k7yLW2noy1jV3UKwNA3wx7vs SD6A== X-Forwarded-Encrypted: i=1; AJvYcCX7twWGExTaNI7PMq21WnktJvhNc+wMqRGETxGtsc4z6V9XvBh+veHWWKQIJRUFGnYK/P+mxAlJT2Mu2As=@vger.kernel.org X-Gm-Message-State: AOJu0YwfGceyACiTN+0qbBiQoDu8k/SOmYGQ8KwWzyWZUjfS4lA0nmwZ QXmfVJwH2WiCPdEIxI+wHRkyNgBknv8zMYkqgaTsDAqO7YHI8tnl X-Gm-Gg: ASbGncsFP2ibIaIlRMLTb0PXwP25t9nakdGNJ+yyl0oOyM7xTFpSXPtuHHuKI8x2Paa NZEKGGSsF/OeLsVo0ve0O1cUsGHtQITR4iswYvCtlA4L+FudTNscVvWy4s+ICrrivobClPO4/Rv bmB6PGPAVwNTZo5Kw2xPTQTi0xHDxLaqdgSUsGValX5sWm0MkBRczETpuulFnwdUtzo4vqPI4x3 JJMl/SWl5M18zgrShUyRVHwgy39dBI/PvTqDzOjd/HfnEOPZp2KANZ138qyrHH6Pw9QTWPFPKtD GM0cycFSQM0R0l0AKr+1c2p7rVAFfPZQAFTlO2I= X-Google-Smtp-Source: AGHT+IEfq5qfPIuleu/gKswH4zJkmmqYLeugQt/NbMerzELwRxsZwFGcr9flUGBRDsMgu09R/LLP6A== X-Received: by 2002:a05:620a:244e:b0:7b6:cef9:4f10 with SMTP id af79cd13be357-7c011d95f51mr1266766985a.3.1738513892959; Sun, 02 Feb 2025 08:31:32 -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.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 02 Feb 2025 08:31:32 -0800 (PST) From: Tamir Duberstein Date: Sun, 02 Feb 2025 11:31:20 -0500 Subject: [PATCH v7 3/4] rust: replace `kernel::c_str!` with C-Strings 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-3-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 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: https://github.com/Rust-for-Linux/linux/issues/1075 Signed-off-by: Tamir Duberstein --- drivers/net/phy/ax88796b_rust.rs | 7 +++---- drivers/net/phy/qt2025.rs | 5 ++--- rust/kernel/devres.rs | 2 +- rust/kernel/firmware.rs | 4 ++-- rust/kernel/kunit.rs | 7 ++++--- rust/kernel/net/phy.rs | 6 ++---- rust/kernel/platform.rs | 4 ++-- rust/kernel/str.rs | 37 +++++++++++++++++++++++------------- rust/kernel/sync.rs | 4 ++-- rust/kernel/sync/lock/global.rs | 3 ++- rust/macros/module.rs | 2 +- samples/rust/rust_driver_pci.rs | 4 ++-- samples/rust/rust_driver_platform.rs | 4 ++-- samples/rust/rust_misc_device.rs | 3 +-- 14 files changed, 50 insertions(+), 42 deletions(-) diff --git a/drivers/net/phy/ax88796b_rust.rs b/drivers/net/phy/ax88796b_rust.rs index 8c7eb009d9fc..b07d36f45a43 100644 --- a/drivers/net/phy/ax88796b_rust.rs +++ b/drivers/net/phy/ax88796b_rust.rs @@ -5,7 +5,6 @@ //! //! C version of this driver: [`drivers/net/phy/ax88796b.c`](./ax88796b.c) use kernel::{ - c_str, net::phy::{self, reg::C22, DeviceId, Driver}, prelude::*, uapi, @@ -41,7 +40,7 @@ fn asix_soft_reset(dev: &mut phy::Device) -> Result { #[vtable] impl Driver for PhyAX88772A { const FLAGS: u32 = phy::flags::IS_INTERNAL; - const NAME: &'static CStr = c_str!("Asix Electronics AX88772A"); + const NAME: &'static CStr = c"Asix Electronics AX88772A"; const PHY_DEVICE_ID: DeviceId = DeviceId::new_with_exact_mask(0x003b1861); // AX88772A is not working properly with some old switches (NETGEAR EN 108TP): @@ -105,7 +104,7 @@ fn link_change_notify(dev: &mut phy::Device) { #[vtable] impl Driver for PhyAX88772C { const FLAGS: u32 = phy::flags::IS_INTERNAL; - const NAME: &'static CStr = c_str!("Asix Electronics AX88772C"); + const NAME: &'static CStr = c"Asix Electronics AX88772C"; const PHY_DEVICE_ID: DeviceId = DeviceId::new_with_exact_mask(0x003b1881); fn suspend(dev: &mut phy::Device) -> Result { @@ -125,7 +124,7 @@ fn soft_reset(dev: &mut phy::Device) -> Result { #[vtable] impl Driver for PhyAX88796B { - const NAME: &'static CStr = c_str!("Asix Electronics AX88796B"); + const NAME: &'static CStr = c"Asix Electronics AX88796B"; const PHY_DEVICE_ID: DeviceId = DeviceId::new_with_model_mask(0x003b1841); fn soft_reset(dev: &mut phy::Device) -> Result { diff --git a/drivers/net/phy/qt2025.rs b/drivers/net/phy/qt2025.rs index 1ab065798175..2f4ba85a0d73 100644 --- a/drivers/net/phy/qt2025.rs +++ b/drivers/net/phy/qt2025.rs @@ -9,7 +9,6 @@ //! //! The QT2025 PHY integrates an Intel 8051 micro-controller. -use kernel::c_str; use kernel::error::code; use kernel::firmware::Firmware; use kernel::net::phy::{ @@ -36,7 +35,7 @@ #[vtable] impl Driver for PhyQT2025 { - const NAME: &'static CStr = c_str!("QT2025 10Gpbs SFP+"); + const NAME: &'static CStr = c"QT2025 10Gpbs SFP+"; const PHY_DEVICE_ID: phy::DeviceId = phy::DeviceId::new_with_exact_mask(0x0043a400); fn probe(dev: &mut phy::Device) -> Result<()> { @@ -69,7 +68,7 @@ fn probe(dev: &mut phy::Device) -> Result<()> { // The micro-controller will start running from the boot ROM. dev.write(C45::new(Mmd::PCS, 0xe854), 0x00c0)?; - let fw = Firmware::request(c_str!("qt2025-2.0.3.3.fw"), dev.as_ref())?; + let fw = Firmware::request(c"qt2025-2.0.3.3.fw", dev.as_ref())?; if fw.data().len() > SZ_16K + SZ_8K { return Err(code::EFBIG); } diff --git a/rust/kernel/devres.rs b/rust/kernel/devres.rs index 942376f6f3af..68af33ca2f25 100644 --- a/rust/kernel/devres.rs +++ b/rust/kernel/devres.rs @@ -45,7 +45,7 @@ struct DevresInner { /// # Example /// /// ```no_run -/// # use kernel::{bindings, c_str, device::Device, devres::Devres, io::{Io, IoRaw}}; +/// # use kernel::{bindings, device::Device, devres::Devres, io::{Io, IoRaw}}; /// # use core::ops::Deref; /// /// // See also [`pci::Bar`] for a real example. diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs index e75db4d825ce..93e375e75ca0 100644 --- a/rust/kernel/firmware.rs +++ b/rust/kernel/firmware.rs @@ -40,13 +40,13 @@ fn request_nowarn() -> Self { /// # Examples /// /// ```no_run -/// # use kernel::{c_str, device::Device, firmware::Firmware}; +/// # use kernel::{device::Device, firmware::Firmware}; /// /// # fn no_run() -> Result<(), Error> { /// # // SAFETY: *NOT* safe, just for the example to get an `ARef` instance /// # let dev = unsafe { Device::get_device(core::ptr::null_mut()) }; /// -/// let fw = Firmware::request(c_str!("path/to/firmware.bin"), &dev)?; +/// let fw = Firmware::request(c"path/to/firmware.bin", &dev)?; /// let blob = fw.data(); /// /// # Ok(()) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 9f40ea744fc2..3d812edec057 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -56,10 +56,11 @@ macro_rules! kunit_assert { break 'out; } - static NAME: &'static $crate::str::CStr = $crate::c_str!($name); - static FILE: &'static $crate::str::CStr = $crate::c_str!($file); + static NAME: &'static $crate::str::CStr = $crate::c_str_avoid_literals!($name); + static FILE: &'static $crate::str::CStr = $crate::c_str_avoid_literals!($file); static LINE: i32 = core::line!() as i32 - $diff; - static CONDITION: &'static $crate::str::CStr = $crate::c_str!(stringify!($condition)); + static CONDITION: &'static $crate::str::CStr = + $crate::c_str_avoid_literals!(stringify!($condition)); // SAFETY: FFI call without safety requirements. let kunit_test = unsafe { $crate::bindings::kunit_get_current_test() }; diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs index c60205606aee..631a81e79a9f 100644 --- a/rust/kernel/net/phy.rs +++ b/rust/kernel/net/phy.rs @@ -780,7 +780,6 @@ const fn as_int(&self) -> u32 { /// /// ``` /// # mod module_phy_driver_sample { -/// use kernel::c_str; /// use kernel::net::phy::{self, DeviceId}; /// use kernel::prelude::*; /// @@ -799,7 +798,7 @@ const fn as_int(&self) -> u32 { /// /// #[vtable] /// impl phy::Driver for PhySample { -/// const NAME: &'static CStr = c_str!("PhySample"); +/// const NAME: &'static CStr = c"PhySample"; /// const PHY_DEVICE_ID: phy::DeviceId = phy::DeviceId::new_with_exact_mask(0x00000001); /// } /// # } @@ -808,7 +807,6 @@ const fn as_int(&self) -> u32 { /// This expands to the following code: /// /// ```ignore -/// use kernel::c_str; /// use kernel::net::phy::{self, DeviceId}; /// use kernel::prelude::*; /// @@ -828,7 +826,7 @@ const fn as_int(&self) -> u32 { /// /// #[vtable] /// impl phy::Driver for PhySample { -/// const NAME: &'static CStr = c_str!("PhySample"); +/// const NAME: &'static CStr = c"PhySample"; /// const PHY_DEVICE_ID: phy::DeviceId = phy::DeviceId::new_with_exact_mask(0x00000001); /// } /// diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs index d1752a978af4..f23a433b2273 100644 --- a/rust/kernel/platform.rs +++ b/rust/kernel/platform.rs @@ -120,7 +120,7 @@ macro_rules! module_platform_driver { /// # Example /// ///``` -/// # use kernel::{bindings, c_str, of, platform}; +/// # use kernel::{bindings, of, platform}; /// /// struct MyDriver; /// @@ -129,7 +129,7 @@ macro_rules! module_platform_driver { /// MODULE_OF_TABLE, /// ::IdInfo, /// [ -/// (of::DeviceId::new(c_str!("test,device")), ()) +/// (of::DeviceId::new(c"test,device"), ()) /// ] /// ); /// diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs index 0c4189a478b4..27911eaede27 100644 --- a/rust/kernel/str.rs +++ b/rust/kernel/str.rs @@ -261,14 +261,13 @@ pub trait CStrExt { /// # Examples /// /// ``` - /// # use kernel::c_str; /// # use kernel::fmt; /// # use kernel::str::CString; - /// let penguin = c_str!(" From patchwork Sun Feb 2 16:31:21 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tamir Duberstein X-Patchwork-Id: 13956543 Received: from mail-qk1-f171.google.com (mail-qk1-f171.google.com [209.85.222.171]) (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 4DA0738384; Sun, 2 Feb 2025 16:31:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738513899; cv=none; b=UOrqotrbsPK7uzfzfCAO5g1FAOvVZSbnI2Uyvumyp5eOTsVNy2J/Id/Puj7MmXpIYe8f+OK5gvqVvTUYYkg5sedDEFXowJxKBLygjSHD5mvgMWGrwzKusfO4q0dQ7CCqucD9PwgwnbrafhSv3kbsDF4hFSgtDxe1lMPdRpE/joo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738513899; c=relaxed/simple; bh=LTtoW8t7ruaMhWR49XFSPGXQJ0qL8M0PLPSll13Kse8=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=SLkHt2PjhzGoRGUF7tMAE/xZmS9lWAdgkJtpJsJ2YYGXiXRUfK0pxHvaWZe30aNeFSRAs7TVrsedpbr6krwQCvnn7PH150ITf/ykCvQpO4iBilCh3AnOJnhfTjxVcw/W9Kkex+LUrOHKgvvvmA+VAtNtjIzNpc2uFw8UXFwsTyI= 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=bAJ34RwF; arc=none smtp.client-ip=209.85.222.171 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="bAJ34RwF" Received: by mail-qk1-f171.google.com with SMTP id af79cd13be357-7b6f7d7e128so434212685a.1; Sun, 02 Feb 2025 08:31:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738513896; x=1739118696; 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=PsmImrWlafHaiAPIjGyqD/ERJHtpy0ANUP2YmLbPZhw=; b=bAJ34RwFn0L9Uv9rtD6P/PJOy4+1Q/UFvPV+rptmHu4hHazrdVZxL+ZKudrLNpeTXW +yvM+fPukYZGiufOGM8+/qAvU5iAIHWTfeiNnB+xXAu3h6EQHUoG7MGaV2iPOVPSp0Y5 cwIY4ZLqp0vl8auXyJA4mHlHjr/rqsgGfqTbSWqsx0iqkeO0IcBqBBU5pOacjfh7ccEl dGzGPPhTLAdZ1lBHK3erK/0Jbky8upy2qf+uSCEnMHQ4nyxg1lW+IAhS4cv7MQvEWQEo +S9ESaR0W/IZb2PITR4Hx30MeH6dRcVnk18LVwT1s8fuCrwkC1H4+8y+H/nIvd9FXHCq tN/w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738513896; x=1739118696; 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=PsmImrWlafHaiAPIjGyqD/ERJHtpy0ANUP2YmLbPZhw=; b=ZlLtBsmBhEprs55YClTpVcqTVRWXwfD9onkCX1SYn949OGmJMCOu/5++Z9Lug7I7AX +XM5c55iLU5UaIH97AKGaR7K3DQS4a+l2NgIEW+ynmqztaZFiRTBZ5+RL8MeziHnWzxB vQSSVQa10/M/dklcAuVZmBFrCyo4dMGZCTlR8KAW5lyOqszdmb90rIPhDW/qfRZuzrN0 JhjXVBTeKPIl93QDNWJQiNT0x/VWQM/iGxth0CQSf3eSdNgFOLUBTsFUbfuf5KadkXVF LhSqW/Z+WqslnoEoHYqAhJR3pf/80l9Un1kuZhLU7DEhKws6R4h56MSPHbXamnDOBZvL ZhMQ== X-Forwarded-Encrypted: i=1; AJvYcCUm3BBOZSecHNDOU0xReCkSLfYFsw9uvkG24qa7RPbxbuPXzcEwcEm8MwO3ygEzflkqwmVu7PTE0KpQJXk=@vger.kernel.org X-Gm-Message-State: AOJu0YxIMs0/ZvIpzniWagoxJvcSlkcq0gAL2dgdR33RCPUlzR/Q3EwB Kd5psvBnJJFaY/13c6B/NIig9PbgX2IjK4lzzuR6670H4avrY2VIJxu33Xbwayo= X-Gm-Gg: ASbGncusRMPNVqs5KXBIo8lW27QBYpzkbezaXsJJyGUdPBnpWxi2tAVAQh/Ysxvh56M wRzIX9p6PM1uCv2zlIK6BLePSy6XEXn3JBShdI2PM9Pm401EmzoO+2OvhGvR5tCYyJYOKRZ54cD ETVIWuYzt3LzNDBWqC638rFuMpWJTASSVyjkXfhJbCroMmtRjK2hSTWz6X3xjBpSQ8QH5XiHhAd 7TBFdlu3TBX90NVE9BzfJtuPtWSen34yztkgreoRhm5+bTJ+VBexxkDUwkphbTGHHwxc92KY5mN D99D6evZHtDzyHdSKAkMNl4SsuJkAiYn0y0Dbxc= X-Google-Smtp-Source: AGHT+IEfrl4Vvug7X259jX7mZnIveRxwNRAsJQ+fTMadD2aib3r062c5MP/DQ1trriRb0XjldnAGIA== X-Received: by 2002:a05:620a:24d1:b0:7a9:a356:a5dd with SMTP id af79cd13be357-7c0097b7d6bmr1959574585a.20.1738513895913; Sun, 02 Feb 2025 08:31:35 -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.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 02 Feb 2025 08:31:34 -0800 (PST) From: Tamir Duberstein Date: Sun, 02 Feb 2025 11:31:21 -0500 Subject: [PATCH v7 4/4] rust: remove core::ffi::CStr reexport 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-4-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 Clean up references to `kernel::str::CStr`. Signed-off-by: Tamir Duberstein --- rust/kernel/device.rs | 3 +-- rust/kernel/driver.rs | 4 ++-- rust/kernel/error.rs | 6 ++---- rust/kernel/firmware.rs | 3 ++- rust/kernel/kunit.rs | 6 +++--- rust/kernel/lib.rs | 2 +- rust/kernel/miscdevice.rs | 3 +-- rust/kernel/of.rs | 4 ++-- rust/kernel/pci.rs | 3 +-- rust/kernel/platform.rs | 3 +-- rust/kernel/prelude.rs | 5 +---- rust/kernel/str.rs | 19 +++++++++---------- rust/kernel/sync/condvar.rs | 2 +- rust/kernel/sync/lock.rs | 3 +-- rust/kernel/sync/lock/global.rs | 4 ++-- rust/kernel/sync/poll.rs | 1 + rust/kernel/workqueue.rs | 1 + rust/macros/module.rs | 2 +- 18 files changed, 33 insertions(+), 41 deletions(-) diff --git a/rust/kernel/device.rs b/rust/kernel/device.rs index 9554921368c0..7248bfcfe8f2 100644 --- a/rust/kernel/device.rs +++ b/rust/kernel/device.rs @@ -6,10 +6,9 @@ use crate::{ bindings, - str::CStr, types::{ARef, Opaque}, }; -use core::{fmt, ptr}; +use core::{ffi::CStr, fmt, ptr}; /// A reference-counted device. /// diff --git a/rust/kernel/driver.rs b/rust/kernel/driver.rs index 2a16d5e64e6c..0fbcdc226729 100644 --- a/rust/kernel/driver.rs +++ b/rust/kernel/driver.rs @@ -6,8 +6,8 @@ //! register using the [`Registration`] class. use crate::error::{Error, Result}; -use crate::{device, init::PinInit, of, str::CStr, try_pin_init, types::Opaque, ThisModule}; -use core::pin::Pin; +use crate::{device, init::PinInit, of, try_pin_init, types::Opaque, ThisModule}; +use core::{ffi::CStr, pin::Pin}; use macros::{pin_data, pinned_drop}; /// The [`RegistrationOps`] trait serves as generic interface for subsystems (e.g., PCI, Platform, diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs index 51c5e0f0a0bc..81972a8f695d 100644 --- a/rust/kernel/error.rs +++ b/rust/kernel/error.rs @@ -4,11 +4,9 @@ //! //! C header: [`include/uapi/asm-generic/errno-base.h`](srctree/include/uapi/asm-generic/errno-base.h) -use crate::{ - alloc::{layout::LayoutError, AllocError}, - str::CStr, -}; +use crate::alloc::{layout::LayoutError, AllocError}; +use core::ffi::CStr; use core::fmt; use core::num::NonZeroI32; use core::num::TryFromIntError; diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs index 93e375e75ca0..86ed79cef211 100644 --- a/rust/kernel/firmware.rs +++ b/rust/kernel/firmware.rs @@ -4,7 +4,8 @@ //! //! C header: [`include/linux/firmware.h`](srctree/include/linux/firmware.h) -use crate::{bindings, device::Device, error::Error, error::Result, str::CStr}; +use crate::{bindings, device::Device, error::Error, error::Result}; +use core::ffi::CStr; use core::ptr::NonNull; /// # Invariants diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 3d812edec057..f83988959257 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -56,10 +56,10 @@ macro_rules! kunit_assert { break 'out; } - static NAME: &'static $crate::str::CStr = $crate::c_str_avoid_literals!($name); - static FILE: &'static $crate::str::CStr = $crate::c_str_avoid_literals!($file); + static NAME: &'static core::ffi::CStr = $crate::c_str_avoid_literals!($name); + static FILE: &'static core::ffi::CStr = $crate::c_str_avoid_literals!($file); static LINE: i32 = core::line!() as i32 - $diff; - static CONDITION: &'static $crate::str::CStr = + static CONDITION: &'static core::ffi::CStr = $crate::c_str_avoid_literals!(stringify!($condition)); // SAFETY: FFI call without safety requirements. diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 496ed32b0911..a129ef3292dc 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -132,7 +132,7 @@ fn init(module: &'static ThisModule) -> impl init::PinInit { /// Metadata attached to a [`Module`] or [`InPlaceModule`]. pub trait ModuleMetadata { /// The name of the module as specified in the `module!` macro. - const NAME: &'static crate::str::CStr; + const NAME: &'static core::ffi::CStr; } /// Equivalent to `THIS_MODULE` in the C API. diff --git a/rust/kernel/miscdevice.rs b/rust/kernel/miscdevice.rs index 65f70ff61eb3..e8c272e24bd0 100644 --- a/rust/kernel/miscdevice.rs +++ b/rust/kernel/miscdevice.rs @@ -16,10 +16,9 @@ fs::File, prelude::*, seq_file::SeqFile, - str::CStr, types::{ForeignOwnable, Opaque}, }; -use core::{marker::PhantomData, mem::MaybeUninit, pin::Pin}; +use core::{ffi::CStr, marker::PhantomData, mem::MaybeUninit, pin::Pin}; /// Options for creating a misc device. #[derive(Copy, Clone)] diff --git a/rust/kernel/of.rs b/rust/kernel/of.rs index 12ea65df46de..04d8dc924147 100644 --- a/rust/kernel/of.rs +++ b/rust/kernel/of.rs @@ -2,7 +2,7 @@ //! Device Tree / Open Firmware abstractions. -use crate::{bindings, device_id::RawDeviceId, prelude::*}; +use crate::{bindings, device_id::RawDeviceId}; /// IdTable type for OF drivers. pub type IdTable = &'static dyn kernel::device_id::IdTable; @@ -28,7 +28,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 { + pub const fn new(compatible: &'static core::ffi::CStr) -> Self { 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. diff --git a/rust/kernel/pci.rs b/rust/kernel/pci.rs index af36ddac80ff..d248b966cab4 100644 --- a/rust/kernel/pci.rs +++ b/rust/kernel/pci.rs @@ -13,11 +13,10 @@ error::{to_result, Result}, io::Io, io::IoRaw, - str::CStr, types::{ARef, ForeignOwnable, Opaque}, ThisModule, }; -use core::{ops::Deref, ptr::addr_of_mut}; +use core::{ffi::CStr, ops::Deref, ptr::addr_of_mut}; use kernel::prelude::*; /// An adapter for the registration of PCI drivers. diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs index f23a433b2273..b8aabc229442 100644 --- a/rust/kernel/platform.rs +++ b/rust/kernel/platform.rs @@ -9,12 +9,11 @@ error::{to_result, Result}, of, prelude::*, - str::CStr, types::{ARef, ForeignOwnable, Opaque}, ThisModule, }; -use core::ptr::addr_of_mut; +use core::{ffi::CStr, ptr::addr_of_mut}; /// An adapter for the registration of platform drivers. pub struct Adapter(T); diff --git a/rust/kernel/prelude.rs b/rust/kernel/prelude.rs index 96e7029c27da..21fa7b3a68c3 100644 --- a/rust/kernel/prelude.rs +++ b/rust/kernel/prelude.rs @@ -34,10 +34,7 @@ pub use super::error::{code::*, Error, Result}; -pub use super::{ - str::{CStr, CStrExt as _}, - ThisModule, -}; +pub use super::{str::CStrExt as _, ThisModule}; pub use super::init::{InPlaceInit, InPlaceWrite, Init, PinInit}; diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs index 27911eaede27..a68acb54f0c8 100644 --- a/rust/kernel/str.rs +++ b/rust/kernel/str.rs @@ -3,6 +3,7 @@ //! String representations. use crate::alloc::{flags::*, AllocError, KVec}; +use core::ffi::CStr; use core::fmt::{self, Write}; use core::ops::{Deref, DerefMut}; @@ -177,8 +178,6 @@ macro_rules! b_str { }}; } -pub use core::ffi::CStr; - /// Wraps a raw C string with a safe C string wrapper. /// /// # Safety @@ -338,7 +337,7 @@ fn display(&self) -> Display<'_> { /// /// ``` /// # use kernel::c_str_avoid_literals; -/// # use kernel::str::CStr; +/// # use core::ffi::CStr; /// const MY_CSTR: &CStr = c_str_avoid_literals!(concat!(file!(), ":", line!(), ": My CStr!")); /// ``` #[macro_export] @@ -348,13 +347,13 @@ macro_rules! c_str_avoid_literals { // too limiting to macro authors, so we rely on the name as a hint instead. ($str:expr) => {{ const S: &'static str = concat!($str, "\0"); - const C: &'static $crate::str::CStr = - match $crate::str::CStr::from_bytes_with_nul(S.as_bytes()) { - Ok(v) => v, - Err(core::ffi::FromBytesWithNulError { .. }) => { - panic!("string contains interior NUL") - } - }; + const C: &'static core::ffi::CStr = match core::ffi::CStr::from_bytes_with_nul(S.as_bytes()) + { + Ok(v) => v, + Err(core::ffi::FromBytesWithNulError { .. }) => { + panic!("string contains interior NUL") + } + }; C }}; } diff --git a/rust/kernel/sync/condvar.rs b/rust/kernel/sync/condvar.rs index 7bf3df980433..3b82acdcd56c 100644 --- a/rust/kernel/sync/condvar.rs +++ b/rust/kernel/sync/condvar.rs @@ -10,11 +10,11 @@ ffi::{c_int, c_long}, init::PinInit, pin_init, - str::CStr, task::{MAX_SCHEDULE_TIMEOUT, TASK_INTERRUPTIBLE, TASK_NORMAL, TASK_UNINTERRUPTIBLE}, time::Jiffies, types::Opaque, }; +use core::ffi::CStr; use core::marker::PhantomPinned; use core::ptr; use macros::pin_data; diff --git a/rust/kernel/sync/lock.rs b/rust/kernel/sync/lock.rs index 5ad62d718279..7951c0ca60cb 100644 --- a/rust/kernel/sync/lock.rs +++ b/rust/kernel/sync/lock.rs @@ -9,10 +9,9 @@ use crate::{ init::PinInit, pin_init, - str::CStr, types::{NotThreadSafe, Opaque, ScopeGuard}, }; -use core::{cell::UnsafeCell, marker::PhantomPinned}; +use core::{cell::UnsafeCell, ffi::CStr, marker::PhantomPinned}; use macros::pin_data; pub mod mutex; diff --git a/rust/kernel/sync/lock/global.rs b/rust/kernel/sync/lock/global.rs index 732dde45024b..ee438654eb6c 100644 --- a/rust/kernel/sync/lock/global.rs +++ b/rust/kernel/sync/lock/global.rs @@ -5,13 +5,13 @@ //! Support for defining statics containing locks. use crate::{ - str::CStr, sync::lock::{Backend, Guard, Lock}, sync::{LockClassKey, LockedBy}, types::Opaque, }; use core::{ cell::UnsafeCell, + ffi::CStr, marker::{PhantomData, PhantomPinned}, }; @@ -266,7 +266,7 @@ macro_rules! global_lock { $pub enum $name {} impl $crate::sync::lock::GlobalLockBackend for $name { - const NAME: &'static $crate::str::CStr = + const NAME: &'static core::ffi::CStr = $crate::c_str_avoid_literals!(::core::stringify!($name)); type Item = $valuety; type Backend = $crate::global_lock_inner!(backend $kind); diff --git a/rust/kernel/sync/poll.rs b/rust/kernel/sync/poll.rs index d5f17153b424..3349f48725f2 100644 --- a/rust/kernel/sync/poll.rs +++ b/rust/kernel/sync/poll.rs @@ -11,6 +11,7 @@ sync::{CondVar, LockClassKey}, types::Opaque, }; +use core::ffi::CStr; use core::ops::Deref; /// Creates a [`PollCondVar`] initialiser with the given name and a newly-created lock class. diff --git a/rust/kernel/workqueue.rs b/rust/kernel/workqueue.rs index 1008dd2635e1..69f419bdb0e7 100644 --- a/rust/kernel/workqueue.rs +++ b/rust/kernel/workqueue.rs @@ -135,6 +135,7 @@ use crate::alloc::{AllocError, Flags}; use crate::{prelude::*, sync::Arc, sync::LockClassKey, types::Opaque}; +use core::ffi::CStr; use core::marker::PhantomData; /// Creates a [`Work`] initialiser with the given name and a newly-created lock class. diff --git a/rust/macros/module.rs b/rust/macros/module.rs index a534fabd29d6..7f81cbbcc4ef 100644 --- a/rust/macros/module.rs +++ b/rust/macros/module.rs @@ -229,7 +229,7 @@ pub(crate) fn module(ts: TokenStream) -> TokenStream { }}; impl kernel::ModuleMetadata for {type_} {{ - const NAME: &'static kernel::str::CStr = c\"{name}\"; + const NAME: &'static core::ffi::CStr = c\"{name}\"; }} // Double nested modules, since then nobody can access the public items inside.