parsed_options.cc revision c8423521c1d1136c70b153479b7df3bf4fd7fc2a
1/*
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"
18
19#ifdef HAVE_ANDROID_OS
20#include "cutils/properties.h"
21#endif
22
23#include "base/stringpiece.h"
24#include "debugger.h"
25#include "gc/heap.h"
26#include "monitor.h"
27#include "runtime.h"
28#include "trace.h"
29#include "utils.h"
30
31namespace art {
32
33ParsedOptions* ParsedOptions::Create(const RuntimeOptions& options, bool ignore_unrecognized) {
34  std::unique_ptr<ParsedOptions> parsed(new ParsedOptions());
35  if (parsed->Parse(options, ignore_unrecognized)) {
36    return parsed.release();
37  }
38  return nullptr;
39}
40
41// Parse a string of the form /[0-9]+[kKmMgG]?/, which is used to specify
42// memory sizes.  [kK] indicates kilobytes, [mM] megabytes, and
43// [gG] gigabytes.
44//
45// "s" should point just past the "-Xm?" part of the string.
46// "div" specifies a divisor, e.g. 1024 if the value must be a multiple
47// of 1024.
48//
49// The spec says the -Xmx and -Xms options must be multiples of 1024.  It
50// doesn't say anything about -Xss.
51//
52// Returns 0 (a useless size) if "s" is malformed or specifies a low or
53// non-evenly-divisible value.
54//
55size_t ParseMemoryOption(const char* s, size_t div) {
56  // strtoul accepts a leading [+-], which we don't want,
57  // so make sure our string starts with a decimal digit.
58  if (isdigit(*s)) {
59    char* s2;
60    size_t val = strtoul(s, &s2, 10);
61    if (s2 != s) {
62      // s2 should be pointing just after the number.
63      // If this is the end of the string, the user
64      // has specified a number of bytes.  Otherwise,
65      // there should be exactly one more character
66      // that specifies a multiplier.
67      if (*s2 != '\0') {
68        // The remainder of the string is either a single multiplier
69        // character, or nothing to indicate that the value is in
70        // bytes.
71        char c = *s2++;
72        if (*s2 == '\0') {
73          size_t mul;
74          if (c == '\0') {
75            mul = 1;
76          } else if (c == 'k' || c == 'K') {
77            mul = KB;
78          } else if (c == 'm' || c == 'M') {
79            mul = MB;
80          } else if (c == 'g' || c == 'G') {
81            mul = GB;
82          } else {
83            // Unknown multiplier character.
84            return 0;
85          }
86
87          if (val <= std::numeric_limits<size_t>::max() / mul) {
88            val *= mul;
89          } else {
90            // Clamp to a multiple of 1024.
91            val = std::numeric_limits<size_t>::max() & ~(1024-1);
92          }
93        } else {
94          // There's more than one character after the numeric part.
95          return 0;
96        }
97      }
98      // The man page says that a -Xm value must be a multiple of 1024.
99      if (val % div == 0) {
100        return val;
101      }
102    }
103  }
104  return 0;
105}
106
107static gc::CollectorType ParseCollectorType(const std::string& option) {
108  if (option == "MS" || option == "nonconcurrent") {
109    return gc::kCollectorTypeMS;
110  } else if (option == "CMS" || option == "concurrent") {
111    return gc::kCollectorTypeCMS;
112  } else if (option == "SS") {
113    return gc::kCollectorTypeSS;
114  } else if (option == "GSS") {
115    return gc::kCollectorTypeGSS;
116  } else if (option == "CC") {
117    return gc::kCollectorTypeCC;
118  } else if (option == "MC") {
119    return gc::kCollectorTypeMC;
120  } else {
121    return gc::kCollectorTypeNone;
122  }
123}
124
125bool ParsedOptions::ParseXGcOption(const std::string& option) {
126  std::vector<std::string> gc_options;
127  Split(option.substr(strlen("-Xgc:")), ',', gc_options);
128  for (const std::string& gc_option : gc_options) {
129    gc::CollectorType collector_type = ParseCollectorType(gc_option);
130    if (collector_type != gc::kCollectorTypeNone) {
131      collector_type_ = collector_type;
132    } else if (gc_option == "preverify") {
133      verify_pre_gc_heap_ = true;
134    } else if (gc_option == "nopreverify") {
135      verify_pre_gc_heap_ = false;
136    }  else if (gc_option == "presweepingverify") {
137      verify_pre_sweeping_heap_ = true;
138    } else if (gc_option == "nopresweepingverify") {
139      verify_pre_sweeping_heap_ = false;
140    } else if (gc_option == "postverify") {
141      verify_post_gc_heap_ = true;
142    } else if (gc_option == "nopostverify") {
143      verify_post_gc_heap_ = false;
144    } else if (gc_option == "preverify_rosalloc") {
145      verify_pre_gc_rosalloc_ = true;
146    } else if (gc_option == "nopreverify_rosalloc") {
147      verify_pre_gc_rosalloc_ = false;
148    } else if (gc_option == "presweepingverify_rosalloc") {
149      verify_pre_sweeping_rosalloc_ = true;
150    } else if (gc_option == "nopresweepingverify_rosalloc") {
151      verify_pre_sweeping_rosalloc_ = false;
152    } else if (gc_option == "postverify_rosalloc") {
153      verify_post_gc_rosalloc_ = true;
154    } else if (gc_option == "nopostverify_rosalloc") {
155      verify_post_gc_rosalloc_ = false;
156    } else if ((gc_option == "precise") ||
157               (gc_option == "noprecise") ||
158               (gc_option == "verifycardtable") ||
159               (gc_option == "noverifycardtable")) {
160      // Ignored for backwards compatibility.
161    } else {
162      Usage("Unknown -Xgc option %s\n", gc_option.c_str());
163      return false;
164    }
165  }
166  return true;
167}
168
169bool ParsedOptions::Parse(const RuntimeOptions& options, bool ignore_unrecognized) {
170  const char* boot_class_path_string = getenv("BOOTCLASSPATH");
171  if (boot_class_path_string != NULL) {
172    boot_class_path_string_ = boot_class_path_string;
173  }
174  const char* class_path_string = getenv("CLASSPATH");
175  if (class_path_string != NULL) {
176    class_path_string_ = class_path_string;
177  }
178  // -Xcheck:jni is off by default for regular builds but on by default in debug builds.
179  check_jni_ = kIsDebugBuild;
180  force_copy_ = false;
181
182  heap_initial_size_ = gc::Heap::kDefaultInitialSize;
183  heap_maximum_size_ = gc::Heap::kDefaultMaximumSize;
184  heap_min_free_ = gc::Heap::kDefaultMinFree;
185  heap_max_free_ = gc::Heap::kDefaultMaxFree;
186  heap_target_utilization_ = gc::Heap::kDefaultTargetUtilization;
187  foreground_heap_growth_multiplier_ = gc::Heap::kDefaultHeapGrowthMultiplier;
188  heap_growth_limit_ = 0;  // 0 means no growth limit .
189  // Default to number of processors minus one since the main GC thread also does work.
190  parallel_gc_threads_ = sysconf(_SC_NPROCESSORS_CONF) - 1;
191  // Only the main GC thread, no workers.
192  conc_gc_threads_ = 0;
193  // The default GC type is set in makefiles.
194#if ART_DEFAULT_GC_TYPE_IS_CMS
195  collector_type_ = gc::kCollectorTypeCMS;
196#elif ART_DEFAULT_GC_TYPE_IS_SS
197  collector_type_ = gc::kCollectorTypeSS;
198#elif ART_DEFAULT_GC_TYPE_IS_GSS
199  collector_type_ = gc::kCollectorTypeGSS;
200#else
201#error "ART default GC type must be set"
202#endif
203  // If we are using homogeneous space compaction then default background compaction to off since
204  // homogeneous space compactions when we transition to not jank perceptible.
205  use_homogeneous_space_compaction_for_oom_ = false;
206  // If background_collector_type_ is kCollectorTypeNone, it defaults to the collector_type_ after
207  // parsing options. If you set this to kCollectorTypeHSpaceCompact then we will do an hspace
208  // compaction when we transition to background instead of a normal collector transition.
209  background_collector_type_ = gc::kCollectorTypeSS;
210  stack_size_ = 0;  // 0 means default.
211  max_spins_before_thin_lock_inflation_ = Monitor::kDefaultMaxSpinsBeforeThinLockInflation;
212  low_memory_mode_ = false;
213  use_tlab_ = false;
214  min_interval_homogeneous_space_compaction_by_oom_ = MsToNs(100 * 1000);  // 100s.
215  verify_pre_gc_heap_ = false;
216  // Pre sweeping is the one that usually fails if the GC corrupted the heap.
217  verify_pre_sweeping_heap_ = kIsDebugBuild;
218  verify_post_gc_heap_ = false;
219  verify_pre_gc_rosalloc_ = kIsDebugBuild;
220  verify_pre_sweeping_rosalloc_ = false;
221  verify_post_gc_rosalloc_ = false;
222
223  compiler_callbacks_ = nullptr;
224  is_zygote_ = false;
225  must_relocate_ = kDefaultMustRelocate;
226  if (kPoisonHeapReferences) {
227    // kPoisonHeapReferences currently works only with the interpreter only.
228    // TODO: make it work with the compiler.
229    interpreter_only_ = true;
230  } else {
231    interpreter_only_ = false;
232  }
233  is_explicit_gc_disabled_ = false;
234
235  long_pause_log_threshold_ = gc::Heap::kDefaultLongPauseLogThreshold;
236  long_gc_log_threshold_ = gc::Heap::kDefaultLongGCLogThreshold;
237  dump_gc_performance_on_shutdown_ = false;
238  ignore_max_footprint_ = false;
239
240  lock_profiling_threshold_ = 0;
241  hook_is_sensitive_thread_ = NULL;
242
243  hook_vfprintf_ = vfprintf;
244  hook_exit_ = exit;
245  hook_abort_ = NULL;  // We don't call abort(3) by default; see Runtime::Abort.
246
247//  gLogVerbosity.class_linker = true;  // TODO: don't check this in!
248//  gLogVerbosity.compiler = true;  // TODO: don't check this in!
249//  gLogVerbosity.gc = true;  // TODO: don't check this in!
250//  gLogVerbosity.heap = true;  // TODO: don't check this in!
251//  gLogVerbosity.jdwp = true;  // TODO: don't check this in!
252//  gLogVerbosity.jni = true;  // TODO: don't check this in!
253//  gLogVerbosity.monitor = true;  // TODO: don't check this in!
254//  gLogVerbosity.profiler = true;  // TODO: don't check this in!
255//  gLogVerbosity.signals = true;  // TODO: don't check this in!
256//  gLogVerbosity.startup = true;  // TODO: don't check this in!
257//  gLogVerbosity.third_party_jni = true;  // TODO: don't check this in!
258//  gLogVerbosity.threads = true;  // TODO: don't check this in!
259//  gLogVerbosity.verifier = true;  // TODO: don't check this in!
260
261  method_trace_ = false;
262  method_trace_file_ = "/data/method-trace-file.bin";
263  method_trace_file_size_ = 10 * MB;
264
265  profile_clock_source_ = kDefaultTraceClockSource;
266
267  verify_ = true;
268  image_isa_ = kRuntimeISA;
269
270  for (size_t i = 0; i < options.size(); ++i) {
271    if (true && options[0].first == "-Xzygote") {
272      LOG(INFO) << "option[" << i << "]=" << options[i].first;
273    }
274  }
275  for (size_t i = 0; i < options.size(); ++i) {
276    const std::string option(options[i].first);
277    if (StartsWith(option, "-help")) {
278      Usage(nullptr);
279      return false;
280    } else if (StartsWith(option, "-showversion")) {
281      UsageMessage(stdout, "ART version %s\n", Runtime::GetVersion());
282      Exit(0);
283    } else if (StartsWith(option, "-Xbootclasspath:")) {
284      boot_class_path_string_ = option.substr(strlen("-Xbootclasspath:")).data();
285      LOG(INFO) << "setting boot class path to " << boot_class_path_string_;
286    } else if (option == "-classpath" || option == "-cp") {
287      // TODO: support -Djava.class.path
288      i++;
289      if (i == options.size()) {
290        Usage("Missing required class path value for %s\n", option.c_str());
291        return false;
292      }
293      const StringPiece& value = options[i].first;
294      class_path_string_ = value.data();
295    } else if (option == "bootclasspath") {
296      boot_class_path_
297          = reinterpret_cast<const std::vector<const DexFile*>*>(options[i].second);
298    } else if (StartsWith(option, "-Ximage:")) {
299      if (!ParseStringAfterChar(option, ':', &image_)) {
300        return false;
301      }
302    } else if (StartsWith(option, "-Xcheck:jni")) {
303      check_jni_ = true;
304    } else if (StartsWith(option, "-Xjniopts:forcecopy")) {
305      force_copy_ = true;
306    } else if (StartsWith(option, "-Xrunjdwp:") || StartsWith(option, "-agentlib:jdwp=")) {
307      std::string tail(option.substr(option[1] == 'X' ? 10 : 15));
308      // TODO: move parsing logic out of Dbg
309      if (tail == "help" || !Dbg::ParseJdwpOptions(tail)) {
310        if (tail != "help") {
311          UsageMessage(stderr, "Failed to parse JDWP option %s\n", tail.c_str());
312        }
313        Usage("Example: -Xrunjdwp:transport=dt_socket,address=8000,server=y\n"
314              "Example: -Xrunjdwp:transport=dt_socket,address=localhost:6500,server=n\n");
315        return false;
316      }
317    } else if (StartsWith(option, "-Xms")) {
318      size_t size = ParseMemoryOption(option.substr(strlen("-Xms")).c_str(), 1024);
319      if (size == 0) {
320        Usage("Failed to parse memory option %s\n", option.c_str());
321        return false;
322      }
323      heap_initial_size_ = size;
324    } else if (StartsWith(option, "-Xmx")) {
325      size_t size = ParseMemoryOption(option.substr(strlen("-Xmx")).c_str(), 1024);
326      if (size == 0) {
327        Usage("Failed to parse memory option %s\n", option.c_str());
328        return false;
329      }
330      heap_maximum_size_ = size;
331    } else if (StartsWith(option, "-XX:HeapGrowthLimit=")) {
332      size_t size = ParseMemoryOption(option.substr(strlen("-XX:HeapGrowthLimit=")).c_str(), 1024);
333      if (size == 0) {
334        Usage("Failed to parse memory option %s\n", option.c_str());
335        return false;
336      }
337      heap_growth_limit_ = size;
338    } else if (StartsWith(option, "-XX:HeapMinFree=")) {
339      size_t size = ParseMemoryOption(option.substr(strlen("-XX:HeapMinFree=")).c_str(), 1024);
340      if (size == 0) {
341        Usage("Failed to parse memory option %s\n", option.c_str());
342        return false;
343      }
344      heap_min_free_ = size;
345    } else if (StartsWith(option, "-XX:HeapMaxFree=")) {
346      size_t size = ParseMemoryOption(option.substr(strlen("-XX:HeapMaxFree=")).c_str(), 1024);
347      if (size == 0) {
348        Usage("Failed to parse memory option %s\n", option.c_str());
349        return false;
350      }
351      heap_max_free_ = size;
352    } else if (StartsWith(option, "-XX:HeapTargetUtilization=")) {
353      if (!ParseDouble(option, '=', 0.1, 0.9, &heap_target_utilization_)) {
354        return false;
355      }
356    } else if (StartsWith(option, "-XX:ForegroundHeapGrowthMultiplier=")) {
357      if (!ParseDouble(option, '=', 0.1, 10.0, &foreground_heap_growth_multiplier_)) {
358        return false;
359      }
360    } else if (StartsWith(option, "-XX:ParallelGCThreads=")) {
361      if (!ParseUnsignedInteger(option, '=', &parallel_gc_threads_)) {
362        return false;
363      }
364    } else if (StartsWith(option, "-XX:ConcGCThreads=")) {
365      if (!ParseUnsignedInteger(option, '=', &conc_gc_threads_)) {
366        return false;
367      }
368    } else if (StartsWith(option, "-Xss")) {
369      size_t size = ParseMemoryOption(option.substr(strlen("-Xss")).c_str(), 1);
370      if (size == 0) {
371        Usage("Failed to parse memory option %s\n", option.c_str());
372        return false;
373      }
374      stack_size_ = size;
375    } else if (StartsWith(option, "-XX:MaxSpinsBeforeThinLockInflation=")) {
376      if (!ParseUnsignedInteger(option, '=', &max_spins_before_thin_lock_inflation_)) {
377        return false;
378      }
379    } else if (StartsWith(option, "-XX:LongPauseLogThreshold=")) {
380      unsigned int value;
381      if (!ParseUnsignedInteger(option, '=', &value)) {
382        return false;
383      }
384      long_pause_log_threshold_ = MsToNs(value);
385    } else if (StartsWith(option, "-XX:LongGCLogThreshold=")) {
386      unsigned int value;
387      if (!ParseUnsignedInteger(option, '=', &value)) {
388        return false;
389      }
390      long_gc_log_threshold_ = MsToNs(value);
391    } else if (option == "-XX:DumpGCPerformanceOnShutdown") {
392      dump_gc_performance_on_shutdown_ = true;
393    } else if (option == "-XX:IgnoreMaxFootprint") {
394      ignore_max_footprint_ = true;
395    } else if (option == "-XX:LowMemoryMode") {
396      low_memory_mode_ = true;
397      // TODO Might want to turn off must_relocate here.
398    } else if (option == "-XX:UseTLAB") {
399      use_tlab_ = true;
400    } else if (option == "-XX:EnableHSpaceCompactForOOM") {
401      use_homogeneous_space_compaction_for_oom_ = true;
402    } else if (option == "-XX:DisableHSpaceCompactForOOM") {
403      use_homogeneous_space_compaction_for_oom_ = false;
404    } else if (StartsWith(option, "-D")) {
405      properties_.push_back(option.substr(strlen("-D")));
406    } else if (StartsWith(option, "-Xjnitrace:")) {
407      jni_trace_ = option.substr(strlen("-Xjnitrace:"));
408    } else if (option == "compilercallbacks") {
409      compiler_callbacks_ =
410          reinterpret_cast<CompilerCallbacks*>(const_cast<void*>(options[i].second));
411    } else if (option == "imageinstructionset") {
412      image_isa_ = GetInstructionSetFromString(
413          reinterpret_cast<const char*>(options[i].second));
414    } else if (option == "-Xzygote") {
415      is_zygote_ = true;
416    } else if (StartsWith(option, "-Xpatchoat:")) {
417      if (!ParseStringAfterChar(option, ':', &patchoat_executable_)) {
418        return false;
419      }
420    } else if (option == "-Xrelocate") {
421      must_relocate_ = true;
422    } else if (option == "-Xnorelocate") {
423      must_relocate_ = false;
424    } else if (option == "-Xint") {
425      interpreter_only_ = true;
426    } else if (StartsWith(option, "-Xgc:")) {
427      if (!ParseXGcOption(option)) {
428        return false;
429      }
430    } else if (StartsWith(option, "-XX:BackgroundGC=")) {
431      std::string substring;
432      if (!ParseStringAfterChar(option, '=', &substring)) {
433        return false;
434      }
435      // Special handling for HSpaceCompact since this is only valid as a background GC type.
436      if (substring == "HSpaceCompact") {
437        background_collector_type_ = gc::kCollectorTypeHomogeneousSpaceCompact;
438      } else {
439        gc::CollectorType collector_type = ParseCollectorType(substring);
440        if (collector_type != gc::kCollectorTypeNone) {
441          background_collector_type_ = collector_type;
442        } else {
443          Usage("Unknown -XX:BackgroundGC option %s\n", substring.c_str());
444          return false;
445        }
446      }
447    } else if (option == "-XX:+DisableExplicitGC") {
448      is_explicit_gc_disabled_ = true;
449    } else if (StartsWith(option, "-verbose:")) {
450      std::vector<std::string> verbose_options;
451      Split(option.substr(strlen("-verbose:")), ',', verbose_options);
452      for (size_t i = 0; i < verbose_options.size(); ++i) {
453        if (verbose_options[i] == "class") {
454          gLogVerbosity.class_linker = true;
455        } else if (verbose_options[i] == "compiler") {
456          gLogVerbosity.compiler = true;
457        } else if (verbose_options[i] == "gc") {
458          gLogVerbosity.gc = true;
459        } else if (verbose_options[i] == "heap") {
460          gLogVerbosity.heap = true;
461        } else if (verbose_options[i] == "jdwp") {
462          gLogVerbosity.jdwp = true;
463        } else if (verbose_options[i] == "jni") {
464          gLogVerbosity.jni = true;
465        } else if (verbose_options[i] == "monitor") {
466          gLogVerbosity.monitor = true;
467        } else if (verbose_options[i] == "profiler") {
468          gLogVerbosity.profiler = true;
469        } else if (verbose_options[i] == "signals") {
470          gLogVerbosity.signals = true;
471        } else if (verbose_options[i] == "startup") {
472          gLogVerbosity.startup = true;
473        } else if (verbose_options[i] == "third-party-jni") {
474          gLogVerbosity.third_party_jni = true;
475        } else if (verbose_options[i] == "threads") {
476          gLogVerbosity.threads = true;
477        } else if (verbose_options[i] == "verifier") {
478          gLogVerbosity.verifier = true;
479        } else {
480          Usage("Unknown -verbose option %s\n", verbose_options[i].c_str());
481          return false;
482        }
483      }
484    } else if (StartsWith(option, "-verbose-methods:")) {
485      gLogVerbosity.compiler = false;
486      Split(option.substr(strlen("-verbose-methods:")), ',', gVerboseMethods);
487    } else if (StartsWith(option, "-Xlockprofthreshold:")) {
488      if (!ParseUnsignedInteger(option, ':', &lock_profiling_threshold_)) {
489        return false;
490      }
491    } else if (StartsWith(option, "-Xstacktracefile:")) {
492      if (!ParseStringAfterChar(option, ':', &stack_trace_file_)) {
493        return false;
494      }
495    } else if (option == "sensitiveThread") {
496      const void* hook = options[i].second;
497      hook_is_sensitive_thread_ = reinterpret_cast<bool (*)()>(const_cast<void*>(hook));
498    } else if (option == "vfprintf") {
499      const void* hook = options[i].second;
500      if (hook == nullptr) {
501        Usage("vfprintf argument was NULL");
502        return false;
503      }
504      hook_vfprintf_ =
505          reinterpret_cast<int (*)(FILE *, const char*, va_list)>(const_cast<void*>(hook));
506    } else if (option == "exit") {
507      const void* hook = options[i].second;
508      if (hook == nullptr) {
509        Usage("exit argument was NULL");
510        return false;
511      }
512      hook_exit_ = reinterpret_cast<void(*)(jint)>(const_cast<void*>(hook));
513    } else if (option == "abort") {
514      const void* hook = options[i].second;
515      if (hook == nullptr) {
516        Usage("abort was NULL\n");
517        return false;
518      }
519      hook_abort_ = reinterpret_cast<void(*)()>(const_cast<void*>(hook));
520    } else if (option == "-Xmethod-trace") {
521      method_trace_ = true;
522    } else if (StartsWith(option, "-Xmethod-trace-file:")) {
523      method_trace_file_ = option.substr(strlen("-Xmethod-trace-file:"));
524    } else if (StartsWith(option, "-Xmethod-trace-file-size:")) {
525      if (!ParseUnsignedInteger(option, ':', &method_trace_file_size_)) {
526        return false;
527      }
528    } else if (option == "-Xprofile:threadcpuclock") {
529      Trace::SetDefaultClockSource(kTraceClockSourceThreadCpu);
530    } else if (option == "-Xprofile:wallclock") {
531      Trace::SetDefaultClockSource(kTraceClockSourceWall);
532    } else if (option == "-Xprofile:dualclock") {
533      Trace::SetDefaultClockSource(kTraceClockSourceDual);
534    } else if (option == "-Xenable-profiler") {
535      profiler_options_.enabled_ = true;
536    } else if (StartsWith(option, "-Xprofile-filename:")) {
537      if (!ParseStringAfterChar(option, ':', &profile_output_filename_)) {
538        return false;
539      }
540    } else if (StartsWith(option, "-Xprofile-period:")) {
541      if (!ParseUnsignedInteger(option, ':', &profiler_options_.period_s_)) {
542        return false;
543      }
544    } else if (StartsWith(option, "-Xprofile-duration:")) {
545      if (!ParseUnsignedInteger(option, ':', &profiler_options_.duration_s_)) {
546        return false;
547      }
548    } else if (StartsWith(option, "-Xprofile-interval:")) {
549      if (!ParseUnsignedInteger(option, ':', &profiler_options_.interval_us_)) {
550        return false;
551      }
552    } else if (StartsWith(option, "-Xprofile-backoff:")) {
553      if (!ParseDouble(option, ':', 1.0, 10.0, &profiler_options_.backoff_coefficient_)) {
554        return false;
555      }
556    } else if (option == "-Xprofile-start-immediately") {
557      profiler_options_.start_immediately_ = true;
558    } else if (StartsWith(option, "-Xprofile-top-k-threshold:")) {
559      if (!ParseDouble(option, ':', 0.0, 100.0, &profiler_options_.top_k_threshold_)) {
560        return false;
561      }
562    } else if (StartsWith(option, "-Xprofile-top-k-change-threshold:")) {
563      if (!ParseDouble(option, ':', 0.0, 100.0, &profiler_options_.top_k_change_threshold_)) {
564        return false;
565      }
566    } else if (option == "-Xprofile-type:method") {
567      profiler_options_.profile_type_ = kProfilerMethod;
568    } else if (option == "-Xprofile-type:stack") {
569      profiler_options_.profile_type_ = kProfilerBoundedStack;
570    } else if (StartsWith(option, "-Xprofile-max-stack-depth:")) {
571      if (!ParseUnsignedInteger(option, ':', &profiler_options_.max_stack_depth_)) {
572        return false;
573      }
574    } else if (StartsWith(option, "-Xcompiler:")) {
575      if (!ParseStringAfterChar(option, ':', &compiler_executable_)) {
576        return false;
577      }
578    } else if (option == "-Xcompiler-option") {
579      i++;
580      if (i == options.size()) {
581        Usage("Missing required compiler option for %s\n", option.c_str());
582        return false;
583      }
584      compiler_options_.push_back(options[i].first);
585    } else if (option == "-Ximage-compiler-option") {
586      i++;
587      if (i == options.size()) {
588        Usage("Missing required compiler option for %s\n", option.c_str());
589        return false;
590      }
591      image_compiler_options_.push_back(options[i].first);
592    } else if (StartsWith(option, "-Xverify:")) {
593      std::string verify_mode = option.substr(strlen("-Xverify:"));
594      if (verify_mode == "none") {
595        verify_ = false;
596      } else if (verify_mode == "remote" || verify_mode == "all") {
597        verify_ = true;
598      } else {
599        Usage("Unknown -Xverify option %s\n", verify_mode.c_str());
600        return false;
601      }
602    } else if (StartsWith(option, "-XX:NativeBridge=")) {
603      if (!ParseStringAfterChar(option, '=', &native_bridge_library_path_)) {
604        return false;
605      }
606    } else if (StartsWith(option, "-ea") ||
607               StartsWith(option, "-da") ||
608               StartsWith(option, "-enableassertions") ||
609               StartsWith(option, "-disableassertions") ||
610               (option == "--runtime-arg") ||
611               (option == "-esa") ||
612               (option == "-dsa") ||
613               (option == "-enablesystemassertions") ||
614               (option == "-disablesystemassertions") ||
615               (option == "-Xrs") ||
616               StartsWith(option, "-Xint:") ||
617               StartsWith(option, "-Xdexopt:") ||
618               (option == "-Xnoquithandler") ||
619               StartsWith(option, "-Xjnigreflimit:") ||
620               (option == "-Xgenregmap") ||
621               (option == "-Xnogenregmap") ||
622               StartsWith(option, "-Xverifyopt:") ||
623               (option == "-Xcheckdexsum") ||
624               (option == "-Xincludeselectedop") ||
625               StartsWith(option, "-Xjitop:") ||
626               (option == "-Xincludeselectedmethod") ||
627               StartsWith(option, "-Xjitthreshold:") ||
628               StartsWith(option, "-Xjitcodecachesize:") ||
629               (option == "-Xjitblocking") ||
630               StartsWith(option, "-Xjitmethod:") ||
631               StartsWith(option, "-Xjitclass:") ||
632               StartsWith(option, "-Xjitoffset:") ||
633               StartsWith(option, "-Xjitconfig:") ||
634               (option == "-Xjitcheckcg") ||
635               (option == "-Xjitverbose") ||
636               (option == "-Xjitprofile") ||
637               (option == "-Xjitdisableopt") ||
638               (option == "-Xjitsuspendpoll") ||
639               StartsWith(option, "-XX:mainThreadStackSize=")) {
640      // Ignored for backwards compatibility.
641    } else if (!ignore_unrecognized) {
642      Usage("Unrecognized option %s\n", option.c_str());
643      return false;
644    }
645  }
646
647  // If a reference to the dalvik core.jar snuck in, replace it with
648  // the art specific version. This can happen with on device
649  // boot.art/boot.oat generation by GenerateImage which relies on the
650  // value of BOOTCLASSPATH.
651#if defined(ART_TARGET)
652  std::string core_jar("/core.jar");
653  std::string core_libart_jar("/core-libart.jar");
654#else
655  // The host uses hostdex files.
656  std::string core_jar("/core-hostdex.jar");
657  std::string core_libart_jar("/core-libart-hostdex.jar");
658#endif
659  size_t core_jar_pos = boot_class_path_string_.find(core_jar);
660  if (core_jar_pos != std::string::npos) {
661    boot_class_path_string_.replace(core_jar_pos, core_jar.size(), core_libart_jar);
662  }
663
664  if (compiler_callbacks_ == nullptr && image_.empty()) {
665    image_ += GetAndroidRoot();
666    image_ += "/framework/boot.art";
667  }
668  if (heap_growth_limit_ == 0) {
669    heap_growth_limit_ = heap_maximum_size_;
670  }
671  if (background_collector_type_ == gc::kCollectorTypeNone) {
672    background_collector_type_ = collector_type_;
673  }
674  return true;
675}  // NOLINT(readability/fn_size)
676
677void ParsedOptions::Exit(int status) {
678  hook_exit_(status);
679}
680
681void ParsedOptions::Abort() {
682  hook_abort_();
683}
684
685void ParsedOptions::UsageMessageV(FILE* stream, const char* fmt, va_list ap) {
686  hook_vfprintf_(stderr, fmt, ap);
687}
688
689void ParsedOptions::UsageMessage(FILE* stream, const char* fmt, ...) {
690  va_list ap;
691  va_start(ap, fmt);
692  UsageMessageV(stream, fmt, ap);
693  va_end(ap);
694}
695
696void ParsedOptions::Usage(const char* fmt, ...) {
697  bool error = (fmt != nullptr);
698  FILE* stream = error ? stderr : stdout;
699
700  if (fmt != nullptr) {
701    va_list ap;
702    va_start(ap, fmt);
703    UsageMessageV(stream, fmt, ap);
704    va_end(ap);
705  }
706
707  const char* program = "dalvikvm";
708  UsageMessage(stream, "%s: [options] class [argument ...]\n", program);
709  UsageMessage(stream, "\n");
710  UsageMessage(stream, "The following standard options are supported:\n");
711  UsageMessage(stream, "  -classpath classpath (-cp classpath)\n");
712  UsageMessage(stream, "  -Dproperty=value\n");
713  UsageMessage(stream, "  -verbose:tag  ('gc', 'jni', or 'class')\n");
714  UsageMessage(stream, "  -showversion\n");
715  UsageMessage(stream, "  -help\n");
716  UsageMessage(stream, "  -agentlib:jdwp=options\n");
717  UsageMessage(stream, "\n");
718
719  UsageMessage(stream, "The following extended options are supported:\n");
720  UsageMessage(stream, "  -Xrunjdwp:<options>\n");
721  UsageMessage(stream, "  -Xbootclasspath:bootclasspath\n");
722  UsageMessage(stream, "  -Xcheck:tag  (e.g. 'jni')\n");
723  UsageMessage(stream, "  -XmsN  (min heap, must be multiple of 1K, >= 1MB)\n");
724  UsageMessage(stream, "  -XmxN  (max heap, must be multiple of 1K, >= 2MB)\n");
725  UsageMessage(stream, "  -XssN  (stack size)\n");
726  UsageMessage(stream, "  -Xint\n");
727  UsageMessage(stream, "\n");
728
729  UsageMessage(stream, "The following Dalvik options are supported:\n");
730  UsageMessage(stream, "  -Xzygote\n");
731  UsageMessage(stream, "  -Xjnitrace:substring (eg NativeClass or nativeMethod)\n");
732  UsageMessage(stream, "  -Xstacktracefile:<filename>\n");
733  UsageMessage(stream, "  -Xgc:[no]preverify\n");
734  UsageMessage(stream, "  -Xgc:[no]postverify\n");
735  UsageMessage(stream, "  -XX:+DisableExplicitGC\n");
736  UsageMessage(stream, "  -XX:HeapGrowthLimit=N\n");
737  UsageMessage(stream, "  -XX:HeapMinFree=N\n");
738  UsageMessage(stream, "  -XX:HeapMaxFree=N\n");
739  UsageMessage(stream, "  -XX:HeapTargetUtilization=doublevalue\n");
740  UsageMessage(stream, "  -XX:ForegroundHeapGrowthMultiplier=doublevalue\n");
741  UsageMessage(stream, "  -XX:LowMemoryMode\n");
742  UsageMessage(stream, "  -Xprofile:{threadcpuclock,wallclock,dualclock}\n");
743  UsageMessage(stream, "\n");
744
745  UsageMessage(stream, "The following unique to ART options are supported:\n");
746  UsageMessage(stream, "  -Xgc:[no]preverify_rosalloc\n");
747  UsageMessage(stream, "  -Xgc:[no]postsweepingverify_rosalloc\n");
748  UsageMessage(stream, "  -Xgc:[no]postverify_rosalloc\n");
749  UsageMessage(stream, "  -Xgc:[no]presweepingverify\n");
750  UsageMessage(stream, "  -Ximage:filename\n");
751  UsageMessage(stream, "  -XX:ParallelGCThreads=integervalue\n");
752  UsageMessage(stream, "  -XX:ConcGCThreads=integervalue\n");
753  UsageMessage(stream, "  -XX:MaxSpinsBeforeThinLockInflation=integervalue\n");
754  UsageMessage(stream, "  -XX:LongPauseLogThreshold=integervalue\n");
755  UsageMessage(stream, "  -XX:LongGCLogThreshold=integervalue\n");
756  UsageMessage(stream, "  -XX:DumpGCPerformanceOnShutdown\n");
757  UsageMessage(stream, "  -XX:IgnoreMaxFootprint\n");
758  UsageMessage(stream, "  -XX:UseTLAB\n");
759  UsageMessage(stream, "  -XX:BackgroundGC=none\n");
760  UsageMessage(stream, "  -Xmethod-trace\n");
761  UsageMessage(stream, "  -Xmethod-trace-file:filename");
762  UsageMessage(stream, "  -Xmethod-trace-file-size:integervalue\n");
763  UsageMessage(stream, "  -Xenable-profiler\n");
764  UsageMessage(stream, "  -Xprofile-filename:filename\n");
765  UsageMessage(stream, "  -Xprofile-period:integervalue\n");
766  UsageMessage(stream, "  -Xprofile-duration:integervalue\n");
767  UsageMessage(stream, "  -Xprofile-interval:integervalue\n");
768  UsageMessage(stream, "  -Xprofile-backoff:doublevalue\n");
769  UsageMessage(stream, "  -Xprofile-start-immediately\n");
770  UsageMessage(stream, "  -Xprofile-top-k-threshold:doublevalue\n");
771  UsageMessage(stream, "  -Xprofile-top-k-change-threshold:doublevalue\n");
772  UsageMessage(stream, "  -Xprofile-type:{method,stack}\n");
773  UsageMessage(stream, "  -Xprofile-max-stack-depth:integervalue\n");
774  UsageMessage(stream, "  -Xcompiler:filename\n");
775  UsageMessage(stream, "  -Xcompiler-option dex2oat-option\n");
776  UsageMessage(stream, "  -Ximage-compiler-option dex2oat-option\n");
777  UsageMessage(stream, "  -Xpatchoat:filename\n");
778  UsageMessage(stream, "  -X[no]relocate\n");
779  UsageMessage(stream, "\n");
780
781  UsageMessage(stream, "The following previously supported Dalvik options are ignored:\n");
782  UsageMessage(stream, "  -ea[:<package name>... |:<class name>]\n");
783  UsageMessage(stream, "  -da[:<package name>... |:<class name>]\n");
784  UsageMessage(stream, "   (-enableassertions, -disableassertions)\n");
785  UsageMessage(stream, "  -esa\n");
786  UsageMessage(stream, "  -dsa\n");
787  UsageMessage(stream, "   (-enablesystemassertions, -disablesystemassertions)\n");
788  UsageMessage(stream, "  -Xverify:{none,remote,all}\n");
789  UsageMessage(stream, "  -Xrs\n");
790  UsageMessage(stream, "  -Xint:portable, -Xint:fast, -Xint:jit\n");
791  UsageMessage(stream, "  -Xdexopt:{none,verified,all,full}\n");
792  UsageMessage(stream, "  -Xnoquithandler\n");
793  UsageMessage(stream, "  -Xjniopts:{warnonly,forcecopy}\n");
794  UsageMessage(stream, "  -Xjnigreflimit:integervalue\n");
795  UsageMessage(stream, "  -Xgc:[no]precise\n");
796  UsageMessage(stream, "  -Xgc:[no]verifycardtable\n");
797  UsageMessage(stream, "  -X[no]genregmap\n");
798  UsageMessage(stream, "  -Xverifyopt:[no]checkmon\n");
799  UsageMessage(stream, "  -Xcheckdexsum\n");
800  UsageMessage(stream, "  -Xincludeselectedop\n");
801  UsageMessage(stream, "  -Xjitop:hexopvalue[-endvalue][,hexopvalue[-endvalue]]*\n");
802  UsageMessage(stream, "  -Xincludeselectedmethod\n");
803  UsageMessage(stream, "  -Xjitthreshold:integervalue\n");
804  UsageMessage(stream, "  -Xjitcodecachesize:decimalvalueofkbytes\n");
805  UsageMessage(stream, "  -Xjitblocking\n");
806  UsageMessage(stream, "  -Xjitmethod:signature[,signature]* (eg Ljava/lang/String\\;replace)\n");
807  UsageMessage(stream, "  -Xjitclass:classname[,classname]*\n");
808  UsageMessage(stream, "  -Xjitoffset:offset[,offset]\n");
809  UsageMessage(stream, "  -Xjitconfig:filename\n");
810  UsageMessage(stream, "  -Xjitcheckcg\n");
811  UsageMessage(stream, "  -Xjitverbose\n");
812  UsageMessage(stream, "  -Xjitprofile\n");
813  UsageMessage(stream, "  -Xjitdisableopt\n");
814  UsageMessage(stream, "  -Xjitsuspendpoll\n");
815  UsageMessage(stream, "  -XX:mainThreadStackSize=N\n");
816  UsageMessage(stream, "\n");
817
818  Exit((error) ? 1 : 0);
819}
820
821bool ParsedOptions::ParseStringAfterChar(const std::string& s, char c, std::string* parsed_value) {
822  std::string::size_type colon = s.find(c);
823  if (colon == std::string::npos) {
824    Usage("Missing char %c in option %s\n", c, s.c_str());
825    return false;
826  }
827  // Add one to remove the char we were trimming until.
828  *parsed_value = s.substr(colon + 1);
829  return true;
830}
831
832bool ParsedOptions::ParseInteger(const std::string& s, char after_char, int* parsed_value) {
833  std::string::size_type colon = s.find(after_char);
834  if (colon == std::string::npos) {
835    Usage("Missing char %c in option %s\n", after_char, s.c_str());
836    return false;
837  }
838  const char* begin = &s[colon + 1];
839  char* end;
840  size_t result = strtoul(begin, &end, 10);
841  if (begin == end || *end != '\0') {
842    Usage("Failed to parse integer from %s\n", s.c_str());
843    return false;
844  }
845  *parsed_value = result;
846  return true;
847}
848
849bool ParsedOptions::ParseUnsignedInteger(const std::string& s, char after_char,
850                                         unsigned int* parsed_value) {
851  int i;
852  if (!ParseInteger(s, after_char, &i)) {
853    return false;
854  }
855  if (i < 0) {
856    Usage("Negative value %d passed for unsigned option %s\n", i, s.c_str());
857    return false;
858  }
859  *parsed_value = i;
860  return true;
861}
862
863bool ParsedOptions::ParseDouble(const std::string& option, char after_char,
864                                double min, double max, double* parsed_value) {
865  std::string substring;
866  if (!ParseStringAfterChar(option, after_char, &substring)) {
867    return false;
868  }
869  bool sane_val = true;
870  double value;
871  if (false) {
872    // TODO: this doesn't seem to work on the emulator.  b/15114595
873    std::stringstream iss(substring);
874    iss >> value;
875    // Ensure that we have a value, there was no cruft after it and it satisfies a sensible range.
876    sane_val = iss.eof() && (value >= min) && (value <= max);
877  } else {
878    char* end = nullptr;
879    value = strtod(substring.c_str(), &end);
880    sane_val = *end == '\0' && value >= min && value <= max;
881  }
882  if (!sane_val) {
883    Usage("Invalid double value %s for option %s\n", substring.c_str(), option.c_str());
884    return false;
885  }
886  *parsed_value = value;
887  return true;
888}
889
890}  // namespace art
891