Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 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_OPTIMIZING_OPTIMIZATION_H_ |
| 18 | #define ART_COMPILER_OPTIMIZING_OPTIMIZATION_H_ |
| 19 | |
Vladimir Marko | a3a3c59 | 2015-06-12 14:30:53 +0100 | [diff] [blame] | 20 | #include "base/arena_object.h" |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 21 | #include "nodes.h" |
Calin Juravle | acf735c | 2015-02-12 15:25:22 +0000 | [diff] [blame] | 22 | #include "optimizing_compiler_stats.h" |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 23 | |
| 24 | namespace art { |
| 25 | |
Aart Bik | 2ca10eb | 2017-11-15 15:17:53 -0800 | [diff] [blame] | 26 | class CodeGenerator; |
| 27 | class CompilerDriver; |
| 28 | class DexCompilationUnit; |
| 29 | |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 30 | /** |
| 31 | * Abstraction to implement an optimization pass. |
| 32 | */ |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 33 | class HOptimization : public ArenaObject<kArenaAllocOptimization> { |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 34 | public: |
| 35 | HOptimization(HGraph* graph, |
Calin Juravle | acf735c | 2015-02-12 15:25:22 +0000 | [diff] [blame] | 36 | const char* pass_name, |
| 37 | OptimizingCompilerStats* stats = nullptr) |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 38 | : graph_(graph), |
Calin Juravle | acf735c | 2015-02-12 15:25:22 +0000 | [diff] [blame] | 39 | stats_(stats), |
Nicolas Geoffray | 5e6916c | 2014-11-18 16:53:35 +0000 | [diff] [blame] | 40 | pass_name_(pass_name) {} |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 41 | |
| 42 | virtual ~HOptimization() {} |
| 43 | |
Wojciech Staszkiewicz | 5319d3c | 2016-08-01 17:48:59 -0700 | [diff] [blame] | 44 | // Return the name of the pass. Pass names for a single HOptimization should be of form |
| 45 | // <optimization_name> or <optimization_name>$<pass_name> for common <optimization_name> prefix. |
| 46 | // Example: 'instruction_simplifier', 'instruction_simplifier$after_bce', |
| 47 | // 'instruction_simplifier$before_codegen'. |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 48 | const char* GetPassName() const { return pass_name_; } |
| 49 | |
Aart Bik | 2477320 | 2018-04-26 10:28:51 -0700 | [diff] [blame] | 50 | // Perform the pass or analysis. Returns false if no optimizations occurred or no useful |
| 51 | // information was computed (this is best effort, returning true is always ok). |
| 52 | virtual bool Run() = 0; |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 53 | |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 54 | protected: |
| 55 | HGraph* const graph_; |
Calin Juravle | acf735c | 2015-02-12 15:25:22 +0000 | [diff] [blame] | 56 | // Used to record stats about the optimization. |
| 57 | OptimizingCompilerStats* const stats_; |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 58 | |
| 59 | private: |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 60 | // Optimization pass name. |
| 61 | const char* pass_name_; |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 62 | |
| 63 | DISALLOW_COPY_AND_ASSIGN(HOptimization); |
| 64 | }; |
| 65 | |
Aart Bik | 2ca10eb | 2017-11-15 15:17:53 -0800 | [diff] [blame] | 66 | // Optimization passes that can be constructed by the helper method below. An enum |
| 67 | // field is preferred over a string lookup at places where performance matters. |
| 68 | // TODO: generate this table and lookup methods below automatically? |
| 69 | enum class OptimizationPass { |
| 70 | kBoundsCheckElimination, |
| 71 | kCHAGuardOptimization, |
| 72 | kCodeSinking, |
| 73 | kConstantFolding, |
| 74 | kConstructorFenceRedundancyElimination, |
| 75 | kDeadCodeElimination, |
| 76 | kGlobalValueNumbering, |
| 77 | kInductionVarAnalysis, |
| 78 | kInliner, |
| 79 | kInstructionSimplifier, |
| 80 | kIntrinsicsRecognizer, |
| 81 | kInvariantCodeMotion, |
| 82 | kLoadStoreAnalysis, |
| 83 | kLoadStoreElimination, |
| 84 | kLoopOptimization, |
| 85 | kScheduling, |
| 86 | kSelectGenerator, |
| 87 | kSharpening, |
| 88 | kSideEffectsAnalysis, |
| 89 | #ifdef ART_ENABLE_CODEGEN_arm |
| 90 | kInstructionSimplifierArm, |
| 91 | #endif |
| 92 | #ifdef ART_ENABLE_CODEGEN_arm64 |
| 93 | kInstructionSimplifierArm64, |
| 94 | #endif |
| 95 | #ifdef ART_ENABLE_CODEGEN_mips |
| 96 | kPcRelativeFixupsMips, |
| 97 | kInstructionSimplifierMips, |
| 98 | #endif |
| 99 | #ifdef ART_ENABLE_CODEGEN_x86 |
| 100 | kPcRelativeFixupsX86, |
| 101 | #endif |
| 102 | #if defined(ART_ENABLE_CODEGEN_x86) || defined(ART_ENABLE_CODEGEN_x86_64) |
| 103 | kX86MemoryOperandGeneration, |
| 104 | #endif |
Aart Bik | 2e14868 | 2018-04-18 16:11:12 -0700 | [diff] [blame] | 105 | kNone, |
| 106 | kLast = kNone |
Aart Bik | 2ca10eb | 2017-11-15 15:17:53 -0800 | [diff] [blame] | 107 | }; |
| 108 | |
| 109 | // Lookup name of optimization pass. |
| 110 | const char* OptimizationPassName(OptimizationPass pass); |
| 111 | |
| 112 | // Lookup optimization pass by name. |
Aart Bik | 2e14868 | 2018-04-18 16:11:12 -0700 | [diff] [blame] | 113 | OptimizationPass OptimizationPassByName(const std::string& pass_name); |
Aart Bik | 2ca10eb | 2017-11-15 15:17:53 -0800 | [diff] [blame] | 114 | |
| 115 | // Optimization definition consisting of an optimization pass |
Aart Bik | 2e14868 | 2018-04-18 16:11:12 -0700 | [diff] [blame] | 116 | // an optional alternative name (nullptr denotes default), and |
| 117 | // an optional pass dependence (kNone denotes no dependence). |
| 118 | struct OptimizationDef { |
| 119 | OptimizationDef(OptimizationPass p, const char* pn, OptimizationPass d) |
| 120 | : pass(p), pass_name(pn), depends_on(d) {} |
| 121 | OptimizationPass pass; |
| 122 | const char* pass_name; |
| 123 | OptimizationPass depends_on; |
| 124 | }; |
Aart Bik | 2ca10eb | 2017-11-15 15:17:53 -0800 | [diff] [blame] | 125 | |
| 126 | // Helper method for optimization definition array entries. |
Aart Bik | 2e14868 | 2018-04-18 16:11:12 -0700 | [diff] [blame] | 127 | inline OptimizationDef OptDef(OptimizationPass pass, |
| 128 | const char* pass_name = nullptr, |
| 129 | OptimizationPass depends_on = OptimizationPass::kNone) { |
| 130 | return OptimizationDef(pass, pass_name, depends_on); |
Aart Bik | 2ca10eb | 2017-11-15 15:17:53 -0800 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | // Helper method to construct series of optimization passes. |
| 134 | // The array should consist of the requested optimizations |
| 135 | // and optional alternative names for repeated passes. |
| 136 | // Example: |
| 137 | // { OptPass(kConstantFolding), |
| 138 | // OptPass(Inliner), |
| 139 | // OptPass(kConstantFolding, "constant_folding$after_inlining") |
| 140 | // } |
| 141 | ArenaVector<HOptimization*> ConstructOptimizations( |
| 142 | const OptimizationDef definitions[], |
| 143 | size_t length, |
| 144 | ArenaAllocator* allocator, |
| 145 | HGraph* graph, |
| 146 | OptimizingCompilerStats* stats, |
| 147 | CodeGenerator* codegen, |
| 148 | CompilerDriver* driver, |
| 149 | const DexCompilationUnit& dex_compilation_unit, |
| 150 | VariableSizedHandleScope* handles); |
| 151 | |
Roland Levillain | 75be283 | 2014-10-17 17:02:00 +0100 | [diff] [blame] | 152 | } // namespace art |
| 153 | |
| 154 | #endif // ART_COMPILER_OPTIMIZING_OPTIMIZATION_H_ |