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
|
/**
* Copyright (C) 2022-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <cstddef>
#include <sys/types.h>
#include "mongo/db/query/ce/histogram_estimation.h"
#include "mongo/db/query/ce/scalar_histogram.h"
#include "mongo/db/query/optimizer/cascades/interfaces.h"
#include "mongo/db/query/optimizer/opt_phase_manager.h"
namespace mongo {
namespace optimizer {
namespace cascades {
// Forward declaration.
class CEInterface;
} // namespace cascades
} // namespace optimizer
namespace ce {
using namespace optimizer;
using namespace sbe;
// Enable this flag to log all estimates, and let all tests pass.
constexpr bool kCETestLogOnly = false;
const double kMaxCEError = 0.01;
const CEType kInvalidCardinality = -1.0;
const OptPhaseManager::PhaseSet kDefaultCETestPhaseSet{OptPhase::MemoSubstitutionPhase,
OptPhase::MemoExplorationPhase,
OptPhase::MemoImplementationPhase};
const OptPhaseManager::PhaseSet kOnlySubPhaseSet{OptPhase::MemoSubstitutionPhase};
const OptPhaseManager::PhaseSet kNoOptPhaseSet{};
/**
* Helpful macros for asserting that the CE of a $match predicate is approximately what we were
* expecting.
*/
#define _ASSERT_MATCH_CE(ce, predicate, expectedCE) \
if constexpr (kCETestLogOnly) { \
if (std::abs(ce.getCE(predicate) - expectedCE) > kMaxCEError) { \
std::cout << "ERROR: cardinality " << ce.getCE(predicate) << " expected " \
<< expectedCE << std::endl; \
} \
ASSERT_APPROX_EQUAL(1.0, 1.0, kMaxCEError); \
} else { \
ASSERT_APPROX_EQUAL(expectedCE, ce.getCE(predicate), kMaxCEError); \
}
#define _PREDICATE(field, predicate) (str::stream() << "{" << field << ": " << predicate "}")
#define _ELEMMATCH_PREDICATE(field, predicate) \
(str::stream() << "{" << field << ": {$elemMatch: " << predicate << "}}")
// This macro verifies the cardinality of a pipeline with a single $match predicate.
#define ASSERT_MATCH_CE(ce, predicate, expectedCE) _ASSERT_MATCH_CE(ce, predicate, expectedCE)
#define ASSERT_MATCH_CE_CARD(ce, predicate, expectedCE, collCard) \
ce.setCollCard(collCard); \
ASSERT_MATCH_CE(ce, predicate, expectedCE)
// This macro tests cardinality of two versions of the predicate; with and without $elemMatch.
#define ASSERT_EQ_ELEMMATCH_CE(tester, expectedCE, elemMatchExpectedCE, field, predicate) \
ASSERT_MATCH_CE(tester, _PREDICATE(field, predicate), expectedCE); \
ASSERT_MATCH_CE(tester, _ELEMMATCH_PREDICATE(field, predicate), elemMatchExpectedCE)
/**
* A test utility class for helping verify the cardinality of CE transports on a given $match
* predicate.
*/
class CETester {
public:
CETester(std::string collName,
double numRecords,
const OptPhaseManager::PhaseSet& optPhases = kDefaultCETestPhaseSet);
/**
* Returns the estimated cardinality of a given 'matchPredicate'.
*/
CEType getCE(const std::string& matchPredicate) const;
/**
* Returns the estimated cardinality of a given 'abt'.
*/
CEType getCE(ABT& abt) const;
void setCollCard(double card) {
_collCard = card;
}
void setIndexes(opt::unordered_map<std::string, IndexDefinition>&& indexes) {
_indexes = std::move(indexes);
}
protected:
/**
* Subclasses need to override this method to initialize the transports they are testing.
*/
virtual std::unique_ptr<cascades::CEInterface> getCETransport() const = 0;
private:
std::string _collName;
// The number of records in the collection we are testing.
double _collCard;
// Phases to use when optimizing an input query.
const OptPhaseManager::PhaseSet& _optPhases;
opt::unordered_map<std::string, IndexDefinition> _indexes;
mutable PrefixId _prefixId;
};
/**
* Test utility for helping with creation of manual histograms in the unit tests.
*/
struct BucketData {
Value _v;
double _equalFreq;
double _rangeFreq;
double _ndv;
BucketData(Value v, double equalFreq, double rangeFreq, double ndv)
: _v(v), _equalFreq(equalFreq), _rangeFreq(rangeFreq), _ndv(ndv) {}
BucketData(const std::string& v, double equalFreq, double rangeFreq, double ndv)
: BucketData(Value(v), equalFreq, rangeFreq, ndv) {}
BucketData(int v, double equalFreq, double rangeFreq, double ndv)
: BucketData(Value(v), equalFreq, rangeFreq, ndv) {}
};
ScalarHistogram createHistogram(const std::vector<BucketData>& data);
double estimateIntValCard(const ScalarHistogram& hist, int v, EstimationType type);
} // namespace ce
} // namespace mongo
|
