Skip to content

Commit b3d161f

Browse files
nbdd0121ojeda
authored andcommitted
rust: disallow use of CStr::as_ptr and CStr::from_ptr
As kernel always use unsigned char and not the platform ABI's default, an user should always use `as_char_ptr` provided via `CStrExt` instead. Therefore configure `disallow-methods` feature of clippy to catch incorrect usage. Similarly, the dual `from_ptr` is also disallowed. [ As an example, without the previous commit, we would get a warning like: warning: use of a disallowed method `core::ffi::CStr::as_ptr` --> rust/kernel/task.rs:422:54 | 422 | unsafe { crate::bindings::__might_sleep(file.as_ptr().cast(), loc.line() as i32) } | ^^^^^^ help: kernel's `char` is always unsigned, use `as_char_ptr` instead: `kernel::prelude::CStrExt::as_char_ptr` | = help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.94.0/index.html#disallowed_methods = note: `-W clippy::disallowed-methods` implied by `-W clippy::all` = help: to override `-W clippy::all` add `#[allow(clippy::disallowed_methods)]` - Miguel ] Signed-off-by: Gary Guo <gary@garyguo.net> Reviewed-by: Tamir Duberstein <tamird@kernel.org> Link: https://patch.msgid.link/20260203130745.868762-2-gary@kernel.org Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent 1a93371 commit b3d161f

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

.clippy.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,13 @@ disallowed-macros = [
99
# it here, see: https://github.com/rust-lang/rust-clippy/issues/11303.
1010
{ path = "kernel::dbg", reason = "the `dbg!` macro is intended as a debugging tool", allow-invalid = true },
1111
]
12+
13+
[[disallowed-methods]]
14+
path = "core::ffi::CStr::as_ptr"
15+
replacement = "kernel::prelude::CStrExt::as_char_ptr"
16+
reason = "kernel's `char` is always unsigned, use `as_char_ptr` instead"
17+
18+
[[disallowed-methods]]
19+
path = "core::ffi::CStr::from_ptr"
20+
replacement = "kernel::prelude::CStrExt::from_char_ptr"
21+
reason = "kernel's `char` is always unsigned, use `from_char_ptr` instead"

rust/kernel/str.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ macro_rules! b_str {
189189
//
190190
// - error[E0379]: functions in trait impls cannot be declared const
191191
#[inline]
192+
#[expect(clippy::disallowed_methods, reason = "internal implementation")]
192193
pub const fn as_char_ptr_in_const_context(c_str: &CStr) -> *const c_char {
193194
c_str.as_ptr().cast()
194195
}
@@ -319,6 +320,7 @@ unsafe fn to_bytes_mut(s: &mut CStr) -> &mut [u8] {
319320

320321
impl CStrExt for CStr {
321322
#[inline]
323+
#[expect(clippy::disallowed_methods, reason = "internal implementation")]
322324
unsafe fn from_char_ptr<'a>(ptr: *const c_char) -> &'a Self {
323325
// SAFETY: The safety preconditions are the same as for `CStr::from_ptr`.
324326
unsafe { CStr::from_ptr(ptr.cast()) }
@@ -334,6 +336,7 @@ impl CStrExt for CStr {
334336
}
335337

336338
#[inline]
339+
#[expect(clippy::disallowed_methods, reason = "internal implementation")]
337340
fn as_char_ptr(&self) -> *const c_char {
338341
self.as_ptr().cast()
339342
}

0 commit comments

Comments
 (0)