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
|
/**
* Copyright (C) 2020-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.
*/
#include "mongo/db/exec/plan_cache_util.h"
#include "mongo/logv2/log.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kQuery
namespace mongo {
namespace plan_cache_util {
namespace log_detail {
void logTieForBest(std::string&& query,
double winnerScore,
double runnerUpScore,
std::string winnerPlanSummary,
std::string runnerUpPlanSummary) {
LOGV2_DEBUG(20594,
1,
"Winning plan tied with runner-up, skip caching",
"query"_attr = redact(query),
"winnerScore"_attr = winnerScore,
"winnerPlanSummary"_attr = winnerPlanSummary,
"runnerUpScore"_attr = runnerUpScore,
"runnerUpPlanSummary"_attr = runnerUpPlanSummary);
}
void logNotCachingZeroResults(std::string&& query, double score, std::string winnerPlanSummary) {
LOGV2_DEBUG(20595,
1,
"Winning plan had zero results, skip caching",
"query"_attr = redact(query),
"winnerScore"_attr = score,
"winnerPlanSummary"_attr = winnerPlanSummary);
}
void logNotCachingNoData(std::string&& solution) {
LOGV2_DEBUG(20596,
5,
"Not caching query because this solution has no cache data",
"solutions"_attr = redact(solution));
}
} // namespace log_detail
// TODO SERVER-75715: Remove hasSbeClusteredCollectionScan() and its calls once SBE support
// for clustered collection scans is fully implemented. This method exists temporarily to
// prevent caching of CC scan plans until the mentioned ticket adds parameterization for them.
bool hasSbeClusteredCollectionScan(const QuerySolutionNode* qsn) {
if (qsn->getType() == STAGE_COLLSCAN &&
static_cast<const CollectionScanNode*>(qsn)->doSbeClusteredCollectionScan()) {
return true;
}
for (const std::unique_ptr<QuerySolutionNode>& child : qsn->children) {
if (hasSbeClusteredCollectionScan(child.get())) {
return true;
}
}
return false;
}
void updatePlanCache(OperationContext* opCtx,
const MultipleCollectionAccessor& collections,
const CanonicalQuery& query,
const QuerySolution& solution,
const sbe::PlanStage& root,
const stage_builder::PlanStageData& data) {
// TODO SERVER-75715: remove hasSbeClusteredCollectionScan() call. This exists temporarily to
// prevent caching SBE clustered coll scan execution plans as they are not yet parameterized.
if (shouldCacheQuery(query) && collections.getMainCollection() &&
!hasSbeClusteredCollectionScan(solution.root())) {
auto key = plan_cache_key_factory::make(query, collections);
auto plan = std::make_unique<sbe::CachedSbePlan>(root.clone(), data);
plan->indexFilterApplied = solution.indexFilterApplied;
bool shouldOmitDiagnosticInformation =
CurOp::get(opCtx)->debug().shouldOmitDiagnosticInformation;
sbe::getPlanCache(opCtx).setPinned(
std::move(key),
canonical_query_encoder::computeHash(
canonical_query_encoder::encodeForPlanCacheCommand(query)),
std::move(plan),
opCtx->getServiceContext()->getPreciseClockSource()->now(),
buildDebugInfo(&solution),
shouldOmitDiagnosticInformation);
}
}
plan_cache_debug_info::DebugInfo buildDebugInfo(
const CanonicalQuery& query, std::unique_ptr<const plan_ranker::PlanRankingDecision> decision) {
// Strip projections on $-prefixed fields, as these are added by internal callers of the
// system and are not considered part of the user projection.
const FindCommandRequest& findCommand = query.getFindCommandRequest();
BSONObjBuilder projBuilder;
for (auto elem : findCommand.getProjection()) {
if (elem.fieldName()[0] == '$') {
continue;
}
projBuilder.append(elem);
}
plan_cache_debug_info::CreatedFromQuery createdFromQuery =
plan_cache_debug_info::CreatedFromQuery{
findCommand.getFilter().getOwned(),
findCommand.getSort().getOwned(),
projBuilder.obj().getOwned(),
query.getCollator() ? query.getCollator()->getSpec().toBSON() : BSONObj()};
return {std::move(createdFromQuery), std::move(decision)};
}
plan_cache_debug_info::DebugInfoSBE buildDebugInfo(const QuerySolution* solution) {
plan_cache_debug_info::DebugInfoSBE debugInfo;
if (!solution || !solution->root())
return debugInfo;
std::queue<const QuerySolutionNode*> queue;
queue.push(solution->root());
// Look through the QuerySolution to collect some static stat details.
while (!queue.empty()) {
auto node = queue.front();
queue.pop();
invariant(node);
switch (node->getType()) {
case STAGE_COUNT_SCAN: {
auto csn = static_cast<const CountScanNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(csn->index.identifier.catalogName);
break;
}
case STAGE_DISTINCT_SCAN: {
auto dn = static_cast<const DistinctNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(dn->index.identifier.catalogName);
break;
}
case STAGE_GEO_NEAR_2D: {
auto geo2d = static_cast<const GeoNear2DNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(geo2d->index.identifier.catalogName);
break;
}
case STAGE_GEO_NEAR_2DSPHERE: {
auto geo2dsphere = static_cast<const GeoNear2DSphereNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(
geo2dsphere->index.identifier.catalogName);
break;
}
case STAGE_IXSCAN: {
auto ixn = static_cast<const IndexScanNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(ixn->index.identifier.catalogName);
break;
}
case STAGE_COLUMN_SCAN: {
auto cisn = static_cast<const ColumnIndexScanNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(cisn->indexEntry.identifier.catalogName);
break;
}
case STAGE_TEXT_MATCH: {
auto tn = static_cast<const TextMatchNode*>(node);
debugInfo.mainStats.indexesUsed.push_back(tn->index.identifier.catalogName);
break;
}
case STAGE_COLLSCAN: {
debugInfo.mainStats.collectionScans++;
auto csn = static_cast<const CollectionScanNode*>(node);
if (!csn->tailable) {
debugInfo.mainStats.collectionScansNonTailable++;
}
break;
}
case STAGE_EQ_LOOKUP: {
auto eln = static_cast<const EqLookupNode*>(node);
auto& secondaryStats = debugInfo.secondaryStats[eln->foreignCollection.toString()];
if (eln->lookupStrategy == EqLookupNode::LookupStrategy::kIndexedLoopJoin) {
tassert(6466200, "Index join lookup should have an index entry", eln->idxEntry);
secondaryStats.indexesUsed.push_back(eln->idxEntry->identifier.catalogName);
} else {
secondaryStats.collectionScans++;
}
[[fallthrough]];
}
default:
break;
}
for (auto&& child : node->children) {
queue.push(child.get());
}
}
debugInfo.planSummary = solution->summaryString();
return debugInfo;
}
} // namespace plan_cache_util
} // namespace mongo
|
