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
|
/**
* 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 <cstddef>
#include <cstdint>
#include <functional>
#include <type_traits>
namespace mongo {
/**
* During the runtime planning phase this tracker is used to track the progress of the work done
* so far. A plan stage in a candidate execution tree may supply the number of documents it has
* processed, or the number of physical reads performed, and the tracker will use it to check if
* the execution plan has progressed enough.
*/
class TrialRunTracker final {
public:
/**
* The type of metric which can be collected and tracked during a trial run.
*/
enum TrialRunMetric : uint8_t {
// Number of documents returned during a trial run.
kNumResults,
// Number of physical reads performed during a trial run. Once a storage cursor advances,
// it counts as a single physical read.
kNumReads,
// Must always be the last element to hold the number of element in the enum.
kLastElem
};
/**
* Constructs a 'TrialRunTracker' which indicates that the trial period is over when any
* 'TrialRunMetric' exceeds the maximum provided at construction.
*
* Callers can also pass a value of zero to indicate that the given metric should not be
* tracked.
*/
template <typename... MaxMetrics,
std::enable_if_t<sizeof...(MaxMetrics) == TrialRunMetric::kLastElem, int> = 0>
TrialRunTracker(MaxMetrics... maxMetrics) : _maxMetrics{maxMetrics...} {}
/**
* Constructs a 'TrialRunTracker' that also has an '_onMetricReached' function, which gets
* called when any 'TrialRunMetric' exceeds its maximum. When an '_onMetricReached' callback is
* present, it must return true for 'trackProgress' to return true. By returning false,
* '_onMetricReached' can prevent tracking from halting plan execution, thereby upgrading a
* trial run to a normal run.
*/
template <typename... MaxMetrics>
TrialRunTracker(std::function<bool(TrialRunMetric)> onMetricReached, MaxMetrics... maxMetrics)
: TrialRunTracker{maxMetrics...} {
_onMetricReached = std::move(onMetricReached);
}
/**
* Increments the trial run metric specified as a template parameter 'metric' by the
* 'metricIncrement' value and, if the updated metric value has exceeded its maximum, calls the
* '_onMetricReached' if there is one and returns true (unless '_onMetricReached' returned
* false).
*
* This is a no-op, and will return false, if the given metric is not being tracked by this
* 'TrialRunTracker'.
*
* If the metric has already exceeded its maximum value before this call, this method
* returns 'true' immediately without incrementing the metric.
*/
template <TrialRunMetric metric>
bool trackProgress(size_t metricIncrement) {
static_assert(metric >= 0 && metric < sizeof(_metrics) / sizeof(size_t));
if (_maxMetrics[metric] == 0) {
// This metric is not being tracked.
return false;
}
if (_done) {
return true;
}
_metrics[metric] += metricIncrement;
if (_metrics[metric] > _maxMetrics[metric]) {
if (_onMetricReached) {
_done = _onMetricReached(metric);
} else {
_done = true;
}
}
return _done;
}
template <TrialRunMetric metric>
size_t getMetric() const {
static_assert(metric >= 0 && metric < sizeof(_metrics) / sizeof(size_t));
return _metrics[metric];
}
template <TrialRunMetric metric>
void updateMaxMetric(size_t newMaxMetric) {
static_assert(metric >= 0 && metric < sizeof(_metrics) / sizeof(size_t));
_maxMetrics[metric] = newMaxMetric;
}
private:
size_t _maxMetrics[TrialRunMetric::kLastElem];
size_t _metrics[TrialRunMetric::kLastElem]{0};
bool _done{false};
std::function<bool(TrialRunMetric)> _onMetricReached{};
};
} // namespace mongo
|
