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
|
/**
* 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.
*/
#pragma once
#include "mongo/db/exec/plan_stats.h"
#include "mongo/db/query/stage_types.h"
namespace mongo::sbe {
struct CommonStats {
CommonStats() = delete;
CommonStats(StringData stageType, PlanNodeId nodeId) : stageType{stageType}, nodeId{nodeId} {}
uint64_t estimateObjectSizeInBytes() const {
return sizeof(*this);
}
const StringData stageType;
// An identifier for the node, or zero if the idenfier was not provided. Useful for displaying
// debug output such as explain.
//
// These identifiers are not necessarily unique. For example, they can be used by code
// constructing the SBE plan to construct groups of nodes with the same id, e.g. if a group of
// PlanStages corresponds to an MQL operation specified by the user.
const PlanNodeId nodeId;
// Time elapsed while working inside this stage. When this field is set to boost::none,
// timing info will not be collected during query execution.
//
// The field must be populated when running explain or when running with the profiler on. It
// must also be populated when multi planning, in order to gather stats stored in the plan
// cache.
boost::optional<long long> executionTimeMillis;
size_t advances{0};
size_t opens{0};
size_t closes{0};
size_t yields{0};
size_t unyields{0};
bool isEOF{false};
};
using PlanStageStats = BasePlanStageStats<CommonStats>;
struct ScanStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<ScanStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
void accumulate(PlanSummaryStats& stats) const final {
stats.totalDocsExamined += numReads;
}
size_t numReads{0};
};
struct IndexScanStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<IndexScanStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const {
return sizeof(*this);
}
void accumulate(PlanSummaryStats& stats) const final {
stats.totalKeysExamined += numReads;
}
size_t numReads{0};
size_t seeks{0};
};
struct FilterStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<FilterStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
size_t numTested{0};
};
struct LimitSkipStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<LimitSkipStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
boost::optional<long long> limit;
boost::optional<long long> skip;
};
struct UniqueStats : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<UniqueStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
size_t dupsTested = 0;
size_t dupsDropped = 0;
};
struct BranchStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<BranchStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
size_t numTested{0};
size_t thenBranchOpens{0};
size_t thenBranchCloses{0};
size_t elseBranchOpens{0};
size_t elseBranchCloses{0};
};
struct CheckBoundsStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<CheckBoundsStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
size_t seeks{0};
};
struct LoopJoinStats final : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<LoopJoinStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
size_t innerOpens{0};
size_t innerCloses{0};
};
struct TraverseStats : public SpecificStats {
std::unique_ptr<SpecificStats> clone() const final {
return std::make_unique<TraverseStats>(*this);
}
uint64_t estimateObjectSizeInBytes() const final {
return sizeof(*this);
}
size_t innerOpens{0};
size_t innerCloses{0};
};
/**
* Calculates the total number of physical reads in the given plan stats tree. If a stage can do
* a physical read (e.g. COLLSCAN or IXSCAN), then its 'numReads' stats is added to the total.
*/
size_t calculateNumberOfReads(const PlanStageStats* root);
} // namespace mongo::sbe
|
