rust/kernel/error.rs

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 //! Kernel errors.
   4 //!
   5 //! C header: [`include/uapi/asm-generic/errno-base.h`](srctree/include/uapi/asm-generic/errno-base.h)
   6
   7 use crate::{alloc::AllocError, str::CStr};
   8
   9 use alloc::alloc::LayoutError;
  10
  11 use core::fmt;
  12 use core::num::TryFromIntError;
  13 use core::str::Utf8Error;
  14
  15 /// Contains the C-compatible error codes.
  16 #[rustfmt::skip]
  17 pub mod code {
  18     macro_rules! declare_err {
  19         ($err:tt $(,)? $($doc:expr),+) => {
  20             $(
  21             #[doc = $doc]
  22             )*
  23             pub const $err: super::Error = super::Error(-(crate::bindings::$err as i32));
  24         };
  25     }
  26
  27     declare_err!(EPERM, "Operation not permitted.");
  28     declare_err!(ENOENT, "No such file or directory.");
  29     declare_err!(ESRCH, "No such process.");
  30     declare_err!(EINTR, "Interrupted system call.");
  31     declare_err!(EIO, "I/O error.");
  32     declare_err!(ENXIO, "No such device or address.");
  33     declare_err!(E2BIG, "Argument list too long.");
  34     declare_err!(ENOEXEC, "Exec format error.");
  35     declare_err!(EBADF, "Bad file number.");
  36     declare_err!(ECHILD, "No child processes.");
  37     declare_err!(EAGAIN, "Try again.");
  38     declare_err!(ENOMEM, "Out of memory.");
  39     declare_err!(EACCES, "Permission denied.");
  40     declare_err!(EFAULT, "Bad address.");
  41     declare_err!(ENOTBLK, "Block device required.");
  42     declare_err!(EBUSY, "Device or resource busy.");
  43     declare_err!(EEXIST, "File exists.");
  44     declare_err!(EXDEV, "Cross-device link.");
  45     declare_err!(ENODEV, "No such device.");
  46     declare_err!(ENOTDIR, "Not a directory.");
  47     declare_err!(EISDIR, "Is a directory.");
  48     declare_err!(EINVAL, "Invalid argument.");
  49     declare_err!(ENFILE, "File table overflow.");
  50     declare_err!(EMFILE, "Too many open files.");
  51     declare_err!(ENOTTY, "Not a typewriter.");
  52     declare_err!(ETXTBSY, "Text file busy.");
  53     declare_err!(EFBIG, "File too large.");
  54     declare_err!(ENOSPC, "No space left on device.");
  55     declare_err!(ESPIPE, "Illegal seek.");
  56     declare_err!(EROFS, "Read-only file system.");
  57     declare_err!(EMLINK, "Too many links.");
  58     declare_err!(EPIPE, "Broken pipe.");
  59     declare_err!(EDOM, "Math argument out of domain of func.");
  60     declare_err!(ERANGE, "Math result not representable.");
  61     declare_err!(ERESTARTSYS, "Restart the system call.");
  62     declare_err!(ERESTARTNOINTR, "System call was interrupted by a signal and will be restarted.");
  63     declare_err!(ERESTARTNOHAND, "Restart if no handler.");
  64     declare_err!(ENOIOCTLCMD, "No ioctl command.");
  65     declare_err!(ERESTART_RESTARTBLOCK, "Restart by calling sys_restart_syscall.");
  66     declare_err!(EPROBE_DEFER, "Driver requests probe retry.");
  67     declare_err!(EOPENSTALE, "Open found a stale dentry.");
  68     declare_err!(ENOPARAM, "Parameter not supported.");
  69     declare_err!(EBADHANDLE, "Illegal NFS file handle.");
  70     declare_err!(ENOTSYNC, "Update synchronization mismatch.");
  71     declare_err!(EBADCOOKIE, "Cookie is stale.");
  72     declare_err!(ENOTSUPP, "Operation is not supported.");
  73     declare_err!(ETOOSMALL, "Buffer or request is too small.");
  74     declare_err!(ESERVERFAULT, "An untranslatable error occurred.");
  75     declare_err!(EBADTYPE, "Type not supported by server.");
  76     declare_err!(EJUKEBOX, "Request initiated, but will not complete before timeout.");
  77     declare_err!(EIOCBQUEUED, "iocb queued, will get completion event.");
  78     declare_err!(ERECALLCONFLICT, "Conflict with recalled state.");
  79     declare_err!(ENOGRACE, "NFS file lock reclaim refused.");
  80 }
  81
  82 /// Generic integer kernel error.
  83 ///
  84 /// The kernel defines a set of integer generic error codes based on C and
  85 /// POSIX ones. These codes may have a more specific meaning in some contexts.
  86 ///
  87 /// # Invariants
  88 ///
  89 /// The value is a valid `errno` (i.e. `>= -MAX_ERRNO && < 0`).
  90 #[derive(Clone, Copy, PartialEq, Eq)]
  91 pub struct Error(core::ffi::c_int);
  92
  93 impl Error {
  94     /// Creates an [`Error`] from a kernel error code.
  95     ///
  96     /// It is a bug to pass an out-of-range `errno`. `EINVAL` would
  97     /// be returned in such a case.
  98     pub(crate) fn from_errno(errno: core::ffi::c_int) -> Error {
  99         if errno < -(bindings::MAX_ERRNO as i32) || errno >= 0 {
 100             // TODO: Make it a `WARN_ONCE` once available.
 101             crate::pr_warn!(
 102                 "attempted to create `Error` with out of range `errno`: {}",
 103                 errno
 104             );
 105             return code::EINVAL;
 106         }
 107
 108         // INVARIANT: The check above ensures the type invariant
 109         // will hold.
 110         Error(errno)
 111     }
 112
 113     /// Creates an [`Error`] from a kernel error code.
 114     ///
 115     /// # Safety
 116     ///
 117     /// `errno` must be within error code range (i.e. `>= -MAX_ERRNO && < 0`).
 118     unsafe fn from_errno_unchecked(errno: core::ffi::c_int) -> Error {
 119         // INVARIANT: The contract ensures the type invariant
 120         // will hold.
 121         Error(errno)
 122     }
 123
 124     /// Returns the kernel error code.
 125     pub fn to_errno(self) -> core::ffi::c_int {
 126         self.0
 127     }
 128
 129     /// Returns the error encoded as a pointer.
 130     #[allow(dead_code)]
 131     pub(crate) fn to_ptr<T>(self) -> *mut T {
 132         // SAFETY: `self.0` is a valid error due to its invariant.
 133         unsafe { bindings::ERR_PTR(self.0.into()) as *mut _ }
 134     }
 135
 136     /// Returns a string representing the error, if one exists.
 137     #[cfg(not(testlib))]
 138     pub fn name(&self) -> Option<&'static CStr> {
 139         // SAFETY: Just an FFI call, there are no extra safety requirements.
 140         let ptr = unsafe { bindings::errname(-self.0) };
 141         if ptr.is_null() {
 142             None
 143         } else {
 144             // SAFETY: The string returned by `errname` is static and `NUL`-terminated.
 145             Some(unsafe { CStr::from_char_ptr(ptr) })
 146         }
 147     }
 148
 149     /// Returns a string representing the error, if one exists.
 150     ///
 151     /// When `testlib` is configured, this always returns `None` to avoid the dependency on a
 152     /// kernel function so that tests that use this (e.g., by calling [`Result::unwrap`]) can still
 153     /// run in userspace.
 154     #[cfg(testlib)]
 155     pub fn name(&self) -> Option<&'static CStr> {
 156         None
 157     }
 158 }
 159
 160 impl fmt::Debug for Error {
 161     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 162         match self.name() {
 163             // Print out number if no name can be found.
 164             None => f.debug_tuple("Error").field(&-self.0).finish(),
 165             // SAFETY: These strings are ASCII-only.
 166             Some(name) => f
 167                 .debug_tuple(unsafe { core::str::from_utf8_unchecked(name) })
 168                 .finish(),
 169         }
 170     }
 171 }
 172
 173 impl From<AllocError> for Error {
 174     fn from(_: AllocError) -> Error {
 175         code::ENOMEM
 176     }
 177 }
 178
 179 impl From<TryFromIntError> for Error {
 180     fn from(_: TryFromIntError) -> Error {
 181         code::EINVAL
 182     }
 183 }
 184
 185 impl From<Utf8Error> for Error {
 186     fn from(_: Utf8Error) -> Error {
 187         code::EINVAL
 188     }
 189 }
 190
 191 impl From<LayoutError> for Error {
 192     fn from(_: LayoutError) -> Error {
 193         code::ENOMEM
 194     }
 195 }
 196
 197 impl From<core::fmt::Error> for Error {
 198     fn from(_: core::fmt::Error) -> Error {
 199         code::EINVAL
 200     }
 201 }
 202
 203 impl From<core::convert::Infallible> for Error {
 204     fn from(e: core::convert::Infallible) -> Error {
 205         match e {}
 206     }
 207 }
 208
 209 /// A [`Result`] with an [`Error`] error type.
 210 ///
 211 /// To be used as the return type for functions that may fail.
 212 ///
 213 /// # Error codes in C and Rust
 214 ///
 215 /// In C, it is common that functions indicate success or failure through
 216 /// their return value; modifying or returning extra data through non-`const`
 217 /// pointer parameters. In particular, in the kernel, functions that may fail
 218 /// typically return an `int` that represents a generic error code. We model
 219 /// those as [`Error`].
 220 ///
 221 /// In Rust, it is idiomatic to model functions that may fail as returning
 222 /// a [`Result`]. Since in the kernel many functions return an error code,
 223 /// [`Result`] is a type alias for a [`core::result::Result`] that uses
 224 /// [`Error`] as its error type.
 225 ///
 226 /// Note that even if a function does not return anything when it succeeds,
 227 /// it should still be modeled as returning a `Result` rather than
 228 /// just an [`Error`].
 229 pub type Result<T = (), E = Error> = core::result::Result<T, E>;
 230
 231 /// Converts an integer as returned by a C kernel function to an error if it's negative, and
 232 /// `Ok(())` otherwise.
 233 pub fn to_result(err: core::ffi::c_int) -> Result {
 234     if err < 0 {
 235         Err(Error::from_errno(err))
 236     } else {
 237         Ok(())
 238     }
 239 }
 240
 241 /// Transform a kernel "error pointer" to a normal pointer.
 242 ///
 243 /// Some kernel C API functions return an "error pointer" which optionally
 244 /// embeds an `errno`. Callers are supposed to check the returned pointer
 245 /// for errors. This function performs the check and converts the "error pointer"
 246 /// to a normal pointer in an idiomatic fashion.
 247 ///
 248 /// # Examples
 249 ///
 250 /// ```ignore
 251 /// # use kernel::from_err_ptr;
 252 /// # use kernel::bindings;
 253 /// fn devm_platform_ioremap_resource(
 254 ///     pdev: &mut PlatformDevice,
 255 ///     index: u32,
 256 /// ) -> Result<*mut core::ffi::c_void> {
 257 ///     // SAFETY: `pdev` points to a valid platform device. There are no safety requirements
 258 ///     // on `index`.
 259 ///     from_err_ptr(unsafe { bindings::devm_platform_ioremap_resource(pdev.to_ptr(), index) })
 260 /// }
 261 /// ```
 262 // TODO: Remove `dead_code` marker once an in-kernel client is available.
 263 #[allow(dead_code)]
 264 pub(crate) fn from_err_ptr<T>(ptr: *mut T) -> Result<*mut T> {
 265     // CAST: Casting a pointer to `*const core::ffi::c_void` is always valid.
 266     let const_ptr: *const core::ffi::c_void = ptr.cast();
 267     // SAFETY: The FFI function does not deref the pointer.
 268     if unsafe { bindings::IS_ERR(const_ptr) } {
 269         // SAFETY: The FFI function does not deref the pointer.
 270         let err = unsafe { bindings::PTR_ERR(const_ptr) };
 271         // CAST: If `IS_ERR()` returns `true`,
 272         // then `PTR_ERR()` is guaranteed to return a
 273         // negative value greater-or-equal to `-bindings::MAX_ERRNO`,
 274         // which always fits in an `i16`, as per the invariant above.
 275         // And an `i16` always fits in an `i32`. So casting `err` to
 276         // an `i32` can never overflow, and is always valid.
 277         //
 278         // SAFETY: `IS_ERR()` ensures `err` is a
 279         // negative value greater-or-equal to `-bindings::MAX_ERRNO`.
 280         #[allow(clippy::unnecessary_cast)]
 281         return Err(unsafe { Error::from_errno_unchecked(err as core::ffi::c_int) });
 282     }
 283     Ok(ptr)
 284 }
 285
 286 /// Calls a closure returning a [`crate::error::Result<T>`] and converts the result to
 287 /// a C integer result.
 288 ///
 289 /// This is useful when calling Rust functions that return [`crate::error::Result<T>`]
 290 /// from inside `extern "C"` functions that need to return an integer error result.
 291 ///
 292 /// `T` should be convertible from an `i16` via `From<i16>`.
 293 ///
 294 /// # Examples
 295 ///
 296 /// ```ignore
 297 /// # use kernel::from_result;
 298 /// # use kernel::bindings;
 299 /// unsafe extern "C" fn probe_callback(
 300 ///     pdev: *mut bindings::platform_device,
 301 /// ) -> core::ffi::c_int {
 302 ///     from_result(|| {
 303 ///         let ptr = devm_alloc(pdev)?;
 304 ///         bindings::platform_set_drvdata(pdev, ptr);
 305 ///         Ok(0)
 306 ///     })
 307 /// }
 308 /// ```
 309 // TODO: Remove `dead_code` marker once an in-kernel client is available.
 310 #[allow(dead_code)]
 311 pub(crate) fn from_result<T, F>(f: F) -> T
 312 where
 313     T: From<i16>,
 314     F: FnOnce() -> Result<T>,
 315 {
 316     match f() {
 317         Ok(v) => v,
 318         // NO-OVERFLOW: negative `errno`s are no smaller than `-bindings::MAX_ERRNO`,
 319         // `-bindings::MAX_ERRNO` fits in an `i16` as per invariant above,
 320         // therefore a negative `errno` always fits in an `i16` and will not overflow.
 321         Err(e) => T::from(e.to_errno() as i16),
 322     }
 323 }
 324
 325 /// Error message for calling a default function of a [`#[vtable]`](macros::vtable) trait.
 326 pub const VTABLE_DEFAULT_ERROR: &str =
 327     "This function must not be called, see the #[vtable] documentation.";