Struct falcon::il::Function

pub struct Function { /* fields omitted */ }

A function for Falcon IL. Provides location and context in a Program to a ControlFlowGraph.

Methods

impl Function

pub fn new(address: u64, control_flow_graph: ControlFlowGraph) -> Function

Create a new Function

Parameters

• address - The address where we recovered this function.
• control_flow_graph - A ControlFlowGraph capturing the semantics of this function.

pub fn locations(&self) -> Vec<RefFunctionLocation>

Create a Vec of every RefFunctionLocation for this function.

Convenient for analyses where we need to check every location in a function

pub fn address(&self) -> u64

Get the address of this Function.

The address returned will be the address set when this Function was created, which should be the virtual address where this Function was found.

pub fn block(&self, index: u64) -> Option<&Block>

Return a Block from this Function's ControlFlowGraph by index.

pub fn block_mut(&mut self, index: u64) -> Option<&mut Block>

Return a mutable reference to a Block in this Function

pub fn blocks(&self) -> Vec<&Block>

Return a Vec of all Block in this Function

pub fn blocks_mut(&mut self) -> Vec<&mut Block>

Return a Vec of mutable references to all Block in this Function

pub fn edge(&self, head: u64, tail: u64) -> Option<&Edge>

Return an Edge from this Function's ControlFlowGraph by index.

pub fn edges(&self) -> Vec<&Edge>

Return a vec of all Edge in this Function

pub fn control_flow_graph(&self) -> &ControlFlowGraph

Return the ControlFlowGraph for this Function.

pub fn control_flow_graph_mut(&mut self) -> &mut ControlFlowGraph

Return a mutable reference to the ControlFlowGraph for this Function.

pub fn name(&self) -> String

Return the name of this Function.

pub fn set_name(&mut self, name: Option<String>)

Set this Function's name.

pub fn index(&self) -> Option<u64>

Return the index of this Function. A Function will have an index if it is added to a Program.

pub fn set_index(&mut self, index: Option<u64>)

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Eq for Function

impl Hash for Function

fn hash<__H: Hasher>(&self, __arg_0: &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 Ord for Function

fn cmp(&self, __arg_0: &Function) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialEq for Function

fn eq(&self, __arg_0: &Function) -> bool

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

fn ne(&self, __arg_0: &Function) -> bool

This method tests for !=.

impl PartialOrd for Function

fn partial_cmp(&self, __arg_0: &Function) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Function) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Function) -> bool

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

fn gt(&self, __arg_0: &Function) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Function) -> bool

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