salsa-macro-rules 0.26.2

/// Macro for setting up a function that must intern its arguments.
#[macro_export]
macro_rules! setup_tracked_fn {
    (
        // Attributes on the function
        attrs: [$(#[$attr:meta]),*],

        // Visibility of the function
        vis: $vis:vis,

        // Name of the function
        fn_name: $fn_name:ident,

        // Name of the `'db` lifetime that the user gave; if they didn't, then defaults to `'db`
        db_lt: $db_lt:lifetime,

        // Path to the database trait that the user's database parameter used
        Db: $Db:path,

        // Name of the database parameter given by the user.
        db: $db:ident,

        // An identifier for each function argument EXCEPT the database.
        // We prefer to use the identifier the user gave, but if the user gave a pattern
        // (e.g., `(a, b): (u32, u32)`) we will synthesize an identifier.
        input_ids: [$($input_id:ident),*],

        // Types of the function arguments (may reference `$generics`).
        input_tys: [$($input_ty:ty),*],

        // Types of the function arguments as should be put in interned struct.
        interned_input_tys: [$($interned_input_ty:ty),*],

        // Return type of the function (may reference `$generics`).
        output_ty: $output_ty:ty,

        // Function body, may reference identifiers defined in `$input_pats` and the generics from `$generics`
        inner_fn: {$($inner_fn:tt)*},

        // Path to the cycle recovery function to use.
        cycle_recovery_fn: ($($cycle_recovery_fn:tt)*),

        // Path to function to get the initial value to use for cycle recovery.
        cycle_recovery_initial: ($($cycle_recovery_initial:tt)*),

        // Name of cycle recovery strategy variant to use.
        cycle_recovery_strategy: $cycle_recovery_strategy:ident,

        // If true, this is specifiable.
        is_specifiable: $is_specifiable:tt,

        // Equality check strategy function
        values_equal: {$($values_equal:tt)+},

        // If true, the input needs an interner (because it has >1 argument).
        needs_interner: $needs_interner:tt,

        // The function used to implement `C::heap_size`.
        heap_size_fn: $($heap_size_fn:path)?,

        // The eviction policy type for this function
        eviction: $Eviction:ty,

        // LRU capacity (a literal, maybe 0)
        lru: $lru:tt,

        // The return mode for the function, see `salsa_macros::options::Option::returns`
        return_mode: $return_mode:tt,

        // If true, the input and output values implement `serde::{Serialize, Deserialize}`.
        persist: $persist:tt,

        assert_types_are_update: {$($assert_types_are_update:tt)*},

        $(self_ty: $self_ty:ty,)?

        // Annoyingly macro-rules hygiene does not extend to items defined in the macro.
        // We have the procedural macro generate names for those items that are
        // not used elsewhere in the user's code.
        unused_names: [
            $zalsa:ident,
            $Configuration:ident,
            $InternedData:ident,
            $FN_CACHE:ident,
            $INTERN_CACHE:ident,
            $inner:ident,
        ]
    ) => {
        // Suppress this clippy lint because we sometimes require `'db` where the ordinary Rust rules would not.
        #[allow(clippy::needless_lifetimes)]
        $(#[$attr])*
        $vis fn $fn_name<$db_lt>(
            $db: &$db_lt dyn $Db,
            $($input_id: $input_ty,)*
        ) -> ::salsa::plumbing::return_mode_ty!(($return_mode, __), $db_lt, $output_ty) {
            use ::salsa::plumbing as $zalsa;

            $zalsa::attach($db, || {
                let (zalsa, zalsa_local) = $db.zalsas();
                let result = $zalsa::macro_if! {
                    if $needs_interner {
                        {
                            let key = $fn_name::intern_ingredient_(zalsa).intern_id(zalsa, zalsa_local, ($($input_id),*), |_, data| data);
                            $fn_name::fn_ingredient_($db, zalsa).fetch($db, zalsa, zalsa_local, key)
                        }
                    } else {
                        {
                            $fn_name::fn_ingredient_($db, zalsa).fetch($db, zalsa, zalsa_local, $zalsa::AsId::as_id(&($($input_id),*)))
                        }
                    }
                };

                $zalsa::return_mode_expression!(($return_mode, __), $output_ty, result,)
            })
        }

        // The module needs be last in the macro expansion in order to make the tracked
        // function's ident be identified as a function, not a struct, during semantic highlighting.
        // for more details, see https://github.com/salsa-rs/salsa/pull/612.
        #[doc(hidden)]
        #[allow(non_camel_case_types)]
        $vis struct $fn_name {
            _priv: ::std::convert::Infallible,
        }

        const _: () = {
            use ::salsa::plumbing as $zalsa;

            struct $Configuration;

            $zalsa::register_jar! {
                $zalsa::ErasedJar::erase::<$fn_name>()
            }

            impl $zalsa::HasJar for $fn_name {
                type Jar = $fn_name;
                const KIND: $zalsa::JarKind = $zalsa::JarKind::TrackedFn;
            }

            static $FN_CACHE: $zalsa::IngredientCache<$zalsa::function::IngredientImpl<$Configuration>> =
                $zalsa::IngredientCache::new();

            $zalsa::macro_if! {
                if $needs_interner {
                    #[derive(Copy, Clone)]
                    struct $InternedData<$db_lt>(
                        ::salsa::Id,
                        ::std::marker::PhantomData<fn() -> &$db_lt ()>,
                    );

                    static $INTERN_CACHE: $zalsa::IngredientCache<$zalsa::interned::IngredientImpl<$Configuration>> =
                        $zalsa::IngredientCache::new();

                    impl $zalsa::SalsaStructInDb for $InternedData<'_> {
                        type MemoIngredientMap = $zalsa::MemoIngredientSingletonIndex;
                        const LEAF_TYPE_IDS: &'static [$zalsa::ConstTypeId] = &[$zalsa::ConstTypeId::of::<$InternedData>()];

                        fn lookup_ingredient_index(aux: &$zalsa::Zalsa) -> $zalsa::IngredientIndices {
                            $zalsa::IngredientIndices::empty()
                        }

                        fn entries(
                            zalsa: &$zalsa::Zalsa
                        ) -> impl Iterator<Item = $zalsa::DatabaseKeyIndex> + '_ {
                            let ingredient_index = zalsa.lookup_jar_by_type::<$fn_name>().successor(0);
                            <$Configuration>::intern_ingredient(zalsa).entries(zalsa).map(|entry| entry.key())
                        }

                        #[inline]
                        fn cast(id: $zalsa::Id, type_id: ::core::any::TypeId) -> Option<Self> {
                            if type_id == ::core::any::TypeId::of::<$InternedData>() {
                                Some($InternedData(id, ::core::marker::PhantomData))
                            } else {
                                None
                            }
                        }

                        #[inline]
                        unsafe fn memo_table(
                            zalsa: &$zalsa::Zalsa,
                            id: $zalsa::Id,
                            current_revision: $zalsa::Revision,
                        ) -> $zalsa::MemoTableWithTypes<'_> {
                            // SAFETY: Guaranteed by caller.
                            unsafe { zalsa.table().memos::<$zalsa::interned::Value<$Configuration>>(id, current_revision) }
                        }
                    }

                    impl $zalsa::AsId for $InternedData<'_> {
                        #[inline]
                        fn as_id(&self) -> ::salsa::Id {
                            self.0
                        }
                    }

                    impl $zalsa::FromId for $InternedData<'_> {
                        #[inline]
                        fn from_id(id: ::salsa::Id) -> Self {
                            Self(id, ::core::marker::PhantomData)
                        }
                    }

                    impl $zalsa::interned::Configuration for $Configuration {
                        const LOCATION: $zalsa::Location = $zalsa::Location {
                            file: file!(),
                            line: line!(),
                        };
                        const DEBUG_NAME: &'static str = concat!($(stringify!($self_ty), "::",)? stringify!($fn_name), "::interned_arguments");
                        const PERSIST: bool = $persist;

                        type Fields<$db_lt> = ($($interned_input_ty),*);

                        type Struct<$db_lt> = $InternedData<$db_lt>;

                        fn serialize<S: $zalsa::serde::Serializer>(
                            fields: &Self::Fields<'_>,
                            serializer: S,
                        ) -> ::std::result::Result<S::Ok, S::Error> {
                            $zalsa::macro_if! {
                                if $persist {
                                    $zalsa::serde::Serialize::serialize(fields, serializer)
                                } else {
                                    panic!("attempted to serialize value not marked with `persist` attribute")
                                }
                            }
                        }

                        fn deserialize<'de, D: $zalsa::serde::Deserializer<'de>>(
                            deserializer: D,
                        ) -> ::std::result::Result<Self::Fields<'static>, D::Error> {
                            $zalsa::macro_if! {
                                if $persist {
                                    $zalsa::serde::Deserialize::deserialize(deserializer)
                                } else {
                                    panic!("attempted to deserialize value not marked with `persist` attribute")
                                }
                            }
                        }
                    }
                } else {
                    type $InternedData<$db_lt> = ($($interned_input_ty),*);

                    $zalsa::macro_if! { $persist =>
                        const fn query_input_is_persistable<T>()
                        where
                            T: $zalsa::serde::Serialize + for<'de> $zalsa::serde::Deserialize<'de>,
                        {
                        }

                        fn assert_query_input_is_persistable<$db_lt>() {
                            query_input_is_persistable::<$($interned_input_ty),*>();
                        }
                    }
                }
            }

            impl $Configuration {
                fn fn_ingredient(db: &dyn $Db) -> &$zalsa::function::IngredientImpl<$Configuration> {
                    let zalsa = db.zalsa();
                    Self::fn_ingredient_(db, zalsa)
                }

                #[inline]
                fn fn_ingredient_<'z>(db: &dyn $Db, zalsa: &'z $zalsa::Zalsa) -> &'z $zalsa::function::IngredientImpl<$Configuration> {
                    // SAFETY: `lookup_jar_by_type` returns a valid ingredient index, and the first
                    // ingredient created by our jar is the function ingredient.
                    unsafe {
                        $FN_CACHE.get_or_create(zalsa, || zalsa.lookup_jar_by_type::<$fn_name>())
                    }
                    .get_or_init(|| *<dyn $Db as $Db>::zalsa_register_downcaster(db))
                }

                pub fn fn_ingredient_mut(db: &mut dyn $Db) -> &mut $zalsa::function::IngredientImpl<Self> {
                    let view = *<dyn $Db as $Db>::zalsa_register_downcaster(db);
                    let zalsa_mut = db.zalsa_mut();
                    let index = zalsa_mut.lookup_jar_by_type::<$fn_name>();
                    let (ingredient, _) = zalsa_mut.lookup_ingredient_mut(index);
                    let ingredient = ingredient.assert_type_mut::<$zalsa::function::IngredientImpl<Self>>();
                    ingredient.get_or_init(|| view);
                    ingredient
                }

                $zalsa::macro_if! { $needs_interner =>
                    fn intern_ingredient(
                        zalsa: &$zalsa::Zalsa,
                    ) -> &$zalsa::interned::IngredientImpl<$Configuration> {
                        Self::intern_ingredient_(zalsa)
                    }

                    #[inline]
                    fn intern_ingredient_<'z>(
                        zalsa: &'z $zalsa::Zalsa
                    ) -> &'z $zalsa::interned::IngredientImpl<$Configuration> {
                        // SAFETY: `lookup_jar_by_type` returns a valid ingredient index, and the second
                        // ingredient created by our jar is the interned ingredient (given `needs_interner`).
                        unsafe {
                            $INTERN_CACHE.get_or_create(zalsa, || {
                                zalsa.lookup_jar_by_type::<$fn_name>().successor(0)
                            })
                        }
                    }
                }
            }

            impl $zalsa::function::Configuration for $Configuration {
                const LOCATION: $zalsa::Location = $zalsa::Location {
                    file: file!(),
                    line: line!(),
                };
                const DEBUG_NAME: &'static str = concat!($(stringify!($self_ty), "::", )? stringify!($fn_name));
                const PERSIST: bool = $persist;

                type DbView = dyn $Db;

                type SalsaStruct<$db_lt> = $InternedData<$db_lt>;

                type Input<$db_lt> = ($($interned_input_ty),*);

                type Output<$db_lt> = $output_ty;

                type Eviction = $Eviction;

                const CYCLE_STRATEGY: $zalsa::CycleRecoveryStrategy = $zalsa::CycleRecoveryStrategy::$cycle_recovery_strategy;

                $($values_equal)+

                $(
                    fn heap_size(value: &Self::Output<'_>) -> Option<usize> {
                        Some($heap_size_fn(value))
                    }
                )?

                fn execute<$db_lt>($db: &$db_lt Self::DbView, ($($input_id),*): ($($interned_input_ty),*)) -> Self::Output<$db_lt> {
                    $($assert_types_are_update)*

                    $($inner_fn)*

                    $inner($db, $($input_id),*)
                }

                fn cycle_initial<$db_lt>(db: &$db_lt Self::DbView, id: ::salsa::Id, ($($input_id),*): ($($interned_input_ty),*)) -> Self::Output<$db_lt> {
                    $($cycle_recovery_initial)*(db, id, $($input_id),*)
                }

                fn recover_from_cycle<$db_lt>(
                    db: &$db_lt dyn $Db,
                    cycle: &::salsa::Cycle,
                    last_provisional_value: &Self::Output<$db_lt>,
                    value: Self::Output<$db_lt>,
                    ($($input_id),*): ($($interned_input_ty),*)
                ) -> Self::Output<$db_lt> {
                    $($cycle_recovery_fn)*(db, cycle, last_provisional_value, value, $($input_id),*)
                }

                fn id_to_input<$db_lt>(zalsa: &$db_lt $zalsa::Zalsa, key: ::salsa::Id) -> Self::Input<$db_lt> {
                    $zalsa::macro_if! {
                        if $needs_interner {
                            $Configuration::intern_ingredient_(zalsa).data(zalsa, key).clone()
                        } else {
                            $zalsa::FromIdWithDb::from_id(key, zalsa)
                        }
                    }
                }

                fn serialize<S: $zalsa::serde::Serializer>(
                    value: &Self::Output<'_>,
                    serializer: S,
                ) -> ::std::result::Result<S::Ok, S::Error> {
                    $zalsa::macro_if! {
                        if $persist {
                            $zalsa::serde::Serialize::serialize(value, serializer)
                        } else {
                            panic!("attempted to serialize value not marked with `persist` attribute")
                        }
                    }
                }

                fn deserialize<'de, D: $zalsa::serde::Deserializer<'de>>(
                    deserializer: D,
                ) -> ::std::result::Result<Self::Output<'static>, D::Error> {
                    $zalsa::macro_if! {
                        if $persist {
                            $zalsa::serde::Deserialize::deserialize(deserializer)
                        } else {
                            panic!("attempted to deserialize value not marked with `persist` attribute")
                        }
                    }
                }
            }

            impl $zalsa::Jar for $fn_name {
                fn create_ingredients(
                    zalsa: &mut $zalsa::Zalsa,
                    first_index: $zalsa::IngredientIndex,
                ) -> Vec<Box<dyn $zalsa::Ingredient>> {
                    let struct_index: $zalsa::IngredientIndices = $zalsa::macro_if! {
                        if $needs_interner {
                            first_index.successor(0).into()
                        } else {
                            // Note that struct ingredients are created before tracked functions,
                            // so this cannot panic.
                            <$InternedData as $zalsa::SalsaStructInDb>::lookup_ingredient_index(zalsa)
                        }
                    };

                    $zalsa::macro_if! { $needs_interner =>
                        let mut intern_ingredient = <$zalsa::interned::IngredientImpl<$Configuration>>::new(
                            first_index.successor(0)
                        );
                    }

                    let intern_ingredient_memo_types = $zalsa::macro_if! {
                        if $needs_interner {
                            Some($zalsa::Ingredient::memo_table_types_mut(&mut intern_ingredient))
                        } else {
                            None
                        }
                    };
                    // SAFETY: We call with the correct memo types.
                    let memo_ingredient_indices = unsafe {
                        $zalsa::NewMemoIngredientIndices::create(
                            zalsa,
                            struct_index,
                            first_index,
                            $zalsa::function::MemoEntryType::of::<$zalsa::function::Memo<$Configuration>>(),
                            intern_ingredient_memo_types,
                        )
                    };

                    let fn_ingredient = <$zalsa::function::IngredientImpl<$Configuration>>::new(
                        first_index,
                        memo_ingredient_indices,
                        $lru,
                    );
                    $zalsa::macro_if! {
                        if $needs_interner {
                            vec![
                                Box::new(fn_ingredient),
                                Box::new(intern_ingredient),
                            ]
                        } else {
                            vec![
                                Box::new(fn_ingredient),
                            ]
                        }
                    }
                }

                fn id_struct_type_id() -> $zalsa::TypeId {
                    $zalsa::TypeId::of::<$InternedData<'static>>()
                }
            }

            impl $fn_name {
                $zalsa::gate_accumulated! {
                    pub fn accumulated<$db_lt, A: ::salsa::Accumulator>(
                        $db: &$db_lt dyn $Db,
                        $($input_id: $interned_input_ty,)*
                    ) -> Vec<&$db_lt A> {
                        use ::salsa::plumbing as $zalsa;
                        let key = $zalsa::macro_if! {
                            if $needs_interner {{
                                let (zalsa, zalsa_local) = $db.zalsas();
                                $Configuration::intern_ingredient(zalsa).intern_id(zalsa, zalsa_local, ($($input_id),*), |_, data| data)
                            }} else {
                                $zalsa::AsId::as_id(&($($input_id),*))
                            }
                        };

                        $Configuration::fn_ingredient($db).accumulated_by::<A>($db, key)
                    }
                }

                $zalsa::macro_if! { $is_specifiable =>
                    pub fn specify<$db_lt>(
                        $db: &$db_lt dyn $Db,
                        $($input_id: $interned_input_ty,)*
                        value: $output_ty,
                    ) {
                        let key = $zalsa::AsId::as_id(&($($input_id),*));
                        $Configuration::fn_ingredient($db).specify_and_record(
                            $db,
                            key,
                            value,
                        )
                    }
                }

                /// Sets the lru capacity
                ///
                /// **WARNING:** Just like an ordinary write, this method triggers
                /// cancellation. If you invoke it while a snapshot exists, it
                /// will block until that snapshot is dropped -- if that snapshot
                /// is owned by the current thread, this could trigger deadlock.
                fn set_lru_capacity(db: &mut dyn $Db, value: usize) where for<'trivial_bounds> $Eviction: $zalsa::function::HasCapacity {
                    $Configuration::fn_ingredient_mut(db).set_capacity(value);
                }

                $zalsa::macro_if! { $needs_interner =>
                    #[inline]
                    fn intern_ingredient_(
                        zalsa: &$zalsa::Zalsa,
                    ) -> &$zalsa::interned::IngredientImpl<$Configuration> {
                        $Configuration::intern_ingredient_(zalsa)
                    }
                }

                #[inline]
                fn fn_ingredient_<'z>(db: &dyn $Db, zalsa: &'z $zalsa::Zalsa) -> &'z $zalsa::function::IngredientImpl<$Configuration> {
                    $Configuration::fn_ingredient_(db, zalsa)
                }
            }
        };
    };
}