26508645b22ea4465ff5a5e1eada509dfb70c689
[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 "JSWebAssemblyCodeBlockSubspace.h"
48 #include "MacroAssemblerCodeRef.h"
49 #include "Microtask.h"
50 #include "NumericStrings.h"
51 #include "SmallStrings.h"
52 #include "Strong.h"
53 #include "StructureCache.h"
54 #include "Subspace.h"
55 #include "TemplateRegistryKeyTable.h"
56 #include "VMEntryRecord.h"
57 #include "VMTraps.h"
58 #include "WasmContext.h"
59 #include "Watchpoint.h"
60 #include <wtf/BumpPointerAllocator.h>
61 #include <wtf/CheckedArithmetic.h>
62 #include <wtf/DateMath.h>
63 #include <wtf/Deque.h>
64 #include <wtf/DoublyLinkedList.h>
65 #include <wtf/Forward.h>
66 #include <wtf/Gigacage.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/text/SymbolRegistry.h>
74 #include <wtf/text/WTFString.h>
75 #if ENABLE(REGEXP_TRACING)
76 #include <wtf/ListHashSet.h>
77 #endif
78
79 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
80 #include <wtf/StackTrace.h>
81 #endif
82
83 namespace WTF {
84 class SimpleStats;
85 } // namespace WTF
86 using WTF::SimpleStats;
87
88 namespace JSC {
89
90 class BuiltinExecutables;
91 class BytecodeIntrinsicRegistry;
92 class CodeBlock;
93 class CodeCache;
94 class CommonIdentifiers;
95 class CustomGetterSetter;
96 class DOMAttributeGetterSetter;
97 class ExecState;
98 class Exception;
99 class ExceptionScope;
100 class FastMallocAlignedMemoryAllocator;
101 class GigacageAlignedMemoryAllocator;
102 class HandleStack;
103 class TypeProfiler;
104 class TypeProfilerLog;
105 class HasOwnPropertyCache;
106 class HeapProfiler;
107 class Identifier;
108 class Interpreter;
109 class JSCustomGetterSetterFunction;
110 class JSGlobalObject;
111 class JSObject;
112 class JSRunLoopTimer;
113 class JSWebAssemblyInstance;
114 class LLIntOffsetsExtractor;
115 class NativeExecutable;
116 class PromiseDeferredTimer;
117 class RegExpCache;
118 class Register;
119 class RegisterAtOffsetList;
120 #if ENABLE(SAMPLING_PROFILER)
121 class SamplingProfiler;
122 #endif
123 class ShadowChicken;
124 class ScriptExecutable;
125 class SourceProvider;
126 class SourceProviderCache;
127 class StackFrame;
128 class Structure;
129 #if ENABLE(REGEXP_TRACING)
130 class RegExp;
131 #endif
132 class Symbol;
133 class TypedArrayController;
134 class UnlinkedCodeBlock;
135 class UnlinkedEvalCodeBlock;
136 class UnlinkedFunctionExecutable;
137 class UnlinkedProgramCodeBlock;
138 class UnlinkedModuleProgramCodeBlock;
139 class VirtualRegister;
140 class VMEntryScope;
141 class Watchdog;
142 class Watchpoint;
143 class WatchpointSet;
144
145 #if ENABLE(FTL_JIT)
146 namespace FTL {
147 class Thunks;
148 }
149 #endif // ENABLE(FTL_JIT)
150 namespace CommonSlowPaths {
151 struct ArityCheckData;
152 }
153 namespace Profiler {
154 class Database;
155 }
156 namespace DOMJIT {
157 class Signature;
158 }
159
160 struct HashTable;
161 struct Instruction;
162
163 struct LocalTimeOffsetCache {
164     LocalTimeOffsetCache()
165         : start(0.0)
166         , end(-1.0)
167         , increment(0.0)
168         , timeType(WTF::UTCTime)
169     {
170     }
171
172     void reset()
173     {
174         offset = LocalTimeOffset();
175         start = 0.0;
176         end = -1.0;
177         increment = 0.0;
178         timeType = WTF::UTCTime;
179     }
180
181     LocalTimeOffset offset;
182     double start;
183     double end;
184     double increment;
185     WTF::TimeType timeType;
186 };
187
188 class QueuedTask {
189     WTF_MAKE_NONCOPYABLE(QueuedTask);
190     WTF_MAKE_FAST_ALLOCATED;
191 public:
192     void run();
193
194     QueuedTask(VM& vm, JSGlobalObject* globalObject, Ref<Microtask>&& microtask)
195         : m_globalObject(vm, globalObject)
196         , m_microtask(WTFMove(microtask))
197     {
198     }
199
200 private:
201     Strong<JSGlobalObject> m_globalObject;
202     Ref<Microtask> m_microtask;
203 };
204
205 class ConservativeRoots;
206
207 #if COMPILER(MSVC)
208 #pragma warning(push)
209 #pragma warning(disable: 4200) // Disable "zero-sized array in struct/union" warning
210 #endif
211 struct ScratchBuffer {
212     ScratchBuffer()
213     {
214         u.m_activeLength = 0;
215     }
216
217     static ScratchBuffer* create(size_t size)
218     {
219         ScratchBuffer* result = new (fastMalloc(ScratchBuffer::allocationSize(size))) ScratchBuffer;
220
221         return result;
222     }
223
224     static size_t allocationSize(Checked<size_t> bufferSize) { return (sizeof(ScratchBuffer) + bufferSize).unsafeGet(); }
225     void setActiveLength(size_t activeLength) { u.m_activeLength = activeLength; }
226     size_t activeLength() const { return u.m_activeLength; };
227     size_t* addressOfActiveLength() { return &u.m_activeLength; };
228     void* dataBuffer() { return m_buffer; }
229
230     union {
231         size_t m_activeLength;
232         double pad; // Make sure m_buffer is double aligned.
233     } u;
234 #if CPU(MIPS) && (defined WTF_MIPS_ARCH_REV && WTF_MIPS_ARCH_REV == 2)
235     void* m_buffer[0] __attribute__((aligned(8)));
236 #else
237     void* m_buffer[0];
238 #endif
239 };
240 #if COMPILER(MSVC)
241 #pragma warning(pop)
242 #endif
243
244 class VM : public ThreadSafeRefCounted<VM>, public DoublyLinkedListNode<VM> {
245 public:
246     // WebCore has a one-to-one mapping of threads to VMs;
247     // either create() or createLeaked() should only be called once
248     // on a thread, this is the 'default' VM (it uses the
249     // thread's default string uniquing table from Thread::current()).
250     // API contexts created using the new context group aware interface
251     // create APIContextGroup objects which require less locking of JSC
252     // than the old singleton APIShared VM created for use by
253     // the original API.
254     enum VMType { Default, APIContextGroup, APIShared };
255
256     struct ClientData {
257         JS_EXPORT_PRIVATE virtual ~ClientData() = 0;
258     };
259
260     bool isSharedInstance() { return vmType == APIShared; }
261     bool usingAPI() { return vmType != Default; }
262     JS_EXPORT_PRIVATE static bool sharedInstanceExists();
263     JS_EXPORT_PRIVATE static VM& sharedInstance();
264
265     JS_EXPORT_PRIVATE static Ref<VM> create(HeapType = SmallHeap);
266     JS_EXPORT_PRIVATE static Ref<VM> createLeaked(HeapType = SmallHeap);
267     static Ref<VM> createContextGroup(HeapType = SmallHeap);
268     JS_EXPORT_PRIVATE ~VM();
269
270     Watchdog& ensureWatchdog();
271     Watchdog* watchdog() { return m_watchdog.get(); }
272
273     HeapProfiler* heapProfiler() const { return m_heapProfiler.get(); }
274     JS_EXPORT_PRIVATE HeapProfiler& ensureHeapProfiler();
275
276 #if ENABLE(SAMPLING_PROFILER)
277     SamplingProfiler* samplingProfiler() { return m_samplingProfiler.get(); }
278     JS_EXPORT_PRIVATE SamplingProfiler& ensureSamplingProfiler(RefPtr<Stopwatch>&&);
279 #endif
280
281 private:
282     RefPtr<JSLock> m_apiLock;
283 #if USE(CF)
284     // These need to be initialized before heap below.
285     HashSet<JSRunLoopTimer*> m_runLoopTimers;
286     RetainPtr<CFRunLoopRef> m_runLoop;
287 #endif
288
289 public:
290     Heap heap;
291     
292     std::unique_ptr<FastMallocAlignedMemoryAllocator> fastMallocAllocator;
293     std::unique_ptr<GigacageAlignedMemoryAllocator> primitiveGigacageAllocator;
294     std::unique_ptr<GigacageAlignedMemoryAllocator> jsValueGigacageAllocator;
295     
296     Subspace primitiveGigacageAuxiliarySpace; // Typed arrays, strings, bitvectors, etc go here.
297     Subspace jsValueGigacageAuxiliarySpace; // Butterflies, arrays of JSValues, etc go here.
298
299     // We make cross-cutting assumptions about typed arrays being in the primitive Gigacage and butterflies
300     // being in the JSValue gigacage. For some types, it's super obvious where they should go, and so we
301     // can hardcode that fact. But sometimes it's not clear, so we abstract it by having a Gigacage::Kind
302     // constant somewhere.
303     // FIXME: Maybe it would be better if everyone abstracted this?
304     // https://bugs.webkit.org/show_bug.cgi?id=175248
305     ALWAYS_INLINE Subspace& gigacageAuxiliarySpace(Gigacage::Kind kind)
306     {
307         switch (kind) {
308         case Gigacage::Primitive:
309             return primitiveGigacageAuxiliarySpace;
310         case Gigacage::JSValue:
311             return jsValueGigacageAuxiliarySpace;
312         case Gigacage::String:
313             break;
314         }
315         RELEASE_ASSERT_NOT_REACHED();
316         return primitiveGigacageAuxiliarySpace;
317     }
318     
319     // Whenever possible, use subspaceFor<CellType>(vm) to get one of these subspaces.
320     Subspace cellSpace;
321     Subspace jsValueGigacageCellSpace;
322     Subspace destructibleCellSpace;
323     JSStringSubspace stringSpace;
324     JSDestructibleObjectSubspace destructibleObjectSpace;
325     JSDestructibleObjectSubspace eagerlySweptDestructibleObjectSpace;
326     JSSegmentedVariableObjectSubspace segmentedVariableObjectSpace;
327 #if ENABLE(WEBASSEMBLY)
328     JSWebAssemblyCodeBlockSubspace webAssemblyCodeBlockSpace;
329 #endif
330
331     VMType vmType;
332     ClientData* clientData;
333     EntryFrame* topEntryFrame;
334     // NOTE: When throwing an exception while rolling back the call frame, this may be equal to
335     // topEntryFrame.
336     // FIXME: This should be a void*, because it might not point to a CallFrame.
337     // https://bugs.webkit.org/show_bug.cgi?id=160441
338     ExecState* topCallFrame { nullptr };
339 #if ENABLE(WEBASSEMBLY)
340     Wasm::Context wasmContext;
341 #endif
342     Strong<Structure> structureStructure;
343     Strong<Structure> structureRareDataStructure;
344     Strong<Structure> terminatedExecutionErrorStructure;
345     Strong<Structure> stringStructure;
346     Strong<Structure> propertyNameIteratorStructure;
347     Strong<Structure> propertyNameEnumeratorStructure;
348     Strong<Structure> customGetterSetterStructure;
349     Strong<Structure> domAttributeGetterSetterStructure;
350     Strong<Structure> scopedArgumentsTableStructure;
351     Strong<Structure> apiWrapperStructure;
352     Strong<Structure> nativeExecutableStructure;
353     Strong<Structure> evalExecutableStructure;
354     Strong<Structure> programExecutableStructure;
355     Strong<Structure> functionExecutableStructure;
356 #if ENABLE(WEBASSEMBLY)
357     Strong<Structure> webAssemblyCodeBlockStructure;
358 #endif
359     Strong<Structure> moduleProgramExecutableStructure;
360     Strong<Structure> regExpStructure;
361     Strong<Structure> symbolStructure;
362     Strong<Structure> symbolTableStructure;
363     Strong<Structure> fixedArrayStructure;
364     Strong<Structure> sourceCodeStructure;
365     Strong<Structure> scriptFetcherStructure;
366     Strong<Structure> scriptFetchParametersStructure;
367     Strong<Structure> structureChainStructure;
368     Strong<Structure> sparseArrayValueMapStructure;
369     Strong<Structure> templateRegistryKeyStructure;
370     Strong<Structure> arrayBufferNeuteringWatchpointStructure;
371     Strong<Structure> unlinkedFunctionExecutableStructure;
372     Strong<Structure> unlinkedProgramCodeBlockStructure;
373     Strong<Structure> unlinkedEvalCodeBlockStructure;
374     Strong<Structure> unlinkedFunctionCodeBlockStructure;
375     Strong<Structure> unlinkedModuleProgramCodeBlockStructure;
376     Strong<Structure> propertyTableStructure;
377     Strong<Structure> inferredValueStructure;
378     Strong<Structure> inferredTypeStructure;
379     Strong<Structure> inferredTypeTableStructure;
380     Strong<Structure> functionRareDataStructure;
381     Strong<Structure> exceptionStructure;
382     Strong<Structure> promiseDeferredStructure;
383     Strong<Structure> internalPromiseDeferredStructure;
384     Strong<Structure> nativeStdFunctionCellStructure;
385     Strong<Structure> programCodeBlockStructure;
386     Strong<Structure> moduleProgramCodeBlockStructure;
387     Strong<Structure> evalCodeBlockStructure;
388     Strong<Structure> functionCodeBlockStructure;
389     Strong<Structure> hashMapBucketSetStructure;
390     Strong<Structure> hashMapBucketMapStructure;
391     Strong<Structure> setIteratorStructure;
392     Strong<Structure> mapIteratorStructure;
393
394     Strong<JSCell> emptyPropertyNameEnumerator;
395     Strong<JSCell> sentinelSetBucket;
396     Strong<JSCell> sentinelMapBucket;
397
398     std::unique_ptr<PromiseDeferredTimer> promiseDeferredTimer;
399     
400     JSCell* currentlyDestructingCallbackObject;
401     const ClassInfo* currentlyDestructingCallbackObjectClassInfo;
402
403     AtomicStringTable* m_atomicStringTable;
404     WTF::SymbolRegistry m_symbolRegistry;
405     TemplateRegistryKeyTable m_templateRegistryKeytable;
406     CommonIdentifiers* propertyNames;
407     const ArgList* emptyList;
408     SmallStrings smallStrings;
409     NumericStrings numericStrings;
410     DateInstanceCache dateInstanceCache;
411     std::unique_ptr<SimpleStats> machineCodeBytesPerBytecodeWordForBaselineJIT;
412     WeakGCMap<std::pair<CustomGetterSetter*, int>, JSCustomGetterSetterFunction> customGetterSetterFunctionMap;
413     WeakGCMap<StringImpl*, JSString, PtrHash<StringImpl*>> stringCache;
414     Strong<JSString> lastCachedString;
415
416     AtomicStringTable* atomicStringTable() const { return m_atomicStringTable; }
417     WTF::SymbolRegistry& symbolRegistry() { return m_symbolRegistry; }
418
419     TemplateRegistryKeyTable& templateRegistryKeyTable() { return m_templateRegistryKeytable; }
420
421     WeakGCMap<SymbolImpl*, Symbol, PtrHash<SymbolImpl*>> symbolImplToSymbolMap;
422
423     enum class DeletePropertyMode {
424         // Default behaviour of deleteProperty, matching the spec.
425         Default,
426         // This setting causes deleteProperty to force deletion of all
427         // properties including those that are non-configurable (DontDelete).
428         IgnoreConfigurable
429     };
430
431     DeletePropertyMode deletePropertyMode()
432     {
433         return m_deletePropertyMode;
434     }
435
436     class DeletePropertyModeScope {
437     public:
438         DeletePropertyModeScope(VM& vm, DeletePropertyMode mode)
439             : m_vm(vm)
440             , m_previousMode(vm.m_deletePropertyMode)
441         {
442             m_vm.m_deletePropertyMode = mode;
443         }
444
445         ~DeletePropertyModeScope()
446         {
447             m_vm.m_deletePropertyMode = m_previousMode;
448         }
449
450     private:
451         VM& m_vm;
452         DeletePropertyMode m_previousMode;
453     };
454
455 #if ENABLE(JIT)
456     bool canUseJIT() { return m_canUseJIT; }
457 #else
458     bool canUseJIT() { return false; } // interpreter only
459 #endif
460
461 #if ENABLE(YARR_JIT)
462     bool canUseRegExpJIT() { return m_canUseRegExpJIT; }
463 #else
464     bool canUseRegExpJIT() { return false; } // interpreter only
465 #endif
466
467     SourceProviderCache* addSourceProviderCache(SourceProvider*);
468     void clearSourceProviderCaches();
469
470     StructureCache structureCache;
471
472     typedef HashMap<RefPtr<SourceProvider>, RefPtr<SourceProviderCache>> SourceProviderCacheMap;
473     SourceProviderCacheMap sourceProviderCacheMap;
474     Interpreter* interpreter;
475 #if ENABLE(JIT)
476     std::unique_ptr<JITThunks> jitStubs;
477     MacroAssemblerCodeRef getCTIStub(ThunkGenerator generator)
478     {
479         return jitStubs->ctiStub(this, generator);
480     }
481
482 #endif // ENABLE(JIT)
483     std::unique_ptr<CommonSlowPaths::ArityCheckData> arityCheckData;
484 #if ENABLE(FTL_JIT)
485     std::unique_ptr<FTL::Thunks> ftlThunks;
486 #endif
487     NativeExecutable* getHostFunction(NativeFunction, NativeFunction constructor, const String& name);
488     NativeExecutable* getHostFunction(NativeFunction, Intrinsic, NativeFunction constructor, const DOMJIT::Signature*, const String& name);
489
490     static ptrdiff_t exceptionOffset()
491     {
492         return OBJECT_OFFSETOF(VM, m_exception);
493     }
494
495     static ptrdiff_t callFrameForCatchOffset()
496     {
497         return OBJECT_OFFSETOF(VM, callFrameForCatch);
498     }
499
500     static ptrdiff_t targetMachinePCForThrowOffset()
501     {
502         return OBJECT_OFFSETOF(VM, targetMachinePCForThrow);
503     }
504
505     static ptrdiff_t topEntryFrameOffset()
506     {
507         return OBJECT_OFFSETOF(VM, topEntryFrame);
508     }
509
510     void restorePreviousException(Exception* exception) { setException(exception); }
511
512     void clearLastException() { m_lastException = nullptr; }
513
514     ExecState** addressOfCallFrameForCatch() { return &callFrameForCatch; }
515
516     JSCell** addressOfException() { return reinterpret_cast<JSCell**>(&m_exception); }
517
518     Exception* lastException() const { return m_lastException; }
519     JSCell** addressOfLastException() { return reinterpret_cast<JSCell**>(&m_lastException); }
520
521     void setFailNextNewCodeBlock() { m_failNextNewCodeBlock = true; }
522     bool getAndClearFailNextNewCodeBlock()
523     {
524         bool result = m_failNextNewCodeBlock;
525         m_failNextNewCodeBlock = false;
526         return result;
527     }
528     
529     ALWAYS_INLINE Structure* getStructure(StructureID id)
530     {
531         return heap.structureIDTable().get(decontaminate(id));
532     }
533     
534     void* stackPointerAtVMEntry() const { return m_stackPointerAtVMEntry; }
535     void setStackPointerAtVMEntry(void*);
536
537     size_t softReservedZoneSize() const { return m_currentSoftReservedZoneSize; }
538     size_t updateSoftReservedZoneSize(size_t softReservedZoneSize);
539     
540     static size_t committedStackByteCount();
541     inline bool ensureStackCapacityFor(Register* newTopOfStack);
542
543     void* stackLimit() { return m_stackLimit; }
544     void* softStackLimit() { return m_softStackLimit; }
545     void** addressOfSoftStackLimit() { return &m_softStackLimit; }
546 #if !ENABLE(JIT)
547     void* cloopStackLimit() { return m_cloopStackLimit; }
548     void setCLoopStackLimit(void* limit) { m_cloopStackLimit = limit; }
549 #endif
550
551     inline bool isSafeToRecurseSoft() const;
552     bool isSafeToRecurse() const
553     {
554         return isSafeToRecurse(m_stackLimit);
555     }
556
557     void** addressOfLastStackTop() { return &m_lastStackTop; }
558     void* lastStackTop() { return m_lastStackTop; }
559     void setLastStackTop(void*);
560     
561     void firePrimitiveGigacageEnabledIfNecessary()
562     {
563         if (m_needToFirePrimitiveGigacageEnabled) {
564             m_needToFirePrimitiveGigacageEnabled = false;
565             m_primitiveGigacageEnabled.fireAll(*this, "Primitive gigacage disabled asynchronously");
566         }
567     }
568
569     JSValue hostCallReturnValue;
570     unsigned varargsLength;
571     ExecState* newCallFrameReturnValue;
572     ExecState* callFrameForCatch;
573     void* targetMachinePCForThrow;
574     Instruction* targetInterpreterPCForThrow;
575     uint32_t osrExitIndex;
576     void* osrExitJumpDestination;
577     bool isExecutingInRegExpJIT { false };
578
579     // The threading protocol here is as follows:
580     // - You can call scratchBufferForSize from any thread.
581     // - You can only set the ScratchBuffer's activeLength from the main thread.
582     ScratchBuffer* scratchBufferForSize(size_t size);
583
584     EncodedJSValue* exceptionFuzzingBuffer(size_t size)
585     {
586         ASSERT(Options::useExceptionFuzz());
587         if (!m_exceptionFuzzBuffer)
588             m_exceptionFuzzBuffer = MallocPtr<EncodedJSValue>::malloc(size);
589         return m_exceptionFuzzBuffer.get();
590     }
591
592     void gatherConservativeRoots(ConservativeRoots&);
593
594     VMEntryScope* entryScope;
595
596     JSObject* stringRecursionCheckFirstObject { nullptr };
597     HashSet<JSObject*> stringRecursionCheckVisitedObjects;
598
599     LocalTimeOffsetCache localTimeOffsetCache;
600
601     String cachedDateString;
602     double cachedDateStringValue;
603
604     std::unique_ptr<Profiler::Database> m_perBytecodeProfiler;
605     RefPtr<TypedArrayController> m_typedArrayController;
606     RegExpCache* m_regExpCache;
607     BumpPointerAllocator m_regExpAllocator;
608     ConcurrentJSLock m_regExpAllocatorLock;
609
610     std::unique_ptr<HasOwnPropertyCache> m_hasOwnPropertyCache;
611     ALWAYS_INLINE HasOwnPropertyCache* hasOwnPropertyCache() { return m_hasOwnPropertyCache.get(); }
612     HasOwnPropertyCache* ensureHasOwnPropertyCache();
613
614 #if ENABLE(REGEXP_TRACING)
615     typedef ListHashSet<RegExp*> RTTraceList;
616     RTTraceList* m_rtTraceList;
617 #endif
618
619     JS_EXPORT_PRIVATE void resetDateCache();
620
621     RegExpCache* regExpCache() { return m_regExpCache; }
622 #if ENABLE(REGEXP_TRACING)
623     void addRegExpToTrace(RegExp*);
624 #endif
625     JS_EXPORT_PRIVATE void dumpRegExpTrace();
626
627     bool isCollectorBusyOnCurrentThread() { return heap.isCurrentThreadBusy(); }
628
629 #if ENABLE(GC_VALIDATION)
630     bool isInitializingObject() const; 
631     void setInitializingObjectClass(const ClassInfo*);
632 #endif
633
634     bool currentThreadIsHoldingAPILock() const { return m_apiLock->currentThreadIsHoldingLock(); }
635
636     JSLock& apiLock() { return *m_apiLock; }
637     CodeCache* codeCache() { return m_codeCache.get(); }
638
639     JS_EXPORT_PRIVATE void whenIdle(std::function<void()>);
640
641     JS_EXPORT_PRIVATE void deleteAllCode(DeleteAllCodeEffort);
642     JS_EXPORT_PRIVATE void deleteAllLinkedCode(DeleteAllCodeEffort);
643
644     WatchpointSet* ensureWatchpointSetForImpureProperty(const Identifier&);
645     void registerWatchpointForImpureProperty(const Identifier&, Watchpoint*);
646     
647     // FIXME: Use AtomicString once it got merged with Identifier.
648     JS_EXPORT_PRIVATE void addImpureProperty(const String&);
649     
650     InlineWatchpointSet& primitiveGigacageEnabled() { return m_primitiveGigacageEnabled; }
651
652     BuiltinExecutables* builtinExecutables() { return m_builtinExecutables.get(); }
653
654     bool enableTypeProfiler();
655     bool disableTypeProfiler();
656     TypeProfilerLog* typeProfilerLog() { return m_typeProfilerLog.get(); }
657     TypeProfiler* typeProfiler() { return m_typeProfiler.get(); }
658     JS_EXPORT_PRIVATE void dumpTypeProfilerData();
659
660     FunctionHasExecutedCache* functionHasExecutedCache() { return &m_functionHasExecutedCache; }
661
662     ControlFlowProfiler* controlFlowProfiler() { return m_controlFlowProfiler.get(); }
663     bool enableControlFlowProfiler();
664     bool disableControlFlowProfiler();
665
666     void queueMicrotask(JSGlobalObject&, Ref<Microtask>&&);
667     JS_EXPORT_PRIVATE void drainMicrotasks();
668     void setGlobalConstRedeclarationShouldThrow(bool globalConstRedeclarationThrow) { m_globalConstRedeclarationShouldThrow = globalConstRedeclarationThrow; }
669     ALWAYS_INLINE bool globalConstRedeclarationShouldThrow() const { return m_globalConstRedeclarationShouldThrow; }
670
671     void setShouldBuildPCToCodeOriginMapping() { m_shouldBuildPCToCodeOriginMapping = true; }
672     bool shouldBuilderPCToCodeOriginMapping() const { return m_shouldBuildPCToCodeOriginMapping; }
673
674     BytecodeIntrinsicRegistry& bytecodeIntrinsicRegistry() { return *m_bytecodeIntrinsicRegistry; }
675     
676     ShadowChicken& shadowChicken() { return *m_shadowChicken; }
677     
678     template<typename Func>
679     void logEvent(CodeBlock*, const char* summary, const Func& func);
680
681     std::optional<RefPtr<Thread>> ownerThread() const { return m_apiLock->ownerThread(); }
682
683     VMTraps& traps() { return m_traps; }
684
685     void handleTraps(ExecState* exec, VMTraps::Mask mask = VMTraps::Mask::allEventTypes()) { m_traps.handleTraps(exec, mask); }
686
687     bool needTrapHandling() { return m_traps.needTrapHandling(); }
688     bool needTrapHandling(VMTraps::Mask mask) { return m_traps.needTrapHandling(mask); }
689     void* needTrapHandlingAddress() { return m_traps.needTrapHandlingAddress(); }
690
691     void notifyNeedDebuggerBreak() { m_traps.fireTrap(VMTraps::NeedDebuggerBreak); }
692     void notifyNeedTermination() { m_traps.fireTrap(VMTraps::NeedTermination); }
693     void notifyNeedWatchdogCheck() { m_traps.fireTrap(VMTraps::NeedWatchdogCheck); }
694
695 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
696     StackTrace* nativeStackTraceOfLastThrow() const { return m_nativeStackTraceOfLastThrow.get(); }
697     ThreadIdentifier throwingThread() const { return m_throwingThread; }
698 #endif
699
700 #if USE(CF)
701     CFRunLoopRef runLoop() const { return m_runLoop.get(); }
702     void registerRunLoopTimer(JSRunLoopTimer*);
703     void unregisterRunLoopTimer(JSRunLoopTimer*);
704     JS_EXPORT_PRIVATE void setRunLoop(CFRunLoopRef);
705 #endif // USE(CF)
706
707 private:
708     friend class LLIntOffsetsExtractor;
709
710     VM(VMType, HeapType);
711     static VM*& sharedInstanceInternal();
712     void createNativeThunk();
713
714     void updateStackLimits();
715
716     bool isSafeToRecurse(void* stackLimit) const
717     {
718         ASSERT(Thread::current().stack().isGrowingDownward());
719         void* curr = reinterpret_cast<void*>(&curr);
720         return curr >= stackLimit;
721     }
722
723     void setException(Exception* exception)
724     {
725         m_exception = exception;
726         m_lastException = exception;
727     }
728     Exception* exception() const
729     {
730 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
731         m_needExceptionCheck = false;
732 #endif
733         return m_exception;
734     }
735     void clearException()
736     {
737 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
738         m_needExceptionCheck = false;
739         m_nativeStackTraceOfLastThrow = nullptr;
740         m_throwingThread = 0;
741 #endif
742         m_exception = nullptr;
743     }
744
745 #if !ENABLE(JIT)    
746     bool ensureStackCapacityForCLoop(Register* newTopOfStack);
747     bool isSafeToRecurseSoftCLoop() const;
748 #endif // !ENABLE(JIT)
749
750     JS_EXPORT_PRIVATE void throwException(ExecState*, Exception*);
751     JS_EXPORT_PRIVATE JSValue throwException(ExecState*, JSValue);
752     JS_EXPORT_PRIVATE JSObject* throwException(ExecState*, JSObject*);
753
754 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
755     void verifyExceptionCheckNeedIsSatisfied(unsigned depth, ExceptionEventLocation&);
756 #endif
757     
758     static void primitiveGigacageDisabledCallback(void*);
759     void primitiveGigacageDisabled();
760
761 #if ENABLE(ASSEMBLER)
762     bool m_canUseAssembler;
763 #endif
764 #if ENABLE(JIT)
765     bool m_canUseJIT;
766 #endif
767 #if ENABLE(YARR_JIT)
768     bool m_canUseRegExpJIT;
769 #endif
770 #if ENABLE(GC_VALIDATION)
771     const ClassInfo* m_initializingObjectClass;
772 #endif
773
774     void* m_stackPointerAtVMEntry;
775     size_t m_currentSoftReservedZoneSize;
776     void* m_stackLimit { nullptr };
777     void* m_softStackLimit { nullptr };
778 #if !ENABLE(JIT)
779     void* m_cloopStackLimit { nullptr };
780 #endif
781     void* m_lastStackTop { nullptr };
782
783     Exception* m_exception { nullptr };
784     Exception* m_lastException { nullptr };
785 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
786     ExceptionScope* m_topExceptionScope { nullptr };
787     ExceptionEventLocation m_simulatedThrowPointLocation;
788     unsigned m_simulatedThrowPointRecursionDepth { 0 };
789     mutable bool m_needExceptionCheck { false };
790     std::unique_ptr<StackTrace> m_nativeStackTraceOfLastThrow;
791     std::unique_ptr<StackTrace> m_nativeStackTraceOfLastSimulatedThrow;
792     ThreadIdentifier m_throwingThread;
793 #endif
794
795     bool m_failNextNewCodeBlock { false };
796     DeletePropertyMode m_deletePropertyMode { DeletePropertyMode::Default };
797     bool m_globalConstRedeclarationShouldThrow { true };
798     bool m_shouldBuildPCToCodeOriginMapping { false };
799     std::unique_ptr<CodeCache> m_codeCache;
800     std::unique_ptr<BuiltinExecutables> m_builtinExecutables;
801     HashMap<String, RefPtr<WatchpointSet>> m_impurePropertyWatchpointSets;
802     std::unique_ptr<TypeProfiler> m_typeProfiler;
803     std::unique_ptr<TypeProfilerLog> m_typeProfilerLog;
804     unsigned m_typeProfilerEnabledCount;
805     bool m_needToFirePrimitiveGigacageEnabled { false };
806     Lock m_scratchBufferLock;
807     Vector<ScratchBuffer*> m_scratchBuffers;
808     size_t m_sizeOfLastScratchBuffer { 0 };
809     InlineWatchpointSet m_primitiveGigacageEnabled;
810     FunctionHasExecutedCache m_functionHasExecutedCache;
811     std::unique_ptr<ControlFlowProfiler> m_controlFlowProfiler;
812     unsigned m_controlFlowProfilerEnabledCount;
813     Deque<std::unique_ptr<QueuedTask>> m_microtaskQueue;
814     MallocPtr<EncodedJSValue> m_exceptionFuzzBuffer;
815     VMTraps m_traps;
816     RefPtr<Watchdog> m_watchdog;
817     std::unique_ptr<HeapProfiler> m_heapProfiler;
818 #if ENABLE(SAMPLING_PROFILER)
819     RefPtr<SamplingProfiler> m_samplingProfiler;
820 #endif
821     std::unique_ptr<ShadowChicken> m_shadowChicken;
822     std::unique_ptr<BytecodeIntrinsicRegistry> m_bytecodeIntrinsicRegistry;
823
824     VM* m_prev; // Required by DoublyLinkedListNode.
825     VM* m_next; // Required by DoublyLinkedListNode.
826
827     // Friends for exception checking purpose only.
828     friend class Heap;
829     friend class CatchScope;
830     friend class ExceptionScope;
831     friend class ThrowScope;
832     friend class VMTraps;
833     friend class WTF::DoublyLinkedListNode<VM>;
834 };
835
836 #if ENABLE(GC_VALIDATION)
837 inline bool VM::isInitializingObject() const
838 {
839     return !!m_initializingObjectClass;
840 }
841
842 inline void VM::setInitializingObjectClass(const ClassInfo* initializingObjectClass)
843 {
844     m_initializingObjectClass = initializingObjectClass;
845 }
846 #endif
847
848 inline Heap* WeakSet::heap() const
849 {
850     return &m_vm->heap;
851 }
852
853 #if ENABLE(JIT)
854 extern "C" void sanitizeStackForVMImpl(VM*);
855 #endif
856
857 void sanitizeStackForVM(VM*);
858 void logSanitizeStack(VM*);
859
860 } // namespace JSC