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