Enum Type 

pub enum Type {
    ScalarValue(U64ScalarValueData),
    ConstPtrToMap {
        id: u64,
        schema: MapSchema,
    },
    PtrToStack {
        offset: StackOffset,
    },
    PtrToMemory {
        id: MemoryId,
        offset: U64ScalarValueData,
        buffer_size: u64,
    },
    PtrToStruct {
        id: MemoryId,
        offset: U64ScalarValueData,
        descriptor: Arc<StructDescriptor>,
    },
    PtrToArray {
        id: MemoryId,
        offset: U64ScalarValueData,
    },
    PtrToEndArray {
        id: MemoryId,
    },
    NullOr {
        id: MemoryId,
        inner: Box<Type>,
    },
    Releasable {
        id: MemoryId,
        inner: Box<Type>,
    },
    ScalarValueParameter,
    ConstPtrToMapParameter,
    MapKeyParameter {
        map_ptr_index: u8,
    },
    MapValueParameter {
        map_ptr_index: u8,
    },
    MemoryParameter {
        size: MemoryParameterSize,
        input: bool,
        output: bool,
    },
    AliasParameter {
        parameter_index: u8,
    },
    NullOrParameter(Box<Type>),
    StructParameter {
        id: MemoryId,
    },
    ReleasableParameter {
        id: MemoryId,
        inner: Box<Type>,
    },
    ReleaseParameter {
        id: MemoryId,
    },
}

Variants

ScalarValue(U64ScalarValueData)

A number.

ConstPtrToMap

A pointer to a map object.

Fields

id: u64

schema: MapSchema

PtrToStack

A pointer into the stack.

Fields

offset: StackOffset

PtrToMemory

A pointer to the kernel memory. The full buffer is buffer_size bytes long. The pointer is situated at offset from the start of the buffer.

Fields

id: MemoryId

offset: U64ScalarValueData

buffer_size: u64

PtrToStruct

A pointer to a struct with the specified StructDescriptor.

Fields

id: MemoryId

offset: U64ScalarValueData

descriptor: Arc<StructDescriptor>

PtrToArray

A pointer to the kernel memory. The full buffer size is determined by an instance of PtrToEndArray with the same id. The pointer is situadted at offset from the start of the buffer.

Fields

id: MemoryId

offset: U64ScalarValueData

PtrToEndArray

A pointer to the kernel memory that represents the first non accessible byte of a PtrToArray with the same id.

Fields

id: MemoryId

NullOr

A pointer that might be null and must be validated before being referenced.

Fields

id: MemoryId

inner: Box<Type>

Releasable

An object that must be passed to a method with an associated ReleaseParameter before the end of the program.

Fields

id: MemoryId

inner: Box<Type>

ScalarValueParameter

A function parameter that must be a ScalarValue when called.

ConstPtrToMapParameter

A function parameter that must be a ConstPtrToMap when called.

MapKeyParameter

A function parameter that must be a key of a map.

Fields

map_ptr_index: u8

The index in the arguments list that contains a ConstPtrToMap for the map this key is associated with.

MapValueParameter

A function parameter that must be a value of a map.

Fields

map_ptr_index: u8

The index in the arguments list that contains a ConstPtrToMap for the map this key is associated with.

MemoryParameter

A function parameter that must be a pointer to memory.

Fields

size: MemoryParameterSize

The index in the arguments list that contains a scalar value containing the size of the memory.

input: bool

Whether this memory is read by the function.

output: bool

Whether this memory is written by the function.

AliasParameter

A function return value that is the same type as a parameter.

Fields

parameter_index: u8

The index in the argument list of the parameter that has the type of this return value.

NullOrParameter(Box<Type>)

A function return value that is either null, or the given type.

StructParameter

A function parameter that must be a pointer to memory with the given id.

Fields

id: MemoryId

ReleasableParameter

A function return value that must be passed to a method with an associated ReleaseParameter before the end of the program.

Fields

id: MemoryId

inner: Box<Type>

ReleaseParameter

A function parameter that will release the value.

Fields

id: MemoryId

Implementations

impl Type

pub const UNINITIALIZED: Self

An uninitialized value.

pub const UNKNOWN_SCALAR: Self

A Type where the data is usable by userspace, but the value is not known by the verifier.

pub fn is_subtype(&self, super_type: &Type) -> bool

Return true if self is a subtype of super_type.

pub fn is_non_zero(&self) -> bool

Return true is self is guaranteed to be non-zero

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Default for Type

fn default() -> Self

A new instance of Type where no bit has been written yet.

impl From<u64> for Type

fn from(value: u64) -> Self

Converts to this type from the input type.

impl PartialEq for Type

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Type

Defines a partial ordering on Type instances, capturing the notion of how “broad” a type is in terms of the set of potential values it represents.

The ordering is defined such that t1 > t2 if a proof that an eBPF program terminates in a state where a register or memory location has type t1 is also a proof that the program terminates in a state where that location has type t2.

In other words, a “broader” type represents a larger set of possible values, and proving termination with a broader type implies termination with any narrower type.

Examples:

• Type::ScalarValue(ScalarValueData({ unknown_mask: 0, .. })) (a known scalar value) is less than Type::ScalarValue(ScalarValueData({ unknown_mask: u64::MAX, .. })) (an unknown scalar value).

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Type