blob: 2ea4b1453d463acb0ed57d16171d4185f32aa8dc [file] [log] [blame]
Brian Carlstrom491ca9e2014-03-02 18:24:38 -08001/*
2 * Copyright (C) 2011 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#include "parsed_options.h"
Ian Rogers576ca0c2014-06-06 15:58:22 -070018
Ian Rogersc7dd2952014-10-21 23:31:19 -070019#include <sstream>
20
Ian Rogers576ca0c2014-06-06 15:58:22 -070021#include "base/stringpiece.h"
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080022#include "debugger.h"
Ian Rogers576ca0c2014-06-06 15:58:22 -070023#include "gc/heap.h"
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080024#include "monitor.h"
Ian Rogerse63db272014-07-15 15:36:11 -070025#include "runtime.h"
26#include "trace.h"
Ian Rogers576ca0c2014-06-06 15:58:22 -070027#include "utils.h"
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080028
Igor Murashkinaaebaa02015-01-26 10:55:53 -080029#include "cmdline_parser.h"
30#include "runtime_options.h"
31
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080032namespace art {
33
Igor Murashkinaaebaa02015-01-26 10:55:53 -080034using MemoryKiB = Memory<1024>;
35
Andreas Gampe313f4032014-08-29 16:01:25 -070036ParsedOptions::ParsedOptions()
Igor Murashkinaaebaa02015-01-26 10:55:53 -080037 : hook_is_sensitive_thread_(nullptr),
Andreas Gampe313f4032014-08-29 16:01:25 -070038 hook_vfprintf_(vfprintf),
39 hook_exit_(exit),
Igor Murashkinaaebaa02015-01-26 10:55:53 -080040 hook_abort_(nullptr) { // We don't call abort(3) by default; see
41 // Runtime::Abort
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080042}
Andreas Gampe313f4032014-08-29 16:01:25 -070043
Vladimir Marko88b2b802015-12-04 14:19:04 +000044bool ParsedOptions::Parse(const RuntimeOptions& options,
45 bool ignore_unrecognized,
46 RuntimeArgumentMap* runtime_options) {
Igor Murashkinb1d8c312015-08-04 11:18:43 -070047 CHECK(runtime_options != nullptr);
48
Vladimir Marko88b2b802015-12-04 14:19:04 +000049 ParsedOptions parser;
50 return parser.DoParse(options, ignore_unrecognized, runtime_options);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080051}
52
Igor Murashkinaaebaa02015-01-26 10:55:53 -080053using RuntimeParser = CmdlineParser<RuntimeArgumentMap, RuntimeArgumentMap::Key>;
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080054
Igor Murashkinaaebaa02015-01-26 10:55:53 -080055// Yes, the stack frame is huge. But we get called super early on (and just once)
56// to pass the command line arguments, so we'll probably be ok.
57// Ideas to avoid suppressing this diagnostic are welcome!
58#pragma GCC diagnostic push
59#pragma GCC diagnostic ignored "-Wframe-larger-than="
60
61std::unique_ptr<RuntimeParser> ParsedOptions::MakeParser(bool ignore_unrecognized) {
62 using M = RuntimeArgumentMap;
63
64 std::unique_ptr<RuntimeParser::Builder> parser_builder =
65 std::unique_ptr<RuntimeParser::Builder>(new RuntimeParser::Builder());
66
67 parser_builder->
68 Define("-Xzygote")
69 .IntoKey(M::Zygote)
70 .Define("-help")
71 .IntoKey(M::Help)
72 .Define("-showversion")
73 .IntoKey(M::ShowVersion)
74 .Define("-Xbootclasspath:_")
75 .WithType<std::string>()
76 .IntoKey(M::BootClassPath)
77 .Define("-Xbootclasspath-locations:_")
78 .WithType<ParseStringList<':'>>() // std::vector<std::string>, split by :
79 .IntoKey(M::BootClassPathLocations)
80 .Define({"-classpath _", "-cp _"})
81 .WithType<std::string>()
82 .IntoKey(M::ClassPath)
83 .Define("-Ximage:_")
84 .WithType<std::string>()
85 .IntoKey(M::Image)
86 .Define("-Xcheck:jni")
87 .IntoKey(M::CheckJni)
88 .Define("-Xjniopts:forcecopy")
89 .IntoKey(M::JniOptsForceCopy)
90 .Define({"-Xrunjdwp:_", "-agentlib:jdwp=_"})
91 .WithType<JDWP::JdwpOptions>()
92 .IntoKey(M::JdwpOptions)
93 .Define("-Xms_")
94 .WithType<MemoryKiB>()
95 .IntoKey(M::MemoryInitialSize)
96 .Define("-Xmx_")
97 .WithType<MemoryKiB>()
98 .IntoKey(M::MemoryMaximumSize)
99 .Define("-XX:HeapGrowthLimit=_")
100 .WithType<MemoryKiB>()
101 .IntoKey(M::HeapGrowthLimit)
102 .Define("-XX:HeapMinFree=_")
103 .WithType<MemoryKiB>()
104 .IntoKey(M::HeapMinFree)
105 .Define("-XX:HeapMaxFree=_")
106 .WithType<MemoryKiB>()
107 .IntoKey(M::HeapMaxFree)
108 .Define("-XX:NonMovingSpaceCapacity=_")
109 .WithType<MemoryKiB>()
110 .IntoKey(M::NonMovingSpaceCapacity)
111 .Define("-XX:HeapTargetUtilization=_")
112 .WithType<double>().WithRange(0.1, 0.9)
113 .IntoKey(M::HeapTargetUtilization)
114 .Define("-XX:ForegroundHeapGrowthMultiplier=_")
115 .WithType<double>().WithRange(0.1, 1.0)
116 .IntoKey(M::ForegroundHeapGrowthMultiplier)
117 .Define("-XX:ParallelGCThreads=_")
118 .WithType<unsigned int>()
119 .IntoKey(M::ParallelGCThreads)
120 .Define("-XX:ConcGCThreads=_")
121 .WithType<unsigned int>()
122 .IntoKey(M::ConcGCThreads)
123 .Define("-Xss_")
124 .WithType<Memory<1>>()
125 .IntoKey(M::StackSize)
126 .Define("-XX:MaxSpinsBeforeThinLockInflation=_")
127 .WithType<unsigned int>()
128 .IntoKey(M::MaxSpinsBeforeThinLockInflation)
129 .Define("-XX:LongPauseLogThreshold=_") // in ms
130 .WithType<MillisecondsToNanoseconds>() // store as ns
131 .IntoKey(M::LongPauseLogThreshold)
132 .Define("-XX:LongGCLogThreshold=_") // in ms
133 .WithType<MillisecondsToNanoseconds>() // store as ns
134 .IntoKey(M::LongGCLogThreshold)
135 .Define("-XX:DumpGCPerformanceOnShutdown")
136 .IntoKey(M::DumpGCPerformanceOnShutdown)
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700137 .Define("-XX:DumpJITInfoOnShutdown")
138 .IntoKey(M::DumpJITInfoOnShutdown)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800139 .Define("-XX:IgnoreMaxFootprint")
140 .IntoKey(M::IgnoreMaxFootprint)
141 .Define("-XX:LowMemoryMode")
142 .IntoKey(M::LowMemoryMode)
143 .Define("-XX:UseTLAB")
Hiroshi Yamauchif360ad02015-02-20 11:28:03 -0800144 .WithValue(true)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800145 .IntoKey(M::UseTLAB)
146 .Define({"-XX:EnableHSpaceCompactForOOM", "-XX:DisableHSpaceCompactForOOM"})
147 .WithValues({true, false})
148 .IntoKey(M::EnableHSpaceCompactForOOM)
Mathieu Chartier1972a8e2015-03-05 17:12:54 -0800149 .Define("-Xusejit:_")
150 .WithType<bool>()
151 .WithValueMap({{"false", false}, {"true", true}})
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800152 .IntoKey(M::UseJIT)
Nicolas Geoffray56782292015-11-19 14:25:43 +0000153 .Define("-Xjitinitialsize:_")
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800154 .WithType<MemoryKiB>()
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000155 .IntoKey(M::JITCodeCacheInitialCapacity)
Nicolas Geoffray56782292015-11-19 14:25:43 +0000156 .Define("-Xjitmaxsize:_")
Nicolas Geoffray0a3be162015-11-18 11:15:22 +0000157 .WithType<MemoryKiB>()
158 .IntoKey(M::JITCodeCacheMaxCapacity)
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800159 .Define("-Xjitthreshold:_")
160 .WithType<unsigned int>()
161 .IntoKey(M::JITCompileThreshold)
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100162 .Define("-Xjitwarmupthreshold:_")
163 .WithType<unsigned int>()
164 .IntoKey(M::JITWarmupThreshold)
Calin Juravle31f2c152015-10-23 17:56:15 +0100165 .Define("-Xjitsaveprofilinginfo")
166 .WithValue(true)
167 .IntoKey(M::JITSaveProfilingInfo)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800168 .Define("-XX:HspaceCompactForOOMMinIntervalMs=_") // in ms
169 .WithType<MillisecondsToNanoseconds>() // store as ns
170 .IntoKey(M::HSpaceCompactForOOMMinIntervalsMs)
171 .Define("-D_")
172 .WithType<std::vector<std::string>>().AppendValues()
173 .IntoKey(M::PropertiesList)
174 .Define("-Xjnitrace:_")
175 .WithType<std::string>()
176 .IntoKey(M::JniTrace)
177 .Define("-Xpatchoat:_")
178 .WithType<std::string>()
179 .IntoKey(M::PatchOat)
180 .Define({"-Xrelocate", "-Xnorelocate"})
181 .WithValues({true, false})
182 .IntoKey(M::Relocate)
183 .Define({"-Xdex2oat", "-Xnodex2oat"})
184 .WithValues({true, false})
185 .IntoKey(M::Dex2Oat)
186 .Define({"-Ximage-dex2oat", "-Xnoimage-dex2oat"})
187 .WithValues({true, false})
188 .IntoKey(M::ImageDex2Oat)
189 .Define("-Xint")
190 .WithValue(true)
191 .IntoKey(M::Interpret)
192 .Define("-Xgc:_")
193 .WithType<XGcOption>()
194 .IntoKey(M::GcOption)
195 .Define("-XX:LargeObjectSpace=_")
196 .WithType<gc::space::LargeObjectSpaceType>()
197 .WithValueMap({{"disabled", gc::space::LargeObjectSpaceType::kDisabled},
198 {"freelist", gc::space::LargeObjectSpaceType::kFreeList},
199 {"map", gc::space::LargeObjectSpaceType::kMap}})
200 .IntoKey(M::LargeObjectSpace)
201 .Define("-XX:LargeObjectThreshold=_")
202 .WithType<Memory<1>>()
203 .IntoKey(M::LargeObjectThreshold)
204 .Define("-XX:BackgroundGC=_")
205 .WithType<BackgroundGcOption>()
206 .IntoKey(M::BackgroundGc)
207 .Define("-XX:+DisableExplicitGC")
208 .IntoKey(M::DisableExplicitGC)
209 .Define("-verbose:_")
210 .WithType<LogVerbosity>()
211 .IntoKey(M::Verbose)
212 .Define("-Xlockprofthreshold:_")
213 .WithType<unsigned int>()
214 .IntoKey(M::LockProfThreshold)
215 .Define("-Xstacktracefile:_")
216 .WithType<std::string>()
217 .IntoKey(M::StackTraceFile)
218 .Define("-Xmethod-trace")
219 .IntoKey(M::MethodTrace)
220 .Define("-Xmethod-trace-file:_")
221 .WithType<std::string>()
222 .IntoKey(M::MethodTraceFile)
223 .Define("-Xmethod-trace-file-size:_")
224 .WithType<unsigned int>()
225 .IntoKey(M::MethodTraceFileSize)
Andreas Gampe40da2862015-02-27 12:49:04 -0800226 .Define("-Xmethod-trace-stream")
227 .IntoKey(M::MethodTraceStreaming)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800228 .Define("-Xprofile:_")
229 .WithType<TraceClockSource>()
230 .WithValueMap({{"threadcpuclock", TraceClockSource::kThreadCpu},
231 {"wallclock", TraceClockSource::kWall},
232 {"dualclock", TraceClockSource::kDual}})
233 .IntoKey(M::ProfileClock)
234 .Define("-Xenable-profiler")
235 .WithType<TestProfilerOptions>()
236 .AppendValues()
237 .IntoKey(M::ProfilerOpts) // NOTE: Appends into same key as -Xprofile-*
238 .Define("-Xprofile-_") // -Xprofile-<key>:<value>
239 .WithType<TestProfilerOptions>()
240 .AppendValues()
241 .IntoKey(M::ProfilerOpts) // NOTE: Appends into same key as -Xenable-profiler
242 .Define("-Xcompiler:_")
243 .WithType<std::string>()
244 .IntoKey(M::Compiler)
245 .Define("-Xcompiler-option _")
246 .WithType<std::vector<std::string>>()
247 .AppendValues()
248 .IntoKey(M::CompilerOptions)
249 .Define("-Ximage-compiler-option _")
250 .WithType<std::vector<std::string>>()
251 .AppendValues()
252 .IntoKey(M::ImageCompilerOptions)
253 .Define("-Xverify:_")
Igor Murashkin7617abd2015-07-10 18:27:47 -0700254 .WithType<verifier::VerifyMode>()
255 .WithValueMap({{"none", verifier::VerifyMode::kNone},
256 {"remote", verifier::VerifyMode::kEnable},
257 {"all", verifier::VerifyMode::kEnable},
258 {"softfail", verifier::VerifyMode::kSoftFail}})
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800259 .IntoKey(M::Verify)
260 .Define("-XX:NativeBridge=_")
261 .WithType<std::string>()
262 .IntoKey(M::NativeBridge)
Andreas Gampe9106e522015-03-31 14:54:03 -0700263 .Define("-Xzygote-max-boot-retry=_")
Narayan Kamath5a2be3f2015-02-16 13:51:51 +0000264 .WithType<unsigned int>()
265 .IntoKey(M::ZygoteMaxFailedBoots)
Jean Christophe Beyler24e04aa2014-09-12 12:03:25 -0700266 .Define("-Xno-dex-file-fallback")
267 .IntoKey(M::NoDexFileFallback)
Calin Juravle01aaf6e2015-06-19 22:05:39 +0100268 .Define("-Xno-sig-chain")
269 .IntoKey(M::NoSigChain)
Dmitriy Ivanov785049f2014-07-18 10:08:57 -0700270 .Define("--cpu-abilist=_")
271 .WithType<std::string>()
272 .IntoKey(M::CpuAbiList)
Andreas Gampedd671252015-07-23 14:37:18 -0700273 .Define("-Xfingerprint:_")
274 .WithType<std::string>()
275 .IntoKey(M::Fingerprint)
Alex Lighteb7c1442015-08-31 13:17:42 -0700276 .Define("-Xexperimental:_")
277 .WithType<ExperimentalFlags>()
278 .AppendValues()
279 .IntoKey(M::Experimental)
Calin Juravled3e7c6c2016-02-04 19:07:51 +0000280 .Define("-Xforce-nb-testing")
281 .IntoKey(M::ForceNativeBridge)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800282 .Ignore({
283 "-ea", "-da", "-enableassertions", "-disableassertions", "--runtime-arg", "-esa",
284 "-dsa", "-enablesystemassertions", "-disablesystemassertions", "-Xrs", "-Xint:_",
285 "-Xdexopt:_", "-Xnoquithandler", "-Xjnigreflimit:_", "-Xgenregmap", "-Xnogenregmap",
286 "-Xverifyopt:_", "-Xcheckdexsum", "-Xincludeselectedop", "-Xjitop:_",
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800287 "-Xincludeselectedmethod", "-Xjitthreshold:_",
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800288 "-Xjitblocking", "-Xjitmethod:_", "-Xjitclass:_", "-Xjitoffset:_",
289 "-Xjitconfig:_", "-Xjitcheckcg", "-Xjitverbose", "-Xjitprofile",
290 "-Xjitdisableopt", "-Xjitsuspendpoll", "-XX:mainThreadStackSize=_"})
291 .IgnoreUnrecognized(ignore_unrecognized);
292
293 // TODO: Move Usage information into this DSL.
294
295 return std::unique_ptr<RuntimeParser>(new RuntimeParser(parser_builder->Build()));
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800296}
297
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800298#pragma GCC diagnostic pop
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800299
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800300// Remove all the special options that have something in the void* part of the option.
301// If runtime_options is not null, put the options in there.
302// As a side-effect, populate the hooks from options.
303bool ParsedOptions::ProcessSpecialOptions(const RuntimeOptions& options,
304 RuntimeArgumentMap* runtime_options,
305 std::vector<std::string>* out_options) {
306 using M = RuntimeArgumentMap;
307
308 // TODO: Move the below loop into JNI
309 // Handle special options that set up hooks
310 for (size_t i = 0; i < options.size(); ++i) {
311 const std::string option(options[i].first);
312 // TODO: support -Djava.class.path
313 if (option == "bootclasspath") {
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000314 auto boot_class_path = static_cast<std::vector<std::unique_ptr<const DexFile>>*>(
315 const_cast<void*>(options[i].second));
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800316
317 if (runtime_options != nullptr) {
318 runtime_options->Set(M::BootClassPathDexList, boot_class_path);
319 }
320 } else if (option == "compilercallbacks") {
321 CompilerCallbacks* compiler_callbacks =
322 reinterpret_cast<CompilerCallbacks*>(const_cast<void*>(options[i].second));
323 if (runtime_options != nullptr) {
324 runtime_options->Set(M::CompilerCallbacksPtr, compiler_callbacks);
325 }
326 } else if (option == "imageinstructionset") {
327 const char* isa_str = reinterpret_cast<const char*>(options[i].second);
328 auto&& image_isa = GetInstructionSetFromString(isa_str);
329 if (image_isa == kNone) {
330 Usage("%s is not a valid instruction set.", isa_str);
331 return false;
332 }
333 if (runtime_options != nullptr) {
334 runtime_options->Set(M::ImageInstructionSet, image_isa);
335 }
336 } else if (option == "sensitiveThread") {
337 const void* hook = options[i].second;
338 bool (*hook_is_sensitive_thread)() = reinterpret_cast<bool (*)()>(const_cast<void*>(hook));
339
340 if (runtime_options != nullptr) {
341 runtime_options->Set(M::HookIsSensitiveThread, hook_is_sensitive_thread);
342 }
343 } else if (option == "vfprintf") {
344 const void* hook = options[i].second;
345 if (hook == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700346 Usage("vfprintf argument was nullptr");
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800347 return false;
348 }
349 int (*hook_vfprintf)(FILE *, const char*, va_list) =
350 reinterpret_cast<int (*)(FILE *, const char*, va_list)>(const_cast<void*>(hook));
351
352 if (runtime_options != nullptr) {
353 runtime_options->Set(M::HookVfprintf, hook_vfprintf);
354 }
355 hook_vfprintf_ = hook_vfprintf;
356 } else if (option == "exit") {
357 const void* hook = options[i].second;
358 if (hook == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700359 Usage("exit argument was nullptr");
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800360 return false;
361 }
362 void(*hook_exit)(jint) = reinterpret_cast<void(*)(jint)>(const_cast<void*>(hook));
363 if (runtime_options != nullptr) {
364 runtime_options->Set(M::HookExit, hook_exit);
365 }
366 hook_exit_ = hook_exit;
367 } else if (option == "abort") {
368 const void* hook = options[i].second;
369 if (hook == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700370 Usage("abort was nullptr\n");
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800371 return false;
372 }
373 void(*hook_abort)() = reinterpret_cast<void(*)()>(const_cast<void*>(hook));
374 if (runtime_options != nullptr) {
375 runtime_options->Set(M::HookAbort, hook_abort);
376 }
377 hook_abort_ = hook_abort;
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700378 } else {
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800379 // It is a regular option, that doesn't have a known 'second' value.
380 // Push it on to the regular options which will be parsed by our parser.
381 if (out_options != nullptr) {
382 out_options->push_back(option);
383 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700384 }
385 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800386
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700387 return true;
388}
389
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200390// Intended for local changes only.
391static void MaybeOverrideVerbosity() {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800392 // gLogVerbosity.class_linker = true; // TODO: don't check this in!
393 // gLogVerbosity.compiler = true; // TODO: don't check this in!
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200394 // gLogVerbosity.deopt = true; // TODO: don't check this in!
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800395 // gLogVerbosity.gc = true; // TODO: don't check this in!
396 // gLogVerbosity.heap = true; // TODO: don't check this in!
397 // gLogVerbosity.jdwp = true; // TODO: don't check this in!
398 // gLogVerbosity.jit = true; // TODO: don't check this in!
399 // gLogVerbosity.jni = true; // TODO: don't check this in!
400 // gLogVerbosity.monitor = true; // TODO: don't check this in!
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200401 // gLogVerbosity.oat = true; // TODO: don't check this in!
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800402 // gLogVerbosity.profiler = true; // TODO: don't check this in!
403 // gLogVerbosity.signals = true; // TODO: don't check this in!
Phil Wang751beff2015-08-28 15:17:15 +0800404 // gLogVerbosity.simulator = true; // TODO: don't check this in!
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800405 // gLogVerbosity.startup = true; // TODO: don't check this in!
406 // gLogVerbosity.third_party_jni = true; // TODO: don't check this in!
407 // gLogVerbosity.threads = true; // TODO: don't check this in!
408 // gLogVerbosity.verifier = true; // TODO: don't check this in!
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200409}
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800410
Vladimir Marko88b2b802015-12-04 14:19:04 +0000411bool ParsedOptions::DoParse(const RuntimeOptions& options,
412 bool ignore_unrecognized,
413 RuntimeArgumentMap* runtime_options) {
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800414 for (size_t i = 0; i < options.size(); ++i) {
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800415 if (true && options[0].first == "-Xzygote") {
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800416 LOG(INFO) << "option[" << i << "]=" << options[i].first;
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800417 }
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800418 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800419
420 auto parser = MakeParser(ignore_unrecognized);
421
422 // Convert to a simple string list (without the magic pointer options)
423 std::vector<std::string> argv_list;
Igor Murashkinb1d8c312015-08-04 11:18:43 -0700424 if (!ProcessSpecialOptions(options, nullptr, &argv_list)) {
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800425 return false;
426 }
427
428 CmdlineResult parse_result = parser->Parse(argv_list);
429
430 // Handle parse errors by displaying the usage and potentially exiting.
431 if (parse_result.IsError()) {
432 if (parse_result.GetStatus() == CmdlineResult::kUsage) {
433 UsageMessage(stdout, "%s\n", parse_result.GetMessage().c_str());
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800434 Exit(0);
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800435 } else if (parse_result.GetStatus() == CmdlineResult::kUnknown && !ignore_unrecognized) {
436 Usage("%s\n", parse_result.GetMessage().c_str());
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800437 return false;
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800438 } else {
439 Usage("%s\n", parse_result.GetMessage().c_str());
440 Exit(0);
441 }
442
443 UNREACHABLE();
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800444 }
445
446 using M = RuntimeArgumentMap;
447 RuntimeArgumentMap args = parser->ReleaseArgumentsMap();
448
449 // -help, -showversion, etc.
450 if (args.Exists(M::Help)) {
451 Usage(nullptr);
452 return false;
453 } else if (args.Exists(M::ShowVersion)) {
454 UsageMessage(stdout, "ART version %s\n", Runtime::GetVersion());
455 Exit(0);
456 } else if (args.Exists(M::BootClassPath)) {
457 LOG(INFO) << "setting boot class path to " << *args.Get(M::BootClassPath);
458 }
459
460 // Set a default boot class path if we didn't get an explicit one via command line.
461 if (getenv("BOOTCLASSPATH") != nullptr) {
462 args.SetIfMissing(M::BootClassPath, std::string(getenv("BOOTCLASSPATH")));
463 }
464
465 // Set a default class path if we didn't get an explicit one via command line.
466 if (getenv("CLASSPATH") != nullptr) {
467 args.SetIfMissing(M::ClassPath, std::string(getenv("CLASSPATH")));
468 }
469
470 // Default to number of processors minus one since the main GC thread also does work.
Mathieu Chartier10d68862015-04-15 14:21:33 -0700471 args.SetIfMissing(M::ParallelGCThreads, gc::Heap::kDefaultEnableParallelGC ?
472 static_cast<unsigned int>(sysconf(_SC_NPROCESSORS_CONF) - 1u) : 0u);
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800473
474 // -Xverbose:
475 {
476 LogVerbosity *log_verbosity = args.Get(M::Verbose);
477 if (log_verbosity != nullptr) {
478 gLogVerbosity = *log_verbosity;
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800479 }
480 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800481
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200482 MaybeOverrideVerbosity();
483
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800484 // -Xprofile:
485 Trace::SetDefaultClockSource(args.GetOrDefault(M::ProfileClock));
486
487 if (!ProcessSpecialOptions(options, &args, nullptr)) {
488 return false;
489 }
490
491 {
492 // If not set, background collector type defaults to homogeneous compaction.
493 // If foreground is GSS, use GSS as background collector.
494 // If not low memory mode, semispace otherwise.
495
496 gc::CollectorType background_collector_type_;
497 gc::CollectorType collector_type_ = (XGcOption{}).collector_type_; // NOLINT [whitespace/braces] [5]
498 bool low_memory_mode_ = args.Exists(M::LowMemoryMode);
499
500 background_collector_type_ = args.GetOrDefault(M::BackgroundGc);
501 {
502 XGcOption* xgc = args.Get(M::GcOption);
503 if (xgc != nullptr && xgc->collector_type_ != gc::kCollectorTypeNone) {
504 collector_type_ = xgc->collector_type_;
505 }
506 }
507
508 if (background_collector_type_ == gc::kCollectorTypeNone) {
509 if (collector_type_ != gc::kCollectorTypeGSS) {
510 background_collector_type_ = low_memory_mode_ ?
511 gc::kCollectorTypeSS : gc::kCollectorTypeHomogeneousSpaceCompact;
512 } else {
513 background_collector_type_ = collector_type_;
514 }
515 }
516
517 args.Set(M::BackgroundGc, BackgroundGcOption { background_collector_type_ });
Mathieu Chartier6b2352b2014-08-20 14:13:18 -0700518 }
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800519
520 // If a reference to the dalvik core.jar snuck in, replace it with
521 // the art specific version. This can happen with on device
522 // boot.art/boot.oat generation by GenerateImage which relies on the
523 // value of BOOTCLASSPATH.
Kenny Rootd5185342014-05-13 14:47:05 -0700524#if defined(ART_TARGET)
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800525 std::string core_jar("/core.jar");
Kenny Rootd5185342014-05-13 14:47:05 -0700526 std::string core_libart_jar("/core-libart.jar");
527#else
528 // The host uses hostdex files.
529 std::string core_jar("/core-hostdex.jar");
530 std::string core_libart_jar("/core-libart-hostdex.jar");
531#endif
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800532 auto boot_class_path_string = args.GetOrDefault(M::BootClassPath);
533
534 size_t core_jar_pos = boot_class_path_string.find(core_jar);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800535 if (core_jar_pos != std::string::npos) {
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800536 boot_class_path_string.replace(core_jar_pos, core_jar.size(), core_libart_jar);
537 args.Set(M::BootClassPath, boot_class_path_string);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800538 }
539
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800540 {
541 auto&& boot_class_path = args.GetOrDefault(M::BootClassPath);
542 auto&& boot_class_path_locations = args.GetOrDefault(M::BootClassPathLocations);
543 if (args.Exists(M::BootClassPathLocations)) {
544 size_t boot_class_path_count = ParseStringList<':'>::Split(boot_class_path).Size();
Richard Uhlerc2752592015-01-02 13:28:22 -0800545
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800546 if (boot_class_path_count != boot_class_path_locations.Size()) {
547 Usage("The number of boot class path files does not match"
548 " the number of boot class path locations given\n"
549 " boot class path files (%zu): %s\n"
550 " boot class path locations (%zu): %s\n",
551 boot_class_path.size(), boot_class_path_string.c_str(),
552 boot_class_path_locations.Size(), boot_class_path_locations.Join().c_str());
553 return false;
554 }
Richard Uhlerc2752592015-01-02 13:28:22 -0800555 }
556 }
557
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800558 if (!args.Exists(M::CompilerCallbacksPtr) && !args.Exists(M::Image)) {
559 std::string image = GetAndroidRoot();
560 image += "/framework/boot.art";
561 args.Set(M::Image, image);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800562 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800563
Lin Zang8cd63ab2015-11-06 14:08:51 +0800564 // 0 means no growth limit, and growth limit should be always <= heap size
565 if (args.GetOrDefault(M::HeapGrowthLimit) <= 0u ||
566 args.GetOrDefault(M::HeapGrowthLimit) > args.GetOrDefault(M::MemoryMaximumSize)) {
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800567 args.Set(M::HeapGrowthLimit, args.GetOrDefault(M::MemoryMaximumSize));
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800568 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800569
Alex Lighteb7c1442015-08-31 13:17:42 -0700570 if (args.GetOrDefault(M::Experimental) & ExperimentalFlags::kLambdas) {
Igor Murashkin158f35c2015-06-10 15:55:30 -0700571 LOG(WARNING) << "Experimental lambdas have been enabled. All lambda opcodes have "
572 << "an unstable specification and are nearly guaranteed to change over time. "
573 << "Do not attempt to write shipping code against these opcodes.";
574 }
575
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800576 *runtime_options = std::move(args);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800577 return true;
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800578}
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800579
580void ParsedOptions::Exit(int status) {
581 hook_exit_(status);
582}
583
584void ParsedOptions::Abort() {
585 hook_abort_();
586}
587
588void ParsedOptions::UsageMessageV(FILE* stream, const char* fmt, va_list ap) {
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700589 hook_vfprintf_(stream, fmt, ap);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800590}
591
592void ParsedOptions::UsageMessage(FILE* stream, const char* fmt, ...) {
593 va_list ap;
594 va_start(ap, fmt);
595 UsageMessageV(stream, fmt, ap);
596 va_end(ap);
597}
598
599void ParsedOptions::Usage(const char* fmt, ...) {
600 bool error = (fmt != nullptr);
601 FILE* stream = error ? stderr : stdout;
602
603 if (fmt != nullptr) {
604 va_list ap;
605 va_start(ap, fmt);
606 UsageMessageV(stream, fmt, ap);
607 va_end(ap);
608 }
609
610 const char* program = "dalvikvm";
611 UsageMessage(stream, "%s: [options] class [argument ...]\n", program);
612 UsageMessage(stream, "\n");
613 UsageMessage(stream, "The following standard options are supported:\n");
614 UsageMessage(stream, " -classpath classpath (-cp classpath)\n");
615 UsageMessage(stream, " -Dproperty=value\n");
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800616 UsageMessage(stream, " -verbose:tag ('gc', 'jit', 'jni', or 'class')\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800617 UsageMessage(stream, " -showversion\n");
618 UsageMessage(stream, " -help\n");
619 UsageMessage(stream, " -agentlib:jdwp=options\n");
620 UsageMessage(stream, "\n");
621
622 UsageMessage(stream, "The following extended options are supported:\n");
623 UsageMessage(stream, " -Xrunjdwp:<options>\n");
624 UsageMessage(stream, " -Xbootclasspath:bootclasspath\n");
625 UsageMessage(stream, " -Xcheck:tag (e.g. 'jni')\n");
Nicolas Geoffray4fcdc942014-07-22 10:48:00 +0100626 UsageMessage(stream, " -XmsN (min heap, must be multiple of 1K, >= 1MB)\n");
627 UsageMessage(stream, " -XmxN (max heap, must be multiple of 1K, >= 2MB)\n");
628 UsageMessage(stream, " -XssN (stack size)\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800629 UsageMessage(stream, " -Xint\n");
630 UsageMessage(stream, "\n");
631
632 UsageMessage(stream, "The following Dalvik options are supported:\n");
633 UsageMessage(stream, " -Xzygote\n");
634 UsageMessage(stream, " -Xjnitrace:substring (eg NativeClass or nativeMethod)\n");
635 UsageMessage(stream, " -Xstacktracefile:<filename>\n");
636 UsageMessage(stream, " -Xgc:[no]preverify\n");
637 UsageMessage(stream, " -Xgc:[no]postverify\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800638 UsageMessage(stream, " -XX:HeapGrowthLimit=N\n");
639 UsageMessage(stream, " -XX:HeapMinFree=N\n");
640 UsageMessage(stream, " -XX:HeapMaxFree=N\n");
Mathieu Chartier6a7824d2014-08-22 14:53:04 -0700641 UsageMessage(stream, " -XX:NonMovingSpaceCapacity=N\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800642 UsageMessage(stream, " -XX:HeapTargetUtilization=doublevalue\n");
Mathieu Chartier455820e2014-04-18 12:02:39 -0700643 UsageMessage(stream, " -XX:ForegroundHeapGrowthMultiplier=doublevalue\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800644 UsageMessage(stream, " -XX:LowMemoryMode\n");
645 UsageMessage(stream, " -Xprofile:{threadcpuclock,wallclock,dualclock}\n");
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800646 UsageMessage(stream, " -Xjitthreshold:integervalue\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800647 UsageMessage(stream, "\n");
648
649 UsageMessage(stream, "The following unique to ART options are supported:\n");
650 UsageMessage(stream, " -Xgc:[no]preverify_rosalloc\n");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700651 UsageMessage(stream, " -Xgc:[no]postsweepingverify_rosalloc\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800652 UsageMessage(stream, " -Xgc:[no]postverify_rosalloc\n");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700653 UsageMessage(stream, " -Xgc:[no]presweepingverify\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800654 UsageMessage(stream, " -Ximage:filename\n");
Richard Uhlerc2752592015-01-02 13:28:22 -0800655 UsageMessage(stream, " -Xbootclasspath-locations:bootclasspath\n"
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800656 " (override the dex locations of the -Xbootclasspath files)\n");
Mathieu Chartier2dbe6272014-09-16 10:43:23 -0700657 UsageMessage(stream, " -XX:+DisableExplicitGC\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800658 UsageMessage(stream, " -XX:ParallelGCThreads=integervalue\n");
659 UsageMessage(stream, " -XX:ConcGCThreads=integervalue\n");
660 UsageMessage(stream, " -XX:MaxSpinsBeforeThinLockInflation=integervalue\n");
661 UsageMessage(stream, " -XX:LongPauseLogThreshold=integervalue\n");
662 UsageMessage(stream, " -XX:LongGCLogThreshold=integervalue\n");
663 UsageMessage(stream, " -XX:DumpGCPerformanceOnShutdown\n");
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700664 UsageMessage(stream, " -XX:DumpJITInfoOnShutdown\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800665 UsageMessage(stream, " -XX:IgnoreMaxFootprint\n");
666 UsageMessage(stream, " -XX:UseTLAB\n");
667 UsageMessage(stream, " -XX:BackgroundGC=none\n");
Mathieu Chartier2dbe6272014-09-16 10:43:23 -0700668 UsageMessage(stream, " -XX:LargeObjectSpace={disabled,map,freelist}\n");
669 UsageMessage(stream, " -XX:LargeObjectThreshold=N\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800670 UsageMessage(stream, " -Xmethod-trace\n");
671 UsageMessage(stream, " -Xmethod-trace-file:filename");
672 UsageMessage(stream, " -Xmethod-trace-file-size:integervalue\n");
Calin Juravlec1b643c2014-05-30 23:44:11 +0100673 UsageMessage(stream, " -Xenable-profiler\n");
Wei Jin2221e3b2014-05-21 18:35:19 -0700674 UsageMessage(stream, " -Xprofile-filename:filename\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800675 UsageMessage(stream, " -Xprofile-period:integervalue\n");
676 UsageMessage(stream, " -Xprofile-duration:integervalue\n");
677 UsageMessage(stream, " -Xprofile-interval:integervalue\n");
Calin Juravle54c73ca2014-05-22 12:13:54 +0100678 UsageMessage(stream, " -Xprofile-backoff:doublevalue\n");
Calin Juravlec1b643c2014-05-30 23:44:11 +0100679 UsageMessage(stream, " -Xprofile-start-immediately\n");
680 UsageMessage(stream, " -Xprofile-top-k-threshold:doublevalue\n");
681 UsageMessage(stream, " -Xprofile-top-k-change-threshold:doublevalue\n");
Wei Jin445220d2014-06-20 15:56:53 -0700682 UsageMessage(stream, " -Xprofile-type:{method,stack}\n");
683 UsageMessage(stream, " -Xprofile-max-stack-depth:integervalue\n");
Tsu Chiang Chuang12e6d742014-05-22 10:22:25 -0700684 UsageMessage(stream, " -Xcompiler:filename\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800685 UsageMessage(stream, " -Xcompiler-option dex2oat-option\n");
686 UsageMessage(stream, " -Ximage-compiler-option dex2oat-option\n");
Alex Lighta59dd802014-07-02 16:28:08 -0700687 UsageMessage(stream, " -Xpatchoat:filename\n");
Mathieu Chartier1972a8e2015-03-05 17:12:54 -0800688 UsageMessage(stream, " -Xusejit:booleanvalue\n");
Nicolas Geoffray56782292015-11-19 14:25:43 +0000689 UsageMessage(stream, " -Xjitinitialsize:N\n");
690 UsageMessage(stream, " -Xjitmaxsize:N\n");
Alex Lighta59dd802014-07-02 16:28:08 -0700691 UsageMessage(stream, " -X[no]relocate\n");
Nicolas Geoffray4fcdc942014-07-22 10:48:00 +0100692 UsageMessage(stream, " -X[no]dex2oat (Whether to invoke dex2oat on the application)\n");
Alex Light64ad14d2014-08-19 14:23:13 -0700693 UsageMessage(stream, " -X[no]image-dex2oat (Whether to create and use a boot image)\n");
Jean Christophe Beyler24e04aa2014-09-12 12:03:25 -0700694 UsageMessage(stream, " -Xno-dex-file-fallback "
695 "(Don't fall back to dex files without oat files)\n");
Neil Fuller9724c632016-01-07 15:42:47 +0000696 UsageMessage(stream, " -Xexperimental:lambdas "
697 "(Enable new and experimental dalvik opcodes and semantics)\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800698 UsageMessage(stream, "\n");
699
700 UsageMessage(stream, "The following previously supported Dalvik options are ignored:\n");
701 UsageMessage(stream, " -ea[:<package name>... |:<class name>]\n");
702 UsageMessage(stream, " -da[:<package name>... |:<class name>]\n");
703 UsageMessage(stream, " (-enableassertions, -disableassertions)\n");
704 UsageMessage(stream, " -esa\n");
705 UsageMessage(stream, " -dsa\n");
706 UsageMessage(stream, " (-enablesystemassertions, -disablesystemassertions)\n");
Igor Murashkin7617abd2015-07-10 18:27:47 -0700707 UsageMessage(stream, " -Xverify:{none,remote,all,softfail}\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800708 UsageMessage(stream, " -Xrs\n");
709 UsageMessage(stream, " -Xint:portable, -Xint:fast, -Xint:jit\n");
710 UsageMessage(stream, " -Xdexopt:{none,verified,all,full}\n");
711 UsageMessage(stream, " -Xnoquithandler\n");
712 UsageMessage(stream, " -Xjniopts:{warnonly,forcecopy}\n");
713 UsageMessage(stream, " -Xjnigreflimit:integervalue\n");
714 UsageMessage(stream, " -Xgc:[no]precise\n");
715 UsageMessage(stream, " -Xgc:[no]verifycardtable\n");
716 UsageMessage(stream, " -X[no]genregmap\n");
717 UsageMessage(stream, " -Xverifyopt:[no]checkmon\n");
718 UsageMessage(stream, " -Xcheckdexsum\n");
719 UsageMessage(stream, " -Xincludeselectedop\n");
720 UsageMessage(stream, " -Xjitop:hexopvalue[-endvalue][,hexopvalue[-endvalue]]*\n");
721 UsageMessage(stream, " -Xincludeselectedmethod\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800722 UsageMessage(stream, " -Xjitblocking\n");
723 UsageMessage(stream, " -Xjitmethod:signature[,signature]* (eg Ljava/lang/String\\;replace)\n");
724 UsageMessage(stream, " -Xjitclass:classname[,classname]*\n");
Nicolas Geoffray56782292015-11-19 14:25:43 +0000725 UsageMessage(stream, " -Xjitcodecachesize:N\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800726 UsageMessage(stream, " -Xjitoffset:offset[,offset]\n");
727 UsageMessage(stream, " -Xjitconfig:filename\n");
728 UsageMessage(stream, " -Xjitcheckcg\n");
729 UsageMessage(stream, " -Xjitverbose\n");
730 UsageMessage(stream, " -Xjitprofile\n");
731 UsageMessage(stream, " -Xjitdisableopt\n");
732 UsageMessage(stream, " -Xjitsuspendpoll\n");
733 UsageMessage(stream, " -XX:mainThreadStackSize=N\n");
734 UsageMessage(stream, "\n");
735
736 Exit((error) ? 1 : 0);
737}
738
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800739} // namespace art