Bmalloc and GC should put auxiliaries (butterflies, typed array backing stores) in...
[WebKit.git] / Source / JavaScriptCore / runtime / Options.h
1 /*
2  * Copyright (C) 2011-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  * 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 #define JSC_OPTIONS(v) \
110     v(bool, validateOptions, false, Normal, "crashes if mis-typed JSC options were passed to the VM") \
111     v(unsigned, dumpOptions, 0, Normal, "dumps JSC options (0 = None, 1 = Overridden only, 2 = All, 3 = Verbose)") \
112     v(optionString, configFile, nullptr, Normal, "file to configure JSC options and logging location") \
113     \
114     v(bool, useLLInt,  true, Normal, "allows the LLINT to be used if true") \
115     v(bool, useJIT,    true, Normal, "allows the executable pages to be allocated for JIT and thunks if true") \
116     v(bool, useBaselineJIT, true, Normal, "allows the baseline JIT to be used if true") \
117     v(bool, useDFGJIT, true, Normal, "allows the DFG JIT to be used if true") \
118     v(bool, useRegExpJIT, true, Normal, "allows the RegExp JIT to be used if true") \
119     v(bool, useDOMJIT, true, Normal, "allows the DOMJIT to be used if true") \
120     \
121     v(bool, reportMustSucceedExecutableAllocations, false, Normal, nullptr) \
122     \
123     v(unsigned, maxPerThreadStackUsage, 4 * MB, Normal, "Max allowed stack usage by the VM") \
124     v(unsigned, softReservedZoneSize, 128 * KB, Normal, "A buffer greater than reservedZoneSize that reserves space for stringifying exceptions.") \
125     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).") \
126     \
127     v(bool, crashIfCantAllocateJITMemory, false, Normal, nullptr) \
128     v(unsigned, jitMemoryReservationSize, 0, Normal, "Set this number to change the executable allocation size in ExecutableAllocatorFixedVMPool. (In bytes.)") \
129     v(bool, useSeparatedWXHeap, false, Normal, nullptr) \
130     \
131     v(bool, forceCodeBlockLiveness, false, Normal, nullptr) \
132     v(bool, forceICFailure, false, Normal, nullptr) \
133     \
134     v(unsigned, repatchCountForCoolDown, 8, Normal, nullptr) \
135     v(unsigned, initialCoolDownCount, 20, Normal, nullptr) \
136     v(unsigned, repatchBufferingCountdown, 8, Normal, nullptr) \
137     \
138     v(bool, dumpGeneratedBytecodes, false, Normal, nullptr) \
139     v(bool, dumpBytecodeLivenessResults, false, Normal, nullptr) \
140     v(bool, validateBytecode, false, Normal, nullptr) \
141     v(bool, forceDebuggerBytecodeGeneration, false, Normal, nullptr) \
142     v(bool, dumpBytecodesBeforeGeneratorification, false, Normal, nullptr) \
143     \
144     v(bool, useFunctionDotArguments, true, Normal, nullptr) \
145     v(bool, useTailCalls, true, Normal, nullptr) \
146     v(bool, alwaysUseShadowChicken, false, Normal, nullptr) \
147     v(unsigned, shadowChickenLogSize, 1000, Normal, nullptr) \
148     v(unsigned, shadowChickenMaxTailDeletedFramesSize, 128, Normal, nullptr) \
149     \
150     /* dumpDisassembly implies dumpDFGDisassembly. */ \
151     v(bool, dumpDisassembly, false, Normal, "dumps disassembly of all JIT compiled code upon compilation") \
152     v(bool, asyncDisassembly, false, Normal, nullptr) \
153     v(bool, dumpDFGDisassembly, false, Normal, "dumps disassembly of DFG function upon compilation") \
154     v(bool, dumpFTLDisassembly, false, Normal, "dumps disassembly of FTL function upon compilation") \
155     v(bool, dumpAllDFGNodes, false, Normal, nullptr) \
156     v(optionRange, bytecodeRangeToJITCompile, 0, Normal, "bytecode size range to allow compilation on, e.g. 1:100") \
157     v(optionRange, bytecodeRangeToDFGCompile, 0, Normal, "bytecode size range to allow DFG compilation on, e.g. 1:100") \
158     v(optionRange, bytecodeRangeToFTLCompile, 0, Normal, "bytecode size range to allow FTL compilation on, e.g. 1:100") \
159     v(optionString, jitWhitelist, nullptr, Normal, "file with list of function signatures to allow compilation on") \
160     v(optionString, dfgWhitelist, nullptr, Normal, "file with list of function signatures to allow DFG compilation on") \
161     v(optionString, ftlWhitelist, nullptr, Normal, "file with list of function signatures to allow FTL compilation on") \
162     v(bool, dumpSourceAtDFGTime, false, Normal, "dumps source code of JS function being DFG compiled") \
163     v(bool, dumpBytecodeAtDFGTime, false, Normal, "dumps bytecode of JS function being DFG compiled") \
164     v(bool, dumpGraphAfterParsing, false, Normal, nullptr) \
165     v(bool, dumpGraphAtEachPhase, false, Normal, nullptr) \
166     v(bool, dumpDFGGraphAtEachPhase, false, Normal, "dumps the DFG graph at each phase of DFG compilation (note this excludes DFG graphs during FTL compilation)") \
167     v(bool, dumpDFGFTLGraphAtEachPhase, false, Normal, "dumps the DFG graph at each phase of DFG compilation when compiling FTL code") \
168     v(bool, dumpB3GraphAtEachPhase, false, Normal, "dumps the B3 graph at each phase of compilation") \
169     v(bool, dumpAirGraphAtEachPhase, false, Normal, "dumps the Air graph at each phase of compilation") \
170     v(bool, verboseDFGByteCodeParsing, false, Normal, nullptr) \
171     v(bool, safepointBeforeEachPhase, true, Normal, nullptr) \
172     v(bool, verboseCompilation, false, Normal, nullptr) \
173     v(bool, verboseFTLCompilation, false, Normal, nullptr) \
174     v(bool, logCompilationChanges, false, Normal, nullptr) \
175     v(bool, printEachOSRExit, false, Normal, nullptr) \
176     v(bool, validateGraph, false, Normal, nullptr) \
177     v(bool, validateGraphAtEachPhase, false, Normal, nullptr) \
178     v(bool, verboseValidationFailure, false, Normal, nullptr) \
179     v(bool, verboseOSR, false, Normal, nullptr) \
180     v(bool, verboseDFGOSRExit, false, Normal, nullptr) \
181     v(bool, verboseFTLOSRExit, false, Normal, nullptr) \
182     v(bool, verboseCallLink, false, Normal, nullptr) \
183     v(bool, verboseCompilationQueue, false, Normal, nullptr) \
184     v(bool, reportCompileTimes, false, Normal, "dumps JS function signature and the time it took to compile in all tiers") \
185     v(bool, reportBaselineCompileTimes, false, Normal, "dumps JS function signature and the time it took to BaselineJIT compile") \
186     v(bool, reportDFGCompileTimes, false, Normal, "dumps JS function signature and the time it took to DFG and FTL compile") \
187     v(bool, reportFTLCompileTimes, false, Normal, "dumps JS function signature and the time it took to FTL compile") \
188     v(bool, reportDFGPhaseTimes, false, Normal, "dumps JS function name and the time is took for each DFG phase") \
189     v(bool, reportTotalCompileTimes, false, Normal, nullptr) \
190     v(bool, verboseExitProfile, false, Normal, nullptr) \
191     v(bool, verboseCFA, false, Normal, nullptr) \
192     v(bool, verboseDFGFailure, false, Normal, nullptr) \
193     v(bool, verboseFTLToJSThunk, false, Normal, nullptr) \
194     v(bool, verboseFTLFailure, false, Normal, nullptr) \
195     v(bool, alwaysComputeHash, false, Normal, nullptr) \
196     v(bool, testTheFTL, false, Normal, nullptr) \
197     v(bool, verboseSanitizeStack, false, Normal, nullptr) \
198     v(bool, useGenerationalGC, true, Normal, nullptr) \
199     v(bool, useConcurrentBarriers, true, Normal, nullptr) \
200     v(bool, useConcurrentGC, true, Normal, nullptr) \
201     v(bool, collectContinuously, false, Normal, nullptr) \
202     v(double, collectContinuouslyPeriodMS, 1, Normal, nullptr) \
203     v(bool, forceFencedBarrier, false, Normal, nullptr) \
204     v(bool, verboseVisitRace, false, Normal, nullptr) \
205     v(bool, optimizeParallelSlotVisitorsForStoppedMutator, false, Normal, nullptr) \
206     v(unsigned, largeHeapSize, 32 * 1024 * 1024, Normal, nullptr) \
207     v(unsigned, smallHeapSize, 1 * 1024 * 1024, Normal, nullptr) \
208     v(double, smallHeapRAMFraction, 0.25, Normal, nullptr) \
209     v(double, smallHeapGrowthFactor, 2, Normal, nullptr) \
210     v(double, mediumHeapRAMFraction, 0.5, Normal, nullptr) \
211     v(double, mediumHeapGrowthFactor, 1.5, Normal, nullptr) \
212     v(double, largeHeapGrowthFactor, 1.24, Normal, nullptr) \
213     v(double, criticalGCMemoryThreshold, 0.80, Normal, "percent memory in use the GC considers critical.  The collector is much more aggressive above this threshold") \
214     v(double, minimumMutatorUtilization, 0, Normal, nullptr) \
215     v(double, maximumMutatorUtilization, 0.7, Normal, nullptr) \
216     v(double, epsilonMutatorUtilization, 0.01, Normal, nullptr) \
217     v(double, concurrentGCMaxHeadroom, 1.5, Normal, nullptr) \
218     v(double, concurrentGCPeriodMS, 2, Normal, nullptr) \
219     v(bool, useStochasticMutatorScheduler, true, Normal, nullptr) \
220     v(double, minimumGCPauseMS, 0.3, Normal, nullptr) \
221     v(double, gcPauseScale, 0.3, Normal, nullptr) \
222     v(double, gcIncrementBytes, 10000, Normal, nullptr) \
223     v(double, gcIncrementMaxBytes, 100000, Normal, nullptr) \
224     v(double, gcIncrementScale, 0, Normal, nullptr) \
225     v(bool, scribbleFreeCells, false, Normal, nullptr) \
226     v(double, sizeClassProgression, 1.4, Normal, nullptr) \
227     v(unsigned, largeAllocationCutoff, 100000, Normal, nullptr) \
228     v(bool, dumpSizeClasses, false, Normal, nullptr) \
229     v(bool, useBumpAllocator, true, Normal, nullptr) \
230     v(bool, stealEmptyBlocksFromOtherAllocators, true, Normal, nullptr) \
231     v(bool, eagerlyUpdateTopCallFrame, false, Normal, nullptr) \
232     \
233     v(bool, useOSREntryToDFG, true, Normal, nullptr) \
234     v(bool, useOSREntryToFTL, true, Normal, nullptr) \
235     \
236     v(bool, useFTLJIT, true, Normal, "allows the FTL JIT to be used if true") \
237     v(bool, useFTLTBAA, true, Normal, nullptr) \
238     v(bool, validateFTLOSRExitLiveness, false, Normal, nullptr) \
239     v(unsigned, defaultB3OptLevel, 2, Normal, nullptr) \
240     v(bool, b3AlwaysFailsBeforeCompile, false, Normal, nullptr) \
241     v(bool, b3AlwaysFailsBeforeLink, false, Normal, nullptr) \
242     v(bool, ftlCrashes, false, Normal, nullptr) /* fool-proof way of checking that you ended up in the FTL. ;-) */\
243     v(bool, clobberAllRegsInFTLICSlowPath, !ASSERT_DISABLED, Normal, nullptr) \
244     v(bool, useAccessInlining, true, Normal, nullptr) \
245     v(unsigned, maxAccessVariantListSize, 8, Normal, nullptr) \
246     v(bool, usePolyvariantDevirtualization, true, Normal, nullptr) \
247     v(bool, usePolymorphicAccessInlining, true, Normal, nullptr) \
248     v(bool, usePolymorphicCallInlining, true, Normal, nullptr) \
249     v(bool, usePolymorphicCallInliningForNonStubStatus, false, Normal, nullptr) \
250     v(unsigned, maxPolymorphicCallVariantListSize, 15, Normal, nullptr) \
251     v(unsigned, maxPolymorphicCallVariantListSizeForTopTier, 5, Normal, nullptr) \
252     v(unsigned, maxPolymorphicCallVariantListSizeForWebAssemblyToJS, 5, Normal, nullptr) \
253     v(unsigned, maxPolymorphicCallVariantsForInlining, 5, Normal, nullptr) \
254     v(unsigned, frequentCallThreshold, 2, Normal, nullptr) \
255     v(double, minimumCallToKnownRate, 0.51, Normal, nullptr) \
256     v(bool, createPreHeaders, true, Normal, nullptr) \
257     v(bool, useMovHintRemoval, true, Normal, nullptr) \
258     v(bool, usePutStackSinking, true, Normal, nullptr) \
259     v(bool, useObjectAllocationSinking, true, Normal, nullptr) \
260     v(bool, logExecutableAllocation, false, Normal, nullptr) \
261     \
262     v(bool, useConcurrentJIT, true, Normal, "allows the DFG / FTL compilation in threads other than the executing JS thread") \
263     v(unsigned, numberOfDFGCompilerThreads, computeNumberOfWorkerThreads(2, 2) - 1, Normal, nullptr) \
264     v(unsigned, numberOfFTLCompilerThreads, computeNumberOfWorkerThreads(MAXIMUM_NUMBER_OF_FTL_COMPILER_THREADS, 2) - 1, Normal, nullptr) \
265     v(int32, priorityDeltaOfDFGCompilerThreads, computePriorityDeltaOfWorkerThreads(-1, 0), Normal, nullptr) \
266     v(int32, priorityDeltaOfFTLCompilerThreads, computePriorityDeltaOfWorkerThreads(-2, 0), Normal, nullptr) \
267     v(int32, priorityDeltaOfWasmCompilerThreads, computePriorityDeltaOfWorkerThreads(-1, 0), Normal, nullptr) \
268     \
269     v(bool, useProfiler, false, Normal, nullptr) \
270     v(bool, disassembleBaselineForProfiler, true, Normal, nullptr) \
271     \
272     v(bool, useArchitectureSpecificOptimizations, true, Normal, nullptr) \
273     \
274     v(bool, breakOnThrow, false, Normal, nullptr) \
275     \
276     v(unsigned, maximumOptimizationCandidateInstructionCount, 100000, Normal, nullptr) \
277     \
278     v(unsigned, maximumFunctionForCallInlineCandidateInstructionCount, 180, Normal, nullptr) \
279     v(unsigned, maximumFunctionForClosureCallInlineCandidateInstructionCount, 100, Normal, nullptr) \
280     v(unsigned, maximumFunctionForConstructInlineCandidateInstructionCount, 100, Normal, nullptr) \
281     \
282     v(unsigned, maximumFTLCandidateInstructionCount, 20000, Normal, nullptr) \
283     \
284     /* Depth of inline stack, so 1 = no inlining, 2 = one level, etc. */ \
285     v(unsigned, maximumInliningDepth, 5, Normal, "maximum allowed inlining depth.  Depth of 1 means no inlining") \
286     v(unsigned, maximumInliningRecursion, 2, Normal, nullptr) \
287     \
288     /* Maximum size of a caller for enabling inlining. This is purely to protect us */\
289     /* from super long compiles that take a lot of memory. */\
290     v(unsigned, maximumInliningCallerSize, 10000, Normal, nullptr) \
291     \
292     v(unsigned, maximumVarargsForInlining, 100, Normal, nullptr) \
293     \
294     v(bool, usePolyvariantCallInlining, true, Normal, nullptr) \
295     v(bool, usePolyvariantByIdInlining, true, Normal, nullptr) \
296     \
297     v(bool, useMaximalFlushInsertionPhase, false, Normal, "Setting to true allows the DFG's MaximalFlushInsertionPhase to run.") \
298     \
299     v(unsigned, maximumBinaryStringSwitchCaseLength, 50, Normal, nullptr) \
300     v(unsigned, maximumBinaryStringSwitchTotalLength, 2000, Normal, nullptr) \
301     \
302     v(double, jitPolicyScale, 1.0, Normal, "scale JIT thresholds to this specified ratio between 0.0 (compile ASAP) and 1.0 (compile like normal).") \
303     v(bool, forceEagerCompilation, false, Normal, nullptr) \
304     v(int32, thresholdForJITAfterWarmUp, 500, Normal, nullptr) \
305     v(int32, thresholdForJITSoon, 100, Normal, nullptr) \
306     \
307     v(int32, thresholdForOptimizeAfterWarmUp, 1000, Normal, nullptr) \
308     v(int32, thresholdForOptimizeAfterLongWarmUp, 1000, Normal, nullptr) \
309     v(int32, thresholdForOptimizeSoon, 1000, Normal, nullptr) \
310     v(int32, executionCounterIncrementForLoop, 1, Normal, nullptr) \
311     v(int32, executionCounterIncrementForEntry, 15, Normal, nullptr) \
312     \
313     v(int32, thresholdForFTLOptimizeAfterWarmUp, 100000, Normal, nullptr) \
314     v(int32, thresholdForFTLOptimizeSoon, 1000, Normal, nullptr) \
315     v(int32, ftlTierUpCounterIncrementForLoop, 1, Normal, nullptr) \
316     v(int32, ftlTierUpCounterIncrementForReturn, 15, Normal, nullptr) \
317     v(unsigned, ftlOSREntryFailureCountForReoptimization, 15, Normal, nullptr) \
318     v(unsigned, ftlOSREntryRetryThreshold, 100, Normal, nullptr) \
319     \
320     v(int32, evalThresholdMultiplier, 10, Normal, nullptr) \
321     v(unsigned, maximumEvalCacheableSourceLength, 256, Normal, nullptr) \
322     \
323     v(bool, randomizeExecutionCountsBetweenCheckpoints, false, Normal, nullptr) \
324     v(int32, maximumExecutionCountsBetweenCheckpointsForBaseline, 1000, Normal, nullptr) \
325     v(int32, maximumExecutionCountsBetweenCheckpointsForUpperTiers, 50000, Normal, nullptr) \
326     \
327     v(unsigned, likelyToTakeSlowCaseMinimumCount, 20, Normal, nullptr) \
328     v(unsigned, couldTakeSlowCaseMinimumCount, 10, Normal, nullptr) \
329     \
330     v(unsigned, osrExitCountForReoptimization, 100, Normal, nullptr) \
331     v(unsigned, osrExitCountForReoptimizationFromLoop, 5, Normal, nullptr) \
332     \
333     v(unsigned, reoptimizationRetryCounterMax, 0, Normal, nullptr)  \
334     \
335     v(unsigned, minimumOptimizationDelay, 1, Normal, nullptr) \
336     v(unsigned, maximumOptimizationDelay, 5, Normal, nullptr) \
337     v(double, desiredProfileLivenessRate, 0.75, Normal, nullptr) \
338     v(double, desiredProfileFullnessRate, 0.35, Normal, nullptr) \
339     \
340     v(double, doubleVoteRatioForDoubleFormat, 2, Normal, nullptr) \
341     v(double, structureCheckVoteRatioForHoisting, 1, Normal, nullptr) \
342     v(double, checkArrayVoteRatioForHoisting, 1, Normal, nullptr) \
343     \
344     v(unsigned, maximumDirectCallStackSize, 200, Normal, nullptr) \
345     \
346     v(unsigned, minimumNumberOfScansBetweenRebalance, 100, Normal, nullptr) \
347     v(unsigned, numberOfGCMarkers, computeNumberOfGCMarkers(8), Normal, nullptr) \
348     v(unsigned, opaqueRootMergeThreshold, 1000, Normal, nullptr) \
349     v(double, minHeapUtilization, 0.8, Normal, nullptr) \
350     v(double, minMarkedBlockUtilization, 0.9, Normal, nullptr) \
351     v(unsigned, slowPathAllocsBetweenGCs, 0, Normal, "force a GC on every Nth slow path alloc, where N is specified by this option") \
352     \
353     v(double, percentCPUPerMBForFullTimer, 0.0003125, Normal, nullptr) \
354     v(double, percentCPUPerMBForEdenTimer, 0.0025, Normal, nullptr) \
355     v(double, collectionTimerMaxPercentCPU, 0.05, Normal, nullptr) \
356     \
357     v(bool, forceWeakRandomSeed, false, Normal, nullptr) \
358     v(unsigned, forcedWeakRandomSeed, 0, Normal, nullptr) \
359     \
360     v(bool, useZombieMode, false, Normal, "debugging option to scribble over dead objects with 0xbadbeef0") \
361     v(bool, useImmortalObjects, false, Normal, "debugging option to keep all objects alive forever") \
362     v(bool, sweepSynchronously, false, Normal, "debugging option to sweep all dead objects synchronously at GC end before resuming mutator") \
363     v(unsigned, maxSingleAllocationSize, 0, Configurable, "debugging option to limit individual allocations to a max size (0 = limit not set, N = limit size in bytes)") \
364     \
365     v(gcLogLevel, logGC, GCLogging::None, Normal, "debugging option to log GC activity (0 = None, 1 = Basic, 2 = Verbose)") \
366     v(bool, useGC, true, Normal, nullptr) \
367     v(bool, gcAtEnd, false, Normal, "If true, the jsc CLI will do a GC before exiting") \
368     v(bool, forceGCSlowPaths, false, Normal, "If true, we will force all JIT fast allocations down their slow paths.") \
369     v(unsigned, gcMaxHeapSize, 0, Normal, nullptr) \
370     v(unsigned, forceRAMSize, 0, Normal, nullptr) \
371     v(bool, recordGCPauseTimes, false, Normal, nullptr) \
372     v(bool, logHeapStatisticsAtExit, false, Normal, nullptr) \
373     v(bool, forceCodeBlockToJettisonDueToOldAge, false, Normal, "If true, this means that anytime we can jettison a CodeBlock due to old age, we do.") \
374     v(bool, useEagerCodeBlockJettisonTiming, false, Normal, "If true, the time slices for jettisoning a CodeBlock due to old age are shrunk significantly.") \
375     \
376     v(bool, useTypeProfiler, false, Normal, nullptr) \
377     v(bool, useControlFlowProfiler, false, Normal, nullptr) \
378     \
379     v(bool, useSamplingProfiler, false, Normal, nullptr) \
380     v(unsigned, sampleInterval, 1000, Normal, "Time between stack traces in microseconds.") \
381     v(bool, collectSamplingProfilerDataForJSCShell, false, Normal, "This corresponds to the JSC shell's --sample option.") \
382     v(unsigned, samplingProfilerTopFunctionsCount, 12, Normal, "Number of top functions to report when using the command line interface.") \
383     v(unsigned, samplingProfilerTopBytecodesCount, 40, Normal, "Number of top bytecodes to report when using the command line interface.") \
384     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.") \
385     v(bool, sampleCCode, false, Normal, "Causes the sampling profiler to record profiling data for C frames.") \
386     \
387     v(bool, alwaysGeneratePCToCodeOriginMap, false, Normal, "This will make sure we always generate a PCToCodeOriginMap for JITed code.") \
388     \
389     v(bool, verifyHeap, false, Normal, nullptr) \
390     v(unsigned, numberOfGCCyclesToRecordForVerification, 3, Normal, nullptr) \
391     \
392     v(unsigned, exceptionStackTraceLimit, 100, Normal, "Stack trace limit for internal Exception object") \
393     v(unsigned, defaultErrorStackTraceLimit, 100, Normal, "The default value for Error.stackTraceLimit") \
394     v(bool, useExceptionFuzz, false, Normal, nullptr) \
395     v(unsigned, fireExceptionFuzzAt, 0, Normal, nullptr) \
396     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 */\
397     v(bool, dumpSimulatedThrows, false, Normal, "Dumps the call stack at each simulated throw for exception scope verification") \
398     v(bool, validateExceptionChecks, false, Normal, "Verifies that needed exception checks are performed.") \
399     v(unsigned, unexpectedExceptionStackTraceLimit, 100, Normal, "Stack trace limit for debugging unexpected exceptions observed in the VM") \
400     \
401     v(bool, useExecutableAllocationFuzz, false, Normal, nullptr) \
402     v(unsigned, fireExecutableAllocationFuzzAt, 0, Normal, nullptr) \
403     v(unsigned, fireExecutableAllocationFuzzAtOrAfter, 0, Normal, nullptr) \
404     v(bool, verboseExecutableAllocationFuzz, false, Normal, nullptr) \
405     \
406     v(bool, useOSRExitFuzz, false, Normal, nullptr) \
407     v(unsigned, fireOSRExitFuzzAtStatic, 0, Normal, nullptr) \
408     v(unsigned, fireOSRExitFuzzAt, 0, Normal, nullptr) \
409     v(unsigned, fireOSRExitFuzzAtOrAfter, 0, Normal, nullptr) \
410     \
411     v(bool, logB3PhaseTimes, false, Normal, nullptr) \
412     v(double, rareBlockPenalty, 0.001, Normal, nullptr) \
413     v(bool, airLinearScanVerbose, false, Normal, nullptr) \
414     v(bool, airLinearScanSpillsEverything, false, Normal, nullptr) \
415     v(bool, airForceBriggsAllocator, false, Normal, nullptr) \
416     v(bool, airForceIRCAllocator, false, Normal, nullptr) \
417     v(bool, coalesceSpillSlots, true, Normal, nullptr) \
418     v(bool, logAirRegisterPressure, false, Normal, nullptr) \
419     v(unsigned, maxB3TailDupBlockSize, 3, Normal, nullptr) \
420     v(unsigned, maxB3TailDupBlockSuccessors, 3, Normal, nullptr) \
421     \
422     v(bool, useDollarVM, false, Restricted, "installs the $vm debugging tool in global objects") \
423     v(optionString, functionOverrides, nullptr, Restricted, "file with debugging overrides for function bodies") \
424     v(bool, useSigillCrashAnalyzer, false, Configurable, "logs data about SIGILL crashes") \
425     \
426     v(unsigned, watchdog, 0, Normal, "watchdog timeout (0 = Disabled, N = a timeout period of N milliseconds)") \
427     v(bool, usePollingTraps, false, Normal, "use polling (instead of signalling) VM traps") \
428     \
429     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)") \
430     \
431     v(bool, useICStats, false, Normal, nullptr) \
432     \
433     v(unsigned, prototypeHitCountForLLIntCaching, 2, Normal, "Number of prototype property hits before caching a prototype in the LLInt. A count of 0 means never cache.") \
434     \
435     v(bool, dumpCompiledRegExpPatterns, false, Normal, nullptr) \
436     \
437     v(bool, dumpModuleRecord, false, Normal, nullptr) \
438     v(bool, dumpModuleLoadingState, false, Normal, nullptr) \
439     v(bool, exposeInternalModuleLoader, false, Normal, "expose the internal module loader object to the global space for debugging") \
440     \
441     v(bool, useSuperSampler, false, Normal, nullptr) \
442     \
443     v(bool, reportLLIntStats, false, Configurable, "Reports LLInt statistics") \
444     v(optionString, llintStatsFile, nullptr, Configurable, "File to collect LLInt statistics in") \
445     \
446     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.") \
447     v(bool, useCodeCache, true, Normal, "If false, the unlinked byte code cache will not be used.") \
448     \
449     v(bool, useWebAssembly, true, Normal, "Expose the WebAssembly global object.") \
450     \
451     v(bool, failToCompileWebAssemblyCode, false, Normal, "If true, no Wasm::Plan will sucessfully compile a function.") \
452     v(size, webAssemblyPartialCompileLimit, 5000, Normal, "Limit on the number of bytes a Wasm::Plan::compile should attempt before checking for other work.") \
453     v(unsigned, webAssemblyBBQOptimizationLevel, 1, Normal, "B3 Optimization level for BBQ Web Assembly module compilations.") \
454     v(unsigned, webAssemblyOMGOptimizationLevel, Options::defaultB3OptLevel(), Normal, "B3 Optimization level for OMG Web Assembly module compilations.") \
455     \
456     v(bool, useBBQTierUpChecks, true, Normal, "Enables tier up checks for our BBQ code.") \
457     v(unsigned, webAssemblyOMGTierUpCount, 5000, Normal, "The countdown before we tier up a function to OMG.") \
458     v(unsigned, webAssemblyLoopDecrement, 15, Normal, "The amount the tier up countdown is decremented on each loop backedge.") \
459     v(unsigned, webAssemblyFunctionEntryDecrement, 1, Normal, "The amount the tier up countdown is decremented on each function entry.") \
460     \
461     /* FIXME: enable fast memories on iOS and pre-allocate them. https://bugs.webkit.org/show_bug.cgi?id=170774 */ \
462     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.") \
463     v(bool, logWebAssemblyMemory, false, Normal, nullptr) \
464     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") \
465     v(bool, crashIfWebAssemblyCantFastMemory, false, Normal, "If true, we will crash if we can't obtain fast memory for wasm.") \
466     v(unsigned, maxNumWebAssemblyFastMemories, 10, Normal, nullptr) \
467     v(bool, useWebAssemblyFastTLS, true, Normal, "If true, we will try to use fast thread-local storage if available on the current platform.") \
468     v(bool, useFastTLSForWasmContext, true, Normal, "If true (and fast TLS is enabled), we will store context in fast TLS. If false, we will pin it to a register.") \
469     v(bool, useCallICsForWebAssemblyToJSCalls, true, Normal, "If true, we will use CallLinkInfo to inline cache Wasm to JS calls.") \
470     v(bool, useObjectRestSpread, true, Normal, "If true, we will enable Object Rest/Spread feature.") \
471     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.")
472
473
474 enum OptionEquivalence {
475     SameOption,
476     InvertedOption,
477 };
478
479 #define JSC_ALIASED_OPTIONS(v) \
480     v(enableFunctionDotArguments, useFunctionDotArguments, SameOption) \
481     v(enableTailCalls, useTailCalls, SameOption) \
482     v(showDisassembly, dumpDisassembly, SameOption) \
483     v(showDFGDisassembly, dumpDFGDisassembly, SameOption) \
484     v(showFTLDisassembly, dumpFTLDisassembly, SameOption) \
485     v(showAllDFGNodes, dumpAllDFGNodes, SameOption) \
486     v(alwaysDoFullCollection, useGenerationalGC, InvertedOption) \
487     v(enableOSREntryToDFG, useOSREntryToDFG, SameOption) \
488     v(enableOSREntryToFTL, useOSREntryToFTL, SameOption) \
489     v(enableAccessInlining, useAccessInlining, SameOption) \
490     v(enablePolyvariantDevirtualization, usePolyvariantDevirtualization, SameOption) \
491     v(enablePolymorphicAccessInlining, usePolymorphicAccessInlining, SameOption) \
492     v(enablePolymorphicCallInlining, usePolymorphicCallInlining, SameOption) \
493     v(enableMovHintRemoval, useMovHintRemoval, SameOption) \
494     v(enableObjectAllocationSinking, useObjectAllocationSinking, SameOption) \
495     v(enableConcurrentJIT, useConcurrentJIT, SameOption) \
496     v(enableProfiler, useProfiler, SameOption) \
497     v(enableArchitectureSpecificOptimizations, useArchitectureSpecificOptimizations, SameOption) \
498     v(enablePolyvariantCallInlining, usePolyvariantCallInlining, SameOption) \
499     v(enablePolyvariantByIdInlining, usePolyvariantByIdInlining, SameOption) \
500     v(enableMaximalFlushInsertionPhase, useMaximalFlushInsertionPhase, SameOption) \
501     v(objectsAreImmortal, useImmortalObjects, SameOption) \
502     v(showObjectStatistics, dumpObjectStatistics, SameOption) \
503     v(disableGC, useGC, InvertedOption) \
504     v(enableTypeProfiler, useTypeProfiler, SameOption) \
505     v(enableControlFlowProfiler, useControlFlowProfiler, SameOption) \
506     v(enableExceptionFuzz, useExceptionFuzz, SameOption) \
507     v(enableExecutableAllocationFuzz, useExecutableAllocationFuzz, SameOption) \
508     v(enableOSRExitFuzz, useOSRExitFuzz, SameOption) \
509     v(enableDollarVM, useDollarVM, SameOption) \
510     v(enableWebAssembly, useWebAssembly, SameOption) \
511
512 class Options {
513 public:
514     enum class DumpLevel {
515         None = 0,
516         Overridden,
517         All,
518         Verbose
519     };
520
521     enum class Availability {
522         Normal = 0,
523         Restricted,
524         Configurable
525     };
526
527     // This typedef is to allow us to eliminate the '_' in the field name in
528     // union inside Entry. This is needed to keep the style checker happy.
529     typedef int32_t int32;
530     typedef size_t size;
531
532     // Declare the option IDs:
533     enum ID {
534 #define FOR_EACH_OPTION(type_, name_, defaultValue_, availability_, description_) \
535         name_##ID,
536         JSC_OPTIONS(FOR_EACH_OPTION)
537 #undef FOR_EACH_OPTION
538         numberOfOptions
539     };
540
541     enum class Type {
542         boolType,
543         unsignedType,
544         doubleType,
545         int32Type,
546         sizeType,
547         optionRangeType,
548         optionStringType,
549         gcLogLevelType,
550     };
551
552     JS_EXPORT_PRIVATE static void initialize();
553
554     // Parses a string of options where each option is of the format "--<optionName>=<value>"
555     // and are separated by a space. The leading "--" is optional and will be ignored.
556     JS_EXPORT_PRIVATE static bool setOptions(const char* optionsList);
557
558     // Parses a single command line option in the format "<optionName>=<value>"
559     // (no spaces allowed) and set the specified option if appropriate.
560     JS_EXPORT_PRIVATE static bool setOption(const char* arg);
561
562     JS_EXPORT_PRIVATE static void dumpAllOptions(FILE*, DumpLevel, const char* title = nullptr);
563     JS_EXPORT_PRIVATE static void dumpAllOptionsInALine(StringBuilder&);
564
565     JS_EXPORT_PRIVATE static void ensureOptionsAreCoherent();
566
567     JS_EXPORT_PRIVATE static void enableRestrictedOptions(bool enableOrNot);
568
569     // Declare accessors for each option:
570 #define FOR_EACH_OPTION(type_, name_, defaultValue_, availability_, description_) \
571     ALWAYS_INLINE static type_& name_() { return s_options[name_##ID].type_##Val; } \
572     ALWAYS_INLINE static type_& name_##Default() { return s_defaultOptions[name_##ID].type_##Val; }
573
574     JSC_OPTIONS(FOR_EACH_OPTION)
575 #undef FOR_EACH_OPTION
576
577     static bool isAvailable(ID, Availability);
578
579 private:
580     // For storing for an option value:
581     union Entry {
582         bool boolVal;
583         unsigned unsignedVal;
584         double doubleVal;
585         int32 int32Val;
586         size sizeVal;
587         OptionRange optionRangeVal;
588         const char* optionStringVal;
589         GCLogging::Level gcLogLevelVal;
590     };
591
592     // For storing constant meta data about each option:
593     struct EntryInfo {
594         const char* name;
595         const char* description;
596         Type type;
597         Availability availability;
598     };
599
600     Options();
601
602     enum DumpDefaultsOption {
603         DontDumpDefaults,
604         DumpDefaults
605     };
606     static void dumpOptionsIfNeeded();
607     static void dumpAllOptions(StringBuilder&, DumpLevel, const char* title,
608         const char* separator, const char* optionHeader, const char* optionFooter, DumpDefaultsOption);
609     static void dumpOption(StringBuilder&, DumpLevel, ID,
610         const char* optionHeader, const char* optionFooter, DumpDefaultsOption);
611
612     static bool setOptionWithoutAlias(const char* arg);
613     static bool setAliasedOption(const char* arg);
614     static bool overrideAliasedOptionWithHeuristic(const char* name);
615
616     // Declare the singleton instance of the options store:
617     JS_EXPORTDATA static Entry s_options[numberOfOptions];
618     static Entry s_defaultOptions[numberOfOptions];
619     static const EntryInfo s_optionsInfo[numberOfOptions];
620
621     friend class Option;
622 };
623
624 class Option {
625 public:
626     Option(Options::ID id)
627         : m_id(id)
628         , m_entry(Options::s_options[m_id])
629     {
630     }
631     
632     void dump(StringBuilder&) const;
633
634     bool operator==(const Option& other) const;
635     bool operator!=(const Option& other) const { return !(*this == other); }
636     
637     Options::ID id() const { return m_id; }
638     const char* name() const;
639     const char* description() const;
640     Options::Type type() const;
641     Options::Availability availability() const;
642     bool isOverridden() const;
643     const Option defaultOption() const;
644     
645     bool& boolVal();
646     unsigned& unsignedVal();
647     double& doubleVal();
648     int32_t& int32Val();
649     OptionRange optionRangeVal();
650     const char* optionStringVal();
651     GCLogging::Level& gcLogLevelVal();
652     
653 private:
654     // Only used for constructing default Options.
655     Option(Options::ID id, Options::Entry& entry)
656         : m_id(id)
657         , m_entry(entry)
658     {
659     }
660     
661     Options::ID m_id;
662     Options::Entry& m_entry;
663 };
664
665 inline const char* Option::name() const
666 {
667     return Options::s_optionsInfo[m_id].name;
668 }
669
670 inline const char* Option::description() const
671 {
672     return Options::s_optionsInfo[m_id].description;
673 }
674
675 inline Options::Type Option::type() const
676 {
677     return Options::s_optionsInfo[m_id].type;
678 }
679
680 inline Options::Availability Option::availability() const
681 {
682     return Options::s_optionsInfo[m_id].availability;
683 }
684
685 inline bool Option::isOverridden() const
686 {
687     return *this != defaultOption();
688 }
689
690 inline const Option Option::defaultOption() const
691 {
692     return Option(m_id, Options::s_defaultOptions[m_id]);
693 }
694
695 inline bool& Option::boolVal()
696 {
697     return m_entry.boolVal;
698 }
699
700 inline unsigned& Option::unsignedVal()
701 {
702     return m_entry.unsignedVal;
703 }
704
705 inline double& Option::doubleVal()
706 {
707     return m_entry.doubleVal;
708 }
709
710 inline int32_t& Option::int32Val()
711 {
712     return m_entry.int32Val;
713 }
714
715 inline OptionRange Option::optionRangeVal()
716 {
717     return m_entry.optionRangeVal;
718 }
719
720 inline const char* Option::optionStringVal()
721 {
722     return m_entry.optionStringVal;
723 }
724
725 inline GCLogging::Level& Option::gcLogLevelVal()
726 {
727     return m_entry.gcLogLevelVal;
728 }
729
730 } // namespace JSC