9fb4d8be42c1f78d1eb0e509dba293416f3bdf6d
[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/text/SymbolRegistry.h>
72 #include <wtf/text/WTFString.h>
73 #if ENABLE(REGEXP_TRACING)
74 #include <wtf/ListHashSet.h>
75 #endif
76
77 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
78 #include <wtf/StackTrace.h>
79 #endif
80
81 namespace WTF {
82 class SimpleStats;
83 } // namespace WTF
84 using WTF::SimpleStats;
85
86 namespace JSC {
87
88 class BuiltinExecutables;
89 class BytecodeIntrinsicRegistry;
90 class CodeBlock;
91 class CodeCache;
92 class CommonIdentifiers;
93 class CustomGetterSetter;
94 class DOMAttributeGetterSetter;
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 Thread::current()).
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> domAttributeGetterSetterStructure;
318     Strong<Structure> scopedArgumentsTableStructure;
319     Strong<Structure> apiWrapperStructure;
320     Strong<Structure> nativeExecutableStructure;
321     Strong<Structure> evalExecutableStructure;
322     Strong<Structure> programExecutableStructure;
323     Strong<Structure> functionExecutableStructure;
324 #if ENABLE(WEBASSEMBLY)
325     Strong<Structure> webAssemblyCodeBlockStructure;
326 #endif
327     Strong<Structure> moduleProgramExecutableStructure;
328     Strong<Structure> regExpStructure;
329     Strong<Structure> symbolStructure;
330     Strong<Structure> symbolTableStructure;
331     Strong<Structure> fixedArrayStructure;
332     Strong<Structure> sourceCodeStructure;
333     Strong<Structure> scriptFetcherStructure;
334     Strong<Structure> structureChainStructure;
335     Strong<Structure> sparseArrayValueMapStructure;
336     Strong<Structure> templateRegistryKeyStructure;
337     Strong<Structure> arrayBufferNeuteringWatchpointStructure;
338     Strong<Structure> unlinkedFunctionExecutableStructure;
339     Strong<Structure> unlinkedProgramCodeBlockStructure;
340     Strong<Structure> unlinkedEvalCodeBlockStructure;
341     Strong<Structure> unlinkedFunctionCodeBlockStructure;
342     Strong<Structure> unlinkedModuleProgramCodeBlockStructure;
343     Strong<Structure> propertyTableStructure;
344     Strong<Structure> weakMapDataStructure;
345     Strong<Structure> inferredValueStructure;
346     Strong<Structure> inferredTypeStructure;
347     Strong<Structure> inferredTypeTableStructure;
348     Strong<Structure> functionRareDataStructure;
349     Strong<Structure> exceptionStructure;
350     Strong<Structure> promiseDeferredStructure;
351     Strong<Structure> internalPromiseDeferredStructure;
352     Strong<Structure> nativeStdFunctionCellStructure;
353     Strong<Structure> programCodeBlockStructure;
354     Strong<Structure> moduleProgramCodeBlockStructure;
355     Strong<Structure> evalCodeBlockStructure;
356     Strong<Structure> functionCodeBlockStructure;
357     Strong<Structure> hashMapBucketSetStructure;
358     Strong<Structure> hashMapBucketMapStructure;
359
360     Strong<JSCell> emptyPropertyNameEnumerator;
361
362     std::unique_ptr<PromiseDeferredTimer> promiseDeferredTimer;
363     
364     JSCell* currentlyDestructingCallbackObject;
365     const ClassInfo* currentlyDestructingCallbackObjectClassInfo;
366
367     AtomicStringTable* m_atomicStringTable;
368     WTF::SymbolRegistry m_symbolRegistry;
369     TemplateRegistryKeyTable m_templateRegistryKeytable;
370     CommonIdentifiers* propertyNames;
371     const ArgList* emptyList;
372     SmallStrings smallStrings;
373     NumericStrings numericStrings;
374     DateInstanceCache dateInstanceCache;
375     std::unique_ptr<SimpleStats> machineCodeBytesPerBytecodeWordForBaselineJIT;
376     WeakGCMap<std::pair<CustomGetterSetter*, int>, JSCustomGetterSetterFunction> customGetterSetterFunctionMap;
377     WeakGCMap<StringImpl*, JSString, PtrHash<StringImpl*>> stringCache;
378     Strong<JSString> lastCachedString;
379
380     AtomicStringTable* atomicStringTable() const { return m_atomicStringTable; }
381     WTF::SymbolRegistry& symbolRegistry() { return m_symbolRegistry; }
382
383     TemplateRegistryKeyTable& templateRegistryKeyTable() { return m_templateRegistryKeytable; }
384
385     WeakGCMap<SymbolImpl*, Symbol, PtrHash<SymbolImpl*>> symbolImplToSymbolMap;
386
387     enum class DeletePropertyMode {
388         // Default behaviour of deleteProperty, matching the spec.
389         Default,
390         // This setting causes deleteProperty to force deletion of all
391         // properties including those that are non-configurable (DontDelete).
392         IgnoreConfigurable
393     };
394
395     DeletePropertyMode deletePropertyMode()
396     {
397         return m_deletePropertyMode;
398     }
399
400     class DeletePropertyModeScope {
401     public:
402         DeletePropertyModeScope(VM& vm, DeletePropertyMode mode)
403             : m_vm(vm)
404             , m_previousMode(vm.m_deletePropertyMode)
405         {
406             m_vm.m_deletePropertyMode = mode;
407         }
408
409         ~DeletePropertyModeScope()
410         {
411             m_vm.m_deletePropertyMode = m_previousMode;
412         }
413
414     private:
415         VM& m_vm;
416         DeletePropertyMode m_previousMode;
417     };
418
419 #if ENABLE(JIT)
420     bool canUseJIT() { return m_canUseJIT; }
421 #else
422     bool canUseJIT() { return false; } // interpreter only
423 #endif
424
425 #if ENABLE(YARR_JIT)
426     bool canUseRegExpJIT() { return m_canUseRegExpJIT; }
427 #else
428     bool canUseRegExpJIT() { return false; } // interpreter only
429 #endif
430
431     SourceProviderCache* addSourceProviderCache(SourceProvider*);
432     void clearSourceProviderCaches();
433
434     PrototypeMap prototypeMap;
435
436     typedef HashMap<RefPtr<SourceProvider>, RefPtr<SourceProviderCache>> SourceProviderCacheMap;
437     SourceProviderCacheMap sourceProviderCacheMap;
438     Interpreter* interpreter;
439 #if ENABLE(JIT)
440     std::unique_ptr<JITThunks> jitStubs;
441     MacroAssemblerCodeRef getCTIStub(ThunkGenerator generator)
442     {
443         return jitStubs->ctiStub(this, generator);
444     }
445     
446     static RegisterAtOffsetList* getAllCalleeSaveRegisterOffsets();
447
448 #endif // ENABLE(JIT)
449     std::unique_ptr<CommonSlowPaths::ArityCheckData> arityCheckData;
450 #if ENABLE(FTL_JIT)
451     std::unique_ptr<FTL::Thunks> ftlThunks;
452 #endif
453     NativeExecutable* getHostFunction(NativeFunction, NativeFunction constructor, const String& name);
454     NativeExecutable* getHostFunction(NativeFunction, Intrinsic, NativeFunction constructor, const DOMJIT::Signature*, const String& name);
455
456     static ptrdiff_t exceptionOffset()
457     {
458         return OBJECT_OFFSETOF(VM, m_exception);
459     }
460
461     static ptrdiff_t callFrameForCatchOffset()
462     {
463         return OBJECT_OFFSETOF(VM, callFrameForCatch);
464     }
465
466     static ptrdiff_t targetMachinePCForThrowOffset()
467     {
468         return OBJECT_OFFSETOF(VM, targetMachinePCForThrow);
469     }
470
471     static ptrdiff_t topVMEntryFrameOffset()
472     {
473         return OBJECT_OFFSETOF(VM, topVMEntryFrame);
474     }
475
476     void restorePreviousException(Exception* exception) { setException(exception); }
477
478     void clearLastException() { m_lastException = nullptr; }
479
480     ExecState** addressOfCallFrameForCatch() { return &callFrameForCatch; }
481
482     JSCell** addressOfException() { return reinterpret_cast<JSCell**>(&m_exception); }
483
484     Exception* lastException() const { return m_lastException; }
485     JSCell** addressOfLastException() { return reinterpret_cast<JSCell**>(&m_lastException); }
486
487     void setFailNextNewCodeBlock() { m_failNextNewCodeBlock = true; }
488     bool getAndClearFailNextNewCodeBlock()
489     {
490         bool result = m_failNextNewCodeBlock;
491         m_failNextNewCodeBlock = false;
492         return result;
493     }
494     
495     ALWAYS_INLINE Structure* getStructure(StructureID id)
496     {
497         return heap.structureIDTable().get(decontaminate(id));
498     }
499     
500     void* stackPointerAtVMEntry() const { return m_stackPointerAtVMEntry; }
501     void setStackPointerAtVMEntry(void*);
502
503     size_t softReservedZoneSize() const { return m_currentSoftReservedZoneSize; }
504     size_t updateSoftReservedZoneSize(size_t softReservedZoneSize);
505     
506     static size_t committedStackByteCount();
507     inline bool ensureStackCapacityFor(Register* newTopOfStack);
508
509     void* stackLimit() { return m_stackLimit; }
510     void* softStackLimit() { return m_softStackLimit; }
511     void** addressOfSoftStackLimit() { return &m_softStackLimit; }
512 #if !ENABLE(JIT)
513     void* cloopStackLimit() { return m_cloopStackLimit; }
514     void setCLoopStackLimit(void* limit) { m_cloopStackLimit = limit; }
515 #endif
516
517     inline bool isSafeToRecurseSoft() const;
518     bool isSafeToRecurse() const
519     {
520         return isSafeToRecurse(m_stackLimit);
521     }
522
523     void* lastStackTop() { return m_lastStackTop; }
524     void setLastStackTop(void*);
525
526     JSValue hostCallReturnValue;
527     unsigned varargsLength;
528     ExecState* newCallFrameReturnValue;
529     ExecState* callFrameForCatch;
530     void* targetMachinePCForThrow;
531     Instruction* targetInterpreterPCForThrow;
532     uint32_t osrExitIndex;
533     void* osrExitJumpDestination;
534     Vector<ScratchBuffer*> scratchBuffers;
535     size_t sizeOfLastScratchBuffer;
536
537     bool isExecutingInRegExpJIT { false };
538
539     ScratchBuffer* scratchBufferForSize(size_t size)
540     {
541         if (!size)
542             return 0;
543
544         if (size > sizeOfLastScratchBuffer) {
545             // Protect against a N^2 memory usage pathology by ensuring
546             // that at worst, we get a geometric series, meaning that the
547             // total memory usage is somewhere around
548             // max(scratch buffer size) * 4.
549             sizeOfLastScratchBuffer = size * 2;
550
551             ScratchBuffer* newBuffer = ScratchBuffer::create(sizeOfLastScratchBuffer);
552             RELEASE_ASSERT(newBuffer);
553             scratchBuffers.append(newBuffer);
554         }
555
556         ScratchBuffer* result = scratchBuffers.last();
557         result->setActiveLength(0);
558         return result;
559     }
560
561     EncodedJSValue* exceptionFuzzingBuffer(size_t size)
562     {
563         ASSERT(Options::useExceptionFuzz());
564         if (!m_exceptionFuzzBuffer)
565             m_exceptionFuzzBuffer = MallocPtr<EncodedJSValue>::malloc(size);
566         return m_exceptionFuzzBuffer.get();
567     }
568
569     void gatherConservativeRoots(ConservativeRoots&);
570
571     VMEntryScope* entryScope;
572
573     JSObject* stringRecursionCheckFirstObject { nullptr };
574     HashSet<JSObject*> stringRecursionCheckVisitedObjects;
575
576     LocalTimeOffsetCache localTimeOffsetCache;
577
578     String cachedDateString;
579     double cachedDateStringValue;
580
581     std::unique_ptr<Profiler::Database> m_perBytecodeProfiler;
582     RefPtr<TypedArrayController> m_typedArrayController;
583     RegExpCache* m_regExpCache;
584     BumpPointerAllocator m_regExpAllocator;
585     ConcurrentJSLock m_regExpAllocatorLock;
586
587     std::unique_ptr<HasOwnPropertyCache> m_hasOwnPropertyCache;
588     ALWAYS_INLINE HasOwnPropertyCache* hasOwnPropertyCache() { return m_hasOwnPropertyCache.get(); }
589     HasOwnPropertyCache* ensureHasOwnPropertyCache();
590
591 #if ENABLE(REGEXP_TRACING)
592     typedef ListHashSet<RegExp*> RTTraceList;
593     RTTraceList* m_rtTraceList;
594 #endif
595
596     JS_EXPORT_PRIVATE void resetDateCache();
597
598     RegExpCache* regExpCache() { return m_regExpCache; }
599 #if ENABLE(REGEXP_TRACING)
600     void addRegExpToTrace(RegExp*);
601 #endif
602     JS_EXPORT_PRIVATE void dumpRegExpTrace();
603
604     bool isCollectorBusyOnCurrentThread() { return heap.isCurrentThreadBusy(); }
605
606 #if ENABLE(GC_VALIDATION)
607     bool isInitializingObject() const; 
608     void setInitializingObjectClass(const ClassInfo*);
609 #endif
610
611     bool currentThreadIsHoldingAPILock() const { return m_apiLock->currentThreadIsHoldingLock(); }
612
613     JSLock& apiLock() { return *m_apiLock; }
614     CodeCache* codeCache() { return m_codeCache.get(); }
615
616     JS_EXPORT_PRIVATE void whenIdle(std::function<void()>);
617
618     JS_EXPORT_PRIVATE void deleteAllCode(DeleteAllCodeEffort);
619     JS_EXPORT_PRIVATE void deleteAllLinkedCode(DeleteAllCodeEffort);
620
621     WatchpointSet* ensureWatchpointSetForImpureProperty(const Identifier&);
622     void registerWatchpointForImpureProperty(const Identifier&, Watchpoint*);
623     
624     // FIXME: Use AtomicString once it got merged with Identifier.
625     JS_EXPORT_PRIVATE void addImpureProperty(const String&);
626
627     BuiltinExecutables* builtinExecutables() { return m_builtinExecutables.get(); }
628
629     bool enableTypeProfiler();
630     bool disableTypeProfiler();
631     TypeProfilerLog* typeProfilerLog() { return m_typeProfilerLog.get(); }
632     TypeProfiler* typeProfiler() { return m_typeProfiler.get(); }
633     JS_EXPORT_PRIVATE void dumpTypeProfilerData();
634
635     FunctionHasExecutedCache* functionHasExecutedCache() { return &m_functionHasExecutedCache; }
636
637     ControlFlowProfiler* controlFlowProfiler() { return m_controlFlowProfiler.get(); }
638     bool enableControlFlowProfiler();
639     bool disableControlFlowProfiler();
640
641     void queueMicrotask(JSGlobalObject&, Ref<Microtask>&&);
642     JS_EXPORT_PRIVATE void drainMicrotasks();
643     void setGlobalConstRedeclarationShouldThrow(bool globalConstRedeclarationThrow) { m_globalConstRedeclarationShouldThrow = globalConstRedeclarationThrow; }
644     ALWAYS_INLINE bool globalConstRedeclarationShouldThrow() const { return m_globalConstRedeclarationShouldThrow; }
645
646     void setShouldBuildPCToCodeOriginMapping() { m_shouldBuildPCToCodeOriginMapping = true; }
647     bool shouldBuilderPCToCodeOriginMapping() const { return m_shouldBuildPCToCodeOriginMapping; }
648
649     BytecodeIntrinsicRegistry& bytecodeIntrinsicRegistry() { return *m_bytecodeIntrinsicRegistry; }
650     
651     ShadowChicken& shadowChicken() { return *m_shadowChicken; }
652     
653     template<typename Func>
654     void logEvent(CodeBlock*, const char* summary, const Func& func);
655
656     std::optional<RefPtr<Thread>> ownerThread() const { return m_apiLock->ownerThread(); }
657
658     VMTraps& traps() { return m_traps; }
659
660     void handleTraps(ExecState* exec, VMTraps::Mask mask = VMTraps::Mask::allEventTypes()) { m_traps.handleTraps(exec, mask); }
661
662     bool needTrapHandling() { return m_traps.needTrapHandling(); }
663     bool needTrapHandling(VMTraps::Mask mask) { return m_traps.needTrapHandling(mask); }
664     void* needTrapHandlingAddress() { return m_traps.needTrapHandlingAddress(); }
665
666     void notifyNeedDebuggerBreak() { m_traps.fireTrap(VMTraps::NeedDebuggerBreak); }
667     void notifyNeedTermination() { m_traps.fireTrap(VMTraps::NeedTermination); }
668     void notifyNeedWatchdogCheck() { m_traps.fireTrap(VMTraps::NeedWatchdogCheck); }
669
670 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
671     StackTrace* nativeStackTraceOfLastThrow() const { return m_nativeStackTraceOfLastThrow.get(); }
672     ThreadIdentifier throwingThread() const { return m_throwingThread; }
673 #endif
674
675 #if USE(CF)
676     CFRunLoopRef runLoop() const { return m_runLoop.get(); }
677     void registerRunLoopTimer(JSRunLoopTimer*);
678     void unregisterRunLoopTimer(JSRunLoopTimer*);
679     JS_EXPORT_PRIVATE void setRunLoop(CFRunLoopRef);
680 #endif // USE(CF)
681
682 private:
683     friend class LLIntOffsetsExtractor;
684
685     VM(VMType, HeapType);
686     static VM*& sharedInstanceInternal();
687     void createNativeThunk();
688
689     void updateStackLimits();
690
691     bool isSafeToRecurse(void* stackLimit) const
692     {
693         ASSERT(Thread::current().stack().isGrowingDownward());
694         void* curr = reinterpret_cast<void*>(&curr);
695         return curr >= stackLimit;
696     }
697
698     void setException(Exception* exception)
699     {
700         m_exception = exception;
701         m_lastException = exception;
702     }
703     Exception* exception() const
704     {
705 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
706         m_needExceptionCheck = false;
707 #endif
708         return m_exception;
709     }
710     void clearException()
711     {
712 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
713         m_needExceptionCheck = false;
714         m_nativeStackTraceOfLastThrow = nullptr;
715         m_throwingThread = 0;
716 #endif
717         m_exception = nullptr;
718     }
719
720 #if !ENABLE(JIT)    
721     bool ensureStackCapacityForCLoop(Register* newTopOfStack);
722     bool isSafeToRecurseSoftCLoop() const;
723 #endif // !ENABLE(JIT)
724
725     JS_EXPORT_PRIVATE void throwException(ExecState*, Exception*);
726     JS_EXPORT_PRIVATE JSValue throwException(ExecState*, JSValue);
727     JS_EXPORT_PRIVATE JSObject* throwException(ExecState*, JSObject*);
728
729 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
730     void verifyExceptionCheckNeedIsSatisfied(unsigned depth, ExceptionEventLocation&);
731 #endif
732
733 #if ENABLE(ASSEMBLER)
734     bool m_canUseAssembler;
735 #endif
736 #if ENABLE(JIT)
737     bool m_canUseJIT;
738 #endif
739 #if ENABLE(YARR_JIT)
740     bool m_canUseRegExpJIT;
741 #endif
742 #if ENABLE(GC_VALIDATION)
743     const ClassInfo* m_initializingObjectClass;
744 #endif
745
746     void* m_stackPointerAtVMEntry;
747     size_t m_currentSoftReservedZoneSize;
748     void* m_stackLimit { nullptr };
749     void* m_softStackLimit { nullptr };
750 #if !ENABLE(JIT)
751     void* m_cloopStackLimit { nullptr };
752 #endif
753     void* m_lastStackTop;
754
755     Exception* m_exception { nullptr };
756     Exception* m_lastException { nullptr };
757 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
758     ExceptionScope* m_topExceptionScope { nullptr };
759     ExceptionEventLocation m_simulatedThrowPointLocation;
760     unsigned m_simulatedThrowPointRecursionDepth { 0 };
761     mutable bool m_needExceptionCheck { false };
762     std::unique_ptr<StackTrace> m_nativeStackTraceOfLastThrow;
763     ThreadIdentifier m_throwingThread;
764 #endif
765
766     bool m_failNextNewCodeBlock { false };
767     DeletePropertyMode m_deletePropertyMode { DeletePropertyMode::Default };
768     bool m_globalConstRedeclarationShouldThrow { true };
769     bool m_shouldBuildPCToCodeOriginMapping { false };
770     std::unique_ptr<CodeCache> m_codeCache;
771     std::unique_ptr<BuiltinExecutables> m_builtinExecutables;
772     HashMap<String, RefPtr<WatchpointSet>> m_impurePropertyWatchpointSets;
773     std::unique_ptr<TypeProfiler> m_typeProfiler;
774     std::unique_ptr<TypeProfilerLog> m_typeProfilerLog;
775     unsigned m_typeProfilerEnabledCount;
776     FunctionHasExecutedCache m_functionHasExecutedCache;
777     std::unique_ptr<ControlFlowProfiler> m_controlFlowProfiler;
778     unsigned m_controlFlowProfilerEnabledCount;
779     Deque<std::unique_ptr<QueuedTask>> m_microtaskQueue;
780     MallocPtr<EncodedJSValue> m_exceptionFuzzBuffer;
781     VMTraps m_traps;
782     RefPtr<Watchdog> m_watchdog;
783     std::unique_ptr<HeapProfiler> m_heapProfiler;
784 #if ENABLE(SAMPLING_PROFILER)
785     RefPtr<SamplingProfiler> m_samplingProfiler;
786 #endif
787     std::unique_ptr<ShadowChicken> m_shadowChicken;
788     std::unique_ptr<BytecodeIntrinsicRegistry> m_bytecodeIntrinsicRegistry;
789
790     VM* m_prev; // Required by DoublyLinkedListNode.
791     VM* m_next; // Required by DoublyLinkedListNode.
792
793     // Friends for exception checking purpose only.
794     friend class Heap;
795     friend class CatchScope;
796     friend class ExceptionScope;
797     friend class ThrowScope;
798     friend class VMTraps;
799     friend class WTF::DoublyLinkedListNode<VM>;
800 };
801
802 #if ENABLE(GC_VALIDATION)
803 inline bool VM::isInitializingObject() const
804 {
805     return !!m_initializingObjectClass;
806 }
807
808 inline void VM::setInitializingObjectClass(const ClassInfo* initializingObjectClass)
809 {
810     m_initializingObjectClass = initializingObjectClass;
811 }
812 #endif
813
814 inline Heap* WeakSet::heap() const
815 {
816     return &m_vm->heap;
817 }
818
819 #if ENABLE(JIT)
820 extern "C" void sanitizeStackForVMImpl(VM*);
821 #endif
822
823 void sanitizeStackForVM(VM*);
824 void logSanitizeStack(VM*);
825
826 } // namespace JSC