1 /*
2  * Copyright (C) 2015 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 "compiler_options.h"
18 
19 #include <fstream>
20 
21 namespace art {
22 
CompilerOptions()23 CompilerOptions::CompilerOptions()
24     : compiler_filter_(kDefaultCompilerFilter),
25       huge_method_threshold_(kDefaultHugeMethodThreshold),
26       large_method_threshold_(kDefaultLargeMethodThreshold),
27       small_method_threshold_(kDefaultSmallMethodThreshold),
28       tiny_method_threshold_(kDefaultTinyMethodThreshold),
29       num_dex_methods_threshold_(kDefaultNumDexMethodsThreshold),
30       inline_depth_limit_(kUnsetInlineDepthLimit),
31       inline_max_code_units_(kUnsetInlineMaxCodeUnits),
32       no_inline_from_(nullptr),
33       include_patch_information_(kDefaultIncludePatchInformation),
34       top_k_profile_threshold_(kDefaultTopKProfileThreshold),
35       debuggable_(false),
36       generate_debug_info_(kDefaultGenerateDebugInfo),
37       generate_mini_debug_info_(kDefaultGenerateMiniDebugInfo),
38       implicit_null_checks_(true),
39       implicit_so_checks_(true),
40       implicit_suspend_checks_(false),
41       compile_pic_(false),
42       verbose_methods_(nullptr),
43       abort_on_hard_verifier_failure_(false),
44       init_failure_output_(nullptr),
45       dump_cfg_file_name_(""),
46       dump_cfg_append_(false),
47       force_determinism_(false) {
48 }
49 
~CompilerOptions()50 CompilerOptions::~CompilerOptions() {
51   // The destructor looks empty but it destroys a PassManagerOptions object. We keep it here
52   // because we don't want to include the PassManagerOptions definition from the header file.
53 }
54 
CompilerOptions(CompilerFilter::Filter 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,size_t inline_depth_limit,size_t inline_max_code_units,const std::vector<const DexFile * > * no_inline_from,bool include_patch_information,double top_k_profile_threshold,bool debuggable,bool generate_debug_info,bool implicit_null_checks,bool implicit_so_checks,bool implicit_suspend_checks,bool compile_pic,const std::vector<std::string> * verbose_methods,std::ostream * init_failure_output,bool abort_on_hard_verifier_failure,const std::string & dump_cfg_file_name,bool dump_cfg_append,bool force_determinism)55 CompilerOptions::CompilerOptions(CompilerFilter::Filter compiler_filter,
56                                  size_t huge_method_threshold,
57                                  size_t large_method_threshold,
58                                  size_t small_method_threshold,
59                                  size_t tiny_method_threshold,
60                                  size_t num_dex_methods_threshold,
61                                  size_t inline_depth_limit,
62                                  size_t inline_max_code_units,
63                                  const std::vector<const DexFile*>* no_inline_from,
64                                  bool include_patch_information,
65                                  double top_k_profile_threshold,
66                                  bool debuggable,
67                                  bool generate_debug_info,
68                                  bool implicit_null_checks,
69                                  bool implicit_so_checks,
70                                  bool implicit_suspend_checks,
71                                  bool compile_pic,
72                                  const std::vector<std::string>* verbose_methods,
73                                  std::ostream* init_failure_output,
74                                  bool abort_on_hard_verifier_failure,
75                                  const std::string& dump_cfg_file_name,
76                                  bool dump_cfg_append,
77                                  bool force_determinism
78                                  ) :  // NOLINT(whitespace/parens)
79     compiler_filter_(compiler_filter),
80     huge_method_threshold_(huge_method_threshold),
81     large_method_threshold_(large_method_threshold),
82     small_method_threshold_(small_method_threshold),
83     tiny_method_threshold_(tiny_method_threshold),
84     num_dex_methods_threshold_(num_dex_methods_threshold),
85     inline_depth_limit_(inline_depth_limit),
86     inline_max_code_units_(inline_max_code_units),
87     no_inline_from_(no_inline_from),
88     include_patch_information_(include_patch_information),
89     top_k_profile_threshold_(top_k_profile_threshold),
90     debuggable_(debuggable),
91     generate_debug_info_(generate_debug_info),
92     generate_mini_debug_info_(kDefaultGenerateMiniDebugInfo),
93     implicit_null_checks_(implicit_null_checks),
94     implicit_so_checks_(implicit_so_checks),
95     implicit_suspend_checks_(implicit_suspend_checks),
96     compile_pic_(compile_pic),
97     verbose_methods_(verbose_methods),
98     abort_on_hard_verifier_failure_(abort_on_hard_verifier_failure),
99     init_failure_output_(init_failure_output),
100     dump_cfg_file_name_(dump_cfg_file_name),
101     dump_cfg_append_(dump_cfg_append),
102     force_determinism_(force_determinism) {
103 }
104 
ParseHugeMethodMax(const StringPiece & option,UsageFn Usage)105 void CompilerOptions::ParseHugeMethodMax(const StringPiece& option, UsageFn Usage) {
106   ParseUintOption(option, "--huge-method-max", &huge_method_threshold_, Usage);
107 }
108 
ParseLargeMethodMax(const StringPiece & option,UsageFn Usage)109 void CompilerOptions::ParseLargeMethodMax(const StringPiece& option, UsageFn Usage) {
110   ParseUintOption(option, "--large-method-max", &large_method_threshold_, Usage);
111 }
112 
ParseSmallMethodMax(const StringPiece & option,UsageFn Usage)113 void CompilerOptions::ParseSmallMethodMax(const StringPiece& option, UsageFn Usage) {
114   ParseUintOption(option, "--small-method-max", &small_method_threshold_, Usage);
115 }
116 
ParseTinyMethodMax(const StringPiece & option,UsageFn Usage)117 void CompilerOptions::ParseTinyMethodMax(const StringPiece& option, UsageFn Usage) {
118   ParseUintOption(option, "--tiny-method-max", &tiny_method_threshold_, Usage);
119 }
120 
ParseNumDexMethods(const StringPiece & option,UsageFn Usage)121 void CompilerOptions::ParseNumDexMethods(const StringPiece& option, UsageFn Usage) {
122   ParseUintOption(option, "--num-dex-methods", &num_dex_methods_threshold_, Usage);
123 }
124 
ParseInlineDepthLimit(const StringPiece & option,UsageFn Usage)125 void CompilerOptions::ParseInlineDepthLimit(const StringPiece& option, UsageFn Usage) {
126   ParseUintOption(option, "--inline-depth-limit", &inline_depth_limit_, Usage);
127 }
128 
ParseInlineMaxCodeUnits(const StringPiece & option,UsageFn Usage)129 void CompilerOptions::ParseInlineMaxCodeUnits(const StringPiece& option, UsageFn Usage) {
130   ParseUintOption(option, "--inline-max-code-units", &inline_max_code_units_, Usage);
131 }
132 
ParseDumpInitFailures(const StringPiece & option,UsageFn Usage ATTRIBUTE_UNUSED)133 void CompilerOptions::ParseDumpInitFailures(const StringPiece& option,
134                                             UsageFn Usage ATTRIBUTE_UNUSED) {
135   DCHECK(option.starts_with("--dump-init-failures="));
136   std::string file_name = option.substr(strlen("--dump-init-failures=")).data();
137   init_failure_output_.reset(new std::ofstream(file_name));
138   if (init_failure_output_.get() == nullptr) {
139     LOG(ERROR) << "Failed to allocate ofstream";
140   } else if (init_failure_output_->fail()) {
141     LOG(ERROR) << "Failed to open " << file_name << " for writing the initialization "
142                << "failures.";
143     init_failure_output_.reset();
144   }
145 }
146 
ParseCompilerOption(const StringPiece & option,UsageFn Usage)147 bool CompilerOptions::ParseCompilerOption(const StringPiece& option, UsageFn Usage) {
148   if (option.starts_with("--compiler-filter=")) {
149     const char* compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
150     if (!CompilerFilter::ParseCompilerFilter(compiler_filter_string, &compiler_filter_)) {
151       Usage("Unknown --compiler-filter value %s", compiler_filter_string);
152     }
153   } else if (option == "--compile-pic") {
154     compile_pic_ = true;
155   } else if (option.starts_with("--huge-method-max=")) {
156     ParseHugeMethodMax(option, Usage);
157   } else if (option.starts_with("--large-method-max=")) {
158     ParseLargeMethodMax(option, Usage);
159   } else if (option.starts_with("--small-method-max=")) {
160     ParseSmallMethodMax(option, Usage);
161   } else if (option.starts_with("--tiny-method-max=")) {
162     ParseTinyMethodMax(option, Usage);
163   } else if (option.starts_with("--num-dex-methods=")) {
164     ParseNumDexMethods(option, Usage);
165   } else if (option.starts_with("--inline-depth-limit=")) {
166     ParseInlineDepthLimit(option, Usage);
167   } else if (option.starts_with("--inline-max-code-units=")) {
168     ParseInlineMaxCodeUnits(option, Usage);
169   } else if (option == "--generate-debug-info" || option == "-g") {
170     generate_debug_info_ = true;
171   } else if (option == "--no-generate-debug-info") {
172     generate_debug_info_ = false;
173   } else if (option == "--generate-mini-debug-info") {
174     generate_mini_debug_info_ = true;
175   } else if (option == "--no-generate-mini-debug-info") {
176     generate_mini_debug_info_ = false;
177   } else if (option == "--debuggable") {
178     debuggable_ = true;
179   } else if (option.starts_with("--top-k-profile-threshold=")) {
180     ParseDouble(option.data(), '=', 0.0, 100.0, &top_k_profile_threshold_, Usage);
181   } else if (option == "--include-patch-information") {
182     include_patch_information_ = true;
183   } else if (option == "--no-include-patch-information") {
184     include_patch_information_ = false;
185   } else if (option == "--abort-on-hard-verifier-error") {
186     abort_on_hard_verifier_failure_ = true;
187   } else if (option.starts_with("--dump-init-failures=")) {
188     ParseDumpInitFailures(option, Usage);
189   } else if (option.starts_with("--dump-cfg=")) {
190     dump_cfg_file_name_ = option.substr(strlen("--dump-cfg=")).data();
191   } else if (option.starts_with("--dump-cfg-append")) {
192     dump_cfg_append_ = true;
193   } else {
194     // Option not recognized.
195     return false;
196   }
197   return true;
198 }
199 
200 }  // namespace art
201