compiler_options.h revision 0cf4493166ff28518c8eafa2d0463f6e817cce75 
1/*
2 * Copyright (C) 2014 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#ifndef ART_COMPILER_DRIVER_COMPILER_OPTIONS_H_
18#define ART_COMPILER_DRIVER_COMPILER_OPTIONS_H_
19
20#include <ostream>
21#include <string>
22#include <vector>
23
24#include "base/macros.h"
25#include "dex/pass_manager.h"
26#include "globals.h"
27#include "utils.h"
28
29namespace art {
30
31class CompilerOptions FINAL {
32 public:
33  enum CompilerFilter {
34    kVerifyNone,          // Skip verification and compile nothing except JNI stubs.
35    kInterpretOnly,       // Verify, and compile only JNI stubs.
36    kVerifyAtRuntime,     // Only compile JNI stubs and verify at runtime.
37    kSpace,               // Maximize space savings.
38    kBalanced,            // Try to get the best performance return on compilation investment.
39    kSpeed,               // Maximize runtime performance.
40    kEverything,          // Force compilation of everything capable of being compiled.
41    kTime,                // Compile methods, but minimize compilation time.
42  };
43
44  // Guide heuristics to determine whether to compile method if profile data not available.
45  static const CompilerFilter kDefaultCompilerFilter = kSpeed;
46  static const size_t kDefaultHugeMethodThreshold = 10000;
47  static const size_t kDefaultLargeMethodThreshold = 600;
48  static const size_t kDefaultSmallMethodThreshold = 60;
49  static const size_t kDefaultTinyMethodThreshold = 20;
50  static const size_t kDefaultNumDexMethodsThreshold = 900;
51  static constexpr double kDefaultTopKProfileThreshold = 90.0;
52  static const bool kDefaultNativeDebuggable = false;
53  static const bool kDefaultGenerateDebugInfo = kIsDebugBuild;
54  static const bool kDefaultIncludePatchInformation = false;
55  static const size_t kDefaultInlineDepthLimit = 3;
56  static const size_t kDefaultInlineMaxCodeUnits = 20;
57  static constexpr size_t kUnsetInlineDepthLimit = -1;
58  static constexpr size_t kUnsetInlineMaxCodeUnits = -1;
59
60  // Default inlining settings when the space filter is used.
61  static constexpr size_t kSpaceFilterInlineDepthLimit = 3;
62  static constexpr size_t kSpaceFilterInlineMaxCodeUnits = 10;
63
64  CompilerOptions();
65  ~CompilerOptions();
66
67  CompilerOptions(CompilerFilter compiler_filter,
68                  size_t huge_method_threshold,
69                  size_t large_method_threshold,
70                  size_t small_method_threshold,
71                  size_t tiny_method_threshold,
72                  size_t num_dex_methods_threshold,
73                  size_t inline_depth_limit,
74                  size_t inline_max_code_units,
75                  bool include_patch_information,
76                  double top_k_profile_threshold,
77                  bool debuggable,
78                  bool generate_debug_info,
79                  bool implicit_null_checks,
80                  bool implicit_so_checks,
81                  bool implicit_suspend_checks,
82                  bool compile_pic,
83                  const std::vector<std::string>* verbose_methods,
84                  std::ostream* init_failure_output,
85                  bool abort_on_hard_verifier_failure);
86
87  CompilerFilter GetCompilerFilter() const {
88    return compiler_filter_;
89  }
90
91  void SetCompilerFilter(CompilerFilter compiler_filter) {
92    compiler_filter_ = compiler_filter;
93  }
94
95  bool VerifyAtRuntime() const {
96    return compiler_filter_ == CompilerOptions::kVerifyAtRuntime;
97  }
98
99  bool IsCompilationEnabled() const {
100    return compiler_filter_ != CompilerOptions::kVerifyNone &&
101        compiler_filter_ != CompilerOptions::kInterpretOnly &&
102        compiler_filter_ != CompilerOptions::kVerifyAtRuntime;
103  }
104
105  bool IsVerificationEnabled() const {
106    return compiler_filter_ != CompilerOptions::kVerifyNone &&
107        compiler_filter_ != CompilerOptions::kVerifyAtRuntime;
108  }
109
110  bool NeverVerify() const {
111    return compiler_filter_ == CompilerOptions::kVerifyNone;
112  }
113
114  size_t GetHugeMethodThreshold() const {
115    return huge_method_threshold_;
116  }
117
118  size_t GetLargeMethodThreshold() const {
119    return large_method_threshold_;
120  }
121
122  size_t GetSmallMethodThreshold() const {
123    return small_method_threshold_;
124  }
125
126  size_t GetTinyMethodThreshold() const {
127    return tiny_method_threshold_;
128  }
129
130  bool IsHugeMethod(size_t num_dalvik_instructions) const {
131    return num_dalvik_instructions > huge_method_threshold_;
132  }
133
134  bool IsLargeMethod(size_t num_dalvik_instructions) const {
135    return num_dalvik_instructions > large_method_threshold_;
136  }
137
138  bool IsSmallMethod(size_t num_dalvik_instructions) const {
139    return num_dalvik_instructions > small_method_threshold_;
140  }
141
142  bool IsTinyMethod(size_t num_dalvik_instructions) const {
143    return num_dalvik_instructions > tiny_method_threshold_;
144  }
145
146  size_t GetNumDexMethodsThreshold() const {
147    return num_dex_methods_threshold_;
148  }
149
150  size_t GetInlineDepthLimit() const {
151    return inline_depth_limit_;
152  }
153
154  size_t GetInlineMaxCodeUnits() const {
155    return inline_max_code_units_;
156  }
157
158  double GetTopKProfileThreshold() const {
159    return top_k_profile_threshold_;
160  }
161
162  bool GetDebuggable() const {
163    return debuggable_;
164  }
165
166  bool GetNativeDebuggable() const {
167    return native_debuggable_;
168  }
169
170  bool GetGenerateDebugInfo() const {
171    return generate_debug_info_;
172  }
173
174  bool GetImplicitNullChecks() const {
175    return implicit_null_checks_;
176  }
177
178  bool GetImplicitStackOverflowChecks() const {
179    return implicit_so_checks_;
180  }
181
182  bool GetImplicitSuspendChecks() const {
183    return implicit_suspend_checks_;
184  }
185
186  bool GetIncludePatchInformation() const {
187    return include_patch_information_;
188  }
189
190  // Should the code be compiled as position independent?
191  bool GetCompilePic() const {
192    return compile_pic_;
193  }
194
195  bool HasVerboseMethods() const {
196    return verbose_methods_ != nullptr && !verbose_methods_->empty();
197  }
198
199  bool IsVerboseMethod(const std::string& pretty_method) const {
200    for (const std::string& cur_method : *verbose_methods_) {
201      if (pretty_method.find(cur_method) != std::string::npos) {
202        return true;
203      }
204    }
205    return false;
206  }
207
208  std::ostream* GetInitFailureOutput() const {
209    return init_failure_output_.get();
210  }
211
212  const PassManagerOptions* GetPassManagerOptions() const {
213    return &pass_manager_options_;
214  }
215
216  bool AbortOnHardVerifierFailure() const {
217    return abort_on_hard_verifier_failure_;
218  }
219
220  bool ParseCompilerOption(const StringPiece& option, UsageFn Usage);
221
222 private:
223  void ParseDumpInitFailures(const StringPiece& option, UsageFn Usage);
224  void ParsePassOptions(const StringPiece& option, UsageFn Usage);
225  void ParseDumpCfgPasses(const StringPiece& option, UsageFn Usage);
226  void ParsePrintPasses(const StringPiece& option, UsageFn Usage);
227  void ParseDisablePasses(const StringPiece& option, UsageFn Usage);
228  void ParseInlineMaxCodeUnits(const StringPiece& option, UsageFn Usage);
229  void ParseInlineDepthLimit(const StringPiece& option, UsageFn Usage);
230  void ParseNumDexMethods(const StringPiece& option, UsageFn Usage);
231  void ParseTinyMethodMax(const StringPiece& option, UsageFn Usage);
232  void ParseSmallMethodMax(const StringPiece& option, UsageFn Usage);
233  void ParseLargeMethodMax(const StringPiece& option, UsageFn Usage);
234  void ParseHugeMethodMax(const StringPiece& option, UsageFn Usage);
235
236  CompilerFilter compiler_filter_;
237  size_t huge_method_threshold_;
238  size_t large_method_threshold_;
239  size_t small_method_threshold_;
240  size_t tiny_method_threshold_;
241  size_t num_dex_methods_threshold_;
242  size_t inline_depth_limit_;
243  size_t inline_max_code_units_;
244  bool include_patch_information_;
245  // When using a profile file only the top K% of the profiled samples will be compiled.
246  double top_k_profile_threshold_;
247  bool debuggable_;
248  bool native_debuggable_;
249  bool generate_debug_info_;
250  bool implicit_null_checks_;
251  bool implicit_so_checks_;
252  bool implicit_suspend_checks_;
253  bool compile_pic_;
254
255  // Vector of methods to have verbose output enabled for.
256  const std::vector<std::string>* verbose_methods_;
257
258  PassManagerOptions pass_manager_options_;
259
260  // Abort compilation with an error if we find a class that fails verification with a hard
261  // failure.
262  bool abort_on_hard_verifier_failure_;
263
264  // Log initialization of initialization failures to this stream if not null.
265  std::unique_ptr<std::ostream> init_failure_output_;
266
267  friend class Dex2Oat;
268
269  DISALLOW_COPY_AND_ASSIGN(CompilerOptions);
270};
271std::ostream& operator<<(std::ostream& os, const CompilerOptions::CompilerFilter& rhs);
272
273}  // namespace art
274
275#endif  // ART_COMPILER_DRIVER_COMPILER_OPTIONS_H_
276