| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347 |
- //-------------------------------------------------------------------------------------------------------
- // Copyright (C) Microsoft. All rights reserved.
- // Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- //-------------------------------------------------------------------------------------------------------
- #pragma once
- struct CodeGenWorkItem;
- class SourceContextInfo;
- class FunctionBailOutRecord;
- struct DeferredFunctionStub;
- #ifdef DYNAMIC_PROFILE_MUTATOR
- class DynamicProfileMutator;
- class DynamicProfileMutatorImpl;
- #endif
- #define MAX_FUNCTION_BODY_DEBUG_STRING_SIZE 42 //11*3+8+1
- namespace Js
- {
- #pragma region Class Forward Declarations
- class ByteCodeBufferReader;
- class ByteCodeBufferBuilder;
- class ByteCodeCache;
- class ScopeInfo;
- class SmallSpanSequence;
- struct StatementLocation;
- class SmallSpanSequenceIter;
- struct StatementData;
- struct PropertyIdOnRegSlotsContainer;
- struct InlineCache;
- struct PolymorphicInlineCache;
- struct IsInstInlineCache;
- class ScopeObjectChain;
- class EntryPointInfo;
- class FunctionProxy;
- class ParseableFunctionInfo;
- class FunctionBody;
- class DebuggerScopeProperty;
- class DebuggerScope;
- class FunctionEntryPointInfo;
- #ifndef TEMP_DISABLE_ASMJS
- class AsmJsFunctionInfo;
- class AmsJsModuleInfo;
- #endif
- class ArrayBuffer;
- class FunctionCodeGenRuntimeData;
- #pragma endregion
- typedef JsUtil::BaseDictionary<Js::PropertyId, const Js::PropertyRecord*, RecyclerNonLeafAllocator, PowerOf2SizePolicy, DefaultComparer, JsUtil::SimpleDictionaryEntry> PropertyRecordList;
- typedef JsUtil::BaseHashSet<void*, Recycler, PowerOf2SizePolicy> TypeRefSet;
- // Definition of scopes such as With, Catch and Block which will be used further in the debugger for additional look-ups.
- enum DiagExtraScopesType
- {
- DiagUnknownScope, // Unknown scope set when deserializing bytecode and the scope is not yet known.
- DiagWithScope, // With scope.
- DiagCatchScopeDirect, // Catch scope in regslot
- DiagCatchScopeInSlot, // Catch scope in slot array
- DiagCatchScopeInObject, // Catch scope in scope object
- DiagBlockScopeDirect, // Block scope in regslot
- DiagBlockScopeInSlot, // Block scope in slot array
- DiagBlockScopeInObject, // Block scope in activation object
- DiagBlockScopeRangeEnd, // Used to end a block scope range.
- };
- class PropertyGuard
- {
- friend class PropertyGuardValidator;
- private:
- intptr_t value;
- public:
- static PropertyGuard* New(Recycler* recycler) { return RecyclerNewLeaf(recycler, Js::PropertyGuard); }
- PropertyGuard() : value(1) {}
- PropertyGuard(intptr_t value) : value(value) { Assert(this->value != 0); }
- inline static size_t const GetSizeOfValue() { return sizeof(((PropertyGuard*)0)->value); }
- inline static size_t const GetOffsetOfValue() { return offsetof(PropertyGuard, value); }
- intptr_t GetValue() const { return this->value; }
- bool IsValid() { return this->value != 0; }
- void SetValue(intptr_t value) { Assert(value != 0); this->value = value; }
- intptr_t const* GetAddressOfValue() { return &this->value; }
- void Invalidate() { this->value = 0; }
- };
- class PropertyGuardValidator
- {
- // Required by EquivalentTypeGuard::SetType.
- CompileAssert(offsetof(PropertyGuard, value) == 0);
- CompileAssert(offsetof(ConstructorCache, guard.value) == offsetof(PropertyGuard, value));
- };
- class JitIndexedPropertyGuard : public Js::PropertyGuard
- {
- private:
- int index;
- public:
- JitIndexedPropertyGuard(intptr_t value, int index):
- Js::PropertyGuard(value), index(index) {}
- int GetIndex() const { return this->index; }
- };
- class JitTypePropertyGuard : public Js::JitIndexedPropertyGuard
- {
- public:
- JitTypePropertyGuard(Js::Type* type, int index):
- JitIndexedPropertyGuard(reinterpret_cast<intptr_t>(type), index) {}
- Js::Type* GetType() const { return reinterpret_cast<Js::Type*>(this->GetValue()); }
- };
- struct TypeGuardTransferEntry
- {
- PropertyId propertyId;
- JitIndexedPropertyGuard* guards[0];
- TypeGuardTransferEntry(): propertyId(Js::Constants::NoProperty) {}
- };
- class FakePropertyGuardWeakReference: public RecyclerWeakReference<Js::PropertyGuard>
- {
- public:
- static FakePropertyGuardWeakReference* New(Recycler* recycler, Js::PropertyGuard* guard)
- {
- Assert(guard != nullptr);
- return RecyclerNewLeaf(recycler, Js::FakePropertyGuardWeakReference, guard);
- }
- FakePropertyGuardWeakReference(const Js::PropertyGuard* guard)
- {
- this->strongRef = (char*)guard;
- this->strongRefHeapBlock = &CollectedRecyclerWeakRefHeapBlock::Instance;
- }
- void Zero()
- {
- Assert(this->strongRef != nullptr);
- this->strongRef = nullptr;
- }
- };
- struct CtorCacheGuardTransferEntry
- {
- PropertyId propertyId;
- ConstructorCache* caches[0];
- CtorCacheGuardTransferEntry(): propertyId(Js::Constants::NoProperty) {}
- };
- #define EQUIVALENT_TYPE_CACHE_SIZE (8)
- struct EquivalentTypeCache
- {
- Js::Type* types[EQUIVALENT_TYPE_CACHE_SIZE];
- PropertyGuard *guard;
- TypeEquivalenceRecord record;
- uint nextEvictionVictim;
- bool isLoadedFromProto;
- bool hasFixedValue;
- EquivalentTypeCache(): nextEvictionVictim(EQUIVALENT_TYPE_CACHE_SIZE) {}
- bool ClearUnusedTypes(Recycler *recycler);
- void SetGuard(PropertyGuard *theGuard) { this->guard = theGuard; }
- void SetIsLoadedFromProto() { this->isLoadedFromProto = true; }
- bool IsLoadedFromProto() const { return this->isLoadedFromProto; }
- void SetHasFixedValue() { this->hasFixedValue = true; }
- bool HasFixedValue() const { return this->hasFixedValue; }
- };
- class JitEquivalentTypeGuard : public JitIndexedPropertyGuard
- {
- // This pointer is allocated from background thread first, and then transferred to recycler,
- // so as to keep the cached types alive.
- EquivalentTypeCache* cache;
- uint32 objTypeSpecFldId;
- public:
- JitEquivalentTypeGuard(Type* type, int index, uint32 objTypeSpecFldId):
- JitIndexedPropertyGuard(reinterpret_cast<intptr_t>(type), index), cache(nullptr), objTypeSpecFldId(objTypeSpecFldId) {}
- Js::Type* GetType() const { return reinterpret_cast<Js::Type*>(this->GetValue()); }
- void SetType(const Js::Type* type)
- {
- this->SetValue(reinterpret_cast<intptr_t>(type));
- }
- uint32 GetObjTypeSpecFldId() const
- {
- return this->objTypeSpecFldId;
- }
- Js::EquivalentTypeCache* GetCache() const
- {
- return this->cache;
- }
- void SetCache(Js::EquivalentTypeCache* cache)
- {
- this->cache = cache;
- }
- };
- #pragma region Inline Cache Info class declarations
- class PolymorphicCacheUtilizationArray
- {
- private:
- byte *utilArray;
- public:
- PolymorphicCacheUtilizationArray()
- : utilArray(nullptr)
- {
- }
- void EnsureUtilArray(Recycler * const recycler, Js::FunctionBody * functionBody);
- void SetUtil(Js::FunctionBody* functionBody, uint index, byte util);
- byte GetUtil(Js::FunctionBody* functionBody, uint index);
- };
- class PolymorphicInlineCacheInfo sealed
- {
- private:
- InlineCachePointerArray<PolymorphicInlineCache> polymorphicInlineCaches;
- PolymorphicCacheUtilizationArray polymorphicCacheUtilizationArray;
- FunctionBody * functionBody;
- public:
- PolymorphicInlineCacheInfo(FunctionBody * functionBody)
- : functionBody(functionBody)
- {
- }
- InlineCachePointerArray<PolymorphicInlineCache> * GetPolymorphicInlineCaches() { return &polymorphicInlineCaches; }
- PolymorphicCacheUtilizationArray * GetUtilArray() { return &polymorphicCacheUtilizationArray; }
- FunctionBody * GetFunctionBody() { return functionBody; }
- };
- class EntryPointPolymorphicInlineCacheInfo sealed
- {
- private:
- PolymorphicInlineCacheInfo selfInfo;
- SListBase<PolymorphicInlineCacheInfo*> inlineeInfo;
- static void SetPolymorphicInlineCache(PolymorphicInlineCacheInfo * polymorphicInlineCacheInfo, FunctionBody * functionBody, uint index, PolymorphicInlineCache * polymorphicInlineCache, byte polyCacheUtil);
- public:
- EntryPointPolymorphicInlineCacheInfo(FunctionBody * functionBody)
- : selfInfo(functionBody)
- {
- }
- PolymorphicInlineCacheInfo * GetSelfInfo() { return &selfInfo; }
- PolymorphicInlineCacheInfo * EnsureInlineeInfo(Recycler * recycler, FunctionBody * inlineeFunctionBody);
- PolymorphicInlineCacheInfo * GetInlineeInfo(FunctionBody * inlineeFunctionBody);
- void SetPolymorphicInlineCache(FunctionBody * functionBody, uint index, PolymorphicInlineCache * polymorphicInlineCache, bool isInlinee, byte polyCacheUtil);
- template <class Fn>
- void MapInlinees(Fn fn)
- {
- SListBase<PolymorphicInlineCacheInfo*>::Iterator iter(&inlineeInfo);
- while (iter.Next())
- {
- fn(iter.Data());
- }
- }
- };
- #pragma endregion
- #ifdef FIELD_ACCESS_STATS
- struct FieldAccessStats
- {
- uint totalInlineCacheCount;
- uint noInfoInlineCacheCount;
- uint monoInlineCacheCount;
- uint emptyMonoInlineCacheCount;
- uint polyInlineCacheCount;
- uint nullPolyInlineCacheCount;
- uint emptyPolyInlineCacheCount;
- uint ignoredPolyInlineCacheCount;
- uint highUtilPolyInlineCacheCount;
- uint lowUtilPolyInlineCacheCount;
- uint equivPolyInlineCacheCount;
- uint nonEquivPolyInlineCacheCount;
- uint disabledPolyInlineCacheCount;
- uint clonedMonoInlineCacheCount;
- uint clonedPolyInlineCacheCount;
- FieldAccessStats() :
- totalInlineCacheCount(0), noInfoInlineCacheCount(0), monoInlineCacheCount(0), emptyMonoInlineCacheCount(0),
- polyInlineCacheCount(0), nullPolyInlineCacheCount(0), emptyPolyInlineCacheCount(0), ignoredPolyInlineCacheCount(0),
- highUtilPolyInlineCacheCount(0), lowUtilPolyInlineCacheCount(0),
- equivPolyInlineCacheCount(0), nonEquivPolyInlineCacheCount(0), disabledPolyInlineCacheCount(0),
- clonedMonoInlineCacheCount(0), clonedPolyInlineCacheCount(0) {}
- void Add(FieldAccessStats* other);
- };
- typedef FieldAccessStats* FieldAccessStatsPtr;
- #else
- typedef void* FieldAccessStatsPtr;
- #endif
- #pragma region Entry point class declarations
- class ProxyEntryPointInfo: public ExpirableObject
- {
- public:
- // These are public because we don't manage them nor their consistency;
- // the user of this class does.
- void * address;
- ProxyEntryPointInfo(void* address, ThreadContext* context = nullptr):
- ExpirableObject(context),
- address(address)
- {
- }
- static DWORD GetAddressOffset() { return offsetof(ProxyEntryPointInfo, address); }
- virtual void Expire()
- {
- AssertMsg(false, "Expire called on object that doesn't support expiration");
- }
- virtual void EnterExpirableCollectMode()
- {
- AssertMsg(false, "EnterExpirableCollectMode called on object that doesn't support expiration");
- }
- virtual bool IsFunctionEntryPointInfo() const { return false; }
- };
- // Not thread safe.
- // Note that instances of this class are read from and written to from the
- // main and JIT threads.
- class EntryPointInfo : public ProxyEntryPointInfo
- {
- private:
- enum State : BYTE
- {
- NotScheduled, // code gen has not been scheduled
- CodeGenPending, // code gen job has been scheduled
- CodeGenQueued, // code gen has been queued and all the code gen data has been gathered.
- CodeGenRecorded, // backend completed, but job still pending
- CodeGenDone, // code gen job successfully completed
- JITCapReached, // workitem created but JIT cap reached
- PendingCleanup, // workitem needs to be cleaned up but couldn't for some reason- it'll be cleaned up at the next opportunity
- CleanedUp // the entry point has been cleaned up
- };
- #if ENABLE_NATIVE_CODEGEN
- class JitTransferData
- {
- friend EntryPointInfo;
- private:
- TypeRefSet* jitTimeTypeRefs;
- void** runtimeTypeRefs;
- int runtimeTypeRefCount;
- int propertyGuardCount;
- // This is a dynamically sized array of dynamically sized TypeGuardTransferEntries. It's heap allocated by the JIT
- // thread and lives until entry point is installed, at which point it is explicitly freed.
- TypeGuardTransferEntry* propertyGuardsByPropertyId;
- size_t propertyGuardsByPropertyIdPlusSize;
- // This is a dynamically sized array of dynamically sized CtorCacheGuardTransferEntry. It's heap allocated by the JIT
- // thread and lives until entry point is installed, at which point it is explicitly freed.
- CtorCacheGuardTransferEntry* ctorCacheGuardsByPropertyId;
- size_t ctorCacheGuardsByPropertyIdPlusSize;
- int equivalentTypeGuardCount;
- int lazyBailoutPropertyCount;
- // This is a dynamically sized array of JitEquivalentTypeGuards. It's heap allocated by the JIT thread and lives
- // until entry point is installed, at which point it is explicitly freed. We need it during installation so as to
- // swap the cache associated with each guard from the heap to the recycler (so the types in the cache are kept alive).
- JitEquivalentTypeGuard** equivalentTypeGuards;
- Js::PropertyId* lazyBailoutProperties;
- NativeCodeData* data;
- bool falseReferencePreventionBit;
- bool isReady;
- public:
- JitTransferData():
- jitTimeTypeRefs(nullptr), runtimeTypeRefCount(0), runtimeTypeRefs(nullptr),
- propertyGuardCount(0), propertyGuardsByPropertyId(nullptr), propertyGuardsByPropertyIdPlusSize(0),
- ctorCacheGuardsByPropertyId(nullptr), ctorCacheGuardsByPropertyIdPlusSize(0),
- equivalentTypeGuardCount(0), equivalentTypeGuards(nullptr), data(nullptr),
- falseReferencePreventionBit(true), isReady(false), lazyBailoutProperties(nullptr), lazyBailoutPropertyCount(0){}
- void AddJitTimeTypeRef(void* typeRef, Recycler* recycler);
- int GetRuntimeTypeRefCount() { return this->runtimeTypeRefCount; }
- void** GetRuntimeTypeRefs() { return this->runtimeTypeRefs; }
- void SetRuntimeTypeRefs(void** runtimeTypeRefs, int count) { this->runtimeTypeRefs = runtimeTypeRefs; this->runtimeTypeRefCount = count; }
- JitEquivalentTypeGuard** GetEquivalentTypeGuards() const { return this->equivalentTypeGuards; }
- void SetEquivalentTypeGuards(JitEquivalentTypeGuard** guards, int count)
- {
- this->equivalentTypeGuardCount = count;
- this->equivalentTypeGuards = guards;
- }
- void SetLazyBailoutProperties(Js::PropertyId* properties, int count)
- {
- this->lazyBailoutProperties = properties;
- this->lazyBailoutPropertyCount = count;
- }
- bool GetIsReady() { return this->isReady; }
- void SetIsReady() { this->isReady = true; }
- private:
- void EnsureJitTimeTypeRefs(Recycler* recycler);
- };
- NativeCodeData * data;
- CodeGenNumberChunk * numberChunks;
- SmallSpanSequence *nativeThrowSpanSequence;
- typedef JsUtil::BaseHashSet<RecyclerWeakReference<FunctionBody>*, Recycler, PowerOf2SizePolicy> WeakFuncRefSet;
- WeakFuncRefSet *weakFuncRefSet;
- // Need to keep strong references to the guards here so they don't get collected while the entry point is alive.
- typedef JsUtil::BaseDictionary<Js::PropertyId, PropertyGuard*, Recycler, PowerOf2SizePolicy> SharedPropertyGuardDictionary;
- SharedPropertyGuardDictionary* sharedPropertyGuards;
- typedef JsUtil::List<LazyBailOutRecord, HeapAllocator> BailOutRecordMap;
- BailOutRecordMap* bailoutRecordMap;
- // This array holds fake weak references to type property guards. We need it to zero out the weak references when the
- // entry point is finalized and the guards are about to be freed. Otherwise, if one of the guards was to be invalidated
- // from the thread context, we would AV trying to access freed memory. Note that the guards themselves are allocated by
- // NativeCodeData::Allocator and are kept alive by the data field. The weak references are recycler allocated, and so
- // the array must be recycler allocated also, so that the recycler doesn't collect the weak references.
- FakePropertyGuardWeakReference** propertyGuardWeakRefs;
- EquivalentTypeCache* equivalentTypeCaches;
- EntryPointInfo ** registeredEquivalentTypeCacheRef;
- int propertyGuardCount;
- int equivalentTypeCacheCount;
- #endif
- CodeGenWorkItem * workItem;
- void * nativeAddress;
- ptrdiff_t codeSize;
- bool isAsmJsFunction; // true if entrypoint is for asmjs function
- uintptr_t mModuleAddress; //asm Module address
- #ifdef FIELD_ACCESS_STATS
- FieldAccessStatsPtr fieldAccessStats;
- #endif
- protected:
- JavascriptLibrary* library;
- #if ENABLE_NATIVE_CODEGEN
- typedef JsUtil::List<NativeOffsetInlineeFramePair, HeapAllocator> InlineeFrameMap;
- InlineeFrameMap* inlineeFrameMap;
- #endif
- #ifdef ENABLE_DEBUG_CONFIG_OPTIONS
- StackBackTrace* cleanupStack;
- #endif
- public:
- enum CleanupReason
- {
- NotCleanedUp,
- CodeGenFailedOOM,
- CodeGenFailedStackOverflow,
- CodeGenFailedAborted,
- NativeCodeInstallFailure,
- CleanUpForFinalize
- };
- uint frameHeight;
- private:
- #if ENABLE_NATIVE_CODEGEN
- typedef SListCounted<ConstructorCache*, Recycler> ConstructorCacheList;
- ConstructorCacheList* constructorCaches;
- EntryPointPolymorphicInlineCacheInfo * polymorphicInlineCacheInfo;
- // This field holds any recycler allocated references that must be kept alive until
- // we install the entry point. It is freed at that point, so anything that must survive
- // until the EntryPointInfo itself goes away, must be copied somewhere else.
- JitTransferData* jitTransferData;
- // If we pin types this array contains strong references to types, otherwise it holds weak references.
- void **runtimeTypeRefs;
- uint32 pendingPolymorphicCacheState;
- #endif
- State state; // Single state member so users can query state w/o a lock
- #if ENABLE_DEBUG_CONFIG_OPTIONS
- CleanupReason cleanupReason;
- #endif
- BYTE pendingInlinerVersion;
- bool isLoopBody;
- bool hasJittedStackClosure;
- #if ENABLE_NATIVE_CODEGEN
- ImplicitCallFlags pendingImplicitCallFlags;
- #endif
- public:
- virtual void Finalize(bool isShutdown) override;
- virtual bool IsFunctionEntryPointInfo() const override { return true; }
- protected:
- EntryPointInfo(void* address, JavascriptLibrary* library, void* validationCookie, ThreadContext* context = nullptr, bool isLoopBody = false) :
- ProxyEntryPointInfo(address, context),
- #if ENABLE_NATIVE_CODEGEN
- nativeThrowSpanSequence(nullptr), workItem(nullptr), weakFuncRefSet(nullptr),
- jitTransferData(nullptr), sharedPropertyGuards(nullptr), propertyGuardCount(0), propertyGuardWeakRefs(nullptr),
- equivalentTypeCacheCount(0), equivalentTypeCaches(nullptr), constructorCaches(nullptr), state(NotScheduled), data(nullptr),
- numberChunks(nullptr), polymorphicInlineCacheInfo(nullptr), runtimeTypeRefs(nullptr),
- isLoopBody(isLoopBody), hasJittedStackClosure(false), registeredEquivalentTypeCacheRef(nullptr), bailoutRecordMap(nullptr),
- #endif
- library(library), codeSize(0), nativeAddress(nullptr), isAsmJsFunction(false), validationCookie(validationCookie)
- #ifdef ENABLE_DEBUG_CONFIG_OPTIONS
- , cleanupStack(nullptr)
- , cleanupReason(NotCleanedUp)
- #endif
- #if DBG_DUMP | defined(VTUNE_PROFILING)
- , nativeOffsetMaps(&HeapAllocator::Instance)
- #endif
- #ifdef FIELD_ACCESS_STATS
- , fieldAccessStats(nullptr)
- #endif
- {}
- virtual void ReleasePendingWorkItem() {};
- virtual void OnCleanup(bool isShutdown) = 0;
- #ifdef PERF_COUNTERS
- virtual void OnRecorded() = 0;
- #endif
- private:
- State GetState() const
- {
- Assert(this->state >= NotScheduled && this->state <= CleanedUp);
- return this->state;
- }
- public:
- ScriptContext* GetScriptContext();
- virtual FunctionBody *GetFunctionBody() const = 0;
- #if ENABLE_NATIVE_CODEGEN
- EntryPointPolymorphicInlineCacheInfo * EnsurePolymorphicInlineCacheInfo(Recycler * recycler, FunctionBody * functionBody);
- EntryPointPolymorphicInlineCacheInfo * GetPolymorphicInlineCacheInfo() { return polymorphicInlineCacheInfo; }
- JitTransferData* GetJitTransferData() { return this->jitTransferData; }
- JitTransferData* EnsureJitTransferData(Recycler* recycler);
- #ifdef FIELD_ACCESS_STATS
- FieldAccessStats* GetFieldAccessStats() { return this->fieldAccessStats; }
- FieldAccessStats* EnsureFieldAccessStats(Recycler* recycler);
- #endif
- void PinTypeRefs(ScriptContext* scriptContext);
- void InstallGuards(ScriptContext* scriptContext);
- #endif
- void Cleanup(bool isShutdown, bool captureCleanupStack);
- #ifdef ENABLE_DEBUG_CONFIG_OPTIONS
- void CaptureCleanupStackTrace();
- #endif
- bool IsNotScheduled() const
- {
- return this->GetState() == NotScheduled;
- }
- bool IsCodeGenPending() const
- {
- return this->GetState() == CodeGenPending;
- }
- bool IsNativeCode() const
- {
- #if ENABLE_NATIVE_CODEGEN
- return this->GetState() == CodeGenRecorded ||
- this->GetState() == CodeGenDone;
- #else
- return false;
- #endif
- }
- bool IsCodeGenDone() const
- {
- #if ENABLE_NATIVE_CODEGEN
- return this->GetState() == CodeGenDone;
- #else
- return false;
- #endif
- }
- bool IsCodeGenQueued() const
- {
- #if ENABLE_NATIVE_CODEGEN
- return this->GetState() == CodeGenQueued;
- #else
- return false;
- #endif
- }
- bool IsJITCapReached() const
- {
- #if ENABLE_NATIVE_CODEGEN
- return this->GetState() == JITCapReached;
- #else
- return false;
- #endif
- }
- bool IsCleanedUp() const
- {
- return this->GetState() == CleanedUp;
- }
- bool IsPendingCleanup() const
- {
- return this->GetState() == PendingCleanup;
- }
- void SetPendingCleanup()
- {
- this->state = PendingCleanup;
- }
- #if ENABLE_DEBUG_CONFIG_OPTIONS
- void SetCleanupReason(CleanupReason reason)
- {
- this->cleanupReason = reason;
- }
- #endif
- bool IsLoopBody() const
- {
- return this->isLoopBody;
- }
- #if ENABLE_NATIVE_CODEGEN
- bool HasJittedStackClosure() const
- {
- return this->hasJittedStackClosure;
- }
- void SetHasJittedStackClosure()
- {
- this->hasJittedStackClosure = true;
- }
- #endif
- #ifndef TEMP_DISABLE_ASMJS
- void SetModuleAddress(uintptr_t moduleAddress)
- {
- Assert(this->GetIsAsmJSFunction());
- Assert(moduleAddress);
- mModuleAddress = moduleAddress;
- }
- uintptr_t GetModuleAddress()const
- {
- Assert(this->GetIsAsmJSFunction());
- Assert(mModuleAddress); // module address should not be null
- return mModuleAddress;
- }
- #endif
- void Reset(bool resetStateToNotScheduled = true);
- #if ENABLE_NATIVE_CODEGEN
- void SetCodeGenPending(CodeGenWorkItem * workItem)
- {
- Assert(this->GetState() == NotScheduled || this->GetState() == CleanedUp);
- Assert(workItem != nullptr);
- this->workItem = workItem;
- this->state = CodeGenPending;
- }
- void SetCodeGenPending()
- {
- Assert(this->GetState() == CodeGenQueued);
- this->state = CodeGenPending;
- }
- void SetCodeGenQueued()
- {
- Assert(this->GetState() == CodeGenPending);
- this->state = CodeGenQueued;
- }
- void RevertToNotScheduled()
- {
- Assert(this->GetState() == CodeGenPending);
- Assert(this->workItem != nullptr);
- this->workItem = nullptr;
- this->state = NotScheduled;
- }
- void SetCodeGenPendingWithStackAllocatedWorkItem()
- {
- Assert(this->GetState() == NotScheduled || this->GetState() == CleanedUp);
- this->workItem = nullptr;
- this->state = CodeGenPending;
- }
- void SetCodeGenRecorded(void * nativeAddress, ptrdiff_t codeSize,
- NativeCodeData * data, NativeCodeData * transferData, CodeGenNumberChunk * numberChunks)
- {
- Assert(this->GetState() == CodeGenQueued);
- Assert(nativeAddress != nullptr);
- Assert(codeSize > 0);
- Assert(this->jitTransferData != nullptr || transferData == nullptr);
- this->nativeAddress = (void *)nativeAddress;
- this->codeSize = codeSize;
- this->data = data;
- if (transferData != nullptr)
- {
- this->jitTransferData->data = transferData;
- }
- this->numberChunks = numberChunks;
- this->state = CodeGenRecorded;
- #ifdef PERF_COUNTERS
- this->OnRecorded();
- #endif
- }
- void SetCodeGenDone()
- {
- Assert(this->GetState() == CodeGenRecorded);
- this->state = CodeGenDone;
- this->workItem = nullptr;
- }
- void SetJITCapReached()
- {
- Assert(this->GetState() == CodeGenQueued);
- this->state = JITCapReached;
- this->workItem = nullptr;
- }
- SmallSpanSequence* GetNativeThrowSpanSequence() const
- {
- Assert(this->GetState() != NotScheduled);
- Assert(this->GetState() != CleanedUp);
- return nativeThrowSpanSequence;
- }
- void SetNativeThrowSpanSequence(SmallSpanSequence* seq)
- {
- Assert(this->GetState() == CodeGenQueued);
- Assert(this->nativeThrowSpanSequence == nullptr);
- nativeThrowSpanSequence = seq;
- }
- bool IsInNativeAddressRange(DWORD_PTR codeAddress) {
- return (IsNativeCode() &&
- codeAddress >= GetNativeAddress() &&
- codeAddress < GetNativeAddress() + GetCodeSize());
- }
- #endif
- DWORD_PTR GetNativeAddress() const
- {
- // need the assert to skip for asmjsFunction as nativeAddress can be interpreter too for asmjs
- Assert(this->GetState() == CodeGenRecorded || this->GetState() == CodeGenDone || this->isAsmJsFunction);
- return (DWORD_PTR)this->nativeAddress;
- }
- ptrdiff_t GetCodeSize() const
- {
- Assert(this->GetState() == CodeGenRecorded || this->GetState() == CodeGenDone);
- return codeSize;
- }
- CodeGenWorkItem * GetWorkItem() const
- {
- State state = this->GetState();
- Assert(state != NotScheduled || this->workItem == nullptr);
- Assert(state == CleanedUp && this->workItem == nullptr ||
- state != CleanedUp);
- if (state == PendingCleanup)
- {
- return nullptr;
- }
- return this->workItem;
- }
- #ifndef TEMP_DISABLE_ASMJS
- // set code size, used by TJ to set the code size
- void SetCodeSize(ptrdiff_t size)
- {
- Assert(isAsmJsFunction);
- this->codeSize = size;
- }
- void SetNativeAddress(void* address)
- {
- Assert(isAsmJsFunction);
- this->nativeAddress = address;
- }
- void SetIsAsmJSFunction(bool value)
- {
- this->isAsmJsFunction = value;
- }
- #endif
- bool GetIsAsmJSFunction()const
- {
- return this->isAsmJsFunction;
- }
- #ifndef TEMP_DISABLE_ASMJS
- void SetTJCodeGenDone()
- {
- Assert(isAsmJsFunction);
- this->state = CodeGenDone;
- this->workItem = nullptr;
- }
- #endif
- #if ENABLE_NATIVE_CODEGEN
- void AddWeakFuncRef(RecyclerWeakReference<FunctionBody> *weakFuncRef, Recycler *recycler);
- WeakFuncRefSet *EnsureWeakFuncRefSet(Recycler *recycler);
- void EnsureIsReadyToCall();
- void ProcessJitTransferData();
- void ResetOnNativeCodeInstallFailure();
- virtual void OnNativeCodeInstallFailure() = 0;
- Js::PropertyGuard* RegisterSharedPropertyGuard(Js::PropertyId propertyId, ScriptContext* scriptContext);
- bool HasSharedPropertyGuards() { return this->sharedPropertyGuards != nullptr; }
- bool HasSharedPropertyGuard(Js::PropertyId propertyId);
- bool TryGetSharedPropertyGuard(Js::PropertyId propertyId, Js::PropertyGuard*& guard);
- void RecordTypeGuards(int propertyGuardCount, TypeGuardTransferEntry* typeGuardTransferRecord, size_t typeGuardTransferPlusSize);
- void RecordCtorCacheGuards(CtorCacheGuardTransferEntry* ctorCacheTransferRecord, size_t ctorCacheTransferPlusSize);
- void FreePropertyGuards();
- void FreeJitTransferData();
- void RegisterEquivalentTypeCaches();
- void UnregisterEquivalentTypeCaches();
- bool ClearEquivalentTypeCaches();
- void RegisterConstructorCache(Js::ConstructorCache* constructorCache, Recycler* recycler);
- uint GetConstructorCacheCount() const { return this->constructorCaches != nullptr ? this->constructorCaches->Count() : 0; }
- uint32 GetPendingPolymorphicCacheState() const { return this->pendingPolymorphicCacheState; }
- void SetPendingPolymorphicCacheState(uint32 state) { this->pendingPolymorphicCacheState = state; }
- BYTE GetPendingInlinerVersion() const { return this->pendingInlinerVersion; }
- void SetPendingInlinerVersion(BYTE version) { this->pendingInlinerVersion = version; }
- ImplicitCallFlags GetPendingImplicitCallFlags() const { return this->pendingImplicitCallFlags; }
- void SetPendingImplicitCallFlags(ImplicitCallFlags flags) { this->pendingImplicitCallFlags = flags; }
- virtual void Invalidate(bool prolongEntryPoint) { Assert(false); }
- void RecordBailOutMap(JsUtil::List<LazyBailOutRecord, ArenaAllocator>* bailoutMap);
- void RecordInlineeFrameMap(JsUtil::List<NativeOffsetInlineeFramePair, ArenaAllocator>* tempInlineeFrameMap);
- InlineeFrameRecord* FindInlineeFrame(void* returnAddress);
- bool HasInlinees() { return this->frameHeight > 0; }
- void DoLazyBailout(BYTE** addressOfeturnAddress, Js::FunctionBody* functionBody, const PropertyRecord* propertyRecord);
- #endif
- #if DBG_DUMP
- public:
- #else if defined(VTUNE_PROFILING)
- private:
- #endif
- #if DBG_DUMP | defined(VTUNE_PROFILING)
- // NativeOffsetMap is public for DBG_DUMP, private for VTUNE_PROFILING
- struct NativeOffsetMap
- {
- uint32 statementIndex;
- regex::Interval nativeOffsetSpan;
- };
- private:
- JsUtil::List<NativeOffsetMap, HeapAllocator> nativeOffsetMaps;
- public:
- void RecordNativeMap(uint32 offset, uint32 statementIndex);
- int GetNativeOffsetMapCount() const;
- #endif
- #if DBG_DUMP && ENABLE_NATIVE_CODEGEN
- void DumpNativeOffsetMaps();
- void DumpNativeThrowSpanSequence();
- NativeOffsetMap* GetNativeOffsetMap(int index)
- {
- Assert(index >= 0);
- Assert(index < GetNativeOffsetMapCount());
- return &nativeOffsetMaps.Item(index);
- }
- #endif
- #ifdef VTUNE_PROFILING
- public:
- uint PopulateLineInfo(void* pLineInfo, FunctionBody* body);
- #endif
- protected:
- void* validationCookie;
- };
- class FunctionEntryPointInfo : public EntryPointInfo
- {
- public:
- FunctionProxy * functionProxy;
- FunctionEntryPointInfo* nextEntryPoint;
- // The offset on the native stack, from which the locals are located (Populated at RegAlloc phase). Used for debug purpose.
- int32 localVarSlotsOffset;
- // The offset which stores that any of the locals are changed from the debugger.
- int32 localVarChangedOffset;
- uint entryPointIndex;
- uint8 callsCount;
- uint8 lastCallsCount;
- bool nativeEntryPointProcessed;
- private:
- ExecutionMode jitMode;
- FunctionEntryPointInfo* mOldFunctionEntryPointInfo; // strong ref to oldEntryPointInfo(Int or TJ) in asm to ensure we don't collect it before JIT is completed
- bool mIsTemplatizedJitMode; // true only if in TJ mode, used only for debugging
- public:
- static const uint8 GetDecrCallCountPerBailout()
- {
- return (100 / (uint8)CONFIG_FLAG(RejitRatioLimit)) + 1;
- }
- FunctionEntryPointInfo(FunctionProxy * functionInfo, void * address, ThreadContext* context, void* validationCookie);
- #ifndef TEMP_DISABLE_ASMJS
- //AsmJS Support
- void SetOldFunctionEntryPointInfo(FunctionEntryPointInfo* entrypointInfo);
- FunctionEntryPointInfo* GetOldFunctionEntryPointInfo()const;
- void SetIsTJMode(bool value);
- bool GetIsTJMode()const;
- //End AsmJS Support
- #endif
- virtual FunctionBody *GetFunctionBody() const override;
- #if ENABLE_NATIVE_CODEGEN
- ExecutionMode GetJitMode() const;
- void SetJitMode(const ExecutionMode jitMode);
- virtual void Invalidate(bool prolongEntryPoint) override;
- virtual void Expire() override;
- virtual void EnterExpirableCollectMode() override;
- virtual void OnNativeCodeInstallFailure() override;
- #endif
- virtual void OnCleanup(bool isShutdown) override;
- virtual void ReleasePendingWorkItem() override;
- #ifdef PERF_COUNTERS
- virtual void OnRecorded() override;
- #endif
- };
- class LoopEntryPointInfo : public EntryPointInfo
- {
- public:
- LoopHeader* loopHeader;
- LoopEntryPointInfo(LoopHeader* loopHeader, Js::JavascriptLibrary* library, void* validationCookie) :
- loopHeader(loopHeader), mIsTemplatizedJitMode(false),EntryPointInfo(nullptr, library, validationCookie, /*threadContext*/ nullptr, /*isLoopBody*/ true)
- #ifdef BGJIT_STATS
- ,used(false)
- #endif
- { }
- virtual FunctionBody *GetFunctionBody() const override;
- virtual void OnCleanup(bool isShutdown) override;
- #if ENABLE_NATIVE_CODEGEN
- virtual void OnNativeCodeInstallFailure() override;
- #endif
- #ifndef TEMP_DISABLE_ASMJS
- void SetIsTJMode(bool value)
- {
- Assert(this->GetIsAsmJSFunction());
- mIsTemplatizedJitMode = value;
- }
- bool GetIsTJMode()const
- {
- return mIsTemplatizedJitMode;
- };
- #endif
- #ifdef PERF_COUNTERS
- virtual void OnRecorded() override;
- #endif
- #ifdef BGJIT_STATS
- bool IsUsed() const
- {
- return this->used;
- }
- void MarkAsUsed()
- {
- this->used = true;
- }
- #endif
- private:
- #ifdef BGJIT_STATS
- bool used;
- #endif
- bool mIsTemplatizedJitMode;
- };
- typedef RecyclerWeakReference<FunctionEntryPointInfo> FunctionEntryPointWeakRef;
- typedef SynchronizableList<FunctionEntryPointWeakRef*, JsUtil::List<FunctionEntryPointWeakRef*>> FunctionEntryPointList;
- typedef SynchronizableList<LoopEntryPointInfo*, JsUtil::List<LoopEntryPointInfo*>> LoopEntryPointList;
- #pragma endregion
- struct LoopHeader
- {
- private:
- LoopEntryPointList* entryPoints;
- public:
- uint startOffset;
- uint endOffset;
- uint interpretCount;
- uint profiledLoopCounter;
- bool isNested;
- bool isInTry;
- FunctionBody * functionBody;
- #if DBG_DUMP
- uint nativeCount;
- #endif
- static const uint NoLoop = (uint)-1;
- static const uint GetOffsetOfProfiledLoopCounter() { return offsetof(LoopHeader, profiledLoopCounter); }
- static const uint GetOffsetOfInterpretCount() { return offsetof(LoopHeader, interpretCount); }
- bool Contains(Js::LoopHeader * loopHeader) const
- {
- return (this->startOffset <= loopHeader->startOffset && loopHeader->endOffset <= this->endOffset);
- }
- bool Contains(uint offset) const
- {
- return this->startOffset <= offset && offset < this->endOffset;
- }
- void * GetCurrentEntryPoint() const
- {
- LoopEntryPointInfo * entryPoint = GetCurrentEntryPointInfo();
- if (entryPoint != nullptr)
- {
- return this->entryPoints->Item(this->GetCurrentEntryPointIndex())->address;
- }
- return nullptr;
- }
- LoopEntryPointInfo * GetCurrentEntryPointInfo() const
- {
- Assert(this->entryPoints->Count() > 0);
- return this->entryPoints->Item(this->GetCurrentEntryPointIndex());
- }
- uint GetByteCodeCount()
- {
- return (endOffset - startOffset);
- }
- int GetCurrentEntryPointIndex() const
- {
- return this->entryPoints->Count() - 1;
- }
- LoopEntryPointInfo * GetEntryPointInfo(int index) const
- {
- return this->entryPoints->Item(index);
- }
- template <class Fn>
- void MapEntryPoints(Fn fn) const
- {
- if (this->entryPoints) // ETW rundown may call this before entryPoints initialization
- {
- this->entryPoints->Map([&](int index, LoopEntryPointInfo * entryPoint)
- {
- if (entryPoint != nullptr)
- {
- fn(index, entryPoint);
- }
- });
- }
- }
- template <class DebugSite, class Fn>
- HRESULT MapEntryPoints(DebugSite site, Fn fn) const // external debugging version
- {
- return Map(site, this->entryPoints, [&](int index, LoopEntryPointInfo * entryPoint)
- {
- if (entryPoint != nullptr)
- {
- fn(index, entryPoint);
- }
- });
- }
- void Init(FunctionBody * functionBody);
- #if ENABLE_NATIVE_CODEGEN
- int CreateEntryPoint();
- void ReleaseEntryPoints();
- #endif
- void ResetInterpreterCount()
- {
- this->interpretCount = 0;
- }
- void ResetProfiledLoopCounter()
- {
- this->profiledLoopCounter = 0;
- }
- };
- class FunctionProxy;
- #ifdef RECYCLER_WRITE_BARRIER
- CompileAssert(sizeof(WriteBarrierPtr<FunctionProxy>) == sizeof(FunctionProxy*));
- typedef WriteBarrierPtr<FunctionProxy>* FunctionProxyArray;
- typedef WriteBarrierPtr<FunctionProxy>* FunctionProxyPtrPtr;
- #else
- typedef FunctionProxy** FunctionProxyArray;
- typedef FunctionProxy** FunctionProxyPtrPtr;
- #endif
- //
- // FunctionProxy represents a user defined function
- // This could be either from a source file or the byte code cache
- // The function need not have been compiled yet- it could be parsed or compiled
- // at a later time
- //
- class FunctionProxy : public FunctionInfo
- {
- protected:
- FunctionProxy(JavascriptMethod entryPoint, Attributes attributes, int nestedCount, int derivedSize,
- LocalFunctionId functionId, ScriptContext* scriptContext, Utf8SourceInfo* utf8SourceInfo, uint functionNumber);
- DEFINE_VTABLE_CTOR_NO_REGISTER(FunctionProxy, FunctionInfo);
- public:
- enum SetDisplayNameFlags
- {
- SetDisplayNameFlagsNone = 0,
- SetDisplayNameFlagsDontCopy = 1,
- SetDisplayNameFlagsRecyclerAllocated = 2
- };
- typedef RecyclerWeakReference<DynamicType> FunctionTypeWeakRef;
- typedef JsUtil::List<FunctionTypeWeakRef*, Recycler, false, WeakRefFreeListedRemovePolicy> FunctionTypeWeakRefList;
- uint32 GetSourceContextId() const;
- wchar_t* GetDebugNumberSet(wchar(&bufferToWriteTo)[MAX_FUNCTION_BODY_DEBUG_STRING_SIZE]) const;
- bool GetIsTopLevel() { return m_isTopLevel; }
- void SetIsTopLevel(bool set) { m_isTopLevel = set; }
- bool GetIsAnonymousFunction() const { return this->GetDisplayName() == Js::Constants::AnonymousFunction; }
- uint GetNestedCount() const { return m_nestedCount; }
- void Copy(FunctionProxy* other);
- ParseableFunctionInfo* EnsureDeserialized();
- ScriptContext* GetScriptContext() const;
- Utf8SourceInfo* GetUtf8SourceInfo() const { return this->m_utf8SourceInfo; }
- void SetReferenceInParentFunction(FunctionProxyPtrPtr reference);
- void UpdateReferenceInParentFunction(FunctionProxy* newFunctionInfo);
- DWORD_PTR GetSecondaryHostSourceContext() const;
- DWORD_PTR GetHostSourceContext() const;
- SourceContextInfo * GetSourceContextInfo() const;
- SRCINFO const * GetHostSrcInfo() const;
- uint GetFunctionNumber() const { return m_functionNumber; }
- virtual void Finalize(bool isShutdown) override;
- void UpdateFunctionBodyImpl(FunctionBody* body);
- bool IsFunctionBody() const;
- ProxyEntryPointInfo* GetDefaultEntryPointInfo() const;
- ScriptFunctionType * GetDeferredPrototypeType() const;
- ScriptFunctionType * EnsureDeferredPrototypeType();
- JavascriptMethod GetDirectEntryPoint(ProxyEntryPointInfo* entryPoint) const;
- // Function object type list methods
- FunctionTypeWeakRefList* EnsureFunctionObjectTypeList();
- void RegisterFunctionObjectType(DynamicType* functionType);
- template <typename Fn>
- void MapFunctionObjectTypes(Fn func);
- static uint GetOffsetOfDeferredPrototypeType() { return offsetof(Js::FunctionProxy, deferredPrototypeType); }
- static Js::ScriptFunctionType * EnsureFunctionProxyDeferredPrototypeType(FunctionProxy * proxy)
- {
- return proxy->EnsureDeferredPrototypeType();
- }
- void SetIsPublicLibraryCode() { m_isPublicLibraryCode = true; }
- bool IsPublicLibraryCode() const { return m_isPublicLibraryCode; }
- #if DBG
- bool HasValidEntryPoint() const;
- bool HasValidProfileEntryPoint() const;
- bool HasValidNonProfileEntryPoint() const;
- #endif
- virtual void SetDisplayName(const wchar_t* displayName, uint displayNameLength, uint displayShortNameOffset, SetDisplayNameFlags flags = SetDisplayNameFlagsNone) = 0;
- virtual const wchar_t* GetDisplayName() const = 0;
- virtual uint GetDisplayNameLength() const = 0;
- virtual uint GetShortDisplayNameOffset() const = 0;
- static const wchar_t* WrapWithBrackets(const wchar_t* name, charcount_t sz, ScriptContext* scriptContext);
- // Used only in the library function stringify (toString, DiagGetValueString).
- // If we need more often to give the short name, we should create a member variable which points to the short name
- // this is also now being used for function.name.
- const wchar_t* GetShortDisplayName(charcount_t * shortNameLength);
- bool IsJitLoopBodyPhaseEnabled() const
- {
- // Consider: Allow JitLoopBody in generator functions for loops that do not yield.
- return !PHASE_OFF(JITLoopBodyPhase, this) && DoFullJit() && !this->IsGenerator();
- }
- bool IsJitLoopBodyPhaseForced() const
- {
- return
- IsJitLoopBodyPhaseEnabled() &&
- (
- PHASE_FORCE(JITLoopBodyPhase, this)
- #ifdef ENABLE_PREJIT
- || Configuration::Global.flags.Prejit
- #endif
- );
- }
- ULONG GetHostStartLine() const;
- ULONG GetHostStartColumn() const;
- bool DoFullJit() const
- {
- return !PHASE_OFF(FullJitPhase, this);
- }
- protected:
- // Static method(s)
- static void SetDisplayName(const wchar_t* srcName, WriteBarrierPtr<const wchar_t>* destName, uint displayNameLength, ScriptContext * scriptContext, SetDisplayNameFlags flags = SetDisplayNameFlagsNone);
- static bool SetDisplayName(const wchar_t* srcName, const wchar_t** destName, uint displayNameLength, ScriptContext * scriptContext, SetDisplayNameFlags flags = SetDisplayNameFlagsNone);
- static bool IsConstantFunctionName(const wchar_t* srcName);
- protected:
- NoWriteBarrierPtr<ScriptContext> m_scriptContext; // Memory context for this function body
- WriteBarrierPtr<Utf8SourceInfo> m_utf8SourceInfo;
- // WriteBarrier-TODO: Consider changing this to NoWriteBarrierPtr, and skip tagging- also, tagging is likely unnecessary since that pointer in question is likely not resolvable
- FunctionProxyPtrPtr m_referenceInParentFunction; // Reference to nested function reference to this function in the parent function body (tagged to not be actual reference)
- WriteBarrierPtr<ScriptFunctionType> deferredPrototypeType;
- // Script function types not including the deferred prototype type
- WriteBarrierPtr<FunctionTypeWeakRefList> m_functionObjectTypeList;
- WriteBarrierPtr<ProxyEntryPointInfo> m_defaultEntryPointInfo; // The default entry point info for the function proxy
- NoWriteBarrierField<uint> m_derivedSize;
- NoWriteBarrierField<uint> m_functionNumber; // Per thread global function number
- #define DEFINE_FUNCTION_PROXY_FIELDS 1
- #define CURRENT_ACCESS_MODIFIER protected:
- #include "SerializableFunctionFields.h"
- bool m_isTopLevel : 1; // Indicates that this function is top-level function, currently being used in script profiler and debugger
- bool m_isPublicLibraryCode: 1; // Indicates this function is public boundary library code that should be visible in JS stack
- void CleanupFunctionProxyCounters()
- {
- PERF_COUNTER_DEC(Code, TotalFunction);
- }
- ULONG ComputeAbsoluteLineNumber(ULONG relativeLineNumber) const;
- ULONG ComputeAbsoluteColumnNumber(ULONG relativeLineNumber, ULONG relativeColumnNumber) const;
- ULONG GetLineNumberInHostBuffer(ULONG relativeLineNumber) const;
- private:
- ScriptFunctionType * AllocDeferredPrototypeType();
- };
- // Represents a function from the byte code cache which will
- // be deserialized upon use
- class DeferDeserializeFunctionInfo: public FunctionProxy
- {
- friend struct ByteCodeSerializer;
- private:
- DeferDeserializeFunctionInfo(int nestedFunctionCount, LocalFunctionId functionId, ByteCodeCache* byteCodeCache, const byte* serializedFunction, Utf8SourceInfo* sourceInfo, ScriptContext* scriptContext, uint functionNumber, const wchar_t* displayName, uint displayNameLength, uint displayShortNameOffset, NativeModule *nativeModule, Attributes attributes);
- public:
- static DeferDeserializeFunctionInfo* New(ScriptContext* scriptContext, int nestedFunctionCount, LocalFunctionId functionId, ByteCodeCache* byteCodeCache, const byte* serializedFunction, Utf8SourceInfo* utf8SourceInfo, const wchar_t* displayName, uint displayNameLength, uint displayShortNameOffset, NativeModule *nativeModule, Attributes attributes);
- virtual void Finalize(bool isShutdown) override;
- FunctionBody* Deserialize();
- virtual const wchar_t* GetDisplayName() const override;
- void SetDisplayName(const wchar_t* displayName);
- virtual void SetDisplayName(const wchar_t* displayName, uint displayNameLength, uint displayShortNameOffset, SetDisplayNameFlags flags = SetDisplayNameFlagsNone) override;
- virtual uint GetDisplayNameLength() const { return m_displayNameLength; }
- virtual uint GetShortDisplayNameOffset() const { return m_displayShortNameOffset; }
- LPCWSTR GetSourceInfo(int& lineNumber, int& columnNumber) const;
- private:
- const byte* m_functionBytes;
- ByteCodeCache* m_cache;
- const wchar_t * m_displayName; // Optional name
- uint m_displayNameLength;
- uint m_displayShortNameOffset;
- NativeModule *m_nativeModule;
- };
- class ParseableFunctionInfo: public FunctionProxy
- {
- friend class ByteCodeBufferReader;
- protected:
- ParseableFunctionInfo(JavascriptMethod method, int nestedFunctionCount, int derivedSize, LocalFunctionId functionId, Utf8SourceInfo* sourceInfo, ScriptContext* scriptContext, uint functionNumber, const wchar_t* displayName, uint m_displayNameLength, uint displayShortNameOffset, Attributes attributes, Js::PropertyRecordList* propertyRecordList);
- public:
- static ParseableFunctionInfo* New(ScriptContext* scriptContext, int nestedFunctionCount, LocalFunctionId functionId, Utf8SourceInfo* utf8SourceInfo, const wchar_t* displayName, uint m_displayNameLength, uint displayShortNameOffset, Js::PropertyRecordList* propertyRecordList, Attributes attributes);
- DEFINE_VTABLE_CTOR_NO_REGISTER(ParseableFunctionInfo, FunctionProxy);
- FunctionBody* Parse(ScriptFunction ** functionRef = nullptr, bool isByteCodeDeserialization = false);
- #ifndef TEMP_DISABLE_ASMJS
- FunctionBody* ParseAsmJs(Parser * p, __out CompileScriptException * se, __out ParseNodePtr * ptree);
- #endif
- virtual uint GetDisplayNameLength() const { return m_displayNameLength; }
- virtual uint GetShortDisplayNameOffset() const { return m_displayShortNameOffset; }
- bool GetIsDeclaration() const { return m_isDeclaration; }
- void SetIsDeclaration(const bool is) { m_isDeclaration = is; }
- bool GetIsAccessor() const { return m_isAccessor; }
- void SetIsAccessor(const bool is) { m_isAccessor = is; }
- bool GetIsGlobalFunc() const { return m_isGlobalFunc; }
- void SetIsStaticNameFunction(const bool is) { m_isStaticNameFunction = is; }
- bool GetIsStaticNameFunction() const { return m_isStaticNameFunction; }
- void SetIsNamedFunctionExpression(const bool is) { m_isNamedFunctionExpression = is; }
- bool GetIsNamedFunctionExpression() const { return m_isNamedFunctionExpression; }
- void SetIsNameIdentifierRef (const bool is) { m_isNameIdentifierRef = is; }
- bool GetIsNameIdentifierRef () const { return m_isNameIdentifierRef ; }
- // Fake global ->
- // 1) new Function code's global code
- // 2) global code generated from the reparsing deferred parse function
- bool IsFakeGlobalFunc(ulong flags) const;
- void SetIsGlobalFunc(bool is) { m_isGlobalFunc = is; }
- bool GetIsStrictMode() const { return m_isStrictMode; }
- void SetIsStrictMode() { m_isStrictMode = true; }
- bool GetIsAsmjsMode() const { return m_isAsmjsMode; }
- void SetIsAsmjsMode(bool value)
- {
- m_isAsmjsMode = value;
- #if DBG
- if (value)
- {
- m_wasEverAsmjsMode = true;
- }
- #endif
- }
- bool GetHasImplicitArgIns() { return m_hasImplicitArgIns; }
- void SetHasImplicitArgIns(bool has) { m_hasImplicitArgIns = has; }
- ulong GetGrfscr() const;
- void SetGrfscr(ulong grfscr);
- ///----------------------------------------------------------------------------
- ///
- /// ParseableFunctionInfo::GetInParamsCount
- ///
- /// GetInParamsCount() returns the number of "in parameters" that have
- /// currently been declared for this function:
- /// - If this is "RegSlot_VariableCount", the function takes a variable number
- /// of parameters.
- ///
- /// Consider: Change to store type information about parameters- names, type,
- /// direction, etc.
- ///
- ///----------------------------------------------------------------------------
- ArgSlot GetInParamsCount() const { return m_inParamCount; }
- void SetInParamsCount(ArgSlot newInParamCount);
- ArgSlot GetReportedInParamsCount() const;
- void SetReportedInParamsCount(ArgSlot newReportedInParamCount);
- void ResetInParams();
- ScopeInfo* GetScopeInfo() const { return this->m_scopeInfo; }
- void SetScopeInfo(ScopeInfo* scopeInfo) { this->m_scopeInfo = scopeInfo; }
- PropertyId GetOrAddPropertyIdTracked(JsUtil::CharacterBuffer<WCHAR> const& propName);
- bool IsTrackedPropertyId(PropertyId pid);
- Js::PropertyRecordList* GetBoundPropertyRecords() { return this->m_boundPropertyRecords; }
- void SetBoundPropertyRecords(Js::PropertyRecordList* boundPropertyRecords)
- {
- Assert(this->m_boundPropertyRecords == nullptr);
- this->m_boundPropertyRecords = boundPropertyRecords;
- }
- void ClearBoundPropertyRecords()
- {
- this->m_boundPropertyRecords = nullptr;
- }
- ParseableFunctionInfo* Clone(ScriptContext *scriptContext, uint sourceIndex = Js::Constants::InvalidSourceIndex);
- ParseableFunctionInfo* CopyFunctionInfoInto(ScriptContext *scriptContext, Js::ParseableFunctionInfo* functionInfo, uint sourceIndex = Js::Constants::InvalidSourceIndex);
- void CloneSourceInfo(ScriptContext* scriptContext, const ParseableFunctionInfo& other, ScriptContext* othersScriptContext, uint sourceIndex);
- void SetInitialDefaultEntryPoint();
- void SetDeferredParsingEntryPoint();
- void SetEntryPoint(ProxyEntryPointInfo* entryPoint, Js::JavascriptMethod address) {
- entryPoint->address = address;
- }
- bool IsDynamicScript() const;
- uint LengthInBytes() const { return m_cbLength; }
- uint StartOffset() const;
- ULONG GetLineNumber() const;
- ULONG GetColumnNumber() const;
- template <class T>
- LPCWSTR GetSourceName(const T& sourceContextInfo) const;
- template <class T>
- static LPCWSTR GetSourceName(const T& sourceContextInfo, bool m_isEval, bool m_isDynamicFunction);
- LPCWSTR GetSourceName() const;
- ULONG GetRelativeLineNumber() const { return m_lineNumber; }
- ULONG GetRelativeColumnNumber() const { return m_columnNumber; }
- uint GetSourceIndex() const;
- LPCUTF8 GetSource(const wchar_t* reason = nullptr) const;
- charcount_t LengthInChars() const { return m_cchLength; }
- charcount_t StartInDocument() const;
- bool IsEval() const { return m_isEval; }
- bool IsDynamicFunction() const;
- bool GetDontInline() { return m_dontInline; }
- void SetDontInline(bool is) { m_dontInline = is; }
- LPCUTF8 GetStartOfDocument(const wchar_t* reason = nullptr) const;
- bool IsReparsed() const { return m_reparsed; }
- void SetReparsed(bool set) { m_reparsed = set; }
- bool IsByteCodeDebugMode() { return isByteCodeDebugMode; }
- void SetIsByteCodeDebugMode(bool set) { isByteCodeDebugMode = set; }
- bool GetExternalDisplaySourceName(BSTR* sourceName);
- void SetDoBackendArgumentsOptimization(bool set)
- {
- if (m_doBackendArgumentsOptimization)
- {
- m_doBackendArgumentsOptimization = set;
- }
- }
- bool GetDoBackendArgumentsOptimization()
- {
- return m_doBackendArgumentsOptimization;
- }
- bool IsFunctionParsed()
- {
- return !IsDeferredParseFunction() || m_hasBeenParsed;
- }
- void SetFunctionParsed(bool hasBeenParsed)
- {
- m_hasBeenParsed = hasBeenParsed;
- }
- void SetSourceInfo(uint sourceIndex, ParseNodePtr node, bool isEval, bool isDynamicFunction);
- void Copy(FunctionBody* other);
- const wchar_t* GetExternalDisplayName() const;
- //
- // Algorithm to retrieve a function body's external display name. Template supports both
- // local FunctionBody and ScriptDAC (debugging) scenarios.
- //
- template <class T>
- static const wchar_t* GetExternalDisplayName(const T* funcBody)
- {
- Assert(funcBody != nullptr);
- Assert(funcBody->GetDisplayName() != nullptr);
- return funcBody->GetDisplayName();
- }
- virtual const wchar_t* GetDisplayName() const override;
- void SetDisplayName(const wchar_t* displayName);
- virtual void SetDisplayName(const wchar_t* displayName, uint displayNameLength, uint displayShortNameOffset, SetDisplayNameFlags flags = SetDisplayNameFlagsNone) override;
- virtual void Finalize(bool isShutdown) override;
- Var GetCachedSourceString()
- {
- return cachedSourceString;
- }
- void SetCachedSourceString(Var sourceString)
- {
- Assert(this->cachedSourceString == nullptr);
- this->cachedSourceString = sourceString;
- }
- FunctionProxyArray GetNestedFuncArray();
- FunctionProxy* GetNestedFunc(uint index);
- FunctionProxyPtrPtr GetNestedFuncReference(uint index);
- ParseableFunctionInfo* GetNestedFunctionForExecution(uint index);
- void SetNestedFunc(FunctionProxy* nestedFunc, uint index, ulong flags);
- void ClearNestedFunctionParentFunctionReference();
- void SetCapturesThis() { attributes = (Attributes)(attributes | Attributes::CapturesThis); }
- bool GetCapturesThis() { return (attributes & Attributes::CapturesThis) != 0; }
- void BuildDeferredStubs(ParseNode *pnodeFnc);
- DeferredFunctionStub *GetDeferredStubs() const { return this->deferredStubs; }
- void SetDeferredStubs(DeferredFunctionStub *stub) { this->deferredStubs = stub; }
- void RegisterFuncToDiag(ScriptContext * scriptContext, wchar_t const * pszTitle);
- protected:
- static HRESULT MapDeferredReparseError(HRESULT& hrParse, const CompileScriptException& se);
- bool m_hasBeenParsed : 1; // Has function body been parsed- true for actual function bodies, false for deferparse
- bool m_isDeclaration : 1;
- bool m_isAccessor : 1; // Function is a property getter or setter
- bool m_isStaticNameFunction : 1;
- bool m_isNamedFunctionExpression : 1;
- bool m_isNameIdentifierRef : 1;
- bool m_isClassMember : 1;
- bool m_isStrictMode : 1;
- bool m_isAsmjsMode : 1;
- bool m_isAsmJsFunction : 1;
- bool m_isGlobalFunc : 1;
- bool m_doBackendArgumentsOptimization :1;
- bool m_isEval : 1; // Source code is in 'eval'
- bool m_isDynamicFunction : 1; // Source code is in 'Function'
- bool m_hasImplicitArgIns : 1;
- bool m_dontInline : 1; // Used by the JIT's inliner
- // Indicates if the function has been reparsed for debug attach/detach scenario.
- bool m_reparsed : 1;
- bool isByteCodeDebugMode : 1; // Whether last time generated bytecode was generated for debug mode.
- // This field is not required for deferred parsing but because our thunks can't handle offsets > 128 bytes
- // yet, leaving this here for now. We can look at optimizing the function info and function proxy structures some
- // more and also fix our thunks to handle 8 bit offsets
- NoWriteBarrierField<bool> m_utf8SourceHasBeenSet; // start of UTF8-encoded source
- NoWriteBarrierField<uint> m_sourceIndex; // index into the scriptContext's list of saved sources
- #if DYNAMIC_INTERPRETER_THUNK
- void* m_dynamicInterpreterThunk; // Unique 'thunk' for every interpreted function - used for ETW symbol decoding.
- #endif
- NoWriteBarrierField<uint> m_cbStartOffset; // pUtf8Source is this many bytes from the start of the scriptContext's source buffer.
- // This is generally the same as m_cchStartOffset unless the buffer has a BOM
- #define DEFINE_PARSEABLE_FUNCTION_INFO_FIELDS 1
- #define CURRENT_ACCESS_MODIFIER protected:
- #include "SerializableFunctionFields.h"
- ULONG m_lineNumber;
- ULONG m_columnNumber;
- WriteBarrierPtr<const wchar_t> m_displayName; // Optional name
- uint m_displayNameLength;
- uint m_displayShortNameOffset;
- WriteBarrierPtr<ScopeInfo> m_scopeInfo;
- WriteBarrierPtr<PropertyRecordList> m_boundPropertyRecords;
- WriteBarrierVar cachedSourceString;
- WriteBarrierPtr<DeferredFunctionStub> deferredStubs;
- public:
- #if DBG
- bool m_wasEverAsmjsMode; // has m_isAsmjsMode ever been true
- NoWriteBarrierField<Js::LocalFunctionId> deferredParseNextFunctionId;
- #endif
- #if DBG
- NoWriteBarrierField<UINT> scopeObjectSize; // If the scope is an activation object - its size
- #endif
- };
- //
- // Algorithm to retrieve a function body's source name (url). Template supports both
- // local FunctionBody and ScriptDAC (debugging) scenarios.
- //
- template <class T>
- LPCWSTR ParseableFunctionInfo::GetSourceName(const T& sourceContextInfo) const
- {
- return GetSourceName<T>(sourceContextInfo, this->m_isEval, this->m_isDynamicFunction);
- }
- template <class T>
- LPCWSTR ParseableFunctionInfo::GetSourceName(const T& sourceContextInfo, bool m_isEval, bool m_isDynamicFunction)
- {
- if (sourceContextInfo->IsDynamic())
- {
- if (m_isEval)
- {
- return Constants::EvalCode;
- }
- else if (m_isDynamicFunction)
- {
- return Constants::FunctionCode;
- }
- else
- {
- return Constants::UnknownScriptCode;
- }
- }
- else
- {
- return sourceContextInfo->url;
- }
- }
- class FunctionBody : public ParseableFunctionInfo
- {
- DEFINE_VTABLE_CTOR_NO_REGISTER(FunctionBody, ParseableFunctionInfo);
- friend class ByteCodeBufferBuilder;
- friend class ByteCodeBufferReader;
- public:
- // same as MachDouble, used in the Func.h
- static const uint DIAGLOCALSLOTSIZE = 8;
- struct StatementMap
- {
- StatementMap() : isSubexpression(false) {}
- static StatementMap * New(Recycler* recycler)
- {
- return RecyclerNew(recycler, StatementMap);
- }
- regex::Interval sourceSpan;
- regex::Interval byteCodeSpan;
- bool isSubexpression;
- };
- // The type of StatementAdjustmentRecord.
- // A bitmask that can be OR'ed of multiple values of the enum.
- enum StatementAdjustmentType : ushort
- {
- SAT_None = 0,
- // Specifies an adjustment for next statement when going from current to next.
- // Used for transitioning from current stmt to next during normal control-flow,
- // such as offset of Br after if-block when there is else block present,
- // when throw happens inside if and we ignore exceptions (next statement in the list
- // would be 'else' but we need to pass flow control to Br target rather than entering 'else').
- SAT_FromCurrentToNext = 0x01,
- // Specifies an adjustment for beginning of next statement.
- // If there is adjustment record, the statement following it starts at specified offset and not at offset specified in statementMap.
- // Used for set next statement from arbitrary location.
- SAT_NextStatementStart = 0x02,
- SAT_All = SAT_FromCurrentToNext | SAT_NextStatementStart
- };
- class StatementAdjustmentRecord
- {
- uint m_byteCodeOffset;
- StatementAdjustmentType m_adjustmentType;
- public:
- StatementAdjustmentRecord();
- StatementAdjustmentRecord(StatementAdjustmentType type, int byteCodeOffset);
- StatementAdjustmentRecord(const StatementAdjustmentRecord& other);
- uint GetByteCodeOffset();
- StatementAdjustmentType GetAdjustmentType();
- };
- // Offset and entry/exit of a block that must be processed in new interpreter frame rather than current.
- // Used for try and catch blocks.
- class CrossFrameEntryExitRecord
- {
- uint m_byteCodeOffset;
- // true means enter, false means exit.
- bool m_isEnterBlock;
- public:
- CrossFrameEntryExitRecord();
- CrossFrameEntryExitRecord(uint byteCodeOffset, bool isEnterBlock);
- CrossFrameEntryExitRecord(const CrossFrameEntryExitRecord& other);
- uint GetByteCodeOffset() const;
- bool GetIsEnterBlock();
- };
- typedef JsUtil::List<Js::FunctionBody::StatementMap*> StatementMapList;
- // Note: isLeaf = true template param below means that recycler should not be used to dispose the items.
- typedef JsUtil::List<StatementAdjustmentRecord, Recycler, /* isLeaf = */ true> StatementAdjustmentRecordList;
- typedef JsUtil::List<CrossFrameEntryExitRecord, Recycler, /* isLeaf = */ true> CrossFrameEntryExitRecordList;
- // Contains recorded at bytecode generation time information about statements and try-catch blocks.
- // Used by debugger.
- struct AuxStatementData
- {
- // Contains statement adjustment data:
- // For given bytecode, following statement needs an adjustment, see StatementAdjustmentType for details.
- StatementAdjustmentRecordList* m_statementAdjustmentRecords;
- // Contain data about entry/exit of blocks that cause processing in different interpreter stack frame, such as try or catch.
- CrossFrameEntryExitRecordList* m_crossFrameBlockEntryExisRecords;
- AuxStatementData();
- };
- class SourceInfo
- {
- friend class RemoteFunctionBody;
- friend class ByteCodeBufferReader;
- friend class ByteCodeBufferBuilder;
- public:
- SmallSpanSequence * pSpanSequence;
- RegSlot frameDisplayRegister; // this register slot cannot be 0 so we use that sentinel value to indicate invalid
- RegSlot objectRegister; // this register slot cannot be 0 so we use that sentinel value to indicate invalid
- WriteBarrierPtr<ScopeObjectChain> pScopeObjectChain;
- WriteBarrierPtr<ByteBlock> m_probeBackingBlock; // NULL if no Probes, otherwise a copy of the unmodified the byte-codeblock //Delay
- int32 m_probeCount; // The number of installed probes (such as breakpoints).
- // List of bytecode offset for the Branch bytecode.
- WriteBarrierPtr<AuxStatementData> m_auxStatementData;
- SourceInfo():
- frameDisplayRegister(0),
- objectRegister(0),
- pScopeObjectChain(nullptr),
- m_probeBackingBlock(nullptr),
- m_probeCount(0),
- m_auxStatementData(nullptr),
- pSpanSequence(nullptr)
- {
- }
- };
- private:
- WriteBarrierPtr<ByteBlock> auxBlock; // Optional auxiliary information
- WriteBarrierPtr<ByteBlock> auxContextBlock; // Optional auxiliary context specific information
- WriteBarrierPtr<ByteBlock> byteCodeBlock; // Function byte-code for script functions
- WriteBarrierPtr<FunctionEntryPointList> entryPoints;
- WriteBarrierPtr<Js::LoopHeader> loopHeaderArray;
- WriteBarrierPtr<Var> m_constTable;
- WriteBarrierPtr<FunctionCodeGenRuntimeData*> m_codeGenRuntimeData;
- WriteBarrierPtr<FunctionCodeGenRuntimeData*> m_codeGenGetSetRuntimeData;
- WriteBarrierPtr<void*> inlineCaches;
- InlineCachePointerArray<PolymorphicInlineCache> polymorphicInlineCaches; // Contains the latest polymorphic inline caches
- WriteBarrierPtr<PolymorphicInlineCache> polymorphicInlineCachesHead; // DList of all polymorphic inline caches that aren't finalized yet
- WriteBarrierPtr<PropertyId> cacheIdToPropertyIdMap;
- WriteBarrierPtr<PropertyId> referencedPropertyIdMap;
- WriteBarrierPtr<UnifiedRegex::RegexPattern*>literalRegexes;
- WriteBarrierPtr<AsmJsFunctionInfo> asmJsFunctionInfo;
- WriteBarrierPtr<AsmJsModuleInfo> asmJsModuleInfo;
- // For SourceInfo
- WriteBarrierPtr<PropertyId> propertyIdsForScopeSlotArray;
- // This is used for showing locals for the current frame.
- WriteBarrierPtr<PropertyIdOnRegSlotsContainer> propertyIdOnRegSlotsContainer;
- #if DBG
- #define InlineCacheTypeNone 0x00
- #define InlineCacheTypeInlineCache 0x01
- #define InlineCacheTypeIsInst 0x02
- WriteBarrierPtr<byte> m_inlineCacheTypes;
- #endif
- WriteBarrierPtr<StatementMapList> pStatementMaps;
- public:
- static DWORD GetConstTableOffset() { return offsetof(FunctionBody, m_constTable); }
- static DWORD GetAuxiliaryDataOffset() { return offsetof(FunctionBody, auxBlock); }
- static DWORD GetAuxiliaryContextDataOffset() { return offsetof(FunctionBody, auxContextBlock); }
- static DWORD GetObjLiteralTypesOffset() { return offsetof(FunctionBody, objLiteralTypes); }
- static DWORD GetInlineCachesOffset() { return offsetof(FunctionBody, inlineCaches); }
- static DWORD GetInlineCacheCountOffset() { return offsetof(FunctionBody, inlineCacheCount); }
- static DWORD GetLiteralRegexesOffset() { return offsetof(FunctionBody, literalRegexes); }
- static DWORD GetDerivedSizeOffset() { return offsetof(FunctionBody, m_derivedSize); }
- static DWORD GetReferencedPropertyIdMapOffset() { return offsetof(FunctionBody, referencedPropertyIdMap); }
- static DWORD GetCacheIdToPropertyIdMapOffset() { return offsetof(FunctionBody, cacheIdToPropertyIdMap); }
- static DWORD GetAsmJsTotalLoopCountOffset(){ return offsetof(FunctionBody, m_asmJsTotalLoopCount); }
- #if DBG
- int m_DEBUG_executionCount; // Count of outstanding on InterpreterStackFrame
- bool m_nativeEntryPointIsInterpreterThunk; // NativeEntry entry point is in fact InterpreterThunk.
- // Set by bgjit in OutOfMemory scenario during codegen.
- #endif
- #if ENABLE_DEBUG_CONFIG_OPTIONS
- NoWriteBarrierField<uint> regAllocStoreCount;
- NoWriteBarrierField<uint> regAllocLoadCount;
- NoWriteBarrierField<uint> callCountStats;
- #endif
- NoWriteBarrierField<uint> interpretedCount;
- NoWriteBarrierField<uint> loopInterpreterLimit;
- // >>>>>>WARNING! WARNING!<<<<<<<<<<
- //
- // If you add compile-time attributes to this set, be sure to add them to the attributes that are
- // copied in FunctionBody::Clone
- //
- SourceInfo m_sourceInfo; // position of the source
- // Data needed by profiler:
- NoWriteBarrierField<uint> m_uScriptId; // Delay //Script Block it belongs to. This is function no. of the global function created by engine for each block
- #if DBG
- NoWriteBarrierField<int> m_iProfileSession; // Script profile session the meta data of this function is reported to.
- #endif // DEBUG
- // R0 is reserved for the return value, R1 for the root object
- static const RegSlot ReturnValueRegSlot = 0;
- static const RegSlot RootObjectRegSlot = 1;
- static const RegSlot FirstRegSlot = 1;
- // This value be set on the stack (on a particular offset), when the frame value got changed.
- static const int LocalsChangeDirtyValue = 1;
- enum FunctionBodyFlags : byte
- {
- Flags_None = 0x00,
- Flags_StackNestedFunc = 0x01,
- Flags_HasOrParentHasArguments = 0x02,
- Flags_HasTry = 0x04,
- Flags_HasThis = 0x08,
- Flags_NonUserCode = 0x10,
- Flags_HasOnlyThisStatements = 0x20,
- Flags_HasNoExplicitReturnValue = 0x40, // Returns undefined, i.e. has no return statements or return with no expression
- Flags_HasRestParameter = 0x80
- };
- #define DEFINE_FUNCTION_BODY_FIELDS 1
- #define CURRENT_ACCESS_MODIFIER public:
- #include "SerializableFunctionFields.h"
- private:
- bool m_tag : 1; // Used to tag the low bit to prevent possible GC false references
- bool m_nativeEntryPointUsed : 1; // Code might have been generated but not yet used.
- bool hasDoneLoopBodyCodeGen : 1; // Code generated for loop body, but not necessary available to execute yet.
- bool m_isFuncRegistered : 1;
- bool m_isFuncRegisteredToDiag : 1; // Mentions the function's context is registered with diagprobe.
- bool funcEscapes : 1;
- bool m_hasBailoutInstrInJittedCode : 1; // Indicates whether function has bailout instructions. Valid only if hasDoneCodeGen is true
- bool m_pendingLoopHeaderRelease : 1; // Indicates whether loop headers need to be released
- bool hasExecutionDynamicProfileInfo : 1;
- bool cleanedUp: 1;
- bool sourceInfoCleanedUp: 1;
- bool dontRethunkAfterBailout : 1;
- bool disableInlineApply : 1;
- bool disableInlineSpread : 1;
- bool hasHotLoop: 1;
- bool wasCalledFromLoop : 1;
- bool hasNestedLoop : 1;
- bool recentlyBailedOutOfJittedLoopBody : 1;
- bool m_firstFunctionObject: 1;
- bool m_inlineCachesOnFunctionObject: 1;
- // Used for the debug re-parse. Saves state of function on the first parse, and restores it on a reparse. The state below is either dependent on
- // the state of the script context, or on other factors like whether it was defer parsed or not.
- bool m_hasSetIsObject : 1;
- // Used for the debug purpose, this info will be stored (in the non-debug mode), when a function has all locals marked as non-local-referenced.
- // So when we got to no-refresh debug mode, and try to re-use the same function body we can then enforce all locals to be non-local-referenced.
- bool m_hasAllNonLocalReferenced : 1;
- bool m_hasFunExprNameReference : 1;
- bool m_ChildCallsEval : 1;
- bool m_CallsEval : 1;
- bool m_hasReferenceableBuiltInArguments : 1;
- // Used in the debug purpose. This is to avoid setting all locals to non-local-referenced, multiple times for each child function.
- bool m_hasDoneAllNonLocalReferenced : 1;
- // Used by the script profiler, once the function compiled is sent this will be set to true.
- bool m_hasFunctionCompiledSent : 1;
- bool m_isFromNativeCodeModule : 1;
- bool m_isPartialDeserializedFunction : 1;
- bool m_isAsmJsScheduledForFullJIT : 1;
- #ifdef PERF_COUNTERS
- bool m_isDeserializedFunction : 1;
- #endif
- #if DBG
- // Indicates that nested functions can be allocated on the stack (but may not be)
- bool m_canDoStackNestedFunc : 1;
- #endif
- #if DBG
- bool initializedExecutionModeAndLimits : 1;
- #endif
- #ifdef IR_VIEWER
- // whether IR Dump is enabled for this function (used by parseIR)
- bool m_isIRDumpEnabled : 1;
- WriteBarrierPtr<Js::DynamicObject> m_irDumpBaseObject;
- #endif /* IR_VIEWER */
- NoWriteBarrierField<uint8> bailOnMisingProfileCount;
- NoWriteBarrierField<uint8> bailOnMisingProfileRejitCount;
- NoWriteBarrierField<byte> inlineDepth; // Used by inlining to avoid recursively inlining functions excessively
- NoWriteBarrierField<ExecutionMode> executionMode;
- NoWriteBarrierField<uint16> interpreterLimit;
- NoWriteBarrierField<uint16> autoProfilingInterpreter0Limit;
- NoWriteBarrierField<uint16> profilingInterpreter0Limit;
- NoWriteBarrierField<uint16> autoProfilingInterpreter1Limit;
- NoWriteBarrierField<uint16> simpleJitLimit;
- NoWriteBarrierField<uint16> profilingInterpreter1Limit;
- NoWriteBarrierField<uint16> fullJitThreshold;
- NoWriteBarrierField<uint16> fullJitRequeueThreshold;
- NoWriteBarrierField<uint16> committedProfiledIterations;
- NoWriteBarrierField<uint> m_depth; // Indicates how many times the function has been entered (so increases by one on each recursive call, decreases by one when we're done)
- WriteBarrierPtr<RecyclerWeakReference<FunctionBody>> stackNestedFuncParent;
- // >>>>>>WARNING! WARNING!<<<<<<<<<<
- //
- // If you add compile-time attributes to the above set, be sure to add them to the attributes that are
- // copied in FunctionBody::Clone
- //
- NoWriteBarrierPtr<Js::ByteCodeCache> byteCodeCache; // Not GC allocated so naked pointer
- NoWriteBarrierField<int> serializationIndex;
- #ifdef ENABLE_DEBUG_CONFIG_OPTIONS
- static bool shareInlineCaches;
- #endif
- WriteBarrierPtr<DynamicType*> objLiteralTypes;
- WriteBarrierPtr<FunctionEntryPointInfo> defaultFunctionEntryPointInfo;
- WriteBarrierPtr<FunctionEntryPointInfo> simpleJitEntryPointInfo;
- #if ENABLE_PROFILE_INFO
- WriteBarrierPtr<DynamicProfileInfo> dynamicProfileInfo;
- WriteBarrierPtr<PolymorphicCallSiteInfo> polymorphicCallSiteInfoHead;
- #endif
- FunctionBailOutRecord * functionBailOutRecord;
- // select dynamic profile info saved off when we codegen and later
- // used for rejit decisions (see bailout.cpp)
- NoWriteBarrierField<BYTE> savedInlinerVersion;
- #if ENABLE_NATIVE_CODEGEN
- NoWriteBarrierField<ImplicitCallFlags> savedImplicitCallsFlags;
- #endif
- // State of inline caches (polymorphic vs. monomorphic) reflected in
- // last jitted version of this func.
- NoWriteBarrierField<uint32> savedPolymorphicCacheState;
- // Used to track where we are when adding debugger scopes to the scope chain
- // in order to avoid re-adding existing entries.
- NoWriteBarrierField<int> debuggerScopeIndex;
- FunctionBody(ScriptContext* scriptContext, const wchar_t* displayName, uint displayNameLength, uint displayShortNameOffset, uint nestedCount, Utf8SourceInfo* sourceInfo,
- uint uFunctionNumber, uint uScriptId, Js::LocalFunctionId functionId, Js::PropertyRecordList* propRecordList, Attributes attributes
- #ifdef PERF_COUNTERS
- , bool isDeserializedFunction = false
- #endif
- );
- void SetNativeEntryPoint(FunctionEntryPointInfo* entryPointInfo, JavascriptMethod originalEntryPoint, Var directEntryPoint);
- #if DYNAMIC_INTERPRETER_THUNK
- void GenerateDynamicInterpreterThunk();
- #endif
- void CloneByteCodeInto(ScriptContext * scriptContext, FunctionBody *newFunctionBody, uint sourceIndex);
- void * GetEntryPoint(ProxyEntryPointInfo* entryPoint) const { return entryPoint->address; }
- void CaptureDynamicProfileState(FunctionEntryPointInfo* entryPointInfo);
- #if ENABLE_DEBUG_CONFIG_OPTIONS
- void DumpRegStats(FunctionBody *funcBody);
- #endif
- // Gets the next index for tracking debugger scopes (increments the internal counter as well).
- int GetNextDebuggerScopeIndex();
- public:
- FunctionBody(ByteCodeCache* cache, Utf8SourceInfo* sourceInfo, ScriptContext* scriptContext):
- ParseableFunctionInfo((JavascriptMethod) nullptr, 0, 0, (LocalFunctionId) 0, sourceInfo, scriptContext, 0, nullptr, 0, 0, None, nullptr)
- {
- // Dummy constructor- does nothing
- // Must be stack allocated
- // Used during deferred bytecode serialization
- }
- static FunctionBody * NewFromRecycler(Js::ScriptContext * scriptContext, const wchar_t * displayName, uint displayNameLength, uint displayShortNameOffset, uint nestedCount,
- Utf8SourceInfo* sourceInfo, uint uScriptId, Js::LocalFunctionId functionId, Js::PropertyRecordList* boundPropertyRecords, Attributes attributes
- #ifdef PERF_COUNTERS
- , bool isDeserializedFunction
- #endif
- );
- static FunctionBody * NewFromRecycler(Js::ScriptContext * scriptContext, const wchar_t * displayName, uint displayNameLength, uint displayShortNameOffset, uint nestedCount,
- Utf8SourceInfo* sourceInfo, uint uFunctionNumber, uint uScriptId, Js::LocalFunctionId functionId, Js::PropertyRecordList* boundPropertyRecords, Attributes attributes
- #ifdef PERF_COUNTERS
- , bool isDeserializedFunction
- #endif
- );
- FunctionEntryPointInfo * GetEntryPointInfo(int index) const;
- FunctionEntryPointInfo * TryGetEntryPointInfo(int index) const;
- Js::RootObjectBase * LoadRootObject() const;
- Js::RootObjectBase * GetRootObject() const;
- ByteBlock* GetAuxiliaryData();
- ByteBlock* GetAuxiliaryContextData();
- ByteBlock* GetByteCode();
- ByteBlock* GetOriginalByteCode(); // Returns original bytecode without probes (such as BPs).
- const Js::ByteCodeCache * GetByteCodeCache() const;
- void SetSerializationIndex(int index) { Assert(serializationIndex == -1 && index != -1); serializationIndex = index; }
- const int GetSerializationIndex() const;
- uint GetByteCodeCount() const { return m_byteCodeCount; }
- uint GetByteCodeWithoutLDACount() const { return m_byteCodeWithoutLDACount; }
- uint GetByteCodeInLoopCount() const { return m_byteCodeInLoopCount; }
- uint16 GetEnvDepth() const { return m_envDepth; }
- void SetEnvDepth(uint16 depth) { m_envDepth = depth; }
- RegSlot GetEnvReg() const { return envRegister; }
- void SetEnvReg(RegSlot reg) { Assert(envRegister == Constants::NoRegister); envRegister = this->MapRegSlot(reg); }
- RegSlot GetThisRegForEventHandler() const { return thisRegisterForEventHandler; }
- void SetThisRegForEventHandler(RegSlot reg) { Assert(thisRegisterForEventHandler == Constants::NoRegister); thisRegisterForEventHandler = this->MapRegSlot(reg); }
- bool HasScopeObject() const { return hasScopeObject; }
- void SetHasScopeObject(bool has) { hasScopeObject = has; }
- void SetLocalClosureReg(RegSlot reg) { Assert(localClosureRegister == Constants::NoRegister); localClosureRegister = this->MapRegSlot(reg); }
- RegSlot GetLocalClosureReg() const { return localClosureRegister; }
- void SetLocalFrameDisplayReg(RegSlot reg) { Assert(localFrameDisplayRegister == Constants::NoRegister); localFrameDisplayRegister = this->MapRegSlot(reg); }
- RegSlot GetLocalFrameDisplayReg() const { return localFrameDisplayRegister; /*localClosureRegister == Constants::NoRegister ? Constants::NoRegister : localClosureRegister + 1;*/ }
- RegSlot FirstInnerScopeReg() const { Assert(firstInnerScopeRegister != Constants::NoRegister); return firstInnerScopeRegister; }
- void SetFirstInnerScopeReg(RegSlot reg) { Assert(reg != Constants::NoRegister); firstInnerScopeRegister = this->MapRegSlot(reg); }
- RegSlot GetFuncExprScopeReg() const { return funcExprScopeRegister; }
- void SetFuncExprScopeReg(RegSlot reg) { Assert(reg != Constants::NoRegister); funcExprScopeRegister = this->MapRegSlot(reg); }
- uint GetInnerScopeCount() const { return innerScopeCount; }
- void SetInnerScopeCount(uint count) { innerScopeCount = count; }
- bool HasCachedScopePropIds() const { return hasCachedScopePropIds; }
- void SetHasCachedScopePropIds(bool has) { hasCachedScopePropIds = has; }
- size_t GetLoopBodyName(uint loopNumber, _Out_writes_opt_z_(sizeInChars) WCHAR* displayName, _In_ size_t sizeInChars);
- void AllocateLoopHeaders();
- void ReleaseLoopHeaders();
- Js::LoopHeader * GetLoopHeader(uint index) const;
- Js::Var GetLoopHeaderArrayPtr() const
- {
- Assert(this->loopHeaderArray != nullptr);
- return this->loopHeaderArray;
- }
- #ifndef TEMP_DISABLE_ASMJS
- void SetIsAsmJsFullJitScheduled(bool val){ m_isAsmJsScheduledForFullJIT = val; }
- bool GetIsAsmJsFullJitScheduled(){ return m_isAsmJsScheduledForFullJIT; }
- uint32 GetAsmJSTotalLoopCount() const
- {
- return m_asmJsTotalLoopCount;
- }
- void SetIsAsmJsFunction(bool isAsmJsFunction)
- {
- m_isAsmJsFunction = isAsmJsFunction;
- }
- #endif
- const bool GetIsAsmJsFunction() const
- {
- return m_isAsmJsFunction;
- }
- #ifndef TEMP_DISABLE_ASMJS
- bool IsHotAsmJsLoop()
- {
- // Negative MinTemplatizedJitLoopRunCount treats all loops as hot asm loop
- if (CONFIG_FLAG(MinTemplatizedJitLoopRunCount) < 0 || m_asmJsTotalLoopCount > static_cast<uint>(CONFIG_FLAG(MinTemplatizedJitLoopRunCount)))
- {
- return true;
- }
- return false;
- }
- #endif
- private:
- void ResetLoops();
- public:
- static bool Is(void* ptr);
- uint GetScriptId() const { return m_uScriptId; }
- void* GetAddressOfScriptId() const
- {
- return (void*)&m_uScriptId;
- }
- uint8 *GetCallsCountAddress(EntryPointInfo* info) const
- {
- FunctionEntryPointInfo* entryPoint = (FunctionEntryPointInfo*) info;
- return &entryPoint->callsCount;
- }
- FunctionEntryPointInfo* GetDefaultFunctionEntryPointInfo() const;
- void SetDefaultFunctionEntryPointInfo(FunctionEntryPointInfo* entryPointInfo, const JavascriptMethod originalEntryPoint);
- FunctionEntryPointInfo *GetSimpleJitEntryPointInfo() const;
- void SetSimpleJitEntryPointInfo(FunctionEntryPointInfo *const entryPointInfo);
- private:
- void VerifyExecutionMode(const ExecutionMode executionMode) const;
- public:
- ExecutionMode GetDefaultInterpreterExecutionMode() const;
- ExecutionMode GetExecutionMode() const;
- ExecutionMode GetInterpreterExecutionMode(const bool isPostBailout);
- void SetExecutionMode(const ExecutionMode executionMode);
- private:
- bool IsInterpreterExecutionMode() const;
- public:
- bool TryTransitionToNextExecutionMode();
- void TryTransitionToNextInterpreterExecutionMode();
- void SetIsSpeculativeJitCandidate();
- bool TryTransitionToJitExecutionMode();
- void TransitionToSimpleJitExecutionMode();
- void TransitionToFullJitExecutionMode();
- private:
- void VerifyExecutionModeLimits();
- void InitializeExecutionModeAndLimits();
- public:
- void ReinitializeExecutionModeAndLimits();
- private:
- void SetFullJitThreshold(const uint16 newFullJitThreshold, const bool skipSimpleJit = false);
- void CommitExecutedIterations();
- void CommitExecutedIterations(uint16 &limit, const uint executedIterations);
- private:
- uint16 GetSimpleJitExecutedIterations() const;
- public:
- void ResetSimpleJitLimitAndCallCount();
- private:
- void SetSimpleJitCallCount(const uint16 simpleJitLimit) const;
- void ResetSimpleJitCallCount();
- public:
- uint16 GetProfiledIterations() const;
- public:
- void OnFullJitDequeued(const FunctionEntryPointInfo *const entryPointInfo);
- public:
- void TraceExecutionMode(const char *const eventDescription = nullptr) const;
- void TraceInterpreterExecutionMode() const;
- private:
- void DoTraceExecutionMode(const char *const eventDescription) const;
- public:
- static bool IsNewSimpleJit();
- bool DoSimpleJit() const;
- bool DoSimpleJitDynamicProfile() const;
- private:
- bool DoInterpreterProfile() const;
- bool DoInterpreterAutoProfile() const;
- public:
- bool WasCalledFromLoop() const;
- void SetWasCalledFromLoop();
- public:
- bool RecentlyBailedOutOfJittedLoopBody() const;
- void SetRecentlyBailedOutOfJittedLoopBody(const bool value);
- private:
- static uint16 GetMinProfileIterations();
- public:
- static uint16 GetMinFunctionProfileIterations();
- private:
- static uint GetMinLoopProfileIterations(const uint loopInterpreterLimit);
- public:
- uint GetLoopProfileThreshold(const uint loopInterpreterLimit) const;
- private:
- static uint GetReducedLoopInterpretCount();
- public:
- uint GetLoopInterpretCount(LoopHeader* loopHeader) const;
- private:
- static bool DoObjectHeaderInlining();
- static bool DoObjectHeaderInliningForConstructors();
- public:
- static bool DoObjectHeaderInliningForConstructor(const uint32 inlineSlotCapacity);
- private:
- static bool DoObjectHeaderInliningForObjectLiterals();
- public:
- static bool DoObjectHeaderInliningForObjectLiteral(const uint32 inlineSlotCapacity);
- static bool DoObjectHeaderInliningForObjectLiteral(const PropertyIdArray *const propIds, ScriptContext *const scriptContext);
- static bool DoObjectHeaderInliningForEmptyObjects();
- public:
- #if DBG
- int GetProfileSession() { return m_iProfileSession; }
- #endif
- virtual void Finalize(bool isShutdown) override;
- void Cleanup(bool isScriptContextClosing);
- void CleanupSourceInfo(bool isScriptContextClosing);
- template<bool IsScriptContextShutdown>
- void CleanUpInlineCaches();
- void CleanupRecyclerData(bool isRecyclerShutdown, bool doEntryPointCleanupCaptureStack);
- #ifdef PERF_COUNTERS
- void CleanupPerfCounter();
- #endif
- virtual void Dispose(bool isShutdown) override { }
- bool HasRejit() const
- {
- if(this->entryPoints)
- {
- return this->entryPoints->Count() > 1;
- }
- return false;
- }
- #pragma region SourceInfo Methods
- void CopySourceInfo(ParseableFunctionInfo* originalFunctionInfo);
- void FinishSourceInfo();
- RegSlot GetFrameDisplayRegister() const;
- void SetFrameDisplayRegister(RegSlot frameDisplayRegister);
- RegSlot GetObjectRegister() const;
- void SetObjectRegister(RegSlot objectRegister);
- bool HasObjectRegister() const { return GetObjectRegister() != 0; }
- ScopeObjectChain *GetScopeObjectChain() const;
- void SetScopeObjectChain(ScopeObjectChain *pScopeObjectChain);
- // fetch the Catch scope object which encloses the passed bytecode offset, returns NULL otherwise
- Js::DebuggerScope * GetDiagCatchScopeObjectAt(int byteCodeOffset);
- ByteBlock *GetProbeBackingBlock();
- void SetProbeBackingBlock(ByteBlock* probeBackingBlock);
- bool HasLineBreak() const;
- bool HasLineBreak(charcount_t start, charcount_t end) const;
- bool HasGeneratedFromByteCodeCache() const { return this->byteCodeCache != nullptr; }
- bool EndsAfter(size_t offset) const;
- void TrackLoad(int ichMin);
- SmallSpanSequence* GetStatementMapSpanSequence() const { return m_sourceInfo.pSpanSequence; }
- void RecordStatementMap(StatementMap* statementMap);
- void RecordStatementMap(SmallSpanSequenceIter &iter, StatementData * data);
- void RecordLoad(int ichMin, int bytecodeAfterLoad);
- DebuggerScope* RecordStartScopeObject(DiagExtraScopesType scopeType, int start, RegSlot scopeLocation, int* index = nullptr);
- void RecordEndScopeObject(DebuggerScope* currentScope, int end);
- DebuggerScope* AddScopeObject(DiagExtraScopesType scopeType, int start, RegSlot scopeLocation);
- bool TryGetDebuggerScopeAt(int index, DebuggerScope*& debuggerScope);
- StatementMapList * GetStatementMaps() const;
- static StatementMap * GetNextNonSubexpressionStatementMap(StatementMapList *statementMapList, int & startingAtIndex);
- static StatementMap * GetPrevNonSubexpressionStatementMap(StatementMapList *statementMapList, int & startingAtIndex);
- void RecordStatementAdjustment(uint offset, StatementAdjustmentType adjType);
- void RecordCrossFrameEntryExitRecord(uint byteCodeOffset, bool isEnterBlock);
- // Find out an offset falls within the range. returns TRUE if found.
- BOOL GetBranchOffsetWithin(uint start, uint end, StatementAdjustmentRecord* record);
- bool GetLineCharOffset(int byteCodeOffset, ULONG* line, LONG* charOffset, bool canAllocateLineCache = true);
- bool GetLineCharOffsetFromStartChar(int startCharOfStatement, ULONG* _line, LONG* _charOffset, bool canAllocateLineCache = true);
- // Given bytecode position, returns the start position of the statement and length of the statement.
- bool GetStatementIndexAndLengthAt(int byteCodeOffset, UINT32* statementIndex, UINT32* statementLength);
- // skip any utf-8/utf-16 byte-order-mark. Returns the number of chars skipped.
- static charcount_t SkipByteOrderMark(__in_bcount_z(4) LPCUTF8& documentStart)
- {
- charcount_t retValue = 0;
- Assert(documentStart != nullptr);
- if (documentStart[0] == 0xEF &&
- documentStart[1] == 0xBB &&
- documentStart[2] == 0xBF)
- {
- // UTF-8 - EF BB BF
- // 3 bytes skipped - reports one char skipped
- documentStart += 3;
- retValue = 1;
- }
- else if ((documentStart[0] == 0xFF && documentStart[1] == 0xFE) ||
- (documentStart[0] == 0xFE && documentStart[1] == 0xFF))
- {
- // UTF-16 LE - FF FE
- // UTF-16 BE - FE FF
- // 2 bytes skipped - reports one char skipped
- documentStart += 2;
- retValue = 1;
- }
- return retValue;
- }
- StatementMap* GetMatchingStatementMapFromByteCode(int byteCodeOffset, bool ignoreSubexpressions = false);
- int GetEnclosingStatementIndexFromByteCode(int byteCodeOffset, bool ignoreSubexpressions = false);
- StatementMap* GetEnclosingStatementMapFromByteCode(int byteCodeOffset, bool ignoreSubexpressions = false);
- StatementMap* GetMatchingStatementMapFromSource(int byteCodeOffset, int* pMapIndex = nullptr);
- void RecordFrameDisplayRegister(RegSlot slot);
- void RecordObjectRegister(RegSlot slot);
- CrossFrameEntryExitRecordList* GetCrossFrameEntryExitRecords();
- #ifdef VTUNE_PROFILING
- uint GetStartOffset(uint statementIndex) const;
- ULONG GetSourceLineNumber(uint statementIndex);
- #endif
- #pragma endregion
- // Field accessors
- bool GetHasBailoutInstrInJittedCode() const { return this->m_hasBailoutInstrInJittedCode; }
- void SetHasBailoutInstrInJittedCode(bool hasBailout) { this->m_hasBailoutInstrInJittedCode = hasBailout; }
- bool GetCanReleaseLoopHeaders() const { return (this->m_depth == 0); }
- void SetPendingLoopHeaderRelease(bool pendingLoopHeaderRelease) { this->m_pendingLoopHeaderRelease = pendingLoopHeaderRelease; }
- bool GetIsFromNativeCodeModule() const { return m_isFromNativeCodeModule; }
- void SetIsFromNativeCodeModule(bool isFromNativeCodeModule) { m_isFromNativeCodeModule = isFromNativeCodeModule; }
- uint GetLoopNumber(LoopHeader const * loopHeader) const;
- bool GetHasAllocatedLoopHeaders() { return this->loopHeaderArray != nullptr; }
- #if ENABLE_NATIVE_CODEGEN
- Js::JavascriptMethod GetLoopBodyEntryPoint(Js::LoopHeader * loopHeader, int entryPointIndex);
- void SetLoopBodyEntryPoint(Js::LoopHeader * loopHeader, EntryPointInfo* entryPointInfo, Js::JavascriptMethod entryPoint);
- #endif
- void RestoreOldDefaultEntryPoint(FunctionEntryPointInfo* oldEntryPoint, JavascriptMethod oldOriginalEntryPoint, FunctionEntryPointInfo* newEntryPoint);
- FunctionEntryPointInfo* CreateNewDefaultEntryPoint();
- void AddEntryPointToEntryPointList(FunctionEntryPointInfo* entryPoint);
- // Kind of entry point for original entry point
- BOOL IsInterpreterThunk() const;
- BOOL IsDynamicInterpreterThunk() const;
- BOOL IsNativeOriginalEntryPoint() const;
- bool IsSimpleJitOriginalEntryPoint() const;
- #if DYNAMIC_INTERPRETER_THUNK
- static BYTE GetOffsetOfDynamicInterpreterThunk() { return offsetof(FunctionBody, m_dynamicInterpreterThunk); }
- void* GetDynamicInterpreterEntryPoint() const
- {
- return m_dynamicInterpreterThunk;
- }
- bool HasInterpreterThunkGenerated() const
- {
- return m_dynamicInterpreterThunk != nullptr;
- }
- DWORD GetDynamicInterpreterThunkSize() const;
- #endif
- bool GetHasHotLoop() const { return hasHotLoop; };
- void SetHasHotLoop();
- bool GetHasNestedLoop() const { return hasNestedLoop; };
- void SetHasNestedLoop(bool nest) { hasNestedLoop = nest; };
- bool IsInlineApplyDisabled();
- void InitDisableInlineApply();
- void SetDisableInlineApply(bool set);
- bool IsInlineSpreadDisabled() const { return disableInlineSpread; }
- void InitDisableInlineSpread() { disableInlineSpread = this->functionId != Js::Constants::NoFunctionId && PHASE_OFF(Js::InlinePhase, this); }
- void SetDisableInlineSpread(bool set) { disableInlineSpread = set; }
- bool CheckCalleeContextForInlining(FunctionProxy* calleeFunctionProxy);
- #if DBG
- bool HasValidSourceInfo();
- #endif
- #if DYNAMIC_INTERPRETER_THUNK
- JavascriptMethod EnsureDynamicInterpreterThunk(FunctionEntryPointInfo* entryPointInfo);
- #endif
- void SetCheckCodeGenEntryPoint(FunctionEntryPointInfo* entryPointInfo, JavascriptMethod entryPoint);
- #if ENABLE_NATIVE_CODEGEN
- typedef void (*SetNativeEntryPointFuncType)(FunctionEntryPointInfo* entryPointInfo, Js::FunctionBody * functionBody, Js::JavascriptMethod entryPoint);
- static void DefaultSetNativeEntryPoint(FunctionEntryPointInfo* entryPointInfo, FunctionBody * functionBody, JavascriptMethod entryPoint);
- static void ProfileSetNativeEntryPoint(FunctionEntryPointInfo* entryPointInfo, FunctionBody * functionBody, JavascriptMethod entryPoint);
- bool GetNativeEntryPointUsed() const { return m_nativeEntryPointUsed; }
- void SetNativeEntryPointUsed(bool nativeEntryPointUsed) { this->m_nativeEntryPointUsed = nativeEntryPointUsed; }
- #endif
- bool GetIsFuncRegistered() { return m_isFuncRegistered; }
- void SetIsFuncRegistered(bool isRegistered) { m_isFuncRegistered = isRegistered; }
- bool GetHasLoops() const { return loopCount != 0; }
- uint IncrLoopCount() { return this->loopCount++; }
- uint GetLoopCount() const { return this->loopCount; }
- bool AllocProfiledDivOrRem(ProfileId* profileId) { if (this->profiledDivOrRemCount != Constants::NoProfileId) { *profileId = this->profiledDivOrRemCount++; return true; } return false; }
- ProfileId GetProfiledDivOrRemCount() { return this->profiledDivOrRemCount; }
- bool AllocProfiledSwitch(ProfileId* profileId) { if (this->profiledSwitchCount != Constants::NoProfileId) { *profileId = this->profiledSwitchCount++; return true; } return false; }
- ProfileId GetProfiledSwitchCount() { return this->profiledSwitchCount; }
- bool AllocProfiledCallSiteId(ProfileId* profileId) { if (this->profiledCallSiteCount != Constants::NoProfileId) { *profileId = this->profiledCallSiteCount++; return true; } return false; }
- ProfileId GetProfiledCallSiteCount() const { return this->profiledCallSiteCount; }
- void SetProfiledCallSiteCount(ProfileId callSiteId) { this->profiledCallSiteCount = callSiteId; }
- bool AllocProfiledArrayCallSiteId(ProfileId* profileId) { if (this->profiledArrayCallSiteCount != Constants::NoProfileId) { *profileId = this->profiledArrayCallSiteCount++; return true; } return false; }
- ProfileId GetProfiledArrayCallSiteCount() const { return this->profiledArrayCallSiteCount; }
- bool AllocProfiledReturnTypeId(ProfileId* profileId) { if (this->profiledReturnTypeCount != Constants::NoProfileId) { *profileId = this->profiledReturnTypeCount++; return true; } return false; }
- ProfileId GetProfiledReturnTypeCount() const { return this->profiledReturnTypeCount; }
- bool AllocProfiledSlotId(ProfileId* profileId) { if (this->profiledSlotCount != Constants::NoProfileId) { *profileId = this->profiledSlotCount++; return true; } return false; }
- ProfileId GetProfiledSlotCount() const { return this->profiledSlotCount; }
- ProfileId AllocProfiledLdElemId(ProfileId* profileId) { if (this->profiledLdElemCount != Constants::NoProfileId) { *profileId = this->profiledLdElemCount++; return true; } return false; }
- ProfileId GetProfiledLdElemCount() const { return this->profiledLdElemCount; }
- bool AllocProfiledStElemId(ProfileId* profileId) { if (this->profiledStElemCount != Constants::NoProfileId) { *profileId = this->profiledStElemCount++; return true; } return false; }
- ProfileId GetProfiledStElemCount() const { return this->profiledStElemCount; }
- uint GetProfiledFldCount() const { return this->GetInlineCacheCount(); }
- ArgSlot GetProfiledInParamsCount() const { return this->GetInParamsCount() > 1? this->GetInParamsCount() - 1 : 0; }
- bool IsPartialDeserializedFunction() { return this->m_isPartialDeserializedFunction; }
- #ifdef PERF_COUNTERS
- bool IsDeserializedFunction() { return this->m_isDeserializedFunction; }
- #endif
- #ifdef IR_VIEWER
- bool IsIRDumpEnabled() const { return this->m_isIRDumpEnabled; }
- void SetIRDumpEnabled(bool enabled) { this->m_isIRDumpEnabled = enabled; }
- Js::DynamicObject * GetIRDumpBaseObject();
- #endif /* IR_VIEWER */
- #if ENABLE_NATIVE_CODEGEN
- void SetPolymorphicCallSiteInfoHead(PolymorphicCallSiteInfo *polyCallSiteInfo) { this->polymorphicCallSiteInfoHead = polyCallSiteInfo;}
- PolymorphicCallSiteInfo * GetPolymorphicCallSiteInfoHead() { return this->polymorphicCallSiteInfoHead;}
- #endif
- PolymorphicInlineCache * GetPolymorphicInlineCachesHead() { return this->polymorphicInlineCachesHead; }
- void SetPolymorphicInlineCachesHead(PolymorphicInlineCache * cache) { this->polymorphicInlineCachesHead = cache; }
- bool PolyInliningUsingFixedMethodsAllowedByConfigFlags(FunctionBody* topFunctionBody)
- {
- return !PHASE_OFF(Js::InlinePhase, this) && !PHASE_OFF(Js::InlinePhase, topFunctionBody) &&
- !PHASE_OFF(Js::PolymorphicInlinePhase, this) && !PHASE_OFF(Js::PolymorphicInlinePhase, topFunctionBody) &&
- !PHASE_OFF(Js::FixedMethodsPhase, this) && !PHASE_OFF(Js::FixedMethodsPhase, topFunctionBody) &&
- !PHASE_OFF(Js::PolymorphicInlineFixedMethodsPhase, this) && !PHASE_OFF(Js::PolymorphicInlineFixedMethodsPhase, topFunctionBody);
- }
- Js::PropertyId * GetPropertyIdsForScopeSlotArray() const
- {
- return this->propertyIdsForScopeSlotArray;
- }
- void SetPropertyIdsForScopeSlotArray(Js::PropertyId * propertyIdsForScopeSlotArray, uint scopeSlotCount)
- {
- this->scopeSlotArraySize = scopeSlotCount;
- this->propertyIdsForScopeSlotArray = propertyIdsForScopeSlotArray;
- }
- Js::PropertyIdOnRegSlotsContainer * GetPropertyIdOnRegSlotsContainer() const
- {
- return this->propertyIdOnRegSlotsContainer;
- }
- private:
- void ResetProfileIds();
- void SetFlags(bool does, FunctionBodyFlags newFlags)
- {
- if (does)
- {
- flags = (FunctionBodyFlags)(flags | newFlags);
- }
- else
- {
- flags = (FunctionBodyFlags)(flags & ~newFlags);
- }
- }
- public:
- bool GetHasThis() const { return (flags & Flags_HasThis) != 0; }
- void SetHasThis(bool has) { SetFlags(has, Flags_HasThis); }
- bool GetHasTry() const { return (flags & Flags_HasTry) != 0; }
- void SetHasTry(bool has) { SetFlags(has, Flags_HasTry); }
- bool GetHasFinally() const { return m_hasFinally; }
- void SetHasFinally(bool has){ m_hasFinally = has; }
- bool GetFuncEscapes() const { return funcEscapes; }
- void SetFuncEscapes(bool does) { funcEscapes = does; }
- bool GetHasOrParentHasArguments() const { return (flags & Flags_HasOrParentHasArguments) != 0; }
- void SetHasOrParentHasArguments(bool has) { SetFlags(has, Flags_HasOrParentHasArguments); }
- bool DoStackNestedFunc() const { return (flags & Flags_StackNestedFunc) != 0; }
- void SetStackNestedFunc(bool does) { SetFlags(does, Flags_StackNestedFunc); }
- #if DBG
- bool CanDoStackNestedFunc() const { return m_canDoStackNestedFunc; }
- void SetCanDoStackNestedFunc() { m_canDoStackNestedFunc = true; }
- #endif
- FunctionBody * GetStackNestedFuncParent();
- FunctionBody * GetAndClearStackNestedFuncParent();
- void ClearStackNestedFuncParent();
- void SetStackNestedFuncParent(FunctionBody * parentFunctionBody);
- #if defined(_M_IX86) || defined(_M_X64)
- bool DoStackClosure() const
- {
- return DoStackNestedFunc() && GetNestedCount() != 0 && !PHASE_OFF(StackClosurePhase, this) && scopeSlotArraySize != 0 && GetEnvDepth() != (uint16)-1;
- }
- #else
- bool DoStackClosure() const
- {
- return false;
- }
- #endif
- bool DoStackFrameDisplay() const { return DoStackClosure(); }
- bool DoStackScopeSlots() const { return DoStackClosure(); }
- bool IsNonUserCode() const { return (flags & Flags_NonUserCode) != 0; }
- void SetIsNonUserCode(bool set);
- bool GetHasNoExplicitReturnValue() { return (flags & Flags_HasNoExplicitReturnValue) != 0; }
- void SetHasNoExplicitReturnValue(bool has) { SetFlags(has, Flags_HasNoExplicitReturnValue); }
- bool GetHasOnlyThisStmts() const { return (flags & Flags_HasOnlyThisStatements) != 0; }
- void SetHasOnlyThisStmts(bool has) { SetFlags(has, Flags_HasOnlyThisStatements); }
- bool GetIsFirstFunctionObject() const { return m_firstFunctionObject; }
- void SetIsNotFirstFunctionObject() { m_firstFunctionObject = false; }
- bool GetInlineCachesOnFunctionObject() { return m_inlineCachesOnFunctionObject; }
- void SetInlineCachesOnFunctionObject(bool has) { m_inlineCachesOnFunctionObject = has; }
- bool GetHasRestParameter() const { return (flags & Flags_HasRestParameter) != 0; }
- void SetHasRestParameter() { SetFlags(true, Flags_HasRestParameter); }
- uint GetNumberOfRecursiveCallSites();
- bool CanInlineRecursively(uint depth, bool tryAggressive = true);
- public:
- bool CanInlineAgain() const
- {
- // Block excessive recursive inlining of the same function
- return inlineDepth < static_cast<byte>(max(1, min(0xff, CONFIG_FLAG(MaxFuncInlineDepth))));
- }
- void OnBeginInlineInto()
- {
- ++inlineDepth;
- }
- void OnEndInlineInto()
- {
- --inlineDepth;
- }
- uint8 IncrementBailOnMisingProfileCount() { return ++bailOnMisingProfileCount; }
- void ResetBailOnMisingProfileCount() { bailOnMisingProfileCount = 0; }
- uint8 IncrementBailOnMisingProfileRejitCount() { return ++bailOnMisingProfileRejitCount; }
- uint32 GetFrameHeight(EntryPointInfo* entryPointInfo) const;
- void SetFrameHeight(EntryPointInfo* entryPointInfo, uint32 frameHeight);
- RegSlot GetLocalsCount();
- RegSlot GetConstantCount() const { return m_constCount; }
- void SetConstantCount(RegSlot cNewConstants);
- RegSlot GetVarCount();
- void SetVarCount(RegSlot cNewVars);
- RegSlot MapRegSlot(RegSlot reg)
- {
- if (this->RegIsConst(reg))
- {
- reg = CONSTREG_TO_REGSLOT(reg);
- Assert(reg < this->GetConstantCount());
- }
- else
- {
- reg += this->GetConstantCount();
- }
- return reg;
- }
- bool RegIsConst(RegSlot reg) { return reg > REGSLOT_TO_CONSTREG(this->GetConstantCount()); }
- uint32 GetNonTempLocalVarCount();
- uint32 GetFirstNonTempLocalIndex();
- uint32 GetEndNonTempLocalIndex();
- bool IsNonTempLocalVar(uint32 varIndex);
- bool GetSlotOffset(RegSlot slotId, int32 * slotOffset, bool allowTemp = false);
- RegSlot GetOutParamsDepth();
- void SetOutParamDepth(RegSlot cOutParamsDepth);
- RegSlot GetYieldRegister();
- RegSlot GetFirstTmpReg();
- void SetFirstTmpReg(RegSlot firstTmpReg);
- RegSlot GetTempCount();
- Js::ModuleID GetModuleID() const;
- void CreateConstantTable();
- void RecordNullObject(RegSlot location);
- void RecordUndefinedObject(RegSlot location);
- void RecordTrueObject(RegSlot location);
- void RecordFalseObject(RegSlot location);
- void RecordIntConstant(RegSlot location, unsigned int val);
- void RecordStrConstant(RegSlot location, LPCOLESTR psz, ulong cch);
- void RecordFloatConstant(RegSlot location, double d);
- void RecordNullDisplayConstant(RegSlot location);
- void RecordStrictNullDisplayConstant(RegSlot location);
- void InitConstantSlots(Var *dstSlots);
- Var GetConstantVar(RegSlot location);
- void* GetConstTable() const{return m_constTable;}
- void CloneConstantTable(FunctionBody *newFunc);
- void MarkScript(ByteBlock * pblkByteCode, ByteBlock * pblkAuxiliaryData, ByteBlock* auxContextBlock,
- uint byteCodeCount, uint byteCodeInLoopCount, uint byteCodeWithoutLDACount);
- void BeginExecution();
- void EndExecution();
- SourceInfo * GetSourceInfo() { return &this->m_sourceInfo; }
- bool InstallProbe(int offset);
- bool UninstallProbe(int offset);
- bool ProbeAtOffset(int offsest, OpCode* pOriginalOpcode);
- FunctionBody * Clone(ScriptContext *scriptContext, uint sourceIndex = Js::Constants::InvalidSourceIndex);
- static bool ShouldShareInlineCaches() { return CONFIG_FLAG(ShareInlineCaches); }
- uint GetInlineCacheCount() const { return inlineCacheCount; }
- uint GetRootObjectLoadInlineCacheStart() const { return rootObjectLoadInlineCacheStart; }
- uint GetRootObjectLoadMethodInlineCacheStart() const { return rootObjectLoadMethodInlineCacheStart; }
- uint GetRootObjectStoreInlineCacheStart() const { return rootObjectStoreInlineCacheStart; }
- uint GetIsInstInlineCacheCount() const { return isInstInlineCacheCount; }
- uint GetReferencedPropertyIdCount() const { return referencedPropertyIdCount; }
- void AllocateInlineCache();
- InlineCache * GetInlineCache(uint index);
- bool CanFunctionObjectHaveInlineCaches();
- void** GetInlineCaches();
- #if DBG
- byte* GetInlineCacheTypes();
- #endif
- InlineCache * GetRootObjectInlineCache(uint index);
- IsInstInlineCache * GetIsInstInlineCache(uint index);
- PolymorphicInlineCache * GetPolymorphicInlineCache(uint index);
- PolymorphicInlineCache * CreateNewPolymorphicInlineCache(uint index, PropertyId propertyId, InlineCache * inlineCache);
- PolymorphicInlineCache * CreateBiggerPolymorphicInlineCache(uint index, PropertyId propertyId);
- private:
- void ResetInlineCaches();
- PolymorphicInlineCache * CreatePolymorphicInlineCache(uint index, uint16 size);
- uint32 m_asmJsTotalLoopCount;
- public:
- void CreateCacheIdToPropertyIdMap();
- void CreateCacheIdToPropertyIdMap(uint rootObjectLoadInlineCacheStart, uint rootObjectLoadMethodInlineCacheStart, uint rootObjectStoreInlineCacheStart,
- uint totalFieldAccessInlineCacheCount, uint isInstInlineCacheCount);
- void SetPropertyIdForCacheId(uint cacheId, PropertyId propertyId);
- PropertyId GetPropertyIdFromCacheId(uint cacheId)
- {
- Assert(this->cacheIdToPropertyIdMap);
- Assert(cacheId < this->GetInlineCacheCount());
- return this->cacheIdToPropertyIdMap[cacheId];
- }
- #if DBG
- void VerifyCacheIdToPropertyIdMap();
- #endif
- void CreateReferencedPropertyIdMap(uint referencedPropertyIdCount);
- void CreateReferencedPropertyIdMap();
- PropertyId GetReferencedPropertyIdWithMapIndex(uint mapIndex);
- void SetReferencedPropertyIdWithMapIndex(uint mapIndex, PropertyId propertyId);
- PropertyId GetReferencedPropertyId(uint index);
- #if DBG
- void VerifyReferencedPropertyIdMap();
- #endif
- #ifdef ENABLE_DEBUG_CONFIG_OPTIONS
- void DumpFullFunctionName();
- void DumpFunctionId(bool pad);
- uint GetTraceFunctionNumber() const;
- #endif
- public:
- uint NewObjectLiteral();
- void AllocateObjectLiteralTypeArray();
- DynamicType ** GetObjectLiteralTypeRef(uint index);
- uint NewLiteralRegex();
- uint GetLiteralRegexCount() const;
- void AllocateLiteralRegexArray();
- UnifiedRegex::RegexPattern *GetLiteralRegex(const uint index);
- #ifndef TEMP_DISABLE_ASMJS
- AsmJsFunctionInfo* GetAsmJsFunctionInfo()const {return asmJsFunctionInfo; }
- AsmJsFunctionInfo* AllocateAsmJsFunctionInfo();
- AsmJsModuleInfo* GetAsmJsModuleInfo()const{ return asmJsModuleInfo; }
- void ResetAsmJsInfo()
- {
- asmJsFunctionInfo = nullptr;
- asmJsModuleInfo = nullptr;
- }
- bool IsAsmJSModule()const{ if (asmJsModuleInfo) return true; return false; }
- AsmJsModuleInfo* AllocateAsmJsModuleInfo();
- #endif
- void SetLiteralRegex(const uint index, UnifiedRegex::RegexPattern *const pattern);
- private:
- void ResetLiteralRegexes();
- void ResetObjectLiteralTypes();
- public:
- void ResetByteCodeGenState();
- void ResetByteCodeGenVisitState();
- void FindClosestStatements(long characterOffset, StatementLocation *firstStatementLocation, StatementLocation *secondStatementLocation);
- #if ENABLE_NATIVE_CODEGEN
- const FunctionCodeGenRuntimeData *GetInlineeCodeGenRuntimeData(const ProfileId profiledCallSiteId) const;
- const FunctionCodeGenRuntimeData *GetInlineeCodeGenRuntimeDataForTargetInlinee(const ProfileId profiledCallSiteId, FunctionBody *inlineeFuncBody) const;
- FunctionCodeGenRuntimeData *EnsureInlineeCodeGenRuntimeData(
- Recycler *const recycler,
- __in_range(0, profiledCallSiteCount - 1) const ProfileId profiledCallSiteId,
- FunctionBody *const inlinee);
- const FunctionCodeGenRuntimeData *GetLdFldInlineeCodeGenRuntimeData(const InlineCacheIndex inlineCacheIndex) const;
- FunctionCodeGenRuntimeData *EnsureLdFldInlineeCodeGenRuntimeData(
- Recycler *const recycler,
- __in_range(0, this->inlineCacheCount - 1) const InlineCacheIndex inlineCacheIndex,
- FunctionBody *const inlinee);
- void LoadDynamicProfileInfo();
- bool HasExecutionDynamicProfileInfo() const { return hasExecutionDynamicProfileInfo; }
- bool HasDynamicProfileInfo() const { return dynamicProfileInfo != nullptr; }
- bool NeedEnsureDynamicProfileInfo() const;
- DynamicProfileInfo * GetDynamicProfileInfo() const { Assert(HasExecutionDynamicProfileInfo()); return dynamicProfileInfo; }
- DynamicProfileInfo * GetAnyDynamicProfileInfo() const { Assert(HasDynamicProfileInfo()); return dynamicProfileInfo; }
- DynamicProfileInfo * EnsureDynamicProfileInfo();
- DynamicProfileInfo * AllocateDynamicProfile();
- BYTE GetSavedInlinerVersion() const;
- uint32 GetSavedPolymorphicCacheState() const;
- ImplicitCallFlags GetSavedImplicitCallsFlags() const;
- bool HasNonBuiltInCallee();
- bool HasFunctionBailOutRecord() const { return functionBailOutRecord != nullptr; }
- FunctionBailOutRecord * GetFunctionBailOutRecord() const { Assert(HasFunctionBailOutRecord()); return functionBailOutRecord; }
- void SetFunctionBailOutRecord(FunctionBailOutRecord * record) { Assert(!HasFunctionBailOutRecord()); functionBailOutRecord = record; }
- void RecordNativeThrowMap(SmallSpanSequenceIter& iter, uint32 offset, uint32 statementIndex, EntryPointInfo* entryPoint, uint loopNum);
- void RecordNativeBaseAddress(BYTE* baseAddress, ptrdiff_t codeSizeS, NativeCodeData * data, NativeCodeData * transferData, CodeGenNumberChunk * numberChunks,
- EntryPointInfo* info, uint loopNum);
- void SetNativeThrowSpanSequence(SmallSpanSequence *seq, uint loopNum, LoopEntryPointInfo* entryPoint);
- BOOL GetMatchingStatementMapFromNativeAddress(DWORD_PTR codeAddress, StatementData &data, uint loopNum, FunctionBody *inlinee = nullptr);
- BOOL GetMatchingStatementMapFromNativeOffset(DWORD_PTR codeAddress, uint32 offset, StatementData &data, uint loopNum, FunctionBody *inlinee = nullptr);
- FunctionEntryPointInfo * GetEntryPointFromNativeAddress(DWORD_PTR codeAddress);
- LoopEntryPointInfo * GetLoopEntryPointInfoFromNativeAddress(DWORD_PTR codeAddress, uint loopNum) const;
- #endif
- void InsertSymbolToRegSlotList(JsUtil::CharacterBuffer<WCHAR> const& propName, RegSlot reg, RegSlot totalRegsCount);
- void InsertSymbolToRegSlotList(RegSlot reg, PropertyId propertyId, RegSlot totalRegsCount);
- void SetPropertyIdsOfFormals(PropertyIdArray * formalArgs);
- bool DontRethunkAfterBailout() const { return dontRethunkAfterBailout; }
- void SetDontRethunkAfterBailout() { dontRethunkAfterBailout = true; }
- void ClearDontRethunkAfterBailout() { dontRethunkAfterBailout = false; }
- void SaveState(ParseNodePtr pnode);
- void RestoreState(ParseNodePtr pnode);
- // Used for the debug purpose, this info will be stored (in the non-debug mode), when a function has all locals marked as non-local-referenced.
- // So when we got to no-refresh debug mode, and try to re-use the same function body we can then enforce all locals to be non-local-referenced.
- bool HasAllNonLocalReferenced() const { return m_hasAllNonLocalReferenced; }
- void SetAllNonLocalReferenced(bool set) { m_hasAllNonLocalReferenced = set; }
- bool HasSetIsObject() const { return m_hasSetIsObject; }
- void SetHasSetIsObject(bool set) { m_hasSetIsObject = set; }
- bool HasFuncExprNameReference() const { return m_hasFunExprNameReference; }
- void SetFuncExprNameReference(bool value) { m_hasFunExprNameReference = value; }
- bool GetChildCallsEval() const { return m_ChildCallsEval; }
- void SetChildCallsEval(bool value) { m_ChildCallsEval = value; }
- bool GetCallsEval() const { return m_CallsEval; }
- void SetCallsEval(bool set) { m_CallsEval = set; }
- bool HasReferenceableBuiltInArguments() const { return m_hasReferenceableBuiltInArguments; }
- void SetHasReferenceableBuiltInArguments(bool value) { m_hasReferenceableBuiltInArguments = value; }
- // Used for the debug purpose. This is to avoid setting all locals to non-local-referenced, multiple time for each child function.
- bool HasDoneAllNonLocalReferenced() const { return m_hasDoneAllNonLocalReferenced; }
- void SetHasDoneAllNonLocalReferenced(bool set) { m_hasDoneAllNonLocalReferenced = set; }
- // Once the function compiled is sent m_hasFunctionCompiledSent will be set to 'true'. The below check will be used only to determine during ProfileModeDeferredParse function.
- bool HasFunctionCompiledSent() const { return m_hasFunctionCompiledSent; }
- void SetHasFunctionCompiledSent(bool set) { m_hasFunctionCompiledSent = set; }
- #if DBG_DUMP
- void DumpStatementMaps();
- void Dump();
- void PrintStatementSourceLine(uint statementIndex);
- void PrintStatementSourceLineFromStartOffset(uint cchStartOffset);
- void DumpScopes();
- #endif
- uint GetStatementStartOffset(const uint statementIndex);
- #ifdef IR_VIEWER
- void GetSourceLineFromStartOffset(const uint startOffset, LPCUTF8 *sourceBegin, LPCUTF8 *sourceEnd,
- ULONG * line, LONG * col);
- void GetStatementSourceInfo(const uint statementIndex, LPCUTF8 *sourceBegin, LPCUTF8 *sourceEnd,
- ULONG * line, LONG * col);
- #endif
- HRESULT RegisterFunction(BOOL fChangeMode, BOOL fOnlyCurrent = FALSE);
- HRESULT ReportScriptCompiled();
- HRESULT ReportFunctionCompiled();
- void SetEntryToProfileMode();
- void CheckAndRegisterFuncToDiag(ScriptContext *scriptContext);
- void SetEntryToDeferParseForDebugger();
- void ResetEntryPoint();
- void CleanupToReparse();
- void AddDeferParseAttribute();
- void RemoveDeferParseAttribute();
- #if DBG
- void MustBeInDebugMode();
- #endif
- static bool IsDummyGlobalRetStatement(const regex::Interval *sourceSpan)
- {
- Assert(sourceSpan != nullptr);
- return sourceSpan->begin == 0 && sourceSpan->end == 0;
- }
- static void GetShortNameFromUrl(__in LPCWSTR pchUrl, _Out_writes_z_(cchBuffer) LPWSTR pchShortName, __in size_t cchBuffer);
- template<class Fn>
- void MapLoopHeaders(Fn fn) const
- {
- if(this->loopHeaderArray)
- {
- for(uint i = 0; i < loopCount; i++)
- {
- fn(i , &this->loopHeaderArray[i]);
- }
- }
- }
- template <class Fn>
- void MapEntryPoints(Fn fn) const
- {
- if (this->entryPoints)
- {
- this->entryPoints->Map([&fn] (int index, RecyclerWeakReference<FunctionEntryPointInfo>* entryPoint) {
- FunctionEntryPointInfo* strongRef = entryPoint->Get();
- if (strongRef)
- {
- fn(index, strongRef);
- }
- });
- }
- }
- bool DoJITLoopBody() const
- {
- return IsJitLoopBodyPhaseEnabled() && this->loopHeaderArray != nullptr;
- }
- bool ForceJITLoopBody() const
- {
- return IsJitLoopBodyPhaseForced() && !this->GetHasTry();
- }
- bool IsGeneratorAndJitIsDisabled()
- {
- return this->IsGenerator() && !(CONFIG_ISENABLED(Js::JitES6GeneratorsFlag) && !this->GetHasTry());
- }
- FunctionBodyFlags * GetAddressOfFlags() { return &this->flags; }
- Js::RegSlot GetRestParamRegSlot();
- public:
- void RecordConstant(RegSlot location, Var var);
- private:
- inline void CheckEmpty();
- inline void CheckNotExecuting();
- SmallSpanSequence *GetThrowSpanSequence(DWORD_PTR codeAddress, uint loopNum);
- BOOL GetMatchingStatementMap(StatementData &data, int statementIndex, FunctionBody *inlinee);
- #if ENABLE_NATIVE_CODEGEN
- int GetStatementIndexFromNativeOffset(SmallSpanSequence *pThrowSpanSequence, uint32 nativeOffset);
- int GetStatementIndexFromNativeAddress(SmallSpanSequence *pThrowSpanSequence, DWORD_PTR codeAddress, DWORD_PTR nativeBaseAddress);
- #endif
- void EnsureAuxStatementData();
- StatementAdjustmentRecordList* GetStatementAdjustmentRecords();
- #ifdef DYNAMIC_PROFILE_MUTATOR
- friend class DynamicProfileMutator;
- friend class DynamicProfileMutatorImpl;
- #endif
- friend class RemoteFunctionBody;
- };
- typedef SynchronizableList<FunctionBody*, JsUtil::List<FunctionBody*, ArenaAllocator, false, Js::FreeListedRemovePolicy> > FunctionBodyList;
- struct ScopeSlots
- {
- public:
- static uint const MaxEncodedSlotCount = USHORT_MAX;
- // The slot index is at the same location as the vtable, so that we can distinguish between scope slot and frame display
- static uint const EncodedSlotCountSlotIndex = 0;
- static uint const ScopeMetadataSlotIndex = 1; // Either a FunctionBody* or DebuggerScope*
- static uint const FirstSlotIndex = 2;
- public:
- ScopeSlots(Var* slotArray) : slotArray(slotArray)
- {
- }
- bool IsFunctionScopeSlotArray()
- {
- return FunctionBody::Is(slotArray[ScopeMetadataSlotIndex]);
- }
- FunctionBody* GetFunctionBody()
- {
- Assert(IsFunctionScopeSlotArray());
- return (FunctionBody*)(slotArray[ScopeMetadataSlotIndex]);
- }
- DebuggerScope* GetDebuggerScope()
- {
- Assert(!IsFunctionScopeSlotArray());
- return (DebuggerScope*)(slotArray[ScopeMetadataSlotIndex]);
- }
- Var GetScopeMetadataRaw() const
- {
- return slotArray[ScopeMetadataSlotIndex];
- }
- void SetScopeMetadata(Var scopeMetadataObj)
- {
- slotArray[ScopeMetadataSlotIndex] = scopeMetadataObj;
- }
- uint GetCount() const
- {
- return ::Math::PointerCastToIntegralTruncate<uint>(slotArray[EncodedSlotCountSlotIndex]);
- }
- void SetCount(uint count)
- {
- slotArray[EncodedSlotCountSlotIndex] = (Var)min<uint>(count, ScopeSlots::MaxEncodedSlotCount);
- }
- Var Get(uint i) const
- {
- Assert(i < GetCount());
- return slotArray[i + FirstSlotIndex];
- }
- void Set(uint i, Var value)
- {
- Assert(i < GetCount());
- slotArray[i + FirstSlotIndex] = value;
- }
- template<class Fn>
- void Map(Fn fn)
- {
- uint count = GetCount();
- for(uint i = 0; i < count; i++)
- {
- fn(GetSlot[i]);
- }
- }
- // The first pointer sized value in the object for scope slots is the count, while it is a vtable
- // for Activation object or with scope (a recyclable object)
- // VTable values are always > 64K because they are a pointer, hence anything less than that implies
- // a slot array.
- // CONSIDER: Use TaggedInt instead of range of slot count to distinguish slot array with others.
- static bool Is(void* object)
- {
- size_t slotCount = *((size_t*)object);
- if(slotCount <= MaxEncodedSlotCount)
- {
- return true;
- }
- return false;
- }
- private:
- Var* slotArray;
- };
- enum ScopeType
- {
- ScopeType_ActivationObject,
- ScopeType_SlotArray,
- ScopeType_WithScope
- };
- // A FrameDisplay encodes a FunctionObject's scope chain. It is an array of scopes, where each scope can be either an inline slot array
- // or a RecyclableObject. A FrameDisplay for a given FunctionObject will consist of the FrameDisplay from it's enclosing scope, with any additional
- // scopes prepended. Due to with statements etc. a function may introduce multiple scopes to the FrameDisplay.
- struct FrameDisplay
- {
- FrameDisplay(uint16 len, bool strictMode = false) :
- tag(true),
- length(len),
- strictMode(strictMode)
- #if _M_X64
- , unused(0)
- #endif
- {
- }
- void SetTag(bool tag) { this->tag = tag; }
- void SetItem(uint index, void* item);
- void *GetItem(uint index);
- uint16 GetLength() const { return length; }
- void SetLength(uint16 len) { this->length = len; }
- bool GetStrictMode() const { return strictMode; }
- void SetStrictMode(bool flag) { this->strictMode = flag; }
- void** GetDataAddress() { return (void**)&this->scopes; }
- static uint32 GetOffsetOfStrictMode() { return offsetof(FrameDisplay, strictMode); }
- static uint32 GetOffsetOfLength() { return offsetof(FrameDisplay, length); }
- static uint32 GetOffsetOfScopes() { return offsetof(FrameDisplay, scopes); }
- static ScopeType GetScopeType(void* scope);
- private:
- bool tag; // Tag it so that the NativeCodeGenerator::IsValidVar would not think this is var
- bool strictMode;
- uint16 length;
- #if defined(_M_X64_OR_ARM64)
- uint32 unused;
- #endif
- void* scopes[];
- };
- #pragma region Function Body helper classes
- #pragma region Debugging related source classes
- // Contains only the beginning part of the statement. This will mainly used in SmallSpanSequence which will further be compressed
- // and stored in the buffer
- struct StatementData
- {
- StatementData()
- : sourceBegin(0),
- bytecodeBegin(0)
- {
- }
- int sourceBegin;
- int bytecodeBegin;
- };
- struct StatementLocation
- {
- Js::FunctionBody* function;
- regex::Interval statement;
- regex::Interval bytecodeSpan;
- };
- // Small span in the Statement buffer of the SmallSpanSequence
- struct SmallSpan
- {
- ushort sourceBegin;
- ushort bytecodeBegin;
- SmallSpan(uint32 val)
- {
- sourceBegin = (ushort)(val >> 16);
- bytecodeBegin = (ushort)(val & 0x0000FFFF);
- }
- operator unsigned int()
- {
- return (uint32)sourceBegin << 16 | bytecodeBegin;
- }
- };
- // Iterator which contains the state at particular index. These values will used when fetching next item from
- // SmallSpanSequence
- class SmallSpanSequenceIter
- {
- friend class SmallSpanSequence;
- public:
- SmallSpanSequenceIter()
- : accumulatedIndex(-1),
- accumulatedSourceBegin(0),
- accumulatedBytecodeBegin(0),
- indexOfActualOffset(0)
- {
- }
- // Below are used for fast access when the last access happened nearby.
- // so the actual index would be accumulatedIndex / 2 + (remainder for which byte).
- int accumulatedIndex;
- int accumulatedSourceBegin;
- int accumulatedBytecodeBegin;
- int indexOfActualOffset;
- };
- // This class compacts the range of the statement to BYTEs instead of ints.
- // Instead of having start and end as int32s we will have them stored in bytes, and they will be
- // treated as start offset and end offset.
- // For simplicity, this class should be heap allocated, since it can be allocated from either the background
- // or main thread.
- class SmallSpanSequence
- {
- friend class SmallSpanSequenceIter;
- friend class ByteCodeBufferBuilder;
- friend class ByteCodeBufferReader;
- private:
- // Each item in the list contains two set of begins (one for bytecode and for sourcespan).
- // The allowed valued for source and bytecode span is in between SHORT_MAX - 1 to SHORT_MIN (inclusive).
- // otherwise its a miss
- JsUtil::GrowingUint32HeapArray * pStatementBuffer;
- // Contains list of values which are missed in StatementBuffer.
- JsUtil::GrowingUint32HeapArray * pActualOffsetList;
- // The first value of the sequence
- int baseValue;
- BOOL GetRangeAt(int index, SmallSpanSequenceIter &iter, int * pCountOfMissed, StatementData & data);
- ushort GetDiff(int current, int prev);
- public:
- SmallSpanSequence();
- ~SmallSpanSequence()
- {
- Cleanup();
- }
- void Cleanup()
- {
- if (pStatementBuffer != nullptr)
- {
- HeapDelete(pStatementBuffer);
- }
- if (pActualOffsetList != nullptr)
- {
- HeapDelete(pActualOffsetList);
- }
- }
- // Trys to match passed bytecode in the statement, and returns the statement which includes that.
- BOOL GetMatchingStatementFromBytecode(int bytecode, SmallSpanSequenceIter &iter, StatementData & data);
- // Record the statement data in the statement buffer in the compressed manner.
- BOOL RecordARange(SmallSpanSequenceIter &iter, StatementData * data);
- // Reset the accumulator's state and value.
- void Reset(SmallSpanSequenceIter &iter);
- uint32 Count() const { return pStatementBuffer ? pStatementBuffer->Count() : 0; }
- BOOL Item(int index, SmallSpanSequenceIter &iter, StatementData &data);
- // Below function will not change any state, so it will not alter accumulated index and value
- BOOL Seek(int index, StatementData & data);
- SmallSpanSequence * Clone();
- };
- #pragma endregion
- // This container represent the property ids for the locals which are placed at direct slot
- // and list of formals args if user has not used the arguments object in the script for the current function
- struct PropertyIdOnRegSlotsContainer
- {
- PropertyId * propertyIdsForRegSlots;
- uint length;
- PropertyIdArray * propertyIdsForFormalArgs;
- PropertyIdOnRegSlotsContainer();
- static PropertyIdOnRegSlotsContainer * New(Recycler * recycler);
- void CreateRegSlotsArray(Recycler * recycler, uint _length);
- void SetFormalArgs(PropertyIdArray * formalArgs);
- // Helper methods
- void Insert(RegSlot reg, PropertyId propId);
- void FetchItemAt(uint index, FunctionBody *pFuncBody, __out PropertyId *pPropId, __out RegSlot *pRegSlot);
- // Whether reg belongs to non-temp locals
- bool IsRegSlotFormal(RegSlot reg);
- };
- // Flags for the DebuggerScopeProperty object.
- typedef int DebuggerScopePropertyFlags;
- const int DebuggerScopePropertyFlags_None = 0x000000000;
- const int DebuggerScopePropertyFlags_Const = 0x000000001;
- const int DebuggerScopePropertyFlags_CatchObject = 0x000000002;
- const int DebuggerScopePropertyFlags_WithObject = 0x000000004;
- const int DebuggerScopePropertyFlags_ForInOrOfCollection = 0x000000008;
- // Used to store local property info for with/catch objects, lets, or consts
- // that are needed for the debugger.
- class DebuggerScopeProperty
- {
- public:
- Js::PropertyId propId; // The property ID of the scope variable.
- RegSlot location; // Contains the location of the scope variable (regslot, slotarray, direct).
- int byteCodeInitializationOffset; // The byte code offset used when comparing let/const variables for dead zone exclusion debugger side.
- DebuggerScopePropertyFlags flags; // Flags for the property.
- bool IsConst() const { return (flags & DebuggerScopePropertyFlags_Const) != 0; }
- bool IsCatchObject() const { return (flags & DebuggerScopePropertyFlags_CatchObject) != 0; }
- bool IsWithObject() const { return (flags & DebuggerScopePropertyFlags_WithObject) != 0; }
- bool IsForInOrForOfCollectionScope() const { return (flags & DebuggerScopePropertyFlags_ForInOrOfCollection) != 0; }
- public:
- // Determines if the current property is in a dead zone. Note that the property makes
- // no assumptions about what scope it's in, that is determined by DebuggerScope.
- // byteCodeOffset - The current offset in bytecode that the debugger is at.
- bool IsInDeadZone(int byteCodeOffset) const
- {
- if (IsForInOrForOfCollectionScope())
- {
- // These are let/const loop variables of a for-in or for-of loop
- // in the scope for the collection expression. They are always
- // in TDZ in this scope, never initialized by the bytecode.
- return true;
- }
- if (this->byteCodeInitializationOffset == Constants::InvalidByteCodeOffset && !(IsCatchObject() || IsWithObject()))
- {
- AssertMsg(false, "Debug let/const property never had its initialization point updated. This indicates that a Ld or St operation in ByteCodeGenerator was missed that needs to have DebuggerScope::UpdatePropertyInitializationOffset() added to it.");
- return false;
- }
- return byteCodeOffset < this->byteCodeInitializationOffset;
- }
- };
- // Used to track with, catch, and block scopes for the debugger to determine context.
- class DebuggerScope
- {
- public:
- typedef JsUtil::List<DebuggerScopeProperty> DebuggerScopePropertyList;
- DebuggerScope(Recycler* recycler, DiagExtraScopesType scopeType, RegSlot scopeLocation, int rangeBegin)
- : scopeType(scopeType),
- scopeProperties(nullptr),
- parentScope(nullptr),
- siblingScope(nullptr),
- scopeLocation(scopeLocation),
- recycler(recycler)
- {
- this->range.begin = rangeBegin;
- this->range.end = -1;
- }
- DebuggerScope * GetSiblingScope(RegSlot location, FunctionBody *functionBody);
- void AddProperty(RegSlot location, Js::PropertyId propertyId, DebuggerScopePropertyFlags flags);
- bool GetPropertyIndex(Js::PropertyId propertyId, int& i);
- bool IsOffsetInScope(int offset) const;
- bool Contains(Js::PropertyId propertyId, RegSlot location) const;
- bool IsBlockScope() const;
- bool IsBlockObjectScope() const
- {
- return this->scopeType == Js::DiagBlockScopeInObject;
- }
- bool IsCatchScope() const;
- bool IsWithScope() const;
- bool IsSlotScope() const;
- bool HasProperties() const;
- bool IsAncestorOf(const DebuggerScope* potentialChildScope);
- bool AreAllPropertiesInDeadZone(int byteCodeOffset) const;
- RegSlot GetLocation() const { Assert(IsOwnScope()); return scopeLocation; }
- bool IsOwnScope() const { return scopeLocation != Js::Constants::NoRegister; }
- bool TryGetProperty(Js::PropertyId propertyId, RegSlot location, DebuggerScopeProperty* outScopeProperty) const;
- bool TryGetValidProperty(Js::PropertyId propertyId, RegSlot location, int offset, DebuggerScopeProperty* outScopeProperty, bool* isInDeadZone) const;
- bool UpdatePropertyInitializationOffset(RegSlot location, Js::PropertyId propertyId, int byteCodeOffset, bool isFunctionDeclaration = false);
- void UpdateDueToByteCodeRegeneration(DiagExtraScopesType scopeType, int start, RegSlot scopeLocation);
- void UpdatePropertiesInForInOrOfCollectionScope();
- void SetParentScope(DebuggerScope* parentScope) { this->parentScope = parentScope; }
- DebuggerScope* GetParentScope() const { return parentScope; }
- DebuggerScope* FindCommonAncestor(DebuggerScope* debuggerScope);
- int GetEnd() const { return range.end; }
- int GetStart() const { return range.begin; }
- void SetScopeLocation(RegSlot scopeLocation) { this->scopeLocation = scopeLocation; }
- void SetBegin(int begin);
- void SetEnd(int end);
- #if DBG
- void Dump();
- PCWSTR GetDebuggerScopeTypeString(DiagExtraScopesType scopeType);
- #endif
- public:
- // The list of scope properties in this scope object.
- // For with scope: Has 1 property that represents the scoped object.
- // For catch scope: Has 1 property that represents the exception object.
- // For block scope: Has 0-n properties that represent let/const variables in that scope.
- DebuggerScopePropertyList* scopeProperties;
- DiagExtraScopesType scopeType; // The type of scope being represented (With, Catch, or Block scope).
- DebuggerScope* siblingScope; // Valid only when current scope is slot/activationobject and symbols are on direct regslot
- static const int InvalidScopeIndex = -1;
- private:
- int GetScopeDepth() const;
- bool UpdatePropertyInitializationOffsetInternal(RegSlot location, Js::PropertyId propertyId, int byteCodeOffset, bool isFunctionDeclaration = false);
- void EnsurePropertyListIsAllocated();
- private:
- DebuggerScope* parentScope;
- regex::Interval range; // The start and end byte code writer offsets used when comparing where the debugger is currently stopped at (breakpoint location).
- RegSlot scopeLocation;
- Recycler* recycler;
- };
- class ScopeObjectChain
- {
- public:
- typedef JsUtil::List<DebuggerScope*> ScopeObjectChainList;
- ScopeObjectChain(Recycler* recycler)
- : pScopeChain(nullptr)
- {
- pScopeChain = RecyclerNew(recycler, ScopeObjectChainList, recycler);
- }
- // This function will return DebuggerScopeProperty when the property is found and correctly in the range.
- // If the property is found, but the scope is not in the range, it will return false, but the out param (isPropertyInDebuggerScope) will set to true,
- // and isConst will be updated.
- // If the property is not found at all, it will return false, and isPropertyInDebuggerScope will be false.
- bool TryGetDebuggerScopePropertyInfo(PropertyId propertyId, RegSlot location, int offset, bool* isPropertyInDebuggerScope, bool *isConst, bool* isInDeadZone);
- // List of all Scope Objects in a function. Scopes are added to this list as when they are created in bytecode gen part.
- ScopeObjectChainList* pScopeChain;
- };
- #pragma endregion
- } // namespace Js
|