1 //===- ScopHelper.cpp - Some Helper Functions for Scop.  ------------------===//
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 // Small functions that help with Scop and LLVM-IR.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "polly/Support/ScopHelper.h"
15 #include "polly/Options.h"
16 #include "polly/ScopInfo.h"
17 #include "polly/Support/SCEVValidator.h"
18 #include "llvm/Analysis/LoopInfo.h"
19 #include "llvm/Analysis/RegionInfo.h"
20 #include "llvm/Analysis/ScalarEvolution.h"
21 #include "llvm/Analysis/ScalarEvolutionExpander.h"
22 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
23 #include "llvm/IR/CFG.h"
24 #include "llvm/IR/IntrinsicInst.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
27 
28 using namespace llvm;
29 using namespace polly;
30 
31 #define DEBUG_TYPE "polly-scop-helper"
32 
33 bool polly::hasInvokeEdge(const PHINode *PN) {
34   for (unsigned i = 0, e = PN->getNumIncomingValues(); i < e; ++i)
35     if (InvokeInst *II = dyn_cast<InvokeInst>(PN->getIncomingValue(i)))
36       if (II->getParent() == PN->getIncomingBlock(i))
37         return true;
38 
39   return false;
40 }
41 
42 // Ensures that there is just one predecessor to the entry node from outside the
43 // region.
44 // The identity of the region entry node is preserved.
45 static void simplifyRegionEntry(Region *R, DominatorTree *DT, LoopInfo *LI,
46                                 RegionInfo *RI) {
47   BasicBlock *EnteringBB = R->getEnteringBlock();
48   BasicBlock *Entry = R->getEntry();
49 
50   // Before (one of):
51   //
52   //                       \    /            //
53   //                      EnteringBB         //
54   //                        |    \------>    //
55   //   \   /                |                //
56   //   Entry <--\         Entry <--\         //
57   //   /   \    /         /   \    /         //
58   //        ....               ....          //
59 
60   // Create single entry edge if the region has multiple entry edges.
61   if (!EnteringBB) {
62     SmallVector<BasicBlock *, 4> Preds;
63     for (BasicBlock *P : predecessors(Entry))
64       if (!R->contains(P))
65         Preds.push_back(P);
66 
67     BasicBlock *NewEntering =
68         SplitBlockPredecessors(Entry, Preds, ".region_entering", DT, LI);
69 
70     if (RI) {
71       // The exit block of predecessing regions must be changed to NewEntering
72       for (BasicBlock *ExitPred : predecessors(NewEntering)) {
73         Region *RegionOfPred = RI->getRegionFor(ExitPred);
74         if (RegionOfPred->getExit() != Entry)
75           continue;
76 
77         while (!RegionOfPred->isTopLevelRegion() &&
78                RegionOfPred->getExit() == Entry) {
79           RegionOfPred->replaceExit(NewEntering);
80           RegionOfPred = RegionOfPred->getParent();
81         }
82       }
83 
84       // Make all ancestors use EnteringBB as entry; there might be edges to it
85       Region *AncestorR = R->getParent();
86       RI->setRegionFor(NewEntering, AncestorR);
87       while (!AncestorR->isTopLevelRegion() && AncestorR->getEntry() == Entry) {
88         AncestorR->replaceEntry(NewEntering);
89         AncestorR = AncestorR->getParent();
90       }
91     }
92 
93     EnteringBB = NewEntering;
94   }
95   assert(R->getEnteringBlock() == EnteringBB);
96 
97   // After:
98   //
99   //    \    /       //
100   //  EnteringBB     //
101   //      |          //
102   //      |          //
103   //    Entry <--\   //
104   //    /   \    /   //
105   //         ....    //
106 }
107 
108 // Ensure that the region has a single block that branches to the exit node.
109 static void simplifyRegionExit(Region *R, DominatorTree *DT, LoopInfo *LI,
110                                RegionInfo *RI) {
111   BasicBlock *ExitBB = R->getExit();
112   BasicBlock *ExitingBB = R->getExitingBlock();
113 
114   // Before:
115   //
116   //   (Region)   ______/  //
117   //      \  |   /         //
118   //       ExitBB          //
119   //       /    \          //
120 
121   if (!ExitingBB) {
122     SmallVector<BasicBlock *, 4> Preds;
123     for (BasicBlock *P : predecessors(ExitBB))
124       if (R->contains(P))
125         Preds.push_back(P);
126 
127     //  Preds[0] Preds[1]      otherBB //
128     //         \  |  ________/         //
129     //          \ | /                  //
130     //           BB                    //
131     ExitingBB =
132         SplitBlockPredecessors(ExitBB, Preds, ".region_exiting", DT, LI);
133     // Preds[0] Preds[1]      otherBB  //
134     //        \  /           /         //
135     // BB.region_exiting    /          //
136     //                  \  /           //
137     //                   BB            //
138 
139     if (RI)
140       RI->setRegionFor(ExitingBB, R);
141 
142     // Change the exit of nested regions, but not the region itself,
143     R->replaceExitRecursive(ExitingBB);
144     R->replaceExit(ExitBB);
145   }
146   assert(ExitingBB == R->getExitingBlock());
147 
148   // After:
149   //
150   //     \   /                //
151   //    ExitingBB     _____/  //
152   //          \      /        //
153   //           ExitBB         //
154   //           /    \         //
155 }
156 
157 void polly::simplifyRegion(Region *R, DominatorTree *DT, LoopInfo *LI,
158                            RegionInfo *RI) {
159   assert(R && !R->isTopLevelRegion());
160   assert(!RI || RI == R->getRegionInfo());
161   assert((!RI || DT) &&
162          "RegionInfo requires DominatorTree to be updated as well");
163 
164   simplifyRegionEntry(R, DT, LI, RI);
165   simplifyRegionExit(R, DT, LI, RI);
166   assert(R->isSimple());
167 }
168 
169 // Split the block into two successive blocks.
170 //
171 // Like llvm::SplitBlock, but also preserves RegionInfo
172 static BasicBlock *splitBlock(BasicBlock *Old, Instruction *SplitPt,
173                               DominatorTree *DT, llvm::LoopInfo *LI,
174                               RegionInfo *RI) {
175   assert(Old && SplitPt);
176 
177   // Before:
178   //
179   //  \   /  //
180   //   Old   //
181   //  /   \  //
182 
183   BasicBlock *NewBlock = llvm::SplitBlock(Old, SplitPt, DT, LI);
184 
185   if (RI) {
186     Region *R = RI->getRegionFor(Old);
187     RI->setRegionFor(NewBlock, R);
188   }
189 
190   // After:
191   //
192   //   \   /    //
193   //    Old     //
194   //     |      //
195   //  NewBlock  //
196   //   /   \    //
197 
198   return NewBlock;
199 }
200 
201 void polly::splitEntryBlockForAlloca(BasicBlock *EntryBlock, Pass *P) {
202   // Find first non-alloca instruction. Every basic block has a non-alloc
203   // instruction, as every well formed basic block has a terminator.
204   BasicBlock::iterator I = EntryBlock->begin();
205   while (isa<AllocaInst>(I))
206     ++I;
207 
208   auto *DTWP = P->getAnalysisIfAvailable<DominatorTreeWrapperPass>();
209   auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
210   auto *LIWP = P->getAnalysisIfAvailable<LoopInfoWrapperPass>();
211   auto *LI = LIWP ? &LIWP->getLoopInfo() : nullptr;
212   RegionInfoPass *RIP = P->getAnalysisIfAvailable<RegionInfoPass>();
213   RegionInfo *RI = RIP ? &RIP->getRegionInfo() : nullptr;
214 
215   // splitBlock updates DT, LI and RI.
216   splitBlock(EntryBlock, &*I, DT, LI, RI);
217 }
218 
219 /// The SCEVExpander will __not__ generate any code for an existing SDiv/SRem
220 /// instruction but just use it, if it is referenced as a SCEVUnknown. We want
221 /// however to generate new code if the instruction is in the analyzed region
222 /// and we generate code outside/in front of that region. Hence, we generate the
223 /// code for the SDiv/SRem operands in front of the analyzed region and then
224 /// create a new SDiv/SRem operation there too.
225 struct ScopExpander : SCEVVisitor<ScopExpander, const SCEV *> {
226   friend struct SCEVVisitor<ScopExpander, const SCEV *>;
227 
228   explicit ScopExpander(const Region &R, ScalarEvolution &SE,
229                         const DataLayout &DL, const char *Name, ValueMapT *VMap)
230       : Expander(SCEVExpander(SE, DL, Name)), SE(SE), Name(Name), R(R),
231         VMap(VMap) {}
232 
233   Value *expandCodeFor(const SCEV *E, Type *Ty, Instruction *I) {
234     // If we generate code in the region we will immediately fall back to the
235     // SCEVExpander, otherwise we will stop at all unknowns in the SCEV and if
236     // needed replace them by copies computed in the entering block.
237     if (!R.contains(I))
238       E = visit(E);
239     return Expander.expandCodeFor(E, Ty, I);
240   }
241 
242 private:
243   SCEVExpander Expander;
244   ScalarEvolution &SE;
245   const char *Name;
246   const Region &R;
247   ValueMapT *VMap;
248 
249   /// @brief Return the Value for @p E if it is not zero or else the value 1.
250   Value *selectOneIfZero(const SCEV *E, Instruction *IP) {
251     auto *Ty = E->getType();
252     auto *RHS = Expander.expandCodeFor(E, Ty, IP);
253     auto *Zero = ConstantInt::get(Ty, 0);
254     auto *Cond = new ICmpInst(IP, ICmpInst::ICMP_NE, RHS, Zero);
255     return SelectInst::Create(Cond, RHS, ConstantInt::get(Ty, 1), "", IP);
256   }
257 
258   const SCEV *visitUnknown(const SCEVUnknown *E) {
259 
260     // If a value mapping was given try if the underlying value is remapped.
261     Value *NewVal = VMap ? VMap->lookup(E->getValue()) : nullptr;
262     if (NewVal) {
263       auto *NewE = SE.getSCEV(NewVal);
264 
265       // While the mapped value might be different the SCEV representation might
266       // not be. To this end we will check before we go into recursion here.
267       if (E != NewE)
268         return visit(NewE);
269     }
270 
271     Instruction *Inst = dyn_cast<Instruction>(E->getValue());
272     if (!Inst || (Inst->getOpcode() != Instruction::SRem &&
273                   Inst->getOpcode() != Instruction::SDiv))
274       return E;
275 
276     if (!R.contains(Inst))
277       return E;
278 
279     Instruction *StartIP = R.getEnteringBlock()->getTerminator();
280 
281     const SCEV *LHSScev = visit(SE.getSCEV(Inst->getOperand(0)));
282     const SCEV *RHSScev = visit(SE.getSCEV(Inst->getOperand(1)));
283 
284     Value *LHS = Expander.expandCodeFor(LHSScev, E->getType(), StartIP);
285     Value *RHS = nullptr;
286     if (SE.isKnownNonZero(RHSScev))
287       RHS = Expander.expandCodeFor(RHSScev, E->getType(), StartIP);
288     else
289       RHS = selectOneIfZero(RHSScev, StartIP);
290 
291     Inst = BinaryOperator::Create((Instruction::BinaryOps)Inst->getOpcode(),
292                                   LHS, RHS, Inst->getName() + Name, StartIP);
293     return SE.getSCEV(Inst);
294   }
295 
296   /// The following functions will just traverse the SCEV and rebuild it with
297   /// the new operands returned by the traversal.
298   ///
299   ///{
300   const SCEV *visitConstant(const SCEVConstant *E) { return E; }
301   const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
302     return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
303   }
304   const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
305     return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
306   }
307   const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
308     return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
309   }
310   const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
311     if (SE.isKnownNonZero(E->getRHS()))
312       return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
313     auto *RHSScev = visit(E->getRHS());
314     auto *IP = R.getEnteringBlock()->getTerminator();
315     auto *RHS = selectOneIfZero(RHSScev, IP);
316     return SE.getUDivExpr(visit(E->getLHS()), SE.getSCEV(RHS));
317   }
318   const SCEV *visitAddExpr(const SCEVAddExpr *E) {
319     SmallVector<const SCEV *, 4> NewOps;
320     for (const SCEV *Op : E->operands())
321       NewOps.push_back(visit(Op));
322     return SE.getAddExpr(NewOps);
323   }
324   const SCEV *visitMulExpr(const SCEVMulExpr *E) {
325     SmallVector<const SCEV *, 4> NewOps;
326     for (const SCEV *Op : E->operands())
327       NewOps.push_back(visit(Op));
328     return SE.getMulExpr(NewOps);
329   }
330   const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
331     SmallVector<const SCEV *, 4> NewOps;
332     for (const SCEV *Op : E->operands())
333       NewOps.push_back(visit(Op));
334     return SE.getUMaxExpr(NewOps);
335   }
336   const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
337     SmallVector<const SCEV *, 4> NewOps;
338     for (const SCEV *Op : E->operands())
339       NewOps.push_back(visit(Op));
340     return SE.getSMaxExpr(NewOps);
341   }
342   const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
343     SmallVector<const SCEV *, 4> NewOps;
344     for (const SCEV *Op : E->operands())
345       NewOps.push_back(visit(Op));
346     return SE.getAddRecExpr(NewOps, E->getLoop(), E->getNoWrapFlags());
347   }
348   ///}
349 };
350 
351 Value *polly::expandCodeFor(Scop &S, ScalarEvolution &SE, const DataLayout &DL,
352                             const char *Name, const SCEV *E, Type *Ty,
353                             Instruction *IP, ValueMapT *VMap) {
354   ScopExpander Expander(S.getRegion(), SE, DL, Name, VMap);
355   return Expander.expandCodeFor(E, Ty, IP);
356 }
357 
358 bool polly::isErrorBlock(BasicBlock &BB, const Region &R, LoopInfo &LI,
359                          const DominatorTree &DT) {
360 
361   if (isa<UnreachableInst>(BB.getTerminator()))
362     return true;
363 
364   if (LI.isLoopHeader(&BB))
365     return false;
366 
367   // Basic blocks that are always executed are not considered error blocks,
368   // as their execution can not be a rare event.
369   bool DominatesAllPredecessors = true;
370   for (auto Pred : predecessors(R.getExit()))
371     if (R.contains(Pred) && !DT.dominates(&BB, Pred))
372       DominatesAllPredecessors = false;
373 
374   if (DominatesAllPredecessors)
375     return false;
376 
377   // FIXME: This is a simple heuristic to determine if the load is executed
378   //        in a conditional. However, we actually would need the control
379   //        condition, i.e., the post dominance frontier. Alternatively we
380   //        could walk up the dominance tree until we find a block that is
381   //        not post dominated by the load and check if it is a conditional
382   //        or a loop header.
383   auto *DTNode = DT.getNode(&BB);
384   auto *IDomBB = DTNode->getIDom()->getBlock();
385   if (LI.isLoopHeader(IDomBB))
386     return false;
387 
388   for (Instruction &Inst : BB)
389     if (CallInst *CI = dyn_cast<CallInst>(&Inst)) {
390       if (isIgnoredIntrinsic(CI))
391         return false;
392 
393       if (!CI->doesNotAccessMemory())
394         return true;
395       if (CI->doesNotReturn())
396         return true;
397     }
398 
399   return false;
400 }
401 
402 Value *polly::getConditionFromTerminator(TerminatorInst *TI) {
403   if (BranchInst *BR = dyn_cast<BranchInst>(TI)) {
404     if (BR->isUnconditional())
405       return ConstantInt::getTrue(Type::getInt1Ty(TI->getContext()));
406 
407     return BR->getCondition();
408   }
409 
410   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
411     return SI->getCondition();
412 
413   return nullptr;
414 }
415 
416 bool polly::isHoistableLoad(LoadInst *LInst, Region &R, LoopInfo &LI,
417                             ScalarEvolution &SE) {
418   Loop *L = LI.getLoopFor(LInst->getParent());
419   const SCEV *PtrSCEV = SE.getSCEVAtScope(LInst->getPointerOperand(), L);
420   while (L && R.contains(L)) {
421     if (!SE.isLoopInvariant(PtrSCEV, L))
422       return false;
423     L = L->getParentLoop();
424   }
425 
426   return true;
427 }
428 
429 bool polly::isIgnoredIntrinsic(const Value *V) {
430   if (auto *IT = dyn_cast<IntrinsicInst>(V)) {
431     switch (IT->getIntrinsicID()) {
432     // Lifetime markers are supported/ignored.
433     case llvm::Intrinsic::lifetime_start:
434     case llvm::Intrinsic::lifetime_end:
435     // Invariant markers are supported/ignored.
436     case llvm::Intrinsic::invariant_start:
437     case llvm::Intrinsic::invariant_end:
438     // Some misc annotations are supported/ignored.
439     case llvm::Intrinsic::var_annotation:
440     case llvm::Intrinsic::ptr_annotation:
441     case llvm::Intrinsic::annotation:
442     case llvm::Intrinsic::donothing:
443     case llvm::Intrinsic::assume:
444     case llvm::Intrinsic::expect:
445     // Some debug info intrisics are supported/ignored.
446     case llvm::Intrinsic::dbg_value:
447     case llvm::Intrinsic::dbg_declare:
448       return true;
449     default:
450       break;
451     }
452   }
453   return false;
454 }
455 
456 bool polly::canSynthesize(const Value *V, const llvm::LoopInfo *LI,
457                           ScalarEvolution *SE, const Region *R, Loop *Scope) {
458   if (!V || !SE->isSCEVable(V->getType()))
459     return false;
460 
461   if (const SCEV *Scev = SE->getSCEVAtScope(const_cast<Value *>(V), Scope))
462     if (!isa<SCEVCouldNotCompute>(Scev))
463       if (!hasScalarDepsInsideRegion(Scev, R, Scope, false))
464         return true;
465 
466   return false;
467 }
468 
469 llvm::BasicBlock *polly::getUseBlock(llvm::Use &U) {
470   Instruction *UI = dyn_cast<Instruction>(U.getUser());
471   if (!UI)
472     return nullptr;
473 
474   if (PHINode *PHI = dyn_cast<PHINode>(UI))
475     return PHI->getIncomingBlock(U);
476 
477   return UI->getParent();
478 }
479