Struct falcon::il::ControlFlowGraph

pub struct ControlFlowGraph { /* fields omitted */ }

A directed graph of types Block and Edge.

Entry and Exit

A ControlFlowGraph has an optional, "Entry," and an optional, "Exit." When these are provided, certain convenience functions become available.

For example, when translating a native instruction to Falcon IL, it can be useful to consider an instruction as its own ControlFlowGraph. rep scasb is a great example of when this pattern is helpful. Instructions in a Block will have one entry, and one exit. Explicitly declaring these makes merging ControlFlowGraphs easier.

Methods

impl ControlFlowGraph

pub fn new() -> ControlFlowGraph

pub fn graph(&self) -> &Graph<Block, Edge>

Returns the underlying graph

pub fn set_entry(&mut self, entry: u64) -> Result<()>

Sets the entry point for this ControlFlowGraph to the given Block index.

pub fn set_exit(&mut self, exit: u64) -> Result<()>

Sets the exit point for this ControlFlowGraph to the given Block index.

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

Get the entry Block index for this ControlFlowGraph.

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

Get the exit Block index for this ControlFlowGraph.

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

Get a Block by index.

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

Get a mutable reference to a Block by index.

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

Get every Block in this ControlFlowGraph.

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

Get a mutable reference to every Block in this ControlFlowGraph.

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

Get an Edge by its head and tail Block indices.

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

Get a mutable reference to an Edge by its head and tail Block indices.

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

Get every Edge in thie ControlFlowGraph.

pub fn edges_mut(&mut self) -> Vec<&mut Edge>

Get a mutable reference to every Edge in this ControlFlowGraph.

pub fn edges_in(&self, index: u64) -> Option<&Vec<Edge>>

Get every incoming edge to a block

pub fn edges_out(&self, index: u64) -> Option<&Vec<Edge>>

Get every outgoing edge from a block

pub fn set_address(&mut self, address: Option<u64>)

Sets the address for all instructions in this ControlFlowGraph.

Useful for translators to set address information.

pub fn entry_block(&self) -> Option<&Block>

Returns the entry block for this ControlFlowGraph

pub fn temp(&mut self, bits: usize) -> Scalar

Generates a temporary scalar unique to this control flow graph.

pub fn new_block(&mut self) -> Result<&mut Block>

Creates a new basic block, adds it to the graph, and returns it

pub fn unconditional_edge(&mut self, head: u64, tail: u64) -> Result<()>

Creates an unconditional edge from one block to another block

pub fn conditional_edge(
    &mut self,
    head: u64,
    tail: u64,
    condition: Expression
) -> Result<()>

Creates a conditional edge from one block to another block

pub fn merge(&mut self) -> Result<()>

Merge Blocks.

When a Block as only one successor, and that successor has only one predecessor, we merge both into one Block.

pub fn append(&mut self, other: &ControlFlowGraph) -> Result<()>

Appends a control flow graph to this control flow graph.

In order for this to work, the entry and exit of boths graphs must be set, which should be the case for all conformant translators. You can also append to an empty ControlFlowGraph.

pub fn insert(&mut self, other: &ControlFlowGraph) -> Result<(u64, u64)>

Inserts a control flow graph into this control flow graph, and returns the entry and exit indices for inserted graph.

Requires the graph being inserted to have entry set.

This function causes the ControlFlowGraph to become disconnected.

This function is useful for inserting multiple ControlFlowGraphs into one before adding all Edges in a subsequent pass.

Warnings

This invalidates the entry and exit of the control flow graph.

Trait Implementations

impl Clone for ControlFlowGraph

fn clone(&self) -> ControlFlowGraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlFlowGraph

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

Formats the value using the given formatter.

impl Eq for ControlFlowGraph

impl Hash for ControlFlowGraph

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 ControlFlowGraph

fn cmp(&self, __arg_0: &ControlFlowGraph) -> 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 ControlFlowGraph

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

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

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

This method tests for !=.

impl PartialOrd for ControlFlowGraph

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

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

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

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

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

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

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

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

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

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

impl Display for ControlFlowGraph

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

Formats the value using the given formatter.