-
Notifications
You must be signed in to change notification settings - Fork 1
/
jq2.cpp
2487 lines (2206 loc) · 72.1 KB
/
jq2.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
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
// This is free and unencumbered software released into the public domain.
// Anyone is free to copy, modify, publish, use, compile, sell, or
// distribute this software, either in source code form or as a compiled
// binary, for any purpose, commercial or non-commercial, and by any
// means.
// In jurisdictions that recognize copyright laws, the author or authors
// of this software dedicate any and all copyright interest in the
// software to the public domain. We make this dedication for the benefit
// of the public at large and to the detriment of our heirs and
// successors. We intend this dedication to be an overt act of
// relinquishment in perpetuity of all present and future rights to this
// software under copyright law.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// For more information, please refer to <http://unlicense.org/>
//
// ***********************************************************************
//
//
// TODO:
// new doc
#define JQ_IMPL
#include "jq.h"
#include "jqinternal.h"
#include <inttypes.h>
#ifndef _WIN32
#include <pthread.h>
#endif
#include <atomic>
#include <stdlib.h>
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable : 4324)
#endif
#define JQ_JOBFLAG_UNINITIALIZED 0x80
#define JQ_MAX_SEMAPHORES JQ_MAX_THREADS
#define JQ_NUM_LOCKS 2048
#define JQ_GRAPH_ENABLED 1
#define JQ_QUEUE_FULL_EXECUTE_JOBS 1 // set to 1 to execute jobs when we're close to running out of handles
#define JQ_JOB_FILL_PRC_LIMIT 95 // percentages of fullness to accept
#define JQ_JOBFLAG_EXTERNAL_MASK 0x3f
#define JQ_JOBFLAG_INTERNAL_SPAWN 0x40
// Split the finish counter into three 16bit parts
// [16-31] is used to count children
// [0-15] is used to count actual jobs
#define JOB_FINISH_CHILD (0x000010000llu)
#define JOB_FINISH_CHILD_MASK (0x0ffff0000llu)
#define JOB_FINISH_PLAIN (0x000000001llu)
#define JOB_FINISH_PLAIN_MASK (0x00000ffffllu)
#define JQ_MAX_DEBUG_STACK (3 * JQ_MAX_JOB_STACK)
#define JQ_TOKEN_PASTE0(a, b) a##b
#define JQ_TOKEN_PASTE(a, b) JQ_TOKEN_PASTE0(a, b)
static_assert(JQ_JOB_BUFFER_SIZE == (1llu << JQ_JOB_BUFFER_SIZE_BITS), "JQ_JOB_BUFFER_SIZE and JQ_JOB_BUFFER_SHIFT must match");
static_assert(JQ_MAX_QUEUES <= 64, "Currently a queue mask is being put in a uint64_t");
struct JqMutexLock;
enum JqWorkerState : uint8_t;
enum JqDebugStackState : uint8_t;
enum JqPopJobFlags : uint8_t;
struct JqThreadState;
void JqWorker(int ThreadId);
void JqQueuePush(uint8_t Queue, uint64_t Handle);
uint16_t JqQueuePop(uint8_t Queue, uint16_t& OutSubJob);
bool JqQueueEmpty(uint8_t Queue);
bool JqPendingJobs(uint64_t Job);
void JqSelfPush(uint64_t Job, uint32_t JobIndex);
void JqSelfPop(uint64_t Job);
void JqFinishSubJob(uint16_t JobIndex, uint64_t Count);
void JqFinishInternal(uint16_t JobIndex);
void JqDecBlockCount(uint64_t Handle, int Count, uint64_t* QueueTriggerMask = 0);
void JqIncBlockCount(uint64_t Handle, int Count);
void JqUnpackQueueLink(uint64_t Value, uint16_t& Head, uint16_t& Tail, uint16_t& JobCount);
uint64_t JqPackQueueLink(uint16_t Head, uint16_t Tail, uint16_t JobCount);
void JqUnpackStartAndQueue(uint64_t Value, uint16_t& PendingStart, uint8_t& Queue);
uint64_t JqPackStartAndQueue(uint16_t PendingStart, uint8_t Queue);
JqMutex& JqGetQueueMutex(uint64_t QueueIndex);
JqMutex& JqGetJobMutex(uint64_t JobIndex);
JqConditionVariable& JqGetJobConditionVariable(uint64_t Handle);
uint16_t JqDependentJobLinkAlloc(uint64_t Handle);
void JqDependentJobLinkFreeList(uint16_t Index);
uint16_t JqQueuePopInternal(uint16_t JobIndex, uint8_t QueueIndex, uint16_t* OutSubJob, uint16_t* OutNextJob, bool PopAll);
void JqTriggerQueues(uint64_t QueueTriggerMask);
JqHandle JqAddInternal(const char* Name, JqHandle ReservedHandle, JqFunction JobFunc, uint8_t Queue, int NumJobs, int Range, uint32_t JobFlags, JqHandle PreconditionHandle);
void JqRunInternal(JqFunction* Function, int Begin, int End, uint32_t JobFlags);
void JqRunInternal(uint32_t WorkIndex, int Begin, int End);
bool JqTryPopJob(uint16_t JobIndex, JqPopJobFlags Flags, uint16_t& OutSubJob, uint16_t& NumJobs, bool& OutIsDrained);
const char* JqWorkerStateString(JqWorkerState State);
const char* JqDebugStackStateString(JqDebugStackState State);
static void JqGraphAdd(uint64_t Handle, const char* Name, uint16_t Count);
static void JqGraphWait(uint64_t WaitTarget);
static void JqGraphPrecondtion(uint64_t Handle, uint64_t Precondition);
JqThreadState& JqGetThreadState();
void JqClearThreadState(JqThreadState& State);
void JqClearAllThreadStates();
struct JqSelfStack
{
uint64_t Job;
uint32_t JobIndex;
};
enum JqWorkerState : uint8_t
{
JWS_NOT_WORKER,
JWS_WORKING,
JWS_IDLE,
};
enum JqDebugStackState : uint8_t
{
JDS_EXECUTE,
JDS_WAIT,
JDS_WAIT_ALL,
JDS_INVALID,
};
enum JqPopJobFlags : uint8_t
{
JPF_NONE = 0,
JPF_DRAIN = 0x1,
};
struct JqDebugState
{
uint64_t Handle;
uint32_t Flags;
JqDebugStackState State;
uint16_t SubIndex;
};
struct JqThreadState
{
JqSelfStack SelfStack[JQ_MAX_JOB_STACK];
uint32_t SelfPos;
uint32_t HasLock;
uint64_t ThreadId;
std::atomic<uint32_t> Initialized;
JqWorkerState WorkerState;
JqDebugState DebugStack[JQ_MAX_JOB_STACK];
uint32_t DebugPos;
JqMutex** SingleMutexPtr;
uint32_t* pJqNumQueues;
uint8_t* pJqQueues;
JqThreadState* NextThreadState;
};
struct JqDebugStackScope
{
JqDebugStackScope(JqDebugStackState StackState, uint64_t Handle, uint32_t Flags, uint16_t SubIndex = 0)
{
JqThreadState& State = JqGetThreadState();
JQ_ASSERT(State.DebugPos < JQ_MAX_DEBUG_STACK);
JqDebugState& DebugState = State.DebugStack[State.DebugPos++];
DebugState.State = StackState;
DebugState.Flags = Flags;
DebugState.Handle = Handle;
DebugState.SubIndex = SubIndex;
}
~JqDebugStackScope()
{
JqThreadState& State = JqGetThreadState();
JQ_ASSERT(State.DebugPos > 0);
State.DebugPos--;
}
};
#define JQ_DEBUG_SCOPE(State, Handle, Flags, SubIndex) JqDebugStackScope JQ_TOKEN_PASTE(jq_debug, __LINE__) = JqDebugStackScope(State, Handle, Flags, SubIndex)
enum JqGraphDataType : uint8_t
{
JGDT_ADD,
JGDT_WAIT,
JGDT_PRECONDITION,
};
struct JqGraphData
{
JqGraphDataType Type;
union
{
struct
{
uint64_t AddHandle;
uint64_t AddSelf;
const char* AddName;
uint16_t AddCount;
};
struct
{
uint64_t WaitTarget;
uint64_t WaitSelf;
};
struct
{
uint64_t PreconditionCondition;
uint64_t PreconditionTarget;
};
};
};
#ifdef JQ_GRAPH_ENABLED
#define JQ_GRAPH(...) \
do \
{ \
if(JqState.GraphPut.load()) \
{ \
__VA_ARGS__; \
} \
} while(0)
#else
#define JQ_GRAPH(...) \
do \
{ \
} while(0)
#endif
// linked list structure, for when jobs have multiple jobs that depend on them
struct JqDependentJobLink
{
std::atomic<uint64_t> Job;
uint16_t Next;
uint64_t Owner;
};
struct JqJob
{
JqFunction Function;
std::atomic<uint64_t> StartedHandle; /// Handle which has been added to the queue
std::atomic<uint64_t> FinishedHandle; /// Handle which was last finished
std::atomic<uint64_t> ClaimedHandle; /// Handle which has claimed this header
std::atomic<uint64_t> PendingFinish; /// No. of jobs & (direct) child jobs that need to finish in order for this to be finished.
std::atomic<uint64_t> PendingStart; /// No. of Jobs that needs to be Started, and the queue which is it inserted to
std::atomic<uint8_t> ActiveQueue; // only for debugging
std::atomic<uint64_t> BlockCount; /// No. of Preconditions that need to finish, before this can be enqueued.
const char* Name;
JqDependentJobLink DependentJob; /// Job that is dependent on this job finishing.
uint16_t NumJobs; /// Num Jobs to Finish
uint16_t NumJobsToStart; /// Num Jobs to Start
int Range; /// Range to pass to jobs
uint32_t JobFlags; /// Job Flags
uint8_t Queue; /// Priority of the job
uint8_t Waiters; /// Set when waiting
uint8_t WaitersWas; /// Prev wait flag(debug only)
/// mutex protected.
uint16_t Parent;
uint16_t NextSibling;
uint16_t PrevSibling;
uint16_t FirstChild;
uint16_t LastChild;
bool Reserved;
};
struct JqStatsInternal
{
std::atomic<uint32_t> nNumAdded;
std::atomic<uint32_t> nNumFinished;
std::atomic<uint32_t> nNumAddedSub;
std::atomic<uint32_t> nNumFinishedSub;
std::atomic<uint32_t> nNumCancelled;
std::atomic<uint32_t> nNumCancelledSub;
std::atomic<uint32_t> nNumLocks;
std::atomic<uint32_t> nNumSema;
std::atomic<uint32_t> nNumWaitCond;
std::atomic<uint32_t> nNumWaitKicks;
std::atomic<uint32_t> nMemoryUsed;
void Clear()
{
nNumAdded = 0;
nNumFinished = 0;
nNumAddedSub = 0;
nNumFinishedSub = 0;
nNumCancelled = 0;
nNumCancelledSub = 0;
nNumLocks = 0;
nNumSema = 0;
nNumWaitCond = 0;
nNumWaitKicks = 0;
nMemoryUsed = 0;
}
};
#if 0
#define llqprintf(...) printf(__VA_ARGS__);
#else
#define llqprintf(...) \
do \
{ \
} while(0)
#endif
// lockless queue..
struct JqLocklessQueue
{
struct Entry
{
// Packed
// [48-63] popped sequence number.
// [32-47] pushed sequence number.
// [0-31] payload
std::atomic<uint64_t> Entry;
char pad[JQ_CACHE_LINE_SIZE - sizeof(uint64_t)];
};
static constexpr const uint32_t SEQUENCE_SHIFT = JQ_JOB_BUFFER_SIZE_BITS;
static constexpr const uint32_t BUFFER_SIZE = JQ_JOB_BUFFER_SIZE;
Entry Entries[BUFFER_SIZE];
std::atomic<uint64_t> PushPop;
int Index;
static uint64_t PackEntry(uint16_t PushSequence, uint16_t PopSequence, uint32_t Payload)
{
return ((uint64_t)PushSequence << 48llu) | ((uint64_t)PopSequence << 32llu) | Payload;
}
static void UnpackEntry(uint64_t Packed, uint16_t& PushSequence, uint16_t& PopSequence, uint32_t& Payload)
{
PushSequence = (uint16_t)(Packed >> 48llu);
PopSequence = (uint16_t)(Packed >> 32llu);
Payload = (uint32_t)(Packed & 0xffffffff);
}
static uint64_t PackPushPop(uint32_t Push, uint32_t Pop)
{
return ((uint64_t)Push << 32llu) | (uint64_t)Pop;
}
static void UnpackPushPop(uint64_t Packed, uint32_t& Push, uint32_t& Pop)
{
Push = (uint32_t)(Packed >> 32llu);
Pop = (uint32_t)(Packed & 0xffffffff);
}
void Init(int InitialIndex)
{
Index = InitialIndex;
PushPop.store(0);
for(Entry& e : Entries)
{
uint64_t Value = PackEntry(0xffff, 0xffff, 0);
e.Entry.store(Value);
}
llqprintf("init done %p\n", this);
static_assert(BUFFER_SIZE == JQ_JOB_BUFFER_SIZE, "BUFFER_SIZE must match JQ_JOB_BUFFER_SIZE");
}
bool Peek(uint32_t& PeekOut, uint32_t* Ref)
{
uint32_t Push, Pop, Payload;
uint64_t Old, Entry;
uint16_t PushSequence, PopSequence;
do
{
Old = PushPop.load();
UnpackPushPop(Old, Push, Pop);
if(Push == Pop)
return false;
uint32_t PopIndex = Pop & (BUFFER_SIZE - 1);
uint16_t Sequence = (uint16_t)(Pop >> SEQUENCE_SHIFT);
uint16_t PrevSequence = Sequence - 1;
Entry = Entries[PopIndex].Entry.load();
UnpackEntry(Entry, PushSequence, PopSequence, Payload);
if(PushSequence != Sequence)
{
// not done pushing, so we have to back off.
}
else if(PrevSequence == PopSequence)
{
if(Ref)
*Ref = Pop;
PeekOut = Payload;
if(Payload == 0)
{
JqDump();
}
JQ_ASSERT(Payload != 0);
return true;
}
// if sequence doesn't match, someone popped inbetween, so the payload should be zero, and we have to retry
// backoff here
} while(true);
}
// pops a value.
// optionally only pops if that value has sequence given as arg
bool Pop(uint32_t& PoppedValue, uint32_t* Ref)
{
uint32_t Push, Pop, Payload;
uint64_t Old, New, Entry;
uint16_t PushSequence, PopSequence;
bool UseRef = Ref != 0;
uint32_t RefValue = Ref ? *Ref : 0;
do
{
Old = PushPop.load();
UnpackPushPop(Old, Push, Pop);
if(Push == Pop)
return false; // Queue empty
if(UseRef && Pop != RefValue) // something else got popped.
return false;
uint32_t PopIndex = Pop & (BUFFER_SIZE - 1);
uint16_t Sequence = uint16_t(Pop >> SEQUENCE_SHIFT);
uint16_t PrevSequence = Sequence - 1;
Entry = Entries[PopIndex].Entry.load();
UnpackEntry(Entry, PushSequence, PopSequence, Payload);
if(PushSequence != Sequence)
{
// someones not done pushing. can't push yet..
// back off
}
else if(PrevSequence == PopSequence)
{
// ready to pop
New = PackPushPop(Push, Pop + 1);
if(PushPop.compare_exchange_weak(Old, New))
{
PoppedValue = Payload;
// we're done updating push/pop, now clear the payload.
Entries[PopIndex].Entry.store(PackEntry(PushSequence, Sequence, 0));
llqprintf("popped %d [%d/%d] %8d :: %8d %8d [%lld/%lld]\n", Index, Push, Pop, Payload, PopIndex, Sequence, PushPop.load() >> 32, PushPop.load() & 0xffffffff);
return true;
}
}
// backoff here
} while(true);
}
void Push(uint32_t Value)
{
if(Value == 0)
JQ_BREAK();
// queue should never be full.
uint32_t Push, Pop, Payload;
uint64_t Old, New;
uint16_t PushSequence, PopSequence;
do
{
Old = PushPop.load();
UnpackPushPop(Old, Push, Pop);
if(((Push + 1) % JQ_JOB_BUFFER_SIZE) == (Pop % JQ_JOB_BUFFER_SIZE))
{
// queue is full. this should never occur, calling code should back off or crash
// intentionally not supported.
JQ_BREAK();
}
New = PackPushPop(Push + 1, Pop);
if(PushPop.compare_exchange_weak(Old, New))
break;
// exp backoff here
} while(true);
// now commit the value in the queue
uint32_t PushIndex = Push & (BUFFER_SIZE - 1);
uint16_t Sequence = uint16_t(Push >> SEQUENCE_SHIFT);
uint16_t PrevSequence = Sequence - 1;
llqprintf("pushin %d [%d/%d]%8d :: %8d %8d [%lld/%lld]\n", Index, Push, Pop, Value, PushIndex, Sequence, PushPop.load() >> 32, PushPop.load() & 0xffffffff);
// atomically insert and mark the value.
// do backoff, if for some reason the value isn't popped
do
{
Old = Entries[PushIndex].Entry.load();
UnpackEntry(Old, PushSequence, PopSequence, Payload);
// handle the case where a poppin' hasnt committed its pop
if(PopSequence != PrevSequence)
{
// do exp. backoff?
}
if(PushSequence != PrevSequence)
{
// do exp. backoff?
}
JQ_ASSERT(Payload == 0);
New = PackEntry(Sequence, PopSequence, Value);
if(Entries[PushIndex].Entry.compare_exchange_weak(Old, New))
break;
} while(true);
}
template <typename T>
void DebugCallbackAll(T Function)
{
uint32_t Push, Pop;
UnpackPushPop(PushPop.load(), Push, Pop);
while(Pop != Push)
{
uint32_t PopIndex = Pop & (BUFFER_SIZE - 1);
uint16_t Sequence = uint16_t(Pop >> SEQUENCE_SHIFT);
uint64_t Entry = Entries[PopIndex].Entry.load();
uint16_t EntryPushSequence, EntryPopSequence;
uint32_t Payload;
UnpackEntry(Entry, EntryPushSequence, EntryPopSequence, Payload);
Function(Pop, PopIndex, Sequence, EntryPushSequence, EntryPopSequence, Payload);
Pop++;
}
}
};
struct JQ_ALIGN_CACHELINE JqState_t
{
JqSemaphore Semaphore[JQ_MAX_SEMAPHORES];
uint64_t SemaphoreMask[JQ_MAX_SEMAPHORES];
uint8_t QueueNumSemaphores[JQ_MAX_QUEUES];
uint8_t QueueToSemaphore[JQ_MAX_QUEUES][JQ_MAX_SEMAPHORES];
uint8_t SemaphoreClients[JQ_MAX_SEMAPHORES][JQ_MAX_THREADS];
uint8_t SemaphoreClientCount[JQ_MAX_SEMAPHORES];
int ActiveSemaphores;
JqAttributes Attributes;
uint8_t NumQueues[JQ_MAX_THREADS];
uint8_t QueueList[JQ_MAX_THREADS][JQ_MAX_QUEUES];
uint8_t SemaphoreIndex[JQ_MAX_THREADS];
JQ_THREAD WorkerThreads[JQ_MAX_THREADS];
JqJobStackList StackSmall;
JqJobStackList StackLarge;
bool IsRunning;
int NumWorkers;
std::atomic<int> Stop;
int TotalWaiting;
std::atomic<uint32_t> ActiveJobs;
std::atomic<uint64_t> NextHandle;
JqQueueOrder ThreadConfig[JQ_MAX_THREADS];
JqJob Jobs[JQ_JOB_BUFFER_SIZE];
JqLocklessQueue LocklessQueues[JQ_MAX_QUEUES];
JqMutex MutexJob[JQ_NUM_LOCKS];
JqConditionVariable ConditionVariableJob[JQ_NUM_LOCKS];
JqMutex DependentJobLinkMutex;
JqDependentJobLink DependentJobLinks[JQ_JOB_BUFFER_SIZE];
uint16_t DependentJobLinkHead;
std::atomic<uint32_t> DependentJobLinkCounter;
JqMutex GraphLock;
const char* GraphFilename;
uint32_t GraphBufferSize;
JqGraphData* GraphData;
uint32_t GraphFlags;
std::atomic<JqGraphData*> GraphPut;
std::atomic<JqGraphData*> GraphEnd;
JqState_t()
: IsRunning(false)
, NumWorkers(0)
{
}
JqStatsInternal Stats;
} JqState;
#ifdef _WIN32
#pragma warning(pop)
#endif
JQ_THREAD_LOCAL int g_JqSpinloop = 0; // prevent optimizer from removing spin loop
JQ_THREAD_LOCAL uint32_t g_nJqNumQueues = 0;
JQ_THREAD_LOCAL uint8_t g_JqQueues[JQ_MAX_QUEUES] = { 0 };
JQ_THREAD_LOCAL JqJobStack* g_pJqJobStacks = 0;
JQ_THREAD_LOCAL JqThreadState g_JqThreadState;
JqMutex ThreadStateLock;
JqThreadState* FirstThreadState = nullptr;
void JqStart(JqAttributes* pAttr)
{
#if 0
//verify macros
uint64_t t0 = 0xf000000000000000;
uint64_t t1 = 0;
uint64_t t2 = 0x1000000000000000;
JQ_ASSERT(JQ_LE_WRAP(t0, t0));
JQ_ASSERT(JQ_LE_WRAP(t1, t1));
JQ_ASSERT(JQ_LE_WRAP(t2, t2));
JQ_ASSERT(JQ_LE_WRAP(t0, t1));
JQ_ASSERT(!JQ_LE_WRAP(t1, t0));
JQ_ASSERT(JQ_LE_WRAP(t1, t2));
JQ_ASSERT(!JQ_LE_WRAP(t2, t1));
JQ_ASSERT(JQ_LE_WRAP(t0, t2));
JQ_ASSERT(!JQ_LE_WRAP(t2, t0));
JQ_ASSERT(!JQ_LT_WRAP(t0, t0));
JQ_ASSERT(!JQ_LT_WRAP(t1, t1));
JQ_ASSERT(!JQ_LT_WRAP(t2, t2));
JQ_ASSERT(JQ_LT_WRAP(t0, t1));
JQ_ASSERT(!JQ_LT_WRAP(t1, t0));
JQ_ASSERT(JQ_LT_WRAP(t1, t2));
JQ_ASSERT(!JQ_LT_WRAP(t2, t1));
JQ_ASSERT(JQ_LT_WRAP(t0, t2));
JQ_ASSERT(!JQ_LT_WRAP(t2, t0));
#endif
JQ_ASSERT(((JQ_CACHE_LINE_SIZE - 1) & (uint64_t)&JqState) == 0);
// JQ_ASSERT(((JQ_CACHE_LINE_SIZE - 1) & offsetof(JqState_t, Mutex)) == 0);
JQ_ASSERT(JqState.NumWorkers == 0);
memset(JqState.QueueList, 0xff, sizeof(JqState.QueueList));
memset(JqState.NumQueues, 0, sizeof(JqState.NumQueues));
memset(JqState.SemaphoreMask, 0, sizeof(JqState.SemaphoreMask));
memset(JqState.QueueNumSemaphores, 0, sizeof(JqState.QueueNumSemaphores));
memset(JqState.QueueToSemaphore, 0, sizeof(JqState.QueueToSemaphore));
memset(JqState.SemaphoreClients, 0, sizeof(JqState.SemaphoreClients));
memset(JqState.SemaphoreClientCount, 0, sizeof(JqState.SemaphoreClientCount));
JqState.ActiveSemaphores = 0;
JqState.Attributes = *pAttr;
JqState.NumWorkers = pAttr->NumWorkers;
JqState.Stats.nMemoryUsed = sizeof(JqState);
for(uint32_t i = 0; i < pAttr->NumWorkers; ++i)
{
JQ_ASSERT(pAttr->WorkerOrderIndex[i] < pAttr->NumQueueOrders); /// out of bounds pipe order index in attributes
JQ_ASSERT(pAttr->WorkerOrderIndex[i] < JQ_MAX_QUEUES);
JqState.ThreadConfig[i] = pAttr->QueueOrder[pAttr->WorkerOrderIndex[i]];
}
for(int i = 0; i < JQ_MAX_QUEUES; ++i)
{
JqState.LocklessQueues[i].Init(i);
}
for(int i = 0; i < JqState.NumWorkers; ++i)
{
JqQueueOrder& C = JqState.ThreadConfig[i];
uint8_t nNumActivePipes = 0;
uint64_t PipeMask = 0;
static_assert(JQ_MAX_QUEUES < 64, "wont fit in 64bit mask");
for(uint32_t j = 0; j < C.NumQueues; ++j)
{
if(C.Queues[j] != 0xff)
{
JqState.QueueList[i][nNumActivePipes++] = C.Queues[j];
JQ_ASSERT(C.Queues[j] < JQ_MAX_QUEUES);
PipeMask |= 1llu << C.Queues[j];
}
}
JQ_ASSERT(nNumActivePipes); // worker without active pipes.
JqState.NumQueues[i] = nNumActivePipes;
int nSelectedSemaphore = -1;
for(int j = 0; j < JqState.ActiveSemaphores; ++j)
{
if(JqState.SemaphoreMask[j] == PipeMask)
{
nSelectedSemaphore = j;
break;
}
}
if(-1 == nSelectedSemaphore)
{
JQ_ASSERT(JqState.ActiveSemaphores < JQ_MAX_SEMAPHORES);
nSelectedSemaphore = JqState.ActiveSemaphores++;
JqState.SemaphoreMask[nSelectedSemaphore] = PipeMask;
for(uint32_t j = 0; j < JQ_MAX_QUEUES; ++j)
{
if(PipeMask & (1llu << j))
{
JQ_ASSERT(JqState.QueueNumSemaphores[j] < JQ_MAX_SEMAPHORES);
JqState.QueueToSemaphore[j][JqState.QueueNumSemaphores[j]++] = (uint8_t)nSelectedSemaphore;
}
}
}
JQ_ASSERT(JqState.SemaphoreClientCount[nSelectedSemaphore] < JQ_MAX_SEMAPHORES);
JqState.SemaphoreClients[nSelectedSemaphore][JqState.SemaphoreClientCount[nSelectedSemaphore]++] = (uint8_t)i;
JqState.SemaphoreIndex[i] = (uint8_t)nSelectedSemaphore;
}
for(uint32_t i = 0; i < JQ_MAX_SEMAPHORES; ++i)
{
JqState.Semaphore[i].Init(JqState.SemaphoreClientCount[i] ? JqState.SemaphoreClientCount[i] : 1);
}
JqState.TotalWaiting = 0;
JqState.Stop = 0;
for(int i = 0; i < JQ_JOB_BUFFER_SIZE; ++i)
{
JqState.Jobs[i].StartedHandle = 0;
JqState.Jobs[i].FinishedHandle = 0;
JqState.Jobs[i].ClaimedHandle = 0;
JqState.Jobs[i].PendingFinish = 0;
JqState.Jobs[i].PendingStart = 0;
JqState.Jobs[i].ActiveQueue = 0;
JqState.Jobs[i].BlockCount = 0;
JqState.Jobs[i].Name = nullptr;
JqState.Jobs[i].DependentJob.Job = 0;
JqState.Jobs[i].DependentJob.Next = 0;
JqState.Jobs[i].DependentJob.Owner = 0;
JqState.Jobs[i].NumJobs = 0;
JqState.Jobs[i].NumJobsToStart = 0;
JqState.Jobs[i].Range = 1;
JqState.Jobs[i].JobFlags = 0;
JqState.Jobs[i].Queue = 0xff;
JqState.Jobs[i].Waiters = 0;
JqState.Jobs[i].WaitersWas = 0;
JqState.Jobs[i].NextSibling = 0;
JqState.Jobs[i].PrevSibling = 0;
JqState.Jobs[i].FirstChild = 0;
JqState.Jobs[i].LastChild = 0;
JqState.Jobs[i].Reserved = false;
}
JqState.ActiveJobs = 0;
JqState.NextHandle = JQ_JOB_BUFFER_SIZE + 1;
JqState.Stats.Clear();
for(uint16_t i = 0; i < JQ_JOB_BUFFER_SIZE; ++i)
{
// terminate at end, and tag zero as unusable
if(i == 0 || i == (JQ_JOB_BUFFER_SIZE - 1))
{
JqState.DependentJobLinks[i].Next = 0;
}
else
{
JqState.DependentJobLinks[i].Next = i + 1;
}
JqState.DependentJobLinks[i].Job = 0;
}
JqState.DependentJobLinkHead = 1;
JqState.IsRunning = true;
for(int i = 0; i < JqState.NumWorkers; ++i)
{
JQ_THREAD_CREATE(&JqState.WorkerThreads[i]);
JQ_THREAD_START(&JqState.WorkerThreads[i], JqWorker, (i));
}
}
int JqNumWorkers()
{
return JqState.NumWorkers;
}
void JqStop()
{
JqWaitAll();
JqState.Stop = 1;
for(int i = 0; i < JqState.ActiveSemaphores; ++i)
{
JqState.Semaphore[i].Signal(JqState.NumWorkers);
}
for(int i = 0; i < JqState.NumWorkers; ++i)
{
JQ_THREAD_JOIN(&JqState.WorkerThreads[i]);
JQ_THREAD_DESTROY(&JqState.WorkerThreads[i]);
}
JqFreeAllStacks(JqState.StackSmall);
JqFreeAllStacks(JqState.StackLarge);
uint64_t DependentLinkCounter = JqState.DependentJobLinkCounter.load();
if(DependentLinkCounter)
{
printf("Dependent links(%" PRId64 ") left over after finishing\n", DependentLinkCounter);
}
JQ_ASSERT(0 == DependentLinkCounter);
JqState.NumWorkers = 0;
JqState.IsRunning = false;
JqClearAllThreadStates();
}
void JqSetThreadQueueOrder(JqQueueOrder* pConfig)
{
uint32_t nNumActiveQueues = 0;
JQ_ASSERT(pConfig->NumQueues <= JQ_MAX_QUEUES);
for(uint32_t j = 0; j < pConfig->NumQueues; ++j)
{
if(pConfig->Queues[j] != 0xff)
{
g_JqQueues[nNumActiveQueues++] = pConfig->Queues[j];
JQ_ASSERT(pConfig->Queues[j] < JQ_MAX_QUEUES);
}
}
g_nJqNumQueues = nNumActiveQueues;
}
void JqConsumeStats(JqStats* pStats)
{
pStats->nNumAdded = JqState.Stats.nNumAdded.exchange(0);
pStats->nNumFinished = JqState.Stats.nNumFinished.exchange(0);
pStats->nNumAddedSub = JqState.Stats.nNumAddedSub.exchange(0);
pStats->nNumFinishedSub = JqState.Stats.nNumFinishedSub.exchange(0);
pStats->nNumCancelled = JqState.Stats.nNumCancelled.exchange(0);
pStats->nNumCancelledSub = JqState.Stats.nNumCancelledSub.exchange(0);
pStats->nNumLocks = JqState.Stats.nNumLocks.exchange(0);
pStats->nNumSema = JqState.Stats.nNumSema.exchange(0);
pStats->nNumWaitCond = JqState.Stats.nNumWaitCond.exchange(0);
pStats->nNumWaitKicks = JqState.Stats.nNumWaitKicks.exchange(0);
pStats->nMemoryUsed = JqState.Stats.nMemoryUsed.load();
}
void JqKickWaiters(uint16_t JobIndex)
{
JobIndex = JobIndex % JQ_JOB_BUFFER_SIZE;
JqJob& Job = JqState.Jobs[JobIndex];
// kick waiting threads.
int8_t Waiters = Job.Waiters;
if(Waiters != 0)
{
JqState.Stats.nNumWaitKicks++;
JqGetJobConditionVariable(JobIndex).NotifyAll();
Job.Waiters = 0;
Job.WaitersWas = Waiters;
}
else
{
Job.WaitersWas = 0xff;
}
}
void JqFinishInternal(uint16_t JobIndex)
{
JQ_MICROPROFILE_VERBOSE_SCOPE("JqFinishInternal", 0xffff);
JobIndex = JobIndex % JQ_JOB_BUFFER_SIZE;
JqJob& Job = JqState.Jobs[JobIndex];
JQ_ASSERT(Job.PendingStart.load() == 0);
JQ_ASSERT(Job.PendingFinish.load() == 0);
// no need to lock queue, since we are removed a long time ago
uint64_t FinishValue = 0;
uint16_t Parent = Job.Parent; // we can read this safely, as noone will try and finish this job
// Detach from parent first.
if(Parent)
{
{
JqSingleMutexLock L(JqGetJobMutex(Parent));
JqJob& ParentJob = JqState.Jobs[JQ_GET_INDEX(Parent)];
if(Job.NextSibling != 0)
{
JqState.Jobs[Job.NextSibling].PrevSibling = Job.PrevSibling;
JQ_ASSERT(JobIndex != ParentJob.LastChild);
}
else
{
JQ_ASSERT(JobIndex == ParentJob.LastChild);
ParentJob.LastChild = Job.PrevSibling;
}
if(Job.PrevSibling != 0)
{
JqState.Jobs[Job.PrevSibling].NextSibling = Job.NextSibling;
JQ_ASSERT(JobIndex != ParentJob.FirstChild);
}
else
{
JQ_ASSERT(JobIndex == ParentJob.FirstChild);
ParentJob.FirstChild = Job.NextSibling;
}
}
JqFinishSubJob(Parent, JOB_FINISH_CHILD);
}
JqDependentJobLink Dependent;
{
JqSingleMutexLock L(JqGetJobMutex(JobIndex));
Parent = Job.Parent;
Job.Parent = 0;
JQ_ASSERT(Job.FirstChild == 0);
JQ_ASSERT(Job.LastChild == 0);
// Siblings can only be cleared while parent lock is taken
JQ_CLEAR_FUNCTION(Job.Function);
Dependent.Job = Job.DependentJob.Job.exchange(0);
Dependent.Next = Job.DependentJob.Next;
Dependent.Owner = Job.DependentJob.Owner;
Job.DependentJob.Job = 0;
Job.DependentJob.Next = 0;
Job.DependentJob.Owner = 0;
JqState.Stats.nNumFinished++;
JQ_ASSERT(Job.FinishedHandle.load() != Job.StartedHandle.load());
JQ_ASSERT(Job.ClaimedHandle.load() == Job.StartedHandle.load());
FinishValue = Job.StartedHandle.load();
// this releases the header.
Job.FinishedHandle = FinishValue;
JqState.ActiveJobs.fetch_sub(1);
JqKickWaiters(JobIndex);
}
if(Dependent.Job)
{
JQ_MICROPROFILE_VERBOSE_SCOPE("DecPrecondtion", MP_AUTO);
uint64_t QueueTriggerMask = 0;
JqDecBlockCount(Dependent.Job, 1, &QueueTriggerMask);
uint16_t Next = Dependent.Next;
while(Next)
{
uint64_t JobHandle = JqState.DependentJobLinks[Next].Job;
Next = JqState.DependentJobLinks[Next].Next;
JqDecBlockCount(JobHandle, 1, &QueueTriggerMask);
}
// Trigger only once. the overhead for kicking all the queues can be substantial
JqTriggerQueues(QueueTriggerMask);
}
if(Dependent.Next)
{
// First element is embedded so it doesn't need freeing.
JqDependentJobLinkFreeList(Dependent.Next);
}
}
void JqFinishSubJob(uint16_t nJobIndex, uint64_t FinishCount = 1)
{
JQ_MICROPROFILE_VERBOSE_SCOPE("JqFinishSubJob", 0xffff);
nJobIndex = nJobIndex % JQ_JOB_BUFFER_SIZE;
JqJob& Job = JqState.Jobs[nJobIndex];
uint64_t Before = Job.PendingFinish.fetch_sub(FinishCount);
uint64_t FinishIndex = Before - FinishCount;
JqState.Stats.nNumFinishedSub++;
JQ_ASSERT((int64_t)FinishIndex >= 0);
if(0 == FinishIndex)
{
JqFinishInternal(nJobIndex);
}
}
void JqAttachChild(uint64_t Parent, uint64_t Child)
{
if(!Parent)
return;
uint16_t ParentIndex = Parent % JQ_JOB_BUFFER_SIZE;
uint16_t ChildIndex = Child % JQ_JOB_BUFFER_SIZE;
JqJob& ParentJob = JqState.Jobs[ParentIndex];
JqJob& ChildJob = JqState.Jobs[ChildIndex];
JQ_MICROPROFILE_VERBOSE_SCOPE("JQ_ATTACH_CHILD", MP_BLACK);
JqSingleMutexLock L(JqGetJobMutex(ParentIndex));
// can't add parent/child relations to already finished jobs.
JQ_ASSERT(ParentJob.FinishedHandle != Parent);
JQ_ASSERT(ChildJob.FinishedHandle != Child);
// handles must be claimed
JQ_ASSERT(ParentJob.ClaimedHandle == Parent);
JQ_ASSERT(ChildJob.ClaimedHandle == Child);
JQ_ASSERT(ChildJob.Parent == 0);
JQ_ASSERT(ChildJob.NextSibling == 0);
JQ_ASSERT(ChildJob.PrevSibling == 0);
ChildJob.Parent = ParentIndex;
uint16_t LastChild = ParentJob.LastChild;
ChildJob.PrevSibling = LastChild;
if(LastChild)
{
JQ_ASSERT(JqState.Jobs[LastChild].NextSibling == 0);
JqState.Jobs[LastChild].NextSibling = ChildIndex;
}
else
{
JQ_ASSERT(ParentJob.LastChild == ParentJob.FirstChild);
ParentJob.FirstChild = ChildIndex;