Enum cranelift_codegen::ir::ArgumentPurpose

pub enum ArgumentPurpose {
    Normal,
    StructReturn,
    Link,
    FramePointer,
    CalleeSaved,
    VMContext,
    SignatureId,
    StackLimit,
}

The special purpose of a function argument.

Function arguments and return values are used to pass user program values between functions, but they are also used to represent special registers with significance to the ABI such as frame pointers and callee-saved registers.

The argument purpose is used to indicate any special meaning of an argument or return value.

Variants

Normal

A normal user program value passed to or from a function.

StructReturn

Struct return pointer.

When a function needs to return more data than will fit in registers, the caller passes a pointer to a memory location where the return value can be written. In some ABIs, this struct return pointer is passed in a specific register.

This argument kind can also appear as a return value for ABIs that require a function with a StructReturn pointer argument to also return that pointer in a register.

Link

The link register.

Most RISC architectures implement calls by saving the return address in a designated register rather than pushing it on the stack. This is represented with a Link argument.

Similarly, some return instructions expect the return address in a register represented as a Link return value.

FramePointer

The frame pointer.

This indicates the frame pointer register which has a special meaning in some ABIs.

The frame pointer appears as an argument and as a return value since it is a callee-saved register.

CalleeSaved

A callee-saved register.

Some calling conventions have registers that must be saved by the callee. These registers are represented as CalleeSaved arguments and return values.

VMContext

A VM context pointer.

This is a pointer to a context struct containing details about the current sandbox. It is used as a base pointer for vmctx global values.

SignatureId

A signature identifier.

This is a special-purpose argument used to identify the calling convention expected by the caller in an indirect call. The callee can verify that the expected signature ID matches.

StackLimit

A stack limit pointer.

This is a pointer to a stack limit. It is used to check the current stack pointer against. Can only appear once in a signature.

Trait Implementations

impl Clone for ArgumentPurpose

fn clone(&self) -> ArgumentPurpose

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ArgumentPurpose

impl Debug for ArgumentPurpose

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

Formats the value using the given formatter.

impl Display for ArgumentPurpose

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

Formats the value using the given formatter.

impl Eq for ArgumentPurpose

impl FromStr for ArgumentPurpose

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, ()>

Parses a string s to return a value of this type.

impl Hash for ArgumentPurpose

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<ArgumentPurpose> for ArgumentPurpose

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for ArgumentPurpose

impl StructuralPartialEq for ArgumentPurpose