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