2023-04-03 09:33:53 +00:00
|
|
|
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
|
|
2024-01-31 20:23:30 +00:00
|
|
|
//! `ioctl()` number definitions.
|
2023-04-03 09:33:53 +00:00
|
|
|
//!
|
2023-12-15 23:54:28 +00:00
|
|
|
//! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h)
|
2023-04-03 09:33:53 +00:00
|
|
|
|
rust: start using the `#[expect(...)]` attribute
In Rust, it is possible to `allow` particular warnings (diagnostics,
lints) locally, making the compiler ignore instances of a given warning
within a given function, module, block, etc.
It is similar to `#pragma GCC diagnostic push` + `ignored` + `pop` in C:
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-function"
static void f(void) {}
#pragma GCC diagnostic pop
But way less verbose:
#[allow(dead_code)]
fn f() {}
By that virtue, it makes it possible to comfortably enable more
diagnostics by default (i.e. outside `W=` levels) that may have some
false positives but that are otherwise quite useful to keep enabled to
catch potential mistakes.
The `#[expect(...)]` attribute [1] takes this further, and makes the
compiler warn if the diagnostic was _not_ produced. For instance, the
following will ensure that, when `f()` is called somewhere, we will have
to remove the attribute:
#[expect(dead_code)]
fn f() {}
If we do not, we get a warning from the compiler:
warning: this lint expectation is unfulfilled
--> x.rs:3:10
|
3 | #[expect(dead_code)]
| ^^^^^^^^^
|
= note: `#[warn(unfulfilled_lint_expectations)]` on by default
This means that `expect`s do not get forgotten when they are not needed.
See the next commit for more details, nuances on its usage and
documentation on the feature.
The attribute requires the `lint_reasons` [2] unstable feature, but it
is becoming stable in 1.81.0 (to be released on 2024-09-05) and it has
already been useful to clean things up in this patch series, finding
cases where the `allow`s should not have been there.
Thus, enable `lint_reasons` and convert some of our `allow`s to `expect`s
where possible.
This feature was also an example of the ongoing collaboration between
Rust and the kernel -- we tested it in the kernel early on and found an
issue that was quickly resolved [3].
Cc: Fridtjof Stoldt <xfrednet@gmail.com>
Cc: Urgau <urgau@numericable.fr>
Link: https://rust-lang.github.io/rfcs/2383-lint-reasons.html#expect-lint-attribute [1]
Link: https://github.com/rust-lang/rust/issues/54503 [2]
Link: https://github.com/rust-lang/rust/issues/114557 [3]
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Trevor Gross <tmgross@umich.edu>
Tested-by: Gary Guo <gary@garyguo.net>
Reviewed-by: Gary Guo <gary@garyguo.net>
Link: https://lore.kernel.org/r/20240904204347.168520-18-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
2024-09-04 20:43:45 +00:00
|
|
|
#![expect(non_snake_case)]
|
2023-04-03 09:33:53 +00:00
|
|
|
|
|
|
|
|
use crate::build_assert;
|
|
|
|
|
|
|
|
|
|
/// Build an ioctl number, analogous to the C macro of the same name.
|
|
|
|
|
#[inline(always)]
|
|
|
|
|
const fn _IOC(dir: u32, ty: u32, nr: u32, size: usize) -> u32 {
|
|
|
|
|
build_assert!(dir <= uapi::_IOC_DIRMASK);
|
|
|
|
|
build_assert!(ty <= uapi::_IOC_TYPEMASK);
|
|
|
|
|
build_assert!(nr <= uapi::_IOC_NRMASK);
|
|
|
|
|
build_assert!(size <= (uapi::_IOC_SIZEMASK as usize));
|
|
|
|
|
|
|
|
|
|
(dir << uapi::_IOC_DIRSHIFT)
|
|
|
|
|
| (ty << uapi::_IOC_TYPESHIFT)
|
|
|
|
|
| (nr << uapi::_IOC_NRSHIFT)
|
|
|
|
|
| ((size as u32) << uapi::_IOC_SIZESHIFT)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Build an ioctl number for an argumentless ioctl.
|
|
|
|
|
#[inline(always)]
|
|
|
|
|
pub const fn _IO(ty: u32, nr: u32) -> u32 {
|
|
|
|
|
_IOC(uapi::_IOC_NONE, ty, nr, 0)
|
|
|
|
|
}
|
|
|
|
|
|
2024-01-31 20:23:23 +00:00
|
|
|
/// Build an ioctl number for a read-only ioctl.
|
2023-04-03 09:33:53 +00:00
|
|
|
#[inline(always)]
|
|
|
|
|
pub const fn _IOR<T>(ty: u32, nr: u32) -> u32 {
|
|
|
|
|
_IOC(uapi::_IOC_READ, ty, nr, core::mem::size_of::<T>())
|
|
|
|
|
}
|
|
|
|
|
|
2024-01-31 20:23:23 +00:00
|
|
|
/// Build an ioctl number for a write-only ioctl.
|
2023-04-03 09:33:53 +00:00
|
|
|
#[inline(always)]
|
|
|
|
|
pub const fn _IOW<T>(ty: u32, nr: u32) -> u32 {
|
|
|
|
|
_IOC(uapi::_IOC_WRITE, ty, nr, core::mem::size_of::<T>())
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Build an ioctl number for a read-write ioctl.
|
|
|
|
|
#[inline(always)]
|
|
|
|
|
pub const fn _IOWR<T>(ty: u32, nr: u32) -> u32 {
|
|
|
|
|
_IOC(
|
|
|
|
|
uapi::_IOC_READ | uapi::_IOC_WRITE,
|
|
|
|
|
ty,
|
|
|
|
|
nr,
|
|
|
|
|
core::mem::size_of::<T>(),
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Get the ioctl direction from an ioctl number.
|
|
|
|
|
pub const fn _IOC_DIR(nr: u32) -> u32 {
|
|
|
|
|
(nr >> uapi::_IOC_DIRSHIFT) & uapi::_IOC_DIRMASK
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Get the ioctl type from an ioctl number.
|
|
|
|
|
pub const fn _IOC_TYPE(nr: u32) -> u32 {
|
|
|
|
|
(nr >> uapi::_IOC_TYPESHIFT) & uapi::_IOC_TYPEMASK
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Get the ioctl number from an ioctl number.
|
|
|
|
|
pub const fn _IOC_NR(nr: u32) -> u32 {
|
|
|
|
|
(nr >> uapi::_IOC_NRSHIFT) & uapi::_IOC_NRMASK
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Get the ioctl size from an ioctl number.
|
|
|
|
|
pub const fn _IOC_SIZE(nr: u32) -> usize {
|
|
|
|
|
((nr >> uapi::_IOC_SIZESHIFT) & uapi::_IOC_SIZEMASK) as usize
|
|
|
|
|
}
|