-
Notifications
You must be signed in to change notification settings - Fork 270
/
Copy pathjob.cpp
1451 lines (1215 loc) · 45.1 KB
/
job.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
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose:
//
// $NoKeywords: $
//=============================================================================
#include "stdafx.h"
#ifdef WIN32
#include "typeinfo.h"
#else
#include <typeinfo>
#endif
// memdbgon must be the last include file in a .cpp file!!!
#include "tier0/memdbgon.h"
namespace GCSDK
{
//-----------------------------------------------------------------------------
// Purpose: EJobPauseReason descriptions
//-----------------------------------------------------------------------------
static const char * const k_prgchJobPauseReason[] =
{
"active",
"not started",
"netmsg",
"sleep for time",
"waiting for lock",
"yielding",
"SQL",
"work item",
};
COMPILE_TIME_ASSERT( ARRAYSIZE( k_prgchJobPauseReason ) == k_EJobPauseReasonCount );
CJob *g_pJobCur = NULL;
//-----------------------------------------------------------------------------
// Purpose: Delete a Job
// Input: pJob - The Job to delete
//-----------------------------------------------------------------------------
void CJob::DeleteJob( CJob *pJob )
{
// we can't delete the if we still have a pending work item
pJob->WaitForThreadFuncWorkItemBlocking();
delete pJob;
}
//-----------------------------------------------------------------------------
// Purpose: Constructor
// Input: pServerParent - The server we belong to
//-----------------------------------------------------------------------------
CJob::CJob( CJobMgr &jobMgr, const char *pchJobName ) : m_JobMgr( jobMgr ), m_pchJobName( pchJobName )
{
m_ePauseReason = k_EJobPauseReasonNotStarted;
m_JobID = jobMgr.GetNewJobID();
m_pJobType = NULL;
m_bWorkItemCanceled = false;
m_hCoroutine = Coroutine_Create( &BRunProxy, this );
m_pvStartParam = NULL;
m_bRunFromMsg = false;
m_pJobPrev = NULL;
m_pWaitingOnLock = NULL;
m_pJobToNotifyOnLockRelease = NULL;
m_pWaitingOnWorkItem = NULL;
m_STimeStarted.SetToJobTime();
m_STimeSwitched.SetToJobTime();
m_STimeNextHeartbeat.SetFromJobTime( k_cMicroSecJobHeartbeat );
m_bIsLongRunning = false;
m_cLocksAttempted = 0;
m_cLocksWaitedFor = 0;
m_flags.m_uFlags = 0;
m_cyclecountTotal = 0;
m_unWaitMsgType = 0;
GetJobMgr().InsertJob( *this );
}
//-----------------------------------------------------------------------------
// Purpose: Destructor
//-----------------------------------------------------------------------------
CJob::~CJob()
{
// don't want SendMsgToConnection to call back into us, we *know*
// we are replying to these other jobs now
g_pJobCur = NULL;
// reset the job pointer
g_pJobCur = m_pJobPrev;
// remove from the job tracking list
GetJobMgr().RemoveJob( *this );
// Forcefully release any locks
ReleaseLocks();
// free any network messages we've allocated
FOR_EACH_VEC( m_vecNetPackets, i )
{
m_vecNetPackets[i]->Release();
}
m_vecNetPackets.RemoveAll();
AssertMsg2( 0 == GetDoNotYieldDepth(), "Job ending with %d open Do Not Yields. Are we missing a END_DO_NOT_YIELD()? Innermost delared at %s",
GetDoNotYieldDepth(), m_stackDoNotYieldGuards[m_stackDoNotYieldGuards.Head()] );
}
//-----------------------------------------------------------------------------
// Purpose: if necessary wait for the pending work item to finish
//-----------------------------------------------------------------------------
void CJob::WaitForThreadFuncWorkItemBlocking()
{
if ( m_pWaitingOnWorkItem )
{
switch ( GetPauseReason() )
{
case k_EJobPauseReasonWorkItem:
// force the workitem to be canceled in case it's still in the in-queue
m_pWaitingOnWorkItem->ForceTimeOut();
// we can't shutdown the job while it's work item is currently running
// alot of work items refernce back into the job object
while ( m_pWaitingOnWorkItem->BIsRunning() )
ThreadSleep( 25 );
m_pWaitingOnWorkItem = NULL;
break;
#if 0 // not used in gcsdk
case k_EJobPauseReasonGeneric:
AssertMsg1( ( !m_pWaitingForGeneric || ( m_pWaitingForGeneric == ( void * ) 1 ) ), "CJob::WaitForThreadFuncWorkItemBlocking job %s will leak generic heap object", GetName() );
// Let another assert fire later, don't null-out: m_pWaitingForGeneric = NULL;
break;
#endif
default:
AssertMsg1( false, "CJob::WaitForThreadFuncWorkItemBlocking job %s has unexpected work item state", GetName() );
}
}
}
//-----------------------------------------------------------------------------
// Purpose: returns the name of the job
//-----------------------------------------------------------------------------
const char *CJob::GetName() const
{
if ( m_pchJobName )
return m_pchJobName;
else if ( m_pJobType )
return m_pJobType->m_pchName;
else
return "";
}
//-----------------------------------------------------------------------------
// Purpose: string description of why we're paused
//-----------------------------------------------------------------------------
const char *CJob::GetPauseReasonDescription() const
{
static char srgchPauseReason[k_cSmallBuff];
if ( GetPauseReason() < Q_ARRAYSIZE( k_prgchJobPauseReason ) )
{
switch( GetPauseReason() )
{
case k_EJobPauseReasonWaitingForLock:
{
Q_snprintf( srgchPauseReason, k_cSmallBuff, "WOL: 0x%x (%s)", (unsigned int)m_pWaitingOnLock, m_pWaitingOnLock ? m_pWaitingOnLock->GetName() : "null" );
return srgchPauseReason;
}
case k_EJobPauseReasonNetworkMsg:
{
const char *pchMsgType;
if( g_theMessageList.GetMessage( m_unWaitMsgType, &pchMsgType, 0xFF ) )
{
Q_snprintf( srgchPauseReason, k_cSmallBuff, "NetMsg: %s", pchMsgType );
return srgchPauseReason;
}
else
{
Q_snprintf( srgchPauseReason, k_cSmallBuff, "NetMsg: Unknown %d", m_unWaitMsgType );
return srgchPauseReason;
}
}
default:
return k_prgchJobPauseReason[ GetPauseReason() ];
}
}
return "undefined";
}
//-----------------------------------------------------------------------------
// Purpose: accessor to get access to the JobMgr from the server we belong to
//-----------------------------------------------------------------------------
CJobMgr &CJob::GetJobMgr()
{
return m_JobMgr;
}
//-----------------------------------------------------------------------------
// Purpose: Starts the job, based on the current network msg
// Input : hConnection - Connection that the message was received form
// pubPkt - The raw message packet
// cubPkt - The size of the message packet
//-----------------------------------------------------------------------------
void CJob::StartJobFromNetworkMsg( IMsgNetPacket *pNetPacket, const JobID_t &gidJobIDSrc )
{
// hang on to the packet with the message that started this job
AddPacketToList( pNetPacket, gidJobIDSrc );
SetFromFromMsg( true );
// start running this job
InitCoroutine();
//and start executing the job
Continue();
}
//-----------------------------------------------------------------------------
// Purpose: Starts the job
//-----------------------------------------------------------------------------
void CJob::StartJob( void * pvStartParam )
{
// job must not be started
AssertMsg1( m_ePauseReason == k_EJobPauseReasonNotStarted, "CJob::StartJob() called twice on job %s\n", GetName() );
// save the start params for this job
SetStartParam( pvStartParam );
m_JobMgr.CheckThreadID();
// start running this job
InitCoroutine();
Continue();
}
//-----------------------------------------------------------------------------
// Purpose: Starts the job in a suspended state
//-----------------------------------------------------------------------------
void CJob::StartJobDelayed( void * pvStartParam )
{
// job must not be started
AssertMsg1( m_ePauseReason == k_EJobPauseReasonNotStarted, "CJob::StartJob() called twice on job %s\n", GetName() );
// save the start params for this job
SetStartParam( pvStartParam );
m_JobMgr.CheckThreadID();
//init the job, but don't start it
InitCoroutine();
//set our job as suspended (a yield)
m_ePauseReason = k_EJobPauseReasonYield;
m_JobMgr.AddDelayedJobToYieldList( *this );
}
//-----------------------------------------------------------------------------
// Purpose: setup the debug memory and job name before running a job the first time
//-----------------------------------------------------------------------------
void CJob::InitCoroutine()
{
// make sure we have an appropriate chunk of memory to store
// our debug alloc info
if( MemAlloc_GetDebugInfoSize() )
{
m_memAllocStack.EnsureCapacity( MemAlloc_GetDebugInfoSize() );
// Set the job name as the root
MemAlloc_InitDebugInfo( m_memAllocStack.Base(), GetName(), 0 );
}
// Set the job name
if ( !m_pJobType && !m_pchJobName )
{
#ifdef _WIN32
m_pchJobName = typeid( *this ).raw_name();
if ( m_pchJobName[0] == '.' && m_pchJobName[1] == '?' && m_pchJobName[2] == 'A')
m_pchJobName += 4;
if ( m_pchJobName[0] == '?' && m_pchJobName[1] == '$' )
m_pchJobName += 2;
#else
m_pchJobName = typeid( *this ).name();
#endif
}
}
//-----------------------------------------------------------------------------
// Purpose: proxy function for starting the job in the coroutine
//-----------------------------------------------------------------------------
void CJob::BRunProxy( void *pvThis )
{
CJob *pJob = (CJob *)pvThis;
// run the job
bool bJobReturn = false;
if ( pJob->m_bRunFromMsg )
{
Assert( pJob->m_vecNetPackets.Count() > 0 );
bJobReturn = pJob->BYieldingRunJobFromMsg( pJob->m_vecNetPackets.Head() );
}
else
{
bJobReturn = pJob->BYieldingRunJob( pJob->m_pvStartParam );
}
pJob->m_flags.m_bits.m_bJobFailed = ( true != bJobReturn );
// kill it
DeleteJob( pJob );
}
//-----------------------------------------------------------------------------
// Purpose: Adds this packet to the linked list of packets for this job
//-----------------------------------------------------------------------------
void CJob::AddPacketToList( IMsgNetPacket *pNetPacket, const GID_t gidJobIDSrc )
{
Assert( pNetPacket );
pNetPacket->AddRef();
m_vecNetPackets.AddToTail( pNetPacket );
}
//-----------------------------------------------------------------------------
// Purpose: marks a net packet as being finished with, releases the packet and frees the memory
//-----------------------------------------------------------------------------
void CJob::ReleaseNetPacket( IMsgNetPacket *pNetPacket )
{
int iVec = m_vecNetPackets.Find( pNetPacket );
if ( iVec != m_vecNetPackets.InvalidIndex() )
{
pNetPacket->Release();
m_vecNetPackets.Remove( iVec );
}
else
{
AssertMsg( false, "Job failed trying to release a IMsgNetPacket it doesn't own" );
}
}
//-----------------------------------------------------------------------------
// Purpose: continues the current job
//-----------------------------------------------------------------------------
void CJob::Continue()
{
AssertNotRunningThisJob();
m_pJobPrev = g_pJobCur;
g_pJobCur = this;
// Record frame we're starting in and start a timer to track how long we work for within the frame
// Also, add in how much time has passed since we were last paused to track heartbeat requirements
m_FastTimerDelta.Start();
m_STimeSwitched.SetToJobTime();
// Check if we need to heartbeat
if ( BJobNeedsToHeartbeat() )
{
Heartbeat();
}
m_JobMgr.GetJobStats().m_cTimeslices++;
m_ePauseReason = k_EJobPauseReasonNone;
#if defined(_WIN32) && defined(COROUTINE_TRACE)
const char *pchRawName = typeid( *this ).raw_name();
if ( pchRawName[0] == '.' && pchRawName[1] == '?' && pchRawName[2] == 'A')
pchRawName += 4;
if ( pchRawName[0] == '?' && pchRawName[1] == '$' )
pchRawName += 2;
#else
const char *pchRawName = "";
#endif
// Save debug credit "call stack"
void *pvSaveDebugInfo = GetJobMgr().GetMainMemoryDebugInfo();
MemAlloc_SaveDebugInfo( pvSaveDebugInfo );
MemAlloc_RestoreDebugInfo( m_memAllocStack.Base() );
// continue the coroutine, with the profiling if necessary
bool bJobStillActive;
#if defined( VPROF_ENABLED )
if ( g_VProfCurrentProfile.IsEnabled() )
{
VPROF_BUDGET( GetName(), VPROF_BUDGETGROUP_JOBS_COROUTINES );
bJobStillActive = Coroutine_Continue( m_hCoroutine, pchRawName );
}
else
#endif
{
bJobStillActive = Coroutine_Continue( m_hCoroutine, pchRawName );
}
// WARNING: MEMBER VARIABLES ARE NOW UNSAFE TO ACCESS - this CJob may be deleted
// Restore debug credit call stack
if( bJobStillActive )
{
// only save off debug info for jobs that are still running
MemAlloc_SaveDebugInfo( m_memAllocStack.Base() );
}
MemAlloc_RestoreDebugInfo( pvSaveDebugInfo );
}
void CJob::Debug()
{
AssertNotRunningThisJob();
// This function will 'load' this coroutine then immediately
// break into the debugger. When execution is continued, it
// will pop back out to this context
// So, we don't set m_pJobPrev or g_pJobCur because nobody
// would ever have the chance to see them anyway.
Coroutine_DebugBreak( m_hCoroutine );
}
//-----------------------------------------------------------------------------
// Purpose: pauses the current job
//-----------------------------------------------------------------------------
void CJob::Pause( EJobPauseReason eReason )
{
AssertRunningThisJob();
AssertMsg1( 0 == m_stackDoNotYieldGuards.Count(), "Yielding while in a BEGIN_DO_NOT_YIELD() block declared at %s", m_stackDoNotYieldGuards[m_stackDoNotYieldGuards.Head()] );
g_pJobCur = m_pJobPrev;
// End our timer so we know how much time we've spent
m_FastTimerDelta.End();
m_cyclecountTotal += m_FastTimerDelta.GetDuration();
if ( m_FastTimerDelta.GetDuration().GetMicroseconds() > k_cMicroSecTaskGranularity * 10 )
{
m_flags.m_bits.m_bLongInterYield = true;
}
// pause this job, remembering which frame and why
m_ePauseReason = eReason;
// We shouldn't have to set the frame -- it should be the same one
Assert( m_STimeSwitched.LTime() == CJobTime::LJobTimeCur() );
Coroutine_YieldToMain();
}
void CJob::GenerateAssert( const char *pchMsg )
{
// Default message if they didn't provide a custom one
if ( !pchMsg )
{
pchMsg = "Forced assert failure";
}
// Just for grins, allow this function to be called whether
// we are the current job or not
if ( this == g_pJobCur )
{
AssertMsg1( !"Job assertion requested", "%s", pchMsg );
}
else
{
Coroutine_DebugAssert( m_hCoroutine, pchMsg );
}
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a network msg for the job arrives
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitForMsg( IMsgNetPacket **ppNetPacket )
{
AssertRunningThisJob();
*ppNetPacket = NULL;
// await and retrieve the network message
if ( GetJobMgr().BYieldingWaitForMsg( *this ) )
{
Assert( m_vecNetPackets.Count() > 0 );
*ppNetPacket = m_vecNetPackets.Tail();
return true;
}
return false;
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a network msg for the job arrives
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitForMsg( CGCMsgBase *pMsg, MsgType_t eMsg )
{
IMsgNetPacket *pNetPacket = NULL;
// Check if we already waited for a message of this type
// but timed out. If so, then we currently don't have a way
// to tell if the message we might receive is the reply
// to the old mesage, of the one we're about to send.
// So let's just disallow this entirely.
if ( BHasFailedToReceivedMsgType( eMsg ) )
{
AssertMsg2( false, "Job %s cannot wait for msg %u, it has already failed to wait for that msg type.", GetName(), eMsg );
return false;
}
m_unWaitMsgType = eMsg;
if ( !BYieldingWaitForMsg( &pNetPacket) )
{
// Remember this event, so we can at least detect if a reply comes late, we don't get confused.
MarkFailedToReceivedMsgType( eMsg );
return false;
}
pMsg->SetPacket( pNetPacket );
if ( pMsg->Hdr().m_eMsg != eMsg )
{
// Remember this event, so we can at least detect if a reply comes late, we don't get confused.
MarkFailedToReceivedMsgType( eMsg );
AssertMsg2( false, "CJob::BYieldingWaitForMsg expected msg %u but received %u", eMsg, pMsg->Hdr().m_eMsg );
return false;
}
return true;
}
//-----------------------------------------------------------------------------
bool CJob::BHasFailedToReceivedMsgType( MsgType_t m ) const
{
FOR_EACH_VEC( m_vecMsgTypesFailedToReceive, i )
{
if ( m_vecMsgTypesFailedToReceive[i] == m )
return true;
}
return false;
}
//-----------------------------------------------------------------------------
void CJob::MarkFailedToReceivedMsgType( MsgType_t m )
{
if ( !BHasFailedToReceivedMsgType( m ) )
{
m_vecMsgTypesFailedToReceive.AddToTail( m );
}
}
//-----------------------------------------------------------------------------
void CJob::ClearFailedToReceivedMsgType( MsgType_t m )
{
m_vecMsgTypesFailedToReceive.FindAndFastRemove( m );
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a network msg for the job arrives
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitForMsg( CProtoBufMsgBase *pMsg, MsgType_t eMsg )
{
IMsgNetPacket *pNetPacket = NULL;
// Check if we already waited for a message of this type
// but timed out. If so, then we currently don't have a way
// to tell if the message we might receive is the reply
// to the old mesage, of the one we're about to send.
// So let's just disallow this entirely.
if ( BHasFailedToReceivedMsgType( eMsg ) )
{
AssertMsg2( false, "Job %s cannot wait for msg %u, it has already failed to wait for that msg type.", GetName(), eMsg );
return false;
}
m_unWaitMsgType = eMsg;
if ( !BYieldingWaitForMsg( &pNetPacket) )
{
// Remember this event, so we can at least detect if a reply comes late, we don't get confused.
MarkFailedToReceivedMsgType( eMsg );
return false;
}
pMsg->InitFromPacket( pNetPacket );
if ( pMsg->GetEMsg() != eMsg )
{
// Remember this event, so we can at least detect if a reply comes late, we don't get confused.
MarkFailedToReceivedMsgType( eMsg );
EmitError( SPEW_GC, "CJob::BYieldingWaitForMsg expected msg %u but received %u", eMsg, pMsg->GetEMsg() );
return false;
}
return true;
}
#ifdef GC
bool CJob::BYieldingWaitForMsg( CGCMsgBase *pMsg, MsgType_t eMsg, const CSteamID &expectedID )
{
if( !BYieldingWaitForMsg( pMsg, eMsg ) )
return false;
if( pMsg->Hdr().m_ulSteamID != expectedID.ConvertToUint64() )
{
EmitError( SPEW_GC, "CJob::BYieldingWaitForMsg expected reply from steam ID %s, but instead got a response from %s for message %d\n", expectedID.Render(), CSteamID( pMsg->Hdr().m_ulSteamID ).Render(), eMsg );
return false;
}
return true;
}
bool CJob::BYieldingWaitForMsg( CProtoBufMsgBase *pMsg, MsgType_t eMsg, const CSteamID &expectedID )
{
if( !BYieldingWaitForMsg( pMsg, eMsg ) )
return false;
if( pMsg->GetClientSteamID() != expectedID )
{
EmitError( SPEW_GC, "CJob::BYieldingWaitForMsg expected reply from steam ID %s, but instead got a response from %s for message %d\n", expectedID.Render(), pMsg->GetClientSteamID().Render(), eMsg );
return false;
}
return true;
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a network msg for the job arrives
//-----------------------------------------------------------------------------
bool CJob::BYieldingRunQuery( CGCSQLQueryGroup *pQueryGroup, ESchemaCatalog eSchemaCatalog )
{
AssertRunningThisJob();
// await and retrieve the network message
return GetJobMgr().BYieldingRunQuery( *this, pQueryGroup, eSchemaCatalog );
}
#endif
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a work item callback occurs
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitForWorkItem( const char *pszWorkItemName )
{
AssertRunningThisJob();
// await the work item completion
return GetJobMgr().BYieldingWaitForWorkItem( *this, pszWorkItemName );
}
//-----------------------------------------------------------------------------
// Purpose: CWorkItem for processing functions in CJob-derived classes on another thread
//-----------------------------------------------------------------------------
class CJobThreadFuncWorkItem : public CWorkItem
{
public:
DECLARE_WORK_ITEM( CJobThreadFuncWorkItem );
CJobThreadFuncWorkItem( CJob *pJob, JobThreadFunc_t jobThreadFunc, CFunctor *pFunctor ) : CWorkItem( pJob->GetJobID() ),
m_pJob( pJob ),
m_pJobThreadFunc( jobThreadFunc ),
m_pFunctor( pFunctor )
{
}
virtual bool ThreadProcess( CWorkThread *pThread )
{
if ( m_pJobThreadFunc )
(m_pJob->*m_pJobThreadFunc)();
if ( m_pFunctor )
(*m_pFunctor)();
return true;
}
private:
CJob *m_pJob;
JobThreadFunc_t m_pJobThreadFunc;
CFunctor *m_pFunctor;
};
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a work item callback occurs
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitForThreadFuncWorkItem( CWorkItem *pItem )
{
AssertRunningThisJob();
Assert( m_pWaitingOnWorkItem == NULL );
Assert( pItem->GetJobID() == GetJobID() );
m_pWaitingOnWorkItem = pItem;
// add it to a central thread pool
GetJobMgr().AddThreadedJobWorkItem( pItem );
// await the work item completion
bool bSuccess = GetJobMgr().BYieldingWaitForWorkItem( *this );
m_pWaitingOnWorkItem = NULL;
return bSuccess;
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job until a work item callback occurs
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitForThreadFunc( CFunctor *jobFunctor )
{
// store off which function to launch when we're done
CJobThreadFuncWorkItem *pJobThreadFuncWorkItem = new CJobThreadFuncWorkItem( this, NULL, jobFunctor );
bool bSuccess = BYieldingWaitForThreadFuncWorkItem( pJobThreadFuncWorkItem );
// free the thread func
SafeRelease( jobFunctor );
SAFE_RELEASE( pJobThreadFuncWorkItem );
return bSuccess;
}
//-----------------------------------------------------------------------------
// Purpose: Allows a job that was paused for a specific reason to resume
//-----------------------------------------------------------------------------
void CJob::EndPause( EJobPauseReason eExpectedState )
{
Assert( m_ePauseReason == eExpectedState );
if( m_ePauseReason == eExpectedState )
{
m_ePauseReason = k_EJobPauseReasonYield;
}
}
//-----------------------------------------------------------------------------
// Purpose: Returns the number of heartbeats to wait before timing out this job
//-----------------------------------------------------------------------------
uint32 CJob::CHeartbeatsBeforeTimeout()
{
return k_cJobHeartbeatsBeforeTimeoutDefault;
}
//-----------------------------------------------------------------------------
// Purpose: Send heartbeat messages to our listeners during long operations
// to let them know we're still alive and avoid timeouts
// This should be called by the CJobMgr
//-----------------------------------------------------------------------------
void CJob::Heartbeat()
{
// Reset our counter
m_STimeNextHeartbeat.SetFromJobTime( k_cMicroSecJobHeartbeat );
}
//-----------------------------------------------------------------------------
// Purpose: waits for specified time and checks for timeout. Useful when you
// need to repeatedly sleep while waiting for something to happen.
// This function uses STime (server "pseudo" time) to determine
// timeout conditions.
//
// Input: cMicrosecondsToSleep - duration to sleep this call
// stimeStarted - the time to calculate timeout from. (Typically,
// the time you start calling this in a loop, passing the same
// start time each time you call this method.)
// nMicroSecLimit - duration from stimeStarted to consider timed out
// Output : Returns true if not timed out yet, false if timed out
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitTimeWithLimit( uint32 cMicrosecondsToSleep, CJobTime &stimeStarted, int64 nMicroSecLimit )
{
if ( stimeStarted.CServerMicroSecsPassed() > nMicroSecLimit )
return false;
return BYieldingWaitTime( cMicrosecondsToSleep );
}
//-----------------------------------------------------------------------------
// Purpose: waits for specified time and checks for timeout. Useful when you
// need to repeatedly sleep while waiting for something to happen.
// This function uses RTime (wall-clock "real" time) to determine
// timeout conditions.
//
// Input: cMicrosecondsToSleep - duration to sleep this call
// nSecLimit - duration from stimeStarted to consider timed out
// Output : Returns true if not timed out yet, false if timed out
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitTimeWithLimitRealTime( uint32 cMicrosecondsToSleep, int nSecondsLimit )
{
return BYieldingWaitTime( cMicrosecondsToSleep );
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job for the specified amount of time
// Input : m_cMicrosecondsToSleep - microseconds to wait for
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitTime( uint32 cMicrosecondsToSleep )
{
AssertRunningThisJob();
return GetJobMgr().BYieldingWaitTime( *this, cMicrosecondsToSleep );
}
//-----------------------------------------------------------------------------
// Purpose: pauses the job until the next time the JobMgr Run() is called
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYield()
{
AssertRunningThisJob();
return GetJobMgr().BYield( *this );
}
//-----------------------------------------------------------------------------
// Purpose: Pauses the job ONLY IF JobMgr decides it needs to based on time run and priority
// If pausing, pauses until the next time the JobMgr Run() is called
// Input: pbYielded - Set to true if we did yield
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYieldIfNeeded( bool *pbYielded )
{
AssertRunningThisJob();
if ( pbYielded )
*pbYielded = false;
// Assume only low priority jobs need to yield
// Automatically bail out here if the job is not low priority
return GetJobMgr().BYieldIfNeeded( *this, pbYielded );
}
//-----------------------------------------------------------------------------
// Purpose: Pauses the job for a single frame
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::BYieldingWaitOneFrame()
{
return BYieldingWaitTime( 1 );
}
//-----------------------------------------------------------------------------
// Purpose: Blocks until we acquire the lock on the specified object
// Input : *pLock - object to lock
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::_BYieldingAcquireLock( CLock *pLock, const char *filename, int line )
{
AssertRunningThisJob();
// Skip the path info from the filename. It just maks the debug messages excessively long.
filename = V_GetFileName( filename );
// Is the lock locked by this job? If so, inc the ref count.
if ( pLock->GetJobLocking() == this )
{
pLock->IncrementReference();
return true;
}
// jobs can have multiple locks as long as they are in priority order
FOR_EACH_VEC( m_vecLocks, i )
{
if( m_vecLocks[i]->GetLockType() == pLock->GetLockType() )
{
if( m_vecLocks[i]->GetLockSubType() <= pLock->GetLockSubType() )
{
AssertMsg7( false, "Job %s Locking %s at %s:(%d) with yielding; holds lock %s from %s(%d)\n",
GetName(),
pLock->GetName(),
filename, line,
m_vecLocks[i]->GetName(),
m_vecLocks[i]->m_pFilename, m_vecLocks[i]->m_line );
return false;
}
}
else if ( m_vecLocks[i]->GetLockType() < pLock->GetLockType() )
{
AssertMsg7( false, "Job %s Locking %s at %s:(%d) with yielding; holds lock %s from %s(%d)\n",
GetName(),
pLock->GetName(),
filename, line,
m_vecLocks[i]->GetName(),
m_vecLocks[i]->m_pFilename, m_vecLocks[i]->m_line );
return false;
}
}
if( m_pWaitingOnLock != NULL )
{
AssertMsg7( false, "Job (%s) locking %s at %s(%d); already waiting on %s at %s(%d).\n",
GetName(),
pLock->GetName(),
filename, line,
m_pWaitingOnLock->GetName(),
m_pWaitingOnLock->m_pFilename, m_pWaitingOnLock->m_line );
return false;
}
m_cLocksAttempted++;
if ( pLock->BIsLocked() )
{
// tell the job we want the lock next
// But walking the entire linked list is slow so
// skip to the tail pointer
pLock->AddToWaitingQueue( this );
// We should be the tail of the list
Assert( NULL == m_pJobToNotifyOnLockRelease );
// yield until we get the lock
m_pWaitingOnLock = pLock;
m_pWaitingOnLockFilename = filename;
m_waitingOnLockLine = line;
m_cLocksWaitedFor++;
Pause( k_EJobPauseReasonWaitingForLock );
m_pWaitingOnLock = NULL;
// make sure we actually got it, instead of timing out
int index = m_vecLocks.Find( pLock );
if ( index != m_vecLocks.InvalidIndex() && this == pLock->GetJobLocking() )
{
pLock->IncrementReference();
return true;
}
else
{
m_flags.m_bits.m_bLocksFailed = true;
EmitWarning( SPEW_JOB, LOG_ALWAYS, "Failed to get lock %s at %s(%d) after waiting in %s\n", pLock->GetName(), filename, line, GetName() );
if ( m_vecLocks.Count() == 0 )
{
EmitWarning( SPEW_JOB, LOG_ALWAYS, "m_vecLocks.Count(): %d, this: 0x%p, pLock->GetJobLocking(): %s (0x%p)\n",
m_vecLocks.Count(), this, pLock->GetJobLocking() ? pLock->GetJobLocking()->GetName() : "(null)", pLock->GetJobLocking() );
}
else
{
EmitWarning( SPEW_JOB, LOG_ALWAYS, "m_vecLocks.Count(): %d this: 0x%p, pLock: 0x%p pLock->GetJobLocking(): %s (0x%p)\n",
m_vecLocks.Count(), this, pLock, pLock->GetJobLocking() ? pLock->GetJobLocking()->GetName() : "(null)", pLock->GetJobLocking() );
FOR_EACH_VEC( m_vecLocks, i )
{
EmitWarning( SPEW_JOB, LOG_ALWAYS, "m_vecLocks[%d]: %s (0x%p) %s(%d)\n",
i, m_vecLocks[i] ? m_vecLocks[i]->GetName() : "(null)", m_vecLocks[i], m_vecLocks[i]->m_pFilename, m_vecLocks[i]->m_line );
}
}
return false;
}
}
else
{
// unused, take it for ourself
pLock->IncrementReference();
_SetLock( pLock, filename, line );
return true;
}
}
//-----------------------------------------------------------------------------
// Purpose: Either locks on the specified object immediately or returns failure
// Input : *pLock - object to lock
// Output : Returns true on success, false on failure.
//-----------------------------------------------------------------------------
bool CJob::_BAcquireLockImmediate( CLock *pLock, const char *filename, int line )
{
AssertRunningThisJob();
AssertMsg5( m_pWaitingOnLock == NULL, "Job (%s) at %s(%d) trying to take a lock while it was already waiting for the first one at %s(%d)", GetName(), filename, line, m_pWaitingOnLockFilename, m_waitingOnLockLine );
m_cLocksAttempted++;
// Is the lock locked by this job? If so, inc the ref count.
if ( pLock->GetJobLocking() == this )
{
pLock->IncrementReference();
return true;
}
if ( !pLock->BIsLocked() )
{
// unused, take it for ourself
pLock->IncrementReference();
_SetLock( pLock, filename, line );
return true;
}