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