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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
#pragma once
#include <library/cpp/deprecated/atomic/atomic.h>
#include <util/datetime/base.h>
#include <util/system/mutex.h>
#include <util/system/hp_timer.h>
/* Token bucket.
* Makes flow of *inflow* units per second in average, with up to *capacity* bursts.
* Do not use for STRICT flow control.
*/
/* samples: create and use quoter sending 1000 bytes per second on average,
with up to 60 seconds quota buildup.
TBucketQuoter quoter(1000, 60000, NULL, NULL, NULL);
for (;;) {
T *msg = get_message();
quoter.Sleep();
quoter.Use(msg->GetSize());
send_message(msg);
}
----------------------------
TBucketQuoter quoter(1000, 60000, NULL, NULL, NULL);
for (;;) {
T *msg = get_message();
while (! quoter.IsAvail()) {
// do something else
}
quoter.Use(msg->GetSize());
send_message(msg);
}
*/
struct TInstantTimerMs {
using TTime = TInstant;
static constexpr ui64 Resolution = 1000ull; // milliseconds
static TTime Now() {
return TInstant::Now();
}
static ui64 Duration(TTime from, TTime to) {
return (to - from).MilliSeconds();
}
};
struct THPTimerUs {
using TTime = NHPTimer::STime;
static constexpr ui64 Resolution = 1000000ull; // microseconds
static TTime Now() {
NHPTimer::STime ret;
NHPTimer::GetTime(&ret);
return ret;
}
static ui64 Duration(TTime from, TTime to) {
i64 cycles = to - from;
if (cycles > 0) {
return ui64(double(cycles) * double(Resolution) / NHPTimer::GetClockRate());
} else {
return 0;
}
}
};
template <typename StatCounter, typename Lock = TMutex, typename Timer = TInstantTimerMs>
class TBucketQuoter {
public:
using TTime = typename Timer::TTime;
struct TResult {
i64 Before;
i64 After;
ui64 Seqno;
};
/* fixed quota */
TBucketQuoter(ui64 inflow, ui64 capacity, StatCounter* msgPassed = nullptr,
StatCounter* bucketUnderflows = nullptr, StatCounter* tokensUsed = nullptr,
StatCounter* usecWaited = nullptr, bool fill = false, StatCounter* aggregateInflow = nullptr)
: MsgPassed(msgPassed)
, BucketUnderflows(bucketUnderflows)
, TokensUsed(tokensUsed)
, UsecWaited(usecWaited)
, AggregateInflow(aggregateInflow)
, Bucket(fill ? capacity : 0)
, LastAdd(Timer::Now())
, InflowTokensPerSecond(&FixedInflow)
, BucketTokensCapacity(&FixedCapacity)
, FixedInflow(inflow)
, FixedCapacity(capacity)
{
/* no-op */
}
/* adjustable quotas */
TBucketQuoter(TAtomic* inflow, TAtomic* capacity, StatCounter* msgPassed = nullptr,
StatCounter* bucketUnderflows = nullptr, StatCounter* tokensUsed = nullptr,
StatCounter* usecWaited = nullptr, bool fill = false, StatCounter* aggregateInflow = nullptr)
: MsgPassed(msgPassed)
, BucketUnderflows(bucketUnderflows)
, TokensUsed(tokensUsed)
, UsecWaited(usecWaited)
, AggregateInflow(aggregateInflow)
, Bucket(fill ? AtomicGet(*capacity) : 0)
, LastAdd(Timer::Now())
, InflowTokensPerSecond(inflow)
, BucketTokensCapacity(capacity)
{
/* no-op */
}
bool IsAvail() {
TGuard<Lock> g(BucketMutex);
FillBucket();
if (Bucket < 0) {
if (BucketUnderflows) {
(*BucketUnderflows)++;
}
}
return (Bucket >= 0);
}
bool IsAvail(TResult& res) {
TGuard<Lock> g(BucketMutex);
res.Before = Bucket;
FillBucket();
res.After = Bucket;
res.Seqno = ++Seqno;
if (Bucket < 0) {
if (BucketUnderflows) {
(*BucketUnderflows)++;
}
}
return (Bucket >= 0);
}
ui64 GetAvail() {
TGuard<Lock> g(BucketMutex);
FillBucket();
return Max<i64>(0, Bucket);
}
ui64 GetAvail(TResult& res) {
TGuard<Lock> g(BucketMutex);
res.Before = Bucket;
FillBucket();
res.After = Bucket;
res.Seqno = ++Seqno;
return Max<i64>(0, Bucket);
}
void Use(ui64 tokens, bool sleep = false) {
TGuard<Lock> g(BucketMutex);
UseNoLock(tokens, sleep);
}
void Use(ui64 tokens, TResult& res, bool sleep = false) {
TGuard<Lock> g(BucketMutex);
res.Before = Bucket;
UseNoLock(tokens, sleep);
res.After = Bucket;
res.Seqno = ++Seqno;
}
i64 UseAndFill(ui64 tokens) {
TGuard<Lock> g(BucketMutex);
FillBucket();
UseNoLock(tokens);
return Bucket;
}
void Add(ui64 tokens) {
TGuard<Lock> g(BucketMutex);
AddNoLock(tokens);
}
void Add(ui64 tokens, TResult& res) {
TGuard<Lock> g(BucketMutex);
res.Before = Bucket;
AddNoLock(tokens);
res.After = Bucket;
res.Seqno = ++Seqno;
}
ui32 GetWaitTime() {
TGuard<Lock> g(BucketMutex);
FillBucket();
if (Bucket >= 0) {
return 0;
}
ui32 usec = (-Bucket * 1000000) / (*InflowTokensPerSecond);
return usec;
}
ui32 GetWaitTime(TResult& res) {
TGuard<Lock> g(BucketMutex);
res.Before = Bucket;
FillBucket();
res.After = Bucket;
res.Seqno = ++Seqno;
if (Bucket >= 0) {
return 0;
}
ui32 usec = (-Bucket * 1000000) / (*InflowTokensPerSecond);
return usec;
}
void Sleep() {
while (!IsAvail()) {
ui32 delay = GetWaitTime();
if (delay != 0) {
usleep(delay);
if (UsecWaited) {
(*UsecWaited) += delay;
}
}
}
}
private:
void FillBucket() {
TTime now = Timer::Now();
ui64 elapsed = Timer::Duration(LastAdd, now);
if (*InflowTokensPerSecond * elapsed >= Timer::Resolution) {
ui64 inflow = *InflowTokensPerSecond * elapsed / Timer::Resolution;
if (AggregateInflow) {
*AggregateInflow += inflow;
}
Bucket += inflow;
if (Bucket > *BucketTokensCapacity) {
Bucket = *BucketTokensCapacity;
}
LastAdd = now;
}
}
void UseNoLock(ui64 tokens, bool sleep = false) {
if (sleep)
Sleep();
Bucket -= tokens;
if (TokensUsed) {
(*TokensUsed) += tokens;
}
if (MsgPassed) {
(*MsgPassed)++;
}
}
void AddNoLock(ui64 tokens) {
Bucket += tokens;
if (Bucket > *BucketTokensCapacity) {
Bucket = *BucketTokensCapacity;
}
}
StatCounter* MsgPassed;
StatCounter* BucketUnderflows;
StatCounter* TokensUsed;
StatCounter* UsecWaited;
StatCounter* AggregateInflow;
i64 Bucket;
TTime LastAdd;
Lock BucketMutex;
ui64 Seqno = 0;
TAtomic* InflowTokensPerSecond;
TAtomic* BucketTokensCapacity;
TAtomic FixedInflow;
TAtomic FixedCapacity;
};
|
