forked from UWQuickstep/quickstep
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCSBTreeIndexSubBlock.cpp
2408 lines (2167 loc) · 94.4 KB
/
CSBTreeIndexSubBlock.cpp
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
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
**/
#include "storage/CSBTreeIndexSubBlock.hpp"
#include <algorithm>
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <memory>
#include <utility>
#include <vector>
#include "catalog/CatalogAttribute.hpp"
#include "catalog/CatalogRelationSchema.hpp"
#include "catalog/CatalogTypedefs.hpp"
#include "compression/CompressionDictionary.hpp"
#include "expressions/predicate/ComparisonPredicate.hpp"
#include "expressions/predicate/PredicateCost.hpp"
#include "expressions/scalar/Scalar.hpp"
#include "expressions/scalar/ScalarAttribute.hpp"
#include "storage/CompressedTupleStorageSubBlock.hpp"
#include "storage/StorageBlockLayout.pb.h"
#include "storage/StorageConstants.hpp"
#include "storage/StorageErrors.hpp"
#include "storage/SubBlockTypeRegistry.hpp"
#include "storage/TupleIdSequence.hpp"
#include "storage/TupleStorageSubBlock.hpp"
#include "types/Type.hpp"
#include "types/TypedValue.hpp"
#include "types/operations/comparisons/Comparison.hpp"
#include "types/operations/comparisons/ComparisonFactory.hpp"
#include "types/operations/comparisons/ComparisonID.hpp"
#include "types/operations/comparisons/ComparisonUtil.hpp"
#include "utility/BitVector.hpp"
#include "utility/Macros.hpp"
#include "utility/PtrVector.hpp"
#include "utility/ScopedBuffer.hpp"
using std::memcpy;
using std::memmove;
using std::pair;
using std::size_t;
using std::sort;
using std::uint8_t;
using std::uint16_t;
using std::uint32_t;
using std::vector;
namespace quickstep {
QUICKSTEP_REGISTER_INDEX(CSBTreeIndexSubBlock, CSB_TREE);
namespace csbtree_internal {
template <typename CodeType>
class CompressedCodeLessComparator : public UncheckedComparator {
public:
~CompressedCodeLessComparator() {
}
bool compareTypedValues(const TypedValue &left, const TypedValue &right) const {
FATAL_ERROR("Can not use CompressedCodeLessComparator to compare TypedValue.");
}
inline bool compareDataPtrs(const void *left, const void *right) const {
return compareDataPtrsInl(left, right);
}
inline bool compareDataPtrsInl(const void *left, const void *right) const {
return *static_cast<const CodeType*>(left) < *static_cast<const CodeType*>(right);
}
bool compareTypedValueWithDataPtr(const TypedValue &left, const void *right) const {
FATAL_ERROR("Can not use CompressedCodeLessComparator to compare TypedValue.");
}
bool compareDataPtrWithTypedValue(const void *left, const TypedValue &right) const {
FATAL_ERROR("Can not use CompressedCodeLessComparator to compare TypedValue.");
}
};
class EntryReference {
public:
EntryReference(TypedValue &&key,
const tuple_id tuple)
: key_(key), tuple_(tuple) {
}
inline const void* getDataPtr() const {
return key_.getDataPtr();
}
inline tuple_id getTupleID() const {
return tuple_;
}
private:
TypedValue key_;
tuple_id tuple_;
};
class CompressedEntryReference {
public:
CompressedEntryReference(const uint32_t key_code, const tuple_id tuple)
: key_code_(key_code), tuple_(tuple) {
}
inline const void* getDataPtr() const {
return &key_code_;
}
inline uint32_t getKeyCode() const {
return key_code_;
}
inline tuple_id getTupleID() const {
return tuple_;
}
private:
uint32_t key_code_;
tuple_id tuple_;
};
class CompositeEntryReference {
public:
CompositeEntryReference(void *composite_key_copy, const tuple_id tuple)
: composite_key_(composite_key_copy),
tuple_(tuple) {
}
inline const void* getDataPtr() const {
return composite_key_.get();
}
inline tuple_id getTupleID() const {
return tuple_;
}
private:
ScopedBuffer composite_key_;
tuple_id tuple_;
};
class CompressedEntryReferenceComparator {
public:
inline bool operator() (const CompressedEntryReference &left,
const CompressedEntryReference &right) const {
return left.getKeyCode() < right.getKeyCode();
}
};
class CompositeEntryReferenceComparator {
public:
explicit CompositeEntryReferenceComparator(const CompositeKeyLessComparator &comparator)
: internal_comparator_(comparator) {
}
inline bool operator() (const CompositeEntryReference &left,
const CompositeEntryReference &right) const {
return internal_comparator_.compareDataPtrsInl(left.getDataPtr(), right.getDataPtr());
}
private:
const CompositeKeyLessComparator &internal_comparator_;
};
CompositeKeyLessComparator::CompositeKeyLessComparator(
const CSBTreeIndexSubBlock &owner,
const CatalogRelationSchema &relation)
: owner_(owner) {
attribute_comparators_.reserve(owner_.indexed_attribute_ids_.size());
for (vector<attribute_id>::const_iterator it = owner_.indexed_attribute_ids_.begin();
it != owner_.indexed_attribute_ids_.end();
++it) {
const Type &attribute_type = relation.getAttributeById(*it)->getType();
DEBUG_ASSERT(!attribute_type.isVariableLength());
attribute_comparators_.push_back(
ComparisonFactory::GetComparison(ComparisonID::kLess).makeUncheckedComparatorForTypes(
attribute_type,
attribute_type));
}
}
bool CompositeKeyLessComparator::compareDataPtrsInl(const void *left, const void *right) const {
DEBUG_ASSERT(attribute_comparators_.size() == owner_.indexed_attribute_offsets_.size());
vector<size_t>::const_iterator offset_it = owner_.indexed_attribute_offsets_.begin();
for (PtrVector<UncheckedComparator>::const_iterator comparator_it = attribute_comparators_.begin();
comparator_it != attribute_comparators_.end();
++comparator_it, ++offset_it) {
if (comparator_it->compareDataPtrs(static_cast<const char*>(left) + *offset_it,
static_cast<const char*>(right) + *offset_it)) {
return true;
} else if (comparator_it->compareDataPtrs(static_cast<const char*>(right) + *offset_it,
static_cast<const char*>(left) + *offset_it)) {
return false;
}
// Attributes are equal, so loop procedes to compare next attribute in
// composite key.
}
return false; // Keys are exactly equal.
}
} // namespace csbtree_internal
const int CSBTreeIndexSubBlock::kNodeGroupNone = -1;
const int CSBTreeIndexSubBlock::kNodeGroupNextLeaf = -2;
const int CSBTreeIndexSubBlock::kNodeGroupFull = -3;
CSBTreeIndexSubBlock::CSBTreeIndexSubBlock(const TupleStorageSubBlock &tuple_store,
const IndexSubBlockDescription &description,
const bool new_block,
void *sub_block_memory,
const std::size_t sub_block_memory_size)
: IndexSubBlock(tuple_store,
description,
new_block,
sub_block_memory,
sub_block_memory_size),
initialized_(false),
key_may_be_compressed_(false),
key_is_compressed_(false),
key_is_nullable_(false),
key_type_(nullptr),
next_free_node_group_(kNodeGroupNone),
num_free_node_groups_(0) {
if (!DescriptionIsValid(relation_, description_)) {
FATAL_ERROR("Attempted to construct a CSBTreeIndexSubBlock from an invalid description.");
}
const int num_indexed_attributes = description_.indexed_attribute_ids_size();
if (num_indexed_attributes > 1) {
key_is_composite_ = true;
} else {
key_is_composite_ = false;
const attribute_id key_id = description_.indexed_attribute_ids(0);
key_type_ = &(relation_.getAttributeById(key_id)->getType());
}
indexed_attribute_ids_.reserve(num_indexed_attributes);
indexed_attribute_offsets_.reserve(num_indexed_attributes);
for (int indexed_attribute_num = 0;
indexed_attribute_num < num_indexed_attributes;
++indexed_attribute_num) {
const attribute_id indexed_attribute_id = description_.indexed_attribute_ids(indexed_attribute_num);
indexed_attribute_ids_.push_back(indexed_attribute_id);
// TODO(chasseur): Support a composite key with compressed parts.
if ((!key_is_composite_) && tuple_store_.isCompressed()) {
const CompressedTupleStorageSubBlock &compressed_tuple_store
= static_cast<const CompressedTupleStorageSubBlock&>(tuple_store_);
if (compressed_tuple_store.compressedBlockIsBuilt()) {
if (compressed_tuple_store.compressedAttributeIsDictionaryCompressed(indexed_attribute_id)
|| compressed_tuple_store.compressedAttributeIsTruncationCompressed(indexed_attribute_id)) {
key_may_be_compressed_ = true;
}
} else {
if (compressed_tuple_store.compressedUnbuiltBlockAttributeMayBeCompressed(indexed_attribute_id)) {
key_may_be_compressed_ = true;
}
}
}
}
bool initialize_now = true;
if (key_may_be_compressed_) {
if (!static_cast<const CompressedTupleStorageSubBlock&>(tuple_store_).compressedBlockIsBuilt()) {
initialize_now = false;
}
}
if (initialize_now) {
if (new_block) {
initialize(new_block);
} else {
if (!initialize(new_block)) {
throw MalformedBlock();
}
}
}
}
bool CSBTreeIndexSubBlock::DescriptionIsValid(const CatalogRelationSchema &relation,
const IndexSubBlockDescription &description) {
// Make sure description is initialized and specifies CSBTree.
if (!description.IsInitialized()) {
return false;
}
if (description.sub_block_type() != IndexSubBlockDescription::CSB_TREE) {
return false;
}
// Make sure at least one key attribute is specified.
if (description.indexed_attribute_ids_size() == 0) {
return false;
}
// TODO(chasseur): Consider checking key-length here.
// Check that all key attributes exist and are fixed-length.
for (int indexed_attribute_num = 0;
indexed_attribute_num < description.indexed_attribute_ids_size();
++indexed_attribute_num) {
const attribute_id indexed_attribute_id = description.indexed_attribute_ids(indexed_attribute_num);
if (!relation.hasAttributeWithId(indexed_attribute_id)) {
return false;
}
const Type &attr_type = relation.getAttributeById(indexed_attribute_id)->getType();
if (attr_type.isVariableLength()) {
return false;
}
}
return true;
}
// TODO(chasseur): Make this more accurate by actually considering the internal
// structure of a CSBTreeIndexSubBlock. Also consider how to get better
// estimates when compression might be used.
std::size_t CSBTreeIndexSubBlock::EstimateBytesPerTuple(
const CatalogRelationSchema &relation,
const IndexSubBlockDescription &description) {
DEBUG_ASSERT(DescriptionIsValid(relation, description));
size_t key_length = 0;
for (int indexed_attribute_num = 0;
indexed_attribute_num < description.indexed_attribute_ids_size();
++indexed_attribute_num) {
key_length +=
relation.getAttributeById(description.indexed_attribute_ids(indexed_attribute_num))
->getType().maximumByteLength();
}
return (5 * key_length) >> 1;
}
std::size_t CSBTreeIndexSubBlock::EstimateBytesPerBlock(
const CatalogRelationSchema &relation,
const IndexSubBlockDescription &description) {
return kZeroSize;
}
bool CSBTreeIndexSubBlock::addEntry(const tuple_id tuple) {
DEBUG_ASSERT(initialized_);
DEBUG_ASSERT(tuple_store_.hasTupleWithID(tuple));
InsertReturnValue retval;
if (key_is_composite_) {
ScopedBuffer composite_key_buffer(makeKeyCopy(tuple));
if (key_is_nullable_) {
if (composite_key_buffer.empty()) {
// Don't insert a NULL key.
return true;
}
} else {
DEBUG_ASSERT(!composite_key_buffer.empty());
}
retval = rootInsertHelper(tuple,
composite_key_buffer.get(),
*composite_key_comparator_);
} else if (key_is_compressed_) {
// Don't insert a NULL key.
if (key_is_nullable_) {
TypedValue typed_key(tuple_store_.getAttributeValueTyped(tuple,
indexed_attribute_ids_.front()));
if (typed_key.isNull()) {
return true;
}
}
const CompressedTupleStorageSubBlock &compressed_tuple_store
= static_cast<const CompressedTupleStorageSubBlock&>(tuple_store_);
uint32_t code = compressed_tuple_store.compressedGetCode(tuple,
indexed_attribute_ids_.front());
switch (compressed_tuple_store.compressedGetCompressedAttributeSize(indexed_attribute_ids_.front())) {
case 1:
retval = compressedKeyAddEntryHelper<uint8_t>(tuple, code);
break;
case 2:
retval = compressedKeyAddEntryHelper<uint16_t>(tuple, code);
break;
case 4:
retval = compressedKeyAddEntryHelper<uint32_t>(tuple, code);
break;
default:
FATAL_ERROR("Unexpected compressed key byte-length (not 1, 2, or 4) encountered "
"in CSBTreeIndexSubBlock::addEntry()");
}
} else {
TypedValue typed_key(tuple_store_.getAttributeValueTyped(tuple, indexed_attribute_ids_.front()));
if (key_is_nullable_) {
if (typed_key.isNull()) {
// Don't insert a NULL key.
return true;
}
} else {
DEBUG_ASSERT(!typed_key.isNull());
}
InvokeOnLessComparatorForTypeIgnoreNullability(
*key_type_,
[&](const auto &comp) { // NOLINT(build/c++11)
retval = this->rootInsertHelper(tuple, typed_key.getDataPtr(), comp);
});
}
if (retval.new_node_group_id == kNodeGroupFull) {
// Needed to split a node group, but not enough space.
return false;
}
DEBUG_ASSERT(retval.new_node_group_id == kNodeGroupNone);
if (retval.split_node_least_key != NULL) {
// The root was split, must create a new root.
// Allocate the new root.
int new_root_group_id = allocateNodeGroup();
DEBUG_ASSERT(new_root_group_id >= 0);
void *new_root = getNode(new_root_group_id, 0);
// Set up the new root's header.
static_cast<NodeHeader*>(new_root)->num_keys = 1;
static_cast<NodeHeader*>(new_root)->is_leaf = false;
static_cast<NodeHeader*>(new_root)->node_group_reference = getRootNodeGroupNumber();
// Insert the split key into the new root.
memcpy(static_cast<char*>(new_root) + sizeof(NodeHeader),
retval.split_node_least_key,
key_length_bytes_);
// Update the root node group number.
setRootNodeGroupNumber(new_root_group_id);
}
return true;
}
bool CSBTreeIndexSubBlock::bulkAddEntries(const TupleIdSequence &tuples) {
DEBUG_ASSERT(initialized_);
// TODO(chasseur): Can possibly be more efficient in some cases if we sort
// and insert groups where possible.
for (TupleIdSequence::const_iterator it = tuples.begin();
it != tuples.end();
++it) {
if (!addEntry(*it)) {
// Ran out of space. Roll back.
for (TupleIdSequence::const_iterator fixer_it = tuples.begin();
fixer_it != it;
++fixer_it) {
removeEntry(*fixer_it);
}
return false;
}
}
return true;
}
void CSBTreeIndexSubBlock::removeEntry(const tuple_id tuple) {
DEBUG_ASSERT(initialized_);
if (key_is_composite_) {
ScopedBuffer composite_key_buffer(makeKeyCopy(tuple));
if (key_is_nullable_) {
if (composite_key_buffer.empty()) {
// Don't remove a NULL key (it would not have been inserted in the
// first place).
return;
}
} else {
DEBUG_ASSERT(!composite_key_buffer.empty());
}
removeEntryFromLeaf(tuple,
composite_key_buffer.get(),
*composite_key_comparator_,
findLeaf(getRootNode(),
composite_key_buffer.get(),
*composite_key_comparator_,
*composite_key_comparator_));
} else if (key_is_compressed_) {
// Don't remove a NULL key (it would not have been inserted in the first
// place).
if (key_is_nullable_) {
TypedValue typed_key(tuple_store_.getAttributeValueTyped(tuple,
indexed_attribute_ids_.front()));
if (typed_key.isNull()) {
return;
}
}
const CompressedTupleStorageSubBlock &compressed_tuple_store
= static_cast<const CompressedTupleStorageSubBlock&>(tuple_store_);
uint32_t code = compressed_tuple_store.compressedGetCode(tuple,
indexed_attribute_ids_.front());
switch (compressed_tuple_store.compressedGetCompressedAttributeSize(indexed_attribute_ids_.front())) {
case 1:
compressedKeyRemoveEntryHelper<uint8_t>(tuple, code);
break;
case 2:
compressedKeyRemoveEntryHelper<uint16_t>(tuple, code);
break;
case 4:
compressedKeyRemoveEntryHelper<uint32_t>(tuple, code);
break;
default:
FATAL_ERROR("Unexpected compressed key byte-length (not 1, 2, or 4) encountered "
"in CSBTreeIndexSubBlock::removeEntry()");
}
} else {
TypedValue typed_key(tuple_store_.getAttributeValueTyped(tuple, indexed_attribute_ids_.front()));
if (key_is_nullable_) {
if (typed_key.isNull()) {
// Don't remove a NULL key (it would not have been inserted in the
// first place).
return;
}
} else {
DEBUG_ASSERT(!typed_key.isNull());
}
InvokeOnLessComparatorForTypeIgnoreNullability(
*key_type_,
[&](const auto &comp) { // NOLINT(build/c++11)
this->removeEntryFromLeaf(tuple,
typed_key.getDataPtr(),
comp,
this->findLeaf(this->getRootNode(),
typed_key.getDataPtr(),
comp,
comp));
});
}
}
void CSBTreeIndexSubBlock::bulkRemoveEntries(const TupleIdSequence &tuples) {
DEBUG_ASSERT(initialized_);
// TODO(chasseur): Can possibly be more efficient in some cases if we sort
// and scan through leaves.
for (TupleIdSequence::const_iterator it = tuples.begin();
it != tuples.end();
++it) {
removeEntry(*it);
}
}
predicate_cost_t CSBTreeIndexSubBlock::estimatePredicateEvaluationCost(
const ComparisonPredicate &predicate) const {
if ((!key_is_composite_) && predicate.isAttributeLiteralComparisonPredicate()) {
std::pair<bool, attribute_id> comparison_attr = predicate.getAttributeFromAttributeLiteralComparison();
if (comparison_attr.second == indexed_attribute_ids_.front()) {
return predicate_cost::kTreeSearch;
}
}
return predicate_cost::kInfinite;
}
TupleIdSequence* CSBTreeIndexSubBlock::getMatchesForPredicate(const ComparisonPredicate &predicate,
const TupleIdSequence *filter) const {
DEBUG_ASSERT(initialized_);
if (key_is_composite_) {
// TODO(chasseur): Evaluate predicates on composite keys.
FATAL_ERROR("CSBTreeIndexSubBlock::getMatchesForPredicate() is unimplemented for composite keys.");
}
if (!predicate.isAttributeLiteralComparisonPredicate()) {
FATAL_ERROR("CSBTreeIndexSubBlock::getMatchesForPredicate() can not "
"evaluate predicates other than simple comparisons.");
}
const CatalogAttribute *comparison_attribute = NULL;
bool left_literal = false;
if (predicate.getLeftOperand().hasStaticValue()) {
DEBUG_ASSERT(predicate.getRightOperand().getDataSource() == Scalar::kAttribute);
comparison_attribute
= &(static_cast<const ScalarAttribute&>(predicate.getRightOperand()).getAttribute());
left_literal = true;
} else {
DEBUG_ASSERT(predicate.getLeftOperand().getDataSource() == Scalar::kAttribute);
comparison_attribute
= &(static_cast<const ScalarAttribute&>(predicate.getLeftOperand()).getAttribute());
left_literal = false;
}
if (comparison_attribute->getID() != indexed_attribute_ids_.front()) {
FATAL_ERROR("CSBTreeIndexSubBlock::getMatchesForPredicate() can not "
"evaluate predicates on non-indexed attributes.");
}
TypedValue comparison_literal;
const Type* comparison_literal_type;
if (left_literal) {
comparison_literal = predicate.getLeftOperand().getStaticValue().makeReferenceToThis();
comparison_literal_type = &(predicate.getLeftOperand().getType());
} else {
comparison_literal = predicate.getRightOperand().getStaticValue().makeReferenceToThis();
comparison_literal_type = &(predicate.getRightOperand().getType());
}
if (comparison_literal.isNull()) {
return new TupleIdSequence(tuple_store_.getMaxTupleID() + 1);
}
// If the literal is on the left, flip the comparison around.
ComparisonID comp = predicate.getComparison().getComparisonID();
if (left_literal) {
flipComparisonID(comp);
}
TupleIdSequence *idx_result;
if (key_is_compressed_) {
idx_result = evaluateComparisonPredicateOnCompressedKey(
comp,
comparison_literal,
*comparison_literal_type);
} else {
idx_result = evaluateComparisonPredicateOnUncompressedKey(
comp,
comparison_literal,
*comparison_literal_type);
}
if (filter != nullptr) {
idx_result->intersectWith(*filter);
}
return idx_result;
}
bool CSBTreeIndexSubBlock::rebuild() {
if (!initialized_) {
if (!initialize(false)) {
return false;
}
}
clearIndex();
if (tuple_store_.isEmpty()) {
return true;
}
if (!rebuildSpaceCheck()) {
return false;
}
vector<int> node_groups_this_level;
// Rebuild leaves.
uint16_t nodes_in_last_group = rebuildLeaves(&node_groups_this_level);
// Keep building intermediate levels from the bottom up until there is a
// single root node.
while (!((node_groups_this_level.size() == 1) && (nodes_in_last_group == 1))) {
vector<int> node_groups_next_level;
nodes_in_last_group = rebuildInternalLevel(node_groups_this_level,
nodes_in_last_group,
&node_groups_next_level);
node_groups_this_level.swap(node_groups_next_level);
}
// Set the root number.
setRootNodeGroupNumber(node_groups_this_level.front());
return true;
}
bool CSBTreeIndexSubBlock::initialize(const bool new_block) {
if (key_may_be_compressed_) {
const CompressedTupleStorageSubBlock &compressed_tuple_store
= static_cast<const CompressedTupleStorageSubBlock&>(tuple_store_);
if (!compressed_tuple_store.compressedBlockIsBuilt()) {
FATAL_ERROR("CSBTreeIndexSubBlock::initialize() called with a key which "
"may be compressed before the associated TupleStorageSubBlock "
"was built.");
}
if (compressed_tuple_store.compressedAttributeIsDictionaryCompressed(indexed_attribute_ids_.front())
|| compressed_tuple_store.compressedAttributeIsTruncationCompressed(indexed_attribute_ids_.front())) {
key_is_compressed_ = true;
}
}
// Compute the number of bytes needed to store a key, and fill in the vector
// of indexed attribute offsets.
key_length_bytes_ = 0;
for (vector<attribute_id>::const_iterator indexed_attr_it = indexed_attribute_ids_.begin();
indexed_attr_it != indexed_attribute_ids_.end();
++indexed_attr_it) {
indexed_attribute_offsets_.push_back(key_length_bytes_);
const Type &attr_type = relation_.getAttributeById(*indexed_attr_it)->getType();
if (attr_type.isNullable()) {
key_is_nullable_ = true;
}
if (key_is_compressed_) {
key_length_bytes_ += static_cast<const CompressedTupleStorageSubBlock&>(tuple_store_)
.compressedGetCompressedAttributeSize(*indexed_attr_it);
} else {
key_length_bytes_ += attr_type.maximumByteLength();
}
}
DEBUG_ASSERT(key_length_bytes_ > 0);
key_tuple_id_pair_length_bytes_ = key_length_bytes_ + sizeof(tuple_id);
// Compute the number of keys that can be stored in internal and leaf nodes.
// Internal nodes are just a header and a list of keys.
max_keys_internal_ = (kCSBTreeNodeSizeBytes - sizeof(NodeHeader)) / key_length_bytes_;
// Leaf nodes are a header, plus a list of (key, tuple_id) pairs.
max_keys_leaf_ = (kCSBTreeNodeSizeBytes - sizeof(NodeHeader)) / key_tuple_id_pair_length_bytes_;
if ((max_keys_internal_ < 2) || (max_keys_leaf_ < 2)) {
if (new_block) {
throw CSBTreeKeyTooLarge();
} else {
return false;
}
}
// The number of child nodes allocated to each half of a split internal node.
small_half_num_children_ = (max_keys_internal_ + 1) >> 1;
large_half_num_children_ = small_half_num_children_ + ((max_keys_internal_ + 1) & 0x1);
small_half_num_keys_leaf_ = max_keys_leaf_ >> 1;
large_half_num_keys_leaf_ = (max_keys_leaf_ >> 1) + (max_keys_leaf_ & 0x1);
// Create the less-than comparator for a composite key.
if (key_is_composite_) {
composite_key_comparator_.reset(new csbtree_internal::CompositeKeyLessComparator(*this, relation_));
}
node_group_size_bytes_ = kCSBTreeNodeSizeBytes * (max_keys_internal_ + 1);
// Perform this computation on the order of bits.
size_t num_node_groups = ((sub_block_memory_size_ - sizeof(int)) << 3)
/ ((node_group_size_bytes_ << 3) + 1);
// Compute the number of bytes needed for this SubBlock's header. The header
// consists of the root node's node group number and a bitmap of free/used
// node groups.
size_t header_size_bytes = sizeof(int) + BitVector<false>::BytesNeeded(num_node_groups);
// Node groups start after the header, and should be aligned to
// kCSBTreeNodeSizeBytes (i.e. cache lines). In some circumstances, the
// alignment requirement forces us to use one less node group than would
// otherwise be possible.
node_groups_start_ = static_cast<char*>(sub_block_memory_) + header_size_bytes;
if (reinterpret_cast<size_t>(node_groups_start_) & (kCSBTreeNodeSizeBytes - 1)) {
node_groups_start_ = static_cast<char*>(node_groups_start_)
+ kCSBTreeNodeSizeBytes
- (reinterpret_cast<size_t>(node_groups_start_) & (kCSBTreeNodeSizeBytes - 1));
}
// Adjust num_node_groups as necessary for aligned nodes.
num_node_groups = (static_cast<char*>(sub_block_memory_) + sub_block_memory_size_
- static_cast<char*>(node_groups_start_)) / node_group_size_bytes_;
if (num_node_groups == 0) {
throw BlockMemoryTooSmall("CSBTreeIndex", sub_block_memory_size_);
}
// Set up the free/used node group bitmap and the free list.
node_group_used_bitmap_.reset(new BitVector<false>(static_cast<char*>(sub_block_memory_) + sizeof(int),
num_node_groups));
initialized_ = true;
if (new_block) {
clearIndex();
} else {
num_free_node_groups_ = num_node_groups - node_group_used_bitmap_->onesCount();
if (num_free_node_groups_ > 0) {
next_free_node_group_ = node_group_used_bitmap_->firstZero();
DEBUG_ASSERT(static_cast<size_t>(next_free_node_group_) < node_group_used_bitmap_->size());
}
}
return true;
}
void CSBTreeIndexSubBlock::clearIndex() {
// Reset the free node group bitmap.
DEBUG_ASSERT(node_group_used_bitmap_->size() > 0);
node_group_used_bitmap_->clear();
next_free_node_group_ = 0;
num_free_node_groups_ = node_group_used_bitmap_->size();
// Allocate the root node.
setRootNodeGroupNumber(allocateNodeGroup());
DEBUG_ASSERT(getRootNodeGroupNumber() >= 0);
// Initialize the root node as an empty leaf node.
NodeHeader *root_header = static_cast<NodeHeader*>(getRootNode());
root_header->num_keys = 0;
root_header->is_leaf = true;
root_header->node_group_reference = kNodeGroupNone;
}
void* CSBTreeIndexSubBlock::makeKeyCopy(const tuple_id tuple) const {
DEBUG_ASSERT(tuple_store_.hasTupleWithID(tuple));
DEBUG_ASSERT(indexed_attribute_ids_.size() == indexed_attribute_offsets_.size());
ScopedBuffer key_copy(key_length_bytes_);
vector<attribute_id>::const_iterator attr_it = indexed_attribute_ids_.begin();
for (vector<size_t>::const_iterator offset_it = indexed_attribute_offsets_.begin();
offset_it != indexed_attribute_offsets_.end();
++attr_it, ++offset_it) {
TypedValue attr_value(tuple_store_.getAttributeValueTyped(tuple, *attr_it));
if (attr_value.isNull()) {
return NULL;
}
attr_value.copyInto(static_cast<char*>(key_copy.get()) + *offset_it);
}
return key_copy.release();
}
const void* CSBTreeIndexSubBlock::getLeastKey(const void *node) const {
if (static_cast<const NodeHeader*>(node)->is_leaf) {
if (static_cast<const NodeHeader*>(node)->num_keys) {
return static_cast<const char*>(node) + sizeof(NodeHeader);
} else {
return NULL;
}
} else {
DEBUG_ASSERT(static_cast<const NodeHeader*>(node)->num_keys);
const void *least_key = getLeastKey(getNode(static_cast<const NodeHeader*>(node)->node_group_reference, 0));
if (least_key == NULL) {
// If the leftmost child leaf was empty, can just use the first key here.
return static_cast<const char*>(node) + sizeof(NodeHeader);
}
return least_key;
}
}
template <typename LiteralLessKeyComparatorT,
typename KeyLessLiteralComparatorT>
void* CSBTreeIndexSubBlock::findLeaf(
const void *node,
const void *literal,
const LiteralLessKeyComparatorT &literal_less_key_comparator,
const KeyLessLiteralComparatorT &key_less_literal_comparator) const {
const NodeHeader *node_header = static_cast<const NodeHeader*>(node);
if (node_header->is_leaf) {
return const_cast<void*>(node);
}
for (uint16_t key_num = 0;
key_num < node_header->num_keys;
++key_num) {
if (literal_less_key_comparator.compareDataPtrsInl(literal,
static_cast<const char*>(node)
+ sizeof(NodeHeader)
+ key_num * key_length_bytes_)) {
return findLeaf(getNode(node_header->node_group_reference, key_num),
literal,
literal_less_key_comparator,
key_less_literal_comparator);
} else if (!key_less_literal_comparator.compareDataPtrsInl(static_cast<const char*>(node)
+ sizeof(NodeHeader)
+ key_num * key_length_bytes_,
literal)) {
// Handle the special case where duplicate keys are spread across
// multiple nodes.
// TODO(chasseur): If duplicate keys are not allowed, this branch is
// not necessary, and searches can be done more efficiently.
return findLeaf(getNode(node_header->node_group_reference, key_num),
literal,
literal_less_key_comparator,
key_less_literal_comparator);
}
}
return findLeaf(getNode(node_header->node_group_reference, node_header->num_keys),
literal,
literal_less_key_comparator,
key_less_literal_comparator);
}
void* CSBTreeIndexSubBlock::getLeftmostLeaf() const {
void* node = getRootNode();
while (!static_cast<const NodeHeader*>(node)->is_leaf) {
node = getNode(static_cast<const NodeHeader*>(node)->node_group_reference, 0);
}
return node;
}
template <typename CodeType>
CSBTreeIndexSubBlock::InsertReturnValue CSBTreeIndexSubBlock::compressedKeyAddEntryHelper(
const tuple_id tuple,
const std::uint32_t compressed_code) {
CodeType actual_code = compressed_code;
return rootInsertHelper(tuple,
&actual_code,
csbtree_internal::CompressedCodeLessComparator<CodeType>());
}
template <typename ComparatorT>
CSBTreeIndexSubBlock::InsertReturnValue CSBTreeIndexSubBlock::internalInsertHelper(
const int node_group_allocation_requirement,
const tuple_id tuple,
const void *key,
const ComparatorT &key_comparator,
const NodeHeader *parent_node_header,
void *node) {
DEBUG_ASSERT((node_group_allocation_requirement == 0) || (parent_node_header != NULL));
NodeHeader *node_header = static_cast<NodeHeader*>(node);
DEBUG_ASSERT(!node_header->is_leaf);
// Find the child to insert into.
uint16_t key_num;
for (key_num = 0;
key_num < node_header->num_keys;
++key_num) {
if (key_comparator.compareDataPtrsInl(key,
static_cast<char*>(node)
+ sizeof(NodeHeader)
+ key_num * key_length_bytes_)) {
break;
}
}
// Insert into the appropriate child.
void *child_node = getNode(node_header->node_group_reference, key_num);
int child_node_group_allocation_requirement = 0;
if (node_header->num_keys == max_keys_internal_) {
// If the child node is split, this node must also be split.
if (getRootNode() == node) {
// If this node is the root, make sure there is additional space for a
// new root.
DEBUG_ASSERT(node_group_allocation_requirement == 0);
child_node_group_allocation_requirement = 2;
} else {
child_node_group_allocation_requirement = node_group_allocation_requirement + 1;
}
} else {
// This node can accomodate an additional key without splitting.
child_node_group_allocation_requirement = 0;
}
InsertReturnValue child_return_value;
if (static_cast<NodeHeader*>(child_node)->is_leaf) {
child_return_value = leafInsertHelper(child_node_group_allocation_requirement,
tuple,
key,
key_comparator,
node_header,
child_node);
} else {
child_return_value = internalInsertHelper(child_node_group_allocation_requirement,
tuple,
key,
key_comparator,
node_header,
child_node);
}
if (child_return_value.new_node_group_id == kNodeGroupFull) {
// Insertion failed (out of space).
return child_return_value;
}
InsertReturnValue retval;
bool child_split_across_groups = !child_return_value.left_split_group_smaller
&& (key_num == small_half_num_children_);
if (child_return_value.new_node_group_id != kNodeGroupNone) {
// A new node group was allocated, and this node must be split.
DEBUG_ASSERT(child_return_value.split_node_least_key != NULL);
DEBUG_ASSERT(node_header->num_keys == max_keys_internal_);
const void *group_end = NULL;
if (node_group_allocation_requirement) {
// Parent node is full, must allocate new node group(s).
// Should already by checked by the child:
DEBUG_ASSERT(num_free_node_groups_ >= node_group_allocation_requirement);
// Split the node group.
group_end = splitNodeGroupHelper(parent_node_header, &node, &retval);
} else {
group_end = getNode(parent_node_header->node_group_reference, parent_node_header->num_keys + 1);
}
if (group_end == NULL) {
retval.split_node_least_key = splitNodeAcrossGroups(node,
retval.new_node_group_id,
child_return_value.new_node_group_id,
child_return_value.left_split_group_smaller,
child_split_across_groups);
} else {
retval.split_node_least_key = splitNodeInGroup(node,
group_end,