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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
#![deny(warnings)]
#![allow(clippy::new_without_default)]

pub use vsdb::{RawBytes, RawKey, RawValue, ValueEnDe};

use ruc::*;
use serde::{Deserialize, Serialize};
use sp_trie::{
    cache::{LocalTrieCache, TrieCache},
    trie_types::{TrieDB, TrieDBMutBuilderV1 as TrieDBMutBuilder, TrieDBMutV1 as TrieDBMut},
    LayoutV1, Trie, TrieDBBuilder, TrieHash, TrieMut,
};
use std::mem;
use vsdb::basic::mapx_ord_rawkey::MapxOrdRawKey;
use vsdb_hash_db::{
    sp_trie_db::{CError, DBValue, HashDB, Hasher as _, TrieItem, TrieIterator, TrieKeyItem},
    KeccakHasher as H, TrieBackend,
};

type L = LayoutV1<H>;
pub type TrieRoot = TrieHash<L>;

pub type TrieIter<'a> = Box<dyn TrieIterator<L, Item = TrieItem<TrieHash<L>, CError<L>>> + 'a>;
pub type TrieKeyIter<'a> =
    Box<dyn TrieIterator<L, Item = TrieKeyItem<TrieHash<L>, CError<L>>> + 'a>;

#[derive(Deserialize, Serialize)]
pub struct MptStore {
    // backend key ==> backend instance
    //
    // the backend key
    // - for the world state MPT, it is `[0]`
    // - for the storage MPT, it is the bytes of a H160 address
    meta: MapxOrdRawKey<TrieBackend>,
}

impl MptStore {
    pub fn new() -> Self {
        Self {
            meta: MapxOrdRawKey::new(),
        }
    }

    pub fn trie_remove(&self, backend_key: &[u8]) {
        self.remove_backend(backend_key);
    }

    pub fn trie_create(
        &self,
        backend_key: &[u8],
        cache_size: Option<usize>,
        reset: bool,
    ) -> Result<MptOnce> {
        let backend = MptStore::new_backend(cache_size);
        self.put_backend(backend_key, &backend, reset).c(d!())?;

        MptOnce::create_with_backend(backend).c(d!())
    }

    /// @param cache_size:
    ///     - None, do nothing
    ///     - Some(0 or an negative value), disable cache
    ///     - Some(a positive value), reset the cache capacity to the new size
    pub fn trie_restore(
        &self,
        backend_key: &[u8],
        new_cache_size: Option<isize>,
        root: TrieRoot,
    ) -> Result<MptOnce> {
        let mut backend = self.get_backend(backend_key).c(d!("backend not found"))?;
        if let Some(n) = new_cache_size {
            if 0 < n {
                backend.reset_cache(Some(n as usize));
            } else {
                backend.reset_cache(None);
            }
        }
        MptOnce::restore(backend, root).c(d!())
    }

    fn get_backend(&self, backend_key: &[u8]) -> Option<TrieBackend> {
        self.meta.get(backend_key)
    }

    fn put_backend(&self, backend_key: &[u8], backend: &TrieBackend, reset: bool) -> Result<()> {
        let mut hdr = unsafe { self.meta.shadow() };

        if reset {
            hdr.remove(backend_key);
        } else if hdr.contains_key(backend_key) {
            return Err(eg!("backend key already exists"));
        }

        hdr.insert(backend_key, backend);

        Ok(())
    }

    fn remove_backend(&self, backend_key: &[u8]) {
        unsafe { self.meta.shadow() }.remove(backend_key);
    }

    fn new_backend(cache_size: Option<usize>) -> TrieBackend {
        TrieBackend::new(cache_size)
    }
}

//
// # NOTE
//
// The referenced field **MUST** be placed after the field that references it,
// this is to ensure that the `Drop::drop` can be executed in the correct order,
// so that UB will not occur
/// An owned MPT instance
pub struct MptOnce {
    mpt: MptMut<'static>,
    root: TrieRoot,

    // self-reference
    #[allow(dead_code)]
    backend: Box<TrieBackend>,
}

impl MptOnce {
    pub fn create(cache_size: Option<usize>) -> Result<Self> {
        Self::create_with_backend(TrieBackend::new(cache_size)).c(d!())
    }

    pub fn create_with_backend(backend: TrieBackend) -> Result<Self> {
        let backend = Box::into_raw(Box::new(backend));
        let mut mpt = MptMut::new(unsafe { &mut *backend });
        let root = mpt.commit();
        Ok(Self {
            mpt,
            root,
            backend: unsafe { Box::from_raw(backend) },
        })
    }

    pub fn restore(backend: TrieBackend, root: TrieRoot) -> Result<Self> {
        let backend = Box::into_raw(Box::new(backend));
        let mpt = MptMut::from_existing(unsafe { &mut *backend }, root);
        Ok(Self {
            mpt,
            root,
            backend: unsafe { Box::from_raw(backend) },
        })
    }

    pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
        self.mpt.get(key).c(d!())
    }

    pub fn contains(&self, key: &[u8]) -> Result<bool> {
        self.mpt.contains(key).c(d!())
    }

    pub fn insert(&mut self, key: &[u8], value: &[u8]) -> Result<()> {
        self.mpt.insert(key, value).c(d!())
    }

    pub fn remove(&mut self, key: &[u8]) -> Result<()> {
        self.mpt.remove(key).c(d!()).map(|_| ())
    }

    pub fn clear(&mut self) -> Result<()> {
        self.mpt.clear().c(d!())
    }

    pub fn is_empty(&self) -> bool {
        self.mpt.is_empty()
    }

    pub fn commit(&mut self) -> TrieRoot {
        self.root = self.mpt.commit();
        self.root
    }

    pub fn root(&self) -> TrieRoot {
        self.root
    }

    pub fn ro_handle(&self, root: TrieRoot) -> MptRo {
        MptRo::from_existing(&self.backend, root)
    }
}

impl ValueEnDe for MptOnce {
    fn try_encode(&self) -> Result<RawBytes> {
        Ok(self.encode())
    }

    fn encode(&self) -> RawBytes {
        let mut buf = self.root.to_vec();
        buf.append(&mut self.backend.encode());
        buf
    }

    fn decode(bytes: &[u8]) -> Result<Self> {
        alt!(H::LENGTH > bytes.len(), return Err(eg!("Invalid length")));

        let mut root = [0; H::LENGTH];
        root.copy_from_slice(&bytes[..H::LENGTH]);

        let backend = TrieBackend::decode(&bytes[H::LENGTH..]).c(d!())?;

        Self::restore(backend, root).c(d!())
    }
}

//
// # NOTE
//
// The referenced field **MUST** be placed after the field that references it,
// this is to ensure that the `drop`s can be executed in the correct order,
// so that UB will not occur
/// A mutable MPT instance
pub struct MptMut<'a> {
    trie: TrieDBMut<'a, H>,

    // self-reference
    #[allow(dead_code)]
    meta: MptMeta<'a>,
}

impl<'a> MptMut<'a> {
    // keep private !!
    pub fn new(backend: &'a mut TrieBackend) -> Self {
        let lc = backend.get_cache_hdr().map(|hdr| hdr.local_cache());

        // The buf will be rewrited when building the target `Trie`,
        // so its original contents can be arbitrary values.
        let root_buf = Default::default();

        let meta = MptMeta::new(lc, root_buf, true);

        let trie = TrieDBMutBuilder::new(backend, unsafe { &mut *meta.root })
            .with_optional_cache(
                meta.cache
                    .as_ref()
                    .map(|c| unsafe { &mut *c.cache } as &mut dyn sp_trie::TrieCache<_>),
            )
            .build();

        Self { trie, meta }
    }

    pub fn from_existing(backend: &'a mut TrieBackend, root: TrieRoot) -> Self {
        let lc = backend.get_cache_hdr().map(|hdr| hdr.local_cache());
        let meta = MptMeta::new(lc, root, true);

        let trie = TrieDBMutBuilder::from_existing(backend, unsafe { &mut *meta.root })
            .with_optional_cache(
                meta.cache
                    .as_ref()
                    .map(|c| unsafe { &mut *c.cache } as &mut dyn sp_trie::TrieCache<_>),
            )
            .build();

        Self { trie, meta }
    }

    pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
        self.trie.get(key).c(d!())
    }

    pub fn contains(&self, key: &[u8]) -> Result<bool> {
        self.trie.contains(key).c(d!())
    }

    pub fn insert(&mut self, key: &[u8], value: &[u8]) -> Result<()> {
        self.trie.insert(key, value).c(d!()).map(|_| ())
    }

    pub fn remove(&mut self, key: &[u8]) -> Result<()> {
        self.trie.remove(key).c(d!()).map(|_| ())
    }

    pub fn clear(&mut self) -> Result<()> {
        let root = self.commit();
        let keys = self.ro_handle(root).key_iter().collect::<Vec<_>>();
        for k in keys.iter().map(|k| k.as_ref().unwrap()) {
            self.remove(k).c(d!())?;
        }
        Ok(())
    }

    pub fn is_empty(&self) -> bool {
        self.trie.is_empty()
    }

    pub fn commit(&mut self) -> TrieRoot {
        *self.trie.root()
    }

    pub fn ro_handle(&self, root: TrieRoot) -> MptRo {
        MptRo::from_existing_dyn(self.trie.db(), root)
    }
}

//
// # NOTE
//
// The referenced field **MUST** be placed after the field that references it,
// this is to ensure that the `drop`s can be executed in the correct order,
// so that UB will not occur
/// A readonly MPT instance
pub struct MptRo<'a> {
    trie: TrieDB<'a, 'a, H>,

    // self-reference
    #[allow(dead_code)]
    meta: MptMeta<'a>,
}

impl<'a> MptRo<'a> {
    pub fn from_existing(backend: &'a TrieBackend, root: TrieRoot) -> Self {
        let lc = backend.get_cache_hdr().map(|hdr| hdr.local_cache());
        let meta = MptMeta::new(lc, root, false);

        let trie = TrieDBBuilder::new(backend, unsafe { &*meta.root })
            .with_optional_cache(
                meta.cache
                    .as_ref()
                    .map(|c| unsafe { &mut *c.cache } as &mut dyn sp_trie::TrieCache<_>),
            )
            .build();

        Self { trie, meta }
    }

    pub fn from_existing_dyn(backend: &dyn HashDB<H, DBValue>, root: TrieRoot) -> Self {
        let backend = &backend as *const &dyn HashDB<H, DBValue>;
        let backend = backend.cast::<&TrieBackend>();
        let backend = unsafe { *backend };
        MptRo::from_existing(backend, root)
    }

    pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
        self.trie.get(key).c(d!())
    }

    pub fn contains(&self, key: &[u8]) -> Result<bool> {
        self.trie.contains(key).c(d!())
    }

    pub fn iter(&self) -> TrieIter<'_> {
        pnk!(self.trie.iter())
    }

    pub fn key_iter(&self) -> TrieKeyIter<'_> {
        pnk!(self.trie.key_iter())
    }

    pub fn root(&mut self) -> TrieRoot {
        *self.trie.root()
    }
}

struct MptMeta<'a> {
    // self-reference
    #[allow(dead_code)]
    cache: Option<LayeredCache<'a>>,

    // self-reference
    #[allow(dead_code)]
    root: *mut TrieRoot,
}

impl<'a> MptMeta<'a> {
    fn new(lc: Option<LocalTrieCache<H>>, root: TrieRoot, mutable: bool) -> Self {
        Self {
            cache: lc.map(|lc| LayeredCache::new(lc, alt!(mutable, None, Some(root)))),
            root: Box::into_raw(Box::new(root)),
        }
    }
}

// The raw pointers in `LayeredCache` will be dropped here
impl Drop for MptMeta<'_> {
    fn drop(&mut self) {
        unsafe {
            drop(Box::from_raw(self.root));
            if let Some(c) = mem::take(&mut self.cache) {
                Box::from_raw(c.cache).merge_into(&Box::from_raw(c.local_cache), *self.root);
            }
        }
    }
}

struct LayeredCache<'a> {
    // self-reference
    #[allow(dead_code)]
    cache: *mut TrieCache<'a, H>,

    // self-reference
    #[allow(dead_code)]
    local_cache: *mut LocalTrieCache<H>,
}

impl<'a> LayeredCache<'a> {
    fn new(lc: LocalTrieCache<H>, root: Option<TrieRoot>) -> Self {
        let lc = Box::into_raw(Box::new(lc));

        let cache = if let Some(root) = root {
            Box::into_raw(Box::new(unsafe { &*lc }.as_trie_db_cache(root)))
        } else {
            Box::into_raw(Box::new(unsafe { &*lc }.as_trie_db_mut_cache()))
        };

        Self {
            cache,
            local_cache: lc,
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use std::collections::BTreeMap;

    #[test]
    fn encode_decode() {
        let mut hdr = pnk!(MptOnce::create(None));

        pnk!(hdr.insert(b"key", b"value"));
        assert_eq!(b"value", pnk!(hdr.get(b"key")).unwrap().as_slice());

        let root = hdr.commit();
        assert_eq!(root, hdr.root());

        let hdr_encoded = hdr.encode();
        drop(hdr);

        let hdr = pnk!(MptOnce::decode(&hdr_encoded));
        assert_eq!(b"value", pnk!(hdr.get(b"key")).unwrap().as_slice());
    }

    #[test]
    fn iter() {
        iter_run(None);
    }

    #[test]
    fn iter_with_cache() {
        iter_run(Some(1024))
    }

    fn iter_run(cache_size: Option<usize>) {
        let s = MptStore::new();
        let mut hdr = pnk!(s.trie_create(b"backend_key", cache_size, false));

        {
            let samples = (0u8..200).map(|i| ([i], [i])).collect::<Vec<_>>();
            samples.iter().for_each(|(k, v)| {
                pnk!(hdr.insert(k, v));
            });

            let root = hdr.commit();

            let ro_hdr = hdr.ro_handle(root);
            let bt = ro_hdr
                .iter()
                .map(|i| i.unwrap())
                .collect::<BTreeMap<_, _>>();

            bt.iter().enumerate().for_each(|(i, (k, v))| {
                assert_eq!(&[i as u8], k.as_slice());
                assert_eq!(k, v);
            });

            let keylist = ro_hdr.key_iter().map(|i| i.unwrap()).collect::<Vec<_>>();
            assert_eq!(keylist, bt.keys().cloned().collect::<Vec<_>>());
        }

        {
            let samples = (0u8..200).map(|i| ([i], [i + 1])).collect::<Vec<_>>();
            samples.iter().for_each(|(k, v)| {
                pnk!(hdr.insert(k, v));
            });

            let root = hdr.commit();

            let ro_hdr = hdr.ro_handle(root);
            let bt = ro_hdr
                .iter()
                .map(|i| i.unwrap())
                .collect::<BTreeMap<_, _>>();

            bt.iter().enumerate().for_each(|(i, (k, v))| {
                assert_eq!(&[i as u8], k.as_slice());
                assert_eq!(&[k[0] + 1], v.as_slice());
            });

            let keylist = ro_hdr.key_iter().map(|i| i.unwrap()).collect::<Vec<_>>();
            assert_eq!(keylist, bt.keys().cloned().collect::<Vec<_>>());
        }

        assert!(!hdr.is_empty());
        hdr.clear().unwrap();
        assert!(hdr.is_empty());
    }
}