[JSC] Drop ArityCheckData
[WebKit-https.git] / Source / JavaScriptCore / runtime / VM.h
1 /*
2  * Copyright (C) 2008-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "CallData.h"
32 #include "ConcurrentJSLock.h"
33 #include "ControlFlowProfiler.h"
34 #include "DateInstanceCache.h"
35 #include "DeleteAllCodeEffort.h"
36 #include "ExceptionEventLocation.h"
37 #include "ExecutableAllocator.h"
38 #include "FunctionHasExecutedCache.h"
39 #include "Heap.h"
40 #include "Intrinsic.h"
41 #include "JITThunks.h"
42 #include "JSCJSValue.h"
43 #include "JSDestructibleObjectSubspace.h"
44 #include "JSLock.h"
45 #include "JSSegmentedVariableObjectSubspace.h"
46 #include "JSStringSubspace.h"
47 #include "JSWebAssemblyCodeBlockSubspace.h"
48 #include "MacroAssemblerCodeRef.h"
49 #include "Microtask.h"
50 #include "NumericStrings.h"
51 #include "SmallStrings.h"
52 #include "Strong.h"
53 #include "StructureCache.h"
54 #include "Subspace.h"
55 #include "TemplateRegistryKeyTable.h"
56 #include "VMEntryRecord.h"
57 #include "VMTraps.h"
58 #include "WasmContext.h"
59 #include "Watchpoint.h"
60 #include <wtf/BumpPointerAllocator.h>
61 #include <wtf/CheckedArithmetic.h>
62 #include <wtf/DateMath.h>
63 #include <wtf/Deque.h>
64 #include <wtf/DoublyLinkedList.h>
65 #include <wtf/Forward.h>
66 #include <wtf/Gigacage.h>
67 #include <wtf/HashMap.h>
68 #include <wtf/HashSet.h>
69 #include <wtf/StackBounds.h>
70 #include <wtf/Stopwatch.h>
71 #include <wtf/ThreadSafeRefCounted.h>
72 #include <wtf/ThreadSpecific.h>
73 #include <wtf/text/SymbolRegistry.h>
74 #include <wtf/text/WTFString.h>
75 #if ENABLE(REGEXP_TRACING)
76 #include <wtf/ListHashSet.h>
77 #endif
78
79 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
80 #include <wtf/StackTrace.h>
81 #endif
82
83 namespace WTF {
84 class SimpleStats;
85 } // namespace WTF
86 using WTF::SimpleStats;
87
88 namespace JSC {
89
90 class BuiltinExecutables;
91 class BytecodeIntrinsicRegistry;
92 class CodeBlock;
93 class CodeCache;
94 class CommonIdentifiers;
95 class CustomGetterSetter;
96 class DOMAttributeGetterSetter;
97 class ExecState;
98 class Exception;
99 class ExceptionScope;
100 class FastMallocAlignedMemoryAllocator;
101 class GigacageAlignedMemoryAllocator;
102 class HandleStack;
103 class TypeProfiler;
104 class TypeProfilerLog;
105 class HasOwnPropertyCache;
106 class HeapProfiler;
107 class Identifier;
108 class Interpreter;
109 class JSCustomGetterSetterFunction;
110 class JSGlobalObject;
111 class JSObject;
112 class JSRunLoopTimer;
113 class JSWebAssemblyInstance;
114 class LLIntOffsetsExtractor;
115 class NativeExecutable;
116 class PromiseDeferredTimer;
117 class RegExpCache;
118 class Register;
119 class RegisterAtOffsetList;
120 #if ENABLE(SAMPLING_PROFILER)
121 class SamplingProfiler;
122 #endif
123 class ShadowChicken;
124 class ScriptExecutable;
125 class SourceProvider;
126 class SourceProviderCache;
127 class StackFrame;
128 class Structure;
129 #if ENABLE(REGEXP_TRACING)
130 class RegExp;
131 #endif
132 class Symbol;
133 class TypedArrayController;
134 class UnlinkedCodeBlock;
135 class UnlinkedEvalCodeBlock;
136 class UnlinkedFunctionExecutable;
137 class UnlinkedProgramCodeBlock;
138 class UnlinkedModuleProgramCodeBlock;
139 class VirtualRegister;
140 class VMEntryScope;
141 class Watchdog;
142 class Watchpoint;
143 class WatchpointSet;
144
145 #if ENABLE(FTL_JIT)
146 namespace FTL {
147 class Thunks;
148 }
149 #endif // ENABLE(FTL_JIT)
150 namespace 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* addressOfActiveLength() { 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 Thread::current()).
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     std::unique_ptr<FastMallocAlignedMemoryAllocator> fastMallocAllocator;
290     std::unique_ptr<GigacageAlignedMemoryAllocator> primitiveGigacageAllocator;
291     std::unique_ptr<GigacageAlignedMemoryAllocator> jsValueGigacageAllocator;
292     
293     Subspace primitiveGigacageAuxiliarySpace; // Typed arrays, strings, bitvectors, etc go here.
294     Subspace jsValueGigacageAuxiliarySpace; // Butterflies, arrays of JSValues, etc go here.
295
296     // We make cross-cutting assumptions about typed arrays being in the primitive Gigacage and butterflies
297     // being in the JSValue gigacage. For some types, it's super obvious where they should go, and so we
298     // can hardcode that fact. But sometimes it's not clear, so we abstract it by having a Gigacage::Kind
299     // constant somewhere.
300     // FIXME: Maybe it would be better if everyone abstracted this?
301     // https://bugs.webkit.org/show_bug.cgi?id=175248
302     ALWAYS_INLINE Subspace& gigacageAuxiliarySpace(Gigacage::Kind kind)
303     {
304         switch (kind) {
305         case Gigacage::Primitive:
306             return primitiveGigacageAuxiliarySpace;
307         case Gigacage::JSValue:
308             return jsValueGigacageAuxiliarySpace;
309         case Gigacage::String:
310             break;
311         }
312         RELEASE_ASSERT_NOT_REACHED();
313         return primitiveGigacageAuxiliarySpace;
314     }
315     
316     // Whenever possible, use subspaceFor<CellType>(vm) to get one of these subspaces.
317     Subspace cellSpace;
318     Subspace jsValueGigacageCellSpace;
319     Subspace destructibleCellSpace;
320     JSStringSubspace stringSpace;
321     JSDestructibleObjectSubspace destructibleObjectSpace;
322     JSDestructibleObjectSubspace eagerlySweptDestructibleObjectSpace;
323     JSSegmentedVariableObjectSubspace segmentedVariableObjectSpace;
324 #if ENABLE(WEBASSEMBLY)
325     JSWebAssemblyCodeBlockSubspace webAssemblyCodeBlockSpace;
326 #endif
327
328     VMType vmType;
329     ClientData* clientData;
330     EntryFrame* topEntryFrame;
331     // NOTE: When throwing an exception while rolling back the call frame, this may be equal to
332     // topEntryFrame.
333     // FIXME: This should be a void*, because it might not point to a CallFrame.
334     // https://bugs.webkit.org/show_bug.cgi?id=160441
335     ExecState* topCallFrame { nullptr };
336 #if ENABLE(WEBASSEMBLY)
337     Wasm::Context wasmContext;
338 #endif
339     Strong<Structure> structureStructure;
340     Strong<Structure> structureRareDataStructure;
341     Strong<Structure> terminatedExecutionErrorStructure;
342     Strong<Structure> stringStructure;
343     Strong<Structure> propertyNameIteratorStructure;
344     Strong<Structure> propertyNameEnumeratorStructure;
345     Strong<Structure> customGetterSetterStructure;
346     Strong<Structure> domAttributeGetterSetterStructure;
347     Strong<Structure> scopedArgumentsTableStructure;
348     Strong<Structure> apiWrapperStructure;
349     Strong<Structure> nativeExecutableStructure;
350     Strong<Structure> evalExecutableStructure;
351     Strong<Structure> programExecutableStructure;
352     Strong<Structure> functionExecutableStructure;
353 #if ENABLE(WEBASSEMBLY)
354     Strong<Structure> webAssemblyCodeBlockStructure;
355 #endif
356     Strong<Structure> moduleProgramExecutableStructure;
357     Strong<Structure> regExpStructure;
358     Strong<Structure> symbolStructure;
359     Strong<Structure> symbolTableStructure;
360     Strong<Structure> fixedArrayStructure;
361     Strong<Structure> sourceCodeStructure;
362     Strong<Structure> scriptFetcherStructure;
363     Strong<Structure> scriptFetchParametersStructure;
364     Strong<Structure> structureChainStructure;
365     Strong<Structure> sparseArrayValueMapStructure;
366     Strong<Structure> templateRegistryKeyStructure;
367     Strong<Structure> arrayBufferNeuteringWatchpointStructure;
368     Strong<Structure> unlinkedFunctionExecutableStructure;
369     Strong<Structure> unlinkedProgramCodeBlockStructure;
370     Strong<Structure> unlinkedEvalCodeBlockStructure;
371     Strong<Structure> unlinkedFunctionCodeBlockStructure;
372     Strong<Structure> unlinkedModuleProgramCodeBlockStructure;
373     Strong<Structure> propertyTableStructure;
374     Strong<Structure> inferredValueStructure;
375     Strong<Structure> inferredTypeStructure;
376     Strong<Structure> inferredTypeTableStructure;
377     Strong<Structure> functionRareDataStructure;
378     Strong<Structure> exceptionStructure;
379     Strong<Structure> promiseDeferredStructure;
380     Strong<Structure> internalPromiseDeferredStructure;
381     Strong<Structure> nativeStdFunctionCellStructure;
382     Strong<Structure> programCodeBlockStructure;
383     Strong<Structure> moduleProgramCodeBlockStructure;
384     Strong<Structure> evalCodeBlockStructure;
385     Strong<Structure> functionCodeBlockStructure;
386     Strong<Structure> hashMapBucketSetStructure;
387     Strong<Structure> hashMapBucketMapStructure;
388     Strong<Structure> setIteratorStructure;
389     Strong<Structure> mapIteratorStructure;
390
391     Strong<JSCell> emptyPropertyNameEnumerator;
392     Strong<JSCell> sentinelSetBucket;
393     Strong<JSCell> sentinelMapBucket;
394
395     std::unique_ptr<PromiseDeferredTimer> promiseDeferredTimer;
396     
397     JSCell* currentlyDestructingCallbackObject;
398     const ClassInfo* currentlyDestructingCallbackObjectClassInfo;
399
400     AtomicStringTable* m_atomicStringTable;
401     WTF::SymbolRegistry m_symbolRegistry;
402     TemplateRegistryKeyTable m_templateRegistryKeytable;
403     CommonIdentifiers* propertyNames;
404     const ArgList* emptyList;
405     SmallStrings smallStrings;
406     NumericStrings numericStrings;
407     DateInstanceCache dateInstanceCache;
408     std::unique_ptr<SimpleStats> machineCodeBytesPerBytecodeWordForBaselineJIT;
409     WeakGCMap<std::pair<CustomGetterSetter*, int>, JSCustomGetterSetterFunction> customGetterSetterFunctionMap;
410     WeakGCMap<StringImpl*, JSString, PtrHash<StringImpl*>> stringCache;
411     Strong<JSString> lastCachedString;
412
413     AtomicStringTable* atomicStringTable() const { return m_atomicStringTable; }
414     WTF::SymbolRegistry& symbolRegistry() { return m_symbolRegistry; }
415
416     TemplateRegistryKeyTable& templateRegistryKeyTable() { return m_templateRegistryKeytable; }
417
418     WeakGCMap<SymbolImpl*, Symbol, PtrHash<SymbolImpl*>> symbolImplToSymbolMap;
419
420     enum class DeletePropertyMode {
421         // Default behaviour of deleteProperty, matching the spec.
422         Default,
423         // This setting causes deleteProperty to force deletion of all
424         // properties including those that are non-configurable (DontDelete).
425         IgnoreConfigurable
426     };
427
428     DeletePropertyMode deletePropertyMode()
429     {
430         return m_deletePropertyMode;
431     }
432
433     class DeletePropertyModeScope {
434     public:
435         DeletePropertyModeScope(VM& vm, DeletePropertyMode mode)
436             : m_vm(vm)
437             , m_previousMode(vm.m_deletePropertyMode)
438         {
439             m_vm.m_deletePropertyMode = mode;
440         }
441
442         ~DeletePropertyModeScope()
443         {
444             m_vm.m_deletePropertyMode = m_previousMode;
445         }
446
447     private:
448         VM& m_vm;
449         DeletePropertyMode m_previousMode;
450     };
451
452 #if ENABLE(JIT)
453     bool canUseJIT() { return m_canUseJIT; }
454 #else
455     bool canUseJIT() { return false; } // interpreter only
456 #endif
457
458 #if ENABLE(YARR_JIT)
459     bool canUseRegExpJIT() { return m_canUseRegExpJIT; }
460 #else
461     bool canUseRegExpJIT() { return false; } // interpreter only
462 #endif
463
464     SourceProviderCache* addSourceProviderCache(SourceProvider*);
465     void clearSourceProviderCaches();
466
467     StructureCache structureCache;
468
469     typedef HashMap<RefPtr<SourceProvider>, RefPtr<SourceProviderCache>> SourceProviderCacheMap;
470     SourceProviderCacheMap sourceProviderCacheMap;
471     Interpreter* interpreter;
472 #if ENABLE(JIT)
473     std::unique_ptr<JITThunks> jitStubs;
474     MacroAssemblerCodeRef getCTIStub(ThunkGenerator generator)
475     {
476         return jitStubs->ctiStub(this, generator);
477     }
478
479 #endif // ENABLE(JIT)
480 #if ENABLE(FTL_JIT)
481     std::unique_ptr<FTL::Thunks> ftlThunks;
482 #endif
483     NativeExecutable* getHostFunction(NativeFunction, NativeFunction constructor, const String& name);
484     NativeExecutable* getHostFunction(NativeFunction, Intrinsic, NativeFunction constructor, const DOMJIT::Signature*, const String& name);
485
486     static ptrdiff_t exceptionOffset()
487     {
488         return OBJECT_OFFSETOF(VM, m_exception);
489     }
490
491     static ptrdiff_t callFrameForCatchOffset()
492     {
493         return OBJECT_OFFSETOF(VM, callFrameForCatch);
494     }
495
496     static ptrdiff_t targetMachinePCForThrowOffset()
497     {
498         return OBJECT_OFFSETOF(VM, targetMachinePCForThrow);
499     }
500
501     static ptrdiff_t topEntryFrameOffset()
502     {
503         return OBJECT_OFFSETOF(VM, topEntryFrame);
504     }
505
506     void restorePreviousException(Exception* exception) { setException(exception); }
507
508     void clearLastException() { m_lastException = nullptr; }
509
510     ExecState** addressOfCallFrameForCatch() { return &callFrameForCatch; }
511
512     JSCell** addressOfException() { return reinterpret_cast<JSCell**>(&m_exception); }
513
514     Exception* lastException() const { return m_lastException; }
515     JSCell** addressOfLastException() { return reinterpret_cast<JSCell**>(&m_lastException); }
516
517     void setFailNextNewCodeBlock() { m_failNextNewCodeBlock = true; }
518     bool getAndClearFailNextNewCodeBlock()
519     {
520         bool result = m_failNextNewCodeBlock;
521         m_failNextNewCodeBlock = false;
522         return result;
523     }
524     
525     ALWAYS_INLINE Structure* getStructure(StructureID id)
526     {
527         return heap.structureIDTable().get(decontaminate(id));
528     }
529     
530     void* stackPointerAtVMEntry() const { return m_stackPointerAtVMEntry; }
531     void setStackPointerAtVMEntry(void*);
532
533     size_t softReservedZoneSize() const { return m_currentSoftReservedZoneSize; }
534     size_t updateSoftReservedZoneSize(size_t softReservedZoneSize);
535     
536     static size_t committedStackByteCount();
537     inline bool ensureStackCapacityFor(Register* newTopOfStack);
538
539     void* stackLimit() { return m_stackLimit; }
540     void* softStackLimit() { return m_softStackLimit; }
541     void** addressOfSoftStackLimit() { return &m_softStackLimit; }
542 #if !ENABLE(JIT)
543     void* cloopStackLimit() { return m_cloopStackLimit; }
544     void setCLoopStackLimit(void* limit) { m_cloopStackLimit = limit; }
545 #endif
546
547     inline bool isSafeToRecurseSoft() const;
548     bool isSafeToRecurse() const
549     {
550         return isSafeToRecurse(m_stackLimit);
551     }
552
553     void** addressOfLastStackTop() { return &m_lastStackTop; }
554     void* lastStackTop() { return m_lastStackTop; }
555     void setLastStackTop(void*);
556     
557     void firePrimitiveGigacageEnabledIfNecessary()
558     {
559         if (m_needToFirePrimitiveGigacageEnabled) {
560             m_needToFirePrimitiveGigacageEnabled = false;
561             m_primitiveGigacageEnabled.fireAll(*this, "Primitive gigacage disabled asynchronously");
562         }
563     }
564
565     JSValue hostCallReturnValue;
566     unsigned varargsLength;
567     ExecState* newCallFrameReturnValue;
568     ExecState* callFrameForCatch;
569     void* targetMachinePCForThrow;
570     Instruction* targetInterpreterPCForThrow;
571     uint32_t osrExitIndex;
572     void* osrExitJumpDestination;
573     bool isExecutingInRegExpJIT { false };
574
575     // The threading protocol here is as follows:
576     // - You can call scratchBufferForSize from any thread.
577     // - You can only set the ScratchBuffer's activeLength from the main thread.
578     ScratchBuffer* scratchBufferForSize(size_t size);
579
580     EncodedJSValue* exceptionFuzzingBuffer(size_t size)
581     {
582         ASSERT(Options::useExceptionFuzz());
583         if (!m_exceptionFuzzBuffer)
584             m_exceptionFuzzBuffer = MallocPtr<EncodedJSValue>::malloc(size);
585         return m_exceptionFuzzBuffer.get();
586     }
587
588     void gatherConservativeRoots(ConservativeRoots&);
589
590     VMEntryScope* entryScope;
591
592     JSObject* stringRecursionCheckFirstObject { nullptr };
593     HashSet<JSObject*> stringRecursionCheckVisitedObjects;
594
595     LocalTimeOffsetCache localTimeOffsetCache;
596
597     String cachedDateString;
598     double cachedDateStringValue;
599
600     std::unique_ptr<Profiler::Database> m_perBytecodeProfiler;
601     RefPtr<TypedArrayController> m_typedArrayController;
602     RegExpCache* m_regExpCache;
603     BumpPointerAllocator m_regExpAllocator;
604     ConcurrentJSLock m_regExpAllocatorLock;
605
606     std::unique_ptr<HasOwnPropertyCache> m_hasOwnPropertyCache;
607     ALWAYS_INLINE HasOwnPropertyCache* hasOwnPropertyCache() { return m_hasOwnPropertyCache.get(); }
608     HasOwnPropertyCache* ensureHasOwnPropertyCache();
609
610 #if ENABLE(REGEXP_TRACING)
611     typedef ListHashSet<RegExp*> RTTraceList;
612     RTTraceList* m_rtTraceList;
613 #endif
614
615     JS_EXPORT_PRIVATE void resetDateCache();
616
617     RegExpCache* regExpCache() { return m_regExpCache; }
618 #if ENABLE(REGEXP_TRACING)
619     void addRegExpToTrace(RegExp*);
620 #endif
621     JS_EXPORT_PRIVATE void dumpRegExpTrace();
622
623     bool isCollectorBusyOnCurrentThread() { return heap.isCurrentThreadBusy(); }
624
625 #if ENABLE(GC_VALIDATION)
626     bool isInitializingObject() const; 
627     void setInitializingObjectClass(const ClassInfo*);
628 #endif
629
630     bool currentThreadIsHoldingAPILock() const { return m_apiLock->currentThreadIsHoldingLock(); }
631
632     JSLock& apiLock() { return *m_apiLock; }
633     CodeCache* codeCache() { return m_codeCache.get(); }
634
635     JS_EXPORT_PRIVATE void whenIdle(std::function<void()>);
636
637     JS_EXPORT_PRIVATE void deleteAllCode(DeleteAllCodeEffort);
638     JS_EXPORT_PRIVATE void deleteAllLinkedCode(DeleteAllCodeEffort);
639
640     WatchpointSet* ensureWatchpointSetForImpureProperty(const Identifier&);
641     void registerWatchpointForImpureProperty(const Identifier&, Watchpoint*);
642     
643     // FIXME: Use AtomicString once it got merged with Identifier.
644     JS_EXPORT_PRIVATE void addImpureProperty(const String&);
645     
646     InlineWatchpointSet& primitiveGigacageEnabled() { return m_primitiveGigacageEnabled; }
647
648     BuiltinExecutables* builtinExecutables() { return m_builtinExecutables.get(); }
649
650     bool enableTypeProfiler();
651     bool disableTypeProfiler();
652     TypeProfilerLog* typeProfilerLog() { return m_typeProfilerLog.get(); }
653     TypeProfiler* typeProfiler() { return m_typeProfiler.get(); }
654     JS_EXPORT_PRIVATE void dumpTypeProfilerData();
655
656     FunctionHasExecutedCache* functionHasExecutedCache() { return &m_functionHasExecutedCache; }
657
658     ControlFlowProfiler* controlFlowProfiler() { return m_controlFlowProfiler.get(); }
659     bool enableControlFlowProfiler();
660     bool disableControlFlowProfiler();
661
662     void queueMicrotask(JSGlobalObject&, Ref<Microtask>&&);
663     JS_EXPORT_PRIVATE void drainMicrotasks();
664     void setGlobalConstRedeclarationShouldThrow(bool globalConstRedeclarationThrow) { m_globalConstRedeclarationShouldThrow = globalConstRedeclarationThrow; }
665     ALWAYS_INLINE bool globalConstRedeclarationShouldThrow() const { return m_globalConstRedeclarationShouldThrow; }
666
667     void setShouldBuildPCToCodeOriginMapping() { m_shouldBuildPCToCodeOriginMapping = true; }
668     bool shouldBuilderPCToCodeOriginMapping() const { return m_shouldBuildPCToCodeOriginMapping; }
669
670     BytecodeIntrinsicRegistry& bytecodeIntrinsicRegistry() { return *m_bytecodeIntrinsicRegistry; }
671     
672     ShadowChicken& shadowChicken() { return *m_shadowChicken; }
673     
674     template<typename Func>
675     void logEvent(CodeBlock*, const char* summary, const Func& func);
676
677     std::optional<RefPtr<Thread>> ownerThread() const { return m_apiLock->ownerThread(); }
678
679     VMTraps& traps() { return m_traps; }
680
681     void handleTraps(ExecState* exec, VMTraps::Mask mask = VMTraps::Mask::allEventTypes()) { m_traps.handleTraps(exec, mask); }
682
683     bool needTrapHandling() { return m_traps.needTrapHandling(); }
684     bool needTrapHandling(VMTraps::Mask mask) { return m_traps.needTrapHandling(mask); }
685     void* needTrapHandlingAddress() { return m_traps.needTrapHandlingAddress(); }
686
687     void notifyNeedDebuggerBreak() { m_traps.fireTrap(VMTraps::NeedDebuggerBreak); }
688     void notifyNeedTermination() { m_traps.fireTrap(VMTraps::NeedTermination); }
689     void notifyNeedWatchdogCheck() { m_traps.fireTrap(VMTraps::NeedWatchdogCheck); }
690
691 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
692     StackTrace* nativeStackTraceOfLastThrow() const { return m_nativeStackTraceOfLastThrow.get(); }
693     ThreadIdentifier throwingThread() const { return m_throwingThread; }
694 #endif
695
696 #if USE(CF)
697     CFRunLoopRef runLoop() const { return m_runLoop.get(); }
698     void registerRunLoopTimer(JSRunLoopTimer*);
699     void unregisterRunLoopTimer(JSRunLoopTimer*);
700     JS_EXPORT_PRIVATE void setRunLoop(CFRunLoopRef);
701 #endif // USE(CF)
702
703 private:
704     friend class LLIntOffsetsExtractor;
705
706     VM(VMType, HeapType);
707     static VM*& sharedInstanceInternal();
708     void createNativeThunk();
709
710     void updateStackLimits();
711
712     bool isSafeToRecurse(void* stackLimit) const
713     {
714         ASSERT(Thread::current().stack().isGrowingDownward());
715         void* curr = reinterpret_cast<void*>(&curr);
716         return curr >= stackLimit;
717     }
718
719     void setException(Exception* exception)
720     {
721         m_exception = exception;
722         m_lastException = exception;
723     }
724     Exception* exception() const
725     {
726 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
727         m_needExceptionCheck = false;
728 #endif
729         return m_exception;
730     }
731     void clearException()
732     {
733 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
734         m_needExceptionCheck = false;
735         m_nativeStackTraceOfLastThrow = nullptr;
736         m_throwingThread = 0;
737 #endif
738         m_exception = nullptr;
739     }
740
741 #if !ENABLE(JIT)    
742     bool ensureStackCapacityForCLoop(Register* newTopOfStack);
743     bool isSafeToRecurseSoftCLoop() const;
744 #endif // !ENABLE(JIT)
745
746     JS_EXPORT_PRIVATE void throwException(ExecState*, Exception*);
747     JS_EXPORT_PRIVATE JSValue throwException(ExecState*, JSValue);
748     JS_EXPORT_PRIVATE JSObject* throwException(ExecState*, JSObject*);
749
750 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
751     void verifyExceptionCheckNeedIsSatisfied(unsigned depth, ExceptionEventLocation&);
752 #endif
753     
754     static void primitiveGigacageDisabledCallback(void*);
755     void primitiveGigacageDisabled();
756
757 #if ENABLE(ASSEMBLER)
758     bool m_canUseAssembler;
759 #endif
760 #if ENABLE(JIT)
761     bool m_canUseJIT;
762 #endif
763 #if ENABLE(YARR_JIT)
764     bool m_canUseRegExpJIT;
765 #endif
766 #if ENABLE(GC_VALIDATION)
767     const ClassInfo* m_initializingObjectClass;
768 #endif
769
770     void* m_stackPointerAtVMEntry;
771     size_t m_currentSoftReservedZoneSize;
772     void* m_stackLimit { nullptr };
773     void* m_softStackLimit { nullptr };
774 #if !ENABLE(JIT)
775     void* m_cloopStackLimit { nullptr };
776 #endif
777     void* m_lastStackTop { nullptr };
778
779     Exception* m_exception { nullptr };
780     Exception* m_lastException { nullptr };
781 #if ENABLE(EXCEPTION_SCOPE_VERIFICATION)
782     ExceptionScope* m_topExceptionScope { nullptr };
783     ExceptionEventLocation m_simulatedThrowPointLocation;
784     unsigned m_simulatedThrowPointRecursionDepth { 0 };
785     mutable bool m_needExceptionCheck { false };
786     std::unique_ptr<StackTrace> m_nativeStackTraceOfLastThrow;
787     std::unique_ptr<StackTrace> m_nativeStackTraceOfLastSimulatedThrow;
788     ThreadIdentifier m_throwingThread;
789 #endif
790
791     bool m_failNextNewCodeBlock { false };
792     DeletePropertyMode m_deletePropertyMode { DeletePropertyMode::Default };
793     bool m_globalConstRedeclarationShouldThrow { true };
794     bool m_shouldBuildPCToCodeOriginMapping { false };
795     std::unique_ptr<CodeCache> m_codeCache;
796     std::unique_ptr<BuiltinExecutables> m_builtinExecutables;
797     HashMap<String, RefPtr<WatchpointSet>> m_impurePropertyWatchpointSets;
798     std::unique_ptr<TypeProfiler> m_typeProfiler;
799     std::unique_ptr<TypeProfilerLog> m_typeProfilerLog;
800     unsigned m_typeProfilerEnabledCount;
801     bool m_needToFirePrimitiveGigacageEnabled { false };
802     Lock m_scratchBufferLock;
803     Vector<ScratchBuffer*> m_scratchBuffers;
804     size_t m_sizeOfLastScratchBuffer { 0 };
805     InlineWatchpointSet m_primitiveGigacageEnabled;
806     FunctionHasExecutedCache m_functionHasExecutedCache;
807     std::unique_ptr<ControlFlowProfiler> m_controlFlowProfiler;
808     unsigned m_controlFlowProfilerEnabledCount;
809     Deque<std::unique_ptr<QueuedTask>> m_microtaskQueue;
810     MallocPtr<EncodedJSValue> m_exceptionFuzzBuffer;
811     VMTraps m_traps;
812     RefPtr<Watchdog> m_watchdog;
813     std::unique_ptr<HeapProfiler> m_heapProfiler;
814 #if ENABLE(SAMPLING_PROFILER)
815     RefPtr<SamplingProfiler> m_samplingProfiler;
816 #endif
817     std::unique_ptr<ShadowChicken> m_shadowChicken;
818     std::unique_ptr<BytecodeIntrinsicRegistry> m_bytecodeIntrinsicRegistry;
819
820     VM* m_prev; // Required by DoublyLinkedListNode.
821     VM* m_next; // Required by DoublyLinkedListNode.
822
823     // Friends for exception checking purpose only.
824     friend class Heap;
825     friend class CatchScope;
826     friend class ExceptionScope;
827     friend class ThrowScope;
828     friend class VMTraps;
829     friend class WTF::DoublyLinkedListNode<VM>;
830 };
831
832 #if ENABLE(GC_VALIDATION)
833 inline bool VM::isInitializingObject() const
834 {
835     return !!m_initializingObjectClass;
836 }
837
838 inline void VM::setInitializingObjectClass(const ClassInfo* initializingObjectClass)
839 {
840     m_initializingObjectClass = initializingObjectClass;
841 }
842 #endif
843
844 inline Heap* WeakSet::heap() const
845 {
846     return &m_vm->heap;
847 }
848
849 #if ENABLE(JIT)
850 extern "C" void sanitizeStackForVMImpl(VM*);
851 #endif
852
853 void sanitizeStackForVM(VM*);
854 void logSanitizeStack(VM*);
855
856 } // namespace JSC