Struct Function

pub struct Function {
    pub id: FunctionIdent,
    pub signature: Signature,
    pub dfg: DataFlowGraph,
    /* private fields */
}

Function corresponds to a function definition, in single-static assignment (SSA) form.

• Functions may have zero or more parameters, and produce zero or more results.
• Functions are namespaced in Modules. You may define a function separately from a module, to aid in parallelizing compilation, but functions must be attached to a module prior to code generation. Furthermore, in order to reference other functions, you must do so using their fully-qualified names.
• Functions consist of one or more basic blocks, where the entry block is predefined based on the function signature.
• Basic blocks consist of a sequence of Instruction without any control flow (excluding calls), terminating with a control flow instruction. Our SSA representation uses block arguments rather than phi nodes to represent join points in the control flow graph.
• Instructions consume zero or more arguments, and produce zero or more results. Results produced by an instruction constitute definitions of those values. A value may only ever have a single definition, e.g. you can’t reassign a value after it is introduced by an instruction.

References to functions and global variables from a Function are not fully validated until link-time/code generation.

Fields

id: FunctionIdent

signature: Signature

dfg: DataFlowGraph

Implementations

impl Function

pub fn new(id: FunctionIdent, signature: Signature) -> Self

Create a new Function with the given name, signature, and source location.

The resulting function will be given default internal linkage, i.e. it will only be visible within it’s containing Module.

pub fn is_detached(&self) -> bool

Returns true if this function has yet to be attached to a Module

pub fn is_kernel(&self) -> bool

Returns true if this function is a kernel function

pub fn is_public(&self) -> bool

Returns true if this function has external linkage

pub fn signature(&self) -> &Signature

Return the Signature for this function

pub fn signature_mut(&mut self) -> &mut Signature

Return the Signature for this function

pub fn arity(&self) -> usize

Return the number of parameters this function expects

pub fn linkage(&self) -> Linkage

Return the Linkage type for this function

pub fn set_linkage(&mut self, linkage: Linkage)

Set the linkage type for this function

pub fn calling_convention(&self) -> CallConv

Return the CallConv type for this function

pub fn set_calling_convention(&mut self, cc: CallConv)

Set the linkage type for this function

pub fn has_attribute<Q>(&self, name: &Q) -> bool

where Q: Ord + ?Sized, Symbol: Borrow<Q>,

Return true if this function has attribute name

pub fn imports<'a, 'b: 'a>( &'b self, ) -> impl Iterator<Item = &'a ExternalFunction> + 'a

Iterate over all of the external functions imported by this function

pub fn builder(&mut self) -> FunctionBuilder<'_>

pub fn cfg_printer(&self) -> impl Display + '_

Trait Implementations

impl AnalysisKey for Function

type Key = FunctionIdent

The type of the unique identifier associated with Self

fn key(&self) -> Self::Key

Get the key to associate with the current entity

impl Debug for Function

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

Formats the value using the given formatter.

impl Display for Function

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

Formats the value using the given formatter.

impl Emit for Function

fn name(&self) -> Option<Symbol>

The name of this item, if applicable

fn output_type(&self, _mode: OutputMode) -> OutputType

The output type associated with this item and the given mode

fn write_to<W: Write>( &self, writer: W, mode: OutputMode, _session: &Session, ) -> Result<()>

Write this item to the given std::io::Write handle, using mode to determine the output type

fn write_to_stdout(&self, session: &Session) -> Result<(), Error>

Write this item to standard output, inferring the best OutputMode based on whether or not stdout is a tty or not

fn write_to_file( &self, path: &Path, mode: OutputMode, session: &Session, ) -> Result<(), Error>

Write this item to the given file path, using mode to determine the output type

impl PartialEq for Function

fn eq(&self, other: &Self) -> 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 PrettyPrint for Function

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Spanned for Function

fn span(&self) -> SourceSpan

impl Eq for Function