jingle 0.5.4

SMT Modeling for Ghidra's PCODE
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use std::{
    any::{Any, TypeId},
    collections::HashMap,
    sync::OnceLock,
};

use crate::analysis::cpa::state::AbstractState;

type StrengthenFn = fn(&mut dyn Any, &dyn Any);

/// A factory wrapper used with `inventory` so each registration can provide
/// the pair `(TypeId of target, TypeId of other, StrengthenFn)` at runtime.
pub struct StrengthenFactory(pub fn() -> (TypeId, TypeId, StrengthenFn));

inventory::collect!(StrengthenFactory);

#[macro_export]
/// [AbstractState]s that can Strengthen other states can be registered through
/// this function. The first argument, the target state type, gets strengthened
/// by the second argument, the source state type, using the third argument, a
/// function that takes a target state as a mutable reference and the source state
/// as a const reference.
///
/// For a strengthen implementation to be sound with respect to the CPA literature,
/// it must ensure that the strengthened state is <= the original version.
macro_rules! register_strengthen {
    ($Target:ty, $Source:ty, $func:path) => {
        const _: () = {
            // wrapper used to adapt the concrete fn signature `fn(&$Target, &$Source) -> Option<$Target>`
            // into the registry-required `fn(&dyn Any, &dyn Any) -> Option<Box<dyn Any>>`.
            fn wrapper(a: &mut dyn std::any::Any, b: &dyn std::any::Any) {
                let a = a.downcast_mut::<$Target>();
                let b = b.downcast_ref::<$Source>();
                if let Some(a) = a
                    && let Some(b) = b
                {
                    ($func)(a, b);
                }
            }

            // factory function (concrete fn pointer) that returns the triple the registry expects.
            fn factory() -> (
                std::any::TypeId,
                std::any::TypeId,
                fn(&mut dyn std::any::Any, &dyn std::any::Any),
            ) {
                (
                    std::any::TypeId::of::<$Target>(),
                    std::any::TypeId::of::<$Source>(),
                    wrapper,
                )
            }

            // Submit the factory to inventory so it is discovered at link time.
            inventory::submit! {
                $crate::analysis::compound::strengthen::StrengthenFactory(factory)
            }
        };
    };
}

static STRENGTHEN_REGISTRY: OnceLock<HashMap<(TypeId, TypeId), StrengthenFn>> = OnceLock::new();

fn build_strengthen_registry() -> HashMap<(TypeId, TypeId), StrengthenFn> {
    let mut m = HashMap::new();
    for f in inventory::iter::<StrengthenFactory> {
        let (a, b, fun) = (f.0)();
        m.insert((a, b), fun);
    }
    m
}

fn register_lookup(src: TypeId, other: TypeId) -> Option<StrengthenFn> {
    let map = STRENGTHEN_REGISTRY.get_or_init(build_strengthen_registry);
    map.get(&(src, other)).copied()
}

pub trait ComponentStrengthen: 'static {
    /// Attempt to strengthen `self` using information from `other`.
    ///
    /// The default implementation performs a lookup in the inventory-backed
    /// registry of strengthening functions keyed by `(TypeId of Self, TypeId of other)`.
    /// Registered functions have signature `fn(&dyn Any, &dyn Any) -> Option<Box<dyn Any>>`
    /// and are expected to return a boxed concrete `Self` on success.
    fn try_strengthen(&mut self, other: &dyn Any)
    where
        Self: Sized,
    {
        if let Some(func) = register_lookup(TypeId::of::<Self>(), other.type_id()) {
            func(self as &mut dyn Any, other)
        }
    }
}

/// Strengthening impls are registered at link time and dynamically fetched
/// at runtime using [inventory]. This trait is therefore implemented for all
/// states, since every state can query the registry.
impl<T: AbstractState> ComponentStrengthen for T where T: 'static {}