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