1a4f90228488479b6805ab3e0f4d0afbe89052aa
[WebKit-https.git] / Source / JavaScriptCore / runtime / VM.h
1 /*
2  * Copyright (C) 2008-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "CallData.h"
32 #include "ConcurrentJSLock.h"
33 #include "ControlFlowProfiler.h"
34 #include "DateInstanceCache.h"
35 #include "DeleteAllCodeEffort.h"
36 #include "ExceptionEventLocation.h"
37 #include "ExecutableAllocator.h"
38 #include "FunctionHasExecutedCache.h"
39 #include "Heap.h"
40 #include "Intrinsic.h"
41 #include "JITThunks.h"
42 #include "JSCJSValue.h"
43 #include "JSDestructibleObjectSubspace.h"
44 #include "JSLock.h"
45 #include "JSSegmentedVariableObjectSubspace.h"
46 #include "JSStringSubspace.h"
47 #include "MacroAssemblerCodeRef.h"
48 #include "Microtask.h"
49 #include "NumericStrings.h"
50 #include "PrivateName.h"
51 #include "PrototypeMap.h"
52 #include "SmallStrings.h"
53 #include "SourceCode.h"
54 #include "Strong.h"
55 #include "Subspace.h"
56 #include "TemplateRegistryKeyTable.h"
57 #include "ThunkGenerators.h"
58 #include "VMEntryRecord.h"
59 #include "VMTraps.h"
60 #include "Watchpoint.h"
61 #include <wtf/Bag.h>
62 #include <wtf/BumpPointerAllocator.h>
63 #include <wtf/DateMath.h>
64 #include <wtf/Deque.h>
65 #include <wtf/DoublyLinkedList.h>
66 #include <wtf/Forward.h>
67 #include <wtf/HashMap.h>
68 #include <wtf/HashSet.h>
69 #include <wtf/StackBounds.h>
70 #include <wtf/Stopwatch.h>
71 #include <wtf/ThreadSafeRefCounted.h>
72 #include <wtf/ThreadSpecific.h>
73 #include <wtf/WTFThreadData.h>
74 #include <wtf/text/SymbolRegistry.h>
75 #include <wtf/text/WTFString.h>
76 #if ENABLE(REGEXP_TRACING)
77 #include <wtf/ListHashSet.h>
78 #endif
79
80 namespace WTF {
81 class SimpleStats;
82 } // namespace WTF
83 using WTF::SimpleStats;
84
85 namespace JSC {
86
87 class BuiltinExecutables;
88 class BytecodeIntrinsicRegistry;
89 class CodeBlock;
90 class CodeCache;
91 class CommonIdentifiers;
92 class CustomGetterSetter;
93 class ExecState;
94 class Exception;
95 class ExceptionScope;
96 class HandleStack;
97 class TypeProfiler;
98 class TypeProfilerLog;
99 class HasOwnPropertyCache;
100 class HeapProfiler;
101 class Identifier;
102 class Interpreter;
103 class JSCustomGetterSetterFunction;
104 class JSGlobalObject;
105 class JSObject;
106 class JSWebAssemblyInstance;
107 class LLIntOffsetsExtractor;
108 class NativeExecutable;
109 class RegExpCache;
110 class Register;
111 class RegisterAtOffsetList;
112 #if ENABLE(SAMPLING_PROFILER)
113 class SamplingProfiler;
114 #endif
115 class ShadowChicken;
116 class ScriptExecutable;
117 class SourceProvider;
118 class SourceProviderCache;
119 class StackFrame;
120 class Structure;
121 #if ENABLE(REGEXP_TRACING)
122 class RegExp;
123 #endif
124 class Symbol;
125 class TypedArrayController;
126 class UnlinkedCodeBlock;
127 class UnlinkedEvalCodeBlock;
128 class UnlinkedFunctionExecutable;
129 class UnlinkedProgramCodeBlock;
130 class UnlinkedModuleProgramCodeBlock;
131 class VirtualRegister;
132 class VMEntryScope;
133 class Watchdog;
134 class Watchpoint;
135 class WatchpointSet;
136
137 #if ENABLE(DFG_JIT)
138 namespace DFG {
139 class LongLivedState;
140 }
141 #endif // ENABLE(DFG_JIT)
142 #if ENABLE(FTL_JIT)
143 namespace FTL {
144 class Thunks;
145 }
146 #endif // ENABLE(FTL_JIT)
147 namespace CommonSlowPaths {
148 struct ArityCheckData;
149 }
150 namespace Profiler {
151 class Database;
152 }
153 namespace DOMJIT {
154 class Signature;
155 }
156 #if ENABLE(WEBASSEMBLY)
157 namespace Wasm {
158 class SignatureInformation;
159 }
160 #endif
161
162 struct HashTable;
163 struct Instruction;
164
165 struct LocalTimeOffsetCache {
166     LocalTimeOffsetCache()
167         : start(0.0)
168         , end(-1.0)
169         , increment(0.0)
170         , timeType(WTF::UTCTime)
171     {
172     }
173
174     void reset()
175     {
176         offset = LocalTimeOffset();
177         start = 0.0;
178         end = -1.0;
179         increment = 0.0;
180         timeType = WTF::UTCTime;
181     }
182
183     LocalTimeOffset offset;
184     double start;
185     double end;
186     double increment;
187     WTF::TimeType timeType;
188 };
189
190 class QueuedTask {
191     WTF_MAKE_NONCOPYABLE(QueuedTask);
192     WTF_MAKE_FAST_ALLOCATED;
193 public:
194     void run();
195
196     QueuedTask(VM& vm, JSGlobalObject* globalObject, Ref<Microtask>&& microtask)
197         : m_globalObject(vm, globalObject)
198         , m_microtask(WTFMove(microtask))
199     {
200     }
201
202 private:
203     Strong<JSGlobalObject> m_globalObject;
204     Ref<Microtask> m_microtask;
205 };
206
207 class ConservativeRoots;
208
209 #if COMPILER(MSVC)
210 #pragma warning(push)
211 #pragma warning(disable: 4200) // Disable "zero-sized array in struct/union" warning
212 #endif
213 struct ScratchBuffer {
214     ScratchBuffer()
215     {
216         u.m_activeLength = 0;
217     }
218
219     static ScratchBuffer* create(size_t size)
220     {
221         ScratchBuffer* result = new (fastMalloc(ScratchBuffer::allocationSize(size))) ScratchBuffer;
222
223         return result;
224     }
225
226     static size_t allocationSize(size_t bufferSize) { return sizeof(ScratchBuffer) + bufferSize; }
227     void setActiveLength(size_t activeLength) { u.m_activeLength = activeLength; }
228     size_t activeLength() const { return u.m_activeLength; };
229     size_t* activeLengthPtr() { return &u.m_activeLength; };
230     void* dataBuffer() { return m_buffer; }
231
232     union {
233         size_t m_activeLength;
234         double pad; // Make sure m_buffer is double aligned.
235     } u;
236 #if CPU(MIPS) && (defined WTF_MIPS_ARCH_REV && WTF_MIPS_ARCH_REV == 2)
237     void* m_buffer[0] __attribute__((aligned(8)));
238 #else
239     void* m_buffer[0];
240 #endif
241 };
242 #if COMPILER(MSVC)
243 #pragma warning(pop)
244 #endif
245
246 class VM : public ThreadSafeRefCounted<VM>, public DoublyLinkedListNode<VM> {
247 public:
248     // WebCore has a one-to-one mapping of threads to VMs;
249     // either create() or createLeaked() should only be called once
250     // on a thread, this is the 'default' VM (it uses the
251     // thread's default string uniquing table from wtfThreadData).
252     // API contexts created using the new context group aware interface
253     // create APIContextGroup objects which require less locking of JSC
254     // than the old singleton APIShared VM created for use by
255     // the original API.
256     enum VMType { Default, APIContextGroup, APIShared };
257
258     struct ClientData {
259         JS_EXPORT_PRIVATE virtual ~ClientData() = 0;
260     };
261
262     bool isSharedInstance() { return vmType == APIShared; }
263     bool usingAPI() { return vmType != Default; }
264     JS_EXPORT_PRIVATE static bool sharedInstanceExists();
265     JS_EXPORT_PRIVATE static VM& sharedInstance();
266
267     JS_EXPORT_PRIVATE static Ref<VM> create(HeapType = SmallHeap);
268     JS_EXPORT_PRIVATE static Ref<VM> createLeaked(HeapType = SmallHeap);
269     static Ref<VM> createContextGroup(HeapType = SmallHeap);
270     JS_EXPORT_PRIVATE ~VM();
271
272     JS_EXPORT_PRIVATE Watchdog& ensureWatchdog();
273     Watchdog* watchdog() { return m_watchdog.get(); }
274
275     HeapProfiler* heapProfiler() const { return m_heapProfiler.get(); }
276     JS_EXPORT_PRIVATE HeapProfiler& ensureHeapProfiler();
277
278 #if ENABLE(SAMPLING_PROFILER)
279     SamplingProfiler* samplingProfiler() { return m_samplingProfiler.get(); }
280     JS_EXPORT_PRIVATE SamplingProfiler& ensureSamplingProfiler(RefPtr<Stopwatch>&&);
281 #endif
282
283 private:
284     RefPtr<JSLock> m_apiLock;
285
286 public:
287 #if ENABLE(ASSEMBLER)
288     // executableAllocator should be destructed after the heap, as the heap can call executableAllocator
289     // in its destructor.
290     ExecutableAllocator executableAllocator;
291 #endif
292
293     // The heap should be just after executableAllocator and before other members to ensure that it's
294     // destructed after all the objects that reference it.
295     Heap heap;
296     
297     Subspace auxiliarySpace;
298     
299     // Whenever possible, use subspaceFor<CellType>(vm) to get one of these subspaces.
300     Subspace cellSpace;
301     Subspace destructibleCellSpace;
302     JSStringSubspace stringSpace;
303     JSDestructibleObjectSubspace destructibleObjectSpace;
304     JSSegmentedVariableObjectSubspace segmentedVariableObjectSpace;
305
306 #if ENABLE(DFG_JIT)
307     std::unique_ptr<DFG::LongLivedState> dfgState;
308 #endif // ENABLE(DFG_JIT)
309
310     VMType vmType;
311     ClientData* clientData;
312     VMEntryFrame* topVMEntryFrame;
313     // NOTE: When throwing an exception while rolling back the call frame, this may be equal to
314     // topVMEntryFrame.
315     // FIXME: This should be a void*, because it might not point to a CallFrame.
316     // https://bugs.webkit.org/show_bug.cgi?id=160441
317     ExecState* topCallFrame;
318     JSWebAssemblyInstance* topJSWebAssemblyInstance;
319     Strong<Structure> structureStructure;
320     Strong<Structure> structureRareDataStructure;
321     Strong<Structure> terminatedExecutionErrorStructure;
322     Strong<Structure> stringStructure;
323     Strong<Structure> propertyNameIteratorStructure;
324     Strong<Structure> propertyNameEnumeratorStructure;
325     Strong<Structure> customGetterSetterStructure;
326     Strong<Structure> scopedArgumentsTableStructure;
327     Strong<Structure> apiWrapperStructure;
328     Strong<Structure> JSScopeStructure;
329     Strong<Structure> executableStructure;
330     Strong<Structure> nativeExecutableStructure;
331     Strong<Structure> evalExecutableStructure;
332     Strong<Structure> programExecutableStructure;
333     Strong<Structure> functionExecutableStructure;
334 #if ENABLE(WEBASSEMBLY)
335     Strong<Structure> webAssemblyCalleeStructure;
336     Strong<Structure> webAssemblyToJSCalleeStructure;
337     Strong<JSCell> webAssemblyToJSCallee;
338 #endif
339     Strong<Structure> moduleProgramExecutableStructure;
340     Strong<Structure> regExpStructure;
341     Strong<Structure> symbolStructure;
342     Strong<Structure> symbolTableStructure;
343     Strong<Structure> fixedArrayStructure;
344     Strong<Structure> sourceCodeStructure;
345     Strong<Structure> scriptFetcherStructure;
346     Strong<Structure> structureChainStructure;
347     Strong<Structure> sparseArrayValueMapStructure;
348     Strong<Structure> templateRegistryKeyStructure;
349     Strong<Structure> arrayBufferNeuteringWatchpointStructure;
350     Strong<Structure> unlinkedFunctionExecutableStructure;
351     Strong<Structure> unlinkedProgramCodeBlockStructure;
352     Strong<Structure> unlinkedEvalCodeBlockStructure;
353     Strong<Structure> unlinkedFunctionCodeBlockStructure;
354     Strong<Structure> unlinkedModuleProgramCodeBlockStructure;
355     Strong<Structure> propertyTableStructure;
356     Strong<Structure> weakMapDataStructure;
357     Strong<Structure> inferredValueStructure;
358     Strong<Structure> inferredTypeStructure;
359     Strong<Structure> inferredTypeTableStructure;
360     Strong<Structure> functionRareDataStructure;
361     Strong<Structure> exceptionStructure;
362     Strong<Structure> promiseDeferredStructure;
363     Strong<Structure> internalPromiseDeferredStructure;
364     Strong<Structure> nativeStdFunctionCellStructure;
365     Strong<Structure> programCodeBlockStructure;
366     Strong<Structure> moduleProgramCodeBlockStructure;
367     Strong<Structure> evalCodeBlockStructure;
368     Strong<Structure> functionCodeBlockStructure;
369     Strong<Structure> hashMapBucketSetStructure;
370     Strong<Structure> hashMapBucketMapStructure;
371     Strong<Structure> hashMapImplSetStructure;
372     Strong<Structure> hashMapImplMapStructure;
373
374     Strong<JSCell> iterationTerminator;
375     Strong<JSCell> emptyPropertyNameEnumerator;
376
377 #if ENABLE(WEBASSEMBLY)
378     std::once_flag m_wasmSignatureInformationOnceFlag;
379     std::unique_ptr<Wasm::SignatureInformation> m_wasmSignatureInformation;
380 #endif
381     
382     JSCell* currentlyDestructingCallbackObject;
383     const ClassInfo* currentlyDestructingCallbackObjectClassInfo;
384
385     AtomicStringTable* m_atomicStringTable;
386     WTF::SymbolRegistry m_symbolRegistry;
387     TemplateRegistryKeyTable m_templateRegistryKeytable;
388     CommonIdentifiers* propertyNames;
389     const ArgList* emptyList;
390     SmallStrings smallStrings;
391     NumericStrings numericStrings;
392     DateInstanceCache dateInstanceCache;
393     std::unique_ptr<SimpleStats> machineCodeBytesPerBytecodeWordForBaselineJIT;
394     WeakGCMap<std::pair<CustomGetterSetter*, int>, JSCustomGetterSetterFunction> customGetterSetterFunctionMap;
395     WeakGCMap<StringImpl*, JSString, PtrHash<StringImpl*>> stringCache;
396     Strong<JSString> lastCachedString;
397
398     AtomicStringTable* atomicStringTable() const { return m_atomicStringTable; }
399     WTF::SymbolRegistry& symbolRegistry() { return m_symbolRegistry; }
400
401     TemplateRegistryKeyTable& templateRegistryKeyTable() { return m_templateRegistryKeytable; }
402
403     WeakGCMap<SymbolImpl*, Symbol, PtrHash<SymbolImpl*>> symbolImplToSymbolMap;
404
405     enum class DeletePropertyMode {
406         // Default behaviour of deleteProperty, matching the spec.
407         Default,
408         // This setting causes deleteProperty to force deletion of all
409         // properties including those that are non-configurable (DontDelete).
410         IgnoreConfigurable
411     };
412
413     DeletePropertyMode deletePropertyMode()
414     {
415         return m_deletePropertyMode;
416     }
417
418     class DeletePropertyModeScope {
419     public:
420         DeletePropertyModeScope(VM& vm, DeletePropertyMode mode)
421             : m_vm(vm)
422             , m_previousMode(vm.m_deletePropertyMode)
423         {
424             m_vm.m_deletePropertyMode = mode;
425         }
426
427         ~DeletePropertyModeScope()
428         {
429             m_vm.m_deletePropertyMode = m_previousMode;
430         }
431
432     private:
433         VM& m_vm;
434         DeletePropertyMode m_previousMode;
435     };
436
437 #if ENABLE(JIT)
438     bool canUseJIT() { return m_canUseJIT; }
439 #else
440     bool canUseJIT() { return false; } // interpreter only
441 #endif
442
443 #if ENABLE(YARR_JIT)
444     bool canUseRegExpJIT() { return m_canUseRegExpJIT; }
445 #else
446     bool canUseRegExpJIT() { return false; } // interpreter only
447 #endif
448
449     SourceProviderCache* addSourceProviderCache(SourceProvider*);
450     void clearSourceProviderCaches();
451
452     PrototypeMap prototypeMap;
453
454     typedef HashMap<RefPtr<SourceProvider>, RefPtr<SourceProviderCache>> SourceProviderCacheMap;
455     SourceProviderCacheMap sourceProviderCacheMap;
456     Interpreter* interpreter;
457 #if ENABLE(JIT)
458     std::unique_ptr<JITThunks> jitStubs;
459     MacroAssemblerCodeRef getCTIStub(ThunkGenerator generator)
460     {
461         return jitStubs->ctiStub(this, generator);
462     }
463     
464     std::unique_ptr<RegisterAtOffsetList> allCalleeSaveRegisterOffsets;
465     
466     RegisterAtOffsetList* getAllCalleeSaveRegisterOffsets() { return allCalleeSaveRegisterOffsets.get(); }
467
468 #endif // ENABLE(JIT)
469     std::unique_ptr<CommonSlowPaths::ArityCheckData> arityCheckData;
470 #if ENABLE(FTL_JIT)
471     std::unique_ptr<FTL::Thunks> ftlThunks;
472 #endif
473     NativeExecutable* getHostFunction(NativeFunction, NativeFunction constructor, const String& name);
474     NativeExecutable* getHostFunction(NativeFunction, Intrinsic, NativeFunction constructor, const DOMJIT::Signature*, const String& name);
475
476     static ptrdiff_t exceptionOffset()
477     {
478         return OBJECT_OFFSETOF(VM, m_exception);
479     }
480
481     static ptrdiff_t callFrameForCatchOffset()
482     {
483         return OBJECT_OFFSETOF(VM, callFrameForCatch);
484     }
485
486     static ptrdiff_t targetMachinePCForThrowOffset()
487     {
488         return OBJECT_OFFSETOF(VM, targetMachinePCForThrow);
489     }
490
491     void restorePreviousException(Exception* exception) { setException(exception); }
492
493     void clearLastException() { m_lastException = nullptr; }
494
495     ExecState** addressOfCallFrameForCatch() { return &callFrameForCatch; }
496
497     JSCell** addressOfException() { return reinterpret_cast<JSCell**>(&m_exception); }
498
499     Exception* lastException() const { return m_lastException; }
500     JSCell** addressOfLastException() { return reinterpret_cast<JSCell**>(&m_lastException); }
501
502     void setFailNextNewCodeBlock() { m_failNextNewCodeBlock = true; }
503     bool getAndClearFailNextNewCodeBlock()
504     {
505         bool result = m_failNextNewCodeBlock;
506         m_failNextNewCodeBlock = false;
507         return result;
508     }
509     
510     ALWAYS_INLINE Structure* getStructure(StructureID id)
511     {
512         return heap.structureIDTable().get(decontaminate(id));
513     }
514     
515     void* stackPointerAtVMEntry() const { return m_stackPointerAtVMEntry; }
516     void setStackPointerAtVMEntry(void*);
517
518     size_t softReservedZoneSize() const { return m_currentSoftReservedZoneSize; }
519     size_t updateSoftReservedZoneSize(size_t softReservedZoneSize);
520     
521     static size_t committedStackByteCount();
522     inline bool ensureStackCapacityFor(Register* newTopOfStack);
523
524     void* stackLimit() { return m_stackLimit; }
525     void* softStackLimit() { return m_softStackLimit; }
526     void** addressOfSoftStackLimit() { return &m_softStackLimit; }
527 #if !ENABLE(JIT)
528     void* cloopStackLimit() { return m_cloopStackLimit; }
529     void setCLoopStackLimit(void* limit) { m_cloopStackLimit = limit; }
530 #endif
531
532     inline bool isSafeToRecurseSoft() const;
533     bool isSafeToRecurse() const
534     {
535         return isSafeToRecurse(m_stackLimit);
536     }
537
538     void* lastStackTop() { return m_lastStackTop; }
539     void setLastStackTop(void*);
540
541     const ClassInfo* const jsArrayClassInfo;
542     const ClassInfo* const jsFinalObjectClassInfo;
543
544     JSValue hostCallReturnValue;
545     unsigned varargsLength;
546     ExecState* newCallFrameReturnValue;
547     ExecState* callFrameForCatch;
548     void* targetMachinePCForThrow;
549     Instruction* targetInterpreterPCForThrow;
550     uint32_t osrExitIndex;
551     void* osrExitJumpDestination;
552     Vector<ScratchBuffer*> scratchBuffers;
553     size_t sizeOfLastScratchBuffer;
554
555     bool isExecutingInRegExpJIT { false };
556
557     ScratchBuffer* scratchBufferForSize(size_t size)
558     {
559         if (!size)
560             return 0;
561
562         if (size > sizeOfLastScratchBuffer) {
563             // Protect against a N^2 memory usage pathology by ensuring
564             // that at worst, we get a geometric series, meaning that the
565             // total memory usage is somewhere around
566             // max(scratch buffer size) * 4.
567             sizeOfLastScratchBuffer = size * 2;
568
569             ScratchBuffer* newBuffer = ScratchBuffer::create(sizeOfLastScratchBuffer);
570             RELEASE_ASSERT(newBuffer);
571             scratchBuffers.append(newBuffer);
572         }
573
574         ScratchBuffer* result = scratchBuffers.last();
575         result->setActiveLength(0);
576         return result;
577     }
578
579     EncodedJSValue* exceptionFuzzingBuffer(size_t size)
580     {
581         ASSERT(Options::useExceptionFuzz());
582         if (!m_exceptionFuzzBuffer)
583             m_exceptionFuzzBuffer = MallocPtr<EncodedJSValue>::malloc(size);
584         return m_exceptionFuzzBuffer.get();
585     }
586
587     void gatherConservativeRoots(ConservativeRoots&);
588
589     VMEntryScope* entryScope;
590
591     JSObject* stringRecursionCheckFirstObject { nullptr };
592     HashSet<JSObject*> stringRecursionCheckVisitedObjects;
593
594     LocalTimeOffsetCache localTimeOffsetCache;
595
596     String cachedDateString;
597     double cachedDateStringValue;
598
599     std::unique_ptr<Profiler::Database> m_perBytecodeProfiler;
600     RefPtr<TypedArrayController> m_typedArrayController;
601     RegExpCache* m_regExpCache;
602     BumpPointerAllocator m_regExpAllocator;
603     ConcurrentJSLock m_regExpAllocatorLock;
604
605     std::unique_ptr<HasOwnPropertyCache> m_hasOwnPropertyCache;
606     ALWAYS_INLINE HasOwnPropertyCache* hasOwnPropertyCache() { return m_hasOwnPropertyCache.get(); }
607     HasOwnPropertyCache* ensureHasOwnPropertyCache();
608
609 #if ENABLE(REGEXP_TRACING)
610     typedef ListHashSet<RegExp*> RTTraceList;
611     RTTraceList* m_rtTraceList;
612 #endif
613
614     JS_EXPORT_PRIVATE void resetDateCache();
615
616     RegExpCache* regExpCache() { return m_regExpCache; }
617 #if ENABLE(REGEXP_TRACING)
618     void addRegExpToTrace(RegExp*);
619 #endif
620     JS_EXPORT_PRIVATE void dumpRegExpTrace();
621
622     bool isCollectorBusyOnCurrentThread() { return heap.isCurrentThreadBusy(); }
623
624 #if ENABLE(GC_VALIDATION)
625     bool isInitializingObject() const; 
626     void setInitializingObjectClass(const ClassInfo*);
627 #endif
628
629     bool currentThreadIsHoldingAPILock() const { return m_apiLock->currentThreadIsHoldingLock(); }
630
631     JSLock& apiLock() { return *m_apiLock; }
632     CodeCache* codeCache() { return m_codeCache.get(); }
633
634     JS_EXPORT_PRIVATE void whenIdle(std::function<void()>);
635
636     JS_EXPORT_PRIVATE void deleteAllCode(DeleteAllCodeEffort);
637     JS_EXPORT_PRIVATE void deleteAllLinkedCode(DeleteAllCodeEffort);
638
639     WatchpointSet* ensureWatchpointSetForImpureProperty(const Identifier&);
640     void registerWatchpointForImpureProperty(const Identifier&, Watchpoint*);
641     
642     // FIXME: Use AtomicString once it got merged with Identifier.
643     JS_EXPORT_PRIVATE void addImpureProperty(const String&);
644
645     BuiltinExecutables* builtinExecutables() { return m_builtinExecutables.get(); }
646
647     bool enableTypeProfiler();
648     bool disableTypeProfiler();
649     TypeProfilerLog* typeProfilerLog() { return m_typeProfilerLog.get(); }
650     TypeProfiler* typeProfiler() { return m_typeProfiler.get(); }
651     JS_EXPORT_PRIVATE void dumpTypeProfilerData();
652
653     FunctionHasExecutedCache* functionHasExecutedCache() { return &m_functionHasExecutedCache; }
654
655     ControlFlowProfiler* controlFlowProfiler() { return m_controlFlowProfiler.get(); }
656     bool enableControlFlowProfiler();
657     bool disableControlFlowProfiler();
658
659     JS_EXPORT_PRIVATE void queueMicrotask(JSGlobalObject*, Ref<Microtask>&&);
660     JS_EXPORT_PRIVATE void drainMicrotasks();
661     void setGlobalConstRedeclarationShouldThrow(bool globalConstRedeclarationThrow) { m_globalConstRedeclarationShouldThrow = globalConstRedeclarationThrow; }
662     ALWAYS_INLINE bool globalConstRedeclarationShouldThrow() const { return m_globalConstRedeclarationShouldThrow; }
663
664     void setShouldBuildPCToCodeOriginMapping() { m_shouldBuildPCToCodeOriginMapping = true; }
665     bool shouldBuilderPCToCodeOriginMapping() const { return m_shouldBuildPCToCodeOriginMapping; }
666
667     BytecodeIntrinsicRegistry& bytecodeIntrinsicRegistry() { return *m_bytecodeIntrinsicRegistry; }
668     
669     ShadowChicken& shadowChicken() { return *m_shadowChicken; }
670     
671     template<typename Func>
672     void logEvent(CodeBlock*, const char* summary, const Func& func);
673
674     void handleTraps(ExecState*);
675
676     bool needTrapHandling() { return m_traps.needTrapHandling(); }
677     void* needTrapHandlingAddress() { return m_traps.needTrapHandlingAddress(); }
678
679     void notifyNeedTermination() { m_traps.fireTrap(VMTraps::NeedTermination); }
680     void notifyNeedWatchdogCheck() { m_traps.fireTrap(VMTraps::NeedWatchdogCheck); }
681
682     bool needAsynchronousTerminationSupport() const { return m_needAsynchronousTerminationSupport; }
683     void setNeedAsynchronousTerminationSupport() { m_needAsynchronousTerminationSupport = true; }
684
685 private:
686     friend class LLIntOffsetsExtractor;
687
688     VM(VMType, HeapType);
689     static VM*& sharedInstanceInternal();
690     void createNativeThunk();
691
692     void updateStackLimits();
693
694     bool isSafeToRecurse(void* stackLimit) const
695     {
696         ASSERT(wtfThreadData().stack().isGrowingDownward());
697         void* curr = reinterpret_cast<void*>(&curr);
698         return curr >= stackLimit;
699     }
700
701     void setException(Exception* exception)
702     {
703         m_exception = exception;
704         m_lastException = exception;
705     }
706     Exception* exception() const
707     {
708 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
709         m_needExceptionCheck = false;
710 #endif
711         return m_exception;
712     }
713     void clearException()
714     {
715 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
716         m_needExceptionCheck = false;
717 #endif
718         m_exception = nullptr;
719     }
720
721 #if !ENABLE(JIT)    
722     bool ensureStackCapacityForCLoop(Register* newTopOfStack);
723     bool isSafeToRecurseSoftCLoop() const;
724 #endif // !ENABLE(JIT)
725
726     std::optional<PlatformThread> ownerThread() const { return m_apiLock->ownerThread(); }
727
728     JS_EXPORT_PRIVATE void throwException(ExecState*, Exception*);
729     JS_EXPORT_PRIVATE JSValue throwException(ExecState*, JSValue);
730     JS_EXPORT_PRIVATE JSObject* throwException(ExecState*, JSObject*);
731
732 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
733     void verifyExceptionCheckNeedIsSatisfied(unsigned depth, ExceptionEventLocation&);
734 #endif
735
736 #if ENABLE(ASSEMBLER)
737     bool m_canUseAssembler;
738 #endif
739 #if ENABLE(JIT)
740     bool m_canUseJIT;
741 #endif
742 #if ENABLE(YARR_JIT)
743     bool m_canUseRegExpJIT;
744 #endif
745 #if ENABLE(GC_VALIDATION)
746     const ClassInfo* m_initializingObjectClass;
747 #endif
748
749     void* m_stackPointerAtVMEntry;
750     size_t m_currentSoftReservedZoneSize;
751     void* m_stackLimit { nullptr };
752     void* m_softStackLimit { nullptr };
753 #if !ENABLE(JIT)
754     void* m_cloopStackLimit { nullptr };
755 #endif
756     void* m_lastStackTop;
757
758     Exception* m_exception { nullptr };
759     Exception* m_lastException { nullptr };
760 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
761     ExceptionScope* m_topExceptionScope { nullptr };
762     ExceptionEventLocation m_simulatedThrowPointLocation;
763     unsigned m_simulatedThrowPointRecursionDepth { 0 };
764     mutable bool m_needExceptionCheck { false };
765 #endif
766
767     bool m_failNextNewCodeBlock { false };
768     DeletePropertyMode m_deletePropertyMode { DeletePropertyMode::Default };
769     bool m_globalConstRedeclarationShouldThrow { true };
770     bool m_shouldBuildPCToCodeOriginMapping { false };
771     bool m_needAsynchronousTerminationSupport { false };
772     std::unique_ptr<CodeCache> m_codeCache;
773     std::unique_ptr<BuiltinExecutables> m_builtinExecutables;
774     HashMap<String, RefPtr<WatchpointSet>> m_impurePropertyWatchpointSets;
775     std::unique_ptr<TypeProfiler> m_typeProfiler;
776     std::unique_ptr<TypeProfilerLog> m_typeProfilerLog;
777     unsigned m_typeProfilerEnabledCount;
778     FunctionHasExecutedCache m_functionHasExecutedCache;
779     std::unique_ptr<ControlFlowProfiler> m_controlFlowProfiler;
780     unsigned m_controlFlowProfilerEnabledCount;
781     Deque<std::unique_ptr<QueuedTask>> m_microtaskQueue;
782     MallocPtr<EncodedJSValue> m_exceptionFuzzBuffer;
783     VMTraps m_traps;
784     RefPtr<Watchdog> m_watchdog;
785     std::unique_ptr<HeapProfiler> m_heapProfiler;
786 #if ENABLE(SAMPLING_PROFILER)
787     RefPtr<SamplingProfiler> m_samplingProfiler;
788 #endif
789     std::unique_ptr<ShadowChicken> m_shadowChicken;
790     std::unique_ptr<BytecodeIntrinsicRegistry> m_bytecodeIntrinsicRegistry;
791
792     VM* m_prev; // Required by DoublyLinkedListNode.
793     VM* m_next; // Required by DoublyLinkedListNode.
794
795     // Friends for exception checking purpose only.
796     friend class Heap;
797     friend class CatchScope;
798     friend class ExceptionScope;
799     friend class ThrowScope;
800     friend class WTF::DoublyLinkedListNode<VM>;
801 };
802
803 #if ENABLE(GC_VALIDATION)
804 inline bool VM::isInitializingObject() const
805 {
806     return !!m_initializingObjectClass;
807 }
808
809 inline void VM::setInitializingObjectClass(const ClassInfo* initializingObjectClass)
810 {
811     m_initializingObjectClass = initializingObjectClass;
812 }
813 #endif
814
815 inline Heap* WeakSet::heap() const
816 {
817     return &m_vm->heap;
818 }
819
820 #if ENABLE(JIT)
821 extern "C" void sanitizeStackForVMImpl(VM*);
822 #endif
823
824 void sanitizeStackForVM(VM*);
825 void logSanitizeStack(VM*);
826
827 } // namespace JSC