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