blob: bf3f8ec08a346a745d18a508ee118028282cd82a [file] [log] [blame]
* Copyright (C) 2014 The Android Open Source Project
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <ostream>
#include <string>
#include <vector>
#include "base/macros.h"
#include "globals.h"
namespace art {
class PassManagerOptions;
class CompilerOptions FINAL {
enum CompilerFilter {
kVerifyNone, // Skip verification and compile nothing except JNI stubs.
kInterpretOnly, // Verify, and compile only JNI stubs.
kVerifyAtRuntime, // Only compile JNI stubs and verify at runtime.
kSpace, // Maximize space savings.
kBalanced, // Try to get the best performance return on compilation investment.
kSpeed, // Maximize runtime performance.
kEverything, // Force compilation (Note: excludes compilation of class initializers).
kTime, // Compile methods, but minimize compilation time.
// Guide heuristics to determine whether to compile method if profile data not available.
static const CompilerFilter kDefaultCompilerFilter = kSpeed;
static const size_t kDefaultHugeMethodThreshold = 10000;
static const size_t kDefaultLargeMethodThreshold = 600;
static const size_t kDefaultSmallMethodThreshold = 60;
static const size_t kDefaultTinyMethodThreshold = 20;
static const size_t kDefaultNumDexMethodsThreshold = 900;
static constexpr double kDefaultTopKProfileThreshold = 90.0;
static const bool kDefaultIncludeDebugSymbols = kIsDebugBuild;
static const bool kDefaultIncludePatchInformation = false;
CompilerOptions(CompilerFilter compiler_filter,
size_t huge_method_threshold,
size_t large_method_threshold,
size_t small_method_threshold,
size_t tiny_method_threshold,
size_t num_dex_methods_threshold,
bool include_patch_information,
double top_k_profile_threshold,
bool debuggable,
bool include_debug_symbols,
bool include_cfi,
bool implicit_null_checks,
bool implicit_so_checks,
bool implicit_suspend_checks,
bool compile_pic,
const std::vector<std::string>* verbose_methods,
PassManagerOptions* pass_manager_options,
std::ostream* init_failure_output,
bool abort_on_hard_verifier_failure);
CompilerFilter GetCompilerFilter() const {
return compiler_filter_;
void SetCompilerFilter(CompilerFilter compiler_filter) {
compiler_filter_ = compiler_filter;
bool VerifyAtRuntime() const {
return compiler_filter_ == CompilerOptions::kVerifyAtRuntime;
bool IsCompilationEnabled() const {
return compiler_filter_ != CompilerOptions::kVerifyNone &&
compiler_filter_ != CompilerOptions::kInterpretOnly &&
compiler_filter_ != CompilerOptions::kVerifyAtRuntime;
bool IsVerificationEnabled() const {
return compiler_filter_ != CompilerOptions::kVerifyNone &&
compiler_filter_ != CompilerOptions::kVerifyAtRuntime;
bool NeverVerify() const {
return compiler_filter_ == CompilerOptions::kVerifyNone;
size_t GetHugeMethodThreshold() const {
return huge_method_threshold_;
size_t GetLargeMethodThreshold() const {
return large_method_threshold_;
size_t GetSmallMethodThreshold() const {
return small_method_threshold_;
size_t GetTinyMethodThreshold() const {
return tiny_method_threshold_;
bool IsHugeMethod(size_t num_dalvik_instructions) const {
return num_dalvik_instructions > huge_method_threshold_;
bool IsLargeMethod(size_t num_dalvik_instructions) const {
return num_dalvik_instructions > large_method_threshold_;
bool IsSmallMethod(size_t num_dalvik_instructions) const {
return num_dalvik_instructions > small_method_threshold_;
bool IsTinyMethod(size_t num_dalvik_instructions) const {
return num_dalvik_instructions > tiny_method_threshold_;
size_t GetNumDexMethodsThreshold() const {
return num_dex_methods_threshold_;
double GetTopKProfileThreshold() const {
return top_k_profile_threshold_;
bool GetDebuggable() const {
return debuggable_;
bool GetIncludeDebugSymbols() const {
return include_debug_symbols_;
bool GetIncludeCFI() const {
// include-debug-symbols implies include-cfi.
return include_cfi_ || include_debug_symbols_;
bool GetImplicitNullChecks() const {
return implicit_null_checks_;
bool GetImplicitStackOverflowChecks() const {
return implicit_so_checks_;
bool GetImplicitSuspendChecks() const {
return implicit_suspend_checks_;
bool GetIncludePatchInformation() const {
return include_patch_information_;
// Should the code be compiled as position independent?
bool GetCompilePic() const {
return compile_pic_;
bool HasVerboseMethods() const {
return verbose_methods_ != nullptr && !verbose_methods_->empty();
bool IsVerboseMethod(const std::string& pretty_method) const {
for (const std::string& cur_method : *verbose_methods_) {
if (pretty_method.find(cur_method) != std::string::npos) {
return true;
return false;
std::ostream* GetInitFailureOutput() const {
return init_failure_output_;
const PassManagerOptions* GetPassManagerOptions() const {
return pass_manager_options_.get();
bool AbortOnHardVerifierFailure() const {
return abort_on_hard_verifier_failure_;
CompilerFilter compiler_filter_;
const size_t huge_method_threshold_;
const size_t large_method_threshold_;
const size_t small_method_threshold_;
const size_t tiny_method_threshold_;
const size_t num_dex_methods_threshold_;
const bool include_patch_information_;
// When using a profile file only the top K% of the profiled samples will be compiled.
const double top_k_profile_threshold_;
const bool debuggable_;
const bool include_debug_symbols_;
const bool include_cfi_;
const bool implicit_null_checks_;
const bool implicit_so_checks_;
const bool implicit_suspend_checks_;
const bool compile_pic_;
// Vector of methods to have verbose output enabled for.
const std::vector<std::string>* const verbose_methods_;
std::unique_ptr<PassManagerOptions> pass_manager_options_;
// Abort compilation with an error if we find a class that fails verification with a hard
// failure.
const bool abort_on_hard_verifier_failure_;
// Log initialization of initialization failures to this stream if not null.
std::ostream* const init_failure_output_;
std::ostream& operator<<(std::ostream& os, const CompilerOptions::CompilerFilter& rhs);
} // namespace art