-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathmap.go
1530 lines (1251 loc) · 46.8 KB
/
map.go
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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Atree - Scalable Arrays and Ordered Maps
*
* Copyright Flow Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package atree
import (
"encoding/binary"
"errors"
"fmt"
"strings"
"github.com/fxamacker/circlehash"
)
const (
// typicalRandomConstant is a 64-bit value that has qualities
// of a typical random value (e.g. hamming weight, number of
// consecutive groups of 1-bits, etc.) so it can be useful as
// a const part of a seed, round constant inside a permutation, etc.
// CAUTION: We only store 64-bit seed, so some hashes with 64-bit seed like
// CircleHash64f don't use this const. However, other hashes such as
// CircleHash64fx and SipHash might use this const as part of their
// 128-bit seed (when they don't use 64-bit -> 128-bit seed expansion func).
typicalRandomConstant = uint64(0x1BD11BDAA9FC1A22) // DO NOT MODIFY
)
// OrderedMap is an ordered map of key-value pairs; keys can be any hashable type
// and values can be any serializable value type. It supports heterogeneous key
// or value types (e.g. first key storing a boolean and second key storing a string).
// OrderedMap keeps values in specific sorted order and operations are deterministic
// so the state of the segments after a sequence of operations are always unique.
//
// OrderedMap key-value pairs can be stored in one or more relatively fixed-sized segments.
//
// OrderedMap can be inlined into its parent container when the entire content fits in
// parent container's element size limit. Specifically, OrderedMap with one segment
// which fits in size limit can be inlined, while OrderedMap with multiple segments
// can't be inlined.
type OrderedMap struct {
Storage SlabStorage
root MapSlab
digesterBuilder DigesterBuilder
// parentUpdater is a callback that notifies parent container when this map is modified.
// If this callback is nil, this map has no parent. Otherwise, this map has parent
// and this callback must be used when this map is changed by Set and Remove.
//
// parentUpdater acts like "parent pointer". It is not stored physically and is only in memory.
// It is setup when child map is returned from parent's Get. It is also setup when
// new child is added to parent through Set or Insert.
parentUpdater parentUpdater
}
var _ Value = &OrderedMap{}
var _ mutableValueNotifier = &OrderedMap{}
// Create, copy, and load array
func NewMap(storage SlabStorage, address Address, digestBuilder DigesterBuilder, typeInfo TypeInfo) (*OrderedMap, error) {
// Create root slab ID
sID, err := storage.GenerateSlabID(address)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to generate slab ID for address 0x%x", address))
}
// Create seed for non-crypto hash algos (CircleHash64, SipHash) to use.
// Ideally, seed should be a nondeterministic 128-bit secret because
// these hashes rely on its key being secret for its security. Since
// we handle collisions and based on other factors such as storage space,
// the team decided we can use a 64-bit non-secret key instead of
// a 128-bit secret key. And for performance reasons, we first use
// noncrypto hash algos and fall back to crypto algo after collisions.
// This is for creating the seed, so the seed used here is OK to be 0.
// LittleEndian is needed for compatibility (same digest from []byte and
// two uint64).
a := binary.LittleEndian.Uint64(sID.address[:])
b := binary.LittleEndian.Uint64(sID.index[:])
k0 := circlehash.Hash64Uint64x2(a, b, uint64(0))
// To save storage space, only store 64-bits of the seed.
// Use a 64-bit const for the unstored half to create 128-bit seed.
k1 := typicalRandomConstant
digestBuilder.SetSeed(k0, k1)
// Create extra data with type info and seed
extraData := &MapExtraData{TypeInfo: typeInfo, Seed: k0}
root := &MapDataSlab{
header: MapSlabHeader{
slabID: sID,
size: mapRootDataSlabPrefixSize + hkeyElementsPrefixSize,
},
elements: newHkeyElements(0),
extraData: extraData,
}
err = storeSlab(storage, root)
if err != nil {
return nil, err
}
return &OrderedMap{
Storage: storage,
root: root,
digesterBuilder: digestBuilder,
}, nil
}
func NewMapWithRootID(storage SlabStorage, rootID SlabID, digestBuilder DigesterBuilder) (*OrderedMap, error) {
if rootID == SlabIDUndefined {
return nil, NewSlabIDErrorf("cannot create OrderedMap from undefined slab ID")
}
root, err := getMapSlab(storage, rootID)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by getMapSlab().
return nil, err
}
extraData := root.ExtraData()
if extraData == nil {
return nil, NewNotValueError(rootID)
}
digestBuilder.SetSeed(extraData.Seed, typicalRandomConstant)
return &OrderedMap{
Storage: storage,
root: root,
digesterBuilder: digestBuilder,
}, nil
}
type MapElementProvider func() (Value, Value, error)
// NewMapFromBatchData returns a new map with elements provided by fn callback.
// Provided seed must be the same seed used to create the original map.
// And callback function must return elements in the same order as the original map.
// New map uses and stores the same seed as the original map.
// This function should only be used for copying a map.
func NewMapFromBatchData(
storage SlabStorage,
address Address,
digesterBuilder DigesterBuilder,
typeInfo TypeInfo,
comparator ValueComparator,
hip HashInputProvider,
seed uint64,
fn MapElementProvider,
) (
*OrderedMap,
error,
) {
const defaultElementCountInSlab = 32
if seed == 0 {
return nil, NewHashSeedUninitializedError()
}
// Seed digester
digesterBuilder.SetSeed(seed, typicalRandomConstant)
var slabs []MapSlab
id, err := storage.GenerateSlabID(address)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to generate slab ID for address 0x%x", address))
}
elements := &hkeyElements{
level: 0,
size: hkeyElementsPrefixSize,
hkeys: make([]Digest, 0, defaultElementCountInSlab),
elems: make([]element, 0, defaultElementCountInSlab),
}
count := uint64(0)
var prevHkey Digest
// Appends all elements
for {
key, value, err := fn()
if err != nil {
// Wrap err as external error (if needed) because err is returned by MapElementProvider callback.
return nil, wrapErrorAsExternalErrorIfNeeded(err)
}
if key == nil {
break
}
digester, err := digesterBuilder.Digest(hip, key)
if err != nil {
// Wrap err as external error (if needed) because err is returned by DigesterBuilder interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to create map key digester")
}
hkey, err := digester.Digest(0)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Digester interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to generate map key digest for level 0")
}
if hkey < prevHkey {
// a valid map will always have sorted digests
return nil, NewHashError(fmt.Errorf("digest isn't sorted (found %d before %d)", prevHkey, hkey))
}
if hkey == prevHkey && count > 0 {
// found collision
lastElementIndex := len(elements.elems) - 1
prevElem := elements.elems[lastElementIndex]
prevElemSize := prevElem.Size()
elem, _, existingMapValueStorable, err := prevElem.Set(storage, address, digesterBuilder, digester, 0, hkey, comparator, hip, key, value)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by element.Set().
return nil, err
}
if existingMapValueStorable != nil {
return nil, NewDuplicateKeyError(key)
}
elements.elems[lastElementIndex] = elem
elements.size += elem.Size() - prevElemSize
putDigester(digester)
count++
continue
}
// no collision
putDigester(digester)
elem, err := newSingleElement(storage, address, key, value)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by newSingleElememt().
return nil, err
}
// Finalize data slab
currentSlabSize := mapDataSlabPrefixSize + elements.Size()
newElementSize := digestSize + elem.Size()
if currentSlabSize >= uint32(targetThreshold) ||
currentSlabSize+newElementSize > uint32(maxThreshold) {
// Generate storge id for next data slab
nextID, err := storage.GenerateSlabID(address)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to generate slab ID for address 0x%x", address))
}
// Create data slab
dataSlab := &MapDataSlab{
header: MapSlabHeader{
slabID: id,
size: mapDataSlabPrefixSize + elements.Size(),
firstKey: elements.firstKey(),
},
elements: elements,
next: nextID,
}
// Append data slab to dataSlabs
slabs = append(slabs, dataSlab)
// Save id
id = nextID
// Create new elements for next data slab
elements = &hkeyElements{
level: 0,
size: hkeyElementsPrefixSize,
hkeys: make([]Digest, 0, defaultElementCountInSlab),
elems: make([]element, 0, defaultElementCountInSlab),
}
}
elements.hkeys = append(elements.hkeys, hkey)
elements.elems = append(elements.elems, elem)
elements.size += digestSize + elem.Size()
prevHkey = hkey
count++
}
// Create last data slab
dataSlab := &MapDataSlab{
header: MapSlabHeader{
slabID: id,
size: mapDataSlabPrefixSize + elements.Size(),
firstKey: elements.firstKey(),
},
elements: elements,
}
// Append last data slab to slabs
slabs = append(slabs, dataSlab)
for len(slabs) > 1 {
lastSlab := slabs[len(slabs)-1]
// Rebalance last slab if needed
if underflowSize, underflow := lastSlab.IsUnderflow(); underflow {
leftSib := slabs[len(slabs)-2]
if leftSib.CanLendToRight(underflowSize) {
// Rebalance with left
err := leftSib.LendToRight(lastSlab)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.LendToRight().
return nil, err
}
} else {
// Merge with left
err := leftSib.Merge(lastSlab)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.Merge().
return nil, err
}
// Remove last slab from slabs
slabs[len(slabs)-1] = nil
slabs = slabs[:len(slabs)-1]
}
}
// All slabs are within target size range.
if len(slabs) == 1 {
// This happens when there were exactly two slabs and
// last slab has merged with the first slab.
break
}
// Store all slabs
for _, slab := range slabs {
err = storeSlab(storage, slab)
if err != nil {
return nil, err
}
}
// Get next level meta slabs
slabs, err = nextLevelMapSlabs(storage, address, slabs)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by nextLevelMapSlabs().
return nil, err
}
}
// found root slab
root := slabs[0]
// root is data slab, adjust its size
if dataSlab, ok := root.(*MapDataSlab); ok {
dataSlab.header.size = dataSlab.header.size - mapDataSlabPrefixSize + mapRootDataSlabPrefixSize
}
extraData := &MapExtraData{TypeInfo: typeInfo, Count: count, Seed: seed}
// Set extra data in root
root.SetExtraData(extraData)
// Store root
err = storeSlab(storage, root)
if err != nil {
return nil, err
}
return &OrderedMap{
Storage: storage,
root: root,
digesterBuilder: digesterBuilder,
}, nil
}
// nextLevelMapSlabs returns next level meta data slabs from slabs.
// slabs must have at least 2 elements. It is reused and returned as next level slabs.
// Caller is responsible for rebalance last slab and storing returned slabs in storage.
func nextLevelMapSlabs(storage SlabStorage, address Address, slabs []MapSlab) ([]MapSlab, error) {
maxNumberOfHeadersInMetaSlab := (maxThreshold - mapMetaDataSlabPrefixSize) / mapSlabHeaderSize
nextLevelSlabsIndex := 0
// Generate storge id
id, err := storage.GenerateSlabID(address)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to generate slab ID for address 0x%x", address))
}
childrenCount := maxNumberOfHeadersInMetaSlab
if uint64(len(slabs)) < maxNumberOfHeadersInMetaSlab {
childrenCount = uint64(len(slabs))
}
metaSlab := &MapMetaDataSlab{
header: MapSlabHeader{
slabID: id,
size: mapMetaDataSlabPrefixSize,
firstKey: slabs[0].Header().firstKey,
},
childrenHeaders: make([]MapSlabHeader, 0, childrenCount),
}
for i, slab := range slabs {
if len(metaSlab.childrenHeaders) == int(maxNumberOfHeadersInMetaSlab) {
slabs[nextLevelSlabsIndex] = metaSlab
nextLevelSlabsIndex++
// compute number of children for next meta data slab
childrenCount = maxNumberOfHeadersInMetaSlab
if uint64(len(slabs)-i) < maxNumberOfHeadersInMetaSlab {
childrenCount = uint64(len(slabs) - i)
}
// Generate storge id for next meta data slab
id, err = storage.GenerateSlabID(address)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to generate slab ID for address 0x%x", address))
}
metaSlab = &MapMetaDataSlab{
header: MapSlabHeader{
slabID: id,
size: mapMetaDataSlabPrefixSize,
firstKey: slab.Header().firstKey,
},
childrenHeaders: make([]MapSlabHeader, 0, childrenCount),
}
}
metaSlab.header.size += mapSlabHeaderSize
metaSlab.childrenHeaders = append(metaSlab.childrenHeaders, slab.Header())
}
// Append last meta slab to slabs
slabs[nextLevelSlabsIndex] = metaSlab
nextLevelSlabsIndex++
return slabs[:nextLevelSlabsIndex], nil
}
// Map operations (has, get, set, remove, and pop iterate)
func (m *OrderedMap) Has(comparator ValueComparator, hip HashInputProvider, key Value) (bool, error) {
_, _, err := m.get(comparator, hip, key)
if err != nil {
var knf *KeyNotFoundError
if errors.As(err, &knf) {
return false, nil
}
// Don't need to wrap error as external error because err is already categorized by OrderedMap.Get().
return false, err
}
return true, nil
}
func (m *OrderedMap) Get(comparator ValueComparator, hip HashInputProvider, key Value) (Value, error) {
keyStorable, valueStorable, err := m.get(comparator, hip, key)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.Get().
return nil, err
}
v, err := valueStorable.StoredValue(m.Storage)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Storable interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to get storable's stored value")
}
// As a parent, this map (m) sets up notification callback with child
// value (v) so this map can be notified when child value is modified.
maxInlineSize := maxInlineMapValueSize(uint64(keyStorable.ByteSize()))
m.setCallbackWithChild(comparator, hip, key, v, maxInlineSize)
return v, nil
}
func (m *OrderedMap) get(comparator ValueComparator, hip HashInputProvider, key Value) (Storable, Storable, error) {
keyDigest, err := m.digesterBuilder.Digest(hip, key)
if err != nil {
// Wrap err as external error (if needed) because err is returned by DigesterBuilder interface.
return nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to create map key digester")
}
defer putDigester(keyDigest)
level := uint(0)
hkey, err := keyDigest.Digest(level)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Digesert interface.
return nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to get map key digest at level %d", level))
}
// Don't need to wrap error as external error because err is already categorized by MapSlab.Get().
return m.root.Get(m.Storage, keyDigest, level, hkey, comparator, key)
}
func (m *OrderedMap) getElementAndNextKey(comparator ValueComparator, hip HashInputProvider, key Value) (Value, Value, Value, error) {
keyDigest, err := m.digesterBuilder.Digest(hip, key)
if err != nil {
// Wrap err as external error (if needed) because err is returned by DigesterBuilder interface.
return nil, nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to create map key digester")
}
defer putDigester(keyDigest)
level := uint(0)
hkey, err := keyDigest.Digest(level)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Digesert interface.
return nil, nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to get map key digest at level %d", level))
}
keyStorable, valueStorable, nextKeyStorable, err := m.root.getElementAndNextKey(m.Storage, keyDigest, level, hkey, comparator, key)
if err != nil {
return nil, nil, nil, err
}
k, err := keyStorable.StoredValue(m.Storage)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Storable interface.
return nil, nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to get storable's stored value")
}
v, err := valueStorable.StoredValue(m.Storage)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Storable interface.
return nil, nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to get storable's stored value")
}
var nextKey Value
if nextKeyStorable != nil {
nextKey, err = nextKeyStorable.StoredValue(m.Storage)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Storable interface.
return nil, nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to get storable's stored value")
}
}
// As a parent, this map (m) sets up notification callback with child
// value (v) so this map can be notified when child value is modified.
maxInlineSize := maxInlineMapValueSize(uint64(keyStorable.ByteSize()))
m.setCallbackWithChild(comparator, hip, key, v, maxInlineSize)
return k, v, nextKey, nil
}
func (m *OrderedMap) getNextKey(comparator ValueComparator, hip HashInputProvider, key Value) (Value, error) {
keyDigest, err := m.digesterBuilder.Digest(hip, key)
if err != nil {
// Wrap err as external error (if needed) because err is returned by DigesterBuilder interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to create map key digester")
}
defer putDigester(keyDigest)
level := uint(0)
hkey, err := keyDigest.Digest(level)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Digesert interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to get map key digest at level %d", level))
}
_, _, nextKeyStorable, err := m.root.getElementAndNextKey(m.Storage, keyDigest, level, hkey, comparator, key)
if err != nil {
return nil, err
}
if nextKeyStorable == nil {
return nil, nil
}
nextKey, err := nextKeyStorable.StoredValue(m.Storage)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Storable interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to get storable's stored value")
}
return nextKey, nil
}
func (m *OrderedMap) Set(comparator ValueComparator, hip HashInputProvider, key Value, value Value) (Storable, error) {
storable, err := m.set(comparator, hip, key, value)
if err != nil {
return nil, err
}
// If overwritten storable is an inlined slab, uninline the slab and store it in storage.
// This is to prevent potential data loss because the overwritten inlined slab was not in
// storage and any future changes to it would have been lost.
storable, _, _, err = uninlineStorableIfNeeded(m.Storage, storable)
if err != nil {
return nil, err
}
return storable, nil
}
func (m *OrderedMap) set(comparator ValueComparator, hip HashInputProvider, key Value, value Value) (Storable, error) {
keyDigest, err := m.digesterBuilder.Digest(hip, key)
if err != nil {
// Wrap err as external error (if needed) because err is returned by DigesterBuilder interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to create map key digester")
}
defer putDigester(keyDigest)
level := uint(0)
hkey, err := keyDigest.Digest(level)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Digesert interface.
return nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to get map key digest at level %d", level))
}
keyStorable, existingMapValueStorable, err := m.root.Set(m.Storage, m.digesterBuilder, keyDigest, level, hkey, comparator, hip, key, value)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.Set().
return nil, err
}
if existingMapValueStorable == nil {
m.root.ExtraData().incrementCount()
}
if !m.root.IsData() {
// Set root to its child slab if root has one child slab.
root := m.root.(*MapMetaDataSlab)
if len(root.childrenHeaders) == 1 {
err := m.promoteChildAsNewRoot(root.childrenHeaders[0].slabID)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by OrderedMap.promoteChildAsNewRoot().
return nil, err
}
}
}
if m.root.IsFull() {
err := m.splitRoot()
if err != nil {
// Don't need to wrap error as external error because err is already categorized by OrderedMap.splitRoot().
return nil, err
}
}
// This map (m) is a parent to the new child (value), and this map
// can also be a child in another container.
//
// As a parent, this map needs to setup notification callback with
// the new child value, so it can be notified when child is modified.
//
// If this map is a child, it needs to notify its parent because its
// content (maybe also its size) is changed by this "Set" operation.
// If this map is a child, it notifies parent by invoking callback because
// this map is changed by setting new child.
err = m.notifyParentIfNeeded()
if err != nil {
return nil, err
}
// As a parent, this map sets up notification callback with child value
// so this map can be notified when child value is modified.
//
// Setting up notification with new child value can happen at any time
// (either before or after this map notifies its parent) because
// setting up notification doesn't trigger any read/write ops on parent or child.
maxInlineSize := maxInlineMapValueSize(uint64(keyStorable.ByteSize()))
m.setCallbackWithChild(comparator, hip, key, value, maxInlineSize)
return existingMapValueStorable, nil
}
func (m *OrderedMap) Remove(comparator ValueComparator, hip HashInputProvider, key Value) (Storable, Storable, error) {
keyStorable, valueStorable, err := m.remove(comparator, hip, key)
if err != nil {
return nil, nil, err
}
// If overwritten storable is an inlined slab, uninline the slab and store it in storage.
// This is to prevent potential data loss because the overwritten inlined slab was not in
// storage and any future changes to it would have been lost.
keyStorable, _, _, err = uninlineStorableIfNeeded(m.Storage, keyStorable)
if err != nil {
return nil, nil, err
}
valueStorable, _, _, err = uninlineStorableIfNeeded(m.Storage, valueStorable)
if err != nil {
return nil, nil, err
}
return keyStorable, valueStorable, nil
}
func (m *OrderedMap) remove(comparator ValueComparator, hip HashInputProvider, key Value) (Storable, Storable, error) {
keyDigest, err := m.digesterBuilder.Digest(hip, key)
if err != nil {
// Wrap err as external error (if needed) because err is returned by DigesterBuilder interface.
return nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, "failed to create map key digester")
}
defer putDigester(keyDigest)
level := uint(0)
hkey, err := keyDigest.Digest(level)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Digesert interface.
return nil, nil, wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to create map key digest at level %d", level))
}
k, v, err := m.root.Remove(m.Storage, keyDigest, level, hkey, comparator, key)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.Remove().
return nil, nil, err
}
m.root.ExtraData().decrementCount()
if !m.root.IsData() {
// Set root to its child slab if root has one child slab.
root := m.root.(*MapMetaDataSlab)
if len(root.childrenHeaders) == 1 {
err := m.promoteChildAsNewRoot(root.childrenHeaders[0].slabID)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by OrderedMap.promoteChildAsNewRoot().
return nil, nil, err
}
}
}
if m.root.IsFull() {
err := m.splitRoot()
if err != nil {
// Don't need to wrap error as external error because err is already categorized by OrderedMap.splitRoot().
return nil, nil, err
}
}
// If this map is a child, it notifies parent by invoking callback because
// this map is changed by removing element.
err = m.notifyParentIfNeeded()
if err != nil {
return nil, nil, err
}
return k, v, nil
}
type MapPopIterationFunc func(Storable, Storable)
// PopIterate iterates and removes elements backward.
// Each element is passed to MapPopIterationFunc callback before removal.
func (m *OrderedMap) PopIterate(fn MapPopIterationFunc) error {
err := m.root.PopIterate(m.Storage, fn)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.PopIterate().
return err
}
rootID := m.root.SlabID()
// Set map count to 0 in extraData
extraData := m.root.ExtraData()
extraData.Count = 0
inlined := m.root.Inlined()
prefixSize := uint32(mapRootDataSlabPrefixSize)
if inlined {
prefixSize = uint32(inlinedMapDataSlabPrefixSize)
}
// Set root to empty data slab
m.root = &MapDataSlab{
header: MapSlabHeader{
slabID: rootID,
size: prefixSize + hkeyElementsPrefixSize,
},
elements: newHkeyElements(0),
extraData: extraData,
inlined: inlined,
}
if !m.Inlined() {
// Save root slab
err = storeSlab(m.Storage, m.root)
if err != nil {
return err
}
}
return nil
}
// Slab operations (split root, promote child slab to root)
func (m *OrderedMap) splitRoot() error {
if m.root.IsData() {
// Adjust root data slab size before splitting
dataSlab := m.root.(*MapDataSlab)
dataSlab.header.size = dataSlab.header.size - mapRootDataSlabPrefixSize + mapDataSlabPrefixSize
}
// Get old root's extra data and reset it to nil in old root
extraData := m.root.RemoveExtraData()
// Save root node id
rootID := m.root.SlabID()
// Assign a new slab ID to old root before splitting it.
sID, err := m.Storage.GenerateSlabID(m.Address())
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to generate slab ID for address 0x%x", m.Address()))
}
oldRoot := m.root
oldRoot.SetSlabID(sID)
// Split old root
leftSlab, rightSlab, err := oldRoot.Split(m.Storage)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by MapSlab.Split().
return err
}
left := leftSlab.(MapSlab)
right := rightSlab.(MapSlab)
// Create new MapMetaDataSlab with the old root's slab ID
newRoot := &MapMetaDataSlab{
header: MapSlabHeader{
slabID: rootID,
size: mapMetaDataSlabPrefixSize + mapSlabHeaderSize*2,
firstKey: left.Header().firstKey,
},
childrenHeaders: []MapSlabHeader{left.Header(), right.Header()},
extraData: extraData,
}
m.root = newRoot
err = storeSlab(m.Storage, left)
if err != nil {
return err
}
err = storeSlab(m.Storage, right)
if err != nil {
return err
}
return storeSlab(m.Storage, m.root)
}
func (m *OrderedMap) promoteChildAsNewRoot(childID SlabID) error {
child, err := getMapSlab(m.Storage, childID)
if err != nil {
// Don't need to wrap error as external error because err is already categorized by getMapSlab().
return err
}
if child.IsData() {
// Adjust data slab size before promoting non-root data slab to root
dataSlab := child.(*MapDataSlab)
dataSlab.header.size = dataSlab.header.size - mapDataSlabPrefixSize + mapRootDataSlabPrefixSize
}
extraData := m.root.RemoveExtraData()
rootID := m.root.SlabID()
m.root = child
m.root.SetSlabID(rootID)
m.root.SetExtraData(extraData)
err = storeSlab(m.Storage, m.root)
if err != nil {
return err
}
err = m.Storage.Remove(childID)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to remove slab %s", childID))
}
return nil
}
// mutableValue operations (parent updater callback, mutableElementIndex, etc)
func (m *OrderedMap) Inlined() bool {
return m.root.Inlined()
}
func (m *OrderedMap) Inlinable(maxInlineSize uint64) bool {
return m.root.Inlinable(maxInlineSize)
}
func (m *OrderedMap) setParentUpdater(f parentUpdater) {
m.parentUpdater = f
}
// setCallbackWithChild sets up callback function with child value (child)
// so parent map (m) can be notified when child value is modified.
func (m *OrderedMap) setCallbackWithChild(
comparator ValueComparator,
hip HashInputProvider,
key Value,
child Value,
maxInlineSize uint64,
) {
// Unwrap child value if needed (e.g. interpreter.SomeValue)
unwrappedChild, wrapperSize := unwrapValue(child)
c, ok := unwrappedChild.(mutableValueNotifier)
if !ok {
return
}
if maxInlineSize < wrapperSize {
maxInlineSize = 0
} else {
maxInlineSize -= wrapperSize
}
vid := c.ValueID()
c.setParentUpdater(func() (found bool, err error) {
// Avoid unnecessary write operation on parent container.
// Child value was stored as SlabIDStorable (not inlined) in parent container,
// and continues to be stored as SlabIDStorable (still not inlinable),
// so no update to parent container is needed.
if !c.Inlined() && !c.Inlinable(maxInlineSize) {
return true, nil
}
// Retrieve element value under the same key and
// verify retrieved value is this child (c).
_, valueStorable, err := m.get(comparator, hip, key)
if err != nil {
var knf *KeyNotFoundError
if errors.As(err, &knf) {
return false, nil
}