1a17f03bdSSanjay Patel //===------- VectorCombine.cpp - Optimize partial vector operations -------===// 2a17f03bdSSanjay Patel // 3a17f03bdSSanjay Patel // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4a17f03bdSSanjay Patel // See https://llvm.org/LICENSE.txt for license information. 5a17f03bdSSanjay Patel // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6a17f03bdSSanjay Patel // 7a17f03bdSSanjay Patel //===----------------------------------------------------------------------===// 8a17f03bdSSanjay Patel // 9a17f03bdSSanjay Patel // This pass optimizes scalar/vector interactions using target cost models. The 10a17f03bdSSanjay Patel // transforms implemented here may not fit in traditional loop-based or SLP 11a17f03bdSSanjay Patel // vectorization passes. 12a17f03bdSSanjay Patel // 13a17f03bdSSanjay Patel //===----------------------------------------------------------------------===// 14a17f03bdSSanjay Patel 15a17f03bdSSanjay Patel #include "llvm/Transforms/Vectorize/VectorCombine.h" 16a17f03bdSSanjay Patel #include "llvm/ADT/Statistic.h" 175006e551SSimon Pilgrim #include "llvm/Analysis/BasicAliasAnalysis.h" 18a17f03bdSSanjay Patel #include "llvm/Analysis/GlobalsModRef.h" 19a17f03bdSSanjay Patel #include "llvm/Analysis/TargetTransformInfo.h" 2019b62b79SSanjay Patel #include "llvm/Analysis/ValueTracking.h" 21b6050ca1SSanjay Patel #include "llvm/Analysis/VectorUtils.h" 22a17f03bdSSanjay Patel #include "llvm/IR/Dominators.h" 23a17f03bdSSanjay Patel #include "llvm/IR/Function.h" 24a17f03bdSSanjay Patel #include "llvm/IR/IRBuilder.h" 25a17f03bdSSanjay Patel #include "llvm/IR/PatternMatch.h" 26a17f03bdSSanjay Patel #include "llvm/InitializePasses.h" 27a17f03bdSSanjay Patel #include "llvm/Pass.h" 2825c6544fSSanjay Patel #include "llvm/Support/CommandLine.h" 29a17f03bdSSanjay Patel #include "llvm/Transforms/Utils/Local.h" 305006e551SSimon Pilgrim #include "llvm/Transforms/Vectorize.h" 31a17f03bdSSanjay Patel 32a17f03bdSSanjay Patel using namespace llvm; 33a17f03bdSSanjay Patel using namespace llvm::PatternMatch; 34a17f03bdSSanjay Patel 35a17f03bdSSanjay Patel #define DEBUG_TYPE "vector-combine" 36a17f03bdSSanjay Patel STATISTIC(NumVecCmp, "Number of vector compares formed"); 3719b62b79SSanjay Patel STATISTIC(NumVecBO, "Number of vector binops formed"); 387aeb41b3SRoman Lebedev STATISTIC(NumShufOfBitcast, "Number of shuffles moved after bitcast"); 390d2a0b44SSanjay Patel STATISTIC(NumScalarBO, "Number of scalar binops formed"); 40ed67f5e7SSanjay Patel STATISTIC(NumScalarCmp, "Number of scalar compares formed"); 41a17f03bdSSanjay Patel 4225c6544fSSanjay Patel static cl::opt<bool> DisableVectorCombine( 4325c6544fSSanjay Patel "disable-vector-combine", cl::init(false), cl::Hidden, 4425c6544fSSanjay Patel cl::desc("Disable all vector combine transforms")); 4525c6544fSSanjay Patel 46a69158c1SSanjay Patel static cl::opt<bool> DisableBinopExtractShuffle( 47a69158c1SSanjay Patel "disable-binop-extract-shuffle", cl::init(false), cl::Hidden, 48a69158c1SSanjay Patel cl::desc("Disable binop extract to shuffle transforms")); 49a69158c1SSanjay Patel 506bdd531aSSanjay Patel class VectorCombine { 516bdd531aSSanjay Patel public: 526bdd531aSSanjay Patel VectorCombine(Function &F, const TargetTransformInfo &TTI, 536bdd531aSSanjay Patel const DominatorTree &DT) 54*de65b356SSanjay Patel : F(F), Builder(F.getContext()), TTI(TTI), DT(DT) {} 556bdd531aSSanjay Patel 566bdd531aSSanjay Patel bool run(); 576bdd531aSSanjay Patel 586bdd531aSSanjay Patel private: 596bdd531aSSanjay Patel Function &F; 60*de65b356SSanjay Patel IRBuilder<> Builder; 616bdd531aSSanjay Patel const TargetTransformInfo &TTI; 626bdd531aSSanjay Patel const DominatorTree &DT; 636bdd531aSSanjay Patel 646bdd531aSSanjay Patel bool isExtractExtractCheap(ExtractElementInst *Ext0, ExtractElementInst *Ext1, 656bdd531aSSanjay Patel unsigned Opcode, 666bdd531aSSanjay Patel ExtractElementInst *&ConvertToShuffle, 676bdd531aSSanjay Patel unsigned PreferredExtractIndex); 68*de65b356SSanjay Patel ExtractElementInst *translateExtract(ExtractElementInst *ExtElt, 69*de65b356SSanjay Patel unsigned NewIndex); 70*de65b356SSanjay Patel void foldExtExtCmp(ExtractElementInst *Ext0, ExtractElementInst *Ext1, 71*de65b356SSanjay Patel Instruction &I); 72*de65b356SSanjay Patel void foldExtExtBinop(ExtractElementInst *Ext0, ExtractElementInst *Ext1, 73*de65b356SSanjay Patel Instruction &I); 746bdd531aSSanjay Patel bool foldExtractExtract(Instruction &I); 756bdd531aSSanjay Patel bool foldBitcastShuf(Instruction &I); 766bdd531aSSanjay Patel bool scalarizeBinopOrCmp(Instruction &I); 776bdd531aSSanjay Patel }; 78a69158c1SSanjay Patel 79a69158c1SSanjay Patel /// Compare the relative costs of 2 extracts followed by scalar operation vs. 80a69158c1SSanjay Patel /// vector operation(s) followed by extract. Return true if the existing 81a69158c1SSanjay Patel /// instructions are cheaper than a vector alternative. Otherwise, return false 82a69158c1SSanjay Patel /// and if one of the extracts should be transformed to a shufflevector, set 83a69158c1SSanjay Patel /// \p ConvertToShuffle to that extract instruction. 846bdd531aSSanjay Patel bool VectorCombine::isExtractExtractCheap(ExtractElementInst *Ext0, 856bdd531aSSanjay Patel ExtractElementInst *Ext1, 866bdd531aSSanjay Patel unsigned Opcode, 87216a37bbSSanjay Patel ExtractElementInst *&ConvertToShuffle, 88ce97ce3aSSanjay Patel unsigned PreferredExtractIndex) { 894fa63fd4SAustin Kerbow assert(isa<ConstantInt>(Ext0->getOperand(1)) && 90a69158c1SSanjay Patel isa<ConstantInt>(Ext1->getOperand(1)) && 91a69158c1SSanjay Patel "Expected constant extract indexes"); 9234e34855SSanjay Patel Type *ScalarTy = Ext0->getType(); 93e3056ae9SSam Parker auto *VecTy = cast<VectorType>(Ext0->getOperand(0)->getType()); 9434e34855SSanjay Patel int ScalarOpCost, VectorOpCost; 9534e34855SSanjay Patel 9634e34855SSanjay Patel // Get cost estimates for scalar and vector versions of the operation. 9734e34855SSanjay Patel bool IsBinOp = Instruction::isBinaryOp(Opcode); 9834e34855SSanjay Patel if (IsBinOp) { 9934e34855SSanjay Patel ScalarOpCost = TTI.getArithmeticInstrCost(Opcode, ScalarTy); 10034e34855SSanjay Patel VectorOpCost = TTI.getArithmeticInstrCost(Opcode, VecTy); 10134e34855SSanjay Patel } else { 10234e34855SSanjay Patel assert((Opcode == Instruction::ICmp || Opcode == Instruction::FCmp) && 10334e34855SSanjay Patel "Expected a compare"); 10434e34855SSanjay Patel ScalarOpCost = TTI.getCmpSelInstrCost(Opcode, ScalarTy, 10534e34855SSanjay Patel CmpInst::makeCmpResultType(ScalarTy)); 10634e34855SSanjay Patel VectorOpCost = TTI.getCmpSelInstrCost(Opcode, VecTy, 10734e34855SSanjay Patel CmpInst::makeCmpResultType(VecTy)); 10834e34855SSanjay Patel } 10934e34855SSanjay Patel 110a69158c1SSanjay Patel // Get cost estimates for the extract elements. These costs will factor into 11134e34855SSanjay Patel // both sequences. 112a69158c1SSanjay Patel unsigned Ext0Index = cast<ConstantInt>(Ext0->getOperand(1))->getZExtValue(); 113a69158c1SSanjay Patel unsigned Ext1Index = cast<ConstantInt>(Ext1->getOperand(1))->getZExtValue(); 114a69158c1SSanjay Patel 1156bdd531aSSanjay Patel int Extract0Cost = 1166bdd531aSSanjay Patel TTI.getVectorInstrCost(Instruction::ExtractElement, VecTy, Ext0Index); 1176bdd531aSSanjay Patel int Extract1Cost = 1186bdd531aSSanjay Patel TTI.getVectorInstrCost(Instruction::ExtractElement, VecTy, Ext1Index); 119a69158c1SSanjay Patel 120a69158c1SSanjay Patel // A more expensive extract will always be replaced by a splat shuffle. 121a69158c1SSanjay Patel // For example, if Ext0 is more expensive: 122a69158c1SSanjay Patel // opcode (extelt V0, Ext0), (ext V1, Ext1) --> 123a69158c1SSanjay Patel // extelt (opcode (splat V0, Ext0), V1), Ext1 124a69158c1SSanjay Patel // TODO: Evaluate whether that always results in lowest cost. Alternatively, 125a69158c1SSanjay Patel // check the cost of creating a broadcast shuffle and shuffling both 126a69158c1SSanjay Patel // operands to element 0. 127a69158c1SSanjay Patel int CheapExtractCost = std::min(Extract0Cost, Extract1Cost); 12834e34855SSanjay Patel 12934e34855SSanjay Patel // Extra uses of the extracts mean that we include those costs in the 13034e34855SSanjay Patel // vector total because those instructions will not be eliminated. 131e9c79a7aSSanjay Patel int OldCost, NewCost; 132a69158c1SSanjay Patel if (Ext0->getOperand(0) == Ext1->getOperand(0) && Ext0Index == Ext1Index) { 133a69158c1SSanjay Patel // Handle a special case. If the 2 extracts are identical, adjust the 13434e34855SSanjay Patel // formulas to account for that. The extra use charge allows for either the 13534e34855SSanjay Patel // CSE'd pattern or an unoptimized form with identical values: 13634e34855SSanjay Patel // opcode (extelt V, C), (extelt V, C) --> extelt (opcode V, V), C 13734e34855SSanjay Patel bool HasUseTax = Ext0 == Ext1 ? !Ext0->hasNUses(2) 13834e34855SSanjay Patel : !Ext0->hasOneUse() || !Ext1->hasOneUse(); 139a69158c1SSanjay Patel OldCost = CheapExtractCost + ScalarOpCost; 140a69158c1SSanjay Patel NewCost = VectorOpCost + CheapExtractCost + HasUseTax * CheapExtractCost; 14134e34855SSanjay Patel } else { 14234e34855SSanjay Patel // Handle the general case. Each extract is actually a different value: 143a69158c1SSanjay Patel // opcode (extelt V0, C0), (extelt V1, C1) --> extelt (opcode V0, V1), C 144a69158c1SSanjay Patel OldCost = Extract0Cost + Extract1Cost + ScalarOpCost; 145a69158c1SSanjay Patel NewCost = VectorOpCost + CheapExtractCost + 146a69158c1SSanjay Patel !Ext0->hasOneUse() * Extract0Cost + 147a69158c1SSanjay Patel !Ext1->hasOneUse() * Extract1Cost; 14834e34855SSanjay Patel } 149a69158c1SSanjay Patel 150a69158c1SSanjay Patel if (Ext0Index == Ext1Index) { 151a69158c1SSanjay Patel // If the extract indexes are identical, no shuffle is needed. 152a69158c1SSanjay Patel ConvertToShuffle = nullptr; 153a69158c1SSanjay Patel } else { 154a69158c1SSanjay Patel if (IsBinOp && DisableBinopExtractShuffle) 155a69158c1SSanjay Patel return true; 156a69158c1SSanjay Patel 157a69158c1SSanjay Patel // If we are extracting from 2 different indexes, then one operand must be 158a69158c1SSanjay Patel // shuffled before performing the vector operation. The shuffle mask is 159a69158c1SSanjay Patel // undefined except for 1 lane that is being translated to the remaining 160a69158c1SSanjay Patel // extraction lane. Therefore, it is a splat shuffle. Ex: 161a69158c1SSanjay Patel // ShufMask = { undef, undef, 0, undef } 162a69158c1SSanjay Patel // TODO: The cost model has an option for a "broadcast" shuffle 163a69158c1SSanjay Patel // (splat-from-element-0), but no option for a more general splat. 164a69158c1SSanjay Patel NewCost += 165a69158c1SSanjay Patel TTI.getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, VecTy); 166a69158c1SSanjay Patel 167ce97ce3aSSanjay Patel // The more expensive extract will be replaced by a shuffle. If the costs 168ce97ce3aSSanjay Patel // are equal and there is a preferred extract index, shuffle the opposite 169ce97ce3aSSanjay Patel // operand. Otherwise, replace the extract with the higher index. 170a69158c1SSanjay Patel if (Extract0Cost > Extract1Cost) 171a69158c1SSanjay Patel ConvertToShuffle = Ext0; 172a69158c1SSanjay Patel else if (Extract1Cost > Extract0Cost) 173a69158c1SSanjay Patel ConvertToShuffle = Ext1; 174ce97ce3aSSanjay Patel else if (PreferredExtractIndex == Ext0Index) 175ce97ce3aSSanjay Patel ConvertToShuffle = Ext1; 176ce97ce3aSSanjay Patel else if (PreferredExtractIndex == Ext1Index) 177ce97ce3aSSanjay Patel ConvertToShuffle = Ext0; 178a69158c1SSanjay Patel else 179a69158c1SSanjay Patel ConvertToShuffle = Ext0Index > Ext1Index ? Ext0 : Ext1; 180a69158c1SSanjay Patel } 181a69158c1SSanjay Patel 18210ea01d8SSanjay Patel // Aggressively form a vector op if the cost is equal because the transform 18310ea01d8SSanjay Patel // may enable further optimization. 18410ea01d8SSanjay Patel // Codegen can reverse this transform (scalarize) if it was not profitable. 18510ea01d8SSanjay Patel return OldCost < NewCost; 18634e34855SSanjay Patel } 18734e34855SSanjay Patel 188216a37bbSSanjay Patel /// Given an extract element instruction with constant index operand, shuffle 189216a37bbSSanjay Patel /// the source vector (shift the scalar element) to a NewIndex for extraction. 190216a37bbSSanjay Patel /// Return null if the input can be constant folded, so that we are not creating 191216a37bbSSanjay Patel /// unnecessary instructions. 192*de65b356SSanjay Patel ExtractElementInst *VectorCombine::translateExtract(ExtractElementInst *ExtElt, 193216a37bbSSanjay Patel unsigned NewIndex) { 194216a37bbSSanjay Patel // If the extract can be constant-folded, this code is unsimplified. Defer 195216a37bbSSanjay Patel // to other passes to handle that. 196216a37bbSSanjay Patel Value *X = ExtElt->getVectorOperand(); 197216a37bbSSanjay Patel Value *C = ExtElt->getIndexOperand(); 198*de65b356SSanjay Patel assert(isa<ConstantInt>(C) && "Expected a constant index operand"); 199216a37bbSSanjay Patel if (isa<Constant>(X)) 200216a37bbSSanjay Patel return nullptr; 201216a37bbSSanjay Patel 202216a37bbSSanjay Patel // The shuffle mask is undefined except for 1 lane that is being translated 203216a37bbSSanjay Patel // to the cheap extraction lane. Example: 204216a37bbSSanjay Patel // ShufMask = { 2, undef, undef, undef } 205216a37bbSSanjay Patel auto *VecTy = cast<FixedVectorType>(X->getType()); 206216a37bbSSanjay Patel SmallVector<int, 32> Mask(VecTy->getNumElements(), -1); 207216a37bbSSanjay Patel Mask[NewIndex] = cast<ConstantInt>(C)->getZExtValue(); 208216a37bbSSanjay Patel 209216a37bbSSanjay Patel // extelt X, C --> extelt (shuffle X), NewIndex 210cce625f7SSanjay Patel Value *Shuf = 211cce625f7SSanjay Patel Builder.CreateShuffleVector(X, UndefValue::get(VecTy), Mask, "shift"); 212216a37bbSSanjay Patel return cast<ExtractElementInst>(Builder.CreateExtractElement(Shuf, NewIndex)); 213216a37bbSSanjay Patel } 214216a37bbSSanjay Patel 215fc445589SSanjay Patel /// Try to reduce extract element costs by converting scalar compares to vector 216fc445589SSanjay Patel /// compares followed by extract. 217e9c79a7aSSanjay Patel /// cmp (ext0 V0, C), (ext1 V1, C) 218*de65b356SSanjay Patel void VectorCombine::foldExtExtCmp(ExtractElementInst *Ext0, 219*de65b356SSanjay Patel ExtractElementInst *Ext1, Instruction &I) { 220fc445589SSanjay Patel assert(isa<CmpInst>(&I) && "Expected a compare"); 221216a37bbSSanjay Patel assert(cast<ConstantInt>(Ext0->getIndexOperand())->getZExtValue() == 222216a37bbSSanjay Patel cast<ConstantInt>(Ext1->getIndexOperand())->getZExtValue() && 223216a37bbSSanjay Patel "Expected matching constant extract indexes"); 224a17f03bdSSanjay Patel 225a17f03bdSSanjay Patel // cmp Pred (extelt V0, C), (extelt V1, C) --> extelt (cmp Pred V0, V1), C 226a17f03bdSSanjay Patel ++NumVecCmp; 227fc445589SSanjay Patel CmpInst::Predicate Pred = cast<CmpInst>(&I)->getPredicate(); 228216a37bbSSanjay Patel Value *V0 = Ext0->getVectorOperand(), *V1 = Ext1->getVectorOperand(); 22946a285adSSanjay Patel Value *VecCmp = Builder.CreateCmp(Pred, V0, V1); 230216a37bbSSanjay Patel Value *NewExt = Builder.CreateExtractElement(VecCmp, Ext0->getIndexOperand()); 231216a37bbSSanjay Patel I.replaceAllUsesWith(NewExt); 232cce625f7SSanjay Patel NewExt->takeName(&I); 233a17f03bdSSanjay Patel } 234a17f03bdSSanjay Patel 23519b62b79SSanjay Patel /// Try to reduce extract element costs by converting scalar binops to vector 23619b62b79SSanjay Patel /// binops followed by extract. 237e9c79a7aSSanjay Patel /// bo (ext0 V0, C), (ext1 V1, C) 238*de65b356SSanjay Patel void VectorCombine::foldExtExtBinop(ExtractElementInst *Ext0, 239*de65b356SSanjay Patel ExtractElementInst *Ext1, Instruction &I) { 240fc445589SSanjay Patel assert(isa<BinaryOperator>(&I) && "Expected a binary operator"); 241216a37bbSSanjay Patel assert(cast<ConstantInt>(Ext0->getIndexOperand())->getZExtValue() == 242216a37bbSSanjay Patel cast<ConstantInt>(Ext1->getIndexOperand())->getZExtValue() && 243216a37bbSSanjay Patel "Expected matching constant extract indexes"); 24419b62b79SSanjay Patel 24534e34855SSanjay Patel // bo (extelt V0, C), (extelt V1, C) --> extelt (bo V0, V1), C 24619b62b79SSanjay Patel ++NumVecBO; 247216a37bbSSanjay Patel Value *V0 = Ext0->getVectorOperand(), *V1 = Ext1->getVectorOperand(); 248e9c79a7aSSanjay Patel Value *VecBO = 24934e34855SSanjay Patel Builder.CreateBinOp(cast<BinaryOperator>(&I)->getOpcode(), V0, V1); 250e9c79a7aSSanjay Patel 25119b62b79SSanjay Patel // All IR flags are safe to back-propagate because any potential poison 25219b62b79SSanjay Patel // created in unused vector elements is discarded by the extract. 253e9c79a7aSSanjay Patel if (auto *VecBOInst = dyn_cast<Instruction>(VecBO)) 25419b62b79SSanjay Patel VecBOInst->copyIRFlags(&I); 255e9c79a7aSSanjay Patel 256216a37bbSSanjay Patel Value *NewExt = Builder.CreateExtractElement(VecBO, Ext0->getIndexOperand()); 257216a37bbSSanjay Patel I.replaceAllUsesWith(NewExt); 258cce625f7SSanjay Patel NewExt->takeName(&I); 25919b62b79SSanjay Patel } 26019b62b79SSanjay Patel 261fc445589SSanjay Patel /// Match an instruction with extracted vector operands. 2626bdd531aSSanjay Patel bool VectorCombine::foldExtractExtract(Instruction &I) { 263e9c79a7aSSanjay Patel // It is not safe to transform things like div, urem, etc. because we may 264e9c79a7aSSanjay Patel // create undefined behavior when executing those on unknown vector elements. 265e9c79a7aSSanjay Patel if (!isSafeToSpeculativelyExecute(&I)) 266e9c79a7aSSanjay Patel return false; 267e9c79a7aSSanjay Patel 268216a37bbSSanjay Patel Instruction *I0, *I1; 269fc445589SSanjay Patel CmpInst::Predicate Pred = CmpInst::BAD_ICMP_PREDICATE; 270216a37bbSSanjay Patel if (!match(&I, m_Cmp(Pred, m_Instruction(I0), m_Instruction(I1))) && 271216a37bbSSanjay Patel !match(&I, m_BinOp(m_Instruction(I0), m_Instruction(I1)))) 272fc445589SSanjay Patel return false; 273fc445589SSanjay Patel 274fc445589SSanjay Patel Value *V0, *V1; 275fc445589SSanjay Patel uint64_t C0, C1; 276216a37bbSSanjay Patel if (!match(I0, m_ExtractElt(m_Value(V0), m_ConstantInt(C0))) || 277216a37bbSSanjay Patel !match(I1, m_ExtractElt(m_Value(V1), m_ConstantInt(C1))) || 278fc445589SSanjay Patel V0->getType() != V1->getType()) 279fc445589SSanjay Patel return false; 280fc445589SSanjay Patel 281ce97ce3aSSanjay Patel // If the scalar value 'I' is going to be re-inserted into a vector, then try 282ce97ce3aSSanjay Patel // to create an extract to that same element. The extract/insert can be 283ce97ce3aSSanjay Patel // reduced to a "select shuffle". 284ce97ce3aSSanjay Patel // TODO: If we add a larger pattern match that starts from an insert, this 285ce97ce3aSSanjay Patel // probably becomes unnecessary. 286216a37bbSSanjay Patel auto *Ext0 = cast<ExtractElementInst>(I0); 287216a37bbSSanjay Patel auto *Ext1 = cast<ExtractElementInst>(I1); 288ce97ce3aSSanjay Patel uint64_t InsertIndex = std::numeric_limits<uint64_t>::max(); 289ce97ce3aSSanjay Patel if (I.hasOneUse()) 2907eed772aSSanjay Patel match(I.user_back(), 2917eed772aSSanjay Patel m_InsertElt(m_Value(), m_Value(), m_ConstantInt(InsertIndex))); 292ce97ce3aSSanjay Patel 293216a37bbSSanjay Patel ExtractElementInst *ExtractToChange; 2946bdd531aSSanjay Patel if (isExtractExtractCheap(Ext0, Ext1, I.getOpcode(), ExtractToChange, 295ce97ce3aSSanjay Patel InsertIndex)) 296fc445589SSanjay Patel return false; 297e9c79a7aSSanjay Patel 298216a37bbSSanjay Patel if (ExtractToChange) { 299216a37bbSSanjay Patel unsigned CheapExtractIdx = ExtractToChange == Ext0 ? C1 : C0; 300216a37bbSSanjay Patel ExtractElementInst *NewExtract = 301216a37bbSSanjay Patel translateExtract(ExtractToChange, CheapExtractIdx); 302216a37bbSSanjay Patel if (!NewExtract) 3036d864097SSanjay Patel return false; 304216a37bbSSanjay Patel if (ExtractToChange == Ext0) 305216a37bbSSanjay Patel Ext0 = NewExtract; 306a69158c1SSanjay Patel else 307216a37bbSSanjay Patel Ext1 = NewExtract; 308a69158c1SSanjay Patel } 309e9c79a7aSSanjay Patel 310e9c79a7aSSanjay Patel if (Pred != CmpInst::BAD_ICMP_PREDICATE) 311039ff29eSSanjay Patel foldExtExtCmp(Ext0, Ext1, I); 312e9c79a7aSSanjay Patel else 313039ff29eSSanjay Patel foldExtExtBinop(Ext0, Ext1, I); 314e9c79a7aSSanjay Patel 315e9c79a7aSSanjay Patel return true; 316fc445589SSanjay Patel } 317fc445589SSanjay Patel 318bef6e67eSSanjay Patel /// If this is a bitcast of a shuffle, try to bitcast the source vector to the 319bef6e67eSSanjay Patel /// destination type followed by shuffle. This can enable further transforms by 320bef6e67eSSanjay Patel /// moving bitcasts or shuffles together. 3216bdd531aSSanjay Patel bool VectorCombine::foldBitcastShuf(Instruction &I) { 322b6050ca1SSanjay Patel Value *V; 323b6050ca1SSanjay Patel ArrayRef<int> Mask; 3247eed772aSSanjay Patel if (!match(&I, m_BitCast( 3257eed772aSSanjay Patel m_OneUse(m_Shuffle(m_Value(V), m_Undef(), m_Mask(Mask)))))) 326b6050ca1SSanjay Patel return false; 327b6050ca1SSanjay Patel 328bef6e67eSSanjay Patel // Disallow non-vector casts and length-changing shuffles. 329bef6e67eSSanjay Patel // TODO: We could allow any shuffle. 3303297e9b7SChristopher Tetreault auto *DestTy = dyn_cast<VectorType>(I.getType()); 3313297e9b7SChristopher Tetreault auto *SrcTy = cast<VectorType>(V->getType()); 3323297e9b7SChristopher Tetreault if (!DestTy || I.getOperand(0)->getType() != SrcTy) 333b6050ca1SSanjay Patel return false; 334b6050ca1SSanjay Patel 335b6050ca1SSanjay Patel // The new shuffle must not cost more than the old shuffle. The bitcast is 336b6050ca1SSanjay Patel // moved ahead of the shuffle, so assume that it has the same cost as before. 337b6050ca1SSanjay Patel if (TTI.getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, DestTy) > 338b6050ca1SSanjay Patel TTI.getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, SrcTy)) 339b6050ca1SSanjay Patel return false; 340b6050ca1SSanjay Patel 341bef6e67eSSanjay Patel unsigned DestNumElts = DestTy->getNumElements(); 342bef6e67eSSanjay Patel unsigned SrcNumElts = SrcTy->getNumElements(); 343b6050ca1SSanjay Patel SmallVector<int, 16> NewMask; 344bef6e67eSSanjay Patel if (SrcNumElts <= DestNumElts) { 345bef6e67eSSanjay Patel // The bitcast is from wide to narrow/equal elements. The shuffle mask can 346bef6e67eSSanjay Patel // always be expanded to the equivalent form choosing narrower elements. 347b6050ca1SSanjay Patel assert(DestNumElts % SrcNumElts == 0 && "Unexpected shuffle mask"); 348b6050ca1SSanjay Patel unsigned ScaleFactor = DestNumElts / SrcNumElts; 3491318ddbcSSanjay Patel narrowShuffleMaskElts(ScaleFactor, Mask, NewMask); 350bef6e67eSSanjay Patel } else { 351bef6e67eSSanjay Patel // The bitcast is from narrow elements to wide elements. The shuffle mask 352bef6e67eSSanjay Patel // must choose consecutive elements to allow casting first. 353bef6e67eSSanjay Patel assert(SrcNumElts % DestNumElts == 0 && "Unexpected shuffle mask"); 354bef6e67eSSanjay Patel unsigned ScaleFactor = SrcNumElts / DestNumElts; 355bef6e67eSSanjay Patel if (!widenShuffleMaskElts(ScaleFactor, Mask, NewMask)) 356bef6e67eSSanjay Patel return false; 357bef6e67eSSanjay Patel } 358bef6e67eSSanjay Patel // bitcast (shuf V, MaskC) --> shuf (bitcast V), MaskC' 3597aeb41b3SRoman Lebedev ++NumShufOfBitcast; 360bef6e67eSSanjay Patel Value *CastV = Builder.CreateBitCast(V, DestTy); 3617eed772aSSanjay Patel Value *Shuf = 3627eed772aSSanjay Patel Builder.CreateShuffleVector(CastV, UndefValue::get(DestTy), NewMask); 363b6050ca1SSanjay Patel I.replaceAllUsesWith(Shuf); 364b6050ca1SSanjay Patel return true; 365b6050ca1SSanjay Patel } 366b6050ca1SSanjay Patel 367ed67f5e7SSanjay Patel /// Match a vector binop or compare instruction with at least one inserted 368ed67f5e7SSanjay Patel /// scalar operand and convert to scalar binop/cmp followed by insertelement. 3696bdd531aSSanjay Patel bool VectorCombine::scalarizeBinopOrCmp(Instruction &I) { 370ed67f5e7SSanjay Patel CmpInst::Predicate Pred = CmpInst::BAD_ICMP_PREDICATE; 3715dc4e7c2SSimon Pilgrim Value *Ins0, *Ins1; 372ed67f5e7SSanjay Patel if (!match(&I, m_BinOp(m_Value(Ins0), m_Value(Ins1))) && 373ed67f5e7SSanjay Patel !match(&I, m_Cmp(Pred, m_Value(Ins0), m_Value(Ins1)))) 374ed67f5e7SSanjay Patel return false; 375ed67f5e7SSanjay Patel 376ed67f5e7SSanjay Patel // Do not convert the vector condition of a vector select into a scalar 377ed67f5e7SSanjay Patel // condition. That may cause problems for codegen because of differences in 378ed67f5e7SSanjay Patel // boolean formats and register-file transfers. 379ed67f5e7SSanjay Patel // TODO: Can we account for that in the cost model? 380ed67f5e7SSanjay Patel bool IsCmp = Pred != CmpInst::Predicate::BAD_ICMP_PREDICATE; 381ed67f5e7SSanjay Patel if (IsCmp) 382ed67f5e7SSanjay Patel for (User *U : I.users()) 383ed67f5e7SSanjay Patel if (match(U, m_Select(m_Specific(&I), m_Value(), m_Value()))) 3840d2a0b44SSanjay Patel return false; 3850d2a0b44SSanjay Patel 3865dc4e7c2SSimon Pilgrim // Match against one or both scalar values being inserted into constant 3875dc4e7c2SSimon Pilgrim // vectors: 388ed67f5e7SSanjay Patel // vec_op VecC0, (inselt VecC1, V1, Index) 389ed67f5e7SSanjay Patel // vec_op (inselt VecC0, V0, Index), VecC1 390ed67f5e7SSanjay Patel // vec_op (inselt VecC0, V0, Index), (inselt VecC1, V1, Index) 3910d2a0b44SSanjay Patel // TODO: Deal with mismatched index constants and variable indexes? 3925dc4e7c2SSimon Pilgrim Constant *VecC0 = nullptr, *VecC1 = nullptr; 3935dc4e7c2SSimon Pilgrim Value *V0 = nullptr, *V1 = nullptr; 3945dc4e7c2SSimon Pilgrim uint64_t Index0 = 0, Index1 = 0; 3957eed772aSSanjay Patel if (!match(Ins0, m_InsertElt(m_Constant(VecC0), m_Value(V0), 3965dc4e7c2SSimon Pilgrim m_ConstantInt(Index0))) && 3975dc4e7c2SSimon Pilgrim !match(Ins0, m_Constant(VecC0))) 3985dc4e7c2SSimon Pilgrim return false; 3995dc4e7c2SSimon Pilgrim if (!match(Ins1, m_InsertElt(m_Constant(VecC1), m_Value(V1), 4005dc4e7c2SSimon Pilgrim m_ConstantInt(Index1))) && 4015dc4e7c2SSimon Pilgrim !match(Ins1, m_Constant(VecC1))) 4020d2a0b44SSanjay Patel return false; 4030d2a0b44SSanjay Patel 4045dc4e7c2SSimon Pilgrim bool IsConst0 = !V0; 4055dc4e7c2SSimon Pilgrim bool IsConst1 = !V1; 4065dc4e7c2SSimon Pilgrim if (IsConst0 && IsConst1) 4075dc4e7c2SSimon Pilgrim return false; 4085dc4e7c2SSimon Pilgrim if (!IsConst0 && !IsConst1 && Index0 != Index1) 4095dc4e7c2SSimon Pilgrim return false; 4105dc4e7c2SSimon Pilgrim 4115dc4e7c2SSimon Pilgrim // Bail for single insertion if it is a load. 4125dc4e7c2SSimon Pilgrim // TODO: Handle this once getVectorInstrCost can cost for load/stores. 4135dc4e7c2SSimon Pilgrim auto *I0 = dyn_cast_or_null<Instruction>(V0); 4145dc4e7c2SSimon Pilgrim auto *I1 = dyn_cast_or_null<Instruction>(V1); 4155dc4e7c2SSimon Pilgrim if ((IsConst0 && I1 && I1->mayReadFromMemory()) || 4165dc4e7c2SSimon Pilgrim (IsConst1 && I0 && I0->mayReadFromMemory())) 4175dc4e7c2SSimon Pilgrim return false; 4185dc4e7c2SSimon Pilgrim 4195dc4e7c2SSimon Pilgrim uint64_t Index = IsConst0 ? Index1 : Index0; 4205dc4e7c2SSimon Pilgrim Type *ScalarTy = IsConst0 ? V1->getType() : V0->getType(); 4210d2a0b44SSanjay Patel Type *VecTy = I.getType(); 4225dc4e7c2SSimon Pilgrim assert(VecTy->isVectorTy() && 4235dc4e7c2SSimon Pilgrim (IsConst0 || IsConst1 || V0->getType() == V1->getType()) && 424741e20f3SSanjay Patel (ScalarTy->isIntegerTy() || ScalarTy->isFloatingPointTy() || 425741e20f3SSanjay Patel ScalarTy->isPointerTy()) && 426741e20f3SSanjay Patel "Unexpected types for insert element into binop or cmp"); 4270d2a0b44SSanjay Patel 428ed67f5e7SSanjay Patel unsigned Opcode = I.getOpcode(); 429ed67f5e7SSanjay Patel int ScalarOpCost, VectorOpCost; 430ed67f5e7SSanjay Patel if (IsCmp) { 431ed67f5e7SSanjay Patel ScalarOpCost = TTI.getCmpSelInstrCost(Opcode, ScalarTy); 432ed67f5e7SSanjay Patel VectorOpCost = TTI.getCmpSelInstrCost(Opcode, VecTy); 433ed67f5e7SSanjay Patel } else { 434ed67f5e7SSanjay Patel ScalarOpCost = TTI.getArithmeticInstrCost(Opcode, ScalarTy); 435ed67f5e7SSanjay Patel VectorOpCost = TTI.getArithmeticInstrCost(Opcode, VecTy); 436ed67f5e7SSanjay Patel } 4370d2a0b44SSanjay Patel 4380d2a0b44SSanjay Patel // Get cost estimate for the insert element. This cost will factor into 4390d2a0b44SSanjay Patel // both sequences. 4400d2a0b44SSanjay Patel int InsertCost = 4410d2a0b44SSanjay Patel TTI.getVectorInstrCost(Instruction::InsertElement, VecTy, Index); 4425dc4e7c2SSimon Pilgrim int OldCost = (IsConst0 ? 0 : InsertCost) + (IsConst1 ? 0 : InsertCost) + 4435dc4e7c2SSimon Pilgrim VectorOpCost; 4445f730b64SSanjay Patel int NewCost = ScalarOpCost + InsertCost + 4455dc4e7c2SSimon Pilgrim (IsConst0 ? 0 : !Ins0->hasOneUse() * InsertCost) + 4465dc4e7c2SSimon Pilgrim (IsConst1 ? 0 : !Ins1->hasOneUse() * InsertCost); 4470d2a0b44SSanjay Patel 4480d2a0b44SSanjay Patel // We want to scalarize unless the vector variant actually has lower cost. 4490d2a0b44SSanjay Patel if (OldCost < NewCost) 4500d2a0b44SSanjay Patel return false; 4510d2a0b44SSanjay Patel 452ed67f5e7SSanjay Patel // vec_op (inselt VecC0, V0, Index), (inselt VecC1, V1, Index) --> 453ed67f5e7SSanjay Patel // inselt NewVecC, (scalar_op V0, V1), Index 454ed67f5e7SSanjay Patel if (IsCmp) 455ed67f5e7SSanjay Patel ++NumScalarCmp; 456ed67f5e7SSanjay Patel else 4570d2a0b44SSanjay Patel ++NumScalarBO; 4585dc4e7c2SSimon Pilgrim 4595dc4e7c2SSimon Pilgrim // For constant cases, extract the scalar element, this should constant fold. 4605dc4e7c2SSimon Pilgrim if (IsConst0) 4615dc4e7c2SSimon Pilgrim V0 = ConstantExpr::getExtractElement(VecC0, Builder.getInt64(Index)); 4625dc4e7c2SSimon Pilgrim if (IsConst1) 4635dc4e7c2SSimon Pilgrim V1 = ConstantExpr::getExtractElement(VecC1, Builder.getInt64(Index)); 4645dc4e7c2SSimon Pilgrim 465ed67f5e7SSanjay Patel Value *Scalar = 46646a285adSSanjay Patel IsCmp ? Builder.CreateCmp(Pred, V0, V1) 467ed67f5e7SSanjay Patel : Builder.CreateBinOp((Instruction::BinaryOps)Opcode, V0, V1); 468ed67f5e7SSanjay Patel 469ed67f5e7SSanjay Patel Scalar->setName(I.getName() + ".scalar"); 4700d2a0b44SSanjay Patel 4710d2a0b44SSanjay Patel // All IR flags are safe to back-propagate. There is no potential for extra 4720d2a0b44SSanjay Patel // poison to be created by the scalar instruction. 4730d2a0b44SSanjay Patel if (auto *ScalarInst = dyn_cast<Instruction>(Scalar)) 4740d2a0b44SSanjay Patel ScalarInst->copyIRFlags(&I); 4750d2a0b44SSanjay Patel 4760d2a0b44SSanjay Patel // Fold the vector constants in the original vectors into a new base vector. 477ed67f5e7SSanjay Patel Constant *NewVecC = IsCmp ? ConstantExpr::getCompare(Pred, VecC0, VecC1) 478ed67f5e7SSanjay Patel : ConstantExpr::get(Opcode, VecC0, VecC1); 4790d2a0b44SSanjay Patel Value *Insert = Builder.CreateInsertElement(NewVecC, Scalar, Index); 4800d2a0b44SSanjay Patel I.replaceAllUsesWith(Insert); 4810d2a0b44SSanjay Patel Insert->takeName(&I); 4820d2a0b44SSanjay Patel return true; 4830d2a0b44SSanjay Patel } 4840d2a0b44SSanjay Patel 485a17f03bdSSanjay Patel /// This is the entry point for all transforms. Pass manager differences are 486a17f03bdSSanjay Patel /// handled in the callers of this function. 4876bdd531aSSanjay Patel bool VectorCombine::run() { 48825c6544fSSanjay Patel if (DisableVectorCombine) 48925c6544fSSanjay Patel return false; 49025c6544fSSanjay Patel 491a17f03bdSSanjay Patel bool MadeChange = false; 492a17f03bdSSanjay Patel for (BasicBlock &BB : F) { 493a17f03bdSSanjay Patel // Ignore unreachable basic blocks. 494a17f03bdSSanjay Patel if (!DT.isReachableFromEntry(&BB)) 495a17f03bdSSanjay Patel continue; 496a17f03bdSSanjay Patel // Do not delete instructions under here and invalidate the iterator. 49781e9ede3SSanjay Patel // Walk the block forwards to enable simple iterative chains of transforms. 498a17f03bdSSanjay Patel // TODO: It could be more efficient to remove dead instructions 499a17f03bdSSanjay Patel // iteratively in this loop rather than waiting until the end. 50081e9ede3SSanjay Patel for (Instruction &I : BB) { 501fc3cc8a4SSanjay Patel if (isa<DbgInfoIntrinsic>(I)) 502fc3cc8a4SSanjay Patel continue; 503*de65b356SSanjay Patel Builder.SetInsertPoint(&I); 5046bdd531aSSanjay Patel MadeChange |= foldExtractExtract(I); 5056bdd531aSSanjay Patel MadeChange |= foldBitcastShuf(I); 5066bdd531aSSanjay Patel MadeChange |= scalarizeBinopOrCmp(I); 507a17f03bdSSanjay Patel } 508fc3cc8a4SSanjay Patel } 509a17f03bdSSanjay Patel 510a17f03bdSSanjay Patel // We're done with transforms, so remove dead instructions. 511a17f03bdSSanjay Patel if (MadeChange) 512a17f03bdSSanjay Patel for (BasicBlock &BB : F) 513a17f03bdSSanjay Patel SimplifyInstructionsInBlock(&BB); 514a17f03bdSSanjay Patel 515a17f03bdSSanjay Patel return MadeChange; 516a17f03bdSSanjay Patel } 517a17f03bdSSanjay Patel 518a17f03bdSSanjay Patel // Pass manager boilerplate below here. 519a17f03bdSSanjay Patel 520a17f03bdSSanjay Patel namespace { 521a17f03bdSSanjay Patel class VectorCombineLegacyPass : public FunctionPass { 522a17f03bdSSanjay Patel public: 523a17f03bdSSanjay Patel static char ID; 524a17f03bdSSanjay Patel VectorCombineLegacyPass() : FunctionPass(ID) { 525a17f03bdSSanjay Patel initializeVectorCombineLegacyPassPass(*PassRegistry::getPassRegistry()); 526a17f03bdSSanjay Patel } 527a17f03bdSSanjay Patel 528a17f03bdSSanjay Patel void getAnalysisUsage(AnalysisUsage &AU) const override { 529a17f03bdSSanjay Patel AU.addRequired<DominatorTreeWrapperPass>(); 530a17f03bdSSanjay Patel AU.addRequired<TargetTransformInfoWrapperPass>(); 531a17f03bdSSanjay Patel AU.setPreservesCFG(); 532a17f03bdSSanjay Patel AU.addPreserved<DominatorTreeWrapperPass>(); 533a17f03bdSSanjay Patel AU.addPreserved<GlobalsAAWrapperPass>(); 534024098aeSSanjay Patel AU.addPreserved<AAResultsWrapperPass>(); 535024098aeSSanjay Patel AU.addPreserved<BasicAAWrapperPass>(); 536a17f03bdSSanjay Patel FunctionPass::getAnalysisUsage(AU); 537a17f03bdSSanjay Patel } 538a17f03bdSSanjay Patel 539a17f03bdSSanjay Patel bool runOnFunction(Function &F) override { 540a17f03bdSSanjay Patel if (skipFunction(F)) 541a17f03bdSSanjay Patel return false; 542a17f03bdSSanjay Patel auto &TTI = getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F); 543a17f03bdSSanjay Patel auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 5446bdd531aSSanjay Patel VectorCombine Combiner(F, TTI, DT); 5456bdd531aSSanjay Patel return Combiner.run(); 546a17f03bdSSanjay Patel } 547a17f03bdSSanjay Patel }; 548a17f03bdSSanjay Patel } // namespace 549a17f03bdSSanjay Patel 550a17f03bdSSanjay Patel char VectorCombineLegacyPass::ID = 0; 551a17f03bdSSanjay Patel INITIALIZE_PASS_BEGIN(VectorCombineLegacyPass, "vector-combine", 552a17f03bdSSanjay Patel "Optimize scalar/vector ops", false, 553a17f03bdSSanjay Patel false) 554a17f03bdSSanjay Patel INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 555a17f03bdSSanjay Patel INITIALIZE_PASS_END(VectorCombineLegacyPass, "vector-combine", 556a17f03bdSSanjay Patel "Optimize scalar/vector ops", false, false) 557a17f03bdSSanjay Patel Pass *llvm::createVectorCombinePass() { 558a17f03bdSSanjay Patel return new VectorCombineLegacyPass(); 559a17f03bdSSanjay Patel } 560a17f03bdSSanjay Patel 561a17f03bdSSanjay Patel PreservedAnalyses VectorCombinePass::run(Function &F, 562a17f03bdSSanjay Patel FunctionAnalysisManager &FAM) { 563a17f03bdSSanjay Patel TargetTransformInfo &TTI = FAM.getResult<TargetIRAnalysis>(F); 564a17f03bdSSanjay Patel DominatorTree &DT = FAM.getResult<DominatorTreeAnalysis>(F); 5656bdd531aSSanjay Patel VectorCombine Combiner(F, TTI, DT); 5666bdd531aSSanjay Patel if (!Combiner.run()) 567a17f03bdSSanjay Patel return PreservedAnalyses::all(); 568a17f03bdSSanjay Patel PreservedAnalyses PA; 569a17f03bdSSanjay Patel PA.preserveSet<CFGAnalyses>(); 570a17f03bdSSanjay Patel PA.preserve<GlobalsAA>(); 571024098aeSSanjay Patel PA.preserve<AAManager>(); 572024098aeSSanjay Patel PA.preserve<BasicAA>(); 573a17f03bdSSanjay Patel return PA; 574a17f03bdSSanjay Patel } 575