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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
|
#ifndef FWCore_Framework_Worker_h
#define FWCore_Framework_Worker_h
/*----------------------------------------------------------------------
Worker: this is a basic scheduling unit - an abstract base class to
something that is really a producer or filter.
A worker will not actually call through to the module unless it is
in a Ready state. After a module is actually run, the state will not
be Ready. The Ready state can only be reestablished by doing a reset().
Pre/post module signals are posted only in the Ready state.
Execution statistics are kept here.
If a module has thrown an exception during execution, that exception
will be rethrown if the worker is entered again and the state is not Ready.
In other words, execution results (status) are cached and reused until
the worker is reset().
----------------------------------------------------------------------*/
#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/Common/interface/FWCoreCommonFwd.h"
#include "FWCore/MessageLogger/interface/ExceptionMessages.h"
#include "FWCore/Framework/interface/TransitionInfoTypes.h"
#include "FWCore/Framework/interface/maker/WorkerParams.h"
#include "FWCore/Framework/interface/ExceptionActions.h"
#include "FWCore/Framework/interface/ModuleContextSentry.h"
#include "FWCore/Framework/interface/OccurrenceTraits.h"
#include "FWCore/Framework/interface/ProductResolverIndexAndSkipBit.h"
#include "FWCore/Concurrency/interface/WaitingTask.h"
#include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
#include "FWCore/Concurrency/interface/WaitingTaskList.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ServiceRegistry/interface/ActivityRegistry.h"
#include "FWCore/ServiceRegistry/interface/ServiceRegistryfwd.h"
#include "FWCore/ServiceRegistry/interface/InternalContext.h"
#include "FWCore/ServiceRegistry/interface/ModuleCallingContext.h"
#include "FWCore/ServiceRegistry/interface/ParentContext.h"
#include "FWCore/ServiceRegistry/interface/PathContext.h"
#include "FWCore/ServiceRegistry/interface/PlaceInPathContext.h"
#include "FWCore/ServiceRegistry/interface/ServiceRegistry.h"
#include "FWCore/ServiceRegistry/interface/ServiceRegistryfwd.h"
#include "FWCore/Concurrency/interface/SerialTaskQueueChain.h"
#include "FWCore/Concurrency/interface/LimitedTaskQueue.h"
#include "FWCore/Concurrency/interface/FunctorTask.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "FWCore/Utilities/interface/ConvertException.h"
#include "FWCore/Utilities/interface/BranchType.h"
#include "FWCore/Utilities/interface/ProductResolverIndex.h"
#include "FWCore/Utilities/interface/StreamID.h"
#include "FWCore/Utilities/interface/propagate_const.h"
#include "FWCore/Utilities/interface/thread_safety_macros.h"
#include "FWCore/Utilities/interface/ESIndices.h"
#include "FWCore/Utilities/interface/Transition.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include <array>
#include <atomic>
#include <cassert>
#include <map>
#include <memory>
#include <sstream>
#include <string>
#include <vector>
#include <exception>
#include <unordered_map>
namespace edm {
class EventPrincipal;
class EventSetupImpl;
class EarlyDeleteHelper;
class ProductResolverIndexHelper;
class ProductResolverIndexAndSkipBit;
class ProductRegistry;
class ThinnedAssociationsHelper;
namespace workerhelper {
template <typename O>
class CallImpl;
}
namespace eventsetup {
struct ComponentDescription;
class ESRecordsToProductResolverIndices;
} // namespace eventsetup
class Worker {
public:
enum State { Ready, Pass, Fail, Exception };
enum Types { kAnalyzer, kFilter, kProducer, kOutputModule };
enum ConcurrencyTypes { kGlobal, kLimited, kOne, kStream };
struct TaskQueueAdaptor {
SerialTaskQueueChain* serial_ = nullptr;
LimitedTaskQueue* limited_ = nullptr;
TaskQueueAdaptor() = default;
TaskQueueAdaptor(SerialTaskQueueChain* iChain) : serial_(iChain) {}
TaskQueueAdaptor(LimitedTaskQueue* iLimited) : limited_(iLimited) {}
operator bool() { return serial_ != nullptr or limited_ != nullptr; }
template <class F>
void push(oneapi::tbb::task_group& iG, F&& iF) {
if (serial_) {
serial_->push(iG, iF);
} else {
limited_->push(iG, iF);
}
}
};
Worker(ModuleDescription const& iMD, ExceptionToActionTable const* iActions);
virtual ~Worker();
Worker(Worker const&) = delete; // Disallow copying and moving
Worker& operator=(Worker const&) = delete; // Disallow copying and moving
void clearModule() {
moduleValid_ = false;
doClearModule();
}
virtual bool wantsProcessBlocks() const noexcept = 0;
virtual bool wantsInputProcessBlocks() const noexcept = 0;
virtual bool wantsGlobalRuns() const noexcept = 0;
virtual bool wantsGlobalLuminosityBlocks() const noexcept = 0;
virtual bool wantsStreamRuns() const noexcept = 0;
virtual bool wantsStreamLuminosityBlocks() const noexcept = 0;
virtual SerialTaskQueue* globalRunsQueue() = 0;
virtual SerialTaskQueue* globalLuminosityBlocksQueue() = 0;
void prePrefetchSelectionAsync(oneapi::tbb::task_group&,
WaitingTask* task,
ServiceToken const&,
StreamID stream,
EventPrincipal const*) noexcept;
void prePrefetchSelectionAsync(
oneapi::tbb::task_group&, WaitingTask* task, ServiceToken const&, StreamID stream, void const*) noexcept {
assert(false);
}
template <typename T>
void doWorkAsync(WaitingTaskHolder,
typename T::TransitionInfoType const&,
ServiceToken const&,
StreamID,
ParentContext const&,
typename T::Context const*) noexcept;
template <typename T>
void doWorkNoPrefetchingAsync(WaitingTaskHolder,
typename T::TransitionInfoType const&,
ServiceToken const&,
StreamID,
ParentContext const&,
typename T::Context const*) noexcept;
template <typename T>
std::exception_ptr runModuleDirectly(typename T::TransitionInfoType const&,
StreamID,
ParentContext const&,
typename T::Context const*) noexcept;
virtual size_t transformIndex(edm::ProductDescription const&) const noexcept = 0;
void doTransformAsync(WaitingTaskHolder,
size_t iTransformIndex,
EventPrincipal const&,
ServiceToken const&,
StreamID,
ModuleCallingContext const&,
StreamContext const*) noexcept;
void callWhenDoneAsync(WaitingTaskHolder task) { waitingTasks_.add(std::move(task)); }
void skipOnPath(EventPrincipal const& iEvent);
void beginJob(GlobalContext const&);
void endJob(GlobalContext const&);
void beginStream(StreamID, StreamContext const&);
void endStream(StreamID, StreamContext const&);
void respondToOpenInputFile(FileBlock const& fb) { implRespondToOpenInputFile(fb); }
void respondToCloseInputFile(FileBlock const& fb) { implRespondToCloseInputFile(fb); }
void respondToCloseOutputFile() { implRespondToCloseOutputFile(); }
void registerThinnedAssociations(ProductRegistry const& registry, ThinnedAssociationsHelper& helper);
void reset() {
cached_exception_ = std::exception_ptr();
state_ = Ready;
waitingTasks_.reset();
workStarted_ = false;
numberOfPathsLeftToRun_ = numberOfPathsOn_;
}
void postDoEvent(EventPrincipal const&);
ModuleDescription const* description() const noexcept {
if (moduleValid_) {
return moduleCallingContext_.moduleDescription();
}
return nullptr;
}
///The signals are required to live longer than the last call to 'doWork'
/// this was done to improve performance based on profiling
void setActivityRegistry(std::shared_ptr<ActivityRegistry> areg);
void setEarlyDeleteHelper(EarlyDeleteHelper* iHelper);
//Used to make EDGetToken work
virtual void updateLookup(BranchType iBranchType, ProductResolverIndexHelper const&) = 0;
virtual void updateLookup(eventsetup::ESRecordsToProductResolverIndices const&) = 0;
virtual void releaseMemoryPostLookupSignal() = 0;
virtual void selectInputProcessBlocks(ProductRegistry const&, ProcessBlockHelperBase const&) = 0;
virtual void resolvePutIndicies(
BranchType iBranchType,
std::unordered_multimap<std::string, std::tuple<TypeID const*, const char*, edm::ProductResolverIndex>> const&
iIndicies) = 0;
virtual void modulesWhoseProductsAreConsumed(
std::array<std::vector<ModuleDescription const*>*, NumBranchTypes>& modules,
ProductRegistry const& preg,
std::map<std::string, ModuleDescription const*> const& labelsToDesc) const = 0;
virtual void esModulesWhoseProductsAreConsumed(
std::array<std::vector<eventsetup::ComponentDescription const*>*, kNumberOfEventSetupTransitions>& esModules,
eventsetup::ESRecordsToProductResolverIndices const&) const = 0;
virtual void convertCurrentProcessAlias(std::string const& processName) = 0;
virtual std::vector<ModuleConsumesInfo> moduleConsumesInfos() const = 0;
virtual std::vector<ModuleConsumesESInfo> moduleConsumesESInfos(
eventsetup::ESRecordsToProductResolverIndices const&) const = 0;
virtual Types moduleType() const = 0;
virtual ConcurrencyTypes moduleConcurrencyType() const = 0;
void clearCounters() noexcept {
timesRun_.store(0, std::memory_order_release);
timesVisited_.store(0, std::memory_order_release);
timesPassed_.store(0, std::memory_order_release);
timesFailed_.store(0, std::memory_order_release);
timesExcept_.store(0, std::memory_order_release);
}
void addedToPath() noexcept { ++numberOfPathsOn_; }
//NOTE: calling state() is done to force synchronization across threads
int timesRun() const noexcept { return timesRun_.load(std::memory_order_acquire); }
int timesVisited() const noexcept { return timesVisited_.load(std::memory_order_acquire); }
int timesPassed() const noexcept { return timesPassed_.load(std::memory_order_acquire); }
int timesFailed() const noexcept { return timesFailed_.load(std::memory_order_acquire); }
int timesExcept() const noexcept { return timesExcept_.load(std::memory_order_acquire); }
State state() const noexcept { return state_; }
int timesPass() const noexcept { return timesPassed(); } // for backward compatibility only - to be removed soon
virtual bool hasAccumulator() const noexcept = 0;
// Used in PuttableProductResolver
edm::WaitingTaskList& waitingTaskList() noexcept { return waitingTasks_; }
protected:
template <typename O>
friend class workerhelper::CallImpl;
virtual void doClearModule() = 0;
virtual std::string workerType() const = 0;
virtual bool implDo(EventTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual void itemsToGetForSelection(std::vector<ProductResolverIndexAndSkipBit>&) const = 0;
virtual bool implNeedToRunSelection() const noexcept = 0;
virtual void implDoAcquire(EventTransitionInfo const&, ModuleCallingContext const*, WaitingTaskHolder&&) = 0;
virtual void implDoTransformAsync(WaitingTaskHolder,
size_t iTransformIndex,
EventPrincipal const&,
ParentContext const&,
ServiceWeakToken const&) noexcept = 0;
virtual ProductResolverIndex itemToGetForTransform(size_t iTransformIndex) const noexcept = 0;
virtual bool implDoPrePrefetchSelection(StreamID, EventPrincipal const&, ModuleCallingContext const*) = 0;
virtual bool implDoBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*) = 0;
virtual bool implDoAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*) = 0;
virtual bool implDoEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*) = 0;
virtual bool implDoBegin(RunTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoStreamBegin(StreamID, RunTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoStreamEnd(StreamID, RunTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoEnd(RunTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoBegin(LumiTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoStreamBegin(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoStreamEnd(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual bool implDoEnd(LumiTransitionInfo const&, ModuleCallingContext const*) = 0;
virtual void implBeginJob() = 0;
virtual void implEndJob() = 0;
virtual void implBeginStream(StreamID) = 0;
virtual void implEndStream(StreamID) = 0;
void resetModuleDescription(ModuleDescription const*);
ActivityRegistry* activityRegistry() { return actReg_.get(); }
private:
template <typename T>
bool runModule(typename T::TransitionInfoType const&, StreamID, ParentContext const&, typename T::Context const*);
virtual void itemsToGet(BranchType, std::vector<ProductResolverIndexAndSkipBit>&) const = 0;
virtual void itemsMayGet(BranchType, std::vector<ProductResolverIndexAndSkipBit>&) const = 0;
virtual std::vector<ProductResolverIndexAndSkipBit> const& itemsToGetFrom(BranchType) const = 0;
virtual std::vector<ESResolverIndex> const& esItemsToGetFrom(Transition) const = 0;
virtual std::vector<ESRecordIndex> const& esRecordsToGetFrom(Transition) const = 0;
virtual void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
ModuleCallingContext const& moduleCallingContext,
Principal const& iPrincipal) const noexcept = 0;
virtual void implRespondToOpenInputFile(FileBlock const& fb) = 0;
virtual void implRespondToCloseInputFile(FileBlock const& fb) = 0;
virtual void implRespondToCloseOutputFile() = 0;
virtual void implRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) = 0;
virtual TaskQueueAdaptor serializeRunModule() = 0;
bool shouldRethrowException(std::exception_ptr iPtr,
ParentContext const& parentContext,
bool isEvent,
bool isTryToContinue) const noexcept;
void checkForShouldTryToContinue(ModuleDescription const&);
template <bool IS_EVENT>
bool setPassed() {
if (IS_EVENT) {
timesPassed_.fetch_add(1, std::memory_order_relaxed);
}
state_ = Pass;
return true;
}
template <bool IS_EVENT>
bool setFailed() {
if (IS_EVENT) {
timesFailed_.fetch_add(1, std::memory_order_relaxed);
}
state_ = Fail;
return false;
}
template <bool IS_EVENT>
std::exception_ptr setException(std::exception_ptr iException) {
if (IS_EVENT) {
timesExcept_.fetch_add(1, std::memory_order_relaxed);
}
cached_exception_ = iException; // propagate_const<T> has no reset() function
state_ = Exception;
return cached_exception_;
}
template <typename T>
void prefetchAsync(WaitingTaskHolder,
ServiceToken const&,
ParentContext const&,
typename T::TransitionInfoType const&,
Transition) noexcept;
void esPrefetchAsync(WaitingTaskHolder, EventSetupImpl const&, Transition, ServiceToken const&) noexcept;
void edPrefetchAsync(WaitingTaskHolder, ServiceToken const&, Principal const&) const noexcept;
bool needsESPrefetching(Transition iTrans) const noexcept {
return iTrans < edm::Transition::NumberOfEventSetupTransitions ? not esItemsToGetFrom(iTrans).empty() : false;
}
void emitPostModuleEventPrefetchingSignal() {
actReg_->postModuleEventPrefetchingSignal_.emit(*moduleCallingContext_.getStreamContext(), moduleCallingContext_);
}
void emitPostModuleStreamPrefetchingSignal() {
actReg_->postModuleStreamPrefetchingSignal_.emit(*moduleCallingContext_.getStreamContext(),
moduleCallingContext_);
}
void emitPostModuleGlobalPrefetchingSignal() {
actReg_->postModuleGlobalPrefetchingSignal_.emit(*moduleCallingContext_.getGlobalContext(),
moduleCallingContext_);
}
virtual bool hasAcquire() const noexcept = 0;
template <typename T>
std::exception_ptr runModuleAfterAsyncPrefetch(std::exception_ptr,
typename T::TransitionInfoType const&,
StreamID,
ParentContext const&,
typename T::Context const*) noexcept;
// runAcquire() must take a copy of WaitingTaskHolder
// see comment in runAcquireAfterAsyncPrefetch() definition
void runAcquire(EventTransitionInfo const&, ParentContext const&, WaitingTaskHolder);
void runAcquireAfterAsyncPrefetch(std::exception_ptr,
EventTransitionInfo const&,
ParentContext const&,
WaitingTaskHolder) noexcept;
std::exception_ptr handleExternalWorkException(std::exception_ptr iEPtr,
ParentContext const& parentContext) noexcept;
template <typename T>
class RunModuleTask : public WaitingTask {
public:
RunModuleTask(Worker* worker,
typename T::TransitionInfoType const& transitionInfo,
ServiceToken const& token,
StreamID streamID,
ParentContext const& parentContext,
typename T::Context const* context,
oneapi::tbb::task_group* iGroup) noexcept
: m_worker(worker),
m_transitionInfo(transitionInfo),
m_streamID(streamID),
m_parentContext(parentContext),
m_context(context),
m_serviceToken(token),
m_group(iGroup) {}
struct EnableQueueGuard {
SerialTaskQueue* queue_;
EnableQueueGuard(SerialTaskQueue* iQueue) : queue_{iQueue} {}
EnableQueueGuard(EnableQueueGuard const&) = delete;
EnableQueueGuard& operator=(EnableQueueGuard const&) = delete;
EnableQueueGuard& operator=(EnableQueueGuard&&) = delete;
EnableQueueGuard(EnableQueueGuard&& iGuard) : queue_{iGuard.queue_} { iGuard.queue_ = nullptr; }
~EnableQueueGuard() {
if (queue_) {
queue_->resume();
}
}
};
void execute() final {
//Need to make the services available early so other services can see them
ServiceRegistry::Operate guard(m_serviceToken.lock());
//incase the emit causes an exception, we need a memory location
// to hold the exception_ptr
std::exception_ptr temp_excptr;
auto excptr = exceptionPtr();
if constexpr (T::isEvent_) {
if (!m_worker->hasAcquire()) {
// Caught exception is passed to Worker::runModuleAfterAsyncPrefetch(), which propagates it via WaitingTaskList
CMS_SA_ALLOW try {
//pre was called in prefetchAsync
m_worker->emitPostModuleEventPrefetchingSignal();
} catch (...) {
temp_excptr = std::current_exception();
if (not excptr) {
excptr = temp_excptr;
}
}
}
} else if constexpr (std::is_same_v<typename T::Context, StreamContext>) {
m_worker->emitPostModuleStreamPrefetchingSignal();
} else if constexpr (std::is_same_v<typename T::Context, GlobalContext>) {
m_worker->emitPostModuleGlobalPrefetchingSignal();
}
if (not excptr) {
if (auto queue = m_worker->serializeRunModule()) {
auto f = [worker = m_worker,
info = m_transitionInfo,
streamID = m_streamID,
parentContext = m_parentContext,
sContext = m_context,
serviceToken = m_serviceToken]() {
//Need to make the services available
ServiceRegistry::Operate operateRunModule(serviceToken.lock());
//If needed, we pause the queue in begin transition and resume it
// at the end transition. This can guarantee that the module
// only processes one run or lumi at a time
EnableQueueGuard enableQueueGuard{workerhelper::CallImpl<T>::enableGlobalQueue(worker)};
std::exception_ptr ptr;
worker->template runModuleAfterAsyncPrefetch<T>(ptr, info, streamID, parentContext, sContext);
};
//keep another global transition from running if necessary
auto gQueue = workerhelper::CallImpl<T>::pauseGlobalQueue(m_worker);
if (gQueue) {
gQueue->push(*m_group, [queue, gQueue, f, group = m_group]() mutable {
gQueue->pause();
queue.push(*group, std::move(f));
});
} else {
queue.push(*m_group, std::move(f));
}
return;
}
}
m_worker->runModuleAfterAsyncPrefetch<T>(excptr, m_transitionInfo, m_streamID, m_parentContext, m_context);
}
private:
Worker* m_worker;
typename T::TransitionInfoType m_transitionInfo;
StreamID m_streamID;
ParentContext const m_parentContext;
typename T::Context const* m_context;
ServiceWeakToken m_serviceToken;
oneapi::tbb::task_group* m_group;
};
// AcquireTask is only used for the Event case, but we define
// it as a template so all cases will compile.
// DUMMY exists to work around the C++ Standard prohibition on
// fully specializing templates nested in other classes.
template <typename T, typename DUMMY = void>
class AcquireTask : public WaitingTask {
public:
AcquireTask(Worker*,
typename T::TransitionInfoType const&,
ServiceToken const&,
ParentContext const&,
WaitingTaskHolder) noexcept {}
void execute() final {}
};
template <typename DUMMY>
class AcquireTask<OccurrenceTraits<EventPrincipal, BranchActionStreamBegin>, DUMMY> : public WaitingTask {
public:
AcquireTask(Worker* worker,
EventTransitionInfo const& eventTransitionInfo,
ServiceToken const& token,
ParentContext const& parentContext,
WaitingTaskHolder holder) noexcept
: m_worker(worker),
m_eventTransitionInfo(eventTransitionInfo),
m_parentContext(parentContext),
m_holder(std::move(holder)),
m_serviceToken(token) {}
void execute() final {
//Need to make the services available early so other services can see them
ServiceRegistry::Operate guard(m_serviceToken.lock());
//incase the emit causes an exception, we need a memory location
// to hold the exception_ptr
std::exception_ptr temp_excptr;
auto excptr = exceptionPtr();
// Caught exception is passed to Worker::runModuleAfterAsyncPrefetch(), which propagates it via WaitingTaskHolder
CMS_SA_ALLOW try {
//pre was called in prefetchAsync
m_worker->emitPostModuleEventPrefetchingSignal();
} catch (...) {
temp_excptr = std::current_exception();
if (not excptr) {
excptr = temp_excptr;
}
}
if (not excptr) {
if (auto queue = m_worker->serializeRunModule()) {
queue.push(*m_holder.group(),
[worker = m_worker,
info = m_eventTransitionInfo,
parentContext = m_parentContext,
serviceToken = m_serviceToken,
holder = std::move(m_holder)]() mutable {
//Need to make the services available
ServiceRegistry::Operate operateRunAcquire(serviceToken.lock());
std::exception_ptr ptr;
worker->runAcquireAfterAsyncPrefetch(ptr, info, parentContext, std::move(holder));
});
return;
}
}
m_worker->runAcquireAfterAsyncPrefetch(excptr, m_eventTransitionInfo, m_parentContext, std::move(m_holder));
}
private:
Worker* m_worker;
EventTransitionInfo m_eventTransitionInfo;
ParentContext const m_parentContext;
WaitingTaskHolder m_holder;
ServiceWeakToken m_serviceToken;
};
// This class does nothing unless there is an exception originating
// in an "External Worker". In that case, it handles converting the
// exception to a CMS exception and adding context to the exception.
class HandleExternalWorkExceptionTask : public WaitingTask {
public:
HandleExternalWorkExceptionTask(Worker* worker,
oneapi::tbb::task_group* group,
WaitingTask* runModuleTask,
ParentContext const& parentContext) noexcept;
void execute() final;
private:
Worker* m_worker;
WaitingTask* m_runModuleTask;
oneapi::tbb::task_group* m_group;
ParentContext const m_parentContext;
};
std::atomic<int> timesRun_;
std::atomic<int> timesVisited_;
std::atomic<int> timesPassed_;
std::atomic<int> timesFailed_;
std::atomic<int> timesExcept_;
std::atomic<State> state_;
int numberOfPathsOn_;
std::atomic<int> numberOfPathsLeftToRun_;
ModuleCallingContext moduleCallingContext_;
ExceptionToActionTable const* actions_; // memory assumed to be managed elsewhere
CMS_THREAD_GUARD(state_) std::exception_ptr cached_exception_; // if state is 'exception'
std::shared_ptr<ActivityRegistry> actReg_; // We do not use propagate_const because the registry itself is mutable.
edm::propagate_const<EarlyDeleteHelper*> earlyDeleteHelper_;
edm::WaitingTaskList waitingTasks_;
std::atomic<bool> workStarted_;
bool ranAcquireWithoutException_;
bool moduleValid_ = true;
bool shouldTryToContinue_ = false;
bool beginSucceeded_ = false;
};
namespace {
template <typename T>
class ModuleSignalSentry {
public:
ModuleSignalSentry(ActivityRegistry* a,
typename T::Context const* context,
ModuleCallingContext const* moduleCallingContext)
: a_(a), context_(context), moduleCallingContext_(moduleCallingContext) {}
~ModuleSignalSentry() {
// This destructor does nothing unless we are unwinding the
// the stack from an earlier exception (a_ will be null if we are
// are not). We want to report the earlier exception and ignore any
// addition exceptions from the post module signal.
CMS_SA_ALLOW try {
if (a_) {
T::postModuleSignal(a_, context_, moduleCallingContext_);
}
} catch (...) {
}
}
void preModuleSignal() {
if (a_) {
try {
convertException::wrap([this]() { T::preModuleSignal(a_, context_, moduleCallingContext_); });
} catch (cms::Exception& ex) {
ex.addContext("Handling pre module signal, likely in a service function immediately before module method");
throw;
}
}
}
void postModuleSignal() {
if (a_) {
auto temp = a_;
// Setting a_ to null informs the destructor that the signal
// was already run and that it should do nothing.
a_ = nullptr;
try {
convertException::wrap([this, temp]() { T::postModuleSignal(temp, context_, moduleCallingContext_); });
} catch (cms::Exception& ex) {
ex.addContext("Handling post module signal, likely in a service function immediately after module method");
throw;
}
}
}
private:
ActivityRegistry* a_; // We do not use propagate_const because the registry itself is mutable.
typename T::Context const* context_;
ModuleCallingContext const* moduleCallingContext_;
};
} // namespace
namespace workerhelper {
template <>
class CallImpl<OccurrenceTraits<EventPrincipal, BranchActionStreamBegin>> {
public:
typedef OccurrenceTraits<EventPrincipal, BranchActionStreamBegin> Arg;
static bool call(Worker* iWorker,
StreamID,
EventTransitionInfo const& info,
ActivityRegistry* /* actReg */,
ModuleCallingContext const* mcc,
Arg::Context const* /* context*/) {
//Signal sentry is handled by the module
return iWorker->implDo(info, mcc);
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
EventTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return true; }
static bool needToRunSelection(Worker const* iWorker) noexcept { return iWorker->implNeedToRunSelection(); }
static SerialTaskQueue* pauseGlobalQueue(Worker*) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<RunPrincipal, BranchActionGlobalBegin>> {
public:
typedef OccurrenceTraits<RunPrincipal, BranchActionGlobalBegin> Arg;
static bool call(Worker* iWorker,
StreamID,
RunTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
// If preModuleSignal() throws, implDoBegin() is not called, and the
// cpp destructor calls postModuleSignal (ignoring additional exceptions)
cpp.preModuleSignal();
// If implDoBegin() throws, the cpp destructor calls postModuleSignal
// (ignoring additional exceptions)
auto returnValue = iWorker->implDoBegin(info, mcc);
// If postModuleSignal() throws, the exception will propagate to the framework
cpp.postModuleSignal();
iWorker->beginSucceeded_ = true;
return returnValue;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
RunTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsGlobalRuns(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return iWorker->globalRunsQueue(); }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<RunPrincipal, BranchActionStreamBegin>> {
public:
typedef OccurrenceTraits<RunPrincipal, BranchActionStreamBegin> Arg;
static bool call(Worker* iWorker,
StreamID id,
RunTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoStreamBegin(id, info, mcc);
cpp.postModuleSignal();
iWorker->beginSucceeded_ = true;
return returnValue;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
RunTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsStreamRuns(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<RunPrincipal, BranchActionGlobalEnd>> {
public:
typedef OccurrenceTraits<RunPrincipal, BranchActionGlobalEnd> Arg;
static bool call(Worker* iWorker,
StreamID,
RunTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
if (iWorker->beginSucceeded_) {
iWorker->beginSucceeded_ = false;
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoEnd(info, mcc);
cpp.postModuleSignal();
return returnValue;
}
return true;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
RunTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsGlobalRuns(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker* iWorker) noexcept { return iWorker->globalRunsQueue(); }
};
template <>
class CallImpl<OccurrenceTraits<RunPrincipal, BranchActionStreamEnd>> {
public:
typedef OccurrenceTraits<RunPrincipal, BranchActionStreamEnd> Arg;
static bool call(Worker* iWorker,
StreamID id,
RunTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
if (iWorker->beginSucceeded_) {
iWorker->beginSucceeded_ = false;
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoStreamEnd(id, info, mcc);
cpp.postModuleSignal();
return returnValue;
}
return true;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
RunTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsStreamRuns(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<LuminosityBlockPrincipal, BranchActionGlobalBegin>> {
public:
using Arg = OccurrenceTraits<LuminosityBlockPrincipal, BranchActionGlobalBegin>;
static bool call(Worker* iWorker,
StreamID,
LumiTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoBegin(info, mcc);
cpp.postModuleSignal();
iWorker->beginSucceeded_ = true;
return returnValue;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
LumiTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsGlobalLuminosityBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept {
return iWorker->globalLuminosityBlocksQueue();
}
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<LuminosityBlockPrincipal, BranchActionStreamBegin>> {
public:
using Arg = OccurrenceTraits<LuminosityBlockPrincipal, BranchActionStreamBegin>;
static bool call(Worker* iWorker,
StreamID id,
LumiTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoStreamBegin(id, info, mcc);
cpp.postModuleSignal();
iWorker->beginSucceeded_ = true;
return returnValue;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
LumiTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsStreamLuminosityBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<LuminosityBlockPrincipal, BranchActionGlobalEnd>> {
public:
using Arg = OccurrenceTraits<LuminosityBlockPrincipal, BranchActionGlobalEnd>;
static bool call(Worker* iWorker,
StreamID,
LumiTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
if (iWorker->beginSucceeded_) {
iWorker->beginSucceeded_ = false;
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoEnd(info, mcc);
cpp.postModuleSignal();
return returnValue;
}
return true;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
LumiTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsGlobalLuminosityBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker* iWorker) noexcept {
return iWorker->globalLuminosityBlocksQueue();
}
};
template <>
class CallImpl<OccurrenceTraits<LuminosityBlockPrincipal, BranchActionStreamEnd>> {
public:
using Arg = OccurrenceTraits<LuminosityBlockPrincipal, BranchActionStreamEnd>;
static bool call(Worker* iWorker,
StreamID id,
LumiTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
if (iWorker->beginSucceeded_) {
iWorker->beginSucceeded_ = false;
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoStreamEnd(id, info, mcc);
cpp.postModuleSignal();
return returnValue;
}
return true;
}
static void esPrefetchAsync(Worker* worker,
WaitingTaskHolder waitingTask,
ServiceToken const& token,
LumiTransitionInfo const& info,
Transition transition) noexcept {
worker->esPrefetchAsync(waitingTask, info.eventSetupImpl(), transition, token);
}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsStreamLuminosityBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<ProcessBlockPrincipal, BranchActionGlobalBegin>> {
public:
using Arg = OccurrenceTraits<ProcessBlockPrincipal, BranchActionGlobalBegin>;
static bool call(Worker* iWorker,
StreamID,
ProcessBlockTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoBeginProcessBlock(info.principal(), mcc);
cpp.postModuleSignal();
iWorker->beginSucceeded_ = true;
return returnValue;
}
static void esPrefetchAsync(
Worker*, WaitingTaskHolder, ServiceToken const&, ProcessBlockTransitionInfo const&, Transition) noexcept {}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsProcessBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<ProcessBlockPrincipal, BranchActionProcessBlockInput>> {
public:
using Arg = OccurrenceTraits<ProcessBlockPrincipal, BranchActionProcessBlockInput>;
static bool call(Worker* iWorker,
StreamID,
ProcessBlockTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoAccessInputProcessBlock(info.principal(), mcc);
cpp.postModuleSignal();
return returnValue;
}
static void esPrefetchAsync(
Worker*, WaitingTaskHolder, ServiceToken const&, ProcessBlockTransitionInfo const&, Transition) noexcept {}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsInputProcessBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
template <>
class CallImpl<OccurrenceTraits<ProcessBlockPrincipal, BranchActionGlobalEnd>> {
public:
using Arg = OccurrenceTraits<ProcessBlockPrincipal, BranchActionGlobalEnd>;
static bool call(Worker* iWorker,
StreamID,
ProcessBlockTransitionInfo const& info,
ActivityRegistry* actReg,
ModuleCallingContext const* mcc,
Arg::Context const* context) {
if (iWorker->beginSucceeded_) {
iWorker->beginSucceeded_ = false;
ModuleSignalSentry<Arg> cpp(actReg, context, mcc);
cpp.preModuleSignal();
auto returnValue = iWorker->implDoEndProcessBlock(info.principal(), mcc);
cpp.postModuleSignal();
return returnValue;
}
return true;
}
static void esPrefetchAsync(
Worker*, WaitingTaskHolder, ServiceToken const&, ProcessBlockTransitionInfo const&, Transition) noexcept {}
static bool wantsTransition(Worker const* iWorker) noexcept { return iWorker->wantsProcessBlocks(); }
static bool needToRunSelection(Worker const* iWorker) noexcept { return false; }
static SerialTaskQueue* pauseGlobalQueue(Worker* iWorker) noexcept { return nullptr; }
static SerialTaskQueue* enableGlobalQueue(Worker*) noexcept { return nullptr; }
};
} // namespace workerhelper
template <typename T>
void Worker::prefetchAsync(WaitingTaskHolder iTask,
ServiceToken const& token,
ParentContext const& parentContext,
typename T::TransitionInfoType const& transitionInfo,
Transition iTransition) noexcept {
Principal const& principal = transitionInfo.principal();
moduleCallingContext_.setContext(ModuleCallingContext::State::kPrefetching, parentContext, nullptr);
if constexpr (T::isEvent_) {
actReg_->preModuleEventPrefetchingSignal_.emit(*moduleCallingContext_.getStreamContext(), moduleCallingContext_);
} else if constexpr (std::is_same_v<typename T::Context, StreamContext>) {
actReg_->preModuleStreamPrefetchingSignal_.emit(*moduleCallingContext_.getStreamContext(), moduleCallingContext_);
} else if constexpr (std::is_same_v<typename T::Context, GlobalContext>) {
actReg_->preModuleGlobalPrefetchingSignal_.emit(*moduleCallingContext_.getGlobalContext(), moduleCallingContext_);
}
workerhelper::CallImpl<T>::esPrefetchAsync(this, iTask, token, transitionInfo, iTransition);
edPrefetchAsync(iTask, token, principal);
if (principal.branchType() == InEvent) {
preActionBeforeRunEventAsync(iTask, moduleCallingContext_, principal);
}
}
template <typename T>
void Worker::doWorkAsync(WaitingTaskHolder task,
typename T::TransitionInfoType const& transitionInfo,
ServiceToken const& token,
StreamID streamID,
ParentContext const& parentContext,
typename T::Context const* context) noexcept {
if (not workerhelper::CallImpl<T>::wantsTransition(this)) {
return;
}
//Need to check workStarted_ before adding to waitingTasks_
bool expected = false;
bool workStarted = workStarted_.compare_exchange_strong(expected, true);
waitingTasks_.add(task);
if constexpr (T::isEvent_) {
timesVisited_.fetch_add(1, std::memory_order_relaxed);
}
if (workStarted) {
moduleCallingContext_.setContext(ModuleCallingContext::State::kPrefetching, parentContext, nullptr);
//if have TriggerResults based selection we want to reject the event before doing prefetching
if (workerhelper::CallImpl<T>::needToRunSelection(this)) {
//We need to run the selection in a different task so that
// we can prefetch the data needed for the selection
WaitingTask* moduleTask =
new RunModuleTask<T>(this, transitionInfo, token, streamID, parentContext, context, task.group());
//make sure the task is either run or destroyed
struct DestroyTask {
DestroyTask(edm::WaitingTask* iTask) noexcept : m_task(iTask) {}
~DestroyTask() noexcept {
auto p = m_task.exchange(nullptr);
if (p) {
TaskSentry s{p};
}
}
edm::WaitingTask* release() noexcept { return m_task.exchange(nullptr); }
private:
std::atomic<edm::WaitingTask*> m_task;
};
if constexpr (T::isEvent_) {
if (hasAcquire()) {
auto ownRunTask = std::make_shared<DestroyTask>(moduleTask);
ServiceWeakToken weakToken = token;
auto* group = task.group();
moduleTask = make_waiting_task(
[this, weakToken, transitionInfo, parentContext, ownRunTask, group](std::exception_ptr const* iExcept) {
WaitingTaskHolder runTaskHolder(
*group, new HandleExternalWorkExceptionTask(this, group, ownRunTask->release(), parentContext));
AcquireTask<T> t(this, transitionInfo, weakToken.lock(), parentContext, runTaskHolder);
t.execute();
});
}
}
auto* group = task.group();
auto ownModuleTask = std::make_shared<DestroyTask>(moduleTask);
ServiceWeakToken weakToken = token;
auto selectionTask =
make_waiting_task([ownModuleTask, parentContext, info = transitionInfo, weakToken, group, this](
std::exception_ptr const*) mutable {
ServiceRegistry::Operate guard(weakToken.lock());
prefetchAsync<T>(WaitingTaskHolder(*group, ownModuleTask->release()),
weakToken.lock(),
parentContext,
info,
T::transition_);
});
prePrefetchSelectionAsync(*group, selectionTask, token, streamID, &transitionInfo.principal());
} else {
WaitingTask* moduleTask =
new RunModuleTask<T>(this, transitionInfo, token, streamID, parentContext, context, task.group());
auto group = task.group();
if constexpr (T::isEvent_) {
if (hasAcquire()) {
WaitingTaskHolder runTaskHolder(
*group, new HandleExternalWorkExceptionTask(this, group, moduleTask, parentContext));
moduleTask = new AcquireTask<T>(this, transitionInfo, token, parentContext, std::move(runTaskHolder));
}
}
prefetchAsync<T>(WaitingTaskHolder(*group, moduleTask), token, parentContext, transitionInfo, T::transition_);
}
}
}
template <typename T>
std::exception_ptr Worker::runModuleAfterAsyncPrefetch(std::exception_ptr iEPtr,
typename T::TransitionInfoType const& transitionInfo,
StreamID streamID,
ParentContext const& parentContext,
typename T::Context const* context) noexcept {
std::exception_ptr exceptionPtr;
bool shouldRun = true;
if (iEPtr) {
if (shouldRethrowException(iEPtr, parentContext, T::isEvent_, shouldTryToContinue_)) {
exceptionPtr = iEPtr;
setException<T::isEvent_>(exceptionPtr);
shouldRun = false;
} else {
if (not shouldTryToContinue_) {
setPassed<T::isEvent_>();
shouldRun = false;
}
}
}
if (shouldRun) {
// Caught exception is propagated via WaitingTaskList
CMS_SA_ALLOW try { runModule<T>(transitionInfo, streamID, parentContext, context); } catch (...) {
exceptionPtr = std::current_exception();
}
} else {
moduleCallingContext_.setContext(ModuleCallingContext::State::kInvalid, ParentContext(), nullptr);
}
waitingTasks_.doneWaiting(exceptionPtr);
return exceptionPtr;
}
template <typename T>
void Worker::doWorkNoPrefetchingAsync(WaitingTaskHolder task,
typename T::TransitionInfoType const& transitionInfo,
ServiceToken const& serviceToken,
StreamID streamID,
ParentContext const& parentContext,
typename T::Context const* context) noexcept {
if (not workerhelper::CallImpl<T>::wantsTransition(this)) {
return;
}
//Need to check workStarted_ before adding to waitingTasks_
bool expected = false;
auto workStarted = workStarted_.compare_exchange_strong(expected, true);
waitingTasks_.add(task);
if (workStarted) {
ServiceWeakToken weakToken = serviceToken;
auto toDo = [this, info = transitionInfo, streamID, parentContext, context, weakToken]() {
std::exception_ptr exceptionPtr;
// Caught exception is propagated via WaitingTaskList
CMS_SA_ALLOW try {
//Need to make the services available
ServiceRegistry::Operate guard(weakToken.lock());
this->runModule<T>(info, streamID, parentContext, context);
} catch (...) {
exceptionPtr = std::current_exception();
}
this->waitingTasks_.doneWaiting(exceptionPtr);
};
if (needsESPrefetching(T::transition_)) {
auto group = task.group();
auto afterPrefetch =
edm::make_waiting_task([toDo = std::move(toDo), group, this](std::exception_ptr const* iExcept) {
if (iExcept) {
this->waitingTasks_.doneWaiting(*iExcept);
} else {
if (auto queue = this->serializeRunModule()) {
queue.push(*group, toDo);
} else {
group->run(toDo);
}
}
});
moduleCallingContext_.setContext(ModuleCallingContext::State::kPrefetching, parentContext, nullptr);
esPrefetchAsync(
WaitingTaskHolder(*group, afterPrefetch), transitionInfo.eventSetupImpl(), T::transition_, serviceToken);
} else {
auto group = task.group();
if (auto queue = this->serializeRunModule()) {
queue.push(*group, toDo);
} else {
group->run(toDo);
}
}
}
}
template <typename T>
bool Worker::runModule(typename T::TransitionInfoType const& transitionInfo,
StreamID streamID,
ParentContext const& parentContext,
typename T::Context const* context) {
//unscheduled producers should advance this
//if (T::isEvent_) {
// ++timesVisited_;
//}
ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
if constexpr (T::isEvent_) {
timesRun_.fetch_add(1, std::memory_order_relaxed);
}
bool rc = true;
try {
convertException::wrap([&]() {
rc = workerhelper::CallImpl<T>::call(
this, streamID, transitionInfo, actReg_.get(), &moduleCallingContext_, context);
if (rc) {
setPassed<T::isEvent_>();
} else {
setFailed<T::isEvent_>();
}
});
} catch (cms::Exception& ex) {
edm::exceptionContext(ex, moduleCallingContext_);
if (shouldRethrowException(std::current_exception(), parentContext, T::isEvent_, shouldTryToContinue_)) {
assert(not cached_exception_);
setException<T::isEvent_>(std::current_exception());
std::rethrow_exception(cached_exception_);
} else {
rc = setPassed<T::isEvent_>();
}
}
return rc;
}
template <typename T>
std::exception_ptr Worker::runModuleDirectly(typename T::TransitionInfoType const& transitionInfo,
StreamID streamID,
ParentContext const& parentContext,
typename T::Context const* context) noexcept {
timesVisited_.fetch_add(1, std::memory_order_relaxed);
std::exception_ptr prefetchingException; // null because there was no prefetching to do
return runModuleAfterAsyncPrefetch<T>(prefetchingException, transitionInfo, streamID, parentContext, context);
}
} // namespace edm
#endif
|