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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
use crate::cacheable::Cacheable;
use crate::key::CacheKey;

pub(crate) mod internal {
    use platform_dirs::AppDirs;
    use std::error::Error;
    use std::path::PathBuf;

    use persy::{ByteVec, Config, Persy, ValueMode};

    pub(crate) fn get_cache_dir() -> Result<PathBuf, Box<dyn Error>> {
        let cache_dir = if let Some(cache_dir) =
            AppDirs::new(Some("librashader"), false).map(|a| a.cache_dir)
        {
            cache_dir
        } else {
            let mut current_dir = std::env::current_dir()?;
            current_dir.push("librashader");
            current_dir
        };

        std::fs::create_dir_all(&cache_dir)?;

        Ok(cache_dir)
    }

    // pub(crate) fn get_cache() -> Result<Connection, Box<dyn Error>> {
    //     let cache_dir = get_cache_dir()?;
    //     let mut conn = Connection::open(&cache_dir.join("librashader.db"))?;
    //
    //     let tx = conn.transaction()?;
    //     tx.pragma_update(Some(DatabaseName::Main), "journal_mode", "wal2")?;
    //     tx.execute(
    //         r#"create table if not exists cache (
    //     type text not null,
    //     id blob not null,
    //     value blob not null unique,
    //     primary key (id, type)
    // )"#,
    //         [],
    //     )?;
    //     tx.commit()?;
    //     Ok(conn)
    // }

    pub(crate) fn get_cache() -> Result<Persy, Box<dyn Error>> {
        let cache_dir = get_cache_dir()?;
        let conn = Persy::open_or_create_with(
            &cache_dir.join("librashader.db.1"),
            Config::new(),
            |persy| {
                let tx = persy.begin()?;
                tx.commit()?;
                Ok(())
            },
        )?;
        Ok(conn)
    }

    pub(crate) fn get_blob(
        conn: &Persy,
        index: &str,
        key: &[u8],
    ) -> Result<Option<Vec<u8>>, Box<dyn Error>> {
        if !conn.exists_index(index)? {
            return Ok(None);
        }

        let value = conn.get::<_, ByteVec>(index, &ByteVec::from(key))?.next();
        Ok(value.map(|v| v.to_vec()))
    }

    pub(crate) fn set_blob(
        conn: &Persy,
        index: &str,
        key: &[u8],
        value: &[u8],
    ) -> Result<(), Box<dyn Error>> {
        let mut tx = conn.begin()?;
        if !tx.exists_index(index)? {
            tx.create_index::<ByteVec, ByteVec>(index, ValueMode::Replace)?;
        }

        tx.put(index, ByteVec::from(key), ByteVec::from(value))?;
        tx.commit()?;

        Ok(())
    }
}

/// Cache a shader object (usually bytecode) created by the keyed objects.
///
/// - `factory` is the function that compiles the values passed as keys to a shader object.
/// - `load` tries to load a compiled shader object to a driver-specialized result.
pub fn cache_shader_object<E, T, R, H, const KEY_SIZE: usize>(
    index: &str,
    keys: &[H; KEY_SIZE],
    factory: impl FnOnce(&[H; KEY_SIZE]) -> Result<T, E>,
    load: impl Fn(T) -> Result<R, E>,
    bypass_cache: bool,
) -> Result<R, E>
where
    H: CacheKey,
    T: Cacheable,
{
    if bypass_cache {
        return Ok(load(factory(keys)?)?);
    }

    let cache = internal::get_cache();

    let Ok(cache) = cache else {
        return Ok(load(factory(keys)?)?);
    };

    let hashkey = {
        let mut hasher = blake3::Hasher::new();
        for subkeys in keys {
            hasher.update(subkeys.hash_bytes());
        }
        let hash = hasher.finalize();
        hash
    };

    'attempt: {
        if let Ok(Some(blob)) = internal::get_blob(&cache, index, hashkey.as_bytes()) {
            let cached = T::from_bytes(&blob).map(&load);

            match cached {
                None => break 'attempt,
                Some(Err(_)) => break 'attempt,
                Some(Ok(res)) => return Ok(res),
            }
        }
    };

    let blob = factory(keys)?;

    if let Some(slice) = T::to_bytes(&blob) {
        let _ = internal::set_blob(&cache, index, hashkey.as_bytes(), &slice);
    }
    Ok(load(blob)?)
}

/// Cache a pipeline state object.
///
/// Keys are not used to create the object and are only used to uniquely identify the pipeline state.
///
/// - `restore_pipeline` tries to restore the pipeline with either a cached binary pipeline state
///    cache, or create a new pipeline if no cached value is available.
/// - `fetch_pipeline_state` fetches the new pipeline state cache after the pipeline was created.
pub fn cache_pipeline<E, T, R, const KEY_SIZE: usize>(
    index: &str,
    keys: &[&dyn CacheKey; KEY_SIZE],
    restore_pipeline: impl Fn(Option<Vec<u8>>) -> Result<R, E>,
    fetch_pipeline_state: impl FnOnce(&R) -> Result<T, E>,
    bypass_cache: bool,
) -> Result<R, E>
where
    T: Cacheable,
{
    if bypass_cache {
        return Ok(restore_pipeline(None)?);
    }

    let cache = internal::get_cache();

    let Ok(cache) = cache else {
        return Ok(restore_pipeline(None)?);
    };

    let hashkey = {
        let mut hasher = blake3::Hasher::new();
        for subkeys in keys {
            hasher.update(subkeys.hash_bytes());
        }
        let hash = hasher.finalize();
        hash
    };

    let pipeline = 'attempt: {
        if let Ok(Some(blob)) = internal::get_blob(&cache, index, hashkey.as_bytes()) {
            let cached = restore_pipeline(Some(blob));
            match cached {
                Ok(res) => {
                    break 'attempt res;
                }
                _ => (),
            }
        }

        restore_pipeline(None)?
    };

    // update the pso every time just in case.
    if let Ok(state) = fetch_pipeline_state(&pipeline) {
        if let Some(slice) = T::to_bytes(&state) {
            // We don't really care if the transaction fails, just try again next time.
            let _ = internal::set_blob(&cache, index, hashkey.as_bytes(), &slice);
        }
    }

    Ok(pipeline)
}