mutable_state.rs

use std::{
    cell::{RefCell, RefMut},
    collections::{BTreeMap, HashMap},
};

use bit_vec::BitVec;
use powdr_number::FieldElement;

use crate::witgen::{
    machines::{KnownMachine, LookupCell, Machine},
    range_constraints::RangeConstraint,
    rows::RowPair,
    EvalError, EvalResult, QueryCallback,
};

/// The container and access method for machines and the query callback.
/// The machines contain the actual data tables.
/// This struct uses interior mutability for accessing the machines.
pub struct MutableState<'a, T: FieldElement, Q: QueryCallback<T>> {
    machines: Vec<RefCell<KnownMachine<'a, T>>>,
    identity_to_machine_index: BTreeMap<u64, usize>,
    query_callback: &'a Q,
}

impl<'a, T: FieldElement, Q: QueryCallback<T>> MutableState<'a, T, Q> {
    pub fn new(machines: impl Iterator<Item = KnownMachine<'a, T>>, query_callback: &'a Q) -> Self {
        let machines: Vec<_> = machines.map(RefCell::new).collect();
        let identity_to_machine_index = machines
            .iter()
            .enumerate()
            .flat_map(|(index, m)| {
                m.borrow()
                    .identity_ids()
                    .into_iter()
                    .map(move |id| (id, index))
            })
            .collect();
        Self {
            machines,
            identity_to_machine_index,
            query_callback,
        }
    }

    /// Runs the first machine (unless there are no machines) end returns the generated columns.
    /// The first machine might call other machines, which is handled automatically.
    pub fn run(self) -> HashMap<String, Vec<T>> {
        if let Some(first_machine) = self.machines.first() {
            first_machine.try_borrow_mut().unwrap().run_timed(&self);
        }
        self.take_witness_col_values()
    }

    pub fn can_process_call_fully(
        &self,
        identity_id: u64,
        known_inputs: &BitVec,
        range_constraints: &[RangeConstraint<T>],
    ) -> Option<Vec<RangeConstraint<T>>> {
        // TODO We are currently ignoring bus interaction (also, but not only because there is no
        // unique machine responsible for handling a bus send), so just answer "false" if the identity
        // has no responsible machine.
        let mut machine = self.responsible_machine(identity_id).ok()?;
        machine.can_process_call_fully(identity_id, known_inputs, range_constraints)
    }

    /// Call the machine responsible for the right-hand-side of an identity given its ID
    /// and the row pair of the caller.
    pub fn call(&self, identity_id: u64, caller_rows: &RowPair<'_, 'a, T>) -> EvalResult<'a, T> {
        self.responsible_machine(identity_id)?
            .process_plookup_timed(self, identity_id, caller_rows)
    }

    /// Call the machine responsible for the right-hand-side of an identity given its ID,
    /// use the direct interface.
    #[allow(unused)]
    pub fn call_direct(
        &self,
        identity_id: u64,
        values: &mut [LookupCell<'_, T>],
    ) -> Result<bool, EvalError<T>> {
        self.responsible_machine(identity_id)?
            .process_lookup_direct_timed(self, identity_id, values)
    }

    fn responsible_machine(
        &self,
        identity_id: u64,
    ) -> Result<RefMut<KnownMachine<'a, T>>, EvalError<T>> {
        let machine_index = *self
            .identity_to_machine_index
            .get(&identity_id)
            .unwrap_or_else(|| panic!("No executor machine matched identity ID: {identity_id}"));
        self.machines[machine_index].try_borrow_mut().map_err(|_| {
            EvalError::RecursiveMachineCalls(format!(
                "Detected when processing identity with ID {identity_id}"
            ))
        })
    }

    /// Extracts the witness column values from the machines.
    fn take_witness_col_values(self) -> HashMap<String, Vec<T>> {
        // We keep the already processed machines mutably borrowed so that
        // "later" machines do not try to create new rows in already processed
        // machines.
        let mut processed = vec![];
        self.machines
            .iter()
            .flat_map(|machine| {
                let mut machine = machine
                    .try_borrow_mut()
                    .map_err(|_| {
                        panic!("Recursive machine dependencies while finishing machines.");
                    })
                    .unwrap();
                let columns = machine.take_witness_col_values(&self).into_iter();
                processed.push(machine);
                columns
            })
            .collect()
    }

    pub fn query_callback(&self) -> &Q {
        self.query_callback
    }
}