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
|
/**
* Copyright (C) 2021-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 "mongo/db/query/canonical_query_encoder.h"
#include "mongo/db/query/plan_cache_debug_info.h"
namespace mongo {
// The logging facility enforces the rule that logging should not be done in a header file. Since
// template classes and functions below must be defined in the header file and since they use the
// logging facility, we have to define the helper functions below to perform the actual logging
// operation from template code.
namespace log_detail {
void logInactiveCacheEntry(const std::string& key);
void logCacheEviction(NamespaceString nss, std::string&& evictedEntry);
void logCreateInactiveCacheEntry(std::string&& query,
std::string&& queryHash,
std::string&& planCacheKey,
size_t newWorks);
void logReplaceActiveCacheEntry(std::string&& query,
std::string&& queryHash,
std::string&& planCacheKey,
size_t works,
size_t newWorks);
void logNoop(std::string&& query,
std::string&& queryHash,
std::string&& planCacheKey,
size_t works,
size_t newWorks);
void logIncreasingWorkValue(std::string&& query,
std::string&& queryHash,
std::string&& planCacheKey,
size_t works,
size_t increasedWorks);
void logPromoteCacheEntry(std::string&& query,
std::string&& queryHash,
std::string&& planCacheKey,
size_t works,
size_t newWorks);
} // namespace log_detail
template <class CachedPlanType, class DebugInfo>
class PlanCacheEntryBase;
struct SolutionCacheData;
/**
* Encapsulates callback functions used to perform a custom action when the plan cache state
* changes.
*/
template <typename KeyType, typename CachedPlanType, typename DebugInfoType>
class PlanCacheCallbacks {
public:
virtual ~PlanCacheCallbacks() = default;
virtual void onCreateInactiveCacheEntry(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const = 0;
virtual void onReplaceActiveCacheEntry(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const = 0;
virtual void onNoopActiveCacheEntry(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const = 0;
virtual void onIncreasingWorkValue(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const = 0;
virtual void onPromoteCacheEntry(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const = 0;
virtual DebugInfoType buildDebugInfo() const = 0;
virtual uint32_t getPlanCacheCommandKeyHash() const = 0;
};
/**
* Simple logging callbacks for the plan cache.
*/
template <typename KeyType, typename CachedPlanType, typename DebugInfoType>
class PlanCacheCallbacksImpl : public PlanCacheCallbacks<KeyType, CachedPlanType, DebugInfoType> {
public:
PlanCacheCallbacksImpl(const CanonicalQuery& cq) : _cq{cq} {}
PlanCacheCallbacksImpl(const CanonicalQuery& cq, std::function<DebugInfoType()> buildDebugInfo)
: _cq{cq}, _buildDebugInfoCallBack(buildDebugInfo) {}
void onCreateInactiveCacheEntry(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const final {
auto&& [queryHash, planCacheKey] = hashes(key, oldEntry);
log_detail::logCreateInactiveCacheEntry(
_cq.toStringShort(), std::move(queryHash), std::move(planCacheKey), newWorks);
}
void onReplaceActiveCacheEntry(
const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const final {
invariant(oldEntry);
invariant(oldEntry->works);
auto&& [queryHash, planCacheKey] = hashes(key, oldEntry);
log_detail::logReplaceActiveCacheEntry(_cq.toStringShort(),
std::move(queryHash),
std::move(planCacheKey),
oldEntry->works.get(),
newWorks);
}
void onNoopActiveCacheEntry(const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const final {
invariant(oldEntry);
invariant(oldEntry->works);
auto&& [queryHash, planCacheKey] = hashes(key, oldEntry);
log_detail::logNoop(_cq.toStringShort(),
std::move(queryHash),
std::move(planCacheKey),
oldEntry->works.get(),
newWorks);
}
void onIncreasingWorkValue(const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const final {
invariant(oldEntry);
invariant(oldEntry->works);
auto&& [queryHash, planCacheKey] = hashes(key, oldEntry);
log_detail::logIncreasingWorkValue(_cq.toStringShort(),
std::move(queryHash),
std::move(planCacheKey),
oldEntry->works.get(),
newWorks);
}
void onPromoteCacheEntry(const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry,
size_t newWorks) const final {
invariant(oldEntry);
invariant(oldEntry->works);
auto&& [queryHash, planCacheKey] = hashes(key, oldEntry);
log_detail::logPromoteCacheEntry(_cq.toStringShort(),
std::move(queryHash),
std::move(planCacheKey),
oldEntry->works.get(),
newWorks);
}
DebugInfoType buildDebugInfo() const final {
tassert(6407401, "_buildDebugInfoCallBack should be callable", _buildDebugInfoCallBack);
return _buildDebugInfoCallBack();
}
uint32_t getPlanCacheCommandKeyHash() const final {
return canonical_query_encoder::computeHash(
canonical_query_encoder::encodeForPlanCacheCommand(_cq));
}
private:
auto hashes(const KeyType& key,
const PlanCacheEntryBase<CachedPlanType, DebugInfoType>* oldEntry) const {
// Avoid recomputing the hashes if we've got an old entry to grab them from.
return oldEntry
? std::make_pair(zeroPaddedHex(oldEntry->queryHash),
zeroPaddedHex(oldEntry->planCacheKey))
: std::make_pair(zeroPaddedHex(key.queryHash()), zeroPaddedHex(key.planCacheKeyHash()));
}
const CanonicalQuery& _cq;
std::function<DebugInfoType()> _buildDebugInfoCallBack;
};
} // namespace mongo
|
