Fiber.cs SpicyPixel::Threading::Fiber SpicyPixel SpicyPixel::Threading System::Linq /* Author:AaronOneal,http://aarononeal.info Copyright(c)2012SpicyPixel,http://spicypixel.com Permissionisherebygranted,freeofcharge,toanypersonobtaining acopyofthissoftwareandassociateddocumentationfiles(the "Software"),todealintheSoftwarewithoutrestriction,including withoutlimitationtherightstouse,copy,modify,merge,publish, distribute,sublicense,and/orsellcopiesoftheSoftware,andto permitpersonstowhomtheSoftwareisfurnishedtodoso,subjectto thefollowingconditions: Theabovecopyrightnoticeandthispermissionnoticeshallbe includedinallcopiesorsubstantialportionsoftheSoftware. THESOFTWAREISPROVIDED"ASIS",WITHOUTWARRANTYOFANYKIND, EXPRESSORIMPLIED,INCLUDINGBUTNOTLIMITEDTOTHEWARRANTIESOF MERCHANTABILITY,FITNESSFORAPARTICULARPURPOSEAND NONINFRINGEMENT.INNOEVENTSHALLTHEAUTHORSORCOPYRIGHTHOLDERSBE LIABLEFORANYCLAIM,DAMAGESOROTHERLIABILITY,WHETHERINANACTION OFCONTRACT,TORTOROTHERWISE,ARISINGFROM,OUTOFORINCONNECTION WITHTHESOFTWAREORTHEUSEOROTHERDEALINGSINTHESOFTWARE. */ usingSystem; usingSystem.Collections; usingSystem.Collections.Generic; usingSystem.Linq; usingSystem.Threading; namespaceSpicyPixel.Threading { publicpartialclassFiber { [ThreadStatic] privatestaticFibercurrentFiber; privatestaticFiberFactoryfiberFactory=newFiberFactory(); privatestaticintnextId=0; privateIEnumeratorcoroutine; privateActionaction; privateAction<object>actionObject; privateobjectobjectState; privateFunc<FiberInstruction>func; privateFunc<object,FiberInstruction>funcObject; privateFiberSchedulerscheduler; privateintstatus=(int)FiberStatus.Created; //mustbeinttoworkwithInterlockedonMono privateIDictionary<string,object>properties; internalCancellationTokencancelToken; internalFiberantecedent; internalQueue<FiberContinuation>continuations; publicstaticFiberCurrentFiber{ get{ returncurrentFiber; } privateset{ currentFiber=value; } } publicstaticFiberFactoryFactory{ get{ returnfiberFactory; } } staticintCheckTimeout(TimeSpantimeout) { try{ returnchecked((int)timeout.TotalMilliseconds); }catch(System.OverflowException){ thrownewArgumentOutOfRangeException("timeout"); } } publicIDictionary<string,object>Properties{ get{ if(properties==null) properties=newDictionary<string,object>(); returnproperties; } } internalFiberSchedulerScheduler{ get{returnscheduler;} set{scheduler=value;} } publicstringName{get;set;} publicobjectResultAsObject{get;internalset;} publicboolIsCanceled{ get{ return(FiberStatus)status==FiberStatus.Canceled; } } publicboolIsCompleted{ get{ return(FiberStatus)status>=FiberStatus.RanToCompletion; } } publicboolIsFaulted{ get{ return(FiberStatus)status==FiberStatus.Faulted; } } publicExceptionException{ get; privateset; } publicFiberStatusStatus{ get{return(FiberStatus)status;} set{status=(int)value;} } publicFiberAntecedent{ get{returnantecedent;} } publicCancellationTokenCancellationToken{ get{returncancelToken;} } privatevoidFinishCompletion() { if(continuations==null) return; while(true){ if(continuations.Count==0) return; varcontinuation=continuations.Dequeue(); continuation.Execute(); } } internalvoidCancelContinuation() { status=(int)FiberStatus.Canceled; FinishCompletion(); } internalvoidFaultContinuation(Exceptionexception) { status=(int)FiberStatus.Faulted; Exception=exception; FinishCompletion(); } publicintId{get;privateset;} publicFiber(IEnumeratorcoroutine):this(coroutine,CancellationToken.None) { } publicFiber(IEnumeratorcoroutine,CancellationTokencancellationToken) { Id=nextId++; this.coroutine=coroutine; this.cancelToken=cancellationToken; } publicFiber(Actionaction):this(action,CancellationToken.None) { } publicFiber(Actionaction,CancellationTokencancellationToken) { Id=nextId++; this.action=action; this.cancelToken=cancellationToken; } publicFiber(Action<object>action,objectstate):this(action,state,CancellationToken.None) { } publicFiber(Action<object>action,objectstate,CancellationTokencancellationToken) { Id=nextId++; this.actionObject=action; this.objectState=state; this.cancelToken=cancellationToken; } publicFiber(Func<FiberInstruction>func):this(func,CancellationToken.None) { } publicFiber(Func<FiberInstruction>func,CancellationTokencancellationToken) { Id=nextId++; this.func=func; this.cancelToken=cancellationToken; } publicFiber(Func<object,FiberInstruction>func,objectstate):this(func,state,CancellationToken.None) { } publicFiber(Func<object,FiberInstruction>func,objectstate,CancellationTokencancellationToken) { Id=nextId++; this.funcObject=func; this.objectState=state; this.cancelToken=cancellationToken; } publicvoidStart() { Start(FiberScheduler.Current); } publicvoidStart(FiberSchedulerscheduler) { //ItwouldbeunusualtoattempttostartaFibermorethanonce, //buttobesafeandtosupportcallingfromanythread //useInterlockedwithboxingontheenum. varoriginalState=(FiberStatus)Interlocked.CompareExchange(refstatus,(int)FiberStatus.WaitingToRun,(int)FiberStatus.Created); if(originalState!=FiberStatus.Created){ originalState=(FiberStatus)Interlocked.CompareExchange(refstatus,(int)FiberStatus.WaitingToRun,(int)FiberStatus.WaitingForActivation); if(originalState!=FiberStatus.WaitingForActivation){ thrownewInvalidOperationException("Afibercannotbestartedagainonceithasbegunrunningorhascompleted."); } } this.scheduler=scheduler; ((IFiberScheduler)this.scheduler).QueueFiber(this); } publicvoidThrowIfCanceled() { if(IsCanceled) thrownewSystem.Threading.OperationCanceledException(); } publicvoidThrowIfFaulted() { if(IsFaulted) throwException; } publicvoidThrowIfCanceledOrFaulted() { ThrowIfCanceled(); ThrowIfFaulted(); } internalFiberInstructionExecute() { //Console.WriteLine("Fiber{0}:{1}startexecuting",Id,Status); //Sanitycheckthescheduler.Sincethisisascheduler //onlyissue,thistesthappensfirstbeforeexecution //andbeforeallowinganexceptionhandlertotakeover. if(IsCompleted) thrownewInvalidOperationException("AnattemptwasmadetoexecuteacompletedFiber.Thisindicatesalogicerrorinthescheduler."); //Setupthreadglobalswiththisschedulerastheowner. //Thesynccontextisalsosetupwhentheschedulerchanges. //Settingthesynccontextisn'tasimpleassignin.NET //sodon'tdothisuntilneeded. // //DoingthissetupinExecute()freesderivedschedulersfromthe //burdenofsettingupthesynccontextorscheduler.Italsoallowsthe //currentschedulertochangeondemandwhenthereismorethanone //schedulerrunningperthread. // //Forexample,eachMonoBehaviourinUnityisassigneditsown //schedulersincethebehaviordeterminesthelifetimeoftasks. //Theactiveschedulerthencanvarydependingonwhichbehavioris //currentlyexecutingtasks.Unitywilldecideoutsideofthisframework //whichbehaviourtoexecuteinwhichorderandthereforewhich //schedulerisactive.Theactiveschedulerinthiscasecan //onlybedeterminedatthetimeoffiberexecution. // //UnlikeCurrentFiberbelow,thisdoesnotneedtobestacked //oncesetbecausetheschedulerwillneverchangeduringfiber //execution.Onlysomethingoutsideoftheschedulerwould //changethescheduler. if(FiberScheduler.Current!=scheduler) FiberScheduler.SetCurrentScheduler(scheduler,true); //Pushthecurrentfiberontothestackandpopitinfinally. //Thismustbestackedbecausethefibermayspawnanother //fiberwhichtheschedulermaychoosetoinlinewhichwouldresult //inanewfibertemporarilytakingitsplaceascurrent. varlastFiber=Fiber.CurrentFiber; Fiber.CurrentFiber=this; //Startthefiberifnotstarted Interlocked.CompareExchange(refstatus,(int)FiberStatus.WaitingToRun,(int)FiberStatus.Created); Interlocked.CompareExchange(refstatus,(int)FiberStatus.Running,(int)FiberStatus.WaitingToRun); try{ objectresult=null; //Executethecoroutineoraction if(coroutine!=null){ //Console.WriteLine("Fiber{0}:{1}startexecutingcoroutine",Id,Status); //Executecoroutine if(coroutine.MoveNext()){ //Getresultofexecution result=coroutine.Current; //Ifthecoroutinereturnedastopdirectly //thefiberstillneedstoprocessit if(resultisStopInstruction) Stop(FiberStatus.RanToCompletion); }else{ //Coroutinefinishedexecuting result=Stop(FiberStatus.RanToCompletion); } //Console.WriteLine("Fiber{0}:{1}endexecutingcoroutine",Id,Status); }elseif(action!=null){ //Executeaction action(); //Actionfinishedexecuting result=Stop(FiberStatus.RanToCompletion); }elseif(actionObject!=null){ //Executeaction actionObject(objectState); //Actionfinishedexecuting result=Stop(FiberStatus.RanToCompletion); }elseif(func!=null){ result=func(); func=null; if(resultisStopInstruction) Stop(FiberStatus.RanToCompletion); }elseif(funcObject!=null){ result=funcObject(objectState); funcObject=null; if(resultisStopInstruction) Stop(FiberStatus.RanToCompletion); }else{ //Funcexecutionnullsoutthefunction //sotheschedulerwillreturntohere //whencompleteandthenstop. result=Stop(FiberStatus.RanToCompletion); } //Treatnullasaspecialcase if(result==null) returnFiberInstruction.YieldToAnyFiber; //Returninstructionsorthrowifinvalid varinstruction=resultasFiberInstruction; if(instruction==null){ //Iftheresultwasanenumeratorthereisanestedcoroutinetoexecute if(resultisIEnumerator){ instruction=newYieldUntilComplete(Fiber.Factory.StartNew(resultasIEnumerator,cancelToken,scheduler)); }elseif(resultisFiber){ //Convertfibersintoyieldinstructions instruction=newYieldUntilComplete(resultasFiber); }else{ //Passthroughothervalues returnnewObjectInstruction(result); } } if(instructionisFiberResult){ ResultAsObject=((FiberResult)instruction).Result; result=Stop(FiberStatus.RanToCompletion); } //Verifysamescheduler if(instructionisYieldUntilComplete&&((YieldUntilComplete)instruction).Fiber.Scheduler!=FiberScheduler.Current) thrownewInvalidOperationException("Currentlyonlyfibersbelongingtothesameschedulermaybeyieldedto.FiberScheduler.Current=" +(FiberScheduler.Current==null?"null":FiberScheduler.Current.ToString()) +",Fiber.Scheduler="+(((YieldUntilComplete)instruction).Fiber.Scheduler==null?"null":((YieldUntilComplete)instruction).Fiber.Scheduler.ToString())); varyieldToFiberInstruction=instructionasYieldToFiber; if(yieldToFiberInstruction!=null){ //Startfibersyieldedtothataren'trunningyet Interlocked.CompareExchange(refyieldToFiberInstruction.Fiber.status,(int)FiberStatus.WaitingToRun,(int)FiberStatus.Created); varoriginalState=(FiberStatus)Interlocked.CompareExchange(refyieldToFiberInstruction.Fiber.status,(int)FiberStatus.Running,(int)FiberStatus.WaitingToRun); if(originalState==FiberStatus.WaitingToRun) yieldToFiberInstruction.Fiber.scheduler=scheduler; //Can'tswitchtocompletedfibers if(yieldToFiberInstruction.Fiber.IsCompleted) thrownewInvalidOperationException("Anattemptwasmadetoyieldtoacompletedfiber."); //Verifyscheduler if(yieldToFiberInstruction.Fiber.Scheduler!=FiberScheduler.Current) thrownewInvalidOperationException("Currentlyonlyfibersbelongingtothesameschedulermaybeyieldedto.FiberScheduler.Current=" +(FiberScheduler.Current==null?"null":FiberScheduler.Current.ToString()) +",Fiber.Scheduler="+(yieldToFiberInstruction.Fiber.Scheduler==null?"null":yieldToFiberInstruction.Fiber.Scheduler.ToString())); } //Console.WriteLine("Fiber{0}:{1}returning{2}",Id,Status,instruction); returninstruction; }catch(System.Threading.OperationCanceledExceptioncancelException){ //Handleaspropercancellationonlyifthetokenmatches. //Otherwisetreatitasafault. if(cancelException.CancellationToken==cancelToken){ this.Exception=null; returnStop(FiberStatus.Canceled); }else{ this.Exception=cancelException; returnStop(FiberStatus.Faulted); } }catch(ExceptionfiberException){ this.Exception=fiberException; returnStop(FiberStatus.Faulted); }finally{ //Popthecurrentfiber Fiber.CurrentFiber=lastFiber; //Console.WriteLine("Fiber{0}:{1}endexecuting",Id,Status); } } privateStopInstructionStop(FiberStatusfinalStatus) { //Interlockedisn'tnecessarybecausewedon'tneed //theinitialvalue(stopsarefinal).Theyarealso //onlycalledbytheschedulerthreadduringExecute(). status=(int)finalStatus; FinishCompletion(); returnFiberInstruction.Stop; } } }