Struct HartMask 

pub struct HartMask<T = usize> { /* private fields */ }

Hart mask structure in SBI function calls.

Implementations

impl<T: SbiRegister> HartMask<T>

pub const IGNORE_MASK: T = T::FULL_MASK

Special value to ignore the mask, and consider all bits as set.

pub const fn from_mask_base(hart_mask: T, hart_mask_base: T) -> Self

Construct a HartMask from mask value and base hart id.

pub const fn all() -> Self

Construct a HartMask that selects all available harts on the current environment.

According to the RISC-V SBI Specification, hart_mask_base can be set to -1 (i.e. usize::MAX) to indicate that hart_mask shall be ignored and all available harts must be considered. In case of this function in the sbi-spec crate, we fill in usize::MAX in hart_mask_base parameter to match the RISC-V SBI standard, while choosing 0 as the ignored hart_mask value.

pub const fn ignore_mask(&self) -> T

Gets the special value for ignoring the mask parameter.

pub const fn into_inner(self) -> (T, T)

Returns mask and base parameters from the HartMask.

impl HartMask<usize>

pub const fn has_bit(self, hart_id: usize) -> bool

Returns whether the HartMask contains the provided hart_id.

pub const fn insert(&mut self, hart_id: usize) -> Result<(), MaskError>

Insert a hart id into this HartMask.

Returns error when hart_id is invalid.

pub const fn remove(&mut self, hart_id: usize) -> Result<(), MaskError>

Remove a hart id from this HartMask.

Returns error when hart_id is invalid, or it has been ignored.

pub const fn iter(&self) -> HartIds

Returns HartIds of self.

Trait Implementations

impl<T: Clone> Clone for HartMask<T>

fn clone(&self) -> HartMask<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for HartMask<T>

impl<T: Debug> Debug for HartMask<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for HartMask<T>

impl<T: Hash> Hash for HartMask<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for HartMask

type Item = usize

The type of the elements being iterated over.

type IntoIter = HartIds

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for HartMask<T>

fn eq(&self, other: &HartMask<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for HartMask<T>