JSC should have a way to gather and log Heap memory use and pause times
[WebKit-https.git] / Source / JavaScriptCore / runtime / Options.h
1 /*
2  * Copyright (C) 2011, 2012 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 "JSExportMacros.h"
30 #include <stdint.h>
31 #include <stdio.h>
32
33 namespace JSC {
34
35 // How do JSC VM options work?
36 // ===========================
37 // The JSC_OPTIONS() macro below defines a list of all JSC options in use,
38 // along with their types and default values. The options values are actually
39 // realized as an array of Options::Entry elements.
40 //
41 //     Options::initialize() will initialize the array of options values with
42 // the defaults specified in JSC_OPTIONS() below. After that, the values can
43 // be programmatically read and written to using an accessor method with the
44 // same name as the option. For example, the option "useJIT" can be read and
45 // set like so:
46 //
47 //     bool jitIsOn = Options::useJIT();  // Get the option value.
48 //     Options::useJIT() = false;         // Sets the option value.
49 //
50 //     If you want to tweak any of these values programmatically for testing
51 // purposes, you can do so in Options::initialize() after the default values
52 // are set.
53 //
54 //     Alternatively, you can enable RUN_TIME_HEURISTICS which will allow you
55 // to override the default values by specifying environment variables of the
56 // form: JSC_<name of JSC option>.
57 //
58 // Note: Options::initialize() tries to ensure some sanity on the option values
59 // which are set by doing some range checks, and value corrections. These
60 // checks are done after the option values are set. If you alter the option
61 // values after the sanity checks (for your own testing), then you're liable to
62 // ensure that the new values set are sane and reasonable for your own run.
63
64
65 #define JSC_OPTIONS(v) \
66     v(bool, useJIT,    true) \
67     v(bool, useDFGJIT, true) \
68     v(bool, useRegExpJIT, true) \
69     \
70     /* showDisassembly implies showDFGDisassembly. */ \
71     v(bool, showDisassembly, false) \
72     v(bool, showDFGDisassembly, false) \
73     \
74     v(unsigned, maximumOptimizationCandidateInstructionCount, 10000) \
75     \
76     v(unsigned, maximumFunctionForCallInlineCandidateInstructionCount, 180) \
77     v(unsigned, maximumFunctionForConstructInlineCandidateInstructionCount, 100) \
78     \
79     /* Depth of inline stack, so 1 = no inlining, 2 = one level, etc. */ \
80     v(unsigned, maximumInliningDepth, 5) \
81     \
82     v(int32, thresholdForJITAfterWarmUp, 100) \
83     v(int32, thresholdForJITSoon, 100) \
84     \
85     v(int32, thresholdForOptimizeAfterWarmUp, 1000) \
86     v(int32, thresholdForOptimizeAfterLongWarmUp, 5000) \
87     v(int32, thresholdForOptimizeSoon, 1000) \
88     \
89     v(int32, executionCounterIncrementForLoop, 1) \
90     v(int32, executionCounterIncrementForReturn, 15) \
91     \
92     v(bool, randomizeExecutionCountsBetweenCheckpoints, false) \
93     v(int32, maximumExecutionCountsBetweenCheckpoints, 1000) \
94     \
95     v(double, likelyToTakeSlowCaseThreshold, 0.15) \
96     v(double, couldTakeSlowCaseThreshold, 0.05) \
97     v(unsigned, likelyToTakeSlowCaseMinimumCount, 100) \
98     v(unsigned, couldTakeSlowCaseMinimumCount, 10) \
99     \
100     v(double, osrExitProminenceForFrequentExitSite, 0.3) \
101     v(unsigned, osrExitCountForReoptimization, 100) \
102     v(unsigned, osrExitCountForReoptimizationFromLoop, 5) \
103     \
104     v(unsigned, reoptimizationRetryCounterMax, 0)  \
105     v(unsigned, reoptimizationRetryCounterStep, 1) \
106     \
107     v(unsigned, minimumOptimizationDelay, 1) \
108     v(unsigned, maximumOptimizationDelay, 5) \
109     v(double, desiredProfileLivenessRate, 0.75) \
110     v(double, desiredProfileFullnessRate, 0.35) \
111     \
112     v(double, doubleVoteRatioForDoubleFormat, 2) \
113     v(double, structureCheckVoteRatioForHoisting, 1) \
114     \
115     v(unsigned, minimumNumberOfScansBetweenRebalance, 100) \
116     v(unsigned, gcMarkStackSegmentSize, pageSize()) \
117     v(unsigned, numberOfGCMarkers, computeNumberOfGCMarkers(7)) \
118     v(unsigned, opaqueRootMergeThreshold, 1000) \
119     \
120     v(bool, forceWeakRandomSeed, false) \
121     v(unsigned, forcedWeakRandomSeed, 0) \
122     \
123     v(bool, useZombieMode, false) \
124     v(bool, objectsAreImmortal, false) \
125     v(bool, showObjectStatistics, false) \
126     \
127     v(unsigned, gcMaxHeapSize, 0) \
128     v(bool, recordGCPauseTimes, false) \
129     v(bool, logHeapStatisticsAtExit, false) 
130
131 class Options {
132 public:
133     // This typedef is to allow us to eliminate the '_' in the field name in
134     // union inside Entry. This is needed to keep the style checker happy.
135     typedef int32_t int32;
136
137     // Declare the option IDs:
138     enum OptionID {
139 #define FOR_EACH_OPTION(type_, name_, defaultValue_) \
140         OPT_##name_,
141         JSC_OPTIONS(FOR_EACH_OPTION)
142 #undef FOR_EACH_OPTION
143         numberOfOptions
144     };
145
146
147     static void initialize();
148
149     // Parses a single command line option in the format "<optionName>=<value>"
150     // (no spaces allowed) and set the specified option if appropriate.
151     JS_EXPORT_PRIVATE static bool setOption(const char* arg);
152     JS_EXPORT_PRIVATE static void dumpAllOptions(FILE* stream = stdout);
153     static void dumpOption(OptionID id, FILE* stream = stdout, const char* header = "", const char* footer = "");
154
155     // Declare accessors for each option:
156 #define FOR_EACH_OPTION(type_, name_, defaultValue_) \
157     ALWAYS_INLINE static type_& name_() { return s_options[OPT_##name_].u.type_##Val; }
158
159     JSC_OPTIONS(FOR_EACH_OPTION)
160 #undef FOR_EACH_OPTION
161
162 private:
163     enum EntryType {
164         boolType,
165         unsignedType,
166         doubleType,
167         int32Type,
168     };
169
170     // For storing for an option value:
171     struct Entry {
172         union {
173             bool boolVal;
174             unsigned unsignedVal;
175             double doubleVal;
176             int32 int32Val;
177         } u;
178     };
179
180     // For storing constant meta data about each option:
181     struct EntryInfo {
182         const char* name;
183         EntryType type;
184     };
185
186     Options();
187
188     // Declare the options:
189 #define FOR_EACH_OPTION(type_, name_, defaultValue_) \
190     type_ m_##name_;
191     JSC_OPTIONS(FOR_EACH_OPTION)
192 #undef FOR_EACH_OPTION
193
194     // Declare the singleton instance of the options store:
195     JS_EXPORTDATA static Entry s_options[numberOfOptions];
196     static const EntryInfo s_optionsInfo[numberOfOptions];
197 };
198
199 } // namespace JSC
200
201 #endif // Options_h