Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The patch adds core::num::NonZeroI16 as Error inner type. #857

Open
wants to merge 1 commit into
base: rust
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions rust/kernel/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use alloc::{
};
use core::convert::From;
use core::fmt;
use core::num::TryFromIntError;
use core::num::{NonZeroI16, TryFromIntError};
use core::str::{self, Utf8Error};

/// Contains the C-compatible error codes.
Expand All @@ -22,7 +22,7 @@ pub mod code {
$(
#[doc = $doc]
)*
pub const $err: super::Error = super::Error(-(crate::bindings::$err as i32));
pub const $err: super::Error = super::Error(unsafe { super::NonZeroI16::new_unchecked(-(crate::bindings::$err as i16)) });
};
}

Expand Down Expand Up @@ -317,7 +317,7 @@ pub mod code {
///
/// The value is a valid `errno` (i.e. `>= -MAX_ERRNO && < 0`).
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Error(core::ffi::c_int);
pub struct Error(NonZeroI16);

impl Error {
/// Creates an [`Error`] from a kernel error code.
Expand All @@ -336,7 +336,7 @@ impl Error {

// INVARIANT: The check above ensures the type invariant
// will hold.
Error(errno)
Error(unsafe { NonZeroI16::new_unchecked(errno as i16) })
}

/// Creates an [`Error`] from a kernel error code.
Expand All @@ -347,19 +347,19 @@ impl Error {
pub(crate) unsafe fn from_kernel_errno_unchecked(errno: core::ffi::c_int) -> Error {
// INVARIANT: The contract ensures the type invariant
// will hold.
Error(errno)
Error(unsafe { NonZeroI16::new_unchecked(errno as i16) })
}

/// Returns the kernel error code.
pub fn to_kernel_errno(self) -> core::ffi::c_int {
self.0
self.0.get() as i32
}

/// Returns a string representing the error, if one exists.
#[cfg(not(testlib))]
pub fn name(&self) -> Option<&'static CStr> {
// SAFETY: Just an FFI call, there are no extra safety requirements.
let ptr = unsafe { bindings::errname(-self.0) };
let ptr = unsafe { bindings::errname(-(self.0.get() as i32)) };
if ptr.is_null() {
None
} else {
Expand All @@ -383,7 +383,10 @@ impl fmt::Debug for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.name() {
// Print out number if no name can be found.
None => f.debug_tuple("Error").field(&-self.0).finish(),
None => f
.debug_tuple("Error")
.field(&-(self.0.get() as i32))
.finish(),
// SAFETY: These strings are ASCII-only.
Some(name) => f
.debug_tuple(unsafe { str::from_utf8_unchecked(name) })
Expand Down