aboutsummaryrefslogtreecommitdiffstats
path: root/trie/trie.go
blob: c9fd18e009afb103bcbb2a85423b6c84d2b70cb0 (plain) (blame)
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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
package trie

/*
import (
    "bytes"
    "fmt"
    "sync"

    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethutil"
)

func ParanoiaCheck(t1 *Trie) (bool, *Trie) {
    t2 := New(ethutil.Config.Db, "")

    t1.NewIterator().Each(func(key string, v *ethutil.Value) {
        t2.Update(key, v.Str())
    })

    return bytes.Compare(t2.GetRoot(), t1.GetRoot()) == 0, t2
}

func (s *Cache) Len() int {
    return len(s.nodes)
}

// TODO
// A StateObject is an object that has a state root
// This is goig to be the object for the second level caching (the caching of object which have a state such as contracts)
type StateObject interface {
    State() *Trie
    Sync()
    Undo()
}

type Node struct {
    Key   []byte
    Value *ethutil.Value
    Dirty bool
}

func NewNode(key []byte, val *ethutil.Value, dirty bool) *Node {
    return &Node{Key: key, Value: val, Dirty: dirty}
}

func (n *Node) Copy() *Node {
    return NewNode(n.Key, n.Value, n.Dirty)
}

type Cache struct {
    nodes   map[string]*Node
    db      ethutil.Database
    IsDirty bool
}

func NewCache(db ethutil.Database) *Cache {
    return &Cache{db: db, nodes: make(map[string]*Node)}
}

func (cache *Cache) PutValue(v interface{}, force bool) interface{} {
    value := ethutil.NewValue(v)

    enc := value.Encode()
    if len(enc) >= 32 || force {
        sha := crypto.Sha3(enc)

        cache.nodes[string(sha)] = NewNode(sha, value, true)
        cache.IsDirty = true

        return sha
    }

    return v
}

func (cache *Cache) Put(v interface{}) interface{} {
    return cache.PutValue(v, false)
}

func (cache *Cache) Get(key []byte) *ethutil.Value {
    // First check if the key is the cache
    if cache.nodes[string(key)] != nil {
        return cache.nodes[string(key)].Value
    }

    // Get the key of the database instead and cache it
    data, _ := cache.db.Get(key)
    // Create the cached value
    value := ethutil.NewValueFromBytes(data)

    defer func() {
        if r := recover(); r != nil {
            fmt.Println("RECOVER GET", cache, cache.nodes)
            panic("bye")
        }
    }()
    // Create caching node
    cache.nodes[string(key)] = NewNode(key, value, true)

    return value
}

func (cache *Cache) Delete(key []byte) {
    delete(cache.nodes, string(key))

    cache.db.Delete(key)
}

func (cache *Cache) Commit() {
    // Don't try to commit if it isn't dirty
    if !cache.IsDirty {
        return
    }

    for key, node := range cache.nodes {
        if node.Dirty {
            cache.db.Put([]byte(key), node.Value.Encode())
            node.Dirty = false
        }
    }
    cache.IsDirty = false

    // If the nodes grows beyond the 200 entries we simple empty it
    // FIXME come up with something better
    if len(cache.nodes) > 200 {
        cache.nodes = make(map[string]*Node)
    }
}

func (cache *Cache) Undo() {
    for key, node := range cache.nodes {
        if node.Dirty {
            delete(cache.nodes, key)
        }
    }
    cache.IsDirty = false
}

// A (modified) Radix Trie implementation. The Trie implements
// a caching mechanism and will used cached values if they are
// present. If a node is not present in the cache it will try to
// fetch it from the database and store the cached value.
// Please note that the data isn't persisted unless `Sync` is
// explicitly called.
type Trie struct {
    mut      sync.RWMutex
    prevRoot interface{}
    Root     interface{}
    //db   Database
    cache *Cache
}

func copyRoot(root interface{}) interface{} {
    var prevRootCopy interface{}
    if b, ok := root.([]byte); ok {
        prevRootCopy = ethutil.CopyBytes(b)
    } else {
        prevRootCopy = root
    }

    return prevRootCopy
}

func New(db ethutil.Database, Root interface{}) *Trie {
    // Make absolute sure the root is copied
    r := copyRoot(Root)
    p := copyRoot(Root)

    trie := &Trie{cache: NewCache(db), Root: r, prevRoot: p}
    trie.setRoot(Root)

    return trie
}

func (self *Trie) setRoot(root interface{}) {
    switch t := root.(type) {
    case string:
        //if t == "" {
        //  root = crypto.Sha3(ethutil.Encode(""))
        //}
        self.Root = []byte(t)
    case []byte:
        self.Root = root
    default:
        self.Root = self.cache.PutValue(root, true)
    }
}

func (t *Trie) Update(key, value string) {
    t.mut.Lock()
    defer t.mut.Unlock()

    k := CompactHexDecode(key)

    var root interface{}
    if value != "" {
        root = t.UpdateState(t.Root, k, value)
    } else {
        root = t.deleteState(t.Root, k)
    }
    t.setRoot(root)
}

func (t *Trie) Get(key string) string {
    t.mut.Lock()
    defer t.mut.Unlock()

    k := CompactHexDecode(key)
    c := ethutil.NewValue(t.getState(t.Root, k))

    return c.Str()
}

func (t *Trie) Delete(key string) {
    t.mut.Lock()
    defer t.mut.Unlock()

    k := CompactHexDecode(key)

    root := t.deleteState(t.Root, k)
    t.setRoot(root)
}

func (self *Trie) GetRoot() []byte {
    switch t := self.Root.(type) {
    case string:
        if t == "" {
            return crypto.Sha3(ethutil.Encode(""))
        }
        return []byte(t)
    case []byte:
        if len(t) == 0 {
            return crypto.Sha3(ethutil.Encode(""))
        }

        return t
    default:
        panic(fmt.Sprintf("invalid root type %T (%v)", self.Root, self.Root))
    }
}

// Simple compare function which creates a rlp value out of the evaluated objects
func (t *Trie) Cmp(trie *Trie) bool {
    return ethutil.NewValue(t.Root).Cmp(ethutil.NewValue(trie.Root))
}

// Returns a copy of this trie
func (t *Trie) Copy() *Trie {
    trie := New(t.cache.db, t.Root)
    for key, node := range t.cache.nodes {
        trie.cache.nodes[key] = node.Copy()
    }

    return trie
}

// Save the cached value to the database.
func (t *Trie) Sync() {
    t.cache.Commit()
    t.prevRoot = copyRoot(t.Root)
}

func (t *Trie) Undo() {
    t.cache.Undo()
    t.Root = t.prevRoot
}

func (t *Trie) Cache() *Cache {
    return t.cache
}

func (t *Trie) getState(node interface{}, key []byte) interface{} {
    n := ethutil.NewValue(node)
    // Return the node if key is empty (= found)
    if len(key) == 0 || n.IsNil() || n.Len() == 0 {
        return node
    }

    currentNode := t.getNode(node)
    length := currentNode.Len()

    if length == 0 {
        return ""
    } else if length == 2 {
        // Decode the key
        k := CompactDecode(currentNode.Get(0).Str())
        v := currentNode.Get(1).Raw()

        if len(key) >= len(k) && bytes.Equal(k, key[:len(k)]) { //CompareIntSlice(k, key[:len(k)]) {
            return t.getState(v, key[len(k):])
        } else {
            return ""
        }
    } else if length == 17 {
        return t.getState(currentNode.Get(int(key[0])).Raw(), key[1:])
    }

    // It shouldn't come this far
    panic("unexpected return")
}

func (t *Trie) getNode(node interface{}) *ethutil.Value {
    n := ethutil.NewValue(node)

    if !n.Get(0).IsNil() {
        return n
    }

    str := n.Str()
    if len(str) == 0 {
        return n
    } else if len(str) < 32 {
        return ethutil.NewValueFromBytes([]byte(str))
    }

    data := t.cache.Get(n.Bytes())

    return data
}

func (t *Trie) UpdateState(node interface{}, key []byte, value string) interface{} {
    return t.InsertState(node, key, value)
}

func (t *Trie) Put(node interface{}) interface{} {
    return t.cache.Put(node)

}

func EmptyStringSlice(l int) []interface{} {
    slice := make([]interface{}, l)
    for i := 0; i < l; i++ {
        slice[i] = ""
    }
    return slice
}

func (t *Trie) InsertState(node interface{}, key []byte, value interface{}) interface{} {
    if len(key) == 0 {
        return value
    }

    // New node
    n := ethutil.NewValue(node)
    if node == nil || n.Len() == 0 {
        newNode := []interface{}{CompactEncode(key), value}

        return t.Put(newNode)
    }

    currentNode := t.getNode(node)
    // Check for "special" 2 slice type node
    if currentNode.Len() == 2 {
        // Decode the key

        k := CompactDecode(currentNode.Get(0).Str())
        v := currentNode.Get(1).Raw()

        // Matching key pair (ie. there's already an object with this key)
        if bytes.Equal(k, key) { //CompareIntSlice(k, key) {
            newNode := []interface{}{CompactEncode(key), value}
            return t.Put(newNode)
        }

        var newHash interface{}
        matchingLength := MatchingNibbleLength(key, k)
        if matchingLength == len(k) {
            // Insert the hash, creating a new node
            newHash = t.InsertState(v, key[matchingLength:], value)
        } else {
            // Expand the 2 length slice to a 17 length slice
            oldNode := t.InsertState("", k[matchingLength+1:], v)
            newNode := t.InsertState("", key[matchingLength+1:], value)
            // Create an expanded slice
            scaledSlice := EmptyStringSlice(17)
            // Set the copied and new node
            scaledSlice[k[matchingLength]] = oldNode
            scaledSlice[key[matchingLength]] = newNode

            newHash = t.Put(scaledSlice)
        }

        if matchingLength == 0 {
            // End of the chain, return
            return newHash
        } else {
            newNode := []interface{}{CompactEncode(key[:matchingLength]), newHash}
            return t.Put(newNode)
        }
    } else {

        // Copy the current node over to the new node and replace the first nibble in the key
        newNode := EmptyStringSlice(17)

        for i := 0; i < 17; i++ {
            cpy := currentNode.Get(i).Raw()
            if cpy != nil {
                newNode[i] = cpy
            }
        }

        newNode[key[0]] = t.InsertState(currentNode.Get(int(key[0])).Raw(), key[1:], value)

        return t.Put(newNode)
    }

    panic("unexpected end")
}

func (t *Trie) deleteState(node interface{}, key []byte) interface{} {
    if len(key) == 0 {
        return ""
    }

    // New node
    n := ethutil.NewValue(node)
    //if node == nil || (n.Type() == reflect.String && (n.Str() == "" || n.Get(0).IsNil())) || n.Len() == 0 {
    if node == nil || n.Len() == 0 {
        //return nil
        //fmt.Printf("<empty ret> %x %d\n", n, len(n.Bytes()))

        return ""
    }

    currentNode := t.getNode(node)
    // Check for "special" 2 slice type node
    if currentNode.Len() == 2 {
        // Decode the key
        k := CompactDecode(currentNode.Get(0).Str())
        v := currentNode.Get(1).Raw()

        // Matching key pair (ie. there's already an object with this key)
        if bytes.Equal(k, key) { //CompareIntSlice(k, key) {
            //fmt.Printf("<delete ret> %x\n", v)

            return ""
        } else if bytes.Equal(key[:len(k)], k) { //CompareIntSlice(key[:len(k)], k) {
            hash := t.deleteState(v, key[len(k):])
            child := t.getNode(hash)

            var newNode []interface{}
            if child.Len() == 2 {
                newKey := append(k, CompactDecode(child.Get(0).Str())...)
                newNode = []interface{}{CompactEncode(newKey), child.Get(1).Raw()}
            } else {
                newNode = []interface{}{currentNode.Get(0).Str(), hash}
            }

            //fmt.Printf("%x\n", newNode)

            return t.Put(newNode)
        } else {
            return node
        }
    } else {
        // Copy the current node over to the new node and replace the first nibble in the key
        n := EmptyStringSlice(17)
        var newNode []interface{}

        for i := 0; i < 17; i++ {
            cpy := currentNode.Get(i).Raw()
            if cpy != nil {
                n[i] = cpy
            }
        }

        n[key[0]] = t.deleteState(n[key[0]], key[1:])
        amount := -1
        for i := 0; i < 17; i++ {
            if n[i] != "" {
                if amount == -1 {
                    amount = i
                } else {
                    amount = -2
                }
            }
        }
        if amount == 16 {
            newNode = []interface{}{CompactEncode([]byte{16}), n[amount]}
        } else if amount >= 0 {
            child := t.getNode(n[amount])
            if child.Len() == 17 {
                newNode = []interface{}{CompactEncode([]byte{byte(amount)}), n[amount]}
            } else if child.Len() == 2 {
                key := append([]byte{byte(amount)}, CompactDecode(child.Get(0).Str())...)
                newNode = []interface{}{CompactEncode(key), child.Get(1).Str()}
            }

        } else {
            newNode = n
        }

        //fmt.Printf("%x\n", newNode)
        return t.Put(newNode)
    }

    panic("unexpected return")
}

type TrieIterator struct {
    trie  *Trie
    key   string
    value string

    shas   [][]byte
    values []string

    lastNode []byte
}

func (t *Trie) NewIterator() *TrieIterator {
    return &TrieIterator{trie: t}
}

func (self *Trie) Iterator() *Iterator {
    return NewIterator(self)
}

// Some time in the near future this will need refactoring :-)
// XXX Note to self, IsSlice == inline node. Str == sha3 to node
func (it *TrieIterator) workNode(currentNode *ethutil.Value) {
    if currentNode.Len() == 2 {
        k := CompactDecode(currentNode.Get(0).Str())

        if currentNode.Get(1).Str() == "" {
            it.workNode(currentNode.Get(1))
        } else {
            if k[len(k)-1] == 16 {
                it.values = append(it.values, currentNode.Get(1).Str())
            } else {
                it.shas = append(it.shas, currentNode.Get(1).Bytes())
                it.getNode(currentNode.Get(1).Bytes())
            }
        }
    } else {
        for i := 0; i < currentNode.Len(); i++ {
            if i == 16 && currentNode.Get(i).Len() != 0 {
                it.values = append(it.values, currentNode.Get(i).Str())
            } else {
                if currentNode.Get(i).Str() == "" {
                    it.workNode(currentNode.Get(i))
                } else {
                    val := currentNode.Get(i).Str()
                    if val != "" {
                        it.shas = append(it.shas, currentNode.Get(1).Bytes())
                        it.getNode([]byte(val))
                    }
                }
            }
        }
    }
}

func (it *TrieIterator) getNode(node []byte) {
    currentNode := it.trie.cache.Get(node)
    it.workNode(currentNode)
}

func (it *TrieIterator) Collect() [][]byte {
    if it.trie.Root == "" {
        return nil
    }

    it.getNode(ethutil.NewValue(it.trie.Root).Bytes())

    return it.shas
}

func (it *TrieIterator) Purge() int {
    shas := it.Collect()
    for _, sha := range shas {
        it.trie.cache.Delete(sha)
    }
    return len(it.values)
}

func (it *TrieIterator) Key() string {
    return ""
}

func (it *TrieIterator) Value() string {
    return ""
}

type EachCallback func(key string, node *ethutil.Value)

func (it *TrieIterator) Each(cb EachCallback) {
    it.fetchNode(nil, ethutil.NewValue(it.trie.Root).Bytes(), cb)
}

func (it *TrieIterator) fetchNode(key []byte, node []byte, cb EachCallback) {
    it.iterateNode(key, it.trie.cache.Get(node), cb)
}

func (it *TrieIterator) iterateNode(key []byte, currentNode *ethutil.Value, cb EachCallback) {
    if currentNode.Len() == 2 {
        k := CompactDecode(currentNode.Get(0).Str())

        pk := append(key, k...)
        if currentNode.Get(1).Len() != 0 && currentNode.Get(1).Str() == "" {
            it.iterateNode(pk, currentNode.Get(1), cb)
        } else {
            if k[len(k)-1] == 16 {
                cb(DecodeCompact(pk), currentNode.Get(1))
            } else {
                it.fetchNode(pk, currentNode.Get(1).Bytes(), cb)
            }
        }
    } else {
        for i := 0; i < currentNode.Len(); i++ {
            pk := append(key, byte(i))
            if i == 16 && currentNode.Get(i).Len() != 0 {
                cb(DecodeCompact(pk), currentNode.Get(i))
            } else {
                if currentNode.Get(i).Len() != 0 && currentNode.Get(i).Str() == "" {
                    it.iterateNode(pk, currentNode.Get(i), cb)
                } else {
                    val := currentNode.Get(i).Str()
                    if val != "" {
                        it.fetchNode(pk, []byte(val), cb)
                    }
                }
            }
        }
    }
}
*/