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