1 //===- Scalarizer.cpp - Scalarize vector operations -----------------------===//
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 converts vector operations into scalar operations, in order
11 // to expose optimization opportunities on the individual scalar operations.
12 // It is mainly intended for targets that do not have vector units, but it
13 // may also be useful for revectorizing code to different vector widths.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #include "llvm/ADT/PostOrderIterator.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/Twine.h"
20 #include "llvm/Analysis/VectorUtils.h"
21 #include "llvm/IR/Argument.h"
22 #include "llvm/IR/BasicBlock.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/DerivedTypes.h"
26 #include "llvm/IR/Function.h"
27 #include "llvm/IR/IRBuilder.h"
28 #include "llvm/IR/InstVisitor.h"
29 #include "llvm/IR/InstrTypes.h"
30 #include "llvm/IR/Instruction.h"
31 #include "llvm/IR/Instructions.h"
32 #include "llvm/IR/Intrinsics.h"
33 #include "llvm/IR/LLVMContext.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/IR/Type.h"
36 #include "llvm/IR/Value.h"
37 #include "llvm/Pass.h"
38 #include "llvm/Support/Casting.h"
39 #include "llvm/Support/MathExtras.h"
40 #include "llvm/Support/Options.h"
41 #include "llvm/Transforms/Scalar.h"
42 #include "llvm/Transforms/Scalar/Scalarizer.h"
43 #include <cassert>
44 #include <cstdint>
45 #include <iterator>
46 #include <map>
47 #include <utility>
48 
49 using namespace llvm;
50 
51 #define DEBUG_TYPE "scalarizer"
52 
53 // This is disabled by default because having separate loads and stores
54 // makes it more likely that the -combiner-alias-analysis limits will be
55 // reached.
56 static cl::opt<bool>
57     ScalarizeLoadStore("scalarize-load-store", cl::init(false), cl::Hidden,
58                        cl::desc("Allow the scalarizer pass to scalarize loads and store"));
59 
60 namespace {
61 
62 // Used to store the scattered form of a vector.
63 using ValueVector = SmallVector<Value *, 8>;
64 
65 // Used to map a vector Value to its scattered form.  We use std::map
66 // because we want iterators to persist across insertion and because the
67 // values are relatively large.
68 using ScatterMap = std::map<Value *, ValueVector>;
69 
70 // Lists Instructions that have been replaced with scalar implementations,
71 // along with a pointer to their scattered forms.
72 using GatherList = SmallVector<std::pair<Instruction *, ValueVector *>, 16>;
73 
74 // Provides a very limited vector-like interface for lazily accessing one
75 // component of a scattered vector or vector pointer.
76 class Scatterer {
77 public:
78   Scatterer() = default;
79 
80   // Scatter V into Size components.  If new instructions are needed,
81   // insert them before BBI in BB.  If Cache is nonnull, use it to cache
82   // the results.
83   Scatterer(BasicBlock *bb, BasicBlock::iterator bbi, Value *v,
84             ValueVector *cachePtr = nullptr);
85 
86   // Return component I, creating a new Value for it if necessary.
87   Value *operator[](unsigned I);
88 
89   // Return the number of components.
90   unsigned size() const { return Size; }
91 
92 private:
93   BasicBlock *BB;
94   BasicBlock::iterator BBI;
95   Value *V;
96   ValueVector *CachePtr;
97   PointerType *PtrTy;
98   ValueVector Tmp;
99   unsigned Size;
100 };
101 
102 // FCmpSpliiter(FCI)(Builder, X, Y, Name) uses Builder to create an FCmp
103 // called Name that compares X and Y in the same way as FCI.
104 struct FCmpSplitter {
105   FCmpSplitter(FCmpInst &fci) : FCI(fci) {}
106 
107   Value *operator()(IRBuilder<> &Builder, Value *Op0, Value *Op1,
108                     const Twine &Name) const {
109     return Builder.CreateFCmp(FCI.getPredicate(), Op0, Op1, Name);
110   }
111 
112   FCmpInst &FCI;
113 };
114 
115 // ICmpSpliiter(ICI)(Builder, X, Y, Name) uses Builder to create an ICmp
116 // called Name that compares X and Y in the same way as ICI.
117 struct ICmpSplitter {
118   ICmpSplitter(ICmpInst &ici) : ICI(ici) {}
119 
120   Value *operator()(IRBuilder<> &Builder, Value *Op0, Value *Op1,
121                     const Twine &Name) const {
122     return Builder.CreateICmp(ICI.getPredicate(), Op0, Op1, Name);
123   }
124 
125   ICmpInst &ICI;
126 };
127 
128 // BinarySpliiter(BO)(Builder, X, Y, Name) uses Builder to create
129 // a binary operator like BO called Name with operands X and Y.
130 struct BinarySplitter {
131   BinarySplitter(BinaryOperator &bo) : BO(bo) {}
132 
133   Value *operator()(IRBuilder<> &Builder, Value *Op0, Value *Op1,
134                     const Twine &Name) const {
135     return Builder.CreateBinOp(BO.getOpcode(), Op0, Op1, Name);
136   }
137 
138   BinaryOperator &BO;
139 };
140 
141 // Information about a load or store that we're scalarizing.
142 struct VectorLayout {
143   VectorLayout() = default;
144 
145   // Return the alignment of element I.
146   uint64_t getElemAlign(unsigned I) {
147     return MinAlign(VecAlign, I * ElemSize);
148   }
149 
150   // The type of the vector.
151   VectorType *VecTy = nullptr;
152 
153   // The type of each element.
154   Type *ElemTy = nullptr;
155 
156   // The alignment of the vector.
157   uint64_t VecAlign = 0;
158 
159   // The size of each element.
160   uint64_t ElemSize = 0;
161 };
162 
163 class ScalarizerVisitor : public InstVisitor<ScalarizerVisitor, bool> {
164 public:
165   ScalarizerVisitor(unsigned ParallelLoopAccessMDKind)
166     : ParallelLoopAccessMDKind(ParallelLoopAccessMDKind) {
167   }
168 
169   bool visit(Function &F);
170 
171   // InstVisitor methods.  They return true if the instruction was scalarized,
172   // false if nothing changed.
173   bool visitInstruction(Instruction &I) { return false; }
174   bool visitSelectInst(SelectInst &SI);
175   bool visitICmpInst(ICmpInst &ICI);
176   bool visitFCmpInst(FCmpInst &FCI);
177   bool visitBinaryOperator(BinaryOperator &BO);
178   bool visitGetElementPtrInst(GetElementPtrInst &GEPI);
179   bool visitCastInst(CastInst &CI);
180   bool visitBitCastInst(BitCastInst &BCI);
181   bool visitShuffleVectorInst(ShuffleVectorInst &SVI);
182   bool visitPHINode(PHINode &PHI);
183   bool visitLoadInst(LoadInst &LI);
184   bool visitStoreInst(StoreInst &SI);
185   bool visitCallInst(CallInst &ICI);
186 
187 private:
188   Scatterer scatter(Instruction *Point, Value *V);
189   void gather(Instruction *Op, const ValueVector &CV);
190   bool canTransferMetadata(unsigned Kind);
191   void transferMetadata(Instruction *Op, const ValueVector &CV);
192   bool getVectorLayout(Type *Ty, unsigned Alignment, VectorLayout &Layout,
193                        const DataLayout &DL);
194   bool finish();
195 
196   template<typename T> bool splitBinary(Instruction &, const T &);
197 
198   bool splitCall(CallInst &CI);
199 
200   ScatterMap Scattered;
201   GatherList Gathered;
202 
203   unsigned ParallelLoopAccessMDKind;
204 };
205 
206 class ScalarizerLegacyPass : public FunctionPass {
207 public:
208   static char ID;
209 
210   ScalarizerLegacyPass() : FunctionPass(ID) {
211     initializeScalarizerLegacyPassPass(*PassRegistry::getPassRegistry());
212   }
213 
214   bool runOnFunction(Function &F) override;
215 };
216 
217 } // end anonymous namespace
218 
219 char ScalarizerLegacyPass::ID = 0;
220 INITIALIZE_PASS_BEGIN(ScalarizerLegacyPass, "scalarizer",
221                       "Scalarize vector operations", false, false)
222 INITIALIZE_PASS_END(ScalarizerLegacyPass, "scalarizer",
223                     "Scalarize vector operations", false, false)
224 
225 Scatterer::Scatterer(BasicBlock *bb, BasicBlock::iterator bbi, Value *v,
226                      ValueVector *cachePtr)
227   : BB(bb), BBI(bbi), V(v), CachePtr(cachePtr) {
228   Type *Ty = V->getType();
229   PtrTy = dyn_cast<PointerType>(Ty);
230   if (PtrTy)
231     Ty = PtrTy->getElementType();
232   Size = Ty->getVectorNumElements();
233   if (!CachePtr)
234     Tmp.resize(Size, nullptr);
235   else if (CachePtr->empty())
236     CachePtr->resize(Size, nullptr);
237   else
238     assert(Size == CachePtr->size() && "Inconsistent vector sizes");
239 }
240 
241 // Return component I, creating a new Value for it if necessary.
242 Value *Scatterer::operator[](unsigned I) {
243   ValueVector &CV = (CachePtr ? *CachePtr : Tmp);
244   // Try to reuse a previous value.
245   if (CV[I])
246     return CV[I];
247   IRBuilder<> Builder(BB, BBI);
248   if (PtrTy) {
249     if (!CV[0]) {
250       Type *Ty =
251         PointerType::get(PtrTy->getElementType()->getVectorElementType(),
252                          PtrTy->getAddressSpace());
253       CV[0] = Builder.CreateBitCast(V, Ty, V->getName() + ".i0");
254     }
255     if (I != 0)
256       CV[I] = Builder.CreateConstGEP1_32(nullptr, CV[0], I,
257                                          V->getName() + ".i" + Twine(I));
258   } else {
259     // Search through a chain of InsertElementInsts looking for element I.
260     // Record other elements in the cache.  The new V is still suitable
261     // for all uncached indices.
262     while (true) {
263       InsertElementInst *Insert = dyn_cast<InsertElementInst>(V);
264       if (!Insert)
265         break;
266       ConstantInt *Idx = dyn_cast<ConstantInt>(Insert->getOperand(2));
267       if (!Idx)
268         break;
269       unsigned J = Idx->getZExtValue();
270       V = Insert->getOperand(0);
271       if (I == J) {
272         CV[J] = Insert->getOperand(1);
273         return CV[J];
274       } else if (!CV[J]) {
275         // Only cache the first entry we find for each index we're not actively
276         // searching for. This prevents us from going too far up the chain and
277         // caching incorrect entries.
278         CV[J] = Insert->getOperand(1);
279       }
280     }
281     CV[I] = Builder.CreateExtractElement(V, Builder.getInt32(I),
282                                          V->getName() + ".i" + Twine(I));
283   }
284   return CV[I];
285 }
286 
287 bool ScalarizerLegacyPass::runOnFunction(Function &F) {
288   if (skipFunction(F))
289     return false;
290 
291   Module &M = *F.getParent();
292   unsigned ParallelLoopAccessMDKind =
293       M.getContext().getMDKindID("llvm.mem.parallel_loop_access");
294   ScalarizerVisitor Impl(ParallelLoopAccessMDKind);
295   return Impl.visit(F);
296 }
297 
298 FunctionPass *llvm::createScalarizerPass() {
299   return new ScalarizerLegacyPass();
300 }
301 
302 bool ScalarizerVisitor::visit(Function &F) {
303   assert(Gathered.empty() && Scattered.empty());
304 
305   // To ensure we replace gathered components correctly we need to do an ordered
306   // traversal of the basic blocks in the function.
307   ReversePostOrderTraversal<BasicBlock *> RPOT(&F.getEntryBlock());
308   for (BasicBlock *BB : RPOT) {
309     for (BasicBlock::iterator II = BB->begin(), IE = BB->end(); II != IE;) {
310       Instruction *I = &*II;
311       bool Done = InstVisitor::visit(I);
312       ++II;
313       if (Done && I->getType()->isVoidTy())
314         I->eraseFromParent();
315     }
316   }
317   return finish();
318 }
319 
320 // Return a scattered form of V that can be accessed by Point.  V must be a
321 // vector or a pointer to a vector.
322 Scatterer ScalarizerVisitor::scatter(Instruction *Point, Value *V) {
323   if (Argument *VArg = dyn_cast<Argument>(V)) {
324     // Put the scattered form of arguments in the entry block,
325     // so that it can be used everywhere.
326     Function *F = VArg->getParent();
327     BasicBlock *BB = &F->getEntryBlock();
328     return Scatterer(BB, BB->begin(), V, &Scattered[V]);
329   }
330   if (Instruction *VOp = dyn_cast<Instruction>(V)) {
331     // Put the scattered form of an instruction directly after the
332     // instruction.
333     BasicBlock *BB = VOp->getParent();
334     return Scatterer(BB, std::next(BasicBlock::iterator(VOp)),
335                      V, &Scattered[V]);
336   }
337   // In the fallback case, just put the scattered before Point and
338   // keep the result local to Point.
339   return Scatterer(Point->getParent(), Point->getIterator(), V);
340 }
341 
342 // Replace Op with the gathered form of the components in CV.  Defer the
343 // deletion of Op and creation of the gathered form to the end of the pass,
344 // so that we can avoid creating the gathered form if all uses of Op are
345 // replaced with uses of CV.
346 void ScalarizerVisitor::gather(Instruction *Op, const ValueVector &CV) {
347   // Since we're not deleting Op yet, stub out its operands, so that it
348   // doesn't make anything live unnecessarily.
349   for (unsigned I = 0, E = Op->getNumOperands(); I != E; ++I)
350     Op->setOperand(I, UndefValue::get(Op->getOperand(I)->getType()));
351 
352   transferMetadata(Op, CV);
353 
354   // If we already have a scattered form of Op (created from ExtractElements
355   // of Op itself), replace them with the new form.
356   ValueVector &SV = Scattered[Op];
357   if (!SV.empty()) {
358     for (unsigned I = 0, E = SV.size(); I != E; ++I) {
359       Value *V = SV[I];
360       if (V == nullptr)
361         continue;
362 
363       Instruction *Old = cast<Instruction>(V);
364       CV[I]->takeName(Old);
365       Old->replaceAllUsesWith(CV[I]);
366       Old->eraseFromParent();
367     }
368   }
369   SV = CV;
370   Gathered.push_back(GatherList::value_type(Op, &SV));
371 }
372 
373 // Return true if it is safe to transfer the given metadata tag from
374 // vector to scalar instructions.
375 bool ScalarizerVisitor::canTransferMetadata(unsigned Tag) {
376   return (Tag == LLVMContext::MD_tbaa
377           || Tag == LLVMContext::MD_fpmath
378           || Tag == LLVMContext::MD_tbaa_struct
379           || Tag == LLVMContext::MD_invariant_load
380           || Tag == LLVMContext::MD_alias_scope
381           || Tag == LLVMContext::MD_noalias
382           || Tag == ParallelLoopAccessMDKind);
383 }
384 
385 // Transfer metadata from Op to the instructions in CV if it is known
386 // to be safe to do so.
387 void ScalarizerVisitor::transferMetadata(Instruction *Op, const ValueVector &CV) {
388   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
389   Op->getAllMetadataOtherThanDebugLoc(MDs);
390   for (unsigned I = 0, E = CV.size(); I != E; ++I) {
391     if (Instruction *New = dyn_cast<Instruction>(CV[I])) {
392       for (const auto &MD : MDs)
393         if (canTransferMetadata(MD.first))
394           New->setMetadata(MD.first, MD.second);
395       if (Op->getDebugLoc() && !New->getDebugLoc())
396         New->setDebugLoc(Op->getDebugLoc());
397     }
398   }
399 }
400 
401 // Try to fill in Layout from Ty, returning true on success.  Alignment is
402 // the alignment of the vector, or 0 if the ABI default should be used.
403 bool ScalarizerVisitor::getVectorLayout(Type *Ty, unsigned Alignment,
404                                  VectorLayout &Layout, const DataLayout &DL) {
405   // Make sure we're dealing with a vector.
406   Layout.VecTy = dyn_cast<VectorType>(Ty);
407   if (!Layout.VecTy)
408     return false;
409 
410   // Check that we're dealing with full-byte elements.
411   Layout.ElemTy = Layout.VecTy->getElementType();
412   if (DL.getTypeSizeInBits(Layout.ElemTy) !=
413       DL.getTypeStoreSizeInBits(Layout.ElemTy))
414     return false;
415 
416   if (Alignment)
417     Layout.VecAlign = Alignment;
418   else
419     Layout.VecAlign = DL.getABITypeAlignment(Layout.VecTy);
420   Layout.ElemSize = DL.getTypeStoreSize(Layout.ElemTy);
421   return true;
422 }
423 
424 // Scalarize two-operand instruction I, using Split(Builder, X, Y, Name)
425 // to create an instruction like I with operands X and Y and name Name.
426 template<typename Splitter>
427 bool ScalarizerVisitor::splitBinary(Instruction &I, const Splitter &Split) {
428   VectorType *VT = dyn_cast<VectorType>(I.getType());
429   if (!VT)
430     return false;
431 
432   unsigned NumElems = VT->getNumElements();
433   IRBuilder<> Builder(&I);
434   Scatterer Op0 = scatter(&I, I.getOperand(0));
435   Scatterer Op1 = scatter(&I, I.getOperand(1));
436   assert(Op0.size() == NumElems && "Mismatched binary operation");
437   assert(Op1.size() == NumElems && "Mismatched binary operation");
438   ValueVector Res;
439   Res.resize(NumElems);
440   for (unsigned Elem = 0; Elem < NumElems; ++Elem)
441     Res[Elem] = Split(Builder, Op0[Elem], Op1[Elem],
442                       I.getName() + ".i" + Twine(Elem));
443   gather(&I, Res);
444   return true;
445 }
446 
447 static bool isTriviallyScalariable(Intrinsic::ID ID) {
448   return isTriviallyVectorizable(ID);
449 }
450 
451 // All of the current scalarizable intrinsics only have one mangled type.
452 static Function *getScalarIntrinsicDeclaration(Module *M,
453                                                Intrinsic::ID ID,
454                                                VectorType *Ty) {
455   return Intrinsic::getDeclaration(M, ID, { Ty->getScalarType() });
456 }
457 
458 /// If a call to a vector typed intrinsic function, split into a scalar call per
459 /// element if possible for the intrinsic.
460 bool ScalarizerVisitor::splitCall(CallInst &CI) {
461   VectorType *VT = dyn_cast<VectorType>(CI.getType());
462   if (!VT)
463     return false;
464 
465   Function *F = CI.getCalledFunction();
466   if (!F)
467     return false;
468 
469   Intrinsic::ID ID = F->getIntrinsicID();
470   if (ID == Intrinsic::not_intrinsic || !isTriviallyScalariable(ID))
471     return false;
472 
473   unsigned NumElems = VT->getNumElements();
474   unsigned NumArgs = CI.getNumArgOperands();
475 
476   ValueVector ScalarOperands(NumArgs);
477   SmallVector<Scatterer, 8> Scattered(NumArgs);
478 
479   Scattered.resize(NumArgs);
480 
481   // Assumes that any vector type has the same number of elements as the return
482   // vector type, which is true for all current intrinsics.
483   for (unsigned I = 0; I != NumArgs; ++I) {
484     Value *OpI = CI.getOperand(I);
485     if (OpI->getType()->isVectorTy()) {
486       Scattered[I] = scatter(&CI, OpI);
487       assert(Scattered[I].size() == NumElems && "mismatched call operands");
488     } else {
489       ScalarOperands[I] = OpI;
490     }
491   }
492 
493   ValueVector Res(NumElems);
494   ValueVector ScalarCallOps(NumArgs);
495 
496   Function *NewIntrin = getScalarIntrinsicDeclaration(F->getParent(), ID, VT);
497   IRBuilder<> Builder(&CI);
498 
499   // Perform actual scalarization, taking care to preserve any scalar operands.
500   for (unsigned Elem = 0; Elem < NumElems; ++Elem) {
501     ScalarCallOps.clear();
502 
503     for (unsigned J = 0; J != NumArgs; ++J) {
504       if (hasVectorInstrinsicScalarOpd(ID, J))
505         ScalarCallOps.push_back(ScalarOperands[J]);
506       else
507         ScalarCallOps.push_back(Scattered[J][Elem]);
508     }
509 
510     Res[Elem] = Builder.CreateCall(NewIntrin, ScalarCallOps,
511                                    CI.getName() + ".i" + Twine(Elem));
512   }
513 
514   gather(&CI, Res);
515   return true;
516 }
517 
518 bool ScalarizerVisitor::visitSelectInst(SelectInst &SI) {
519   VectorType *VT = dyn_cast<VectorType>(SI.getType());
520   if (!VT)
521     return false;
522 
523   unsigned NumElems = VT->getNumElements();
524   IRBuilder<> Builder(&SI);
525   Scatterer Op1 = scatter(&SI, SI.getOperand(1));
526   Scatterer Op2 = scatter(&SI, SI.getOperand(2));
527   assert(Op1.size() == NumElems && "Mismatched select");
528   assert(Op2.size() == NumElems && "Mismatched select");
529   ValueVector Res;
530   Res.resize(NumElems);
531 
532   if (SI.getOperand(0)->getType()->isVectorTy()) {
533     Scatterer Op0 = scatter(&SI, SI.getOperand(0));
534     assert(Op0.size() == NumElems && "Mismatched select");
535     for (unsigned I = 0; I < NumElems; ++I)
536       Res[I] = Builder.CreateSelect(Op0[I], Op1[I], Op2[I],
537                                     SI.getName() + ".i" + Twine(I));
538   } else {
539     Value *Op0 = SI.getOperand(0);
540     for (unsigned I = 0; I < NumElems; ++I)
541       Res[I] = Builder.CreateSelect(Op0, Op1[I], Op2[I],
542                                     SI.getName() + ".i" + Twine(I));
543   }
544   gather(&SI, Res);
545   return true;
546 }
547 
548 bool ScalarizerVisitor::visitICmpInst(ICmpInst &ICI) {
549   return splitBinary(ICI, ICmpSplitter(ICI));
550 }
551 
552 bool ScalarizerVisitor::visitFCmpInst(FCmpInst &FCI) {
553   return splitBinary(FCI, FCmpSplitter(FCI));
554 }
555 
556 bool ScalarizerVisitor::visitBinaryOperator(BinaryOperator &BO) {
557   return splitBinary(BO, BinarySplitter(BO));
558 }
559 
560 bool ScalarizerVisitor::visitGetElementPtrInst(GetElementPtrInst &GEPI) {
561   VectorType *VT = dyn_cast<VectorType>(GEPI.getType());
562   if (!VT)
563     return false;
564 
565   IRBuilder<> Builder(&GEPI);
566   unsigned NumElems = VT->getNumElements();
567   unsigned NumIndices = GEPI.getNumIndices();
568 
569   // The base pointer might be scalar even if it's a vector GEP. In those cases,
570   // splat the pointer into a vector value, and scatter that vector.
571   Value *Op0 = GEPI.getOperand(0);
572   if (!Op0->getType()->isVectorTy())
573     Op0 = Builder.CreateVectorSplat(NumElems, Op0);
574   Scatterer Base = scatter(&GEPI, Op0);
575 
576   SmallVector<Scatterer, 8> Ops;
577   Ops.resize(NumIndices);
578   for (unsigned I = 0; I < NumIndices; ++I) {
579     Value *Op = GEPI.getOperand(I + 1);
580 
581     // The indices might be scalars even if it's a vector GEP. In those cases,
582     // splat the scalar into a vector value, and scatter that vector.
583     if (!Op->getType()->isVectorTy())
584       Op = Builder.CreateVectorSplat(NumElems, Op);
585 
586     Ops[I] = scatter(&GEPI, Op);
587   }
588 
589   ValueVector Res;
590   Res.resize(NumElems);
591   for (unsigned I = 0; I < NumElems; ++I) {
592     SmallVector<Value *, 8> Indices;
593     Indices.resize(NumIndices);
594     for (unsigned J = 0; J < NumIndices; ++J)
595       Indices[J] = Ops[J][I];
596     Res[I] = Builder.CreateGEP(GEPI.getSourceElementType(), Base[I], Indices,
597                                GEPI.getName() + ".i" + Twine(I));
598     if (GEPI.isInBounds())
599       if (GetElementPtrInst *NewGEPI = dyn_cast<GetElementPtrInst>(Res[I]))
600         NewGEPI->setIsInBounds();
601   }
602   gather(&GEPI, Res);
603   return true;
604 }
605 
606 bool ScalarizerVisitor::visitCastInst(CastInst &CI) {
607   VectorType *VT = dyn_cast<VectorType>(CI.getDestTy());
608   if (!VT)
609     return false;
610 
611   unsigned NumElems = VT->getNumElements();
612   IRBuilder<> Builder(&CI);
613   Scatterer Op0 = scatter(&CI, CI.getOperand(0));
614   assert(Op0.size() == NumElems && "Mismatched cast");
615   ValueVector Res;
616   Res.resize(NumElems);
617   for (unsigned I = 0; I < NumElems; ++I)
618     Res[I] = Builder.CreateCast(CI.getOpcode(), Op0[I], VT->getElementType(),
619                                 CI.getName() + ".i" + Twine(I));
620   gather(&CI, Res);
621   return true;
622 }
623 
624 bool ScalarizerVisitor::visitBitCastInst(BitCastInst &BCI) {
625   VectorType *DstVT = dyn_cast<VectorType>(BCI.getDestTy());
626   VectorType *SrcVT = dyn_cast<VectorType>(BCI.getSrcTy());
627   if (!DstVT || !SrcVT)
628     return false;
629 
630   unsigned DstNumElems = DstVT->getNumElements();
631   unsigned SrcNumElems = SrcVT->getNumElements();
632   IRBuilder<> Builder(&BCI);
633   Scatterer Op0 = scatter(&BCI, BCI.getOperand(0));
634   ValueVector Res;
635   Res.resize(DstNumElems);
636 
637   if (DstNumElems == SrcNumElems) {
638     for (unsigned I = 0; I < DstNumElems; ++I)
639       Res[I] = Builder.CreateBitCast(Op0[I], DstVT->getElementType(),
640                                      BCI.getName() + ".i" + Twine(I));
641   } else if (DstNumElems > SrcNumElems) {
642     // <M x t1> -> <N*M x t2>.  Convert each t1 to <N x t2> and copy the
643     // individual elements to the destination.
644     unsigned FanOut = DstNumElems / SrcNumElems;
645     Type *MidTy = VectorType::get(DstVT->getElementType(), FanOut);
646     unsigned ResI = 0;
647     for (unsigned Op0I = 0; Op0I < SrcNumElems; ++Op0I) {
648       Value *V = Op0[Op0I];
649       Instruction *VI;
650       // Look through any existing bitcasts before converting to <N x t2>.
651       // In the best case, the resulting conversion might be a no-op.
652       while ((VI = dyn_cast<Instruction>(V)) &&
653              VI->getOpcode() == Instruction::BitCast)
654         V = VI->getOperand(0);
655       V = Builder.CreateBitCast(V, MidTy, V->getName() + ".cast");
656       Scatterer Mid = scatter(&BCI, V);
657       for (unsigned MidI = 0; MidI < FanOut; ++MidI)
658         Res[ResI++] = Mid[MidI];
659     }
660   } else {
661     // <N*M x t1> -> <M x t2>.  Convert each group of <N x t1> into a t2.
662     unsigned FanIn = SrcNumElems / DstNumElems;
663     Type *MidTy = VectorType::get(SrcVT->getElementType(), FanIn);
664     unsigned Op0I = 0;
665     for (unsigned ResI = 0; ResI < DstNumElems; ++ResI) {
666       Value *V = UndefValue::get(MidTy);
667       for (unsigned MidI = 0; MidI < FanIn; ++MidI)
668         V = Builder.CreateInsertElement(V, Op0[Op0I++], Builder.getInt32(MidI),
669                                         BCI.getName() + ".i" + Twine(ResI)
670                                         + ".upto" + Twine(MidI));
671       Res[ResI] = Builder.CreateBitCast(V, DstVT->getElementType(),
672                                         BCI.getName() + ".i" + Twine(ResI));
673     }
674   }
675   gather(&BCI, Res);
676   return true;
677 }
678 
679 bool ScalarizerVisitor::visitShuffleVectorInst(ShuffleVectorInst &SVI) {
680   VectorType *VT = dyn_cast<VectorType>(SVI.getType());
681   if (!VT)
682     return false;
683 
684   unsigned NumElems = VT->getNumElements();
685   Scatterer Op0 = scatter(&SVI, SVI.getOperand(0));
686   Scatterer Op1 = scatter(&SVI, SVI.getOperand(1));
687   ValueVector Res;
688   Res.resize(NumElems);
689 
690   for (unsigned I = 0; I < NumElems; ++I) {
691     int Selector = SVI.getMaskValue(I);
692     if (Selector < 0)
693       Res[I] = UndefValue::get(VT->getElementType());
694     else if (unsigned(Selector) < Op0.size())
695       Res[I] = Op0[Selector];
696     else
697       Res[I] = Op1[Selector - Op0.size()];
698   }
699   gather(&SVI, Res);
700   return true;
701 }
702 
703 bool ScalarizerVisitor::visitPHINode(PHINode &PHI) {
704   VectorType *VT = dyn_cast<VectorType>(PHI.getType());
705   if (!VT)
706     return false;
707 
708   unsigned NumElems = VT->getNumElements();
709   IRBuilder<> Builder(&PHI);
710   ValueVector Res;
711   Res.resize(NumElems);
712 
713   unsigned NumOps = PHI.getNumOperands();
714   for (unsigned I = 0; I < NumElems; ++I)
715     Res[I] = Builder.CreatePHI(VT->getElementType(), NumOps,
716                                PHI.getName() + ".i" + Twine(I));
717 
718   for (unsigned I = 0; I < NumOps; ++I) {
719     Scatterer Op = scatter(&PHI, PHI.getIncomingValue(I));
720     BasicBlock *IncomingBlock = PHI.getIncomingBlock(I);
721     for (unsigned J = 0; J < NumElems; ++J)
722       cast<PHINode>(Res[J])->addIncoming(Op[J], IncomingBlock);
723   }
724   gather(&PHI, Res);
725   return true;
726 }
727 
728 bool ScalarizerVisitor::visitLoadInst(LoadInst &LI) {
729   if (!ScalarizeLoadStore)
730     return false;
731   if (!LI.isSimple())
732     return false;
733 
734   VectorLayout Layout;
735   if (!getVectorLayout(LI.getType(), LI.getAlignment(), Layout,
736                        LI.getModule()->getDataLayout()))
737     return false;
738 
739   unsigned NumElems = Layout.VecTy->getNumElements();
740   IRBuilder<> Builder(&LI);
741   Scatterer Ptr = scatter(&LI, LI.getPointerOperand());
742   ValueVector Res;
743   Res.resize(NumElems);
744 
745   for (unsigned I = 0; I < NumElems; ++I)
746     Res[I] = Builder.CreateAlignedLoad(Ptr[I], Layout.getElemAlign(I),
747                                        LI.getName() + ".i" + Twine(I));
748   gather(&LI, Res);
749   return true;
750 }
751 
752 bool ScalarizerVisitor::visitStoreInst(StoreInst &SI) {
753   if (!ScalarizeLoadStore)
754     return false;
755   if (!SI.isSimple())
756     return false;
757 
758   VectorLayout Layout;
759   Value *FullValue = SI.getValueOperand();
760   if (!getVectorLayout(FullValue->getType(), SI.getAlignment(), Layout,
761                        SI.getModule()->getDataLayout()))
762     return false;
763 
764   unsigned NumElems = Layout.VecTy->getNumElements();
765   IRBuilder<> Builder(&SI);
766   Scatterer Ptr = scatter(&SI, SI.getPointerOperand());
767   Scatterer Val = scatter(&SI, FullValue);
768 
769   ValueVector Stores;
770   Stores.resize(NumElems);
771   for (unsigned I = 0; I < NumElems; ++I) {
772     unsigned Align = Layout.getElemAlign(I);
773     Stores[I] = Builder.CreateAlignedStore(Val[I], Ptr[I], Align);
774   }
775   transferMetadata(&SI, Stores);
776   return true;
777 }
778 
779 bool ScalarizerVisitor::visitCallInst(CallInst &CI) {
780   return splitCall(CI);
781 }
782 
783 // Delete the instructions that we scalarized.  If a full vector result
784 // is still needed, recreate it using InsertElements.
785 bool ScalarizerVisitor::finish() {
786   // The presence of data in Gathered or Scattered indicates changes
787   // made to the Function.
788   if (Gathered.empty() && Scattered.empty())
789     return false;
790   for (const auto &GMI : Gathered) {
791     Instruction *Op = GMI.first;
792     ValueVector &CV = *GMI.second;
793     if (!Op->use_empty()) {
794       // The value is still needed, so recreate it using a series of
795       // InsertElements.
796       Type *Ty = Op->getType();
797       Value *Res = UndefValue::get(Ty);
798       BasicBlock *BB = Op->getParent();
799       unsigned Count = Ty->getVectorNumElements();
800       IRBuilder<> Builder(Op);
801       if (isa<PHINode>(Op))
802         Builder.SetInsertPoint(BB, BB->getFirstInsertionPt());
803       for (unsigned I = 0; I < Count; ++I)
804         Res = Builder.CreateInsertElement(Res, CV[I], Builder.getInt32(I),
805                                           Op->getName() + ".upto" + Twine(I));
806       Res->takeName(Op);
807       Op->replaceAllUsesWith(Res);
808     }
809     Op->eraseFromParent();
810   }
811   Gathered.clear();
812   Scattered.clear();
813   return true;
814 }
815 
816 PreservedAnalyses ScalarizerPass::run(Function &F, FunctionAnalysisManager &AM) {
817   Module &M = *F.getParent();
818   unsigned ParallelLoopAccessMDKind =
819       M.getContext().getMDKindID("llvm.mem.parallel_loop_access");
820   ScalarizerVisitor Impl(ParallelLoopAccessMDKind);
821   bool Changed = Impl.visit(F);
822   return Changed ? PreservedAnalyses::none() : PreservedAnalyses::all();
823 }
824