Skip to main content

Backend

Enum Backend 

Source
#[non_exhaustive]
pub enum Backend { V3GfniCrypto, V3, V2, V1, NeonAes, Neon, Wasm128, Scalar, }
Expand description

The SIMD capability ladder, one variant per archmage tier the ecosystem has kernels for.

Variants are named after the archmage tier they prove and declared in that tier’s dispatch-priority order (strongest first), mirroring archmage-macros/src/tiers.rs at the pinned rev. The declaration order therefore is the ladder: it carries capability, and it cannot drift from archmage’s source of truth without the ordering test failing.

Ord follows declaration order with weaker sorting greater, matching fff’s convention so the downgrade-only override check ports unchanged: requested >= detected reads “requested is at most as strong as detected”. min() over a summoning set is therefore the strongest tier.

Cross-arch variants never share a host: a wrong-arch token summons None, so detection over the full ladder is unambiguous.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

V3GfniCrypto

x86 AVX2 + GFNI + crypto, 32-byte GFNI field multiply (X64V3GfniCryptoToken, tiers.rs priority 37).

§

V3

x86 AVX2, 32-byte split-nibble shuffle (X64V3Token, priority 30).

§

V2

x86 SSE4.2, 16-byte split-nibble shuffle (X64V2Token, priority 20).

§

V1

x86 SSE2 baseline (X64V1Token, priority 10). Always summons on x86_64; the x86 floor below which only Scalar remains.

§

NeonAes

AArch64 NEON + AES, 16-byte NEON (NeonAesToken, priority 30). The aes feature proves PMULL, so this is the PMULL tier (R4).

§

Neon

AArch64 NEON baseline (NeonToken, priority 20).

§

Wasm128

WebAssembly simd128 (Wasm128Token, priority 20).

§

Scalar

Portable fallback, always present (ScalarToken, priority 0).

Implementations§

Source§

impl Backend

Source

pub const ALL: &'static [Backend]

Every backend in detection-preference order — the shipped ladder. A &'static slice (not an array) so adding a tier is not a breaking change to the type.

Source

pub const fn name(self) -> &'static str

Short stable identifier, also the value accepted by the SIMD_BACKEND override and the Backend::from_name / FromStr parse set.

Source

pub fn from_name(name: &str) -> Option<Backend>

Parse a backend name, as accepted by the SIMD_BACKEND override.

Source

pub const fn lane_bytes(self) -> usize

Architectural vector width in bytes per tier. Consumers that derive buffer geometry from the resolved backend import this; they never re-derive it.

Trait Implementations§

Source§

impl Clone for Backend

Source§

fn clone(&self) -> Backend

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Backend

Source§

impl Debug for Backend

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Backend

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Backend

Source§

impl FromStr for Backend

Source§

type Err = ParseBackendError

The associated error which can be returned from parsing.
Source§

fn from_str(name: &str) -> Result<Backend, <Backend as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Backend

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl KernelBackend for Backend

Source§

fn has_native_mul(self) -> bool

Whether this backend has a native byte-wide field multiply (GFNI).
Source§

fn has_blocked_rows(self) -> bool

Whether this backend implements the register-blocked multi-row kernels. Others decompose into repeated single-row AXPY.
Source§

impl Ord for Backend

Source§

fn cmp(&self, other: &Backend) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Backend

Source§

fn eq(&self, other: &Backend) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Backend

Source§

fn partial_cmp(&self, other: &Backend) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for Backend

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.