blob: 543559fdb36b895f5eb7c07fd7f879ed7b4d7079 [file] [log] [blame]
Hal Finkel96c2d4d2012-06-08 15:38:21 +00001//===-- PPCCTRLoops.cpp - Identify and generate CTR loops -----------------===//
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// This pass identifies loops where we can generate the PPC branch instructions
11// that decrement and test the count register (CTR) (bdnz and friends).
Hal Finkel96c2d4d2012-06-08 15:38:21 +000012//
13// The pattern that defines the induction variable can changed depending on
14// prior optimizations. For example, the IndVarSimplify phase run by 'opt'
15// normalizes induction variables, and the Loop Strength Reduction pass
16// run by 'llc' may also make changes to the induction variable.
Hal Finkel96c2d4d2012-06-08 15:38:21 +000017//
18// Criteria for CTR loops:
19// - Countable loops (w/ ind. var for a trip count)
Hal Finkel96c2d4d2012-06-08 15:38:21 +000020// - Try inner-most loops first
21// - No nested CTR loops.
22// - No function calls in loops.
23//
Hal Finkel96c2d4d2012-06-08 15:38:21 +000024//===----------------------------------------------------------------------===//
25
Hal Finkel25c19922013-05-15 21:37:41 +000026#include "llvm/Transforms/Scalar.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000027#include "PPC.h"
28#include "PPCTargetMachine.h"
Hal Finkel25c19922013-05-15 21:37:41 +000029#include "llvm/ADT/STLExtras.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000030#include "llvm/ADT/Statistic.h"
Hal Finkel25c19922013-05-15 21:37:41 +000031#include "llvm/Analysis/LoopInfo.h"
32#include "llvm/Analysis/ScalarEvolutionExpander.h"
Chandler Carruth62d42152015-01-15 02:16:27 +000033#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000034#include "llvm/IR/Constants.h"
Hal Finkel25c19922013-05-15 21:37:41 +000035#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000036#include "llvm/IR/Dominators.h"
Hal Finkel2f474f02013-05-18 09:20:39 +000037#include "llvm/IR/InlineAsm.h"
Hal Finkel25c19922013-05-15 21:37:41 +000038#include "llvm/IR/Instructions.h"
39#include "llvm/IR/IntrinsicInst.h"
40#include "llvm/IR/Module.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000041#include "llvm/IR/ValueHandle.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000042#include "llvm/PassSupport.h"
Hal Finkel25c19922013-05-15 21:37:41 +000043#include "llvm/Support/CommandLine.h"
Hal Finkel96c2d4d2012-06-08 15:38:21 +000044#include "llvm/Support/Debug.h"
45#include "llvm/Support/raw_ostream.h"
Hal Finkel25c19922013-05-15 21:37:41 +000046#include "llvm/Transforms/Utils/BasicBlockUtils.h"
47#include "llvm/Transforms/Utils/Local.h"
Hal Finkela969df82013-05-20 20:46:30 +000048#include "llvm/Transforms/Utils/LoopUtils.h"
Hal Finkel25c19922013-05-15 21:37:41 +000049
Hal Finkel8ca38842013-05-20 16:08:17 +000050#ifndef NDEBUG
51#include "llvm/CodeGen/MachineDominators.h"
52#include "llvm/CodeGen/MachineFunction.h"
53#include "llvm/CodeGen/MachineFunctionPass.h"
54#include "llvm/CodeGen/MachineRegisterInfo.h"
55#endif
56
Hal Finkel96c2d4d2012-06-08 15:38:21 +000057#include <algorithm>
Hal Finkel25c19922013-05-15 21:37:41 +000058#include <vector>
Hal Finkel96c2d4d2012-06-08 15:38:21 +000059
60using namespace llvm;
61
Chandler Carruth84e68b22014-04-22 02:41:26 +000062#define DEBUG_TYPE "ctrloops"
63
Hal Finkel25c19922013-05-15 21:37:41 +000064#ifndef NDEBUG
65static cl::opt<int> CTRLoopLimit("ppc-max-ctrloop", cl::Hidden, cl::init(-1));
66#endif
67
Hal Finkel96c2d4d2012-06-08 15:38:21 +000068STATISTIC(NumCTRLoops, "Number of loops converted to CTR loops");
69
Krzysztof Parzyszek2680b532013-02-13 17:40:07 +000070namespace llvm {
71 void initializePPCCTRLoopsPass(PassRegistry&);
Hal Finkel8ca38842013-05-20 16:08:17 +000072#ifndef NDEBUG
73 void initializePPCCTRLoopsVerifyPass(PassRegistry&);
74#endif
Krzysztof Parzyszek2680b532013-02-13 17:40:07 +000075}
76
Hal Finkel96c2d4d2012-06-08 15:38:21 +000077namespace {
Hal Finkel25c19922013-05-15 21:37:41 +000078 struct PPCCTRLoops : public FunctionPass {
79
80#ifndef NDEBUG
81 static int Counter;
82#endif
Hal Finkel96c2d4d2012-06-08 15:38:21 +000083
84 public:
Hal Finkel25c19922013-05-15 21:37:41 +000085 static char ID;
Hal Finkel96c2d4d2012-06-08 15:38:21 +000086
Craig Topper062a2ba2014-04-25 05:30:21 +000087 PPCCTRLoops() : FunctionPass(ID), TM(nullptr) {
Hal Finkel25c19922013-05-15 21:37:41 +000088 initializePPCCTRLoopsPass(*PassRegistry::getPassRegistry());
89 }
90 PPCCTRLoops(PPCTargetMachine &TM) : FunctionPass(ID), TM(&TM) {
Krzysztof Parzyszek2680b532013-02-13 17:40:07 +000091 initializePPCCTRLoopsPass(*PassRegistry::getPassRegistry());
92 }
Hal Finkel96c2d4d2012-06-08 15:38:21 +000093
Craig Topper0d3fa922014-04-29 07:57:37 +000094 bool runOnFunction(Function &F) override;
Hal Finkel96c2d4d2012-06-08 15:38:21 +000095
Craig Topper0d3fa922014-04-29 07:57:37 +000096 void getAnalysisUsage(AnalysisUsage &AU) const override {
Hal Finkel25c19922013-05-15 21:37:41 +000097 AU.addRequired<LoopInfo>();
98 AU.addPreserved<LoopInfo>();
Chandler Carruth73523022014-01-13 13:07:17 +000099 AU.addRequired<DominatorTreeWrapperPass>();
100 AU.addPreserved<DominatorTreeWrapperPass>();
Hal Finkel25c19922013-05-15 21:37:41 +0000101 AU.addRequired<ScalarEvolution>();
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000102 }
103
104 private:
Hal Finkel5f587c52013-05-16 19:58:38 +0000105 bool mightUseCTR(const Triple &TT, BasicBlock *BB);
Hal Finkel25c19922013-05-15 21:37:41 +0000106 bool convertToCTRLoop(Loop *L);
Hal Finkele6d7c282013-05-20 16:47:10 +0000107
Hal Finkel25c19922013-05-15 21:37:41 +0000108 private:
109 PPCTargetMachine *TM;
110 LoopInfo *LI;
111 ScalarEvolution *SE;
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000112 const DataLayout *DL;
Hal Finkel25c19922013-05-15 21:37:41 +0000113 DominatorTree *DT;
114 const TargetLibraryInfo *LibInfo;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000115 };
116
117 char PPCCTRLoops::ID = 0;
Hal Finkel25c19922013-05-15 21:37:41 +0000118#ifndef NDEBUG
119 int PPCCTRLoops::Counter = 0;
120#endif
Hal Finkel8ca38842013-05-20 16:08:17 +0000121
122#ifndef NDEBUG
123 struct PPCCTRLoopsVerify : public MachineFunctionPass {
124 public:
125 static char ID;
126
127 PPCCTRLoopsVerify() : MachineFunctionPass(ID) {
128 initializePPCCTRLoopsVerifyPass(*PassRegistry::getPassRegistry());
129 }
130
Craig Topper0d3fa922014-04-29 07:57:37 +0000131 void getAnalysisUsage(AnalysisUsage &AU) const override {
Hal Finkel8ca38842013-05-20 16:08:17 +0000132 AU.addRequired<MachineDominatorTree>();
133 MachineFunctionPass::getAnalysisUsage(AU);
134 }
135
Craig Topper0d3fa922014-04-29 07:57:37 +0000136 bool runOnMachineFunction(MachineFunction &MF) override;
Hal Finkel8ca38842013-05-20 16:08:17 +0000137
138 private:
139 MachineDominatorTree *MDT;
140 };
141
142 char PPCCTRLoopsVerify::ID = 0;
143#endif // NDEBUG
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000144} // end anonymous namespace
145
Krzysztof Parzyszek2680b532013-02-13 17:40:07 +0000146INITIALIZE_PASS_BEGIN(PPCCTRLoops, "ppc-ctr-loops", "PowerPC CTR Loops",
147 false, false)
Chandler Carruth73523022014-01-13 13:07:17 +0000148INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Hal Finkel25c19922013-05-15 21:37:41 +0000149INITIALIZE_PASS_DEPENDENCY(LoopInfo)
150INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
Krzysztof Parzyszek2680b532013-02-13 17:40:07 +0000151INITIALIZE_PASS_END(PPCCTRLoops, "ppc-ctr-loops", "PowerPC CTR Loops",
152 false, false)
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000153
Hal Finkel25c19922013-05-15 21:37:41 +0000154FunctionPass *llvm::createPPCCTRLoops(PPCTargetMachine &TM) {
155 return new PPCCTRLoops(TM);
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000156}
157
Hal Finkel8ca38842013-05-20 16:08:17 +0000158#ifndef NDEBUG
159INITIALIZE_PASS_BEGIN(PPCCTRLoopsVerify, "ppc-ctr-loops-verify",
160 "PowerPC CTR Loops Verify", false, false)
161INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
162INITIALIZE_PASS_END(PPCCTRLoopsVerify, "ppc-ctr-loops-verify",
163 "PowerPC CTR Loops Verify", false, false)
164
165FunctionPass *llvm::createPPCCTRLoopsVerify() {
166 return new PPCCTRLoopsVerify();
167}
168#endif // NDEBUG
169
Hal Finkel25c19922013-05-15 21:37:41 +0000170bool PPCCTRLoops::runOnFunction(Function &F) {
171 LI = &getAnalysis<LoopInfo>();
172 SE = &getAnalysis<ScalarEvolution>();
Chandler Carruth73523022014-01-13 13:07:17 +0000173 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Rafael Espindola93512512014-02-25 17:30:31 +0000174 DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
Craig Topper062a2ba2014-04-25 05:30:21 +0000175 DL = DLP ? &DLP->getDataLayout() : nullptr;
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000176 auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
177 LibInfo = TLIP ? &TLIP->getTLI() : nullptr;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000178
Hal Finkel25c19922013-05-15 21:37:41 +0000179 bool MadeChange = false;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000180
Hal Finkel25c19922013-05-15 21:37:41 +0000181 for (LoopInfo::iterator I = LI->begin(), E = LI->end();
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000182 I != E; ++I) {
Hal Finkel25c19922013-05-15 21:37:41 +0000183 Loop *L = *I;
184 if (!L->getParentLoop())
185 MadeChange |= convertToCTRLoop(L);
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000186 }
187
Hal Finkel25c19922013-05-15 21:37:41 +0000188 return MadeChange;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000189}
190
Hal Finkel22304042014-02-25 20:51:50 +0000191static bool isLargeIntegerTy(bool Is32Bit, Type *Ty) {
192 if (IntegerType *ITy = dyn_cast<IntegerType>(Ty))
Aaron Ballman3d69c5c2014-02-26 20:22:20 +0000193 return ITy->getBitWidth() > (Is32Bit ? 32U : 64U);
Hal Finkel22304042014-02-25 20:51:50 +0000194
195 return false;
196}
197
David Majnemerd0bcef22014-12-27 19:45:38 +0000198// Determining the address of a TLS variable results in a function call in
199// certain TLS models.
200static bool memAddrUsesCTR(const PPCTargetMachine *TM,
201 const llvm::Value *MemAddr) {
202 const auto *GV = dyn_cast<GlobalValue>(MemAddr);
203 if (!GV)
204 return false;
205 if (!GV->isThreadLocal())
206 return false;
207 if (!TM)
208 return true;
209 TLSModel::Model Model = TM->getTLSModel(GV);
210 return Model == TLSModel::GeneralDynamic || Model == TLSModel::LocalDynamic;
211}
212
Hal Finkel5f587c52013-05-16 19:58:38 +0000213bool PPCCTRLoops::mightUseCTR(const Triple &TT, BasicBlock *BB) {
214 for (BasicBlock::iterator J = BB->begin(), JE = BB->end();
215 J != JE; ++J) {
216 if (CallInst *CI = dyn_cast<CallInst>(J)) {
Hal Finkel2f474f02013-05-18 09:20:39 +0000217 if (InlineAsm *IA = dyn_cast<InlineAsm>(CI->getCalledValue())) {
218 // Inline ASM is okay, unless it clobbers the ctr register.
219 InlineAsm::ConstraintInfoVector CIV = IA->ParseConstraints();
220 for (unsigned i = 0, ie = CIV.size(); i < ie; ++i) {
221 InlineAsm::ConstraintInfo &C = CIV[i];
222 if (C.Type != InlineAsm::isInput)
223 for (unsigned j = 0, je = C.Codes.size(); j < je; ++j)
224 if (StringRef(C.Codes[j]).equals_lower("{ctr}"))
225 return true;
226 }
227
228 continue;
229 }
230
Hal Finkel5f587c52013-05-16 19:58:38 +0000231 if (!TM)
232 return true;
Eric Christopherd9134482014-08-04 21:25:23 +0000233 const TargetLowering *TLI = TM->getSubtargetImpl()->getTargetLowering();
Hal Finkel5f587c52013-05-16 19:58:38 +0000234
235 if (Function *F = CI->getCalledFunction()) {
236 // Most intrinsics don't become function calls, but some might.
237 // sin, cos, exp and log are always calls.
238 unsigned Opcode;
239 if (F->getIntrinsicID() != Intrinsic::not_intrinsic) {
240 switch (F->getIntrinsicID()) {
241 default: continue;
242
243// VisualStudio defines setjmp as _setjmp
244#if defined(_MSC_VER) && defined(setjmp) && \
245 !defined(setjmp_undefined_for_msvc)
246# pragma push_macro("setjmp")
247# undef setjmp
248# define setjmp_undefined_for_msvc
249#endif
250
251 case Intrinsic::setjmp:
252
253#if defined(_MSC_VER) && defined(setjmp_undefined_for_msvc)
254 // let's return it to _setjmp state
255# pragma pop_macro("setjmp")
256# undef setjmp_undefined_for_msvc
257#endif
258
259 case Intrinsic::longjmp:
Hal Finkel40f76d52013-07-17 05:35:44 +0000260
261 // Exclude eh_sjlj_setjmp; we don't need to exclude eh_sjlj_longjmp
262 // because, although it does clobber the counter register, the
263 // control can't then return to inside the loop unless there is also
264 // an eh_sjlj_setjmp.
265 case Intrinsic::eh_sjlj_setjmp:
266
Hal Finkel5f587c52013-05-16 19:58:38 +0000267 case Intrinsic::memcpy:
268 case Intrinsic::memmove:
269 case Intrinsic::memset:
270 case Intrinsic::powi:
271 case Intrinsic::log:
272 case Intrinsic::log2:
273 case Intrinsic::log10:
274 case Intrinsic::exp:
275 case Intrinsic::exp2:
276 case Intrinsic::pow:
277 case Intrinsic::sin:
278 case Intrinsic::cos:
279 return true;
Hal Finkel0c5c01aa2013-08-19 23:35:46 +0000280 case Intrinsic::copysign:
281 if (CI->getArgOperand(0)->getType()->getScalarType()->
282 isPPC_FP128Ty())
283 return true;
284 else
285 continue; // ISD::FCOPYSIGN is never a library call.
Hal Finkel5f587c52013-05-16 19:58:38 +0000286 case Intrinsic::sqrt: Opcode = ISD::FSQRT; break;
287 case Intrinsic::floor: Opcode = ISD::FFLOOR; break;
288 case Intrinsic::ceil: Opcode = ISD::FCEIL; break;
289 case Intrinsic::trunc: Opcode = ISD::FTRUNC; break;
290 case Intrinsic::rint: Opcode = ISD::FRINT; break;
291 case Intrinsic::nearbyint: Opcode = ISD::FNEARBYINT; break;
Hal Finkel171817e2013-08-07 22:49:12 +0000292 case Intrinsic::round: Opcode = ISD::FROUND; break;
Hal Finkel5f587c52013-05-16 19:58:38 +0000293 }
294 }
295
296 // PowerPC does not use [US]DIVREM or other library calls for
297 // operations on regular types which are not otherwise library calls
298 // (i.e. soft float or atomics). If adapting for targets that do,
299 // additional care is required here.
300
301 LibFunc::Func Func;
302 if (!F->hasLocalLinkage() && F->hasName() && LibInfo &&
303 LibInfo->getLibFunc(F->getName(), Func) &&
304 LibInfo->hasOptimizedCodeGen(Func)) {
305 // Non-read-only functions are never treated as intrinsics.
306 if (!CI->onlyReadsMemory())
307 return true;
308
309 // Conversion happens only for FP calls.
310 if (!CI->getArgOperand(0)->getType()->isFloatingPointTy())
311 return true;
312
313 switch (Func) {
314 default: return true;
315 case LibFunc::copysign:
316 case LibFunc::copysignf:
Hal Finkel5f587c52013-05-16 19:58:38 +0000317 continue; // ISD::FCOPYSIGN is never a library call.
Hal Finkel1cf48ab2013-08-19 23:35:24 +0000318 case LibFunc::copysignl:
319 return true;
Hal Finkel5f587c52013-05-16 19:58:38 +0000320 case LibFunc::fabs:
321 case LibFunc::fabsf:
322 case LibFunc::fabsl:
323 continue; // ISD::FABS is never a library call.
324 case LibFunc::sqrt:
325 case LibFunc::sqrtf:
326 case LibFunc::sqrtl:
327 Opcode = ISD::FSQRT; break;
328 case LibFunc::floor:
329 case LibFunc::floorf:
330 case LibFunc::floorl:
331 Opcode = ISD::FFLOOR; break;
332 case LibFunc::nearbyint:
333 case LibFunc::nearbyintf:
334 case LibFunc::nearbyintl:
335 Opcode = ISD::FNEARBYINT; break;
336 case LibFunc::ceil:
337 case LibFunc::ceilf:
338 case LibFunc::ceill:
339 Opcode = ISD::FCEIL; break;
340 case LibFunc::rint:
341 case LibFunc::rintf:
342 case LibFunc::rintl:
343 Opcode = ISD::FRINT; break;
Hal Finkel171817e2013-08-07 22:49:12 +0000344 case LibFunc::round:
345 case LibFunc::roundf:
346 case LibFunc::roundl:
347 Opcode = ISD::FROUND; break;
Hal Finkel5f587c52013-05-16 19:58:38 +0000348 case LibFunc::trunc:
349 case LibFunc::truncf:
350 case LibFunc::truncl:
351 Opcode = ISD::FTRUNC; break;
352 }
353
354 MVT VTy =
355 TLI->getSimpleValueType(CI->getArgOperand(0)->getType(), true);
356 if (VTy == MVT::Other)
357 return true;
358
359 if (TLI->isOperationLegalOrCustom(Opcode, VTy))
360 continue;
361 else if (VTy.isVector() &&
362 TLI->isOperationLegalOrCustom(Opcode, VTy.getScalarType()))
363 continue;
364
365 return true;
366 }
367 }
368
369 return true;
370 } else if (isa<BinaryOperator>(J) &&
371 J->getType()->getScalarType()->isPPC_FP128Ty()) {
372 // Most operations on ppc_f128 values become calls.
373 return true;
374 } else if (isa<UIToFPInst>(J) || isa<SIToFPInst>(J) ||
375 isa<FPToUIInst>(J) || isa<FPToSIInst>(J)) {
376 CastInst *CI = cast<CastInst>(J);
377 if (CI->getSrcTy()->getScalarType()->isPPC_FP128Ty() ||
378 CI->getDestTy()->getScalarType()->isPPC_FP128Ty() ||
Hal Finkel22304042014-02-25 20:51:50 +0000379 isLargeIntegerTy(TT.isArch32Bit(), CI->getSrcTy()->getScalarType()) ||
380 isLargeIntegerTy(TT.isArch32Bit(), CI->getDestTy()->getScalarType()))
Hal Finkel5f587c52013-05-16 19:58:38 +0000381 return true;
Hal Finkel22304042014-02-25 20:51:50 +0000382 } else if (isLargeIntegerTy(TT.isArch32Bit(),
383 J->getType()->getScalarType()) &&
Hal Finkelfa5f6f72013-06-07 22:16:19 +0000384 (J->getOpcode() == Instruction::UDiv ||
385 J->getOpcode() == Instruction::SDiv ||
386 J->getOpcode() == Instruction::URem ||
387 J->getOpcode() == Instruction::SRem)) {
388 return true;
Hal Finkelc4c6c872014-05-11 16:23:29 +0000389 } else if (TT.isArch32Bit() &&
390 isLargeIntegerTy(false, J->getType()->getScalarType()) &&
391 (J->getOpcode() == Instruction::Shl ||
392 J->getOpcode() == Instruction::AShr ||
393 J->getOpcode() == Instruction::LShr)) {
394 // Only on PPC32, for 128-bit integers (specifically not 64-bit
395 // integers), these might be runtime calls.
396 return true;
Hal Finkel5f587c52013-05-16 19:58:38 +0000397 } else if (isa<IndirectBrInst>(J) || isa<InvokeInst>(J)) {
398 // On PowerPC, indirect jumps use the counter register.
399 return true;
400 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(J)) {
401 if (!TM)
402 return true;
Eric Christopherd9134482014-08-04 21:25:23 +0000403 const TargetLowering *TLI = TM->getSubtargetImpl()->getTargetLowering();
Hal Finkel5f587c52013-05-16 19:58:38 +0000404
Eric Christopher79cc1e32014-09-02 22:28:02 +0000405 if (SI->getNumCases() + 1 >= (unsigned)TLI->getMinimumJumpTableEntries())
Hal Finkel5f587c52013-05-16 19:58:38 +0000406 return true;
407 }
David Majnemerd0bcef22014-12-27 19:45:38 +0000408 for (Value *Operand : J->operands())
409 if (memAddrUsesCTR(TM, Operand))
410 return true;
Hal Finkel5f587c52013-05-16 19:58:38 +0000411 }
412
413 return false;
414}
415
Hal Finkel25c19922013-05-15 21:37:41 +0000416bool PPCCTRLoops::convertToCTRLoop(Loop *L) {
417 bool MadeChange = false;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000418
Hal Finkel25c19922013-05-15 21:37:41 +0000419 Triple TT = Triple(L->getHeader()->getParent()->getParent()->
420 getTargetTriple());
421 if (!TT.isArch32Bit() && !TT.isArch64Bit())
422 return MadeChange; // Unknown arch. type.
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000423
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000424 // Process nested loops first.
Hal Finkel25c19922013-05-15 21:37:41 +0000425 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I) {
426 MadeChange |= convertToCTRLoop(*I);
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000427 }
Hal Finkel25c19922013-05-15 21:37:41 +0000428
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000429 // If a nested loop has been converted, then we can't convert this loop.
Hal Finkel25c19922013-05-15 21:37:41 +0000430 if (MadeChange)
431 return MadeChange;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000432
Hal Finkel25c19922013-05-15 21:37:41 +0000433#ifndef NDEBUG
434 // Stop trying after reaching the limit (if any).
435 int Limit = CTRLoopLimit;
436 if (Limit >= 0) {
437 if (Counter >= CTRLoopLimit)
Hal Finkel21f2a432013-03-18 17:40:44 +0000438 return false;
Hal Finkel25c19922013-05-15 21:37:41 +0000439 Counter++;
Hal Finkel21f2a432013-03-18 17:40:44 +0000440 }
Hal Finkel25c19922013-05-15 21:37:41 +0000441#endif
Hal Finkel21f2a432013-03-18 17:40:44 +0000442
Hal Finkel25c19922013-05-15 21:37:41 +0000443 // We don't want to spill/restore the counter register, and so we don't
444 // want to use the counter register if the loop contains calls.
445 for (Loop::block_iterator I = L->block_begin(), IE = L->block_end();
Hal Finkel5f587c52013-05-16 19:58:38 +0000446 I != IE; ++I)
447 if (mightUseCTR(TT, *I))
448 return MadeChange;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000449
Hal Finkel25c19922013-05-15 21:37:41 +0000450 SmallVector<BasicBlock*, 4> ExitingBlocks;
451 L->getExitingBlocks(ExitingBlocks);
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000452
Craig Topper062a2ba2014-04-25 05:30:21 +0000453 BasicBlock *CountedExitBlock = nullptr;
454 const SCEV *ExitCount = nullptr;
455 BranchInst *CountedExitBranch = nullptr;
Craig Topperaf0dea12013-07-04 01:31:24 +0000456 for (SmallVectorImpl<BasicBlock *>::iterator I = ExitingBlocks.begin(),
Hal Finkel25c19922013-05-15 21:37:41 +0000457 IE = ExitingBlocks.end(); I != IE; ++I) {
458 const SCEV *EC = SE->getExitCount(L, *I);
459 DEBUG(dbgs() << "Exit Count for " << *L << " from block " <<
460 (*I)->getName() << ": " << *EC << "\n");
461 if (isa<SCEVCouldNotCompute>(EC))
462 continue;
463 if (const SCEVConstant *ConstEC = dyn_cast<SCEVConstant>(EC)) {
464 if (ConstEC->getValue()->isZero())
465 continue;
466 } else if (!SE->isLoopInvariant(EC, L))
467 continue;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000468
Hal Finkel25e4a0d2013-07-01 19:34:59 +0000469 if (SE->getTypeSizeInBits(EC->getType()) > (TT.isArch64Bit() ? 64 : 32))
470 continue;
471
Hal Finkel25c19922013-05-15 21:37:41 +0000472 // We now have a loop-invariant count of loop iterations (which is not the
473 // constant zero) for which we know that this loop will not exit via this
474 // exisiting block.
Hal Finkel6261c2d2012-06-16 20:34:07 +0000475
Hal Finkel25c19922013-05-15 21:37:41 +0000476 // We need to make sure that this block will run on every loop iteration.
477 // For this to be true, we must dominate all blocks with backedges. Such
478 // blocks are in-loop predecessors to the header block.
479 bool NotAlways = false;
480 for (pred_iterator PI = pred_begin(L->getHeader()),
481 PIE = pred_end(L->getHeader()); PI != PIE; ++PI) {
482 if (!L->contains(*PI))
483 continue;
484
485 if (!DT->dominates(*I, *PI)) {
486 NotAlways = true;
487 break;
488 }
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000489 }
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000490
Hal Finkel25c19922013-05-15 21:37:41 +0000491 if (NotAlways)
492 continue;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000493
Hal Finkel25c19922013-05-15 21:37:41 +0000494 // Make sure this blocks ends with a conditional branch.
495 Instruction *TI = (*I)->getTerminator();
496 if (!TI)
497 continue;
498
499 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
500 if (!BI->isConditional())
501 continue;
502
503 CountedExitBranch = BI;
504 } else
505 continue;
506
507 // Note that this block may not be the loop latch block, even if the loop
508 // has a latch block.
509 CountedExitBlock = *I;
510 ExitCount = EC;
511 break;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000512 }
513
Hal Finkel25c19922013-05-15 21:37:41 +0000514 if (!CountedExitBlock)
515 return MadeChange;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000516
Hal Finkel25c19922013-05-15 21:37:41 +0000517 BasicBlock *Preheader = L->getLoopPreheader();
Hal Finkel5f587c52013-05-16 19:58:38 +0000518
519 // If we don't have a preheader, then insert one. If we already have a
520 // preheader, then we can use it (except if the preheader contains a use of
521 // the CTR register because some such uses might be reordered by the
522 // selection DAG after the mtctr instruction).
523 if (!Preheader || mightUseCTR(TT, Preheader))
Hal Finkele6d7c282013-05-20 16:47:10 +0000524 Preheader = InsertPreheaderForLoop(L, this);
Hal Finkel25c19922013-05-15 21:37:41 +0000525 if (!Preheader)
526 return MadeChange;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000527
Hal Finkel25c19922013-05-15 21:37:41 +0000528 DEBUG(dbgs() << "Preheader for exit count: " << Preheader->getName() << "\n");
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000529
Hal Finkel25c19922013-05-15 21:37:41 +0000530 // Insert the count into the preheader and replace the condition used by the
531 // selected branch.
532 MadeChange = true;
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000533
Hal Finkel25c19922013-05-15 21:37:41 +0000534 SCEVExpander SCEVE(*SE, "loopcnt");
535 LLVMContext &C = SE->getContext();
536 Type *CountType = TT.isArch64Bit() ? Type::getInt64Ty(C) :
537 Type::getInt32Ty(C);
538 if (!ExitCount->getType()->isPointerTy() &&
539 ExitCount->getType() != CountType)
540 ExitCount = SE->getZeroExtendExpr(ExitCount, CountType);
541 ExitCount = SE->getAddExpr(ExitCount,
542 SE->getConstant(CountType, 1));
543 Value *ECValue = SCEVE.expandCodeFor(ExitCount, CountType,
544 Preheader->getTerminator());
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000545
Hal Finkel25c19922013-05-15 21:37:41 +0000546 IRBuilder<> CountBuilder(Preheader->getTerminator());
547 Module *M = Preheader->getParent()->getParent();
548 Value *MTCTRFunc = Intrinsic::getDeclaration(M, Intrinsic::ppc_mtctr,
549 CountType);
550 CountBuilder.CreateCall(MTCTRFunc, ECValue);
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000551
Hal Finkel25c19922013-05-15 21:37:41 +0000552 IRBuilder<> CondBuilder(CountedExitBranch);
553 Value *DecFunc =
554 Intrinsic::getDeclaration(M, Intrinsic::ppc_is_decremented_ctr_nonzero);
555 Value *NewCond = CondBuilder.CreateCall(DecFunc);
556 Value *OldCond = CountedExitBranch->getCondition();
557 CountedExitBranch->setCondition(NewCond);
558
559 // The false branch must exit the loop.
560 if (!L->contains(CountedExitBranch->getSuccessor(0)))
561 CountedExitBranch->swapSuccessors();
562
563 // The old condition may be dead now, and may have even created a dead PHI
564 // (the original induction variable).
565 RecursivelyDeleteTriviallyDeadInstructions(OldCond);
566 DeleteDeadPHIs(CountedExitBlock);
Hal Finkel96c2d4d2012-06-08 15:38:21 +0000567
568 ++NumCTRLoops;
Hal Finkel25c19922013-05-15 21:37:41 +0000569 return MadeChange;
570}
571
Hal Finkel8ca38842013-05-20 16:08:17 +0000572#ifndef NDEBUG
573static bool clobbersCTR(const MachineInstr *MI) {
574 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
575 const MachineOperand &MO = MI->getOperand(i);
576 if (MO.isReg()) {
577 if (MO.isDef() && (MO.getReg() == PPC::CTR || MO.getReg() == PPC::CTR8))
578 return true;
579 } else if (MO.isRegMask()) {
580 if (MO.clobbersPhysReg(PPC::CTR) || MO.clobbersPhysReg(PPC::CTR8))
581 return true;
582 }
583 }
584
585 return false;
586}
587
588static bool verifyCTRBranch(MachineBasicBlock *MBB,
589 MachineBasicBlock::iterator I) {
590 MachineBasicBlock::iterator BI = I;
591 SmallSet<MachineBasicBlock *, 16> Visited;
592 SmallVector<MachineBasicBlock *, 8> Preds;
593 bool CheckPreds;
594
595 if (I == MBB->begin()) {
596 Visited.insert(MBB);
597 goto queue_preds;
598 } else
599 --I;
600
601check_block:
602 Visited.insert(MBB);
603 if (I == MBB->end())
604 goto queue_preds;
605
606 CheckPreds = true;
607 for (MachineBasicBlock::iterator IE = MBB->begin();; --I) {
608 unsigned Opc = I->getOpcode();
Hal Finkel0859ef22013-05-20 16:08:37 +0000609 if (Opc == PPC::MTCTRloop || Opc == PPC::MTCTR8loop) {
Hal Finkel8ca38842013-05-20 16:08:17 +0000610 CheckPreds = false;
611 break;
612 }
613
614 if (I != BI && clobbersCTR(I)) {
615 DEBUG(dbgs() << "BB#" << MBB->getNumber() << " (" <<
616 MBB->getFullName() << ") instruction " << *I <<
617 " clobbers CTR, invalidating " << "BB#" <<
618 BI->getParent()->getNumber() << " (" <<
619 BI->getParent()->getFullName() << ") instruction " <<
620 *BI << "\n");
621 return false;
622 }
623
624 if (I == IE)
625 break;
626 }
627
628 if (!CheckPreds && Preds.empty())
629 return true;
630
631 if (CheckPreds) {
632queue_preds:
633 if (MachineFunction::iterator(MBB) == MBB->getParent()->begin()) {
634 DEBUG(dbgs() << "Unable to find a MTCTR instruction for BB#" <<
635 BI->getParent()->getNumber() << " (" <<
636 BI->getParent()->getFullName() << ") instruction " <<
637 *BI << "\n");
638 return false;
639 }
640
641 for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
642 PIE = MBB->pred_end(); PI != PIE; ++PI)
643 Preds.push_back(*PI);
644 }
645
646 do {
647 MBB = Preds.pop_back_val();
648 if (!Visited.count(MBB)) {
649 I = MBB->getLastNonDebugInstr();
650 goto check_block;
651 }
652 } while (!Preds.empty());
653
654 return true;
655}
656
657bool PPCCTRLoopsVerify::runOnMachineFunction(MachineFunction &MF) {
658 MDT = &getAnalysis<MachineDominatorTree>();
659
660 // Verify that all bdnz/bdz instructions are dominated by a loop mtctr before
661 // any other instructions that might clobber the ctr register.
662 for (MachineFunction::iterator I = MF.begin(), IE = MF.end();
663 I != IE; ++I) {
664 MachineBasicBlock *MBB = I;
665 if (!MDT->isReachableFromEntry(MBB))
666 continue;
667
668 for (MachineBasicBlock::iterator MII = MBB->getFirstTerminator(),
669 MIIE = MBB->end(); MII != MIIE; ++MII) {
670 unsigned Opc = MII->getOpcode();
671 if (Opc == PPC::BDNZ8 || Opc == PPC::BDNZ ||
672 Opc == PPC::BDZ8 || Opc == PPC::BDZ)
673 if (!verifyCTRBranch(MBB, MII))
674 llvm_unreachable("Invalid PPC CTR loop!");
675 }
676 }
677
678 return false;
679}
680#endif // NDEBUG
681