-
Notifications
You must be signed in to change notification settings - Fork 40
/
BaseTimeCoordinator.cpp
455 lines (418 loc) · 13.2 KB
/
BaseTimeCoordinator.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
/*
Copyright (c) 2017-2024,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#include "BaseTimeCoordinator.hpp"
#include "flagOperations.hpp"
#include "helics_definitions.hpp"
#include "json/json.h"
#include <algorithm>
#include <fmt/format.h>
#include <iostream>
#include <set>
#include <string>
#include <vector>
namespace helics {
static auto nullMessageFunction = [](const ActionMessage& /*unused*/) {};
BaseTimeCoordinator::BaseTimeCoordinator(): sendMessageFunction(nullMessageFunction) {}
BaseTimeCoordinator::BaseTimeCoordinator(
std::function<void(const ActionMessage&)> userSendMessageFunction):
sendMessageFunction(std::move(userSendMessageFunction))
{
if (!sendMessageFunction) {
sendMessageFunction = nullMessageFunction;
}
}
void BaseTimeCoordinator::setMessageSender(
std::function<void(const ActionMessage&)> userSendMessageFunction)
{
sendMessageFunction = std::move(userSendMessageFunction);
if (!sendMessageFunction) {
sendMessageFunction = nullMessageFunction;
}
}
void BaseTimeCoordinator::enteringExecMode(IterationRequest /*mode*/)
{
if (executionMode) {
return;
}
checkingExec = true;
if (!dependencies.empty()) {
updateTimeFactors();
auto res = dependencies.checkForIssues(false);
if (res.first != 0) {
ActionMessage error(CMD_GLOBAL_ERROR);
error.dest_id = parent_broker_id;
error.source_id = mSourceId;
error.messageID = res.first;
error.payload = res.second;
sendMessageFunction(error);
return;
}
}
bool fedOnly = true;
noParent = true;
for (const auto& dep : dependencies) {
if (dep.connection == ConnectionType::PARENT) {
fedOnly = false;
noParent = false;
break;
}
if (dep.connection == ConnectionType::CHILD && dep.fedID.isBroker()) {
fedOnly = false;
}
}
federatesOnly = fedOnly;
sendTimingInfo();
}
void BaseTimeCoordinator::disconnect()
{
if (disconnected) {
return;
}
if (dependencies.empty()) {
disconnected = true;
return;
}
ActionMessage bye(CMD_DISCONNECT);
bye.source_id = mSourceId;
if (dependencies.size() == 1) {
auto& dep = *dependencies.begin();
if ((dep.dependency && dep.next < Time::maxVal()) || dep.dependent) {
bye.dest_id = dep.fedID;
if (bye.dest_id == mSourceId) {
processTimeMessage(bye);
} else {
sendMessageFunction(bye);
}
}
} else {
ActionMessage multi(CMD_MULTI_MESSAGE);
bool hasLocal{false};
for (const auto& dep : dependencies) {
if ((dep.dependency && dep.next < Time::maxVal()) || dep.dependent) {
if (dep.fedID == mSourceId) {
hasLocal = true;
} else {
bye.dest_id = dep.fedID;
appendMessage(multi, bye);
}
}
}
if (hasLocal) {
bye.dest_id = mSourceId;
processTimeMessage(bye);
}
sendMessageFunction(multi);
}
disconnected = true;
}
void BaseTimeCoordinator::generateDebuggingTimeInfo(Json::Value& base) const
{
base["dependencies"] = Json::arrayValue;
base["federatesonly"] = federatesOnly;
base["sequenceCounter"] = sequenceCounter;
base["id"] = mSourceId.baseValue();
for (const auto& dep : dependencies) {
if (dep.dependency) {
Json::Value depblock;
generateJsonOutputDependency(depblock, dep);
base["dependencies"].append(depblock);
}
if (dep.dependent) {
base["dependents"].append(dep.fedID.baseValue());
}
}
}
Json::Value BaseTimeCoordinator::grantTimeoutCheck(const ActionMessage& cmd)
{
for (auto& dep : dependencies) {
if (dep.fedID == cmd.source_id) {
dep.timeoutCount = cmd.counter;
if (cmd.counter == 6) {
Json::Value base;
generateDebuggingTimeInfo(base);
return base;
}
}
}
return Json::nullValue;
}
bool BaseTimeCoordinator::isDependency(GlobalFederateId ofed) const
{
return dependencies.isDependency(ofed);
}
bool BaseTimeCoordinator::addDependency(GlobalFederateId fedID)
{
if (dependencies.addDependency(fedID)) {
if (fedID == mSourceId) {
auto* dep = dependencies.getDependencyInfo(fedID);
if (dep != nullptr) {
dep->connection = ConnectionType::SELF;
}
}
return true;
}
return false;
}
bool BaseTimeCoordinator::addDependent(GlobalFederateId fedID)
{
return dependencies.addDependent(fedID);
}
void BaseTimeCoordinator::setAsChild(GlobalFederateId fedID)
{
if (fedID == mSourceId) {
return;
}
auto* dep = dependencies.getDependencyInfo(fedID);
if (dep != nullptr) {
dep->connection = ConnectionType::CHILD;
}
}
void BaseTimeCoordinator::setAsParent(GlobalFederateId fedID)
{
if (fedID == mSourceId) {
return;
}
auto* dep = dependencies.getDependencyInfo(fedID);
if (dep != nullptr) {
dep->connection = ConnectionType::PARENT;
noParent = false;
}
}
void BaseTimeCoordinator::setVersion(GlobalFederateId fedID, std::int8_t version)
{
auto* dep = dependencies.getDependencyInfo(fedID);
if (dep != nullptr) {
dep->timingVersion = version;
}
}
GlobalFederateId BaseTimeCoordinator::getParent() const
{
for (const auto& dep : dependencies) {
if (dep.connection == ConnectionType::PARENT) {
return dep.fedID;
}
}
return {};
}
void BaseTimeCoordinator::removeDependency(GlobalFederateId fedID)
{
dependencies.removeDependency(fedID);
}
void BaseTimeCoordinator::removeDependent(GlobalFederateId fedID)
{
dependencies.removeDependent(fedID);
}
void BaseTimeCoordinator::resetDependency(GlobalFederateId fedID)
{
dependencies.resetDependency(fedID);
}
const DependencyInfo* BaseTimeCoordinator::getDependencyInfo(GlobalFederateId ofed) const
{
return dependencies.getDependencyInfo(ofed);
}
std::vector<GlobalFederateId> BaseTimeCoordinator::getDependencies() const
{
std::vector<GlobalFederateId> deps;
for (const auto& dep : dependencies) {
if (dep.dependency) {
deps.push_back(dep.fedID);
}
}
return deps;
}
std::vector<GlobalFederateId> BaseTimeCoordinator::getDependents() const
{
std::vector<GlobalFederateId> deps;
for (const auto& dep : dependencies) {
if (dep.dependent) {
deps.push_back(dep.fedID);
}
}
return deps;
}
Time BaseTimeCoordinator::getLastGrant(GlobalFederateId fedId) const
{
const auto* dep = dependencies.getDependencyInfo(fedId);
return (dep == nullptr) ? timeZero : dep->lastGrant;
}
bool BaseTimeCoordinator::hasActiveTimeDependencies() const
{
return dependencies.hasActiveTimeDependencies();
}
int BaseTimeCoordinator::dependencyCount() const
{
return dependencies.activeDependencyCount();
}
/** get a count of the active dependencies*/
GlobalFederateId BaseTimeCoordinator::getMinDependency() const
{
return dependencies.getMinDependency();
}
void BaseTimeCoordinator::sendTimingInfo()
{
ActionMessage tinfo(CMD_TIMING_INFO);
tinfo.source_id = mSourceId;
if (nonGranting) {
setActionFlag(tinfo, non_granting_flag);
}
if (delayedTiming) {
setActionFlag(tinfo, delayed_timing_flag);
}
tinfo.setExtraData(TIME_COORDINATOR_VERSION);
for (const auto& dep : dependencies) {
if (dep.dependent) {
tinfo.dest_id = dep.fedID;
sendMessageFunction(tinfo);
}
}
}
ActionMessage BaseTimeCoordinator::generateTimeRequest(const TimeData& dep,
GlobalFederateId fed,
std::int32_t responseCode) const
{
ActionMessage nTime(CMD_TIME_REQUEST);
nTime.source_id = mSourceId;
nTime.dest_id = fed;
nTime.actionTime = dep.next;
if (dep.interrupted) {
setActionFlag(nTime, interrupted_flag);
}
switch (dep.mTimeState) {
case TimeState::time_granted:
nTime.setAction(CMD_TIME_GRANT);
break;
case TimeState::time_requested:
nTime.setExtraData(dep.minFed.baseValue());
nTime.Tdemin = std::min(dep.minDe, dep.Te);
nTime.Te = dep.Te;
nTime.counter = sequenceCounter;
nTime.setExtraDestData(responseCode);
break;
case TimeState::time_requested_iterative:
nTime.setExtraData(dep.minFed.baseValue());
setIterationFlags(nTime, IterationRequest::ITERATE_IF_NEEDED);
nTime.Tdemin = std::min(dep.minDe, dep.Te);
nTime.Te = dep.Te;
nTime.counter = sequenceCounter;
nTime.setExtraDestData(responseCode);
break;
case TimeState::time_requested_require_iteration:
nTime.setExtraData(dep.minFed.baseValue());
setIterationFlags(nTime, IterationRequest::FORCE_ITERATION);
nTime.Tdemin = std::min(dep.minDe, dep.Te);
nTime.counter = sequenceCounter;
nTime.Te = dep.Te;
nTime.setExtraDestData(responseCode);
break;
case TimeState::exec_requested:
nTime.setAction(CMD_EXEC_REQUEST);
nTime.actionTime = Time::zeroVal();
nTime.counter = sequenceCounter;
nTime.setExtraDestData(responseCode);
break;
case TimeState::error:
nTime.setAction(CMD_IGNORE);
// no need to send updates for this
break;
case TimeState::exec_requested_iterative:
nTime.setAction(CMD_EXEC_REQUEST);
setIterationFlags(nTime, IterationRequest::ITERATE_IF_NEEDED);
nTime.setExtraData(dep.minFed.baseValue());
nTime.counter = sequenceCounter;
nTime.setExtraDestData(responseCode);
break;
case TimeState::exec_requested_require_iteration:
nTime.setAction(CMD_EXEC_REQUEST);
setIterationFlags(nTime, IterationRequest::FORCE_ITERATION);
nTime.setExtraData(dep.minFed.baseValue());
nTime.counter = sequenceCounter;
nTime.setExtraDestData(responseCode);
break;
case TimeState::initialized:
if (dep.responseSequenceCounter == 0) {
nTime.setAction(CMD_IGNORE);
} else {
nTime.setAction(CMD_EXEC_GRANT);
nTime.setExtraData(dep.minFed.baseValue());
setIterationFlags(nTime, IterationRequest::ITERATE_IF_NEEDED);
nTime.counter = sequenceCounter;
nTime.setExtraDestData(responseCode);
}
break;
}
return nTime;
}
TimeProcessingResult BaseTimeCoordinator::processTimeMessage(const ActionMessage& cmd)
{
switch (cmd.action()) {
case CMD_DISCONNECT:
case CMD_DISCONNECT_BROKER:
case CMD_DISCONNECT_FED:
case CMD_DISCONNECT_CORE:
case CMD_BROADCAST_DISCONNECT:
removeDependent(cmd.source_id);
break;
default:
break;
}
auto procRes = dependencies.updateTime(cmd);
if (procRes == TimeProcessingResult::PROCESSED_AND_CHECK) {
auto checkRes = dependencies.checkForIssues(false);
if (checkRes.first != 0) {
ActionMessage error(CMD_GLOBAL_ERROR);
error.dest_id = parent_broker_id;
error.source_id = mSourceId;
error.messageID = checkRes.first;
error.payload = checkRes.second;
sendMessageFunction(error);
}
}
return procRes;
}
void BaseTimeCoordinator::processDependencyUpdateMessage(const ActionMessage& cmd)
{
bool added{false};
switch (cmd.action()) {
case CMD_ADD_DEPENDENCY:
added = addDependency(cmd.source_id);
break;
case CMD_REMOVE_DEPENDENCY:
removeDependency(cmd.source_id);
break;
case CMD_ADD_DEPENDENT:
addDependent(cmd.source_id);
break;
case CMD_REMOVE_DEPENDENT:
removeDependent(cmd.source_id);
break;
case CMD_ADD_INTERDEPENDENCY:
added = addDependency(cmd.source_id);
addDependent(cmd.source_id);
break;
case CMD_REMOVE_INTERDEPENDENCY:
removeDependency(cmd.source_id);
removeDependent(cmd.source_id);
break;
case CMD_TIMING_INFO:
dependencies.updateTime(cmd);
break;
default:
break;
}
if (added) {
if (checkActionFlag(cmd, child_flag)) {
setAsChild(cmd.source_id);
}
if (checkActionFlag(cmd, parent_flag)) {
setAsParent(cmd.source_id);
}
if (cmd.counter > 0) {
setVersion(cmd.source_id, cmd.counter);
}
}
}
} // namespace helics