Quelle  compiler_options_map-inl.h

/*
 * Copyright (C) 2017 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ART_COMPILER_DRIVER_COMPILER_OPTIONS_MAP_INL_H_
#define ART_COMPILER_DRIVER_COMPILER_OPTIONS_MAP_INL_H_

#include "compiler_options_map.h"

#include <memory>

#include "android-base/logging.h"
#include "android-base/macros.h"
#include "android-base/stringprintf.h"
#include "assume_value_options.h"
#include "assume_value_signatures.h"
#include "base/macros.h"
#include "cmdline_parser.h"
#include "com_android_art_rw_flags.h"
#include "compiler_options.h"

using ::android::base::GetBoolProperty;

namespace art HIDDEN {

template <>
struct CmdlineType<AssumeValueOptions> : CmdlineTypeParser<AssumeValueOptions> {
  Result Parse(const std::string& args) {
    assert(false && "Use AppendValues() for an AssumeValueOptions type");
    return Result::Failure("Unconditional failure: AssumeValueOptions must be appended: " + args);
  }

  Result ParseAndAppend(const std::string& args, AssumeValueOptions& assume_value_options) {
    std::vector<std::string> args_parts;
    Split(args, ':', &args_parts);
    if (args_parts.size() != 2) {
      return Result::Failure(std::string("Invalid --assume-value option: '") + args + "'");
    }

    static constexpr std::string_view kMemberDelimiter("->");
    std::string_view signature(args_parts[0]);
    size_t delimiter_pos = signature.find(kMemberDelimiter);
    if (delimiter_pos == std::string::npos) {
      return Result::Failure(std::string("Invalid --assume-value signature: '") + args + "'");
    }
    std::string_view class_descriptor = signature.substr(0, delimiter_pos);
    std::string_view member_name = signature.substr(delimiter_pos + kMemberDelimiter.size());

    // TODO(b/204924812): Make this generic on the predefined and/or provided type.
    const auto parsed_value = ParseNumeric<uint32_t>(args_parts[1]);
    if (!parsed_value.IsSuccess()) {
      return Result::Failure(std::string("Invalid --assume-value value: '") + args + "'");
    }

    auto known_signature = AssumeValueSignatures::Lookup(class_descriptor, member_name);
    if (known_signature == AssumeValueSignatures::kSdkInt) {
      assume_value_options.SetSdkInt(parsed_value.GetValue());
      return Result::SuccessNoValue();
    }

    // Note that we treat unhandled assumed value members as benign, as the optimization is
    // strictly best-effort and shouldn't break compilation.
    LOG(WARNING) << "Unhandled --assume-value member: " << args;
    return Result::SuccessNoValue();
  }

  static const char* Name() { return "AssumeValueOptions"; }
  static const char* DescribeType() { return "Lfoo/bar/Baz;->field:value"; }
};

template <>
struct CmdlineType<CompilerFilter::Filter> : CmdlineTypeParser<CompilerFilter::Filter> {
  Result Parse(const std::string& option) {
    CompilerFilter::Filter compiler_filter;
    if (!CompilerFilter::ParseCompilerFilter(option.c_str(), &compiler_filter)) {
      return Result::Failure(
          android::base::StringPrintf("Unknown --compiler-filter value %s", option.c_str()));
    }
    return Result::Success(compiler_filter);
  }

  static const char* Name() {
    return "CompilerFilter";
  }
  static const char* DescribeType() {
    return CompilerFilter::DescribeOptions();
  }
};

template <class Base>
inline bool ReadCompilerOptions(Base& map, CompilerOptions* options, std::string* error_msg) {
  if (map.Exists(Base::CompilerFilter)) {
    options->SetCompilerFilter(*map.Get(Base::CompilerFilter));
  }
  map.AssignIfExists(Base::CompileArtTest, &options->compile_art_test_);
  map.AssignIfExists(Base::HugeMethodMaxThreshold, &options->huge_method_threshold_);
  map.AssignIfExists(Base::InlineMaxCodeUnitsThreshold, &options->inline_max_code_units_);
  map.AssignIfExists(Base::InlineMaximumNumberOfTotalInstructions,
                     &options->inline_max_total_instructions_);
  map.AssignIfExists(Base::InlineMaxInstructionsForSmallMethod,
                     &options->inline_max_instructions_for_small_method_);
  map.AssignIfExists(Base::InlineMaxCumulatedDexRegisters,
                     &options->inline_max_cumulated_dex_registers_);
  map.AssignIfExists(Base::InlineMaxRecursiveCalls, &options->inline_max_recursive_calls_);
  map.AssignIfExists(Base::GenerateDebugInfo, &options->generate_debug_info_);
  map.AssignIfExists(Base::GenerateMiniDebugInfo, &options->generate_mini_debug_info_);
  map.AssignIfExists(Base::GenerateBuildID, &options->generate_build_id_);
  if (map.Exists(Base::Debuggable)) {
    options->debuggable_ = true;
  }
  if (map.Exists(Base::Baseline)) {
    options->baseline_ = true;
  }
  if (map.Exists(Base::Fast)) {
    options->fast_ = true;
  }
  if (map.Exists(Base::ProfileBranches)) {
    options->profile_branches_ = true;
  }
  map.AssignIfExists(Base::AbortOnHardVerifierFailure, &options->abort_on_hard_verifier_failure_);
  map.AssignIfExists(Base::AbortOnSoftVerifierFailure, &options->abort_on_soft_verifier_failure_);
  if (map.Exists(Base::DumpInitFailures)) {
    if (!options->ParseDumpInitFailures(*map.Get(Base::DumpInitFailures), error_msg)) {
      return false;
    }
  }
  map.AssignIfExists(Base::DumpCFG, &options->dump_cfg_file_name_);
  if (map.Exists(Base::DumpCFGAppend)) {
    options->dump_cfg_append_ = true;
  }
  map.AssignIfExists(Base::VerboseMethods, &options->verbose_methods_);
  options->deduplicate_code_ = map.GetOrDefault(Base::DeduplicateCode);
  if (map.Exists(Base::CountHotnessInCompiledCode)) {
    options->count_hotness_in_compiled_code_ = true;
  }
  map.AssignIfExists(Base::ResolveStartupConstStrings, &options->resolve_startup_const_strings_);
  map.AssignIfExists(Base::InitializeAppImageClasses, &options->initialize_app_image_classes_);
  if (map.Exists(Base::CheckProfiledMethods)) {
    options->check_profiled_methods_ = *map.Get(Base::CheckProfiledMethods);
  }
  map.AssignIfExists(Base::MaxImageBlockSize, &options->max_image_block_size_);

  if (map.Exists(Base::DumpTimings)) {
    options->dump_timings_ = true;
  }

  if (map.Exists(Base::DumpPassTimings)) {
    options->dump_pass_timings_ = true;
  }

  if (map.Exists(Base::DumpStats)) {
    options->dump_stats_ = true;
  }

  map.AssignIfExists(Base::AssumeValueOpts, &options->assume_value_options_);

  // If the option isn't explicitly set, use the system property. Mostly used for tests.
  // Other uses are expected to set the required value.
  bool build_enabled = map.Exists(Base::AllowProfileCode)
      ? *map.Get(Base::AllowProfileCode)
      : GetBoolProperty("dalvik.vm.allow_profile_code", false);
  options->enable_profile_code_ =
      com::android::art::rw::flags::enable_profile_code_rw() && build_enabled;

  return true;
}

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wframe-larger-than="

template <typename Map, typename Builder>
NO_INLINE void AddCompilerOptionsArgumentParserOptions(Builder& b) {
  // clang-format off
  b.
      Define("--compiler-filter=_")
          .template WithType<CompilerFilter::Filter>()
          .WithHelp("Select compiler filter\n"
                    "Default: speed-profile if profile provided, speed otherwise")
          .IntoKey(Map::CompilerFilter)

      .Define({"--compile-art-test", "--no-compile-art-test"})
          .WithValues({true, false})
          .IntoKey(Map::CompileArtTest)
      .Define("--huge-method-max=_")
          .template WithType<unsigned int>()
          .WithHelp("threshold size for a huge method for compiler filter tuning.")
          .IntoKey(Map::HugeMethodMaxThreshold)
      .Define("--inline-max-code-units=_")
          .template WithType<unsigned int>()
          .WithHelp("the maximum code units that a methodcan have to be considered for inlining.\n"
                    "A zero value will disable inlining. Honored only by Optimizing. Has priority\n"
                    "over the --compiler-filter option. Intended for development/experimental use.")
          .IntoKey(Map::InlineMaxCodeUnitsThreshold)
      .Define("--inline-max-total-instructions=_")
          .template WithType<unsigned int>()
          .WithHelp("the maximum number of total instructions that a method can have to be\n"
                    "considered for inlining.")
          .IntoKey(Map::InlineMaximumNumberOfTotalInstructions)
      .Define("--inline-max-instructions-for-small-method=_")
          .template WithType<unsigned int>()
          .WithHelp("the maximum number of instructions that a method can have to be considered\n"
                    "a small method for inlining.")
          .IntoKey(Map::InlineMaxInstructionsForSmallMethod)
      .Define("--inline-max-cumulated-dex-registers=_")
          .template WithType<unsigned int>()
          .WithHelp("the maximum number of dex registers that a method can accumulate by inlining.")
          .IntoKey(Map::InlineMaxCumulatedDexRegisters)
      .Define("--inline-max-recursive-calls=_")
          .template WithType<unsigned int>()
          .WithHelp("the maximum number of recursive calls that can be inlined.")
          .IntoKey(Map::InlineMaxRecursiveCalls)

      .Define({"--generate-debug-info", "-g", "--no-generate-debug-info"})
          .WithValues({true, true, false})
          .WithHelp("Generate (or don't generate) debug information for native debugging, such as\n"
                    "stack unwinding information, ELF symbols and dwarf sections. If used without\n"
                    "--debuggable it will be best effort only. Does not affect the generated\n"
                    "code. Disabled by default.")
          .IntoKey(Map::GenerateDebugInfo)
      .Define({"--generate-mini-debug-info", "--no-generate-mini-debug-info"})
          .WithValues({true, false})
          .WithHelp("Whether or not to generate minimal amount of LZMA-compressed debug\n"
                    "information necessary to print backtraces (disabled by default).")
          .IntoKey(Map::GenerateMiniDebugInfo)

      .Define({"--generate-build-id", "--no-generate-build-id"})
          .WithValues({true, false})
          .WithHelp("Generate GNU-compatible linker build ID ELF section with SHA-1 of the file\n"
                    "content (and thus stable across identical builds)")
          .IntoKey(Map::GenerateBuildID)

      .Define({"--deduplicate-code=_"})
          .template WithType<bool>()
          .WithValueMap({{"false", false}, {"true", true}})
          .WithHelp("enable|disable code deduplication. Deduplicated code will have an arbitrary\n"
                    "symbol tagged with [DEDUPED].")
          .IntoKey(Map::DeduplicateCode)

      .Define({"--count-hotness-in-compiled-code"})
          .IntoKey(Map::CountHotnessInCompiledCode)

      .Define({"--check-profiled-methods=_"})
          .template WithType<ProfileMethodsCheck>()
          .WithValueMap({{"log", ProfileMethodsCheck::kLog},
                         {"abort", ProfileMethodsCheck::kAbort}})
          .IntoKey(Map::CheckProfiledMethods)

      .Define({"--dump-timings"})
          .WithHelp("Display a breakdown of where time was spent.")
          .IntoKey(Map::DumpTimings)

      .Define({"--dump-pass-timings"})
          .WithHelp("Display a breakdown time spent in optimization passes for each compiled"
                    " method.")
          .IntoKey(Map::DumpPassTimings)

      .Define({"--dump-stats"})
          .WithHelp("Display overall compilation statistics.")
          .IntoKey(Map::DumpStats)

      .Define("--debuggable")
          .WithHelp("Produce code debuggable with a java-debugger.")
          .IntoKey(Map::Debuggable)

      .Define("--baseline")
          .WithHelp("Produce code using the baseline compiler")
          .IntoKey(Map::Baseline)

      .Define("--fast")
          .WithHelp("Produce code using the fast compiler. ONLY FOR TESTING.")
          .IntoKey(Map::Fast)

      .Define("--profile-branches")
          .WithHelp("Profile branches in baseline generated code")
          .IntoKey(Map::ProfileBranches)

      .Define({"--abort-on-hard-verifier-error", "--no-abort-on-hard-verifier-error"})
          .WithValues({true, false})
          .IntoKey(Map::AbortOnHardVerifierFailure)
      .Define({"--abort-on-soft-verifier-error", "--no-abort-on-soft-verifier-error"})
          .WithValues({true, false})
          .IntoKey(Map::AbortOnSoftVerifierFailure)

      .Define("--dump-init-failures=_")
          .template WithType<std::string>()
          .IntoKey(Map::DumpInitFailures)

      .Define("--dump-cfg=_")
          .template WithType<std::string>()
          .WithHelp("Dump control-flow graphs (CFGs) to specified file.")
          .IntoKey(Map::DumpCFG)
      .Define("--dump-cfg-append")
          .WithHelp("when dumping CFGs to an existing file, append new CFG data to existing data\n"
                    "(instead of overwriting existing data with new data, which is the default\n"
                    "behavior). This option is only meaningful when used with --dump-cfg.")
          .IntoKey(Map::DumpCFGAppend)

      .Define("--resolve-startup-const-strings=_")
          .template WithType<bool>()
          .WithValueMap({{"false", false}, {"true", true}})
          .WithHelp("If true, the compiler eagerly resolves strings referenced from const-string\n"
                    "of startup methods.")
          .IntoKey(Map::ResolveStartupConstStrings)

      .Define("--initialize-app-image-classes=_")
          .template WithType<bool>()
          .WithValueMap({{"false", false}, {"true", true}})
          .IntoKey(Map::InitializeAppImageClasses)

      .Define("--verbose-methods=_")
          .template WithType<ParseStringList<','>>()
          .WithHelp("Restrict the dumped CFG data to methods whose name is listed.\n"
                    "Eg: --verbose-methods=toString,hashCode")
          .IntoKey(Map::VerboseMethods)

      .Define("--max-image-block-size=_")
          .template WithType<unsigned int>()
          .WithHelp("Maximum solid block size for compressed images.")
          .IntoKey(Map::MaxImageBlockSize)

      .Define("--assume-value=_")
          .template WithType<AssumeValueOptions>()
          .AppendValues()
          .WithHelp("Optional assumed value for compiling a given field.\n"
                    "E.g.: --assume-value=Landroid/os/Build$VERSION;->SDK_INT:23")
          .IntoKey(Map::AssumeValueOpts)

      .Define({"--allow-profile-code", "--no-allow-profile-code"})
          .WithHelp("Generate code for supporting low overhead tracing")
          .WithValues({true, false})
          .IntoKey(Map::AllowProfileCode)

      // Obsolete flags
      .Ignore({
        "--num-dex-methods=_",
        "--top-k-profile-threshold=_",
        "--large-method-max=_",
        "--register-allocation-strategy=_"
      });
  // clang-format on
}

#pragma GCC diagnostic pop

}  // namespace art

#endif  // ART_COMPILER_DRIVER_COMPILER_OPTIONS_MAP_INL_H_