qbice 0.6.5

The Query-Based Incremental Computation Engine
Documentation
use std::sync::Arc;

use crate::{
    Engine, ExecutionStyle,
    config::Config,
    engine::computation_graph::{CallerInformation, computing::QueryComputing},
    query::QueryID,
};

/// A drop guard for undoing the registration of a callee query.
///
/// This aims to ensure cancelation safety in case of the task being yielded and
/// canceled mid query.
pub struct UndoRegisterCallee {
    query_computing: Arc<QueryComputing>,
    callee_target: QueryID,
    defused: bool,
}

impl UndoRegisterCallee {
    /// Creates a new [`UndoRegisterCallee`] instance.
    pub const fn new(
        query_computing: Arc<QueryComputing>,
        callee_target: QueryID,
    ) -> Self {
        Self { query_computing, callee_target, defused: false }
    }

    /// Don't undo the registration when dropped.
    pub fn defuse(mut self) { self.defused = true; }
}

impl Drop for UndoRegisterCallee {
    fn drop(&mut self) {
        if self.defused {
            return;
        }

        self.query_computing.abort_callee(&self.callee_target);
    }
}
impl<C: Config> Engine<C> {
    pub(super) fn register_callee(
        &self,
        caller: &CallerInformation,
        calee_target: &QueryID,
    ) -> Option<UndoRegisterCallee> {
        // record the dependency first, don't necessary need to figure out
        // the observed value fingerprint yet
        caller.get_query_caller().map_or_else(
            || None,
            |caller| {
                let computing = caller.computing();

                assert!(
                    !computing.query_kind().is_external_input(),
                    "`ExternalInput` queries cannot call other queries"
                );

                // Invariant Check: projection query can only requires firewall
                // queries or projection queries.
                if computing.query_kind().is_projection() {
                    // get the kind of query about to be registerd by looking
                    // up from the executor registry
                    let entry =
                        self.executor_registry.get_executor_entry_by_type_id(
                            &calee_target.stable_type_id(),
                        );
                    let exec_style = entry.obtain_execution_style();

                    assert!(
                        matches!(
                            exec_style,
                            ExecutionStyle::Firewall
                                | ExecutionStyle::Projection
                        ),
                        "Projection query can only depend on firewall or \
                         projection queries"
                    );
                }

                computing.register_calee(calee_target);

                Some(UndoRegisterCallee::new(computing.clone(), *calee_target))
            },
        )
    }
}