revive/crates/solidity/src/evmla/ethereal_ir/function/block/mod.rs

//! The Ethereal IR block.

pub mod element;

use std::collections::HashSet;

use num::Zero;

use crate::evmla::assembly::instruction::name::Name as InstructionName;
use crate::evmla::assembly::instruction::Instruction;

use self::element::stack::Stack as ElementStack;
use self::element::Element;

/// The Ethereal IR block.
#[derive(Debug, Clone)]
pub struct Block {
    /// The Solidity compiler version.
    pub solc_version: semver::Version,
    /// The block key.
    pub key: revive_llvm_context::EraVMFunctionBlockKey,
    /// The block instance.
    pub instance: Option<usize>,
    /// The block elements relevant to the stack consistency.
    pub elements: Vec<Element>,
    /// The block predecessors.
    pub predecessors: HashSet<(revive_llvm_context::EraVMFunctionBlockKey, usize)>,
    /// The initial stack state.
    pub initial_stack: ElementStack,
    /// The stack.
    pub stack: ElementStack,
    /// The extra block hashes for alternative routes.
    pub extra_hashes: Vec<md5::Digest>,
}

impl Block {
    /// The elements vector initial capacity.
    pub const ELEMENTS_VECTOR_DEFAULT_CAPACITY: usize = 64;
    /// The predecessors hashset initial capacity.
    pub const PREDECESSORS_HASHSET_DEFAULT_CAPACITY: usize = 4;

    /// Assembles a block from the sequence of instructions.
    pub fn try_from_instructions(
        solc_version: semver::Version,
        code_type: revive_llvm_context::EraVMCodeType,
        slice: &[Instruction],
    ) -> anyhow::Result<(Self, usize)> {
        let mut cursor = 0;

        let tag: num::BigUint = match slice[cursor].name {
            InstructionName::Tag => {
                let tag = slice[cursor]
                    .value
                    .as_deref()
                    .expect("Always exists")
                    .parse()
                    .expect("Always valid");
                cursor += 1;
                tag
            }
            _ => num::BigUint::zero(),
        };

        let mut block = Self {
            solc_version: solc_version.clone(),
            key: revive_llvm_context::EraVMFunctionBlockKey::new(code_type, tag),
            instance: None,
            elements: Vec::with_capacity(Self::ELEMENTS_VECTOR_DEFAULT_CAPACITY),
            predecessors: HashSet::with_capacity(Self::PREDECESSORS_HASHSET_DEFAULT_CAPACITY),
            initial_stack: ElementStack::new(),
            stack: ElementStack::new(),
            extra_hashes: vec![],
        };

        let mut dead_code = false;
        while cursor < slice.len() {
            if !dead_code {
                let element: Element = Element::new(solc_version.clone(), slice[cursor].to_owned());
                block.elements.push(element);
            }

            match slice[cursor].name {
                InstructionName::RETURN
                | InstructionName::REVERT
                | InstructionName::STOP
                | InstructionName::INVALID => {
                    cursor += 1;
                    dead_code = true;
                }
                InstructionName::JUMP => {
                    cursor += 1;
                    dead_code = true;
                }
                InstructionName::Tag => {
                    break;
                }
                _ => {
                    cursor += 1;
                }
            }
        }

        Ok((block, cursor))
    }

    /// Inserts a predecessor tag.
    pub fn insert_predecessor(
        &mut self,
        key: revive_llvm_context::EraVMFunctionBlockKey,
        instance: usize,
    ) {
        self.predecessors.insert((key, instance));
    }
}

impl<D> revive_llvm_context::EraVMWriteLLVM<D> for Block
where
    D: revive_llvm_context::EraVMDependency + Clone,
{
    fn into_llvm(
        self,
        context: &mut revive_llvm_context::EraVMContext<D>,
    ) -> anyhow::Result<()> {
        context.set_code_type(self.key.code_type);

        for element in self.elements.into_iter() {
            element.into_llvm(context)?;
        }

        Ok(())
    }
}

impl std::fmt::Display for Block {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(
            f,
            "block_{}/{}: {}",
            self.key,
            self.instance.unwrap_or_default(),
            if self.predecessors.is_empty() {
                "".to_owned()
            } else {
                format!(
                    "(predecessors: {})",
                    self.predecessors
                        .iter()
                        .map(|(key, instance)| format!("{}/{}", key, instance))
                        .collect::<Vec<String>>()
                        .join(", ")
                )
            },
        )?;
        for element in self.elements.iter() {
            writeln!(f, "    {element}")?;
        }
        Ok(())
    }
}