70217f8c0e4823ab9823af1880ab398f44a1c56c
[WebKit-https.git] / Source / JavaScriptCore / runtime / Options.h
1 /*
2  * Copyright (C) 2011-2016 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 #ifndef Options_h
27 #define Options_h
28
29 #include "GCLogging.h"
30 #include "JSExportMacros.h"
31 #include <stdint.h>
32 #include <stdio.h>
33 #include <wtf/PrintStream.h>
34 #include <wtf/StdLibExtras.h>
35
36 namespace WTF {
37 class StringBuilder;
38 }
39 using WTF::StringBuilder;
40
41 namespace JSC {
42
43 // How do JSC VM options work?
44 // ===========================
45 // The JSC_OPTIONS() macro below defines a list of all JSC options in use,
46 // along with their types and default values. The options values are actually
47 // realized as an array of Options::Entry elements.
48 //
49 //     Options::initialize() will initialize the array of options values with
50 // the defaults specified in JSC_OPTIONS() below. After that, the values can
51 // be programmatically read and written to using an accessor method with the
52 // same name as the option. For example, the option "useJIT" can be read and
53 // set like so:
54 //
55 //     bool jitIsOn = Options::useJIT();  // Get the option value.
56 //     Options::useJIT() = false;         // Sets the option value.
57 //
58 //     If you want to tweak any of these values programmatically for testing
59 // purposes, you can do so in Options::initialize() after the default values
60 // are set.
61 //
62 //     Alternatively, you can override the default values by specifying
63 // environment variables of the form: JSC_<name of JSC option>.
64 //
65 // Note: Options::initialize() tries to ensure some sanity on the option values
66 // which are set by doing some range checks, and value corrections. These
67 // checks are done after the option values are set. If you alter the option
68 // values after the sanity checks (for your own testing), then you're liable to
69 // ensure that the new values set are sane and reasonable for your own run.
70
71 class OptionRange {
72 private:
73     enum RangeState { Uninitialized, InitError, Normal, Inverted };
74 public:
75     OptionRange& operator= (const int& rhs)
76     { // Only needed for initialization
77         if (!rhs) {
78             m_state = Uninitialized;
79             m_rangeString = 0;
80             m_lowLimit = 0;
81             m_highLimit = 0;
82         }
83         return *this;
84     }
85
86     bool init(const char*);
87     bool isInRange(unsigned);
88     const char* rangeString() const { return (m_state > InitError) ? m_rangeString : s_nullRangeStr; }
89     
90     void dump(PrintStream& out) const;
91
92 private:
93     static const char* const s_nullRangeStr;
94
95     RangeState m_state;
96     const char* m_rangeString;
97     unsigned m_lowLimit;
98     unsigned m_highLimit;
99 };
100
101 typedef OptionRange optionRange;
102 typedef const char* optionString;
103
104 #define JSC_OPTIONS(v) \
105     v(bool, validateOptions, false, "crashes if mis-typed JSC options were passed to the VM") \
106     v(unsigned, dumpOptions, 0, "dumps JSC options (0 = None, 1 = Overridden only, 2 = All, 3 = Verbose)") \
107     \
108     v(bool, useLLInt,  true, "allows the LLINT to be used if true") \
109     v(bool, useJIT,    true, "allows the baseline JIT to be used if true") \
110     v(bool, useDFGJIT, true, "allows the DFG JIT to be used if true") \
111     v(bool, useRegExpJIT, true, "allows the RegExp JIT to be used if true") \
112     \
113     v(bool, reportMustSucceedExecutableAllocations, false, nullptr) \
114     \
115     v(unsigned, maxPerThreadStackUsage, 4 * MB, nullptr) \
116     v(unsigned, reservedZoneSize, 128 * KB, nullptr) \
117     v(unsigned, errorModeReservedZoneSize, 64 * KB, nullptr) \
118     \
119     v(bool, crashIfCantAllocateJITMemory, false, nullptr) \
120     v(unsigned, jitMemoryReservationSize, 0, "Set this number to change the executable allocation size in ExecutableAllocatorFixedVMPool. (In bytes.)") \
121     \
122     v(bool, forceCodeBlockLiveness, false, nullptr) \
123     v(bool, forceICFailure, false, nullptr) \
124     \
125     v(unsigned, repatchCountForCoolDown, 10, nullptr) \
126     v(unsigned, initialCoolDownCount, 20, nullptr) \
127     \
128     v(bool, dumpGeneratedBytecodes, false, nullptr) \
129     v(bool, dumpBytecodeLivenessResults, false, nullptr) \
130     v(bool, validateBytecode, false, nullptr) \
131     v(bool, forceDebuggerBytecodeGeneration, false, nullptr) \
132     v(bool, forceProfilerBytecodeGeneration, false, nullptr) \
133     \
134     v(bool, useFunctionDotArguments, true, nullptr) \
135     v(bool, useTailCalls, true, nullptr) \
136     \
137     /* dumpDisassembly implies dumpDFGDisassembly. */ \
138     v(bool, dumpDisassembly, false, "dumps disassembly of all JIT compiled code upon compilation") \
139     v(bool, asyncDisassembly, false, nullptr) \
140     v(bool, dumpDFGDisassembly, false, "dumps disassembly of DFG function upon compilation") \
141     v(bool, dumpFTLDisassembly, false, "dumps disassembly of FTL function upon compilation") \
142     v(bool, dumpAllDFGNodes, false, nullptr) \
143     v(optionRange, bytecodeRangeToDFGCompile, 0, "bytecode size range to allow DFG compilation on, e.g. 1:100") \
144     v(optionRange, bytecodeRangeToFTLCompile, 0, "bytecode size range to allow FTL compilation on, e.g. 1:100") \
145     v(optionString, dfgWhitelist, nullptr, "file with list of function signatures to allow DFG compilation on") \
146     v(bool, dumpSourceAtDFGTime, false, "dumps source code of JS function being DFG compiled") \
147     v(bool, dumpBytecodeAtDFGTime, false, "dumps bytecode of JS function being DFG compiled") \
148     v(bool, dumpGraphAfterParsing, false, nullptr) \
149     v(bool, dumpGraphAtEachPhase, false, nullptr) \
150     v(bool, dumpDFGGraphAtEachPhase, false, "dumps the DFG graph at each phase DFG of complitaion (note this excludes DFG graphs during FTL compilation)") \
151     v(bool, dumpDFGFTLGraphAtEachPhase, false, "dumps the DFG graph at each phase DFG of complitaion when compiling FTL code") \
152     v(bool, dumpB3GraphAtEachPhase, false, "dumps the B3 graph at each phase of compilation") \
153     v(bool, dumpAirGraphAtEachPhase, false, "dumps the Air graph at each phase of compilation") \
154     v(bool, verboseDFGByteCodeParsing, false, nullptr) \
155     v(bool, verboseCompilation, false, nullptr) \
156     v(bool, verboseFTLCompilation, false, nullptr) \
157     v(bool, logCompilationChanges, false, nullptr) \
158     v(bool, printEachOSRExit, false, nullptr) \
159     v(bool, validateGraph, false, nullptr) \
160     v(bool, validateGraphAtEachPhase, false, nullptr) \
161     v(bool, verboseValidationFailure, false, nullptr) \
162     v(bool, verboseOSR, false, nullptr) \
163     v(bool, verboseFTLOSRExit, false, nullptr) \
164     v(bool, verboseCallLink, false, nullptr) \
165     v(bool, verboseCompilationQueue, false, nullptr) \
166     v(bool, reportCompileTimes, false, "dumps JS function signature and the time it took to compile") \
167     v(bool, reportFTLCompileTimes, false, "dumps JS function signature and the time it took to FTL compile") \
168     v(bool, reportTotalCompileTimes, false, nullptr) \
169     v(bool, verboseCFA, false, nullptr) \
170     v(bool, verboseFTLToJSThunk, false, nullptr) \
171     v(bool, verboseFTLFailure, false, nullptr) \
172     v(bool, alwaysComputeHash, false, nullptr) \
173     v(bool, testTheFTL, false, nullptr) \
174     v(bool, verboseSanitizeStack, false, nullptr) \
175     v(bool, useGenerationalGC, true, nullptr) \
176     v(bool, eagerlyUpdateTopCallFrame, false, nullptr) \
177     \
178     v(bool, useOSREntryToDFG, true, nullptr) \
179     v(bool, useOSREntryToFTL, true, nullptr) \
180     \
181     v(bool, useFTLJIT, true, "allows the FTL JIT to be used if true") \
182     v(bool, useFTLTBAA, true, nullptr) \
183     v(bool, useLLVMFastISel, false, nullptr) \
184     v(bool, useLLVMSmallCodeModel, false, nullptr) \
185     v(bool, dumpLLVMIR, false, nullptr) \
186     v(bool, validateFTLOSRExitLiveness, false, nullptr) \
187     v(bool, llvmAlwaysFailsBeforeCompile, false, nullptr) \
188     v(bool, llvmAlwaysFailsBeforeLink, false, nullptr) \
189     v(bool, llvmSimpleOpt, true, nullptr) \
190     v(unsigned, llvmBackendOptimizationLevel, 2, nullptr) \
191     v(unsigned, llvmOptimizationLevel, 2, nullptr) \
192     v(unsigned, llvmSizeLevel, 0, nullptr) \
193     v(unsigned, llvmMaxStackSize, 128 * KB, nullptr) \
194     v(bool, llvmDisallowAVX, true, nullptr) \
195     v(bool, ftlCrashes, false, nullptr) /* fool-proof way of checking that you ended up in the FTL. ;-) */\
196     v(bool, ftlCrashesIfCantInitializeLLVM, false, nullptr) \
197     v(bool, clobberAllRegsInFTLICSlowPath, !ASSERT_DISABLED, nullptr) \
198     v(bool, assumeAllRegsInFTLICAreLive, false, nullptr) \
199     v(bool, useAccessInlining, true, nullptr) \
200     v(unsigned, maxAccessVariantListSize, 8, nullptr) \
201     v(bool, usePolyvariantDevirtualization, true, nullptr) \
202     v(bool, usePolymorphicAccessInlining, true, nullptr) \
203     v(bool, usePolymorphicCallInlining, true, nullptr) \
204     v(unsigned, maxPolymorphicCallVariantListSize, 15, nullptr) \
205     v(unsigned, maxPolymorphicCallVariantListSizeForTopTier, 5, nullptr) \
206     v(unsigned, maxPolymorphicCallVariantsForInlining, 5, nullptr) \
207     v(unsigned, frequentCallThreshold, 2, nullptr) \
208     v(double, minimumCallToKnownRate, 0.51, nullptr) \
209     v(bool, createPreHeaders, true, nullptr) \
210     v(bool, useMovHintRemoval, true, nullptr) \
211     v(bool, usePutStackSinking, true, nullptr) \
212     v(bool, useObjectAllocationSinking, true, nullptr) \
213     v(bool, useCopyBarrierOptimization, true, nullptr) \
214     \
215     v(bool, useConcurrentJIT, true, "allows the DFG / FTL compilation in threads other than the executing JS thread") \
216     v(unsigned, numberOfDFGCompilerThreads, computeNumberOfWorkerThreads(2, 2) - 1, nullptr) \
217     v(unsigned, numberOfFTLCompilerThreads, computeNumberOfWorkerThreads(8, 2) - 1, nullptr) \
218     v(int32, priorityDeltaOfDFGCompilerThreads, computePriorityDeltaOfWorkerThreads(-1, 0), nullptr) \
219     v(int32, priorityDeltaOfFTLCompilerThreads, computePriorityDeltaOfWorkerThreads(-2, 0), nullptr) \
220     \
221     v(bool, useProfiler, false, nullptr) \
222     \
223     v(bool, forceUDis86Disassembler, false, nullptr) \
224     v(bool, forceLLVMDisassembler, false, nullptr) \
225     \
226     v(bool, useArchitectureSpecificOptimizations, true, nullptr) \
227     \
228     v(bool, breakOnThrow, false, nullptr) \
229     \
230     v(unsigned, maximumOptimizationCandidateInstructionCount, 100000, nullptr) \
231     \
232     v(unsigned, maximumFunctionForCallInlineCandidateInstructionCount, 180, nullptr) \
233     v(unsigned, maximumFunctionForClosureCallInlineCandidateInstructionCount, 100, nullptr) \
234     v(unsigned, maximumFunctionForConstructInlineCandidateInstructionCount, 100, nullptr) \
235     \
236     v(unsigned, maximumFTLCandidateInstructionCount, 20000, nullptr) \
237     \
238     /* Depth of inline stack, so 1 = no inlining, 2 = one level, etc. */ \
239     v(unsigned, maximumInliningDepth, 5, "maximum allowed inlining depth.  Depth of 1 means no inlining") \
240     v(unsigned, maximumInliningRecursion, 2, nullptr) \
241     \
242     /* Maximum size of a caller for enabling inlining. This is purely to protect us */\
243     /* from super long compiles that take a lot of memory. */\
244     v(unsigned, maximumInliningCallerSize, 10000, nullptr) \
245     \
246     v(unsigned, maximumVarargsForInlining, 100, nullptr) \
247     \
248     v(bool, usePolyvariantCallInlining, true, nullptr) \
249     v(bool, usePolyvariantByIdInlining, true, nullptr) \
250     \
251     v(bool, useMaximalFlushInsertionPhase, false, "Setting to true allows the DFG's MaximalFlushInsertionPhase to run.") \
252     \
253     v(unsigned, maximumBinaryStringSwitchCaseLength, 50, nullptr) \
254     v(unsigned, maximumBinaryStringSwitchTotalLength, 2000, nullptr) \
255     \
256     v(double, jitPolicyScale, 1.0, "scale JIT thresholds to this specified ratio between 0.0 (compile ASAP) and 1.0 (compile like normal).") \
257     v(bool, forceEagerCompilation, false, nullptr) \
258     v(int32, thresholdForJITAfterWarmUp, 500, nullptr) \
259     v(int32, thresholdForJITSoon, 100, nullptr) \
260     \
261     v(int32, thresholdForOptimizeAfterWarmUp, 1000, nullptr) \
262     v(int32, thresholdForOptimizeAfterLongWarmUp, 1000, nullptr) \
263     v(int32, thresholdForOptimizeSoon, 1000, nullptr) \
264     v(int32, executionCounterIncrementForLoop, 1, nullptr) \
265     v(int32, executionCounterIncrementForEntry, 15, nullptr) \
266     \
267     v(int32, thresholdForFTLOptimizeAfterWarmUp, 100000, nullptr) \
268     v(int32, thresholdForFTLOptimizeSoon, 1000, nullptr) \
269     v(int32, ftlTierUpCounterIncrementForLoop, 1, nullptr) \
270     v(int32, ftlTierUpCounterIncrementForReturn, 15, nullptr) \
271     v(unsigned, ftlOSREntryFailureCountForReoptimization, 15, nullptr) \
272     v(unsigned, ftlOSREntryRetryThreshold, 100, nullptr) \
273     \
274     v(int32, evalThresholdMultiplier, 10, nullptr) \
275     v(unsigned, maximumEvalCacheableSourceLength, 256, nullptr) \
276     \
277     v(bool, randomizeExecutionCountsBetweenCheckpoints, false, nullptr) \
278     v(int32, maximumExecutionCountsBetweenCheckpointsForBaseline, 1000, nullptr) \
279     v(int32, maximumExecutionCountsBetweenCheckpointsForUpperTiers, 50000, nullptr) \
280     \
281     v(unsigned, likelyToTakeSlowCaseMinimumCount, 20, nullptr) \
282     v(unsigned, couldTakeSlowCaseMinimumCount, 10, nullptr) \
283     \
284     v(unsigned, osrExitCountForReoptimization, 100, nullptr) \
285     v(unsigned, osrExitCountForReoptimizationFromLoop, 5, nullptr) \
286     \
287     v(unsigned, reoptimizationRetryCounterMax, 0, nullptr)  \
288     \
289     v(bool, assertICSizing, false, "crash if estimated IC sizes are inadequate")  \
290     v(bool, dumpFailedICSizing, false, "dumps a log entry if estimated IC sizes are inadequate")  \
291     \
292     v(unsigned, minimumOptimizationDelay, 1, nullptr) \
293     v(unsigned, maximumOptimizationDelay, 5, nullptr) \
294     v(double, desiredProfileLivenessRate, 0.75, nullptr) \
295     v(double, desiredProfileFullnessRate, 0.35, nullptr) \
296     \
297     v(double, doubleVoteRatioForDoubleFormat, 2, nullptr) \
298     v(double, structureCheckVoteRatioForHoisting, 1, nullptr) \
299     v(double, checkArrayVoteRatioForHoisting, 1, nullptr) \
300     \
301     v(unsigned, minimumNumberOfScansBetweenRebalance, 100, nullptr) \
302     v(unsigned, numberOfGCMarkers, computeNumberOfGCMarkers(7), nullptr) \
303     v(unsigned, opaqueRootMergeThreshold, 1000, nullptr) \
304     v(double, minHeapUtilization, 0.8, nullptr) \
305     v(double, minCopiedBlockUtilization, 0.9, nullptr) \
306     v(double, minMarkedBlockUtilization, 0.9, nullptr) \
307     v(unsigned, slowPathAllocsBetweenGCs, 0, "force a GC on every Nth slow path alloc, where N is specified by this option") \
308     \
309     v(double, percentCPUPerMBForFullTimer, 0.0003125, nullptr) \
310     v(double, percentCPUPerMBForEdenTimer, 0.0025, nullptr) \
311     v(double, collectionTimerMaxPercentCPU, 0.05, nullptr) \
312     \
313     v(bool, forceWeakRandomSeed, false, nullptr) \
314     v(unsigned, forcedWeakRandomSeed, 0, nullptr) \
315     \
316     v(bool, useZombieMode, false, "debugging option to scribble over dead objects with 0xdeadbeef") \
317     v(bool, useImmortalObjects, false, "debugging option to keep all objects alive forever") \
318     v(bool, dumpObjectStatistics, false, nullptr) \
319     \
320     v(gcLogLevel, logGC, GCLogging::None, "debugging option to log GC activity (0 = None, 1 = Basic, 2 = Verbose)") \
321     v(bool, useGC, true, nullptr) \
322     v(bool, gcAtEnd, false, "If true, the jsc CLI will do a GC before exiting") \
323     v(bool, forceGCSlowPaths, false, "If true, we will force all JIT fast allocations down their slow paths.")\
324     v(unsigned, gcMaxHeapSize, 0, nullptr) \
325     v(unsigned, forceRAMSize, 0, nullptr) \
326     v(bool, recordGCPauseTimes, false, nullptr) \
327     v(bool, logHeapStatisticsAtExit, false, nullptr) \
328     v(bool, useTypeProfiler, false, nullptr) \
329     v(bool, useControlFlowProfiler, false, nullptr) \
330     v(bool, useSamplingProfiler, false, nullptr) \
331     v(bool, alwaysGeneratePCToCodeOriginMap, false, "This will make sure we always generate a PCToCodeOriginMap for JITed code.") \
332     \
333     v(bool, verifyHeap, false, nullptr) \
334     v(unsigned, numberOfGCCyclesToRecordForVerification, 3, nullptr) \
335     \
336     v(bool, useExceptionFuzz, false, nullptr) \
337     v(unsigned, fireExceptionFuzzAt, 0, nullptr) \
338     v(bool, validateDFGExceptionHandling, false, "Causes the DFG to emit code validating exception handling for each node that can exit") /* This is true by default on Debug builds */\
339     \
340     v(bool, useExecutableAllocationFuzz, false, nullptr) \
341     v(unsigned, fireExecutableAllocationFuzzAt, 0, nullptr) \
342     v(unsigned, fireExecutableAllocationFuzzAtOrAfter, 0, nullptr) \
343     v(bool, verboseExecutableAllocationFuzz, false, nullptr) \
344     \
345     v(bool, useOSRExitFuzz, false, nullptr) \
346     v(unsigned, fireOSRExitFuzzAtStatic, 0, nullptr) \
347     v(unsigned, fireOSRExitFuzzAt, 0, nullptr) \
348     v(unsigned, fireOSRExitFuzzAtOrAfter, 0, nullptr) \
349     \
350     v(bool, logB3PhaseTimes, false, nullptr) \
351     v(double, rareBlockPenalty, 0.001, nullptr) \
352     v(bool, airSpillsEverything, false, nullptr) \
353     v(bool, logAirRegisterPressure, false, nullptr) \
354     v(unsigned, maxB3TailDupBlockSize, 3, nullptr) \
355     v(unsigned, maxB3TailDupBlockSuccessors, 3, nullptr) \
356     \
357     v(bool, useDollarVM, false, "installs the $vm debugging tool in global objects") \
358     v(optionString, functionOverrides, nullptr, "file with debugging overrides for function bodies") \
359     \
360     v(unsigned, watchdog, 0, "watchdog timeout (0 = Disabled, N = a timeout period of N milliseconds)") \
361     \
362     v(bool, dumpModuleRecord, false, nullptr) \
363     v(bool, dumpModuleLoadingState, false, nullptr) \
364     v(bool, exposeInternalModuleLoader, false, "expose the internal module loader object to the global space for debugging") \
365
366 enum OptionEquivalence {
367     SameOption,
368     InvertedOption,
369 };
370
371 #define JSC_ALIASED_OPTIONS(v) \
372     v(enableFunctionDotArguments, useFunctionDotArguments, SameOption) \
373     v(enableTailCalls, useTailCalls, SameOption) \
374     v(showDisassembly, dumpDisassembly, SameOption) \
375     v(showDFGDisassembly, dumpDFGDisassembly, SameOption) \
376     v(showFTLDisassembly, dumpFTLDisassembly, SameOption) \
377     v(showAllDFGNodes, dumpAllDFGNodes, SameOption) \
378     v(alwaysDoFullCollection, useGenerationalGC, InvertedOption) \
379     v(enableOSREntryToDFG, useOSREntryToDFG, SameOption) \
380     v(enableOSREntryToFTL, useOSREntryToFTL, SameOption) \
381     v(enableLLVMFastISel, useLLVMFastISel, SameOption) \
382     v(enableAccessInlining, useAccessInlining, SameOption) \
383     v(enablePolyvariantDevirtualization, usePolyvariantDevirtualization, SameOption) \
384     v(enablePolymorphicAccessInlining, usePolymorphicAccessInlining, SameOption) \
385     v(enablePolymorphicCallInlining, usePolymorphicCallInlining, SameOption) \
386     v(enableMovHintRemoval, useMovHintRemoval, SameOption) \
387     v(enableObjectAllocationSinking, useObjectAllocationSinking, SameOption) \
388     v(enableCopyBarrierOptimization, useCopyBarrierOptimization, SameOption) \
389     v(enableConcurrentJIT, useConcurrentJIT, SameOption) \
390     v(enableProfiler, useProfiler, SameOption) \
391     v(enableArchitectureSpecificOptimizations, useArchitectureSpecificOptimizations, SameOption) \
392     v(enablePolyvariantCallInlining, usePolyvariantCallInlining, SameOption) \
393     v(enablePolyvariantByIdInlining, usePolyvariantByIdInlining, SameOption) \
394     v(enableMaximalFlushInsertionPhase, useMaximalFlushInsertionPhase, SameOption) \
395     v(objectsAreImmortal, useImmortalObjects, SameOption) \
396     v(showObjectStatistics, dumpObjectStatistics, SameOption) \
397     v(disableGC, useGC, InvertedOption) \
398     v(enableTypeProfiler, useTypeProfiler, SameOption) \
399     v(enableControlFlowProfiler, useControlFlowProfiler, SameOption) \
400     v(enableExceptionFuzz, useExceptionFuzz, SameOption) \
401     v(enableExecutableAllocationFuzz, useExecutableAllocationFuzz, SameOption) \
402     v(enableOSRExitFuzz, useOSRExitFuzz, SameOption) \
403     v(enableDollarVM, useDollarVM, SameOption) \
404
405 class Options {
406 public:
407     enum class DumpLevel {
408         None = 0,
409         Overridden,
410         All,
411         Verbose
412     };
413     
414     // This typedef is to allow us to eliminate the '_' in the field name in
415     // union inside Entry. This is needed to keep the style checker happy.
416     typedef int32_t int32;
417
418     // Declare the option IDs:
419     enum OptionID {
420 #define FOR_EACH_OPTION(type_, name_, defaultValue_, description_) \
421         name_##ID,
422         JSC_OPTIONS(FOR_EACH_OPTION)
423 #undef FOR_EACH_OPTION
424         numberOfOptions
425     };
426
427     enum class Type {
428         boolType,
429         unsignedType,
430         doubleType,
431         int32Type,
432         optionRangeType,
433         optionStringType,
434         gcLogLevelType,
435     };
436
437     JS_EXPORT_PRIVATE static void initialize();
438
439     // Parses a string of options where each option is of the format "--<optionName>=<value>"
440     // and are separated by a space. The leading "--" is optional and will be ignored.
441     JS_EXPORT_PRIVATE static bool setOptions(const char* optionsList);
442
443     // Parses a single command line option in the format "<optionName>=<value>"
444     // (no spaces allowed) and set the specified option if appropriate.
445     JS_EXPORT_PRIVATE static bool setOption(const char* arg);
446
447     JS_EXPORT_PRIVATE static void dumpAllOptions(FILE*, DumpLevel, const char* title = nullptr);
448     JS_EXPORT_PRIVATE static void dumpAllOptionsInALine(StringBuilder&);
449
450     JS_EXPORT_PRIVATE static void ensureOptionsAreCoherent();
451
452     // Declare accessors for each option:
453 #define FOR_EACH_OPTION(type_, name_, defaultValue_, description_) \
454     ALWAYS_INLINE static type_& name_() { return s_options[name_##ID].type_##Val; } \
455     ALWAYS_INLINE static type_& name_##Default() { return s_defaultOptions[name_##ID].type_##Val; }
456
457     JSC_OPTIONS(FOR_EACH_OPTION)
458 #undef FOR_EACH_OPTION
459
460 private:
461     // For storing for an option value:
462     union Entry {
463         bool boolVal;
464         unsigned unsignedVal;
465         double doubleVal;
466         int32 int32Val;
467         OptionRange optionRangeVal;
468         const char* optionStringVal;
469         GCLogging::Level gcLogLevelVal;
470     };
471
472     // For storing constant meta data about each option:
473     struct EntryInfo {
474         const char* name;
475         const char* description;
476         Type type;
477     };
478
479     Options();
480
481     enum DumpDefaultsOption {
482         DontDumpDefaults,
483         DumpDefaults
484     };
485     static void dumpOptionsIfNeeded();
486     static void dumpAllOptions(StringBuilder&, DumpLevel, const char* title,
487         const char* separator, const char* optionHeader, const char* optionFooter, DumpDefaultsOption);
488     static void dumpOption(StringBuilder&, DumpLevel, OptionID,
489         const char* optionHeader, const char* optionFooter, DumpDefaultsOption);
490
491     static bool setOptionWithoutAlias(const char* arg);
492     static bool setAliasedOption(const char* arg);
493     static bool overrideAliasedOptionWithHeuristic(const char* name);
494
495     // Declare the singleton instance of the options store:
496     JS_EXPORTDATA static Entry s_options[numberOfOptions];
497     static Entry s_defaultOptions[numberOfOptions];
498     static const EntryInfo s_optionsInfo[numberOfOptions];
499
500     friend class Option;
501 };
502
503 class Option {
504 public:
505     Option(Options::OptionID id)
506         : m_id(id)
507         , m_entry(Options::s_options[m_id])
508     {
509     }
510     
511     void dump(StringBuilder&) const;
512
513     bool operator==(const Option& other) const;
514     bool operator!=(const Option& other) const { return !(*this == other); }
515     
516     const char* name() const;
517     const char* description() const;
518     Options::Type type() const;
519     bool isOverridden() const;
520     const Option defaultOption() const;
521     
522     bool& boolVal();
523     unsigned& unsignedVal();
524     double& doubleVal();
525     int32_t& int32Val();
526     OptionRange optionRangeVal();
527     const char* optionStringVal();
528     GCLogging::Level& gcLogLevelVal();
529     
530 private:
531     // Only used for constructing default Options.
532     Option(Options::OptionID id, Options::Entry& entry)
533         : m_id(id)
534         , m_entry(entry)
535     {
536     }
537     
538     Options::OptionID m_id;
539     Options::Entry& m_entry;
540 };
541
542 inline const char* Option::name() const
543 {
544     return Options::s_optionsInfo[m_id].name;
545 }
546
547 inline const char* Option::description() const
548 {
549     return Options::s_optionsInfo[m_id].description;
550 }
551
552 inline Options::Type Option::type() const
553 {
554     return Options::s_optionsInfo[m_id].type;
555 }
556
557 inline bool Option::isOverridden() const
558 {
559     return *this != defaultOption();
560 }
561
562 inline const Option Option::defaultOption() const
563 {
564     return Option(m_id, Options::s_defaultOptions[m_id]);
565 }
566
567 inline bool& Option::boolVal()
568 {
569     return m_entry.boolVal;
570 }
571
572 inline unsigned& Option::unsignedVal()
573 {
574     return m_entry.unsignedVal;
575 }
576
577 inline double& Option::doubleVal()
578 {
579     return m_entry.doubleVal;
580 }
581
582 inline int32_t& Option::int32Val()
583 {
584     return m_entry.int32Val;
585 }
586
587 inline OptionRange Option::optionRangeVal()
588 {
589     return m_entry.optionRangeVal;
590 }
591
592 inline const char* Option::optionStringVal()
593 {
594     return m_entry.optionStringVal;
595 }
596
597 inline GCLogging::Level& Option::gcLogLevelVal()
598 {
599     return m_entry.gcLogLevelVal;
600 }
601
602 } // namespace JSC
603
604 #endif // Options_h