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 
20 #include "base/arena_object.h"
21 #include "base/macros.h"
22 #include "nodes.h"
23 #include "optimizing_compiler_stats.h"
24 
25 namespace art HIDDEN {
26 
27 class CodeGenerator;
28 class DexCompilationUnit;
29 
30 /**
31  * Abstraction to implement an optimization pass.
32  */
33 class HOptimization : public ArenaObject<kArenaAllocOptimization> {
34  public:
35   HOptimization(HGraph* graph,
36                 const char* pass_name,
37                 OptimizingCompilerStats* stats = nullptr)
graph_(graph)38       : graph_(graph),
39         stats_(stats),
40         pass_name_(pass_name) {}
41 
~HOptimization()42   virtual ~HOptimization() {}
43 
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$before_codegen',
47   // 'instruction_simplifier$before_codegen'.
GetPassName()48   const char* GetPassName() const { return pass_name_; }
49 
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;
53 
54  protected:
55   HGraph* const graph_;
56   // Used to record stats about the optimization.
57   OptimizingCompilerStats* const stats_;
58 
59  private:
60   // Optimization pass name.
61   const char* pass_name_;
62 
63   DISALLOW_COPY_AND_ASSIGN(HOptimization);
64 };
65 
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   kAggressiveInstructionSimplifier,
71   kBoundsCheckElimination,
72   kCHAGuardOptimization,
73   kCodeSinking,
74   kConstantFolding,
75   kConstructorFenceRedundancyElimination,
76   kDeadCodeElimination,
77   kGlobalValueNumbering,
78   kInductionVarAnalysis,
79   kInliner,
80   kInstructionSimplifier,
81   kInvariantCodeMotion,
82   kLoadStoreElimination,
83   kLoopOptimization,
84   kScheduling,
85   kSelectGenerator,
86   kSideEffectsAnalysis,
87   kWriteBarrierElimination,
88 #ifdef ART_ENABLE_CODEGEN_arm
89   kInstructionSimplifierArm,
90   kCriticalNativeAbiFixupArm,
91 #endif
92 #ifdef ART_ENABLE_CODEGEN_arm64
93   kInstructionSimplifierArm64,
94 #endif
95 #ifdef ART_ENABLE_CODEGEN_riscv64
96   kCriticalNativeAbiFixupRiscv64,
97   kInstructionSimplifierRiscv64,
98 #endif
99 #ifdef ART_ENABLE_CODEGEN_x86
100   kPcRelativeFixupsX86,
101   kInstructionSimplifierX86,
102 #endif
103 #ifdef ART_ENABLE_CODEGEN_x86_64
104   kInstructionSimplifierX86_64,
105 #endif
106 #if defined(ART_ENABLE_CODEGEN_x86) || defined(ART_ENABLE_CODEGEN_x86_64)
107   kX86MemoryOperandGeneration,
108 #endif
109   kNone,
110   kLast = kNone
111 };
112 
113 // Lookup name of optimization pass.
114 const char* OptimizationPassName(OptimizationPass pass);
115 
116 // Lookup optimization pass by name.
117 OptimizationPass OptimizationPassByName(const std::string& pass_name);
118 
119 // Optimization definition consisting of an optimization pass
120 // an optional alternative name (nullptr denotes default), and
121 // an optional pass dependence (kNone denotes no dependence).
122 struct OptimizationDef {
OptimizationDefOptimizationDef123   OptimizationDef(OptimizationPass p, const char* pn, OptimizationPass d)
124       : pass(p), pass_name(pn), depends_on(d) {}
125   OptimizationPass pass;
126   const char* pass_name;
127   OptimizationPass depends_on;
128 };
129 
130 // Helper method for optimization definition array entries.
131 inline OptimizationDef OptDef(OptimizationPass pass,
132                               const char* pass_name = nullptr,
133                               OptimizationPass depends_on = OptimizationPass::kNone) {
134   return OptimizationDef(pass, pass_name, depends_on);
135 }
136 
137 // Helper method to construct series of optimization passes.
138 // The array should consist of the requested optimizations
139 // and optional alternative names for repeated passes.
140 // Example:
141 //    { OptPass(kConstantFolding),
142 //      OptPass(Inliner),
143 //      OptPass(kConstantFolding, "constant_folding$after_inlining")
144 //    }
145 ArenaVector<HOptimization*> ConstructOptimizations(
146     const OptimizationDef definitions[],
147     size_t length,
148     ArenaAllocator* allocator,
149     HGraph* graph,
150     OptimizingCompilerStats* stats,
151     CodeGenerator* codegen,
152     const DexCompilationUnit& dex_compilation_unit);
153 
154 }  // namespace art
155 
156 #endif  // ART_COMPILER_OPTIMIZING_OPTIMIZATION_H_
157