blob: 5e84df5d0c5978b5a16513e3cf9a7ad5940fad6f [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
Igor Murashkinaaebaa02015-01-26 10:55:53 -080044ParsedOptions* ParsedOptions::Create(const RuntimeOptions& options, bool ignore_unrecognized,
45 RuntimeArgumentMap* runtime_options) {
46 CHECK(runtime_options != nullptr);
47
Ian Rogers700a4022014-05-19 16:49:03 -070048 std::unique_ptr<ParsedOptions> parsed(new ParsedOptions());
Igor Murashkinaaebaa02015-01-26 10:55:53 -080049 if (parsed->Parse(options, ignore_unrecognized, runtime_options)) {
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080050 return parsed.release();
51 }
52 return nullptr;
53}
54
Igor Murashkinaaebaa02015-01-26 10:55:53 -080055using RuntimeParser = CmdlineParser<RuntimeArgumentMap, RuntimeArgumentMap::Key>;
Brian Carlstrom491ca9e2014-03-02 18:24:38 -080056
Igor Murashkinaaebaa02015-01-26 10:55:53 -080057// Yes, the stack frame is huge. But we get called super early on (and just once)
58// to pass the command line arguments, so we'll probably be ok.
59// Ideas to avoid suppressing this diagnostic are welcome!
60#pragma GCC diagnostic push
61#pragma GCC diagnostic ignored "-Wframe-larger-than="
62
63std::unique_ptr<RuntimeParser> ParsedOptions::MakeParser(bool ignore_unrecognized) {
64 using M = RuntimeArgumentMap;
65
66 std::unique_ptr<RuntimeParser::Builder> parser_builder =
67 std::unique_ptr<RuntimeParser::Builder>(new RuntimeParser::Builder());
68
69 parser_builder->
70 Define("-Xzygote")
71 .IntoKey(M::Zygote)
72 .Define("-help")
73 .IntoKey(M::Help)
74 .Define("-showversion")
75 .IntoKey(M::ShowVersion)
76 .Define("-Xbootclasspath:_")
77 .WithType<std::string>()
78 .IntoKey(M::BootClassPath)
79 .Define("-Xbootclasspath-locations:_")
80 .WithType<ParseStringList<':'>>() // std::vector<std::string>, split by :
81 .IntoKey(M::BootClassPathLocations)
82 .Define({"-classpath _", "-cp _"})
83 .WithType<std::string>()
84 .IntoKey(M::ClassPath)
85 .Define("-Ximage:_")
86 .WithType<std::string>()
87 .IntoKey(M::Image)
88 .Define("-Xcheck:jni")
89 .IntoKey(M::CheckJni)
90 .Define("-Xjniopts:forcecopy")
91 .IntoKey(M::JniOptsForceCopy)
92 .Define({"-Xrunjdwp:_", "-agentlib:jdwp=_"})
93 .WithType<JDWP::JdwpOptions>()
94 .IntoKey(M::JdwpOptions)
95 .Define("-Xms_")
96 .WithType<MemoryKiB>()
97 .IntoKey(M::MemoryInitialSize)
98 .Define("-Xmx_")
99 .WithType<MemoryKiB>()
100 .IntoKey(M::MemoryMaximumSize)
101 .Define("-XX:HeapGrowthLimit=_")
102 .WithType<MemoryKiB>()
103 .IntoKey(M::HeapGrowthLimit)
104 .Define("-XX:HeapMinFree=_")
105 .WithType<MemoryKiB>()
106 .IntoKey(M::HeapMinFree)
107 .Define("-XX:HeapMaxFree=_")
108 .WithType<MemoryKiB>()
109 .IntoKey(M::HeapMaxFree)
110 .Define("-XX:NonMovingSpaceCapacity=_")
111 .WithType<MemoryKiB>()
112 .IntoKey(M::NonMovingSpaceCapacity)
113 .Define("-XX:HeapTargetUtilization=_")
114 .WithType<double>().WithRange(0.1, 0.9)
115 .IntoKey(M::HeapTargetUtilization)
116 .Define("-XX:ForegroundHeapGrowthMultiplier=_")
117 .WithType<double>().WithRange(0.1, 1.0)
118 .IntoKey(M::ForegroundHeapGrowthMultiplier)
119 .Define("-XX:ParallelGCThreads=_")
120 .WithType<unsigned int>()
121 .IntoKey(M::ParallelGCThreads)
122 .Define("-XX:ConcGCThreads=_")
123 .WithType<unsigned int>()
124 .IntoKey(M::ConcGCThreads)
125 .Define("-Xss_")
126 .WithType<Memory<1>>()
127 .IntoKey(M::StackSize)
128 .Define("-XX:MaxSpinsBeforeThinLockInflation=_")
129 .WithType<unsigned int>()
130 .IntoKey(M::MaxSpinsBeforeThinLockInflation)
131 .Define("-XX:LongPauseLogThreshold=_") // in ms
132 .WithType<MillisecondsToNanoseconds>() // store as ns
133 .IntoKey(M::LongPauseLogThreshold)
134 .Define("-XX:LongGCLogThreshold=_") // in ms
135 .WithType<MillisecondsToNanoseconds>() // store as ns
136 .IntoKey(M::LongGCLogThreshold)
137 .Define("-XX:DumpGCPerformanceOnShutdown")
138 .IntoKey(M::DumpGCPerformanceOnShutdown)
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700139 .Define("-XX:DumpJITInfoOnShutdown")
140 .IntoKey(M::DumpJITInfoOnShutdown)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800141 .Define("-XX:IgnoreMaxFootprint")
142 .IntoKey(M::IgnoreMaxFootprint)
143 .Define("-XX:LowMemoryMode")
144 .IntoKey(M::LowMemoryMode)
145 .Define("-XX:UseTLAB")
Hiroshi Yamauchif360ad02015-02-20 11:28:03 -0800146 .WithValue(true)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800147 .IntoKey(M::UseTLAB)
148 .Define({"-XX:EnableHSpaceCompactForOOM", "-XX:DisableHSpaceCompactForOOM"})
149 .WithValues({true, false})
150 .IntoKey(M::EnableHSpaceCompactForOOM)
Mathieu Chartier1972a8e2015-03-05 17:12:54 -0800151 .Define("-Xusejit:_")
152 .WithType<bool>()
153 .WithValueMap({{"false", false}, {"true", true}})
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800154 .IntoKey(M::UseJIT)
155 .Define("-Xjitcodecachesize:_")
156 .WithType<MemoryKiB>()
157 .IntoKey(M::JITCodeCacheCapacity)
158 .Define("-Xjitthreshold:_")
159 .WithType<unsigned int>()
160 .IntoKey(M::JITCompileThreshold)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800161 .Define("-XX:HspaceCompactForOOMMinIntervalMs=_") // in ms
162 .WithType<MillisecondsToNanoseconds>() // store as ns
163 .IntoKey(M::HSpaceCompactForOOMMinIntervalsMs)
164 .Define("-D_")
165 .WithType<std::vector<std::string>>().AppendValues()
166 .IntoKey(M::PropertiesList)
167 .Define("-Xjnitrace:_")
168 .WithType<std::string>()
169 .IntoKey(M::JniTrace)
170 .Define("-Xpatchoat:_")
171 .WithType<std::string>()
172 .IntoKey(M::PatchOat)
173 .Define({"-Xrelocate", "-Xnorelocate"})
174 .WithValues({true, false})
175 .IntoKey(M::Relocate)
176 .Define({"-Xdex2oat", "-Xnodex2oat"})
177 .WithValues({true, false})
178 .IntoKey(M::Dex2Oat)
179 .Define({"-Ximage-dex2oat", "-Xnoimage-dex2oat"})
180 .WithValues({true, false})
181 .IntoKey(M::ImageDex2Oat)
182 .Define("-Xint")
183 .WithValue(true)
184 .IntoKey(M::Interpret)
185 .Define("-Xgc:_")
186 .WithType<XGcOption>()
187 .IntoKey(M::GcOption)
188 .Define("-XX:LargeObjectSpace=_")
189 .WithType<gc::space::LargeObjectSpaceType>()
190 .WithValueMap({{"disabled", gc::space::LargeObjectSpaceType::kDisabled},
191 {"freelist", gc::space::LargeObjectSpaceType::kFreeList},
192 {"map", gc::space::LargeObjectSpaceType::kMap}})
193 .IntoKey(M::LargeObjectSpace)
194 .Define("-XX:LargeObjectThreshold=_")
195 .WithType<Memory<1>>()
196 .IntoKey(M::LargeObjectThreshold)
197 .Define("-XX:BackgroundGC=_")
198 .WithType<BackgroundGcOption>()
199 .IntoKey(M::BackgroundGc)
200 .Define("-XX:+DisableExplicitGC")
201 .IntoKey(M::DisableExplicitGC)
202 .Define("-verbose:_")
203 .WithType<LogVerbosity>()
204 .IntoKey(M::Verbose)
205 .Define("-Xlockprofthreshold:_")
206 .WithType<unsigned int>()
207 .IntoKey(M::LockProfThreshold)
208 .Define("-Xstacktracefile:_")
209 .WithType<std::string>()
210 .IntoKey(M::StackTraceFile)
211 .Define("-Xmethod-trace")
212 .IntoKey(M::MethodTrace)
213 .Define("-Xmethod-trace-file:_")
214 .WithType<std::string>()
215 .IntoKey(M::MethodTraceFile)
216 .Define("-Xmethod-trace-file-size:_")
217 .WithType<unsigned int>()
218 .IntoKey(M::MethodTraceFileSize)
Andreas Gampe40da2862015-02-27 12:49:04 -0800219 .Define("-Xmethod-trace-stream")
220 .IntoKey(M::MethodTraceStreaming)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800221 .Define("-Xprofile:_")
222 .WithType<TraceClockSource>()
223 .WithValueMap({{"threadcpuclock", TraceClockSource::kThreadCpu},
224 {"wallclock", TraceClockSource::kWall},
225 {"dualclock", TraceClockSource::kDual}})
226 .IntoKey(M::ProfileClock)
227 .Define("-Xenable-profiler")
228 .WithType<TestProfilerOptions>()
229 .AppendValues()
230 .IntoKey(M::ProfilerOpts) // NOTE: Appends into same key as -Xprofile-*
231 .Define("-Xprofile-_") // -Xprofile-<key>:<value>
232 .WithType<TestProfilerOptions>()
233 .AppendValues()
234 .IntoKey(M::ProfilerOpts) // NOTE: Appends into same key as -Xenable-profiler
235 .Define("-Xcompiler:_")
236 .WithType<std::string>()
237 .IntoKey(M::Compiler)
238 .Define("-Xcompiler-option _")
239 .WithType<std::vector<std::string>>()
240 .AppendValues()
241 .IntoKey(M::CompilerOptions)
242 .Define("-Ximage-compiler-option _")
243 .WithType<std::vector<std::string>>()
244 .AppendValues()
245 .IntoKey(M::ImageCompilerOptions)
246 .Define("-Xverify:_")
247 .WithType<bool>()
248 .WithValueMap({{"none", false},
249 {"remote", true},
250 {"all", true}})
251 .IntoKey(M::Verify)
252 .Define("-XX:NativeBridge=_")
253 .WithType<std::string>()
254 .IntoKey(M::NativeBridge)
Andreas Gampe9106e522015-03-31 14:54:03 -0700255 .Define("-Xzygote-max-boot-retry=_")
Narayan Kamath5a2be3f2015-02-16 13:51:51 +0000256 .WithType<unsigned int>()
257 .IntoKey(M::ZygoteMaxFailedBoots)
Jean Christophe Beyler24e04aa2014-09-12 12:03:25 -0700258 .Define("-Xno-dex-file-fallback")
259 .IntoKey(M::NoDexFileFallback)
Dmitriy Ivanov785049f2014-07-18 10:08:57 -0700260 .Define("--cpu-abilist=_")
261 .WithType<std::string>()
262 .IntoKey(M::CpuAbiList)
Igor Murashkin158f35c2015-06-10 15:55:30 -0700263 .Define({"-Xexperimental-lambdas", "-Xnoexperimental-lambdas"})
264 .WithType<bool>()
265 .WithValues({true, false})
266 .IntoKey(M::ExperimentalLambdas)
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800267 .Ignore({
268 "-ea", "-da", "-enableassertions", "-disableassertions", "--runtime-arg", "-esa",
269 "-dsa", "-enablesystemassertions", "-disablesystemassertions", "-Xrs", "-Xint:_",
270 "-Xdexopt:_", "-Xnoquithandler", "-Xjnigreflimit:_", "-Xgenregmap", "-Xnogenregmap",
271 "-Xverifyopt:_", "-Xcheckdexsum", "-Xincludeselectedop", "-Xjitop:_",
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800272 "-Xincludeselectedmethod", "-Xjitthreshold:_",
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800273 "-Xjitblocking", "-Xjitmethod:_", "-Xjitclass:_", "-Xjitoffset:_",
274 "-Xjitconfig:_", "-Xjitcheckcg", "-Xjitverbose", "-Xjitprofile",
275 "-Xjitdisableopt", "-Xjitsuspendpoll", "-XX:mainThreadStackSize=_"})
276 .IgnoreUnrecognized(ignore_unrecognized);
277
278 // TODO: Move Usage information into this DSL.
279
280 return std::unique_ptr<RuntimeParser>(new RuntimeParser(parser_builder->Build()));
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800281}
282
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800283#pragma GCC diagnostic pop
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800284
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800285// Remove all the special options that have something in the void* part of the option.
286// If runtime_options is not null, put the options in there.
287// As a side-effect, populate the hooks from options.
288bool ParsedOptions::ProcessSpecialOptions(const RuntimeOptions& options,
289 RuntimeArgumentMap* runtime_options,
290 std::vector<std::string>* out_options) {
291 using M = RuntimeArgumentMap;
292
293 // TODO: Move the below loop into JNI
294 // Handle special options that set up hooks
295 for (size_t i = 0; i < options.size(); ++i) {
296 const std::string option(options[i].first);
297 // TODO: support -Djava.class.path
298 if (option == "bootclasspath") {
299 auto boot_class_path
300 = reinterpret_cast<const std::vector<const DexFile*>*>(options[i].second);
301
302 if (runtime_options != nullptr) {
303 runtime_options->Set(M::BootClassPathDexList, boot_class_path);
304 }
305 } else if (option == "compilercallbacks") {
306 CompilerCallbacks* compiler_callbacks =
307 reinterpret_cast<CompilerCallbacks*>(const_cast<void*>(options[i].second));
308 if (runtime_options != nullptr) {
309 runtime_options->Set(M::CompilerCallbacksPtr, compiler_callbacks);
310 }
311 } else if (option == "imageinstructionset") {
312 const char* isa_str = reinterpret_cast<const char*>(options[i].second);
313 auto&& image_isa = GetInstructionSetFromString(isa_str);
314 if (image_isa == kNone) {
315 Usage("%s is not a valid instruction set.", isa_str);
316 return false;
317 }
318 if (runtime_options != nullptr) {
319 runtime_options->Set(M::ImageInstructionSet, image_isa);
320 }
321 } else if (option == "sensitiveThread") {
322 const void* hook = options[i].second;
323 bool (*hook_is_sensitive_thread)() = reinterpret_cast<bool (*)()>(const_cast<void*>(hook));
324
325 if (runtime_options != nullptr) {
326 runtime_options->Set(M::HookIsSensitiveThread, hook_is_sensitive_thread);
327 }
328 } else if (option == "vfprintf") {
329 const void* hook = options[i].second;
330 if (hook == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700331 Usage("vfprintf argument was nullptr");
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800332 return false;
333 }
334 int (*hook_vfprintf)(FILE *, const char*, va_list) =
335 reinterpret_cast<int (*)(FILE *, const char*, va_list)>(const_cast<void*>(hook));
336
337 if (runtime_options != nullptr) {
338 runtime_options->Set(M::HookVfprintf, hook_vfprintf);
339 }
340 hook_vfprintf_ = hook_vfprintf;
341 } else if (option == "exit") {
342 const void* hook = options[i].second;
343 if (hook == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700344 Usage("exit argument was nullptr");
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800345 return false;
346 }
347 void(*hook_exit)(jint) = reinterpret_cast<void(*)(jint)>(const_cast<void*>(hook));
348 if (runtime_options != nullptr) {
349 runtime_options->Set(M::HookExit, hook_exit);
350 }
351 hook_exit_ = hook_exit;
352 } else if (option == "abort") {
353 const void* hook = options[i].second;
354 if (hook == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700355 Usage("abort was nullptr\n");
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800356 return false;
357 }
358 void(*hook_abort)() = reinterpret_cast<void(*)()>(const_cast<void*>(hook));
359 if (runtime_options != nullptr) {
360 runtime_options->Set(M::HookAbort, hook_abort);
361 }
362 hook_abort_ = hook_abort;
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700363 } else {
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800364 // It is a regular option, that doesn't have a known 'second' value.
365 // Push it on to the regular options which will be parsed by our parser.
366 if (out_options != nullptr) {
367 out_options->push_back(option);
368 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700369 }
370 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800371
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700372 return true;
373}
374
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200375// Intended for local changes only.
376static void MaybeOverrideVerbosity() {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800377 // gLogVerbosity.class_linker = true; // TODO: don't check this in!
378 // gLogVerbosity.compiler = true; // TODO: don't check this in!
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200379 // gLogVerbosity.deopt = true; // TODO: don't check this in!
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800380 // gLogVerbosity.gc = true; // TODO: don't check this in!
381 // gLogVerbosity.heap = true; // TODO: don't check this in!
382 // gLogVerbosity.jdwp = true; // TODO: don't check this in!
383 // gLogVerbosity.jit = true; // TODO: don't check this in!
384 // gLogVerbosity.jni = true; // TODO: don't check this in!
385 // gLogVerbosity.monitor = true; // TODO: don't check this in!
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200386 // gLogVerbosity.oat = true; // TODO: don't check this in!
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800387 // gLogVerbosity.profiler = true; // TODO: don't check this in!
388 // gLogVerbosity.signals = true; // TODO: don't check this in!
389 // gLogVerbosity.startup = true; // TODO: don't check this in!
390 // gLogVerbosity.third_party_jni = true; // TODO: don't check this in!
391 // gLogVerbosity.threads = true; // TODO: don't check this in!
392 // gLogVerbosity.verifier = true; // TODO: don't check this in!
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200393}
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800394
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200395bool ParsedOptions::Parse(const RuntimeOptions& options, bool ignore_unrecognized,
396 RuntimeArgumentMap* runtime_options) {
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800397 for (size_t i = 0; i < options.size(); ++i) {
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800398 if (true && options[0].first == "-Xzygote") {
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800399 LOG(INFO) << "option[" << i << "]=" << options[i].first;
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800400 }
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800401 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800402
403 auto parser = MakeParser(ignore_unrecognized);
404
405 // Convert to a simple string list (without the magic pointer options)
406 std::vector<std::string> argv_list;
407 if (!ProcessSpecialOptions(options, nullptr, &argv_list)) {
408 return false;
409 }
410
411 CmdlineResult parse_result = parser->Parse(argv_list);
412
413 // Handle parse errors by displaying the usage and potentially exiting.
414 if (parse_result.IsError()) {
415 if (parse_result.GetStatus() == CmdlineResult::kUsage) {
416 UsageMessage(stdout, "%s\n", parse_result.GetMessage().c_str());
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800417 Exit(0);
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800418 } else if (parse_result.GetStatus() == CmdlineResult::kUnknown && !ignore_unrecognized) {
419 Usage("%s\n", parse_result.GetMessage().c_str());
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800420 return false;
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800421 } else {
422 Usage("%s\n", parse_result.GetMessage().c_str());
423 Exit(0);
424 }
425
426 UNREACHABLE();
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800427 }
428
429 using M = RuntimeArgumentMap;
430 RuntimeArgumentMap args = parser->ReleaseArgumentsMap();
431
432 // -help, -showversion, etc.
433 if (args.Exists(M::Help)) {
434 Usage(nullptr);
435 return false;
436 } else if (args.Exists(M::ShowVersion)) {
437 UsageMessage(stdout, "ART version %s\n", Runtime::GetVersion());
438 Exit(0);
439 } else if (args.Exists(M::BootClassPath)) {
440 LOG(INFO) << "setting boot class path to " << *args.Get(M::BootClassPath);
441 }
442
443 // Set a default boot class path if we didn't get an explicit one via command line.
444 if (getenv("BOOTCLASSPATH") != nullptr) {
445 args.SetIfMissing(M::BootClassPath, std::string(getenv("BOOTCLASSPATH")));
446 }
447
448 // Set a default class path if we didn't get an explicit one via command line.
449 if (getenv("CLASSPATH") != nullptr) {
450 args.SetIfMissing(M::ClassPath, std::string(getenv("CLASSPATH")));
451 }
452
453 // Default to number of processors minus one since the main GC thread also does work.
Mathieu Chartier10d68862015-04-15 14:21:33 -0700454 args.SetIfMissing(M::ParallelGCThreads, gc::Heap::kDefaultEnableParallelGC ?
455 static_cast<unsigned int>(sysconf(_SC_NPROCESSORS_CONF) - 1u) : 0u);
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800456
457 // -Xverbose:
458 {
459 LogVerbosity *log_verbosity = args.Get(M::Verbose);
460 if (log_verbosity != nullptr) {
461 gLogVerbosity = *log_verbosity;
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800462 }
463 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800464
Sebastien Hertzbba348e2015-06-01 08:28:18 +0200465 MaybeOverrideVerbosity();
466
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800467 // -Xprofile:
468 Trace::SetDefaultClockSource(args.GetOrDefault(M::ProfileClock));
469
470 if (!ProcessSpecialOptions(options, &args, nullptr)) {
471 return false;
472 }
473
474 {
475 // If not set, background collector type defaults to homogeneous compaction.
476 // If foreground is GSS, use GSS as background collector.
477 // If not low memory mode, semispace otherwise.
478
479 gc::CollectorType background_collector_type_;
480 gc::CollectorType collector_type_ = (XGcOption{}).collector_type_; // NOLINT [whitespace/braces] [5]
481 bool low_memory_mode_ = args.Exists(M::LowMemoryMode);
482
483 background_collector_type_ = args.GetOrDefault(M::BackgroundGc);
484 {
485 XGcOption* xgc = args.Get(M::GcOption);
486 if (xgc != nullptr && xgc->collector_type_ != gc::kCollectorTypeNone) {
487 collector_type_ = xgc->collector_type_;
488 }
489 }
490
491 if (background_collector_type_ == gc::kCollectorTypeNone) {
492 if (collector_type_ != gc::kCollectorTypeGSS) {
493 background_collector_type_ = low_memory_mode_ ?
494 gc::kCollectorTypeSS : gc::kCollectorTypeHomogeneousSpaceCompact;
495 } else {
496 background_collector_type_ = collector_type_;
497 }
498 }
499
500 args.Set(M::BackgroundGc, BackgroundGcOption { background_collector_type_ });
Mathieu Chartier6b2352b2014-08-20 14:13:18 -0700501 }
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800502
503 // If a reference to the dalvik core.jar snuck in, replace it with
504 // the art specific version. This can happen with on device
505 // boot.art/boot.oat generation by GenerateImage which relies on the
506 // value of BOOTCLASSPATH.
Kenny Rootd5185342014-05-13 14:47:05 -0700507#if defined(ART_TARGET)
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800508 std::string core_jar("/core.jar");
Kenny Rootd5185342014-05-13 14:47:05 -0700509 std::string core_libart_jar("/core-libart.jar");
510#else
511 // The host uses hostdex files.
512 std::string core_jar("/core-hostdex.jar");
513 std::string core_libart_jar("/core-libart-hostdex.jar");
514#endif
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800515 auto boot_class_path_string = args.GetOrDefault(M::BootClassPath);
516
517 size_t core_jar_pos = boot_class_path_string.find(core_jar);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800518 if (core_jar_pos != std::string::npos) {
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800519 boot_class_path_string.replace(core_jar_pos, core_jar.size(), core_libart_jar);
520 args.Set(M::BootClassPath, boot_class_path_string);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800521 }
522
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800523 {
524 auto&& boot_class_path = args.GetOrDefault(M::BootClassPath);
525 auto&& boot_class_path_locations = args.GetOrDefault(M::BootClassPathLocations);
526 if (args.Exists(M::BootClassPathLocations)) {
527 size_t boot_class_path_count = ParseStringList<':'>::Split(boot_class_path).Size();
Richard Uhlerc2752592015-01-02 13:28:22 -0800528
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800529 if (boot_class_path_count != boot_class_path_locations.Size()) {
530 Usage("The number of boot class path files does not match"
531 " the number of boot class path locations given\n"
532 " boot class path files (%zu): %s\n"
533 " boot class path locations (%zu): %s\n",
534 boot_class_path.size(), boot_class_path_string.c_str(),
535 boot_class_path_locations.Size(), boot_class_path_locations.Join().c_str());
536 return false;
537 }
Richard Uhlerc2752592015-01-02 13:28:22 -0800538 }
539 }
540
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800541 if (!args.Exists(M::CompilerCallbacksPtr) && !args.Exists(M::Image)) {
542 std::string image = GetAndroidRoot();
543 image += "/framework/boot.art";
544 args.Set(M::Image, image);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800545 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800546
547 if (args.GetOrDefault(M::HeapGrowthLimit) == 0u) { // 0 means no growth limit
548 args.Set(M::HeapGrowthLimit, args.GetOrDefault(M::MemoryMaximumSize));
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800549 }
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800550
Igor Murashkin158f35c2015-06-10 15:55:30 -0700551 if (args.GetOrDefault(M::ExperimentalLambdas)) {
552 LOG(WARNING) << "Experimental lambdas have been enabled. All lambda opcodes have "
553 << "an unstable specification and are nearly guaranteed to change over time. "
554 << "Do not attempt to write shipping code against these opcodes.";
555 }
556
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800557 *runtime_options = std::move(args);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800558 return true;
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800559}
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800560
561void ParsedOptions::Exit(int status) {
562 hook_exit_(status);
563}
564
565void ParsedOptions::Abort() {
566 hook_abort_();
567}
568
569void ParsedOptions::UsageMessageV(FILE* stream, const char* fmt, va_list ap) {
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700570 hook_vfprintf_(stream, fmt, ap);
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800571}
572
573void ParsedOptions::UsageMessage(FILE* stream, const char* fmt, ...) {
574 va_list ap;
575 va_start(ap, fmt);
576 UsageMessageV(stream, fmt, ap);
577 va_end(ap);
578}
579
580void ParsedOptions::Usage(const char* fmt, ...) {
581 bool error = (fmt != nullptr);
582 FILE* stream = error ? stderr : stdout;
583
584 if (fmt != nullptr) {
585 va_list ap;
586 va_start(ap, fmt);
587 UsageMessageV(stream, fmt, ap);
588 va_end(ap);
589 }
590
591 const char* program = "dalvikvm";
592 UsageMessage(stream, "%s: [options] class [argument ...]\n", program);
593 UsageMessage(stream, "\n");
594 UsageMessage(stream, "The following standard options are supported:\n");
595 UsageMessage(stream, " -classpath classpath (-cp classpath)\n");
596 UsageMessage(stream, " -Dproperty=value\n");
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800597 UsageMessage(stream, " -verbose:tag ('gc', 'jit', 'jni', or 'class')\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800598 UsageMessage(stream, " -showversion\n");
599 UsageMessage(stream, " -help\n");
600 UsageMessage(stream, " -agentlib:jdwp=options\n");
601 UsageMessage(stream, "\n");
602
603 UsageMessage(stream, "The following extended options are supported:\n");
604 UsageMessage(stream, " -Xrunjdwp:<options>\n");
605 UsageMessage(stream, " -Xbootclasspath:bootclasspath\n");
606 UsageMessage(stream, " -Xcheck:tag (e.g. 'jni')\n");
Nicolas Geoffray4fcdc942014-07-22 10:48:00 +0100607 UsageMessage(stream, " -XmsN (min heap, must be multiple of 1K, >= 1MB)\n");
608 UsageMessage(stream, " -XmxN (max heap, must be multiple of 1K, >= 2MB)\n");
609 UsageMessage(stream, " -XssN (stack size)\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800610 UsageMessage(stream, " -Xint\n");
611 UsageMessage(stream, "\n");
612
613 UsageMessage(stream, "The following Dalvik options are supported:\n");
614 UsageMessage(stream, " -Xzygote\n");
615 UsageMessage(stream, " -Xjnitrace:substring (eg NativeClass or nativeMethod)\n");
616 UsageMessage(stream, " -Xstacktracefile:<filename>\n");
617 UsageMessage(stream, " -Xgc:[no]preverify\n");
618 UsageMessage(stream, " -Xgc:[no]postverify\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800619 UsageMessage(stream, " -XX:HeapGrowthLimit=N\n");
620 UsageMessage(stream, " -XX:HeapMinFree=N\n");
621 UsageMessage(stream, " -XX:HeapMaxFree=N\n");
Mathieu Chartier6a7824d2014-08-22 14:53:04 -0700622 UsageMessage(stream, " -XX:NonMovingSpaceCapacity=N\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800623 UsageMessage(stream, " -XX:HeapTargetUtilization=doublevalue\n");
Mathieu Chartier455820e2014-04-18 12:02:39 -0700624 UsageMessage(stream, " -XX:ForegroundHeapGrowthMultiplier=doublevalue\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800625 UsageMessage(stream, " -XX:LowMemoryMode\n");
626 UsageMessage(stream, " -Xprofile:{threadcpuclock,wallclock,dualclock}\n");
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800627 UsageMessage(stream, " -Xjitcodecachesize:N\n");
628 UsageMessage(stream, " -Xjitthreshold:integervalue\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800629 UsageMessage(stream, "\n");
630
631 UsageMessage(stream, "The following unique to ART options are supported:\n");
632 UsageMessage(stream, " -Xgc:[no]preverify_rosalloc\n");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700633 UsageMessage(stream, " -Xgc:[no]postsweepingverify_rosalloc\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800634 UsageMessage(stream, " -Xgc:[no]postverify_rosalloc\n");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700635 UsageMessage(stream, " -Xgc:[no]presweepingverify\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800636 UsageMessage(stream, " -Ximage:filename\n");
Richard Uhlerc2752592015-01-02 13:28:22 -0800637 UsageMessage(stream, " -Xbootclasspath-locations:bootclasspath\n"
Igor Murashkinaaebaa02015-01-26 10:55:53 -0800638 " (override the dex locations of the -Xbootclasspath files)\n");
Mathieu Chartier2dbe6272014-09-16 10:43:23 -0700639 UsageMessage(stream, " -XX:+DisableExplicitGC\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800640 UsageMessage(stream, " -XX:ParallelGCThreads=integervalue\n");
641 UsageMessage(stream, " -XX:ConcGCThreads=integervalue\n");
642 UsageMessage(stream, " -XX:MaxSpinsBeforeThinLockInflation=integervalue\n");
643 UsageMessage(stream, " -XX:LongPauseLogThreshold=integervalue\n");
644 UsageMessage(stream, " -XX:LongGCLogThreshold=integervalue\n");
645 UsageMessage(stream, " -XX:DumpGCPerformanceOnShutdown\n");
Mathieu Chartiera4885cb2015-03-09 15:38:54 -0700646 UsageMessage(stream, " -XX:DumpJITInfoOnShutdown\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800647 UsageMessage(stream, " -XX:IgnoreMaxFootprint\n");
648 UsageMessage(stream, " -XX:UseTLAB\n");
649 UsageMessage(stream, " -XX:BackgroundGC=none\n");
Mathieu Chartier2dbe6272014-09-16 10:43:23 -0700650 UsageMessage(stream, " -XX:LargeObjectSpace={disabled,map,freelist}\n");
651 UsageMessage(stream, " -XX:LargeObjectThreshold=N\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800652 UsageMessage(stream, " -Xmethod-trace\n");
653 UsageMessage(stream, " -Xmethod-trace-file:filename");
654 UsageMessage(stream, " -Xmethod-trace-file-size:integervalue\n");
Calin Juravlec1b643c2014-05-30 23:44:11 +0100655 UsageMessage(stream, " -Xenable-profiler\n");
Wei Jin2221e3b2014-05-21 18:35:19 -0700656 UsageMessage(stream, " -Xprofile-filename:filename\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800657 UsageMessage(stream, " -Xprofile-period:integervalue\n");
658 UsageMessage(stream, " -Xprofile-duration:integervalue\n");
659 UsageMessage(stream, " -Xprofile-interval:integervalue\n");
Calin Juravle54c73ca2014-05-22 12:13:54 +0100660 UsageMessage(stream, " -Xprofile-backoff:doublevalue\n");
Calin Juravlec1b643c2014-05-30 23:44:11 +0100661 UsageMessage(stream, " -Xprofile-start-immediately\n");
662 UsageMessage(stream, " -Xprofile-top-k-threshold:doublevalue\n");
663 UsageMessage(stream, " -Xprofile-top-k-change-threshold:doublevalue\n");
Wei Jin445220d2014-06-20 15:56:53 -0700664 UsageMessage(stream, " -Xprofile-type:{method,stack}\n");
665 UsageMessage(stream, " -Xprofile-max-stack-depth:integervalue\n");
Tsu Chiang Chuang12e6d742014-05-22 10:22:25 -0700666 UsageMessage(stream, " -Xcompiler:filename\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800667 UsageMessage(stream, " -Xcompiler-option dex2oat-option\n");
668 UsageMessage(stream, " -Ximage-compiler-option dex2oat-option\n");
Alex Lighta59dd802014-07-02 16:28:08 -0700669 UsageMessage(stream, " -Xpatchoat:filename\n");
Mathieu Chartier1972a8e2015-03-05 17:12:54 -0800670 UsageMessage(stream, " -Xusejit:booleanvalue\n");
Alex Lighta59dd802014-07-02 16:28:08 -0700671 UsageMessage(stream, " -X[no]relocate\n");
Nicolas Geoffray4fcdc942014-07-22 10:48:00 +0100672 UsageMessage(stream, " -X[no]dex2oat (Whether to invoke dex2oat on the application)\n");
Alex Light64ad14d2014-08-19 14:23:13 -0700673 UsageMessage(stream, " -X[no]image-dex2oat (Whether to create and use a boot image)\n");
Jean Christophe Beyler24e04aa2014-09-12 12:03:25 -0700674 UsageMessage(stream, " -Xno-dex-file-fallback "
675 "(Don't fall back to dex files without oat files)\n");
Igor Murashkin158f35c2015-06-10 15:55:30 -0700676 UsageMessage(stream, " -X[no]experimental-lambdas\n"
677 " (Enable new experimental dalvik opcodes, off by default)\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800678 UsageMessage(stream, "\n");
679
680 UsageMessage(stream, "The following previously supported Dalvik options are ignored:\n");
681 UsageMessage(stream, " -ea[:<package name>... |:<class name>]\n");
682 UsageMessage(stream, " -da[:<package name>... |:<class name>]\n");
683 UsageMessage(stream, " (-enableassertions, -disableassertions)\n");
684 UsageMessage(stream, " -esa\n");
685 UsageMessage(stream, " -dsa\n");
686 UsageMessage(stream, " (-enablesystemassertions, -disablesystemassertions)\n");
687 UsageMessage(stream, " -Xverify:{none,remote,all}\n");
688 UsageMessage(stream, " -Xrs\n");
689 UsageMessage(stream, " -Xint:portable, -Xint:fast, -Xint:jit\n");
690 UsageMessage(stream, " -Xdexopt:{none,verified,all,full}\n");
691 UsageMessage(stream, " -Xnoquithandler\n");
692 UsageMessage(stream, " -Xjniopts:{warnonly,forcecopy}\n");
693 UsageMessage(stream, " -Xjnigreflimit:integervalue\n");
694 UsageMessage(stream, " -Xgc:[no]precise\n");
695 UsageMessage(stream, " -Xgc:[no]verifycardtable\n");
696 UsageMessage(stream, " -X[no]genregmap\n");
697 UsageMessage(stream, " -Xverifyopt:[no]checkmon\n");
698 UsageMessage(stream, " -Xcheckdexsum\n");
699 UsageMessage(stream, " -Xincludeselectedop\n");
700 UsageMessage(stream, " -Xjitop:hexopvalue[-endvalue][,hexopvalue[-endvalue]]*\n");
701 UsageMessage(stream, " -Xincludeselectedmethod\n");
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800702 UsageMessage(stream, " -Xjitblocking\n");
703 UsageMessage(stream, " -Xjitmethod:signature[,signature]* (eg Ljava/lang/String\\;replace)\n");
704 UsageMessage(stream, " -Xjitclass:classname[,classname]*\n");
705 UsageMessage(stream, " -Xjitoffset:offset[,offset]\n");
706 UsageMessage(stream, " -Xjitconfig:filename\n");
707 UsageMessage(stream, " -Xjitcheckcg\n");
708 UsageMessage(stream, " -Xjitverbose\n");
709 UsageMessage(stream, " -Xjitprofile\n");
710 UsageMessage(stream, " -Xjitdisableopt\n");
711 UsageMessage(stream, " -Xjitsuspendpoll\n");
712 UsageMessage(stream, " -XX:mainThreadStackSize=N\n");
713 UsageMessage(stream, "\n");
714
715 Exit((error) ? 1 : 0);
716}
717
Brian Carlstrom491ca9e2014-03-02 18:24:38 -0800718} // namespace art