Struct BasicBlock 

pub struct BasicBlock {
    pub ir_builder: ObjPtr<IRBuilder>,
    pub name: String,
    pub id: usize,
    pub depth: usize,
    /* private fields */
}

The organization structure of the instructions inside the basic block is a double linked list. the last instruction must be br or ret.

Fields

ir_builder: ObjPtr<IRBuilder>

name: String

id: usize

depth: usize

Implementations

impl BasicBlock

pub fn new(name: String, ir_builder: ObjPtr<IRBuilder>) -> Self

pub unsafe fn init_bb(bb: BBPtr, id: usize)

Safety

Inits BasicBlock after memory allocation.

This is an ugly code that is a compromise in design. You should not call this function.

pub fn is_empty(&self) -> bool

Returns True if the BasicBlock is empty.

pub fn get_first_inst(&self) -> InstPtr

Gets first instruction in the BasicBlock.

Panics

Please make sure the current basic block is not empty, otherwise it will panic.

pub fn get_last_inst(&self) -> InstPtr

Gets the last instruction in the BasicBlock.

Panics

Please make sure the current basic block is not empty, otherwise it will panic.

pub fn push_back(&mut self, inst: InstPtr)

Appends a new instruction to the end of the BasicBlock.

pub fn push_front(&mut self, inst: InstPtr)

Appends a new instruction to the beginning of the BasicBlock.

pub fn is_entry(&self) -> bool

Returns True if the BasicBlock is the function entry BasicBlock.

pub fn is_exit(&self) -> bool

Returns True if the BasicBlock is the function exit BasicBlock.

pub fn get_pred_bb(&self) -> &Vec<BBPtr>

Gets the predecessor BasicBlock of the BasicBlock.

pub fn get_succ_bb(&self) -> &Vec<BBPtr>

Gets the successor BasicBlock of the BasicBlock.

pub fn remove_self(&mut self)

Remove current block. This removes self from successor’s predecessor list and phi operand.

Panics

Please make sure this block is unreachable!

pub fn replace_entry(&mut self, entry: BBPtr, func: FunPtr)

Replace preds => [ self -> ... ] => succs with preds => [ entry -> ... ] => succs. This:

• add preds to entry’s predecessor list
• remove preds from self’s predecessor list
• replaces self to entry in predecessor’s successor list
• replaces self to entry in function entry

Safety

Entry should be different from self, and contain no “phi” instructions.

pub fn replace_exit(&mut self, exit: BBPtr)

Replace preds => [ ... -> self ] => succs with preds => [ ... -> exit ] => succs. This:

• add succs to exit’s successor list
• remove succs from self’s successor list
• replaces self -> exit in successor’s predecessor list
• replaces self -> exit in successor’s phi operand

Safety

Exit should be different from self.

pub fn remove_pred_bb(&mut self, pred: BBPtr)

Remove a predecessor of this block.

pub fn replace_pred_bb(&mut self, from: BBPtr, to: BBPtr)

Replace a predecessor of this block.

pub fn replace_succ_bb_only(&mut self, from: BBPtr, to: BBPtr)

Replace successor with given mapping. TODO: rename me

pub fn set_true_bb(&mut self, bb: BBPtr)

Sets which BasicBlock to jump to when the condition is true.

Panics

Don’t replace existing true BasicBlock with this method.

pub fn set_false_bb(&mut self, bb: BBPtr)

Sets which BasicBlock to jump to when the condition is false.

Panics

You should set the true BasicBlock before use this method. Don’t replace existing false BasicBlock with this method.

pub fn remove_false_bb(&mut self)

Remove basic block to jump to when the condition is false. This will only execute when false bb exists.

pub fn remove_true_bb(&mut self)

Remove basic block to jump to when the condition is true. This will only execute when false bb exists.

pub fn iter(&self) -> BasicBlockIterator

Returns a iterator of the BasicBlock. The iterator yields the InstPtr of the BasicBlock except the head instruction.

pub fn iter_rev(&self) -> BasicBlockIteratorRev

Returns a reverse iterator of the BasicBlock. The iterator yields the InstPtr of the BasicBlock except the head instruction.

pub fn gen_llvm_ir(&self) -> String

Trait Implementations

impl Display for BasicBlock

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

Formats the value using the given formatter.

impl Extend<InstPtr> for BasicBlock

fn extend<T: IntoIterator<Item = InstPtr>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Ord for BasicBlock

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BasicBlock

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 PartialOrd for BasicBlock

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl Eq for BasicBlock