Enum cranelift_codegen::ir::ArgumentPurpose [−][src]
pub enum ArgumentPurpose { Normal, StructReturn, Link, FramePointer, CalleeSaved, VMContext, SignatureId, }
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.
Trait Implementations
impl Copy for ArgumentPurpose
[src]
impl Copy for ArgumentPurpose
impl Clone for ArgumentPurpose
[src]
impl Clone for ArgumentPurpose
fn clone(&self) -> ArgumentPurpose
[src]
fn clone(&self) -> ArgumentPurpose
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialEq for ArgumentPurpose
[src]
impl PartialEq for ArgumentPurpose
fn eq(&self, other: &ArgumentPurpose) -> bool
[src]
fn eq(&self, other: &ArgumentPurpose) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl Eq for ArgumentPurpose
[src]
impl Eq for ArgumentPurpose
impl Debug for ArgumentPurpose
[src]
impl Debug for ArgumentPurpose
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Hash for ArgumentPurpose
[src]
impl Hash for ArgumentPurpose
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Display for ArgumentPurpose
[src]
impl Display for ArgumentPurpose
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl FromStr for ArgumentPurpose
[src]
impl FromStr for ArgumentPurpose
Auto Trait Implementations
impl Send for ArgumentPurpose
impl Send for ArgumentPurpose
impl Sync for ArgumentPurpose
impl Sync for ArgumentPurpose