[PM] Change the core design of the TTI analysis to use a polymorphic
[oota-llvm.git] / lib / Target / AArch64 / AArch64TargetMachine.cpp
1 //===-- AArch64TargetMachine.cpp - Define TargetMachine for AArch64 -------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //
11 //===----------------------------------------------------------------------===//
12
13 #include "AArch64.h"
14 #include "AArch64TargetMachine.h"
15 #include "AArch64TargetObjectFile.h"
16 #include "llvm/CodeGen/Passes.h"
17 #include "llvm/CodeGen/RegAllocRegistry.h"
18 #include "llvm/IR/Function.h"
19 #include "llvm/PassManager.h"
20 #include "llvm/Support/CommandLine.h"
21 #include "llvm/Support/TargetRegistry.h"
22 #include "llvm/Target/TargetOptions.h"
23 #include "llvm/Transforms/Scalar.h"
24 using namespace llvm;
25
26 static cl::opt<bool>
27 EnableCCMP("aarch64-ccmp", cl::desc("Enable the CCMP formation pass"),
28            cl::init(true), cl::Hidden);
29
30 static cl::opt<bool> EnableMCR("aarch64-mcr",
31                                cl::desc("Enable the machine combiner pass"),
32                                cl::init(true), cl::Hidden);
33
34 static cl::opt<bool>
35 EnableStPairSuppress("aarch64-stp-suppress", cl::desc("Suppress STP for AArch64"),
36                      cl::init(true), cl::Hidden);
37
38 static cl::opt<bool>
39 EnableAdvSIMDScalar("aarch64-simd-scalar", cl::desc("Enable use of AdvSIMD scalar"
40                     " integer instructions"), cl::init(false), cl::Hidden);
41
42 static cl::opt<bool>
43 EnablePromoteConstant("aarch64-promote-const", cl::desc("Enable the promote "
44                       "constant pass"), cl::init(true), cl::Hidden);
45
46 static cl::opt<bool>
47 EnableCollectLOH("aarch64-collect-loh", cl::desc("Enable the pass that emits the"
48                  " linker optimization hints (LOH)"), cl::init(true),
49                  cl::Hidden);
50
51 static cl::opt<bool>
52 EnableDeadRegisterElimination("aarch64-dead-def-elimination", cl::Hidden,
53                               cl::desc("Enable the pass that removes dead"
54                                        " definitons and replaces stores to"
55                                        " them with stores to the zero"
56                                        " register"),
57                               cl::init(true));
58
59 static cl::opt<bool>
60 EnableLoadStoreOpt("aarch64-load-store-opt", cl::desc("Enable the load/store pair"
61                    " optimization pass"), cl::init(true), cl::Hidden);
62
63 static cl::opt<bool>
64 EnableAtomicTidy("aarch64-atomic-cfg-tidy", cl::Hidden,
65                  cl::desc("Run SimplifyCFG after expanding atomic operations"
66                           " to make use of cmpxchg flow-based information"),
67                  cl::init(true));
68
69 static cl::opt<bool>
70 EnableEarlyIfConversion("aarch64-enable-early-ifcvt", cl::Hidden,
71                         cl::desc("Run early if-conversion"),
72                         cl::init(true));
73
74 static cl::opt<bool>
75 EnableCondOpt("aarch64-condopt",
76               cl::desc("Enable the condition optimizer pass"),
77               cl::init(true), cl::Hidden);
78
79 static cl::opt<bool>
80 EnableA53Fix835769("aarch64-fix-cortex-a53-835769", cl::Hidden,
81                 cl::desc("Work around Cortex-A53 erratum 835769"),
82                 cl::init(false));
83
84 static cl::opt<bool>
85 EnableGEPOpt("aarch64-gep-opt", cl::Hidden,
86              cl::desc("Enable optimizations on complex GEPs"),
87              cl::init(true));
88
89 extern "C" void LLVMInitializeAArch64Target() {
90   // Register the target.
91   RegisterTargetMachine<AArch64leTargetMachine> X(TheAArch64leTarget);
92   RegisterTargetMachine<AArch64beTargetMachine> Y(TheAArch64beTarget);
93   RegisterTargetMachine<AArch64leTargetMachine> Z(TheARM64Target);
94 }
95
96 //===----------------------------------------------------------------------===//
97 // AArch64 Lowering public interface.
98 //===----------------------------------------------------------------------===//
99 static std::unique_ptr<TargetLoweringObjectFile> createTLOF(const Triple &TT) {
100   if (TT.isOSBinFormatMachO())
101     return make_unique<AArch64_MachoTargetObjectFile>();
102
103   return make_unique<AArch64_ELFTargetObjectFile>();
104 }
105
106 /// TargetMachine ctor - Create an AArch64 architecture model.
107 ///
108 AArch64TargetMachine::AArch64TargetMachine(const Target &T, StringRef TT,
109                                            StringRef CPU, StringRef FS,
110                                            const TargetOptions &Options,
111                                            Reloc::Model RM, CodeModel::Model CM,
112                                            CodeGenOpt::Level OL,
113                                            bool LittleEndian)
114     : LLVMTargetMachine(T, TT, CPU, FS, Options, RM, CM, OL),
115       // This nested ternary is horrible, but DL needs to be properly
116       // initialized
117       // before TLInfo is constructed.
118       DL(Triple(TT).isOSBinFormatMachO()
119              ? "e-m:o-i64:64-i128:128-n32:64-S128"
120              : (LittleEndian ? "e-m:e-i64:64-i128:128-n32:64-S128"
121                              : "E-m:e-i64:64-i128:128-n32:64-S128")),
122       TLOF(createTLOF(Triple(getTargetTriple()))),
123       Subtarget(TT, CPU, FS, *this, LittleEndian), isLittle(LittleEndian) {
124   initAsmInfo();
125 }
126
127 AArch64TargetMachine::~AArch64TargetMachine() {}
128
129 const AArch64Subtarget *
130 AArch64TargetMachine::getSubtargetImpl(const Function &F) const {
131   AttributeSet FnAttrs = F.getAttributes();
132   Attribute CPUAttr =
133       FnAttrs.getAttribute(AttributeSet::FunctionIndex, "target-cpu");
134   Attribute FSAttr =
135       FnAttrs.getAttribute(AttributeSet::FunctionIndex, "target-features");
136
137   std::string CPU = !CPUAttr.hasAttribute(Attribute::None)
138                         ? CPUAttr.getValueAsString().str()
139                         : TargetCPU;
140   std::string FS = !FSAttr.hasAttribute(Attribute::None)
141                        ? FSAttr.getValueAsString().str()
142                        : TargetFS;
143
144   auto &I = SubtargetMap[CPU + FS];
145   if (!I) {
146     // This needs to be done before we create a new subtarget since any
147     // creation will depend on the TM and the code generation flags on the
148     // function that reside in TargetOptions.
149     resetTargetOptions(F);
150     I = llvm::make_unique<AArch64Subtarget>(TargetTriple, CPU, FS, *this, isLittle);
151   }
152   return I.get();
153 }
154
155 void AArch64leTargetMachine::anchor() { }
156
157 AArch64leTargetMachine::
158 AArch64leTargetMachine(const Target &T, StringRef TT,
159                        StringRef CPU, StringRef FS, const TargetOptions &Options,
160                        Reloc::Model RM, CodeModel::Model CM,
161                        CodeGenOpt::Level OL)
162   : AArch64TargetMachine(T, TT, CPU, FS, Options, RM, CM, OL, true) {}
163
164 void AArch64beTargetMachine::anchor() { }
165
166 AArch64beTargetMachine::
167 AArch64beTargetMachine(const Target &T, StringRef TT,
168                        StringRef CPU, StringRef FS, const TargetOptions &Options,
169                        Reloc::Model RM, CodeModel::Model CM,
170                        CodeGenOpt::Level OL)
171   : AArch64TargetMachine(T, TT, CPU, FS, Options, RM, CM, OL, false) {}
172
173 namespace {
174 /// AArch64 Code Generator Pass Configuration Options.
175 class AArch64PassConfig : public TargetPassConfig {
176 public:
177   AArch64PassConfig(AArch64TargetMachine *TM, PassManagerBase &PM)
178       : TargetPassConfig(TM, PM) {
179     if (TM->getOptLevel() != CodeGenOpt::None)
180       substitutePass(&PostRASchedulerID, &PostMachineSchedulerID);
181   }
182
183   AArch64TargetMachine &getAArch64TargetMachine() const {
184     return getTM<AArch64TargetMachine>();
185   }
186
187   void addIRPasses()  override;
188   bool addPreISel() override;
189   bool addInstSelector() override;
190   bool addILPOpts() override;
191   void addPreRegAlloc() override;
192   void addPostRegAlloc() override;
193   void addPreSched2() override;
194   void addPreEmitPass() override;
195 };
196 } // namespace
197
198 void AArch64TargetMachine::addAnalysisPasses(PassManagerBase &PM) {
199   PM.add(createAArch64TargetTransformInfoPass(this));
200 }
201
202 TargetPassConfig *AArch64TargetMachine::createPassConfig(PassManagerBase &PM) {
203   return new AArch64PassConfig(this, PM);
204 }
205
206 void AArch64PassConfig::addIRPasses() {
207   // Always expand atomic operations, we don't deal with atomicrmw or cmpxchg
208   // ourselves.
209   addPass(createAtomicExpandPass(TM));
210
211   // Cmpxchg instructions are often used with a subsequent comparison to
212   // determine whether it succeeded. We can exploit existing control-flow in
213   // ldrex/strex loops to simplify this, but it needs tidying up.
214   if (TM->getOptLevel() != CodeGenOpt::None && EnableAtomicTidy)
215     addPass(createCFGSimplificationPass());
216
217   TargetPassConfig::addIRPasses();
218
219   if (TM->getOptLevel() == CodeGenOpt::Aggressive && EnableGEPOpt) {
220     // Call SeparateConstOffsetFromGEP pass to extract constants within indices
221     // and lower a GEP with multiple indices to either arithmetic operations or
222     // multiple GEPs with single index.
223     addPass(createSeparateConstOffsetFromGEPPass(TM, true));
224     // Call EarlyCSE pass to find and remove subexpressions in the lowered
225     // result.
226     addPass(createEarlyCSEPass());
227     // Do loop invariant code motion in case part of the lowered result is
228     // invariant.
229     addPass(createLICMPass());
230   }
231 }
232
233 // Pass Pipeline Configuration
234 bool AArch64PassConfig::addPreISel() {
235   // Run promote constant before global merge, so that the promoted constants
236   // get a chance to be merged
237   if (TM->getOptLevel() != CodeGenOpt::None && EnablePromoteConstant)
238     addPass(createAArch64PromoteConstantPass());
239   if (TM->getOptLevel() != CodeGenOpt::None)
240     addPass(createGlobalMergePass(TM));
241   if (TM->getOptLevel() != CodeGenOpt::None)
242     addPass(createAArch64AddressTypePromotionPass());
243
244   return false;
245 }
246
247 bool AArch64PassConfig::addInstSelector() {
248   addPass(createAArch64ISelDag(getAArch64TargetMachine(), getOptLevel()));
249
250   // For ELF, cleanup any local-dynamic TLS accesses (i.e. combine as many
251   // references to _TLS_MODULE_BASE_ as possible.
252   if (Triple(TM->getTargetTriple()).isOSBinFormatELF() &&
253       getOptLevel() != CodeGenOpt::None)
254     addPass(createAArch64CleanupLocalDynamicTLSPass());
255
256   return false;
257 }
258
259 bool AArch64PassConfig::addILPOpts() {
260   if (EnableCondOpt)
261     addPass(createAArch64ConditionOptimizerPass());
262   if (EnableCCMP)
263     addPass(createAArch64ConditionalCompares());
264   if (EnableMCR)
265     addPass(&MachineCombinerID);
266   if (EnableEarlyIfConversion)
267     addPass(&EarlyIfConverterID);
268   if (EnableStPairSuppress)
269     addPass(createAArch64StorePairSuppressPass());
270   return true;
271 }
272
273 void AArch64PassConfig::addPreRegAlloc() {
274   // Use AdvSIMD scalar instructions whenever profitable.
275   if (TM->getOptLevel() != CodeGenOpt::None && EnableAdvSIMDScalar) {
276     addPass(createAArch64AdvSIMDScalar());
277     // The AdvSIMD pass may produce copies that can be rewritten to
278     // be register coaleascer friendly.
279     addPass(&PeepholeOptimizerID);
280   }
281 }
282
283 void AArch64PassConfig::addPostRegAlloc() {
284   // Change dead register definitions to refer to the zero register.
285   if (TM->getOptLevel() != CodeGenOpt::None && EnableDeadRegisterElimination)
286     addPass(createAArch64DeadRegisterDefinitions());
287   if (TM->getOptLevel() != CodeGenOpt::None &&
288       (TM->getSubtarget<AArch64Subtarget>().isCortexA53() ||
289        TM->getSubtarget<AArch64Subtarget>().isCortexA57()) &&
290       usingDefaultRegAlloc())
291     // Improve performance for some FP/SIMD code for A57.
292     addPass(createAArch64A57FPLoadBalancing());
293 }
294
295 void AArch64PassConfig::addPreSched2() {
296   // Expand some pseudo instructions to allow proper scheduling.
297   addPass(createAArch64ExpandPseudoPass());
298   // Use load/store pair instructions when possible.
299   if (TM->getOptLevel() != CodeGenOpt::None && EnableLoadStoreOpt)
300     addPass(createAArch64LoadStoreOptimizationPass());
301 }
302
303 void AArch64PassConfig::addPreEmitPass() {
304   if (EnableA53Fix835769)
305     addPass(createAArch64A53Fix835769());
306   // Relax conditional branch instructions if they're otherwise out of
307   // range of their destination.
308   addPass(createAArch64BranchRelaxation());
309   if (TM->getOptLevel() != CodeGenOpt::None && EnableCollectLOH &&
310       Triple(TM->getTargetTriple()).isOSBinFormatMachO())
311     addPass(createAArch64CollectLOHPass());
312 }