1/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License")
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef RUNTIME_OPTIONS_KEY
18#error "Please #define RUNTIME_OPTIONS_KEY before #including this file"
19#define RUNTIME_OPTIONS_KEY(...)  // Don't display errors in this file in IDEs.
20#endif
21
22// This file defines the list of keys for RuntimeOptions.
23// These can be used with RuntimeOptions.Get/Set/etc, for example:
24//         RuntimeOptions opt; bool* dex2oat_enabled = opt.Get(RuntimeOptions::Dex2Oat);
25//
26// Column Descriptions:
27//                   <<Type>>             <<Key Name>>                  <<Default Value>>
28//
29// Default values are only used by Map::GetOrDefault(K<T>).
30// If a default value is omitted here, T{} is used as the default value, which is
31// almost-always the value of the type as if it was memset to all 0.
32//
33// Please keep the columns aligned if possible when adding new rows.
34//
35
36// Parse-able keys from the command line.
37RUNTIME_OPTIONS_KEY (Unit,                Zygote)
38RUNTIME_OPTIONS_KEY (Unit,                Help)
39RUNTIME_OPTIONS_KEY (Unit,                ShowVersion)
40RUNTIME_OPTIONS_KEY (std::string,         BootClassPath)
41RUNTIME_OPTIONS_KEY (ParseStringList<':'>,BootClassPathLocations)  // std::vector<std::string>
42RUNTIME_OPTIONS_KEY (std::string,         ClassPath)
43RUNTIME_OPTIONS_KEY (std::string,         Image)
44RUNTIME_OPTIONS_KEY (Unit,                CheckJni)
45RUNTIME_OPTIONS_KEY (Unit,                JniOptsForceCopy)
46RUNTIME_OPTIONS_KEY (JDWP::JdwpOptions,   JdwpOptions)
47RUNTIME_OPTIONS_KEY (MemoryKiB,           MemoryMaximumSize,              gc::Heap::kDefaultMaximumSize)  // -Xmx
48RUNTIME_OPTIONS_KEY (MemoryKiB,           MemoryInitialSize,              gc::Heap::kDefaultInitialSize)  // -Xms
49RUNTIME_OPTIONS_KEY (MemoryKiB,           HeapGrowthLimit)                // Default is 0 for unlimited
50RUNTIME_OPTIONS_KEY (MemoryKiB,           HeapMinFree,                    gc::Heap::kDefaultMinFree)
51RUNTIME_OPTIONS_KEY (MemoryKiB,           HeapMaxFree,                    gc::Heap::kDefaultMaxFree)
52RUNTIME_OPTIONS_KEY (MemoryKiB,           NonMovingSpaceCapacity,         gc::Heap::kDefaultNonMovingSpaceCapacity)
53RUNTIME_OPTIONS_KEY (double,              HeapTargetUtilization,          gc::Heap::kDefaultTargetUtilization)
54RUNTIME_OPTIONS_KEY (double,              ForegroundHeapGrowthMultiplier, gc::Heap::kDefaultHeapGrowthMultiplier)
55RUNTIME_OPTIONS_KEY (unsigned int,        ParallelGCThreads,              0u)
56RUNTIME_OPTIONS_KEY (unsigned int,        ConcGCThreads)
57RUNTIME_OPTIONS_KEY (Memory<1>,           StackSize)  // -Xss
58RUNTIME_OPTIONS_KEY (unsigned int,        MaxSpinsBeforeThinLockInflation,Monitor::kDefaultMaxSpinsBeforeThinLockInflation)
59RUNTIME_OPTIONS_KEY (MillisecondsToNanoseconds, \
60                                          LongPauseLogThreshold,          gc::Heap::kDefaultLongPauseLogThreshold)
61RUNTIME_OPTIONS_KEY (MillisecondsToNanoseconds, \
62                                          LongGCLogThreshold,             gc::Heap::kDefaultLongGCLogThreshold)
63RUNTIME_OPTIONS_KEY (MillisecondsToNanoseconds, \
64                                          ThreadSuspendTimeout,           ThreadList::kDefaultThreadSuspendTimeout)
65RUNTIME_OPTIONS_KEY (Unit,                DumpGCPerformanceOnShutdown)
66RUNTIME_OPTIONS_KEY (Unit,                DumpJITInfoOnShutdown)
67RUNTIME_OPTIONS_KEY (Unit,                IgnoreMaxFootprint)
68RUNTIME_OPTIONS_KEY (Unit,                LowMemoryMode)
69RUNTIME_OPTIONS_KEY (bool,                UseTLAB,                        (kUseTlab || kUseReadBarrier))
70RUNTIME_OPTIONS_KEY (bool,                EnableHSpaceCompactForOOM,      true)
71RUNTIME_OPTIONS_KEY (bool,                UseJitCompilation,              false)
72RUNTIME_OPTIONS_KEY (bool,                DumpNativeStackOnSigQuit,       true)
73RUNTIME_OPTIONS_KEY (unsigned int,        JITCompileThreshold,            jit::Jit::kDefaultCompileThreshold)
74RUNTIME_OPTIONS_KEY (unsigned int,        JITWarmupThreshold)
75RUNTIME_OPTIONS_KEY (unsigned int,        JITOsrThreshold)
76RUNTIME_OPTIONS_KEY (unsigned int,        JITPriorityThreadWeight)
77RUNTIME_OPTIONS_KEY (unsigned int,        JITInvokeTransitionWeight)
78RUNTIME_OPTIONS_KEY (MemoryKiB,           JITCodeCacheInitialCapacity,    jit::JitCodeCache::kInitialCapacity)
79RUNTIME_OPTIONS_KEY (MemoryKiB,           JITCodeCacheMaxCapacity,        jit::JitCodeCache::kMaxCapacity)
80RUNTIME_OPTIONS_KEY (MillisecondsToNanoseconds, \
81                                          HSpaceCompactForOOMMinIntervalsMs,\
82                                                                          MsToNs(100 * 1000))  // 100s
83RUNTIME_OPTIONS_KEY (std::vector<std::string>, \
84                                          PropertiesList)  // -D<whatever> -D<whatever> ...
85RUNTIME_OPTIONS_KEY (std::string,         JniTrace)
86RUNTIME_OPTIONS_KEY (std::string,         PatchOat)
87RUNTIME_OPTIONS_KEY (bool,                Relocate,                       kDefaultMustRelocate)
88RUNTIME_OPTIONS_KEY (bool,                Dex2Oat,                        true)
89RUNTIME_OPTIONS_KEY (bool,                ImageDex2Oat,                   true)
90RUNTIME_OPTIONS_KEY (bool,                Interpret,                      false) // -Xint
91                                                        // Disable the compiler for CC (for now).
92RUNTIME_OPTIONS_KEY (XGcOption,           GcOption)  // -Xgc:
93RUNTIME_OPTIONS_KEY (gc::space::LargeObjectSpaceType, \
94                                          LargeObjectSpace,               gc::Heap::kDefaultLargeObjectSpaceType)
95RUNTIME_OPTIONS_KEY (Memory<1>,           LargeObjectThreshold,           gc::Heap::kDefaultLargeObjectThreshold)
96RUNTIME_OPTIONS_KEY (BackgroundGcOption,  BackgroundGc)
97
98RUNTIME_OPTIONS_KEY (Unit,                DisableExplicitGC)
99RUNTIME_OPTIONS_KEY (Unit,                NoSigChain)
100RUNTIME_OPTIONS_KEY (Unit,                ForceNativeBridge)
101RUNTIME_OPTIONS_KEY (LogVerbosity,        Verbose)
102RUNTIME_OPTIONS_KEY (unsigned int,        LockProfThreshold)
103RUNTIME_OPTIONS_KEY (std::string,         StackTraceFile)
104RUNTIME_OPTIONS_KEY (Unit,                MethodTrace)
105RUNTIME_OPTIONS_KEY (std::string,         MethodTraceFile,                "/data/misc/trace/method-trace-file.bin")
106RUNTIME_OPTIONS_KEY (unsigned int,        MethodTraceFileSize,            10 * MB)
107RUNTIME_OPTIONS_KEY (Unit,                MethodTraceStreaming)
108RUNTIME_OPTIONS_KEY (TraceClockSource,    ProfileClock,                   kDefaultTraceClockSource)  // -Xprofile:
109RUNTIME_OPTIONS_KEY (ProfileSaverOptions, ProfileSaverOpts)  // -Xjitsaveprofilinginfo, -Xps-*
110RUNTIME_OPTIONS_KEY (std::string,         Compiler)
111RUNTIME_OPTIONS_KEY (std::vector<std::string>, \
112                                          CompilerOptions)  // -Xcompiler-option ...
113RUNTIME_OPTIONS_KEY (std::vector<std::string>, \
114                                          ImageCompilerOptions)  // -Ximage-compiler-option ...
115RUNTIME_OPTIONS_KEY (verifier::VerifyMode, \
116                                          Verify,                         verifier::VerifyMode::kEnable)
117RUNTIME_OPTIONS_KEY (std::string,         NativeBridge)
118RUNTIME_OPTIONS_KEY (unsigned int,        ZygoteMaxFailedBoots,           10)
119RUNTIME_OPTIONS_KEY (Unit,                NoDexFileFallback)
120RUNTIME_OPTIONS_KEY (std::string,         CpuAbiList)
121RUNTIME_OPTIONS_KEY (std::string,         Fingerprint)
122RUNTIME_OPTIONS_KEY (ExperimentalFlags,   Experimental,     ExperimentalFlags::kNone) // -Xexperimental:{...}
123RUNTIME_OPTIONS_KEY (std::list<ti::Agent>,         AgentLib)  // -agentlib:<libname>=<options>
124RUNTIME_OPTIONS_KEY (std::list<ti::Agent>,         AgentPath)  // -agentpath:<libname>=<options>
125RUNTIME_OPTIONS_KEY (std::vector<Plugin>,            Plugins)  // -Xplugin:<library>
126
127// Not parse-able from command line, but can be provided explicitly.
128// (Do not add anything here that is defined in ParsedOptions::MakeParser)
129RUNTIME_OPTIONS_KEY (std::vector<std::unique_ptr<const DexFile>>*, \
130                                          BootClassPathDexList)
131RUNTIME_OPTIONS_KEY (InstructionSet,      ImageInstructionSet,            kRuntimeISA)
132RUNTIME_OPTIONS_KEY (CompilerCallbacks*,  CompilerCallbacksPtr)  // TDOO: make unique_ptr
133RUNTIME_OPTIONS_KEY (bool (*)(),          HookIsSensitiveThread)
134RUNTIME_OPTIONS_KEY (int32_t (*)(FILE* stream, const char* format, va_list ap), \
135                                          HookVfprintf,                   vfprintf)
136// Use _exit instead of exit so that we won't get DCHECK failures in global data
137// destructors. b/28106055.
138RUNTIME_OPTIONS_KEY (void (*)(int32_t status), \
139                                          HookExit,                       _exit)
140                                                                          // We don't call abort(3) by default; see
141                                                                          // Runtime::Abort.
142RUNTIME_OPTIONS_KEY (void (*)(),          HookAbort,                      nullptr)
143
144#undef RUNTIME_OPTIONS_KEY
145