Enum kernel::syscall::SyscallReturn

pub enum SyscallReturn {
    Failure(ErrorCode),
    FailureU32(ErrorCode, u32),
    FailureU32U32(ErrorCode, u32, u32),
    FailureU64(ErrorCode, u64),
    Success,
    SuccessU32(u32),
    SuccessU32U32(u32, u32),
    SuccessU32U32U32(u32, u32, u32),
    SuccessU64(u64),
    SuccessU32U64(u32, u64),
    SuccessAddr(usize),
    SuccessPtr(CapabilityPtr),
    AllowReadWriteSuccess(*mut u8, usize),
    AllowReadWriteFailure(ErrorCode, *mut u8, usize),
    UserspaceReadableAllowSuccess(*mut u8, usize),
    UserspaceReadableAllowFailure(ErrorCode, *mut u8, usize),
    AllowReadOnlySuccess(*const u8, usize),
    AllowReadOnlyFailure(ErrorCode, *const u8, usize),
    SubscribeSuccess(*const (), usize),
    SubscribeFailure(ErrorCode, *const (), usize),
    YieldWaitFor(usize, usize, usize),
}

Enumeration of the possible system call return variants.

This struct operates over primitive types such as integers of fixed length and pointers. It is constructed by the scheduler and passed down to the architecture to be encoded into registers. Architectures may use the various helper functions defined in utilities::arch_helpers.

Capsules do not use this struct. Capsules use higher level Rust types (e.g. ReadWriteProcessBuffer and GrantKernelData) or wrappers around this struct (CommandReturn) which limit the available constructors to safely constructable variants.

Variants

Failure(ErrorCode)

Generic error case

FailureU32(ErrorCode, u32)

Generic error case, with an additional 32-bit data field

FailureU32U32(ErrorCode, u32, u32)

Generic error case, with two additional 32-bit data fields

FailureU64(ErrorCode, u64)

Generic error case, with an additional 64-bit data field

Success

Generic success case

SuccessU32(u32)

Generic success case, with an additional 32-bit data field

SuccessU32U32(u32, u32)

Generic success case, with two additional 32-bit data fields

SuccessU32U32U32(u32, u32, u32)

Generic success case, with three additional 32-bit data fields

SuccessU64(u64)

Generic success case, with an additional 64-bit data field

SuccessU32U64(u32, u64)

Generic success case, with an additional 32-bit and 64-bit data field

SuccessAddr(usize)

Generic success case with an additional address-sized value that does not impute access permissions to the process.

SuccessPtr(CapabilityPtr)

Generic success case, with an additional pointer. This pointer is provenance bearing and implies access permission to the process.

AllowReadWriteSuccess(*mut u8, usize)

Read/Write allow success case, returns the previous allowed buffer and size to the process.

AllowReadWriteFailure(ErrorCode, *mut u8, usize)

Read/Write allow failure case, returns the passed allowed buffer and size to the process.

UserspaceReadableAllowSuccess(*mut u8, usize)

Shared Read/Write allow success case, returns the previous allowed buffer and size to the process.

UserspaceReadableAllowFailure(ErrorCode, *mut u8, usize)

Shared Read/Write allow failure case, returns the passed allowed buffer and size to the process.

AllowReadOnlySuccess(*const u8, usize)

Read only allow success case, returns the previous allowed buffer and size to the process.

AllowReadOnlyFailure(ErrorCode, *const u8, usize)

Read only allow failure case, returns the passed allowed buffer and size to the process.

SubscribeSuccess(*const (), usize)

Subscribe success case, returns the previous upcall function pointer and application data.

SubscribeFailure(ErrorCode, *const (), usize)

Subscribe failure case, returns the passed upcall function pointer and application data.

YieldWaitFor(usize, usize, usize)

Yield-WaitFor return value. These arguments match the arguments to an upcall, where the kernel does not define an error field. Therefore this does not have success/failure versions because the kernel cannot know if the upcall (i.e. Yield-WaitFor return value) represents success or failure.

Trait Implementations

impl Clone for SyscallReturn

fn clone(&self) -> SyscallReturn

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SyscallReturn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for SyscallReturn