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
|
/**
* Copyright (C) 2018-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 <string>
#include <utility>
#include "mongo/base/string_data.h"
#include "mongo/db/operation_context.h"
#include "mongo/stdx/mutex.h"
#include "mongo/util/concurrency/with_lock.h"
namespace mongo {
class ProgressMeter {
ProgressMeter(const ProgressMeter&) = delete;
ProgressMeter& operator=(const ProgressMeter&) = delete;
public:
ProgressMeter(unsigned long long total,
int secondsBetween = 3,
int checkInterval = 100,
std::string units = "",
std::string name = "Progress")
: _showTotal(true), _units(units), _name(std::move(name)) {
reset(total, secondsBetween, checkInterval);
}
ProgressMeter() {
_name = "Progress";
}
// typically you do ProgressMeterHolder
void reset(unsigned long long total, int secondsBetween = 3, int checkInterval = 100);
void finished() {
_active = false;
}
bool isActive() const {
return _active;
}
/**
* @param n how far along we are relative to the total # we set in CurOp::setMessage
* @return if row was printed
*/
bool hit(int n = 1);
void setUnits(const std::string& units) {
_units = units;
}
std::string getUnit() const {
return _units;
}
void setName(StringData name) {
stdx::lock_guard lk(_nameMutex);
_name = std::string{name};
}
std::string getName() const {
stdx::lock_guard lk(_nameMutex);
return _name;
}
void setTotalWhileRunning(unsigned long long total) {
_total = total;
}
unsigned long long done() const {
return _done;
}
unsigned long long hits() const {
return _hits;
}
unsigned long long total() const {
return _total;
}
void showTotal(bool doShow) {
_showTotal = doShow;
}
std::string toString() const;
bool operator==(const ProgressMeter& other) const {
return this == &other;
}
private:
bool _active{false};
unsigned long long _total;
bool _showTotal{true};
int _secondsBetween{3};
int _checkInterval{100};
unsigned long long _done;
unsigned long long _hits;
int _lastTime;
std::string _units;
mutable stdx::mutex _nameMutex; // NOLINT
std::string _name; // guarded by _nameMutex
};
/*
* Wraps a CurOp owned ProgressMeter and calls finished() when destructed. This may only exist as
* long as the underlying ProgressMeter.
*
* The underlying ProgressMeter will have the same locking requirements as CurOp (see CurOp class
* description). Accessors and modifiers on the underlying ProgressMeter may need to be performed
* while holding a client lock and specifying the WithLock argument. If accessing without a client
* lock, then the thread must be executing the associated OperationContext.
*/
class ProgressMeterHolder {
ProgressMeterHolder(const ProgressMeterHolder&) = delete;
ProgressMeterHolder& operator=(const ProgressMeterHolder&) = delete;
public:
ProgressMeterHolder() : _pm(nullptr) {}
~ProgressMeterHolder() {
if (_pm) {
{
stdx::unique_lock<Client> lk(*_opCtx->getClient());
_pm->finished();
}
}
}
void set(WithLock, ProgressMeter& pm, OperationContext* opCtx) {
_opCtx = opCtx;
_pm = ±
}
ProgressMeter* get(WithLock) {
return _pm;
}
private:
ProgressMeter* _pm;
OperationContext* _opCtx;
};
} // namespace mongo
|
