We should support CreateThis in the FTL
[WebKit-https.git] / Source / JavaScriptCore / runtime / Options.h
1 /*
2  * Copyright (C) 2011-2018 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "GCLogging.h"
29 #include "JSExportMacros.h"
30 #include <stdint.h>
31 #include <stdio.h>
32 #include <wtf/PrintStream.h>
33 #include <wtf/StdLibExtras.h>
34
35 namespace WTF {
36 class StringBuilder;
37 }
38 using WTF::StringBuilder;
39
40 namespace JSC {
41
42 // How do JSC VM options work?
43 // ===========================
44 // The JSC_OPTIONS() macro below defines a list of all JSC options in use,
45 // along with their types and default values. The options values are actually
46 // realized as an array of Options::Entry elements.
47 //
48 //     Options::initialize() will initialize the array of options values with
49 // the defaults specified in JSC_OPTIONS() below. After that, the values can
50 // be programmatically read and written to using an accessor method with the
51 // same name as the option. For example, the option "useJIT" can be read and
52 // set like so:
53 //
54 //     bool jitIsOn = Options::useJIT();  // Get the option value.
55 //     Options::useJIT() = false;         // Sets the option value.
56 //
57 //     If you want to tweak any of these values programmatically for testing
58 // purposes, you can do so in Options::initialize() after the default values
59 // are set.
60 //
61 //     Alternatively, you can override the default values by specifying
62 // environment variables of the form: JSC_<name of JSC option>.
63 //
64 // Note: Options::initialize() tries to ensure some sanity on the option values
65 // which are set by doing some range checks, and value corrections. These
66 // checks are done after the option values are set. If you alter the option
67 // values after the sanity checks (for your own testing), then you're liable to
68 // ensure that the new values set are sane and reasonable for your own run.
69
70 class OptionRange {
71 private:
72     enum RangeState { Uninitialized, InitError, Normal, Inverted };
73 public:
74     OptionRange& operator= (const int& rhs)
75     { // Only needed for initialization
76         if (!rhs) {
77             m_state = Uninitialized;
78             m_rangeString = 0;
79             m_lowLimit = 0;
80             m_highLimit = 0;
81         }
82         return *this;
83     }
84
85     bool init(const char*);
86     bool isInRange(unsigned);
87     const char* rangeString() const { return (m_state > InitError) ? m_rangeString : s_nullRangeStr; }
88     
89     void dump(PrintStream& out) const;
90
91 private:
92     static const char* const s_nullRangeStr;
93
94     RangeState m_state;
95     const char* m_rangeString;
96     unsigned m_lowLimit;
97     unsigned m_highLimit;
98 };
99
100 typedef OptionRange optionRange;
101 typedef const char* optionString;
102
103 #if PLATFORM(IOS)
104 #define MAXIMUM_NUMBER_OF_FTL_COMPILER_THREADS 2
105 #else
106 #define MAXIMUM_NUMBER_OF_FTL_COMPILER_THREADS 8
107 #endif
108
109 #if ENABLE(JS_ASYNC_ITERATION)
110 constexpr bool enableAsyncIteration = true;
111 #else
112 constexpr bool enableAsyncIteration = false;
113 #endif
114
115 #if ENABLE(INTL_NUMBER_FORMAT_TO_PARTS) && (!PLATFORM(COCOA) || ENABLE(EXPERIMENTAL_FEATURES))
116 constexpr bool enableIntlNumberFormatToParts = true;
117 #else
118 constexpr bool enableIntlNumberFormatToParts = false;
119 #endif
120
121 #if ENABLE(INTL_PLURAL_RULES) && (!PLATFORM(COCOA) || ENABLE(EXPERIMENTAL_FEATURES))
122 constexpr bool enableIntlPluralRules = true;
123 #else
124 constexpr bool enableIntlPluralRules = false;
125 #endif
126
127 #if ENABLE(WEBASSEMBLY_STREAMING_API)
128 constexpr bool enableWebAssemblyStreamingApi = true;
129 #else
130 constexpr bool enableWebAssemblyStreamingApi = false;
131 #endif
132
133 #define JSC_OPTIONS(v) \
134     v(bool, validateOptions, false, Normal, "crashes if mis-typed JSC options were passed to the VM") \
135     v(unsigned, dumpOptions, 0, Normal, "dumps JSC options (0 = None, 1 = Overridden only, 2 = All, 3 = Verbose)") \
136     v(optionString, configFile, nullptr, Normal, "file to configure JSC options and logging location") \
137     \
138     v(bool, useLLInt,  true, Normal, "allows the LLINT to be used if true") \
139     v(bool, useJIT,    true, Normal, "allows the executable pages to be allocated for JIT and thunks if true") \
140     v(bool, useBaselineJIT, true, Normal, "allows the baseline JIT to be used if true") \
141     v(bool, useDFGJIT, true, Normal, "allows the DFG JIT to be used if true") \
142     v(bool, useRegExpJIT, true, Normal, "allows the RegExp JIT to be used if true") \
143     v(bool, useDOMJIT, true, Normal, "allows the DOMJIT to be used if true") \
144     \
145     v(bool, reportMustSucceedExecutableAllocations, false, Normal, nullptr) \
146     \
147     v(unsigned, maxPerThreadStackUsage, 4 * MB, Normal, "Max allowed stack usage by the VM") \
148     v(unsigned, softReservedZoneSize, 128 * KB, Normal, "A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
149     v(unsigned, reservedZoneSize, 64 * KB, Normal, "The amount of stack space we guarantee to our clients (and to interal VM code that does not call out to clients).") \
150     \
151     v(bool, crashIfCantAllocateJITMemory, false, Normal, nullptr) \
152     v(unsigned, jitMemoryReservationSize, 0, Normal, "Set this number to change the executable allocation size in ExecutableAllocatorFixedVMPool. (In bytes.)") \
153     v(bool, useSeparatedWXHeap, false, Normal, nullptr) \
154     \
155     v(bool, forceCodeBlockLiveness, false, Normal, nullptr) \
156     v(bool, forceICFailure, false, Normal, nullptr) \
157     \
158     v(unsigned, repatchCountForCoolDown, 8, Normal, nullptr) \
159     v(unsigned, initialCoolDownCount, 20, Normal, nullptr) \
160     v(unsigned, repatchBufferingCountdown, 8, Normal, nullptr) \
161     \
162     v(bool, dumpGeneratedBytecodes, false, Normal, nullptr) \
163     v(bool, dumpBytecodeLivenessResults, false, Normal, nullptr) \
164     v(bool, validateBytecode, false, Normal, nullptr) \
165     v(bool, forceDebuggerBytecodeGeneration, false, Normal, nullptr) \
166     v(bool, dumpBytecodesBeforeGeneratorification, false, Normal, nullptr) \
167     \
168     v(bool, useFunctionDotArguments, true, Normal, nullptr) \
169     v(bool, useTailCalls, true, Normal, nullptr) \
170     v(bool, optimizeRecursiveTailCalls, true, Normal, nullptr) \
171     v(bool, alwaysUseShadowChicken, false, Normal, nullptr) \
172     v(unsigned, shadowChickenLogSize, 1000, Normal, nullptr) \
173     v(unsigned, shadowChickenMaxTailDeletedFramesSize, 128, Normal, nullptr) \
174     \
175     /* dumpDisassembly implies dumpDFGDisassembly. */ \
176     v(bool, dumpDisassembly, false, Normal, "dumps disassembly of all JIT compiled code upon compilation") \
177     v(bool, asyncDisassembly, false, Normal, nullptr) \
178     v(bool, dumpDFGDisassembly, false, Normal, "dumps disassembly of DFG function upon compilation") \
179     v(bool, dumpFTLDisassembly, false, Normal, "dumps disassembly of FTL function upon compilation") \
180     v(bool, dumpAllDFGNodes, false, Normal, nullptr) \
181     v(optionRange, bytecodeRangeToJITCompile, 0, Normal, "bytecode size range to allow compilation on, e.g. 1:100") \
182     v(optionRange, bytecodeRangeToDFGCompile, 0, Normal, "bytecode size range to allow DFG compilation on, e.g. 1:100") \
183     v(optionRange, bytecodeRangeToFTLCompile, 0, Normal, "bytecode size range to allow FTL compilation on, e.g. 1:100") \
184     v(optionString, jitWhitelist, nullptr, Normal, "file with list of function signatures to allow compilation on") \
185     v(optionString, dfgWhitelist, nullptr, Normal, "file with list of function signatures to allow DFG compilation on") \
186     v(optionString, ftlWhitelist, nullptr, Normal, "file with list of function signatures to allow FTL compilation on") \
187     v(bool, dumpSourceAtDFGTime, false, Normal, "dumps source code of JS function being DFG compiled") \
188     v(bool, dumpBytecodeAtDFGTime, false, Normal, "dumps bytecode of JS function being DFG compiled") \
189     v(bool, dumpGraphAfterParsing, false, Normal, nullptr) \
190     v(bool, dumpGraphAtEachPhase, false, Normal, nullptr) \
191     v(bool, dumpDFGGraphAtEachPhase, false, Normal, "dumps the DFG graph at each phase of DFG compilation (note this excludes DFG graphs during FTL compilation)") \
192     v(bool, dumpDFGFTLGraphAtEachPhase, false, Normal, "dumps the DFG graph at each phase of DFG compilation when compiling FTL code") \
193     v(bool, dumpB3GraphAtEachPhase, false, Normal, "dumps the B3 graph at each phase of compilation") \
194     v(bool, dumpAirGraphAtEachPhase, false, Normal, "dumps the Air graph at each phase of compilation") \
195     v(bool, verboseDFGBytecodeParsing, false, Normal, nullptr) \
196     v(bool, safepointBeforeEachPhase, true, Normal, nullptr) \
197     v(bool, verboseCompilation, false, Normal, nullptr) \
198     v(bool, verboseFTLCompilation, false, Normal, nullptr) \
199     v(bool, logCompilationChanges, false, Normal, nullptr) \
200     v(bool, useProbeOSRExit, false, Normal, nullptr) \
201     v(bool, printEachOSRExit, false, Normal, nullptr) \
202     v(bool, validateGraph, false, Normal, nullptr) \
203     v(bool, validateGraphAtEachPhase, false, Normal, nullptr) \
204     v(bool, verboseValidationFailure, false, Normal, nullptr) \
205     v(bool, verboseOSR, false, Normal, nullptr) \
206     v(bool, verboseDFGOSRExit, false, Normal, nullptr) \
207     v(bool, verboseFTLOSRExit, false, Normal, nullptr) \
208     v(bool, verboseCallLink, false, Normal, nullptr) \
209     v(bool, verboseCompilationQueue, false, Normal, nullptr) \
210     v(bool, reportCompileTimes, false, Normal, "dumps JS function signature and the time it took to compile in all tiers") \
211     v(bool, reportBaselineCompileTimes, false, Normal, "dumps JS function signature and the time it took to BaselineJIT compile") \
212     v(bool, reportDFGCompileTimes, false, Normal, "dumps JS function signature and the time it took to DFG and FTL compile") \
213     v(bool, reportFTLCompileTimes, false, Normal, "dumps JS function signature and the time it took to FTL compile") \
214     v(bool, reportTotalCompileTimes, false, Normal, nullptr) \
215     v(bool, reportParseTimes, false, Normal, "dumps JS function signature and the time it took to parse") \
216     v(bool, reportBytecodeCompileTimes, false, Normal, "dumps JS function signature and the time it took to bytecode compile") \
217     v(bool, verboseExitProfile, false, Normal, nullptr) \
218     v(bool, verboseCFA, false, Normal, nullptr) \
219     v(bool, verboseDFGFailure, false, Normal, nullptr) \
220     v(bool, verboseFTLToJSThunk, false, Normal, nullptr) \
221     v(bool, verboseFTLFailure, false, Normal, nullptr) \
222     v(bool, alwaysComputeHash, false, Normal, nullptr) \
223     v(bool, testTheFTL, false, Normal, nullptr) \
224     v(bool, verboseSanitizeStack, false, Normal, nullptr) \
225     v(bool, useGenerationalGC, true, Normal, nullptr) \
226     v(bool, useConcurrentBarriers, true, Normal, nullptr) \
227     v(bool, useConcurrentGC, true, Normal, nullptr) \
228     v(bool, collectContinuously, false, Normal, nullptr) \
229     v(double, collectContinuouslyPeriodMS, 1, Normal, nullptr) \
230     v(bool, forceFencedBarrier, false, Normal, nullptr) \
231     v(bool, verboseVisitRace, false, Normal, nullptr) \
232     v(bool, optimizeParallelSlotVisitorsForStoppedMutator, false, Normal, nullptr) \
233     v(unsigned, largeHeapSize, 32 * 1024 * 1024, Normal, nullptr) \
234     v(unsigned, smallHeapSize, 1 * 1024 * 1024, Normal, nullptr) \
235     v(double, smallHeapRAMFraction, 0.25, Normal, nullptr) \
236     v(double, smallHeapGrowthFactor, 2, Normal, nullptr) \
237     v(double, mediumHeapRAMFraction, 0.5, Normal, nullptr) \
238     v(double, mediumHeapGrowthFactor, 1.5, Normal, nullptr) \
239     v(double, largeHeapGrowthFactor, 1.24, Normal, nullptr) \
240     v(double, miniVMHeapGrowthFactor, 1.27, Normal, nullptr) \
241     v(double, criticalGCMemoryThreshold, 0.80, Normal, "percent memory in use the GC considers critical.  The collector is much more aggressive above this threshold") \
242     v(double, minimumMutatorUtilization, 0, Normal, nullptr) \
243     v(double, maximumMutatorUtilization, 0.7, Normal, nullptr) \
244     v(double, epsilonMutatorUtilization, 0.01, Normal, nullptr) \
245     v(double, concurrentGCMaxHeadroom, 1.5, Normal, nullptr) \
246     v(double, concurrentGCPeriodMS, 2, Normal, nullptr) \
247     v(bool, useStochasticMutatorScheduler, true, Normal, nullptr) \
248     v(double, minimumGCPauseMS, 0.3, Normal, nullptr) \
249     v(double, gcPauseScale, 0.3, Normal, nullptr) \
250     v(double, gcIncrementBytes, 10000, Normal, nullptr) \
251     v(double, gcIncrementMaxBytes, 100000, Normal, nullptr) \
252     v(double, gcIncrementScale, 0, Normal, nullptr) \
253     v(bool, scribbleFreeCells, false, Normal, nullptr) \
254     v(double, sizeClassProgression, 1.4, Normal, nullptr) \
255     v(unsigned, largeAllocationCutoff, 100000, Normal, nullptr) \
256     v(bool, dumpSizeClasses, false, Normal, nullptr) \
257     v(bool, useBumpAllocator, true, Normal, nullptr) \
258     v(bool, stealEmptyBlocksFromOtherAllocators, true, Normal, nullptr) \
259     v(bool, tradeDestructorBlocks, true, Normal, nullptr) \
260     v(bool, eagerlyUpdateTopCallFrame, false, Normal, nullptr) \
261     \
262     v(bool, useOSREntryToDFG, true, Normal, nullptr) \
263     v(bool, useOSREntryToFTL, true, Normal, nullptr) \
264     \
265     v(bool, useFTLJIT, true, Normal, "allows the FTL JIT to be used if true") \
266     v(bool, useFTLTBAA, true, Normal, nullptr) \
267     v(bool, validateFTLOSRExitLiveness, false, Normal, nullptr) \
268     v(unsigned, defaultB3OptLevel, 2, Normal, nullptr) \
269     v(bool, b3AlwaysFailsBeforeCompile, false, Normal, nullptr) \
270     v(bool, b3AlwaysFailsBeforeLink, false, Normal, nullptr) \
271     v(bool, ftlCrashes, false, Normal, nullptr) /* fool-proof way of checking that you ended up in the FTL. ;-) */\
272     v(bool, clobberAllRegsInFTLICSlowPath, !ASSERT_DISABLED, Normal, nullptr) \
273     v(bool, enableJITDebugAssertions, !ASSERT_DISABLED, Normal, nullptr) \
274     v(bool, useAccessInlining, true, Normal, nullptr) \
275     v(unsigned, maxAccessVariantListSize, 8, Normal, nullptr) \
276     v(bool, usePolyvariantDevirtualization, true, Normal, nullptr) \
277     v(bool, usePolymorphicAccessInlining, true, Normal, nullptr) \
278     v(unsigned, maxPolymorphicAccessInliningListSize, 8, Normal, nullptr) \
279     v(bool, usePolymorphicCallInlining, true, Normal, nullptr) \
280     v(bool, usePolymorphicCallInliningForNonStubStatus, false, Normal, nullptr) \
281     v(unsigned, maxPolymorphicCallVariantListSize, 15, Normal, nullptr) \
282     v(unsigned, maxPolymorphicCallVariantListSizeForTopTier, 5, Normal, nullptr) \
283     v(unsigned, maxPolymorphicCallVariantListSizeForWebAssemblyToJS, 5, Normal, nullptr) \
284     v(unsigned, maxPolymorphicCallVariantsForInlining, 5, Normal, nullptr) \
285     v(unsigned, frequentCallThreshold, 2, Normal, nullptr) \
286     v(double, minimumCallToKnownRate, 0.51, Normal, nullptr) \
287     v(bool, createPreHeaders, true, Normal, nullptr) \
288     v(bool, useMovHintRemoval, true, Normal, nullptr) \
289     v(bool, usePutStackSinking, true, Normal, nullptr) \
290     v(bool, useObjectAllocationSinking, true, Normal, nullptr) \
291     v(bool, useArityFixupInlining, true, Normal, nullptr) \
292     v(bool, logExecutableAllocation, false, Normal, nullptr) \
293     \
294     v(bool, useConcurrentJIT, true, Normal, "allows the DFG / FTL compilation in threads other than the executing JS thread") \
295     v(unsigned, numberOfDFGCompilerThreads, computeNumberOfWorkerThreads(3, 2) - 1, Normal, nullptr) \
296     v(unsigned, numberOfFTLCompilerThreads, computeNumberOfWorkerThreads(MAXIMUM_NUMBER_OF_FTL_COMPILER_THREADS, 2) - 1, Normal, nullptr) \
297     v(int32, priorityDeltaOfDFGCompilerThreads, computePriorityDeltaOfWorkerThreads(-1, 0), Normal, nullptr) \
298     v(int32, priorityDeltaOfFTLCompilerThreads, computePriorityDeltaOfWorkerThreads(-2, 0), Normal, nullptr) \
299     v(int32, priorityDeltaOfWasmCompilerThreads, computePriorityDeltaOfWorkerThreads(-1, 0), Normal, nullptr) \
300     \
301     v(bool, useProfiler, false, Normal, nullptr) \
302     v(bool, disassembleBaselineForProfiler, true, Normal, nullptr) \
303     \
304     v(bool, useArchitectureSpecificOptimizations, true, Normal, nullptr) \
305     \
306     v(bool, breakOnThrow, false, Normal, nullptr) \
307     \
308     v(unsigned, maximumOptimizationCandidateInstructionCount, 100000, Normal, nullptr) \
309     \
310     v(unsigned, maximumFunctionForCallInlineCandidateInstructionCount, 190, Normal, nullptr) \
311     v(unsigned, maximumFunctionForClosureCallInlineCandidateInstructionCount, 100, Normal, nullptr) \
312     v(unsigned, maximumFunctionForConstructInlineCandidateInstructionCount, 100, Normal, nullptr) \
313     \
314     v(unsigned, maximumFTLCandidateInstructionCount, 20000, Normal, nullptr) \
315     \
316     /* Depth of inline stack, so 1 = no inlining, 2 = one level, etc. */ \
317     v(unsigned, maximumInliningDepth, 5, Normal, "maximum allowed inlining depth.  Depth of 1 means no inlining") \
318     v(unsigned, maximumInliningRecursion, 2, Normal, nullptr) \
319     \
320     /* Maximum size of a caller for enabling inlining. This is purely to protect us */\
321     /* from super long compiles that take a lot of memory. */\
322     v(unsigned, maximumInliningCallerSize, 10000, Normal, nullptr) \
323     \
324     v(unsigned, maximumVarargsForInlining, 100, Normal, nullptr) \
325     \
326     v(bool, useMaximalFlushInsertionPhase, false, Normal, "Setting to true allows the DFG's MaximalFlushInsertionPhase to run.") \
327     \
328     v(unsigned, maximumBinaryStringSwitchCaseLength, 50, Normal, nullptr) \
329     v(unsigned, maximumBinaryStringSwitchTotalLength, 2000, Normal, nullptr) \
330     \
331     v(double, jitPolicyScale, 1.0, Normal, "scale JIT thresholds to this specified ratio between 0.0 (compile ASAP) and 1.0 (compile like normal).") \
332     v(bool, forceEagerCompilation, false, Normal, nullptr) \
333     v(int32, thresholdForJITAfterWarmUp, 500, Normal, nullptr) \
334     v(int32, thresholdForJITSoon, 100, Normal, nullptr) \
335     \
336     v(int32, thresholdForOptimizeAfterWarmUp, 1000, Normal, nullptr) \
337     v(int32, thresholdForOptimizeAfterLongWarmUp, 1000, Normal, nullptr) \
338     v(int32, thresholdForOptimizeSoon, 1000, Normal, nullptr) \
339     v(int32, executionCounterIncrementForLoop, 1, Normal, nullptr) \
340     v(int32, executionCounterIncrementForEntry, 15, Normal, nullptr) \
341     \
342     v(int32, thresholdForFTLOptimizeAfterWarmUp, 100000, Normal, nullptr) \
343     v(int32, thresholdForFTLOptimizeSoon, 1000, Normal, nullptr) \
344     v(int32, ftlTierUpCounterIncrementForLoop, 1, Normal, nullptr) \
345     v(int32, ftlTierUpCounterIncrementForReturn, 15, Normal, nullptr) \
346     v(unsigned, ftlOSREntryFailureCountForReoptimization, 15, Normal, nullptr) \
347     v(unsigned, ftlOSREntryRetryThreshold, 100, Normal, nullptr) \
348     \
349     v(int32, evalThresholdMultiplier, 10, Normal, nullptr) \
350     v(unsigned, maximumEvalCacheableSourceLength, 256, Normal, nullptr) \
351     \
352     v(bool, randomizeExecutionCountsBetweenCheckpoints, false, Normal, nullptr) \
353     v(int32, maximumExecutionCountsBetweenCheckpointsForBaseline, 1000, Normal, nullptr) \
354     v(int32, maximumExecutionCountsBetweenCheckpointsForUpperTiers, 50000, Normal, nullptr) \
355     \
356     v(unsigned, likelyToTakeSlowCaseMinimumCount, 20, Normal, nullptr) \
357     v(unsigned, couldTakeSlowCaseMinimumCount, 10, Normal, nullptr) \
358     \
359     v(unsigned, osrExitCountForReoptimization, 100, Normal, nullptr) \
360     v(unsigned, osrExitCountForReoptimizationFromLoop, 5, Normal, nullptr) \
361     \
362     v(unsigned, reoptimizationRetryCounterMax, 0, Normal, nullptr)  \
363     \
364     v(unsigned, minimumOptimizationDelay, 1, Normal, nullptr) \
365     v(unsigned, maximumOptimizationDelay, 5, Normal, nullptr) \
366     v(double, desiredProfileLivenessRate, 0.75, Normal, nullptr) \
367     v(double, desiredProfileFullnessRate, 0.35, Normal, nullptr) \
368     \
369     v(double, doubleVoteRatioForDoubleFormat, 2, Normal, nullptr) \
370     v(double, structureCheckVoteRatioForHoisting, 1, Normal, nullptr) \
371     v(double, checkArrayVoteRatioForHoisting, 1, Normal, nullptr) \
372     \
373     v(unsigned, maximumDirectCallStackSize, 200, Normal, nullptr) \
374     \
375     v(unsigned, minimumNumberOfScansBetweenRebalance, 100, Normal, nullptr) \
376     v(unsigned, numberOfGCMarkers, computeNumberOfGCMarkers(8), Normal, nullptr) \
377     v(bool, useParallelMarkingConstraintSolver, true, Normal, nullptr) \
378     v(unsigned, opaqueRootMergeThreshold, 1000, Normal, nullptr) \
379     v(double, minHeapUtilization, 0.8, Normal, nullptr) \
380     v(double, minMarkedBlockUtilization, 0.9, Normal, nullptr) \
381     v(unsigned, slowPathAllocsBetweenGCs, 0, Normal, "force a GC on every Nth slow path alloc, where N is specified by this option") \
382     \
383     v(double, percentCPUPerMBForFullTimer, 0.0003125, Normal, nullptr) \
384     v(double, percentCPUPerMBForEdenTimer, 0.0025, Normal, nullptr) \
385     v(double, collectionTimerMaxPercentCPU, 0.05, Normal, nullptr) \
386     \
387     v(bool, forceWeakRandomSeed, false, Normal, nullptr) \
388     v(unsigned, forcedWeakRandomSeed, 0, Normal, nullptr) \
389     \
390     v(bool, useZombieMode, false, Normal, "debugging option to scribble over dead objects with 0xbadbeef0") \
391     v(bool, useImmortalObjects, false, Normal, "debugging option to keep all objects alive forever") \
392     v(bool, sweepSynchronously, false, Normal, "debugging option to sweep all dead objects synchronously at GC end before resuming mutator") \
393     v(unsigned, maxSingleAllocationSize, 0, Configurable, "debugging option to limit individual allocations to a max size (0 = limit not set, N = limit size in bytes)") \
394     \
395     v(gcLogLevel, logGC, GCLogging::None, Normal, "debugging option to log GC activity (0 = None, 1 = Basic, 2 = Verbose)") \
396     v(bool, useGC, true, Normal, nullptr) \
397     v(bool, gcAtEnd, false, Normal, "If true, the jsc CLI will do a GC before exiting") \
398     v(bool, forceGCSlowPaths, false, Normal, "If true, we will force all JIT fast allocations down their slow paths.") \
399     v(unsigned, gcMaxHeapSize, 0, Normal, nullptr) \
400     v(unsigned, forceRAMSize, 0, Normal, nullptr) \
401     v(bool, recordGCPauseTimes, false, Normal, nullptr) \
402     v(bool, logHeapStatisticsAtExit, false, Normal, nullptr) \
403     v(bool, forceCodeBlockToJettisonDueToOldAge, false, Normal, "If true, this means that anytime we can jettison a CodeBlock due to old age, we do.") \
404     v(bool, useEagerCodeBlockJettisonTiming, false, Normal, "If true, the time slices for jettisoning a CodeBlock due to old age are shrunk significantly.") \
405     \
406     v(bool, useTypeProfiler, false, Normal, nullptr) \
407     v(bool, useControlFlowProfiler, false, Normal, nullptr) \
408     \
409     v(bool, useSamplingProfiler, false, Normal, nullptr) \
410     v(unsigned, sampleInterval, 1000, Normal, "Time between stack traces in microseconds.") \
411     v(bool, collectSamplingProfilerDataForJSCShell, false, Normal, "This corresponds to the JSC shell's --sample option.") \
412     v(unsigned, samplingProfilerTopFunctionsCount, 12, Normal, "Number of top functions to report when using the command line interface.") \
413     v(unsigned, samplingProfilerTopBytecodesCount, 40, Normal, "Number of top bytecodes to report when using the command line interface.") \
414     v(optionString, samplingProfilerPath, nullptr, Normal, "The path to the directory to write sampiling profiler output to. This probably will not work with WK2 unless the path is in the whitelist.") \
415     v(bool, sampleCCode, false, Normal, "Causes the sampling profiler to record profiling data for C frames.") \
416     \
417     v(bool, alwaysGeneratePCToCodeOriginMap, false, Normal, "This will make sure we always generate a PCToCodeOriginMap for JITed code.") \
418     \
419     v(bool, verifyHeap, false, Normal, nullptr) \
420     v(unsigned, numberOfGCCyclesToRecordForVerification, 3, Normal, nullptr) \
421     \
422     v(unsigned, exceptionStackTraceLimit, 100, Normal, "Stack trace limit for internal Exception object") \
423     v(unsigned, defaultErrorStackTraceLimit, 100, Normal, "The default value for Error.stackTraceLimit") \
424     v(bool, useExceptionFuzz, false, Normal, nullptr) \
425     v(unsigned, fireExceptionFuzzAt, 0, Normal, nullptr) \
426     v(bool, validateDFGExceptionHandling, false, Normal, "Causes the DFG to emit code validating exception handling for each node that can exit") /* This is true by default on Debug builds */\
427     v(bool, dumpSimulatedThrows, false, Normal, "Dumps the call stack of the last simulated throw if exception scope verification fails") \
428     v(bool, validateExceptionChecks, false, Normal, "Verifies that needed exception checks are performed.") \
429     v(unsigned, unexpectedExceptionStackTraceLimit, 100, Normal, "Stack trace limit for debugging unexpected exceptions observed in the VM") \
430     \
431     v(bool, useExecutableAllocationFuzz, false, Normal, nullptr) \
432     v(unsigned, fireExecutableAllocationFuzzAt, 0, Normal, nullptr) \
433     v(unsigned, fireExecutableAllocationFuzzAtOrAfter, 0, Normal, nullptr) \
434     v(bool, verboseExecutableAllocationFuzz, false, Normal, nullptr) \
435     \
436     v(bool, useOSRExitFuzz, false, Normal, nullptr) \
437     v(unsigned, fireOSRExitFuzzAtStatic, 0, Normal, nullptr) \
438     v(unsigned, fireOSRExitFuzzAt, 0, Normal, nullptr) \
439     v(unsigned, fireOSRExitFuzzAtOrAfter, 0, Normal, nullptr) \
440     \
441     v(bool, logPhaseTimes, false, Normal, nullptr) \
442     v(double, rareBlockPenalty, 0.001, Normal, nullptr) \
443     v(bool, airLinearScanVerbose, false, Normal, nullptr) \
444     v(bool, airLinearScanSpillsEverything, false, Normal, nullptr) \
445     v(bool, airForceBriggsAllocator, false, Normal, nullptr) \
446     v(bool, airForceIRCAllocator, false, Normal, nullptr) \
447     v(bool, airRandomizeRegs, false, Normal, nullptr) \
448     v(bool, coalesceSpillSlots, true, Normal, nullptr) \
449     v(bool, logAirRegisterPressure, false, Normal, nullptr) \
450     v(bool, useB3TailDup, true, Normal, nullptr) \
451     v(unsigned, maxB3TailDupBlockSize, 3, Normal, nullptr) \
452     v(unsigned, maxB3TailDupBlockSuccessors, 3, Normal, nullptr) \
453     \
454     v(bool, useDollarVM, false, Restricted, "installs the $vm debugging tool in global objects") \
455     v(optionString, functionOverrides, nullptr, Restricted, "file with debugging overrides for function bodies") \
456     v(bool, useSigillCrashAnalyzer, false, Configurable, "logs data about SIGILL crashes") \
457     \
458     v(unsigned, watchdog, 0, Normal, "watchdog timeout (0 = Disabled, N = a timeout period of N milliseconds)") \
459     v(bool, usePollingTraps, false, Normal, "use polling (instead of signalling) VM traps") \
460     \
461     v(bool, useMachForExceptions, true, Normal, "Use mach exceptions rather than signals to handle faults and pass thread messages. (This does nothing on platforms without mach)") \
462     \
463     v(bool, useICStats, false, Normal, nullptr) \
464     \
465     v(unsigned, prototypeHitCountForLLIntCaching, 2, Normal, "Number of prototype property hits before caching a prototype in the LLInt. A count of 0 means never cache.") \
466     \
467     v(bool, dumpCompiledRegExpPatterns, false, Normal, nullptr) \
468     \
469     v(bool, dumpModuleRecord, false, Normal, nullptr) \
470     v(bool, dumpModuleLoadingState, false, Normal, nullptr) \
471     v(bool, exposeInternalModuleLoader, false, Normal, "expose the internal module loader object to the global space for debugging") \
472     \
473     v(bool, useSuperSampler, false, Normal, nullptr) \
474     \
475     v(bool, useSourceProviderCache, true, Normal, "If false, the parser will not use the source provider cache. It's good to verify everything works when this is false. Because the cache is so successful, it can mask bugs.") \
476     v(bool, useCodeCache, true, Normal, "If false, the unlinked byte code cache will not be used.") \
477     \
478     v(bool, useWebAssembly, true, Normal, "Expose the WebAssembly global object.") \
479     \
480     v(bool, enableSpectreMitigations, true, Restricted, "Enable Spectre mitigations.") \
481     v(bool, enableSpectreGadgets, false, Restricted, "enable gadgets to test Spectre mitigations.") \
482     v(bool, usePoisoning, true, Normal, "Poison is randomized at load time when true, and initialized to 0 if false which defeats some Spectre and type confusion mitigations, but allows tools such as leak detectors to function better.") \
483     v(bool, zeroStackFrame, false, Normal, "Zero stack frame on entry to a function.") \
484     \
485     v(bool, useAsyncIterator, enableAsyncIteration, Normal, "Allow to use Async Iterator in JS.") \
486     \
487     v(bool, failToCompileWebAssemblyCode, false, Normal, "If true, no Wasm::Plan will sucessfully compile a function.") \
488     v(size, webAssemblyPartialCompileLimit, 5000, Normal, "Limit on the number of bytes a Wasm::Plan::compile should attempt before checking for other work.") \
489     v(unsigned, webAssemblyBBQOptimizationLevel, 1, Normal, "B3 Optimization level for BBQ Web Assembly module compilations.") \
490     v(unsigned, webAssemblyOMGOptimizationLevel, Options::defaultB3OptLevel(), Normal, "B3 Optimization level for OMG Web Assembly module compilations.") \
491     \
492     v(bool, useBBQTierUpChecks, true, Normal, "Enables tier up checks for our BBQ code.") \
493     v(unsigned, webAssemblyOMGTierUpCount, 5000, Normal, "The countdown before we tier up a function to OMG.") \
494     v(unsigned, webAssemblyLoopDecrement, 15, Normal, "The amount the tier up countdown is decremented on each loop backedge.") \
495     v(unsigned, webAssemblyFunctionEntryDecrement, 1, Normal, "The amount the tier up countdown is decremented on each function entry.") \
496     \
497     /* FIXME: enable fast memories on iOS and pre-allocate them. https://bugs.webkit.org/show_bug.cgi?id=170774 */ \
498     v(bool, useWebAssemblyFastMemory, !isIOS(), Normal, "If true, we will try to use a 32-bit address space with a signal handler to bounds check wasm memory.") \
499     v(bool, logWebAssemblyMemory, false, Normal, nullptr) \
500     v(unsigned, webAssemblyFastMemoryRedzonePages, 128, Normal, "WebAssembly fast memories use 4GiB virtual allocations, plus a redzone (counted as multiple of 64KiB WebAssembly pages) at the end to catch reg+imm accesses which exceed 32-bit, anything beyond the redzone is explicitly bounds-checked") \
501     v(bool, crashIfWebAssemblyCantFastMemory, false, Normal, "If true, we will crash if we can't obtain fast memory for wasm.") \
502     v(unsigned, maxNumWebAssemblyFastMemories, 4, Normal, nullptr) \
503     v(bool, useFastTLSForWasmContext, true, Normal, "If true, we will store context in fast TLS. If false, we will pin it to a register.") \
504     v(bool, useWebAssemblyStreamingApi, enableWebAssemblyStreamingApi, Normal, "Allow to run WebAssembly's Streaming API") \
505     v(bool, useCallICsForWebAssemblyToJSCalls, true, Normal, "If true, we will use CallLinkInfo to inline cache Wasm to JS calls.") \
506     v(bool, useEagerWebAssemblyModuleHashing, false, Normal, "Unnamed WebAssembly modules are identified in backtraces through their hash, if available.") \
507     v(bool, useObjectRestSpread, true, Normal, "If true, we will enable Object Rest/Spread feature.") \
508     v(bool, useBigInt, false, Normal, "If true, we will enable BigInt support.") \
509     v(bool, useIntlNumberFormatToParts, enableIntlNumberFormatToParts, Normal, "If true, we will enable Intl.NumberFormat.prototype.formatToParts") \
510     v(bool, useIntlPluralRules, enableIntlPluralRules, Normal, "If true, we will enable Intl.PluralRules.") \
511     v(bool, useArrayAllocationProfiling, true, Normal, "If true, we will use our normal array allocation profiling. If false, the allocation profile will always claim to be undecided.") \
512     v(bool, forcePolyProto, false, Normal, "If true, create_this will always create an object with a poly proto structure.") \
513     v(bool, forceMiniVMMode, false, Normal, "If true, it will force mini VM mode on.") \
514     v(bool, useTracePoints, false, Normal, nullptr) \
515     v(bool, traceLLIntExecution, false, Configurable, nullptr) \
516     v(bool, traceLLIntSlowPath, false, Configurable, nullptr) \
517
518
519 enum OptionEquivalence {
520     SameOption,
521     InvertedOption,
522 };
523
524 #define JSC_ALIASED_OPTIONS(v) \
525     v(enableFunctionDotArguments, useFunctionDotArguments, SameOption) \
526     v(enableTailCalls, useTailCalls, SameOption) \
527     v(showDisassembly, dumpDisassembly, SameOption) \
528     v(showDFGDisassembly, dumpDFGDisassembly, SameOption) \
529     v(showFTLDisassembly, dumpFTLDisassembly, SameOption) \
530     v(showAllDFGNodes, dumpAllDFGNodes, SameOption) \
531     v(alwaysDoFullCollection, useGenerationalGC, InvertedOption) \
532     v(enableOSREntryToDFG, useOSREntryToDFG, SameOption) \
533     v(enableOSREntryToFTL, useOSREntryToFTL, SameOption) \
534     v(enableAccessInlining, useAccessInlining, SameOption) \
535     v(enablePolyvariantDevirtualization, usePolyvariantDevirtualization, SameOption) \
536     v(enablePolymorphicAccessInlining, usePolymorphicAccessInlining, SameOption) \
537     v(enablePolymorphicCallInlining, usePolymorphicCallInlining, SameOption) \
538     v(enableMovHintRemoval, useMovHintRemoval, SameOption) \
539     v(enableObjectAllocationSinking, useObjectAllocationSinking, SameOption) \
540     v(enableConcurrentJIT, useConcurrentJIT, SameOption) \
541     v(enableProfiler, useProfiler, SameOption) \
542     v(enableArchitectureSpecificOptimizations, useArchitectureSpecificOptimizations, SameOption) \
543     v(enablePolyvariantCallInlining, usePolyvariantCallInlining, SameOption) \
544     v(enablePolyvariantByIdInlining, usePolyvariantByIdInlining, SameOption) \
545     v(enableMaximalFlushInsertionPhase, useMaximalFlushInsertionPhase, SameOption) \
546     v(objectsAreImmortal, useImmortalObjects, SameOption) \
547     v(showObjectStatistics, dumpObjectStatistics, SameOption) \
548     v(disableGC, useGC, InvertedOption) \
549     v(enableTypeProfiler, useTypeProfiler, SameOption) \
550     v(enableControlFlowProfiler, useControlFlowProfiler, SameOption) \
551     v(enableExceptionFuzz, useExceptionFuzz, SameOption) \
552     v(enableExecutableAllocationFuzz, useExecutableAllocationFuzz, SameOption) \
553     v(enableOSRExitFuzz, useOSRExitFuzz, SameOption) \
554     v(enableDollarVM, useDollarVM, SameOption) \
555     v(enableWebAssembly, useWebAssembly, SameOption) \
556     v(enableAsyncIterator, useAsyncIterator, SameOption) \
557     v(verboseDFGByteCodeParsing, verboseDFGBytecodeParsing, SameOption) \
558
559
560 class Options {
561 public:
562     enum class DumpLevel {
563         None = 0,
564         Overridden,
565         All,
566         Verbose
567     };
568
569     enum class Availability {
570         Normal = 0,
571         Restricted,
572         Configurable
573     };
574
575     // This typedef is to allow us to eliminate the '_' in the field name in
576     // union inside Entry. This is needed to keep the style checker happy.
577     typedef int32_t int32;
578     typedef size_t size;
579
580     // Declare the option IDs:
581     enum ID {
582 #define FOR_EACH_OPTION(type_, name_, defaultValue_, availability_, description_) \
583         name_##ID,
584         JSC_OPTIONS(FOR_EACH_OPTION)
585 #undef FOR_EACH_OPTION
586         numberOfOptions
587     };
588
589     enum class Type {
590         boolType,
591         unsignedType,
592         doubleType,
593         int32Type,
594         sizeType,
595         optionRangeType,
596         optionStringType,
597         gcLogLevelType,
598     };
599
600     JS_EXPORT_PRIVATE static void initialize();
601
602     // Parses a string of options where each option is of the format "--<optionName>=<value>"
603     // and are separated by a space. The leading "--" is optional and will be ignored.
604     JS_EXPORT_PRIVATE static bool setOptions(const char* optionsList);
605
606     // Parses a single command line option in the format "<optionName>=<value>"
607     // (no spaces allowed) and set the specified option if appropriate.
608     JS_EXPORT_PRIVATE static bool setOption(const char* arg);
609
610     JS_EXPORT_PRIVATE static void dumpAllOptions(FILE*, DumpLevel, const char* title = nullptr);
611     JS_EXPORT_PRIVATE static void dumpAllOptionsInALine(StringBuilder&);
612
613     JS_EXPORT_PRIVATE static void ensureOptionsAreCoherent();
614
615     JS_EXPORT_PRIVATE static void enableRestrictedOptions(bool enableOrNot);
616
617     // Declare accessors for each option:
618 #define FOR_EACH_OPTION(type_, name_, defaultValue_, availability_, description_) \
619     ALWAYS_INLINE static type_& name_() { return s_options[name_##ID].type_##Val; } \
620     ALWAYS_INLINE static type_& name_##Default() { return s_defaultOptions[name_##ID].type_##Val; }
621
622     JSC_OPTIONS(FOR_EACH_OPTION)
623 #undef FOR_EACH_OPTION
624
625     static bool isAvailable(ID, Availability);
626
627 private:
628     // For storing for an option value:
629     union Entry {
630         bool boolVal;
631         unsigned unsignedVal;
632         double doubleVal;
633         int32 int32Val;
634         size sizeVal;
635         OptionRange optionRangeVal;
636         const char* optionStringVal;
637         GCLogging::Level gcLogLevelVal;
638     };
639
640     // For storing constant meta data about each option:
641     struct EntryInfo {
642         const char* name;
643         const char* description;
644         Type type;
645         Availability availability;
646     };
647
648     Options();
649
650     enum DumpDefaultsOption {
651         DontDumpDefaults,
652         DumpDefaults
653     };
654     static void dumpOptionsIfNeeded();
655     static void dumpAllOptions(StringBuilder&, DumpLevel, const char* title,
656         const char* separator, const char* optionHeader, const char* optionFooter, DumpDefaultsOption);
657     static void dumpOption(StringBuilder&, DumpLevel, ID,
658         const char* optionHeader, const char* optionFooter, DumpDefaultsOption);
659
660     static bool setOptionWithoutAlias(const char* arg);
661     static bool setAliasedOption(const char* arg);
662     static bool overrideAliasedOptionWithHeuristic(const char* name);
663
664     // Declare the singleton instance of the options store:
665     JS_EXPORT_PRIVATE static Entry s_options[numberOfOptions];
666     static Entry s_defaultOptions[numberOfOptions];
667     static const EntryInfo s_optionsInfo[numberOfOptions];
668
669     friend class Option;
670 };
671
672 class Option {
673 public:
674     Option(Options::ID id)
675         : m_id(id)
676         , m_entry(Options::s_options[m_id])
677     {
678     }
679     
680     void dump(StringBuilder&) const;
681
682     bool operator==(const Option& other) const;
683     bool operator!=(const Option& other) const { return !(*this == other); }
684     
685     Options::ID id() const { return m_id; }
686     const char* name() const;
687     const char* description() const;
688     Options::Type type() const;
689     Options::Availability availability() const;
690     bool isOverridden() const;
691     const Option defaultOption() const;
692     
693     bool& boolVal();
694     unsigned& unsignedVal();
695     double& doubleVal();
696     int32_t& int32Val();
697     OptionRange optionRangeVal();
698     const char* optionStringVal();
699     GCLogging::Level& gcLogLevelVal();
700     
701 private:
702     // Only used for constructing default Options.
703     Option(Options::ID id, Options::Entry& entry)
704         : m_id(id)
705         , m_entry(entry)
706     {
707     }
708     
709     Options::ID m_id;
710     Options::Entry& m_entry;
711 };
712
713 inline const char* Option::name() const
714 {
715     return Options::s_optionsInfo[m_id].name;
716 }
717
718 inline const char* Option::description() const
719 {
720     return Options::s_optionsInfo[m_id].description;
721 }
722
723 inline Options::Type Option::type() const
724 {
725     return Options::s_optionsInfo[m_id].type;
726 }
727
728 inline Options::Availability Option::availability() const
729 {
730     return Options::s_optionsInfo[m_id].availability;
731 }
732
733 inline bool Option::isOverridden() const
734 {
735     return *this != defaultOption();
736 }
737
738 inline const Option Option::defaultOption() const
739 {
740     return Option(m_id, Options::s_defaultOptions[m_id]);
741 }
742
743 inline bool& Option::boolVal()
744 {
745     return m_entry.boolVal;
746 }
747
748 inline unsigned& Option::unsignedVal()
749 {
750     return m_entry.unsignedVal;
751 }
752
753 inline double& Option::doubleVal()
754 {
755     return m_entry.doubleVal;
756 }
757
758 inline int32_t& Option::int32Val()
759 {
760     return m_entry.int32Val;
761 }
762
763 inline OptionRange Option::optionRangeVal()
764 {
765     return m_entry.optionRangeVal;
766 }
767
768 inline const char* Option::optionStringVal()
769 {
770     return m_entry.optionStringVal;
771 }
772
773 inline GCLogging::Level& Option::gcLogLevelVal()
774 {
775     return m_entry.gcLogLevelVal;
776 }
777
778 } // namespace JSC