midenc-hir-analysis 0.4.1

mod backward;
mod forward;
mod lattice;

use midenc_hir::{
    cfg::Graph, dominance::DominanceInfo, loops::LoopForest, pass::AnalysisManager, Backward,
    Block, BlockRef, CallOpInterface, EntityWithId, Forward, Operation, ProgramPoint,
    RegionBranchOpInterface, RegionKindInterface, RegionRef, Report, Spanned, SymbolTable,
};

pub use self::{
    backward::DenseBackwardDataFlowAnalysis, forward::DenseForwardDataFlowAnalysis,
    lattice::DenseLattice,
};
use super::{AnalysisStrategy, DataFlowAnalysis, DataFlowSolver, Dense};
use crate::analyses::{dce::CfgEdge, LoopAction, LoopState};

/// This type provides an [AnalysisStrategy] for dense data-flow analyses.
///
/// In short, it implements the [DataFlowAnalysis] trait, and handles all of the boilerplate that
/// any well-structured dense data-flow analysis requires. Analyses can make use of this strategy
/// by implementing one of the dense data-flow analysis traits, which [DenseDataFlowAnalysis] will
/// use to delegate analysis-specific details to the analysis implementation. The two traits are:
///
/// * [DenseForwardDataFlowAnalysis], for forward-propagating dense analyses
/// * [DenseBackwardDataFlowAnalysis], for backward-propagating dense analyses
///
/// ## What is a dense analysis?
///
/// A dense data-flow analysis is one which associates analysis state with program points, in order
/// to represent the evolution of some state as the program executes (in the case of forward
/// analysis), or to derive facts about program points based on the possible paths that execution
/// might take (backward analysis).
///
/// This is in contrast to sparse data-flow analysis, which associates state with SSA values at
/// their definition, and thus the state does not evolve as the program executes. This is also where
/// the distinction between _dense_ and _sparse_ comes from - program points are dense, while SSA
/// value definitions are sparse (insofar as the state associated with an SSA value only ever occurs
/// once, while states associated with program points are duplicated at each point).
///
/// Some examples of dense analyses:
///
/// * Dead code analysis - at the extreme, indicates whether every program point is executable, i.e.
///   "live", or not. In practice, dead code analysis tends to only associate its state with
///   specific control-flow edges, i.e. changes to the state only occur at block boundaries.
/// * Reaching definition analysis - tracks, for each program point, the set of values whose
///   definitions reach that point.
/// * Dead store analysis - determines for each store instruction in a function, whether or not the
///   stored value is ever read. For example, if you are initializing a struct, and set some field
///   `foo` to `1`, and then set it to `2`, the first store is never observable, and so the store
///   could be eliminated entirely.
///
/// ## Usage
///
/// This type is meant to be used indirectly, as an [AnalysisStrategy] implementation, rather than
/// directly as a [DataFlowAnalysis] implementation, as shown below:
///
/// ```rust,ignore
/// use midenc_hir::dataflow::*;
///
/// #[derive(Default)]
/// pub struct MyAnalysis;
/// impl BuildableDataFlowAnalysis for MyAnalysis {
///     type Strategy = DenseDataFlowAnalysis<Self, Forward>;
///
///     fn new(_solver: &mut DataFlowSolver) -> Self {
///         Self
///     }
/// }
/// impl DenseForwardDataFlowAnalysis for MyAnalysis {
///     type Lattice = Lattice<u32>;
///
///     //...
/// }
/// ```
///
/// The above permits us to load `MyAnalysis` into a `DataFlowSolver` without ever mentioning the
/// `DenseDataFlowAnalysis` type at all, like so:
///
/// ```rust,ignore
/// let mut solver = DataFlowSolver::default();
/// solver.load::<MyAnalysis>();
/// solver.initialize_and_run(&op, analysis_manager);
/// ```
pub struct DenseDataFlowAnalysis<T, D> {
    analysis: T,
    _direction: core::marker::PhantomData<D>,
}

impl<A: DenseForwardDataFlowAnalysis> AnalysisStrategy<A> for DenseDataFlowAnalysis<A, Forward> {
    type Direction = Forward;
    type Kind = Dense;

    fn build(analysis: A, _solver: &mut DataFlowSolver) -> Self {
        Self {
            analysis,
            _direction: core::marker::PhantomData,
        }
    }
}

impl<A: DenseBackwardDataFlowAnalysis> AnalysisStrategy<A> for DenseDataFlowAnalysis<A, Backward> {
    type Direction = Backward;
    type Kind = Dense;

    fn build(analysis: A, _solver: &mut DataFlowSolver) -> Self {
        Self {
            analysis,
            _direction: core::marker::PhantomData,
        }
    }
}

impl<A: DenseForwardDataFlowAnalysis> DataFlowAnalysis for DenseDataFlowAnalysis<A, Forward> {
    #[inline]
    fn debug_name(&self) -> &'static str {
        self.analysis.debug_name()
    }

    fn analysis_id(&self) -> core::any::TypeId {
        core::any::TypeId::of::<Self>()
    }

    /// Initialize the analysis by visiting every program point whose execution may modify the
    /// program state; that is, every operation and block.
    fn initialize(
        &self,
        top: &Operation,
        solver: &mut DataFlowSolver,
        analysis_manager: AnalysisManager,
    ) -> Result<(), Report> {
        log::debug!(
            target: self.analysis.debug_name(),
            "initializing analysis for {top}",
        );

        forward::process_operation(self, top, solver)?;

        // If the op has SSACFG regions, use the dominator tree analysis, if available, to visit the
        // CFG top-down. Otherwise, fall back to a naive iteration over the contents of each region.
        //
        // If we have a domtree, we don't bother visiting unreachable blocks (i.e. blocks that
        // are not in the tree because they are unreachable via the CFG). If we don't have a domtree,
        // then all blocks are visited, regardless of reachability.
        if !top.has_regions() {
            return Ok(());
        }

        let is_ssa_cfg = top
            .as_trait::<dyn RegionKindInterface>()
            .is_none_or(|rki| rki.has_ssa_dominance());
        log::trace!(target: self.analysis.debug_name(), "visiting regions of op (is cfg={is_ssa_cfg})");
        if is_ssa_cfg {
            let dominfo = analysis_manager.get_analysis::<DominanceInfo>()?;
            for (region_index, region) in top.regions().iter().enumerate() {
                // Single-block regions do not require a dominance tree (and do not have one)
                if region.has_one_block() {
                    let block = region.entry();
                    log::trace!(target: self.analysis.debug_name(), "initializing single-block region {region_index} from entry: {block}");
                    forward::visit_block(self, &block, solver);
                    log::trace!(target: self.analysis.debug_name(), "initializing {block} in pre-order");
                    for op in block.body() {
                        let child_analysis_manager = analysis_manager.nest(op.as_operation_ref());
                        self.initialize(&op, solver, child_analysis_manager)?;
                    }
                } else {
                    let entry_block = region.entry_block_ref().unwrap();
                    log::trace!(target: self.analysis.debug_name(), "initializing multi-block region {region_index} with entry: {entry_block}");
                    log::trace!(target: self.analysis.debug_name(), "computing region dominance tree");
                    let domtree = dominfo.dominance(region.as_region_ref());
                    log::trace!(target: self.analysis.debug_name(), "computing region loop forest forward");
                    let loop_forest = LoopForest::new(&domtree);

                    // Visit blocks in CFG reverse post-order
                    log::trace!(
                        target: self.analysis.debug_name(),
                        "visiting region control flow graph in reverse post-order",
                    );
                    for node in domtree.reverse_postorder() {
                        let Some(block) = node.block() else {
                            continue;
                        };
                        log::trace!(target: self.analysis.debug_name(), "analyzing {block}");

                        // Anchor the fact that a loop is being exited to the CfgEdge of the exit,
                        // if applicable for this block
                        if let Some(loop_info) = loop_forest.loop_for(block) {
                            // This block can exit a loop
                            if loop_info.is_loop_exiting(block) {
                                log::trace!(target: self.analysis.debug_name(), "{block} is a loop exit");
                                for succ in BlockRef::children(block) {
                                    if !loop_info.contains_block(succ) {
                                        log::trace!(target: self.analysis.debug_name(), "{block} can exit loop to {succ}");
                                        let mut guard = solver.get_or_create_mut::<LoopState, _>(
                                            CfgEdge::new(block, succ, block.span()),
                                        );
                                        guard.join(LoopAction::Exit);
                                    }
                                }
                            }
                        }

                        let block = block.borrow();
                        forward::visit_block(self, &block, solver);
                        log::trace!(target: self.analysis.debug_name(), "initializing {block} in pre-order");
                        for op in block.body() {
                            let child_analysis_manager =
                                analysis_manager.nest(op.as_operation_ref());
                            self.initialize(&op, solver, child_analysis_manager)?;
                        }
                    }
                }
            }
        } else {
            for (region_index, region) in top.regions().iter().enumerate() {
                for block in region.body() {
                    log::trace!(target: self.analysis.debug_name(), "initializing {block} of region {region_index}");
                    forward::visit_block(self, &block, solver);
                    log::trace!(target: self.analysis.debug_name(), "initializing {block} in pre-order");
                    for op in block.body() {
                        let child_analysis_manager = analysis_manager.nest(op.as_operation_ref());
                        self.initialize(&op, solver, child_analysis_manager)?;
                    }
                }
            }
        }

        Ok(())
    }

    /// Visit a program point that modifies the state of the program.
    ///
    /// If the program point is at the beginning of a block, then the state is propagated from
    /// control-flow predecessors or callsites. If the operation before the program point is a call
    /// operation or region control-flow operation, then the state after the execution of the
    /// operation is set by control-flow or the callgraph. Otherwise, this function invokes the
    /// operation transfer function before the program point iterator.
    fn visit(&self, point: &ProgramPoint, solver: &mut DataFlowSolver) -> Result<(), Report> {
        if point.is_at_block_start() {
            let block = point.block().expect("expected block");
            forward::visit_block(self, &block.borrow(), solver);
        } else {
            let op = point.operation().expect("expected operation");
            forward::process_operation(self, &op.borrow(), solver)?;
        }

        Ok(())
    }
}

impl<A: DenseBackwardDataFlowAnalysis> DataFlowAnalysis for DenseDataFlowAnalysis<A, Backward> {
    #[inline]
    fn debug_name(&self) -> &'static str {
        self.analysis.debug_name()
    }

    fn analysis_id(&self) -> core::any::TypeId {
        core::any::TypeId::of::<Self>()
    }

    /// Initialize the analysis by visiting every program point whose execution may modify the
    /// program state; that is, every operation and block.
    fn initialize(
        &self,
        top: &Operation,
        solver: &mut DataFlowSolver,
        analysis_manager: AnalysisManager,
    ) -> Result<(), Report> {
        log::trace!(
            target: self.analysis.debug_name(),
            "initializing analysis for {top}",
        );

        backward::process_operation(self, top, solver)?;

        // If the op has SSACFG regions, use the dominator tree analysis, if available, to visit the
        // CFG in post-order. Otherwise, fall back to a naive iteration over the contents of each region.
        //
        // If we have a domtree, we don't bother visiting unreachable blocks (i.e. blocks that
        // are not in the tree because they are unreachable via the CFG). If we don't have a domtree,
        // then all blocks are visited, regardless of reachability.
        if !top.has_regions() {
            return Ok(());
        }

        let is_ssa_cfg = top
            .as_trait::<dyn RegionKindInterface>()
            .is_none_or(|rki| rki.has_ssa_dominance());
        log::trace!(target: self.analysis.debug_name(), "visiting regions of op (is cfg={is_ssa_cfg})");
        if is_ssa_cfg {
            let dominfo = analysis_manager.get_analysis::<DominanceInfo>()?;
            for (region_index, region) in top.regions().iter().enumerate() {
                // Single-block regions do not require a dominance tree (and do not have one)
                if region.has_one_block() {
                    let block = region.entry();
                    log::trace!(target: self.analysis.debug_name(), "initializing single-block region {region_index} from entry: {block}");
                    backward::visit_block(self, &block, solver);
                    log::trace!(target: self.analysis.debug_name(), "initializing {block} in post-order");
                    for op in block.body().iter().rev() {
                        let child_analysis_manager = analysis_manager.nest(op.as_operation_ref());
                        self.initialize(&op, solver, child_analysis_manager)?;
                    }
                } else {
                    let entry_block = region.entry_block_ref().unwrap();
                    log::trace!(target: self.analysis.debug_name(), "initializing multi-block region {region_index} with entry: {entry_block}");
                    log::trace!(target: self.analysis.debug_name(), "computing region dominance tree");
                    let domtree = dominfo.dominance(region.as_region_ref());
                    log::trace!(target: self.analysis.debug_name(), "computing region loop forest backward");
                    let loop_forest = LoopForest::new(&domtree);

                    // Visit blocks in CFG postorder
                    log::trace!(
                        target: self.analysis.debug_name(),
                        "visiting region control flow graph in post-order",
                    );
                    for node in domtree.postorder() {
                        let Some(block) = node.block() else {
                            continue;
                        };
                        log::trace!(target: self.analysis.debug_name(), "analyzing {block}");

                        // Anchor the fact that a loop is being exited to the CfgEdge of the exit,
                        // if applicable for this block
                        if let Some(loop_info) = loop_forest.loop_for(block) {
                            // This block can exit a loop
                            if loop_info.is_loop_exiting(block) {
                                log::trace!(target: self.analysis.debug_name(), "{block} is a loop exit");
                                for succ in BlockRef::children(block) {
                                    if !loop_info.contains_block(succ) {
                                        log::trace!(target: self.analysis.debug_name(), "{block} can exit loop to {succ}");
                                        let mut guard = solver.get_or_create_mut::<LoopState, _>(
                                            CfgEdge::new(block, succ, block.span()),
                                        );
                                        guard.join(LoopAction::Exit);
                                    }
                                }
                            }
                        }

                        let block = block.borrow();
                        backward::visit_block(self, &block, solver);
                        log::trace!(target: self.analysis.debug_name(), "initializing {block} in post-order");
                        for op in block.body().iter().rev() {
                            let child_analysis_manager =
                                analysis_manager.nest(op.as_operation_ref());
                            self.initialize(&op, solver, child_analysis_manager)?;
                        }
                    }
                }
            }
        } else {
            for (region_index, region) in top.regions().iter().enumerate() {
                for block in region.body().iter().rev() {
                    log::trace!(target: self.analysis.debug_name(), "initializing {block} of region {region_index}");
                    backward::visit_block(self, &block, solver);
                    log::trace!(target: self.analysis.debug_name(), "initializing {block} in post-order");
                    for op in block.body().iter().rev() {
                        let child_analysis_manager = analysis_manager.nest(op.as_operation_ref());
                        self.initialize(&op, solver, child_analysis_manager)?;
                    }
                }
            }
        }

        Ok(())
    }

    /// Visit a program point that modifies the state of the program. If the program point is at the
    /// beginning of a block, then the state is propagated from control-flow predecessors or
    /// callsites.  If the operation before the program point is a call operation or region
    /// control-flow operation, then the state after the execution of the operation is set by
    /// control-flow or the callgraph. Otherwise, this function invokes the operation transfer
    /// function before the program point.
    fn visit(&self, point: &ProgramPoint, solver: &mut DataFlowSolver) -> Result<(), Report> {
        if point.is_at_block_end() {
            let block = point.block().expect("expected block");
            backward::visit_block(self, &block.borrow(), solver);
        } else {
            let op = point.next_operation().expect("expected operation");
            backward::process_operation(self, &op.borrow(), solver)?;
        }

        Ok(())
    }
}

impl<A: DenseForwardDataFlowAnalysis> DenseForwardDataFlowAnalysis
    for DenseDataFlowAnalysis<A, Forward>
{
    type Lattice = <A as DenseForwardDataFlowAnalysis>::Lattice;

    fn debug_name(&self) -> &'static str {
        <A as DenseForwardDataFlowAnalysis>::debug_name(&self.analysis)
    }

    fn visit_operation(
        &self,
        op: &Operation,
        before: &Self::Lattice,
        after: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) -> Result<(), Report> {
        <A as DenseForwardDataFlowAnalysis>::visit_operation(
            &self.analysis,
            op,
            before,
            after,
            solver,
        )
    }

    fn set_to_entry_state(
        &self,
        lattice: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseForwardDataFlowAnalysis>::set_to_entry_state(&self.analysis, lattice, solver);
    }

    fn visit_branch_control_flow_transfer(
        &self,
        from: BlockRef,
        to: &Block,
        before: &Self::Lattice,
        after: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseForwardDataFlowAnalysis>::visit_branch_control_flow_transfer(
            &self.analysis,
            from,
            to,
            before,
            after,
            solver,
        );
    }

    fn visit_region_branch_control_flow_transfer(
        &self,
        branch: &dyn RegionBranchOpInterface,
        region_from: Option<RegionRef>,
        region_to: Option<RegionRef>,
        before: &Self::Lattice,
        after: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseForwardDataFlowAnalysis>::visit_region_branch_control_flow_transfer(
            &self.analysis,
            branch,
            region_from,
            region_to,
            before,
            after,
            solver,
        );
    }

    fn visit_call_control_flow_transfer(
        &self,
        call: &dyn CallOpInterface,
        action: super::CallControlFlowAction,
        before: &Self::Lattice,
        after: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseForwardDataFlowAnalysis>::visit_call_control_flow_transfer(
            &self.analysis,
            call,
            action,
            before,
            after,
            solver,
        );
    }
}

impl<A: DenseBackwardDataFlowAnalysis> DenseBackwardDataFlowAnalysis
    for DenseDataFlowAnalysis<A, Backward>
{
    type Lattice = <A as DenseBackwardDataFlowAnalysis>::Lattice;

    fn debug_name(&self) -> &'static str {
        <A as DenseBackwardDataFlowAnalysis>::debug_name(&self.analysis)
    }

    fn symbol_table(&self) -> Option<&dyn SymbolTable> {
        <A as DenseBackwardDataFlowAnalysis>::symbol_table(&self.analysis)
    }

    fn set_to_exit_state(
        &self,
        lattice: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseBackwardDataFlowAnalysis>::set_to_exit_state(&self.analysis, lattice, solver)
    }

    fn visit_operation(
        &self,
        op: &Operation,
        after: &Self::Lattice,
        before: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) -> Result<(), Report> {
        <A as DenseBackwardDataFlowAnalysis>::visit_operation(
            &self.analysis,
            op,
            after,
            before,
            solver,
        )
    }

    fn visit_branch_control_flow_transfer(
        &self,
        from: &Block,
        to: BlockRef,
        after: &Self::Lattice,
        before: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseBackwardDataFlowAnalysis>::visit_branch_control_flow_transfer(
            &self.analysis,
            from,
            to,
            after,
            before,
            solver,
        )
    }

    fn visit_region_branch_control_flow_transfer(
        &self,
        branch: &dyn RegionBranchOpInterface,
        region_from: Option<RegionRef>,
        region_to: Option<RegionRef>,
        after: &Self::Lattice,
        before: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseBackwardDataFlowAnalysis>::visit_region_branch_control_flow_transfer(
            &self.analysis,
            branch,
            region_from,
            region_to,
            after,
            before,
            solver,
        )
    }

    fn visit_call_control_flow_transfer(
        &self,
        call: &dyn CallOpInterface,
        action: super::CallControlFlowAction,
        after: &Self::Lattice,
        before: &mut super::AnalysisStateGuardMut<'_, Self::Lattice>,
        solver: &mut DataFlowSolver,
    ) {
        <A as DenseBackwardDataFlowAnalysis>::visit_call_control_flow_transfer(
            &self.analysis,
            call,
            action,
            after,
            before,
            solver,
        )
    }
}