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