-
Notifications
You must be signed in to change notification settings - Fork 49
/
TransmissionPolicyManager.cpp
482 lines (424 loc) · 15.6 KB
/
TransmissionPolicyManager.cpp
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
//
// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
#include "TransmissionPolicyManager.hpp"
#include "TransmitProfiles.hpp"
#include "utils/Utils.hpp"
#include <limits>
namespace MAT_NS_BEGIN {
class PauseGuard {
public:
PauseGuard() = delete;
PauseGuard(ILogManager & logManager)
: m_logManager(logManager)
, m_unpaused(m_logManager.StartActivity())
{}
~PauseGuard()
{
if (m_unpaused) {
m_logManager.EndActivity();
}
}
bool isPaused()
{
return !m_unpaused;
}
private:
ILogManager& m_logManager;
bool m_unpaused;
};
template<typename T>
constexpr T Abs64(const T& a, const T& b) noexcept
{
return (a > b) ? (a - b) : (b - a);
}
MATSDK_LOG_INST_COMPONENT_CLASS(TransmissionPolicyManager, "EventsSDK.TPM", "Events telemetry client - TransmissionPolicyManager class");
TransmissionPolicyManager::TransmissionPolicyManager(ITelemetrySystem& system, ITaskDispatcher& taskDispatcher, IBandwidthController* bandwidthController) :
m_system(system),
m_taskDispatcher(taskDispatcher),
m_config(m_system.getConfig()),
m_bandwidthController(bandwidthController)
{
m_backoff = IBackoff::createFromConfig(m_backoffConfig);
assert(m_backoff);
m_deviceStateHandler.Start();
}
TransmissionPolicyManager::~TransmissionPolicyManager()
{
m_deviceStateHandler.Stop();
}
void TransmissionPolicyManager::checkBackoffConfigUpdate()
{
LOCKGUARD(m_backoffMutex);
std::string config = m_config.GetUploadRetryBackoffConfig();
if (config != m_backoffConfig)
{
std::unique_ptr<IBackoff> backoff = IBackoff::createFromConfig(config);
if (!backoff)
{
LOG_WARN("The new backoff configuration is invalid, continuing to use current settings");
}
else
{
m_backoff = std::move(backoff);
m_backoffConfig = config;
}
}
}
void TransmissionPolicyManager::resetBackoff()
{
LOCKGUARD(m_backoffMutex);
if (m_backoff)
m_backoff->reset();
}
std::chrono::milliseconds TransmissionPolicyManager::increaseBackoff()
{
LOCKGUARD(m_backoffMutex);
checkBackoffConfigUpdate();
if (m_backoff == nullptr)
{
return std::chrono::milliseconds{};
}
std::chrono::milliseconds delay{m_backoff->getValue()};
m_backoff->increase();
return delay;
}
// If delayInMs is negative, do not schedule.
void TransmissionPolicyManager::scheduleUpload(const std::chrono::milliseconds& delay, EventLatency latency, bool force)
{
PauseGuard guard(m_system.getLogManager());
if (guard.isPaused()) {
return;
}
LOCKGUARD(m_scheduledUploadMutex);
if (delay.count() < 0 || m_timerdelay.count() < 0)
{
LOG_TRACE("Negative delay(%d) or m_timerdelay(%d), no upload", delay.count(), m_timerdelay.count());
return;
}
if (m_scheduledUploadAborted)
{
LOG_TRACE("Scheduled upload aborted, no upload.");
return;
}
if (uploadCount() >= static_cast<uint32_t>(m_config[CFG_INT_MAX_PENDING_REQ]) )
{
LOG_TRACE("Maximum number of HTTP requests reached");
return;
}
if (m_isPaused)
{
LOG_TRACE("Paused, not uploading anything until resumed");
return;
}
updateTimersIfNecessary();
if (m_timers[0] < 0) {
latency = std::max(latency, EventLatency_RealTime); // low priority disabled by profile
}
if ((!force)&&(m_isUploadScheduled))
{
if (m_runningLatency > latency)
{
// Allow lower priority (normal) events to get thru in the next batch
m_runningLatency = latency;
}
auto now = PAL::getMonotonicTimeMs();
auto delta = Abs64(m_scheduledUploadTime, now);
if (delta <= static_cast<uint64_t>(delay.count()))
{
// Don't need to cancel and reschedule if it's about to happen now anyways.
// m_isUploadScheduled check does not have to be strictly atomic because
// the completion of upload will schedule more uploads as-needed, we only
// want to avoid the unnecessary wasteful rescheduling.
LOG_TRACE("WAIT upload %d ms for lat=%d", delta, m_runningLatency);
return;
}
}
// Cancel upload if already scheduled.
if (force || delay.count() == 0)
{
if (!cancelUploadTask())
{
LOG_TRACE("Upload either hasn't been scheduled or already done.");
}
}
// Schedule new upload
if (!m_isUploadScheduled.exchange(true))
{
m_scheduledUploadTime = PAL::getMonotonicTimeMs() + delay.count();
m_runningLatency = latency;
LOG_TRACE("SCHED upload %d ms for lat=%d", delay.count(), m_runningLatency);
m_scheduledUpload = PAL::scheduleTask(&m_taskDispatcher, static_cast<unsigned>(delay.count()), this, &TransmissionPolicyManager::uploadAsync, latency);
}
}
void TransmissionPolicyManager::uploadAsync(EventLatency latency)
{
PauseGuard guard(m_system.getLogManager());
if (guard.isPaused()) {
return;
}
m_runningLatency = latency;
m_scheduledUploadTime = std::numeric_limits<uint64_t>::max();
{
LOCKGUARD(m_scheduledUploadMutex);
m_isUploadScheduled = false; // Allow to schedule another uploadAsync
if ((m_isPaused) || (m_scheduledUploadAborted))
{
LOG_TRACE("Paused or upload aborted: cancel pending upload task.");
cancelUploadTask(); // If there is a pending upload task, kill it
return;
}
}
#ifdef ENABLE_BW_CONTROLLER /* Bandwidth controller is not currently supported */
if (m_bandwidthController) {
unsigned proposedBandwidthBps = m_bandwidthController->GetProposedBandwidthBps();
unsigned minimumBandwidthBps = m_config.GetMinimumUploadBandwidthBps();
if (proposedBandwidthBps >= minimumBandwidthBps) {
LOG_TRACE("Bandwidth controller proposed sufficient bandwidth %u bytes/sec (minimum accepted is %u)",
proposedBandwidthBps, minimumBandwidthBps);
}
else {
unsigned delayMs = 1000;
LOG_INFO("Bandwidth controller proposed bandwidth %u bytes/sec but minimum accepted is %u, will retry %u ms later",
proposedBandwidthBps, minimumBandwidthBps, delayMs);
scheduleUpload(delayMs, latency); // reschedule uploadAsync to run again 1000 ms later
return;
}
}
#endif
auto ctx = m_system.createEventsUploadContext();
ctx->requestedMinLatency = m_runningLatency;
addUpload(ctx);
initiateUpload(ctx);
}
void TransmissionPolicyManager::finishUpload(EventsUploadContextPtr const& ctx, const std::chrono::milliseconds& nextUpload)
{
LOG_TRACE("HTTP upload finished for ctx=%p", ctx.get());
if (!removeUpload(ctx))
{
assert(false);
LOG_WARN("HTTP NOT removing non-existing ctx from active uploads ctx=%p", ctx.get());
}
PauseGuard guard(m_system.getLogManager());
if (guard.isPaused()) {
return;
}
// Rescheduling upload
if (nextUpload.count() >= 0)
{
LOG_TRACE("Scheduling upload in %d ms", nextUpload.count());
EventLatency proposed = calculateNewPriority();
scheduleUpload(nextUpload, proposed); // reschedule uploadAsync again
}
}
bool TransmissionPolicyManager::updateTimersIfNecessary()
{
bool needsUpdate = TransmitProfiles::isTimerUpdateRequired();
if (needsUpdate)
{
TransmitProfiles::getTimers(m_timers);
}
return needsUpdate;
}
bool TransmissionPolicyManager::handleStart()
{
m_isPaused = false;
scheduleUpload(std::chrono::seconds{1}, calculateNewPriority());
return true;
}
/**
* Stop scheduling upload task, but don't wait for in-progress uploads to stop.
* Once paused we let all in-progress uploads to run to completion.
*/
bool TransmissionPolicyManager::handlePause()
{
pauseAllUploads();
return true;
}
/**
* Wait for all pending uploads to complete. This handler is invoked from
* TelemetrySystem::onStop after HCM has attempted to cancel all pending
* requests via hcm.cancelAllRequests. Since we don't directly couple TPM
* with HCM implementation, the system asks HCM to stop and TPM must wait
* for all callbacks to come.
*/
bool TransmissionPolicyManager::handleStop()
{
{
LOCKGUARD(m_scheduledUploadMutex);
// Prevent execution of all upload tasks
m_scheduledUploadAborted = true;
// Make sure we wait for completion of the upload scheduling task that may be running
cancelUploadTask();
}
// Make sure we wait for all active upload callbacks to finish
while (uploadCount() > 0)
{
std::this_thread::yield();
}
allUploadsFinished();
return true;
}
/**
* Wait for pending uploads to finish. This handler is invoked from
* TelemetrySystem::onCleanup after HCM has attempted to cancel all pending
* requests via hcm.cancelAllRequests. This won't abort the uploads in the end
* and is possible to resume the transmission
*/
bool TransmissionPolicyManager::handleCleanup()
{
cancelUploadTask();
// Make sure ongoing uploads are finished.
while (uploadCount() > 0)
{
std::this_thread::yield();
}
allUploadsFinished();
return true;
}
// Called from finishAllUploads
void TransmissionPolicyManager::handleFinishAllUploads()
{
// TODO: This pause appears to server no practical purpose? Issue 387
pauseAllUploads();
allUploadsFinished(); // calls stats.onStop >> this->flushTaskDispatcher;
}
void TransmissionPolicyManager::handleEventArrived(IncomingEventContextPtr const& event)
{
if (m_isPaused) {
return;
}
bool forceTimerRestart = false;
/* This logic needs to be revised: one event in a dedicated HTTP post is wasteful! */
// Initiate upload right away
if (event->record.latency > EventLatency_RealTime) {
auto ctx = m_system.createEventsUploadContext();
ctx->requestedMinLatency = event->record.latency;
addUpload(ctx);
initiateUpload(ctx);
return;
}
// Schedule async upload if not scheduled yet
if (!m_isUploadScheduled || TransmitProfiles::isTimerUpdateRequired())
{
if (updateTimersIfNecessary())
{
m_timerdelay = std::chrono::milliseconds { m_timers[1] };
forceTimerRestart = true;
}
EventLatency proposed = calculateNewPriority();
if (m_timerdelay.count() >= 0)
{
scheduleUpload(m_timerdelay, proposed, forceTimerRestart);
}
}
}
// We do only Normal if too few values or timers[0] == timers[2]
// We do only RealTime if timers[0] < 0 (do not transmit)
// We alternate RealTime and Normal otherwise (timers differ)
EventLatency TransmissionPolicyManager::calculateNewPriority()
{
updateTimersIfNecessary();
if (m_timers[0] == m_timers[1])
{
return EventLatency_Normal;
}
if (m_timers[0] < 0)
{
return EventLatency_RealTime;
}
if (m_runningLatency == EventLatency_RealTime)
{
return EventLatency_Normal;
}
return EventLatency_RealTime;
}
void TransmissionPolicyManager::handleNothingToUpload(EventsUploadContextPtr const& ctx)
{
LOG_TRACE("No stored events to send at the moment");
resetBackoff();
if (ctx->requestedMinLatency == EventLatency_Normal)
{
finishUpload(ctx, std::chrono::milliseconds{ -1 });
}
else
{
finishUpload(ctx, m_timerdelay);
}
}
void TransmissionPolicyManager::handlePackagingFailed(EventsUploadContextPtr const& ctx)
{
finishUpload(ctx, m_timerdelay);
}
void TransmissionPolicyManager::handleEventsUploadSuccessful(EventsUploadContextPtr const& ctx)
{
resetBackoff();
finishUpload(ctx, std::chrono::milliseconds{});
}
void TransmissionPolicyManager::handleEventsUploadRejected(EventsUploadContextPtr const& ctx)
{
finishUpload(ctx, increaseBackoff());
}
void TransmissionPolicyManager::handleEventsUploadFailed(EventsUploadContextPtr const& ctx)
{
finishUpload(ctx, increaseBackoff());
}
void TransmissionPolicyManager::handleEventsUploadAborted(EventsUploadContextPtr const& ctx)
{
finishUpload(ctx, std::chrono::milliseconds{ -1 });
}
void TransmissionPolicyManager::addUpload(EventsUploadContextPtr const& ctx)
{
LOCKGUARD(m_activeUploads_lock);
m_activeUploads.insert(ctx);
}
bool TransmissionPolicyManager::removeUpload(EventsUploadContextPtr const& ctx)
{
LOCKGUARD(m_activeUploads_lock);
auto it = m_activeUploads.find(ctx);
if (it != m_activeUploads.cend())
{
LOG_TRACE("HTTP removing from active uploads ctx=%p", ctx.get());
m_activeUploads.erase(it);
return true;
}
return false;
}
void TransmissionPolicyManager::pauseAllUploads()
{
PauseGuard guard(m_system.getLogManager());
m_isPaused = true;
cancelUploadTask();
}
std::chrono::milliseconds TransmissionPolicyManager::getCancelWaitTime() const noexcept
{
return (m_scheduledUploadAborted) ? DefaultTaskCancelTime : std::chrono::milliseconds {};
}
bool TransmissionPolicyManager::cancelUploadTask()
{
bool result = m_scheduledUpload.Cancel(getCancelWaitTime().count());
// TODO: There is a potential for upload tasks to not be canceled, especially if they aren't waited for.
// We either need a stronger guarantee here (could impact SDK performance), or a mechanism to
// ensure those tasks are canceled when the log manager is destroyed. Issue 388
if (result)
{
m_isUploadScheduled.exchange(false);
}
return result;
}
size_t TransmissionPolicyManager::uploadCount() const noexcept
{
LOCKGUARD(m_activeUploads_lock);
return m_activeUploads.size();
}
bool TransmissionPolicyManager::isUploadInProgress() const noexcept
{
// unfinished uploads that haven't processed callbacks or pending upload task
return (uploadCount() > 0) || m_isUploadScheduled;
}
bool TransmissionPolicyManager::isPaused() const noexcept
{
return m_isPaused;
}
} MAT_NS_END