1 //===- SLPVectorizer.cpp - A bottom up SLP Vectorizer ---------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This pass implements the Bottom Up SLP vectorizer. It detects consecutive 10 // stores that can be put together into vector-stores. Next, it attempts to 11 // construct vectorizable tree using the use-def chains. If a profitable tree 12 // was found, the SLP vectorizer performs vectorization on the tree. 13 // 14 // The pass is inspired by the work described in the paper: 15 // "Loop-Aware SLP in GCC" by Ira Rosen, Dorit Nuzman, Ayal Zaks. 16 // 17 //===----------------------------------------------------------------------===// 18 19 #include "llvm/Transforms/Vectorize/SLPVectorizer.h" 20 #include "llvm/ADT/DenseMap.h" 21 #include "llvm/ADT/DenseSet.h" 22 #include "llvm/ADT/Optional.h" 23 #include "llvm/ADT/PostOrderIterator.h" 24 #include "llvm/ADT/PriorityQueue.h" 25 #include "llvm/ADT/STLExtras.h" 26 #include "llvm/ADT/SetOperations.h" 27 #include "llvm/ADT/SetVector.h" 28 #include "llvm/ADT/SmallBitVector.h" 29 #include "llvm/ADT/SmallPtrSet.h" 30 #include "llvm/ADT/SmallSet.h" 31 #include "llvm/ADT/SmallString.h" 32 #include "llvm/ADT/Statistic.h" 33 #include "llvm/ADT/iterator.h" 34 #include "llvm/ADT/iterator_range.h" 35 #include "llvm/Analysis/AliasAnalysis.h" 36 #include "llvm/Analysis/AssumptionCache.h" 37 #include "llvm/Analysis/CodeMetrics.h" 38 #include "llvm/Analysis/DemandedBits.h" 39 #include "llvm/Analysis/GlobalsModRef.h" 40 #include "llvm/Analysis/IVDescriptors.h" 41 #include "llvm/Analysis/LoopAccessAnalysis.h" 42 #include "llvm/Analysis/LoopInfo.h" 43 #include "llvm/Analysis/MemoryLocation.h" 44 #include "llvm/Analysis/OptimizationRemarkEmitter.h" 45 #include "llvm/Analysis/ScalarEvolution.h" 46 #include "llvm/Analysis/ScalarEvolutionExpressions.h" 47 #include "llvm/Analysis/TargetLibraryInfo.h" 48 #include "llvm/Analysis/TargetTransformInfo.h" 49 #include "llvm/Analysis/ValueTracking.h" 50 #include "llvm/Analysis/VectorUtils.h" 51 #include "llvm/IR/Attributes.h" 52 #include "llvm/IR/BasicBlock.h" 53 #include "llvm/IR/Constant.h" 54 #include "llvm/IR/Constants.h" 55 #include "llvm/IR/DataLayout.h" 56 #include "llvm/IR/DerivedTypes.h" 57 #include "llvm/IR/Dominators.h" 58 #include "llvm/IR/Function.h" 59 #include "llvm/IR/IRBuilder.h" 60 #include "llvm/IR/InstrTypes.h" 61 #include "llvm/IR/Instruction.h" 62 #include "llvm/IR/Instructions.h" 63 #include "llvm/IR/IntrinsicInst.h" 64 #include "llvm/IR/Intrinsics.h" 65 #include "llvm/IR/Module.h" 66 #include "llvm/IR/Operator.h" 67 #include "llvm/IR/PatternMatch.h" 68 #include "llvm/IR/Type.h" 69 #include "llvm/IR/Use.h" 70 #include "llvm/IR/User.h" 71 #include "llvm/IR/Value.h" 72 #include "llvm/IR/ValueHandle.h" 73 #ifdef EXPENSIVE_CHECKS 74 #include "llvm/IR/Verifier.h" 75 #endif 76 #include "llvm/Pass.h" 77 #include "llvm/Support/Casting.h" 78 #include "llvm/Support/CommandLine.h" 79 #include "llvm/Support/Compiler.h" 80 #include "llvm/Support/DOTGraphTraits.h" 81 #include "llvm/Support/Debug.h" 82 #include "llvm/Support/ErrorHandling.h" 83 #include "llvm/Support/GraphWriter.h" 84 #include "llvm/Support/InstructionCost.h" 85 #include "llvm/Support/KnownBits.h" 86 #include "llvm/Support/MathExtras.h" 87 #include "llvm/Support/raw_ostream.h" 88 #include "llvm/Transforms/Utils/InjectTLIMappings.h" 89 #include "llvm/Transforms/Utils/Local.h" 90 #include "llvm/Transforms/Utils/LoopUtils.h" 91 #include "llvm/Transforms/Vectorize.h" 92 #include <algorithm> 93 #include <cassert> 94 #include <cstdint> 95 #include <iterator> 96 #include <memory> 97 #include <set> 98 #include <string> 99 #include <tuple> 100 #include <utility> 101 #include <vector> 102 103 using namespace llvm; 104 using namespace llvm::PatternMatch; 105 using namespace slpvectorizer; 106 107 #define SV_NAME "slp-vectorizer" 108 #define DEBUG_TYPE "SLP" 109 110 STATISTIC(NumVectorInstructions, "Number of vector instructions generated"); 111 112 cl::opt<bool> RunSLPVectorization("vectorize-slp", cl::init(true), cl::Hidden, 113 cl::desc("Run the SLP vectorization passes")); 114 115 static cl::opt<int> 116 SLPCostThreshold("slp-threshold", cl::init(0), cl::Hidden, 117 cl::desc("Only vectorize if you gain more than this " 118 "number ")); 119 120 static cl::opt<bool> 121 ShouldVectorizeHor("slp-vectorize-hor", cl::init(true), cl::Hidden, 122 cl::desc("Attempt to vectorize horizontal reductions")); 123 124 static cl::opt<bool> ShouldStartVectorizeHorAtStore( 125 "slp-vectorize-hor-store", cl::init(false), cl::Hidden, 126 cl::desc( 127 "Attempt to vectorize horizontal reductions feeding into a store")); 128 129 static cl::opt<int> 130 MaxVectorRegSizeOption("slp-max-reg-size", cl::init(128), cl::Hidden, 131 cl::desc("Attempt to vectorize for this register size in bits")); 132 133 static cl::opt<unsigned> 134 MaxVFOption("slp-max-vf", cl::init(0), cl::Hidden, 135 cl::desc("Maximum SLP vectorization factor (0=unlimited)")); 136 137 static cl::opt<int> 138 MaxStoreLookup("slp-max-store-lookup", cl::init(32), cl::Hidden, 139 cl::desc("Maximum depth of the lookup for consecutive stores.")); 140 141 /// Limits the size of scheduling regions in a block. 142 /// It avoid long compile times for _very_ large blocks where vector 143 /// instructions are spread over a wide range. 144 /// This limit is way higher than needed by real-world functions. 145 static cl::opt<int> 146 ScheduleRegionSizeBudget("slp-schedule-budget", cl::init(100000), cl::Hidden, 147 cl::desc("Limit the size of the SLP scheduling region per block")); 148 149 static cl::opt<int> MinVectorRegSizeOption( 150 "slp-min-reg-size", cl::init(128), cl::Hidden, 151 cl::desc("Attempt to vectorize for this register size in bits")); 152 153 static cl::opt<unsigned> RecursionMaxDepth( 154 "slp-recursion-max-depth", cl::init(12), cl::Hidden, 155 cl::desc("Limit the recursion depth when building a vectorizable tree")); 156 157 static cl::opt<unsigned> MinTreeSize( 158 "slp-min-tree-size", cl::init(3), cl::Hidden, 159 cl::desc("Only vectorize small trees if they are fully vectorizable")); 160 161 // The maximum depth that the look-ahead score heuristic will explore. 162 // The higher this value, the higher the compilation time overhead. 163 static cl::opt<int> LookAheadMaxDepth( 164 "slp-max-look-ahead-depth", cl::init(2), cl::Hidden, 165 cl::desc("The maximum look-ahead depth for operand reordering scores")); 166 167 // The maximum depth that the look-ahead score heuristic will explore 168 // when it probing among candidates for vectorization tree roots. 169 // The higher this value, the higher the compilation time overhead but unlike 170 // similar limit for operands ordering this is less frequently used, hence 171 // impact of higher value is less noticeable. 172 static cl::opt<int> RootLookAheadMaxDepth( 173 "slp-max-root-look-ahead-depth", cl::init(2), cl::Hidden, 174 cl::desc("The maximum look-ahead depth for searching best rooting option")); 175 176 static cl::opt<bool> 177 ViewSLPTree("view-slp-tree", cl::Hidden, 178 cl::desc("Display the SLP trees with Graphviz")); 179 180 // Limit the number of alias checks. The limit is chosen so that 181 // it has no negative effect on the llvm benchmarks. 182 static const unsigned AliasedCheckLimit = 10; 183 184 // Another limit for the alias checks: The maximum distance between load/store 185 // instructions where alias checks are done. 186 // This limit is useful for very large basic blocks. 187 static const unsigned MaxMemDepDistance = 160; 188 189 /// If the ScheduleRegionSizeBudget is exhausted, we allow small scheduling 190 /// regions to be handled. 191 static const int MinScheduleRegionSize = 16; 192 193 /// Predicate for the element types that the SLP vectorizer supports. 194 /// 195 /// The most important thing to filter here are types which are invalid in LLVM 196 /// vectors. We also filter target specific types which have absolutely no 197 /// meaningful vectorization path such as x86_fp80 and ppc_f128. This just 198 /// avoids spending time checking the cost model and realizing that they will 199 /// be inevitably scalarized. 200 static bool isValidElementType(Type *Ty) { 201 return VectorType::isValidElementType(Ty) && !Ty->isX86_FP80Ty() && 202 !Ty->isPPC_FP128Ty(); 203 } 204 205 /// \returns True if the value is a constant (but not globals/constant 206 /// expressions). 207 static bool isConstant(Value *V) { 208 return isa<Constant>(V) && !isa<ConstantExpr>(V) && !isa<GlobalValue>(V); 209 } 210 211 /// Checks if \p V is one of vector-like instructions, i.e. undef, 212 /// insertelement/extractelement with constant indices for fixed vector type or 213 /// extractvalue instruction. 214 static bool isVectorLikeInstWithConstOps(Value *V) { 215 if (!isa<InsertElementInst, ExtractElementInst>(V) && 216 !isa<ExtractValueInst, UndefValue>(V)) 217 return false; 218 auto *I = dyn_cast<Instruction>(V); 219 if (!I || isa<ExtractValueInst>(I)) 220 return true; 221 if (!isa<FixedVectorType>(I->getOperand(0)->getType())) 222 return false; 223 if (isa<ExtractElementInst>(I)) 224 return isConstant(I->getOperand(1)); 225 assert(isa<InsertElementInst>(V) && "Expected only insertelement."); 226 return isConstant(I->getOperand(2)); 227 } 228 229 /// \returns true if all of the instructions in \p VL are in the same block or 230 /// false otherwise. 231 static bool allSameBlock(ArrayRef<Value *> VL) { 232 Instruction *I0 = dyn_cast<Instruction>(VL[0]); 233 if (!I0) 234 return false; 235 if (all_of(VL, isVectorLikeInstWithConstOps)) 236 return true; 237 238 BasicBlock *BB = I0->getParent(); 239 for (int I = 1, E = VL.size(); I < E; I++) { 240 auto *II = dyn_cast<Instruction>(VL[I]); 241 if (!II) 242 return false; 243 244 if (BB != II->getParent()) 245 return false; 246 } 247 return true; 248 } 249 250 /// \returns True if all of the values in \p VL are constants (but not 251 /// globals/constant expressions). 252 static bool allConstant(ArrayRef<Value *> VL) { 253 // Constant expressions and globals can't be vectorized like normal integer/FP 254 // constants. 255 return all_of(VL, isConstant); 256 } 257 258 /// \returns True if all of the values in \p VL are identical or some of them 259 /// are UndefValue. 260 static bool isSplat(ArrayRef<Value *> VL) { 261 Value *FirstNonUndef = nullptr; 262 for (Value *V : VL) { 263 if (isa<UndefValue>(V)) 264 continue; 265 if (!FirstNonUndef) { 266 FirstNonUndef = V; 267 continue; 268 } 269 if (V != FirstNonUndef) 270 return false; 271 } 272 return FirstNonUndef != nullptr; 273 } 274 275 /// \returns True if \p I is commutative, handles CmpInst and BinaryOperator. 276 static bool isCommutative(Instruction *I) { 277 if (auto *Cmp = dyn_cast<CmpInst>(I)) 278 return Cmp->isCommutative(); 279 if (auto *BO = dyn_cast<BinaryOperator>(I)) 280 return BO->isCommutative(); 281 // TODO: This should check for generic Instruction::isCommutative(), but 282 // we need to confirm that the caller code correctly handles Intrinsics 283 // for example (does not have 2 operands). 284 return false; 285 } 286 287 /// Checks if the given value is actually an undefined constant vector. 288 static bool isUndefVector(const Value *V) { 289 if (isa<UndefValue>(V)) 290 return true; 291 auto *C = dyn_cast<Constant>(V); 292 if (!C) 293 return false; 294 if (!C->containsUndefOrPoisonElement()) 295 return false; 296 auto *VecTy = dyn_cast<FixedVectorType>(C->getType()); 297 if (!VecTy) 298 return false; 299 for (unsigned I = 0, E = VecTy->getNumElements(); I != E; ++I) { 300 if (Constant *Elem = C->getAggregateElement(I)) 301 if (!isa<UndefValue>(Elem)) 302 return false; 303 } 304 return true; 305 } 306 307 /// Checks if the vector of instructions can be represented as a shuffle, like: 308 /// %x0 = extractelement <4 x i8> %x, i32 0 309 /// %x3 = extractelement <4 x i8> %x, i32 3 310 /// %y1 = extractelement <4 x i8> %y, i32 1 311 /// %y2 = extractelement <4 x i8> %y, i32 2 312 /// %x0x0 = mul i8 %x0, %x0 313 /// %x3x3 = mul i8 %x3, %x3 314 /// %y1y1 = mul i8 %y1, %y1 315 /// %y2y2 = mul i8 %y2, %y2 316 /// %ins1 = insertelement <4 x i8> poison, i8 %x0x0, i32 0 317 /// %ins2 = insertelement <4 x i8> %ins1, i8 %x3x3, i32 1 318 /// %ins3 = insertelement <4 x i8> %ins2, i8 %y1y1, i32 2 319 /// %ins4 = insertelement <4 x i8> %ins3, i8 %y2y2, i32 3 320 /// ret <4 x i8> %ins4 321 /// can be transformed into: 322 /// %1 = shufflevector <4 x i8> %x, <4 x i8> %y, <4 x i32> <i32 0, i32 3, i32 5, 323 /// i32 6> 324 /// %2 = mul <4 x i8> %1, %1 325 /// ret <4 x i8> %2 326 /// We convert this initially to something like: 327 /// %x0 = extractelement <4 x i8> %x, i32 0 328 /// %x3 = extractelement <4 x i8> %x, i32 3 329 /// %y1 = extractelement <4 x i8> %y, i32 1 330 /// %y2 = extractelement <4 x i8> %y, i32 2 331 /// %1 = insertelement <4 x i8> poison, i8 %x0, i32 0 332 /// %2 = insertelement <4 x i8> %1, i8 %x3, i32 1 333 /// %3 = insertelement <4 x i8> %2, i8 %y1, i32 2 334 /// %4 = insertelement <4 x i8> %3, i8 %y2, i32 3 335 /// %5 = mul <4 x i8> %4, %4 336 /// %6 = extractelement <4 x i8> %5, i32 0 337 /// %ins1 = insertelement <4 x i8> poison, i8 %6, i32 0 338 /// %7 = extractelement <4 x i8> %5, i32 1 339 /// %ins2 = insertelement <4 x i8> %ins1, i8 %7, i32 1 340 /// %8 = extractelement <4 x i8> %5, i32 2 341 /// %ins3 = insertelement <4 x i8> %ins2, i8 %8, i32 2 342 /// %9 = extractelement <4 x i8> %5, i32 3 343 /// %ins4 = insertelement <4 x i8> %ins3, i8 %9, i32 3 344 /// ret <4 x i8> %ins4 345 /// InstCombiner transforms this into a shuffle and vector mul 346 /// Mask will return the Shuffle Mask equivalent to the extracted elements. 347 /// TODO: Can we split off and reuse the shuffle mask detection from 348 /// TargetTransformInfo::getInstructionThroughput? 349 static Optional<TargetTransformInfo::ShuffleKind> 350 isFixedVectorShuffle(ArrayRef<Value *> VL, SmallVectorImpl<int> &Mask) { 351 const auto *It = 352 find_if(VL, [](Value *V) { return isa<ExtractElementInst>(V); }); 353 if (It == VL.end()) 354 return None; 355 auto *EI0 = cast<ExtractElementInst>(*It); 356 if (isa<ScalableVectorType>(EI0->getVectorOperandType())) 357 return None; 358 unsigned Size = 359 cast<FixedVectorType>(EI0->getVectorOperandType())->getNumElements(); 360 Value *Vec1 = nullptr; 361 Value *Vec2 = nullptr; 362 enum ShuffleMode { Unknown, Select, Permute }; 363 ShuffleMode CommonShuffleMode = Unknown; 364 Mask.assign(VL.size(), UndefMaskElem); 365 for (unsigned I = 0, E = VL.size(); I < E; ++I) { 366 // Undef can be represented as an undef element in a vector. 367 if (isa<UndefValue>(VL[I])) 368 continue; 369 auto *EI = cast<ExtractElementInst>(VL[I]); 370 if (isa<ScalableVectorType>(EI->getVectorOperandType())) 371 return None; 372 auto *Vec = EI->getVectorOperand(); 373 // We can extractelement from undef or poison vector. 374 if (isUndefVector(Vec)) 375 continue; 376 // All vector operands must have the same number of vector elements. 377 if (cast<FixedVectorType>(Vec->getType())->getNumElements() != Size) 378 return None; 379 if (isa<UndefValue>(EI->getIndexOperand())) 380 continue; 381 auto *Idx = dyn_cast<ConstantInt>(EI->getIndexOperand()); 382 if (!Idx) 383 return None; 384 // Undefined behavior if Idx is negative or >= Size. 385 if (Idx->getValue().uge(Size)) 386 continue; 387 unsigned IntIdx = Idx->getValue().getZExtValue(); 388 Mask[I] = IntIdx; 389 // For correct shuffling we have to have at most 2 different vector operands 390 // in all extractelement instructions. 391 if (!Vec1 || Vec1 == Vec) { 392 Vec1 = Vec; 393 } else if (!Vec2 || Vec2 == Vec) { 394 Vec2 = Vec; 395 Mask[I] += Size; 396 } else { 397 return None; 398 } 399 if (CommonShuffleMode == Permute) 400 continue; 401 // If the extract index is not the same as the operation number, it is a 402 // permutation. 403 if (IntIdx != I) { 404 CommonShuffleMode = Permute; 405 continue; 406 } 407 CommonShuffleMode = Select; 408 } 409 // If we're not crossing lanes in different vectors, consider it as blending. 410 if (CommonShuffleMode == Select && Vec2) 411 return TargetTransformInfo::SK_Select; 412 // If Vec2 was never used, we have a permutation of a single vector, otherwise 413 // we have permutation of 2 vectors. 414 return Vec2 ? TargetTransformInfo::SK_PermuteTwoSrc 415 : TargetTransformInfo::SK_PermuteSingleSrc; 416 } 417 418 namespace { 419 420 /// Main data required for vectorization of instructions. 421 struct InstructionsState { 422 /// The very first instruction in the list with the main opcode. 423 Value *OpValue = nullptr; 424 425 /// The main/alternate instruction. 426 Instruction *MainOp = nullptr; 427 Instruction *AltOp = nullptr; 428 429 /// The main/alternate opcodes for the list of instructions. 430 unsigned getOpcode() const { 431 return MainOp ? MainOp->getOpcode() : 0; 432 } 433 434 unsigned getAltOpcode() const { 435 return AltOp ? AltOp->getOpcode() : 0; 436 } 437 438 /// Some of the instructions in the list have alternate opcodes. 439 bool isAltShuffle() const { return AltOp != MainOp; } 440 441 bool isOpcodeOrAlt(Instruction *I) const { 442 unsigned CheckedOpcode = I->getOpcode(); 443 return getOpcode() == CheckedOpcode || getAltOpcode() == CheckedOpcode; 444 } 445 446 InstructionsState() = delete; 447 InstructionsState(Value *OpValue, Instruction *MainOp, Instruction *AltOp) 448 : OpValue(OpValue), MainOp(MainOp), AltOp(AltOp) {} 449 }; 450 451 } // end anonymous namespace 452 453 /// Chooses the correct key for scheduling data. If \p Op has the same (or 454 /// alternate) opcode as \p OpValue, the key is \p Op. Otherwise the key is \p 455 /// OpValue. 456 static Value *isOneOf(const InstructionsState &S, Value *Op) { 457 auto *I = dyn_cast<Instruction>(Op); 458 if (I && S.isOpcodeOrAlt(I)) 459 return Op; 460 return S.OpValue; 461 } 462 463 /// \returns true if \p Opcode is allowed as part of of the main/alternate 464 /// instruction for SLP vectorization. 465 /// 466 /// Example of unsupported opcode is SDIV that can potentially cause UB if the 467 /// "shuffled out" lane would result in division by zero. 468 static bool isValidForAlternation(unsigned Opcode) { 469 if (Instruction::isIntDivRem(Opcode)) 470 return false; 471 472 return true; 473 } 474 475 static InstructionsState getSameOpcode(ArrayRef<Value *> VL, 476 unsigned BaseIndex = 0); 477 478 /// Checks if the provided operands of 2 cmp instructions are compatible, i.e. 479 /// compatible instructions or constants, or just some other regular values. 480 static bool areCompatibleCmpOps(Value *BaseOp0, Value *BaseOp1, Value *Op0, 481 Value *Op1) { 482 return (isConstant(BaseOp0) && isConstant(Op0)) || 483 (isConstant(BaseOp1) && isConstant(Op1)) || 484 (!isa<Instruction>(BaseOp0) && !isa<Instruction>(Op0) && 485 !isa<Instruction>(BaseOp1) && !isa<Instruction>(Op1)) || 486 getSameOpcode({BaseOp0, Op0}).getOpcode() || 487 getSameOpcode({BaseOp1, Op1}).getOpcode(); 488 } 489 490 /// \returns analysis of the Instructions in \p VL described in 491 /// InstructionsState, the Opcode that we suppose the whole list 492 /// could be vectorized even if its structure is diverse. 493 static InstructionsState getSameOpcode(ArrayRef<Value *> VL, 494 unsigned BaseIndex) { 495 // Make sure these are all Instructions. 496 if (llvm::any_of(VL, [](Value *V) { return !isa<Instruction>(V); })) 497 return InstructionsState(VL[BaseIndex], nullptr, nullptr); 498 499 bool IsCastOp = isa<CastInst>(VL[BaseIndex]); 500 bool IsBinOp = isa<BinaryOperator>(VL[BaseIndex]); 501 bool IsCmpOp = isa<CmpInst>(VL[BaseIndex]); 502 CmpInst::Predicate BasePred = 503 IsCmpOp ? cast<CmpInst>(VL[BaseIndex])->getPredicate() 504 : CmpInst::BAD_ICMP_PREDICATE; 505 unsigned Opcode = cast<Instruction>(VL[BaseIndex])->getOpcode(); 506 unsigned AltOpcode = Opcode; 507 unsigned AltIndex = BaseIndex; 508 509 // Check for one alternate opcode from another BinaryOperator. 510 // TODO - generalize to support all operators (types, calls etc.). 511 for (int Cnt = 0, E = VL.size(); Cnt < E; Cnt++) { 512 unsigned InstOpcode = cast<Instruction>(VL[Cnt])->getOpcode(); 513 if (IsBinOp && isa<BinaryOperator>(VL[Cnt])) { 514 if (InstOpcode == Opcode || InstOpcode == AltOpcode) 515 continue; 516 if (Opcode == AltOpcode && isValidForAlternation(InstOpcode) && 517 isValidForAlternation(Opcode)) { 518 AltOpcode = InstOpcode; 519 AltIndex = Cnt; 520 continue; 521 } 522 } else if (IsCastOp && isa<CastInst>(VL[Cnt])) { 523 Type *Ty0 = cast<Instruction>(VL[BaseIndex])->getOperand(0)->getType(); 524 Type *Ty1 = cast<Instruction>(VL[Cnt])->getOperand(0)->getType(); 525 if (Ty0 == Ty1) { 526 if (InstOpcode == Opcode || InstOpcode == AltOpcode) 527 continue; 528 if (Opcode == AltOpcode) { 529 assert(isValidForAlternation(Opcode) && 530 isValidForAlternation(InstOpcode) && 531 "Cast isn't safe for alternation, logic needs to be updated!"); 532 AltOpcode = InstOpcode; 533 AltIndex = Cnt; 534 continue; 535 } 536 } 537 } else if (IsCmpOp && isa<CmpInst>(VL[Cnt])) { 538 auto *BaseInst = cast<Instruction>(VL[BaseIndex]); 539 auto *Inst = cast<Instruction>(VL[Cnt]); 540 Type *Ty0 = BaseInst->getOperand(0)->getType(); 541 Type *Ty1 = Inst->getOperand(0)->getType(); 542 if (Ty0 == Ty1) { 543 Value *BaseOp0 = BaseInst->getOperand(0); 544 Value *BaseOp1 = BaseInst->getOperand(1); 545 Value *Op0 = Inst->getOperand(0); 546 Value *Op1 = Inst->getOperand(1); 547 CmpInst::Predicate CurrentPred = 548 cast<CmpInst>(VL[Cnt])->getPredicate(); 549 CmpInst::Predicate SwappedCurrentPred = 550 CmpInst::getSwappedPredicate(CurrentPred); 551 // Check for compatible operands. If the corresponding operands are not 552 // compatible - need to perform alternate vectorization. 553 if (InstOpcode == Opcode) { 554 if (BasePred == CurrentPred && 555 areCompatibleCmpOps(BaseOp0, BaseOp1, Op0, Op1)) 556 continue; 557 if (BasePred == SwappedCurrentPred && 558 areCompatibleCmpOps(BaseOp0, BaseOp1, Op1, Op0)) 559 continue; 560 if (E == 2 && 561 (BasePred == CurrentPred || BasePred == SwappedCurrentPred)) 562 continue; 563 auto *AltInst = cast<CmpInst>(VL[AltIndex]); 564 CmpInst::Predicate AltPred = AltInst->getPredicate(); 565 Value *AltOp0 = AltInst->getOperand(0); 566 Value *AltOp1 = AltInst->getOperand(1); 567 // Check if operands are compatible with alternate operands. 568 if (AltPred == CurrentPred && 569 areCompatibleCmpOps(AltOp0, AltOp1, Op0, Op1)) 570 continue; 571 if (AltPred == SwappedCurrentPred && 572 areCompatibleCmpOps(AltOp0, AltOp1, Op1, Op0)) 573 continue; 574 } 575 if (BaseIndex == AltIndex && BasePred != CurrentPred) { 576 assert(isValidForAlternation(Opcode) && 577 isValidForAlternation(InstOpcode) && 578 "Cast isn't safe for alternation, logic needs to be updated!"); 579 AltIndex = Cnt; 580 continue; 581 } 582 auto *AltInst = cast<CmpInst>(VL[AltIndex]); 583 CmpInst::Predicate AltPred = AltInst->getPredicate(); 584 if (BasePred == CurrentPred || BasePred == SwappedCurrentPred || 585 AltPred == CurrentPred || AltPred == SwappedCurrentPred) 586 continue; 587 } 588 } else if (InstOpcode == Opcode || InstOpcode == AltOpcode) 589 continue; 590 return InstructionsState(VL[BaseIndex], nullptr, nullptr); 591 } 592 593 return InstructionsState(VL[BaseIndex], cast<Instruction>(VL[BaseIndex]), 594 cast<Instruction>(VL[AltIndex])); 595 } 596 597 /// \returns true if all of the values in \p VL have the same type or false 598 /// otherwise. 599 static bool allSameType(ArrayRef<Value *> VL) { 600 Type *Ty = VL[0]->getType(); 601 for (int i = 1, e = VL.size(); i < e; i++) 602 if (VL[i]->getType() != Ty) 603 return false; 604 605 return true; 606 } 607 608 /// \returns True if Extract{Value,Element} instruction extracts element Idx. 609 static Optional<unsigned> getExtractIndex(Instruction *E) { 610 unsigned Opcode = E->getOpcode(); 611 assert((Opcode == Instruction::ExtractElement || 612 Opcode == Instruction::ExtractValue) && 613 "Expected extractelement or extractvalue instruction."); 614 if (Opcode == Instruction::ExtractElement) { 615 auto *CI = dyn_cast<ConstantInt>(E->getOperand(1)); 616 if (!CI) 617 return None; 618 return CI->getZExtValue(); 619 } 620 ExtractValueInst *EI = cast<ExtractValueInst>(E); 621 if (EI->getNumIndices() != 1) 622 return None; 623 return *EI->idx_begin(); 624 } 625 626 /// \returns True if in-tree use also needs extract. This refers to 627 /// possible scalar operand in vectorized instruction. 628 static bool InTreeUserNeedToExtract(Value *Scalar, Instruction *UserInst, 629 TargetLibraryInfo *TLI) { 630 unsigned Opcode = UserInst->getOpcode(); 631 switch (Opcode) { 632 case Instruction::Load: { 633 LoadInst *LI = cast<LoadInst>(UserInst); 634 return (LI->getPointerOperand() == Scalar); 635 } 636 case Instruction::Store: { 637 StoreInst *SI = cast<StoreInst>(UserInst); 638 return (SI->getPointerOperand() == Scalar); 639 } 640 case Instruction::Call: { 641 CallInst *CI = cast<CallInst>(UserInst); 642 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 643 for (unsigned i = 0, e = CI->arg_size(); i != e; ++i) { 644 if (isVectorIntrinsicWithScalarOpAtArg(ID, i)) 645 return (CI->getArgOperand(i) == Scalar); 646 } 647 LLVM_FALLTHROUGH; 648 } 649 default: 650 return false; 651 } 652 } 653 654 /// \returns the AA location that is being access by the instruction. 655 static MemoryLocation getLocation(Instruction *I) { 656 if (StoreInst *SI = dyn_cast<StoreInst>(I)) 657 return MemoryLocation::get(SI); 658 if (LoadInst *LI = dyn_cast<LoadInst>(I)) 659 return MemoryLocation::get(LI); 660 return MemoryLocation(); 661 } 662 663 /// \returns True if the instruction is not a volatile or atomic load/store. 664 static bool isSimple(Instruction *I) { 665 if (LoadInst *LI = dyn_cast<LoadInst>(I)) 666 return LI->isSimple(); 667 if (StoreInst *SI = dyn_cast<StoreInst>(I)) 668 return SI->isSimple(); 669 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I)) 670 return !MI->isVolatile(); 671 return true; 672 } 673 674 /// Shuffles \p Mask in accordance with the given \p SubMask. 675 static void addMask(SmallVectorImpl<int> &Mask, ArrayRef<int> SubMask) { 676 if (SubMask.empty()) 677 return; 678 if (Mask.empty()) { 679 Mask.append(SubMask.begin(), SubMask.end()); 680 return; 681 } 682 SmallVector<int> NewMask(SubMask.size(), UndefMaskElem); 683 int TermValue = std::min(Mask.size(), SubMask.size()); 684 for (int I = 0, E = SubMask.size(); I < E; ++I) { 685 if (SubMask[I] >= TermValue || SubMask[I] == UndefMaskElem || 686 Mask[SubMask[I]] >= TermValue) 687 continue; 688 NewMask[I] = Mask[SubMask[I]]; 689 } 690 Mask.swap(NewMask); 691 } 692 693 /// Order may have elements assigned special value (size) which is out of 694 /// bounds. Such indices only appear on places which correspond to undef values 695 /// (see canReuseExtract for details) and used in order to avoid undef values 696 /// have effect on operands ordering. 697 /// The first loop below simply finds all unused indices and then the next loop 698 /// nest assigns these indices for undef values positions. 699 /// As an example below Order has two undef positions and they have assigned 700 /// values 3 and 7 respectively: 701 /// before: 6 9 5 4 9 2 1 0 702 /// after: 6 3 5 4 7 2 1 0 703 static void fixupOrderingIndices(SmallVectorImpl<unsigned> &Order) { 704 const unsigned Sz = Order.size(); 705 SmallBitVector UnusedIndices(Sz, /*t=*/true); 706 SmallBitVector MaskedIndices(Sz); 707 for (unsigned I = 0; I < Sz; ++I) { 708 if (Order[I] < Sz) 709 UnusedIndices.reset(Order[I]); 710 else 711 MaskedIndices.set(I); 712 } 713 if (MaskedIndices.none()) 714 return; 715 assert(UnusedIndices.count() == MaskedIndices.count() && 716 "Non-synced masked/available indices."); 717 int Idx = UnusedIndices.find_first(); 718 int MIdx = MaskedIndices.find_first(); 719 while (MIdx >= 0) { 720 assert(Idx >= 0 && "Indices must be synced."); 721 Order[MIdx] = Idx; 722 Idx = UnusedIndices.find_next(Idx); 723 MIdx = MaskedIndices.find_next(MIdx); 724 } 725 } 726 727 namespace llvm { 728 729 static void inversePermutation(ArrayRef<unsigned> Indices, 730 SmallVectorImpl<int> &Mask) { 731 Mask.clear(); 732 const unsigned E = Indices.size(); 733 Mask.resize(E, UndefMaskElem); 734 for (unsigned I = 0; I < E; ++I) 735 Mask[Indices[I]] = I; 736 } 737 738 /// \returns inserting index of InsertElement or InsertValue instruction, 739 /// using Offset as base offset for index. 740 static Optional<unsigned> getInsertIndex(const Value *InsertInst, 741 unsigned Offset = 0) { 742 int Index = Offset; 743 if (const auto *IE = dyn_cast<InsertElementInst>(InsertInst)) { 744 if (const auto *CI = dyn_cast<ConstantInt>(IE->getOperand(2))) { 745 auto *VT = cast<FixedVectorType>(IE->getType()); 746 if (CI->getValue().uge(VT->getNumElements())) 747 return None; 748 Index *= VT->getNumElements(); 749 Index += CI->getZExtValue(); 750 return Index; 751 } 752 return None; 753 } 754 755 const auto *IV = cast<InsertValueInst>(InsertInst); 756 Type *CurrentType = IV->getType(); 757 for (unsigned I : IV->indices()) { 758 if (const auto *ST = dyn_cast<StructType>(CurrentType)) { 759 Index *= ST->getNumElements(); 760 CurrentType = ST->getElementType(I); 761 } else if (const auto *AT = dyn_cast<ArrayType>(CurrentType)) { 762 Index *= AT->getNumElements(); 763 CurrentType = AT->getElementType(); 764 } else { 765 return None; 766 } 767 Index += I; 768 } 769 return Index; 770 } 771 772 /// Reorders the list of scalars in accordance with the given \p Mask. 773 static void reorderScalars(SmallVectorImpl<Value *> &Scalars, 774 ArrayRef<int> Mask) { 775 assert(!Mask.empty() && "Expected non-empty mask."); 776 SmallVector<Value *> Prev(Scalars.size(), 777 UndefValue::get(Scalars.front()->getType())); 778 Prev.swap(Scalars); 779 for (unsigned I = 0, E = Prev.size(); I < E; ++I) 780 if (Mask[I] != UndefMaskElem) 781 Scalars[Mask[I]] = Prev[I]; 782 } 783 784 /// Checks if the provided value does not require scheduling. It does not 785 /// require scheduling if this is not an instruction or it is an instruction 786 /// that does not read/write memory and all operands are either not instructions 787 /// or phi nodes or instructions from different blocks. 788 static bool areAllOperandsNonInsts(Value *V) { 789 auto *I = dyn_cast<Instruction>(V); 790 if (!I) 791 return true; 792 return !mayHaveNonDefUseDependency(*I) && 793 all_of(I->operands(), [I](Value *V) { 794 auto *IO = dyn_cast<Instruction>(V); 795 if (!IO) 796 return true; 797 return isa<PHINode>(IO) || IO->getParent() != I->getParent(); 798 }); 799 } 800 801 /// Checks if the provided value does not require scheduling. It does not 802 /// require scheduling if this is not an instruction or it is an instruction 803 /// that does not read/write memory and all users are phi nodes or instructions 804 /// from the different blocks. 805 static bool isUsedOutsideBlock(Value *V) { 806 auto *I = dyn_cast<Instruction>(V); 807 if (!I) 808 return true; 809 // Limits the number of uses to save compile time. 810 constexpr int UsesLimit = 8; 811 return !I->mayReadOrWriteMemory() && !I->hasNUsesOrMore(UsesLimit) && 812 all_of(I->users(), [I](User *U) { 813 auto *IU = dyn_cast<Instruction>(U); 814 if (!IU) 815 return true; 816 return IU->getParent() != I->getParent() || isa<PHINode>(IU); 817 }); 818 } 819 820 /// Checks if the specified value does not require scheduling. It does not 821 /// require scheduling if all operands and all users do not need to be scheduled 822 /// in the current basic block. 823 static bool doesNotNeedToBeScheduled(Value *V) { 824 return areAllOperandsNonInsts(V) && isUsedOutsideBlock(V); 825 } 826 827 /// Checks if the specified array of instructions does not require scheduling. 828 /// It is so if all either instructions have operands that do not require 829 /// scheduling or their users do not require scheduling since they are phis or 830 /// in other basic blocks. 831 static bool doesNotNeedToSchedule(ArrayRef<Value *> VL) { 832 return !VL.empty() && 833 (all_of(VL, isUsedOutsideBlock) || all_of(VL, areAllOperandsNonInsts)); 834 } 835 836 namespace slpvectorizer { 837 838 /// Bottom Up SLP Vectorizer. 839 class BoUpSLP { 840 struct TreeEntry; 841 struct ScheduleData; 842 843 public: 844 using ValueList = SmallVector<Value *, 8>; 845 using InstrList = SmallVector<Instruction *, 16>; 846 using ValueSet = SmallPtrSet<Value *, 16>; 847 using StoreList = SmallVector<StoreInst *, 8>; 848 using ExtraValueToDebugLocsMap = 849 MapVector<Value *, SmallVector<Instruction *, 2>>; 850 using OrdersType = SmallVector<unsigned, 4>; 851 852 BoUpSLP(Function *Func, ScalarEvolution *Se, TargetTransformInfo *Tti, 853 TargetLibraryInfo *TLi, AAResults *Aa, LoopInfo *Li, 854 DominatorTree *Dt, AssumptionCache *AC, DemandedBits *DB, 855 const DataLayout *DL, OptimizationRemarkEmitter *ORE) 856 : BatchAA(*Aa), F(Func), SE(Se), TTI(Tti), TLI(TLi), LI(Li), 857 DT(Dt), AC(AC), DB(DB), DL(DL), ORE(ORE), Builder(Se->getContext()) { 858 CodeMetrics::collectEphemeralValues(F, AC, EphValues); 859 // Use the vector register size specified by the target unless overridden 860 // by a command-line option. 861 // TODO: It would be better to limit the vectorization factor based on 862 // data type rather than just register size. For example, x86 AVX has 863 // 256-bit registers, but it does not support integer operations 864 // at that width (that requires AVX2). 865 if (MaxVectorRegSizeOption.getNumOccurrences()) 866 MaxVecRegSize = MaxVectorRegSizeOption; 867 else 868 MaxVecRegSize = 869 TTI->getRegisterBitWidth(TargetTransformInfo::RGK_FixedWidthVector) 870 .getFixedSize(); 871 872 if (MinVectorRegSizeOption.getNumOccurrences()) 873 MinVecRegSize = MinVectorRegSizeOption; 874 else 875 MinVecRegSize = TTI->getMinVectorRegisterBitWidth(); 876 } 877 878 /// Vectorize the tree that starts with the elements in \p VL. 879 /// Returns the vectorized root. 880 Value *vectorizeTree(); 881 882 /// Vectorize the tree but with the list of externally used values \p 883 /// ExternallyUsedValues. Values in this MapVector can be replaced but the 884 /// generated extractvalue instructions. 885 Value *vectorizeTree(ExtraValueToDebugLocsMap &ExternallyUsedValues); 886 887 /// \returns the cost incurred by unwanted spills and fills, caused by 888 /// holding live values over call sites. 889 InstructionCost getSpillCost() const; 890 891 /// \returns the vectorization cost of the subtree that starts at \p VL. 892 /// A negative number means that this is profitable. 893 InstructionCost getTreeCost(ArrayRef<Value *> VectorizedVals = None); 894 895 /// Construct a vectorizable tree that starts at \p Roots, ignoring users for 896 /// the purpose of scheduling and extraction in the \p UserIgnoreLst. 897 void buildTree(ArrayRef<Value *> Roots, 898 const SmallDenseSet<Value *> &UserIgnoreLst); 899 900 /// Construct a vectorizable tree that starts at \p Roots. 901 void buildTree(ArrayRef<Value *> Roots); 902 903 /// Builds external uses of the vectorized scalars, i.e. the list of 904 /// vectorized scalars to be extracted, their lanes and their scalar users. \p 905 /// ExternallyUsedValues contains additional list of external uses to handle 906 /// vectorization of reductions. 907 void 908 buildExternalUses(const ExtraValueToDebugLocsMap &ExternallyUsedValues = {}); 909 910 /// Clear the internal data structures that are created by 'buildTree'. 911 void deleteTree() { 912 VectorizableTree.clear(); 913 ScalarToTreeEntry.clear(); 914 MustGather.clear(); 915 ExternalUses.clear(); 916 for (auto &Iter : BlocksSchedules) { 917 BlockScheduling *BS = Iter.second.get(); 918 BS->clear(); 919 } 920 MinBWs.clear(); 921 InstrElementSize.clear(); 922 UserIgnoreList = nullptr; 923 } 924 925 unsigned getTreeSize() const { return VectorizableTree.size(); } 926 927 /// Perform LICM and CSE on the newly generated gather sequences. 928 void optimizeGatherSequence(); 929 930 /// Checks if the specified gather tree entry \p TE can be represented as a 931 /// shuffled vector entry + (possibly) permutation with other gathers. It 932 /// implements the checks only for possibly ordered scalars (Loads, 933 /// ExtractElement, ExtractValue), which can be part of the graph. 934 Optional<OrdersType> findReusedOrderedScalars(const TreeEntry &TE); 935 936 /// Sort loads into increasing pointers offsets to allow greater clustering. 937 Optional<OrdersType> findPartiallyOrderedLoads(const TreeEntry &TE); 938 939 /// Gets reordering data for the given tree entry. If the entry is vectorized 940 /// - just return ReorderIndices, otherwise check if the scalars can be 941 /// reordered and return the most optimal order. 942 /// \param TopToBottom If true, include the order of vectorized stores and 943 /// insertelement nodes, otherwise skip them. 944 Optional<OrdersType> getReorderingData(const TreeEntry &TE, bool TopToBottom); 945 946 /// Reorders the current graph to the most profitable order starting from the 947 /// root node to the leaf nodes. The best order is chosen only from the nodes 948 /// of the same size (vectorization factor). Smaller nodes are considered 949 /// parts of subgraph with smaller VF and they are reordered independently. We 950 /// can make it because we still need to extend smaller nodes to the wider VF 951 /// and we can merge reordering shuffles with the widening shuffles. 952 void reorderTopToBottom(); 953 954 /// Reorders the current graph to the most profitable order starting from 955 /// leaves to the root. It allows to rotate small subgraphs and reduce the 956 /// number of reshuffles if the leaf nodes use the same order. In this case we 957 /// can merge the orders and just shuffle user node instead of shuffling its 958 /// operands. Plus, even the leaf nodes have different orders, it allows to 959 /// sink reordering in the graph closer to the root node and merge it later 960 /// during analysis. 961 void reorderBottomToTop(bool IgnoreReorder = false); 962 963 /// \return The vector element size in bits to use when vectorizing the 964 /// expression tree ending at \p V. If V is a store, the size is the width of 965 /// the stored value. Otherwise, the size is the width of the largest loaded 966 /// value reaching V. This method is used by the vectorizer to calculate 967 /// vectorization factors. 968 unsigned getVectorElementSize(Value *V); 969 970 /// Compute the minimum type sizes required to represent the entries in a 971 /// vectorizable tree. 972 void computeMinimumValueSizes(); 973 974 // \returns maximum vector register size as set by TTI or overridden by cl::opt. 975 unsigned getMaxVecRegSize() const { 976 return MaxVecRegSize; 977 } 978 979 // \returns minimum vector register size as set by cl::opt. 980 unsigned getMinVecRegSize() const { 981 return MinVecRegSize; 982 } 983 984 unsigned getMinVF(unsigned Sz) const { 985 return std::max(2U, getMinVecRegSize() / Sz); 986 } 987 988 unsigned getMaximumVF(unsigned ElemWidth, unsigned Opcode) const { 989 unsigned MaxVF = MaxVFOption.getNumOccurrences() ? 990 MaxVFOption : TTI->getMaximumVF(ElemWidth, Opcode); 991 return MaxVF ? MaxVF : UINT_MAX; 992 } 993 994 /// Check if homogeneous aggregate is isomorphic to some VectorType. 995 /// Accepts homogeneous multidimensional aggregate of scalars/vectors like 996 /// {[4 x i16], [4 x i16]}, { <2 x float>, <2 x float> }, 997 /// {{{i16, i16}, {i16, i16}}, {{i16, i16}, {i16, i16}}} and so on. 998 /// 999 /// \returns number of elements in vector if isomorphism exists, 0 otherwise. 1000 unsigned canMapToVector(Type *T, const DataLayout &DL) const; 1001 1002 /// \returns True if the VectorizableTree is both tiny and not fully 1003 /// vectorizable. We do not vectorize such trees. 1004 bool isTreeTinyAndNotFullyVectorizable(bool ForReduction = false) const; 1005 1006 /// Assume that a legal-sized 'or'-reduction of shifted/zexted loaded values 1007 /// can be load combined in the backend. Load combining may not be allowed in 1008 /// the IR optimizer, so we do not want to alter the pattern. For example, 1009 /// partially transforming a scalar bswap() pattern into vector code is 1010 /// effectively impossible for the backend to undo. 1011 /// TODO: If load combining is allowed in the IR optimizer, this analysis 1012 /// may not be necessary. 1013 bool isLoadCombineReductionCandidate(RecurKind RdxKind) const; 1014 1015 /// Assume that a vector of stores of bitwise-or/shifted/zexted loaded values 1016 /// can be load combined in the backend. Load combining may not be allowed in 1017 /// the IR optimizer, so we do not want to alter the pattern. For example, 1018 /// partially transforming a scalar bswap() pattern into vector code is 1019 /// effectively impossible for the backend to undo. 1020 /// TODO: If load combining is allowed in the IR optimizer, this analysis 1021 /// may not be necessary. 1022 bool isLoadCombineCandidate() const; 1023 1024 OptimizationRemarkEmitter *getORE() { return ORE; } 1025 1026 /// This structure holds any data we need about the edges being traversed 1027 /// during buildTree_rec(). We keep track of: 1028 /// (i) the user TreeEntry index, and 1029 /// (ii) the index of the edge. 1030 struct EdgeInfo { 1031 EdgeInfo() = default; 1032 EdgeInfo(TreeEntry *UserTE, unsigned EdgeIdx) 1033 : UserTE(UserTE), EdgeIdx(EdgeIdx) {} 1034 /// The user TreeEntry. 1035 TreeEntry *UserTE = nullptr; 1036 /// The operand index of the use. 1037 unsigned EdgeIdx = UINT_MAX; 1038 #ifndef NDEBUG 1039 friend inline raw_ostream &operator<<(raw_ostream &OS, 1040 const BoUpSLP::EdgeInfo &EI) { 1041 EI.dump(OS); 1042 return OS; 1043 } 1044 /// Debug print. 1045 void dump(raw_ostream &OS) const { 1046 OS << "{User:" << (UserTE ? std::to_string(UserTE->Idx) : "null") 1047 << " EdgeIdx:" << EdgeIdx << "}"; 1048 } 1049 LLVM_DUMP_METHOD void dump() const { dump(dbgs()); } 1050 #endif 1051 }; 1052 1053 /// A helper class used for scoring candidates for two consecutive lanes. 1054 class LookAheadHeuristics { 1055 const DataLayout &DL; 1056 ScalarEvolution &SE; 1057 const BoUpSLP &R; 1058 int NumLanes; // Total number of lanes (aka vectorization factor). 1059 int MaxLevel; // The maximum recursion depth for accumulating score. 1060 1061 public: 1062 LookAheadHeuristics(const DataLayout &DL, ScalarEvolution &SE, 1063 const BoUpSLP &R, int NumLanes, int MaxLevel) 1064 : DL(DL), SE(SE), R(R), NumLanes(NumLanes), MaxLevel(MaxLevel) {} 1065 1066 // The hard-coded scores listed here are not very important, though it shall 1067 // be higher for better matches to improve the resulting cost. When 1068 // computing the scores of matching one sub-tree with another, we are 1069 // basically counting the number of values that are matching. So even if all 1070 // scores are set to 1, we would still get a decent matching result. 1071 // However, sometimes we have to break ties. For example we may have to 1072 // choose between matching loads vs matching opcodes. This is what these 1073 // scores are helping us with: they provide the order of preference. Also, 1074 // this is important if the scalar is externally used or used in another 1075 // tree entry node in the different lane. 1076 1077 /// Loads from consecutive memory addresses, e.g. load(A[i]), load(A[i+1]). 1078 static const int ScoreConsecutiveLoads = 4; 1079 /// The same load multiple times. This should have a better score than 1080 /// `ScoreSplat` because it in x86 for a 2-lane vector we can represent it 1081 /// with `movddup (%reg), xmm0` which has a throughput of 0.5 versus 0.5 for 1082 /// a vector load and 1.0 for a broadcast. 1083 static const int ScoreSplatLoads = 3; 1084 /// Loads from reversed memory addresses, e.g. load(A[i+1]), load(A[i]). 1085 static const int ScoreReversedLoads = 3; 1086 /// ExtractElementInst from same vector and consecutive indexes. 1087 static const int ScoreConsecutiveExtracts = 4; 1088 /// ExtractElementInst from same vector and reversed indices. 1089 static const int ScoreReversedExtracts = 3; 1090 /// Constants. 1091 static const int ScoreConstants = 2; 1092 /// Instructions with the same opcode. 1093 static const int ScoreSameOpcode = 2; 1094 /// Instructions with alt opcodes (e.g, add + sub). 1095 static const int ScoreAltOpcodes = 1; 1096 /// Identical instructions (a.k.a. splat or broadcast). 1097 static const int ScoreSplat = 1; 1098 /// Matching with an undef is preferable to failing. 1099 static const int ScoreUndef = 1; 1100 /// Score for failing to find a decent match. 1101 static const int ScoreFail = 0; 1102 /// Score if all users are vectorized. 1103 static const int ScoreAllUserVectorized = 1; 1104 1105 /// \returns the score of placing \p V1 and \p V2 in consecutive lanes. 1106 /// \p U1 and \p U2 are the users of \p V1 and \p V2. 1107 /// Also, checks if \p V1 and \p V2 are compatible with instructions in \p 1108 /// MainAltOps. 1109 int getShallowScore(Value *V1, Value *V2, Instruction *U1, Instruction *U2, 1110 ArrayRef<Value *> MainAltOps) const { 1111 if (V1 == V2) { 1112 if (isa<LoadInst>(V1)) { 1113 // Retruns true if the users of V1 and V2 won't need to be extracted. 1114 auto AllUsersAreInternal = [U1, U2, this](Value *V1, Value *V2) { 1115 // Bail out if we have too many uses to save compilation time. 1116 static constexpr unsigned Limit = 8; 1117 if (V1->hasNUsesOrMore(Limit) || V2->hasNUsesOrMore(Limit)) 1118 return false; 1119 1120 auto AllUsersVectorized = [U1, U2, this](Value *V) { 1121 return llvm::all_of(V->users(), [U1, U2, this](Value *U) { 1122 return U == U1 || U == U2 || R.getTreeEntry(U) != nullptr; 1123 }); 1124 }; 1125 return AllUsersVectorized(V1) && AllUsersVectorized(V2); 1126 }; 1127 // A broadcast of a load can be cheaper on some targets. 1128 if (R.TTI->isLegalBroadcastLoad(V1->getType(), 1129 ElementCount::getFixed(NumLanes)) && 1130 ((int)V1->getNumUses() == NumLanes || 1131 AllUsersAreInternal(V1, V2))) 1132 return LookAheadHeuristics::ScoreSplatLoads; 1133 } 1134 return LookAheadHeuristics::ScoreSplat; 1135 } 1136 1137 auto *LI1 = dyn_cast<LoadInst>(V1); 1138 auto *LI2 = dyn_cast<LoadInst>(V2); 1139 if (LI1 && LI2) { 1140 if (LI1->getParent() != LI2->getParent()) 1141 return LookAheadHeuristics::ScoreFail; 1142 1143 Optional<int> Dist = getPointersDiff( 1144 LI1->getType(), LI1->getPointerOperand(), LI2->getType(), 1145 LI2->getPointerOperand(), DL, SE, /*StrictCheck=*/true); 1146 if (!Dist || *Dist == 0) 1147 return LookAheadHeuristics::ScoreFail; 1148 // The distance is too large - still may be profitable to use masked 1149 // loads/gathers. 1150 if (std::abs(*Dist) > NumLanes / 2) 1151 return LookAheadHeuristics::ScoreAltOpcodes; 1152 // This still will detect consecutive loads, but we might have "holes" 1153 // in some cases. It is ok for non-power-2 vectorization and may produce 1154 // better results. It should not affect current vectorization. 1155 return (*Dist > 0) ? LookAheadHeuristics::ScoreConsecutiveLoads 1156 : LookAheadHeuristics::ScoreReversedLoads; 1157 } 1158 1159 auto *C1 = dyn_cast<Constant>(V1); 1160 auto *C2 = dyn_cast<Constant>(V2); 1161 if (C1 && C2) 1162 return LookAheadHeuristics::ScoreConstants; 1163 1164 // Extracts from consecutive indexes of the same vector better score as 1165 // the extracts could be optimized away. 1166 Value *EV1; 1167 ConstantInt *Ex1Idx; 1168 if (match(V1, m_ExtractElt(m_Value(EV1), m_ConstantInt(Ex1Idx)))) { 1169 // Undefs are always profitable for extractelements. 1170 if (isa<UndefValue>(V2)) 1171 return LookAheadHeuristics::ScoreConsecutiveExtracts; 1172 Value *EV2 = nullptr; 1173 ConstantInt *Ex2Idx = nullptr; 1174 if (match(V2, 1175 m_ExtractElt(m_Value(EV2), m_CombineOr(m_ConstantInt(Ex2Idx), 1176 m_Undef())))) { 1177 // Undefs are always profitable for extractelements. 1178 if (!Ex2Idx) 1179 return LookAheadHeuristics::ScoreConsecutiveExtracts; 1180 if (isUndefVector(EV2) && EV2->getType() == EV1->getType()) 1181 return LookAheadHeuristics::ScoreConsecutiveExtracts; 1182 if (EV2 == EV1) { 1183 int Idx1 = Ex1Idx->getZExtValue(); 1184 int Idx2 = Ex2Idx->getZExtValue(); 1185 int Dist = Idx2 - Idx1; 1186 // The distance is too large - still may be profitable to use 1187 // shuffles. 1188 if (std::abs(Dist) == 0) 1189 return LookAheadHeuristics::ScoreSplat; 1190 if (std::abs(Dist) > NumLanes / 2) 1191 return LookAheadHeuristics::ScoreSameOpcode; 1192 return (Dist > 0) ? LookAheadHeuristics::ScoreConsecutiveExtracts 1193 : LookAheadHeuristics::ScoreReversedExtracts; 1194 } 1195 return LookAheadHeuristics::ScoreAltOpcodes; 1196 } 1197 return LookAheadHeuristics::ScoreFail; 1198 } 1199 1200 auto *I1 = dyn_cast<Instruction>(V1); 1201 auto *I2 = dyn_cast<Instruction>(V2); 1202 if (I1 && I2) { 1203 if (I1->getParent() != I2->getParent()) 1204 return LookAheadHeuristics::ScoreFail; 1205 SmallVector<Value *, 4> Ops(MainAltOps.begin(), MainAltOps.end()); 1206 Ops.push_back(I1); 1207 Ops.push_back(I2); 1208 InstructionsState S = getSameOpcode(Ops); 1209 // Note: Only consider instructions with <= 2 operands to avoid 1210 // complexity explosion. 1211 if (S.getOpcode() && 1212 (S.MainOp->getNumOperands() <= 2 || !MainAltOps.empty() || 1213 !S.isAltShuffle()) && 1214 all_of(Ops, [&S](Value *V) { 1215 return cast<Instruction>(V)->getNumOperands() == 1216 S.MainOp->getNumOperands(); 1217 })) 1218 return S.isAltShuffle() ? LookAheadHeuristics::ScoreAltOpcodes 1219 : LookAheadHeuristics::ScoreSameOpcode; 1220 } 1221 1222 if (isa<UndefValue>(V2)) 1223 return LookAheadHeuristics::ScoreUndef; 1224 1225 return LookAheadHeuristics::ScoreFail; 1226 } 1227 1228 /// Go through the operands of \p LHS and \p RHS recursively until 1229 /// MaxLevel, and return the cummulative score. \p U1 and \p U2 are 1230 /// the users of \p LHS and \p RHS (that is \p LHS and \p RHS are operands 1231 /// of \p U1 and \p U2), except at the beginning of the recursion where 1232 /// these are set to nullptr. 1233 /// 1234 /// For example: 1235 /// \verbatim 1236 /// A[0] B[0] A[1] B[1] C[0] D[0] B[1] A[1] 1237 /// \ / \ / \ / \ / 1238 /// + + + + 1239 /// G1 G2 G3 G4 1240 /// \endverbatim 1241 /// The getScoreAtLevelRec(G1, G2) function will try to match the nodes at 1242 /// each level recursively, accumulating the score. It starts from matching 1243 /// the additions at level 0, then moves on to the loads (level 1). The 1244 /// score of G1 and G2 is higher than G1 and G3, because {A[0],A[1]} and 1245 /// {B[0],B[1]} match with LookAheadHeuristics::ScoreConsecutiveLoads, while 1246 /// {A[0],C[0]} has a score of LookAheadHeuristics::ScoreFail. 1247 /// Please note that the order of the operands does not matter, as we 1248 /// evaluate the score of all profitable combinations of operands. In 1249 /// other words the score of G1 and G4 is the same as G1 and G2. This 1250 /// heuristic is based on ideas described in: 1251 /// Look-ahead SLP: Auto-vectorization in the presence of commutative 1252 /// operations, CGO 2018 by Vasileios Porpodas, Rodrigo C. O. Rocha, 1253 /// Luís F. W. Góes 1254 int getScoreAtLevelRec(Value *LHS, Value *RHS, Instruction *U1, 1255 Instruction *U2, int CurrLevel, 1256 ArrayRef<Value *> MainAltOps) const { 1257 1258 // Get the shallow score of V1 and V2. 1259 int ShallowScoreAtThisLevel = 1260 getShallowScore(LHS, RHS, U1, U2, MainAltOps); 1261 1262 // If reached MaxLevel, 1263 // or if V1 and V2 are not instructions, 1264 // or if they are SPLAT, 1265 // or if they are not consecutive, 1266 // or if profitable to vectorize loads or extractelements, early return 1267 // the current cost. 1268 auto *I1 = dyn_cast<Instruction>(LHS); 1269 auto *I2 = dyn_cast<Instruction>(RHS); 1270 if (CurrLevel == MaxLevel || !(I1 && I2) || I1 == I2 || 1271 ShallowScoreAtThisLevel == LookAheadHeuristics::ScoreFail || 1272 (((isa<LoadInst>(I1) && isa<LoadInst>(I2)) || 1273 (I1->getNumOperands() > 2 && I2->getNumOperands() > 2) || 1274 (isa<ExtractElementInst>(I1) && isa<ExtractElementInst>(I2))) && 1275 ShallowScoreAtThisLevel)) 1276 return ShallowScoreAtThisLevel; 1277 assert(I1 && I2 && "Should have early exited."); 1278 1279 // Contains the I2 operand indexes that got matched with I1 operands. 1280 SmallSet<unsigned, 4> Op2Used; 1281 1282 // Recursion towards the operands of I1 and I2. We are trying all possible 1283 // operand pairs, and keeping track of the best score. 1284 for (unsigned OpIdx1 = 0, NumOperands1 = I1->getNumOperands(); 1285 OpIdx1 != NumOperands1; ++OpIdx1) { 1286 // Try to pair op1I with the best operand of I2. 1287 int MaxTmpScore = 0; 1288 unsigned MaxOpIdx2 = 0; 1289 bool FoundBest = false; 1290 // If I2 is commutative try all combinations. 1291 unsigned FromIdx = isCommutative(I2) ? 0 : OpIdx1; 1292 unsigned ToIdx = isCommutative(I2) 1293 ? I2->getNumOperands() 1294 : std::min(I2->getNumOperands(), OpIdx1 + 1); 1295 assert(FromIdx <= ToIdx && "Bad index"); 1296 for (unsigned OpIdx2 = FromIdx; OpIdx2 != ToIdx; ++OpIdx2) { 1297 // Skip operands already paired with OpIdx1. 1298 if (Op2Used.count(OpIdx2)) 1299 continue; 1300 // Recursively calculate the cost at each level 1301 int TmpScore = 1302 getScoreAtLevelRec(I1->getOperand(OpIdx1), I2->getOperand(OpIdx2), 1303 I1, I2, CurrLevel + 1, None); 1304 // Look for the best score. 1305 if (TmpScore > LookAheadHeuristics::ScoreFail && 1306 TmpScore > MaxTmpScore) { 1307 MaxTmpScore = TmpScore; 1308 MaxOpIdx2 = OpIdx2; 1309 FoundBest = true; 1310 } 1311 } 1312 if (FoundBest) { 1313 // Pair {OpIdx1, MaxOpIdx2} was found to be best. Never revisit it. 1314 Op2Used.insert(MaxOpIdx2); 1315 ShallowScoreAtThisLevel += MaxTmpScore; 1316 } 1317 } 1318 return ShallowScoreAtThisLevel; 1319 } 1320 }; 1321 /// A helper data structure to hold the operands of a vector of instructions. 1322 /// This supports a fixed vector length for all operand vectors. 1323 class VLOperands { 1324 /// For each operand we need (i) the value, and (ii) the opcode that it 1325 /// would be attached to if the expression was in a left-linearized form. 1326 /// This is required to avoid illegal operand reordering. 1327 /// For example: 1328 /// \verbatim 1329 /// 0 Op1 1330 /// |/ 1331 /// Op1 Op2 Linearized + Op2 1332 /// \ / ----------> |/ 1333 /// - - 1334 /// 1335 /// Op1 - Op2 (0 + Op1) - Op2 1336 /// \endverbatim 1337 /// 1338 /// Value Op1 is attached to a '+' operation, and Op2 to a '-'. 1339 /// 1340 /// Another way to think of this is to track all the operations across the 1341 /// path from the operand all the way to the root of the tree and to 1342 /// calculate the operation that corresponds to this path. For example, the 1343 /// path from Op2 to the root crosses the RHS of the '-', therefore the 1344 /// corresponding operation is a '-' (which matches the one in the 1345 /// linearized tree, as shown above). 1346 /// 1347 /// For lack of a better term, we refer to this operation as Accumulated 1348 /// Path Operation (APO). 1349 struct OperandData { 1350 OperandData() = default; 1351 OperandData(Value *V, bool APO, bool IsUsed) 1352 : V(V), APO(APO), IsUsed(IsUsed) {} 1353 /// The operand value. 1354 Value *V = nullptr; 1355 /// TreeEntries only allow a single opcode, or an alternate sequence of 1356 /// them (e.g, +, -). Therefore, we can safely use a boolean value for the 1357 /// APO. It is set to 'true' if 'V' is attached to an inverse operation 1358 /// in the left-linearized form (e.g., Sub/Div), and 'false' otherwise 1359 /// (e.g., Add/Mul) 1360 bool APO = false; 1361 /// Helper data for the reordering function. 1362 bool IsUsed = false; 1363 }; 1364 1365 /// During operand reordering, we are trying to select the operand at lane 1366 /// that matches best with the operand at the neighboring lane. Our 1367 /// selection is based on the type of value we are looking for. For example, 1368 /// if the neighboring lane has a load, we need to look for a load that is 1369 /// accessing a consecutive address. These strategies are summarized in the 1370 /// 'ReorderingMode' enumerator. 1371 enum class ReorderingMode { 1372 Load, ///< Matching loads to consecutive memory addresses 1373 Opcode, ///< Matching instructions based on opcode (same or alternate) 1374 Constant, ///< Matching constants 1375 Splat, ///< Matching the same instruction multiple times (broadcast) 1376 Failed, ///< We failed to create a vectorizable group 1377 }; 1378 1379 using OperandDataVec = SmallVector<OperandData, 2>; 1380 1381 /// A vector of operand vectors. 1382 SmallVector<OperandDataVec, 4> OpsVec; 1383 1384 const DataLayout &DL; 1385 ScalarEvolution &SE; 1386 const BoUpSLP &R; 1387 1388 /// \returns the operand data at \p OpIdx and \p Lane. 1389 OperandData &getData(unsigned OpIdx, unsigned Lane) { 1390 return OpsVec[OpIdx][Lane]; 1391 } 1392 1393 /// \returns the operand data at \p OpIdx and \p Lane. Const version. 1394 const OperandData &getData(unsigned OpIdx, unsigned Lane) const { 1395 return OpsVec[OpIdx][Lane]; 1396 } 1397 1398 /// Clears the used flag for all entries. 1399 void clearUsed() { 1400 for (unsigned OpIdx = 0, NumOperands = getNumOperands(); 1401 OpIdx != NumOperands; ++OpIdx) 1402 for (unsigned Lane = 0, NumLanes = getNumLanes(); Lane != NumLanes; 1403 ++Lane) 1404 OpsVec[OpIdx][Lane].IsUsed = false; 1405 } 1406 1407 /// Swap the operand at \p OpIdx1 with that one at \p OpIdx2. 1408 void swap(unsigned OpIdx1, unsigned OpIdx2, unsigned Lane) { 1409 std::swap(OpsVec[OpIdx1][Lane], OpsVec[OpIdx2][Lane]); 1410 } 1411 1412 /// \param Lane lane of the operands under analysis. 1413 /// \param OpIdx operand index in \p Lane lane we're looking the best 1414 /// candidate for. 1415 /// \param Idx operand index of the current candidate value. 1416 /// \returns The additional score due to possible broadcasting of the 1417 /// elements in the lane. It is more profitable to have power-of-2 unique 1418 /// elements in the lane, it will be vectorized with higher probability 1419 /// after removing duplicates. Currently the SLP vectorizer supports only 1420 /// vectorization of the power-of-2 number of unique scalars. 1421 int getSplatScore(unsigned Lane, unsigned OpIdx, unsigned Idx) const { 1422 Value *IdxLaneV = getData(Idx, Lane).V; 1423 if (!isa<Instruction>(IdxLaneV) || IdxLaneV == getData(OpIdx, Lane).V) 1424 return 0; 1425 SmallPtrSet<Value *, 4> Uniques; 1426 for (unsigned Ln = 0, E = getNumLanes(); Ln < E; ++Ln) { 1427 if (Ln == Lane) 1428 continue; 1429 Value *OpIdxLnV = getData(OpIdx, Ln).V; 1430 if (!isa<Instruction>(OpIdxLnV)) 1431 return 0; 1432 Uniques.insert(OpIdxLnV); 1433 } 1434 int UniquesCount = Uniques.size(); 1435 int UniquesCntWithIdxLaneV = 1436 Uniques.contains(IdxLaneV) ? UniquesCount : UniquesCount + 1; 1437 Value *OpIdxLaneV = getData(OpIdx, Lane).V; 1438 int UniquesCntWithOpIdxLaneV = 1439 Uniques.contains(OpIdxLaneV) ? UniquesCount : UniquesCount + 1; 1440 if (UniquesCntWithIdxLaneV == UniquesCntWithOpIdxLaneV) 1441 return 0; 1442 return (PowerOf2Ceil(UniquesCntWithOpIdxLaneV) - 1443 UniquesCntWithOpIdxLaneV) - 1444 (PowerOf2Ceil(UniquesCntWithIdxLaneV) - UniquesCntWithIdxLaneV); 1445 } 1446 1447 /// \param Lane lane of the operands under analysis. 1448 /// \param OpIdx operand index in \p Lane lane we're looking the best 1449 /// candidate for. 1450 /// \param Idx operand index of the current candidate value. 1451 /// \returns The additional score for the scalar which users are all 1452 /// vectorized. 1453 int getExternalUseScore(unsigned Lane, unsigned OpIdx, unsigned Idx) const { 1454 Value *IdxLaneV = getData(Idx, Lane).V; 1455 Value *OpIdxLaneV = getData(OpIdx, Lane).V; 1456 // Do not care about number of uses for vector-like instructions 1457 // (extractelement/extractvalue with constant indices), they are extracts 1458 // themselves and already externally used. Vectorization of such 1459 // instructions does not add extra extractelement instruction, just may 1460 // remove it. 1461 if (isVectorLikeInstWithConstOps(IdxLaneV) && 1462 isVectorLikeInstWithConstOps(OpIdxLaneV)) 1463 return LookAheadHeuristics::ScoreAllUserVectorized; 1464 auto *IdxLaneI = dyn_cast<Instruction>(IdxLaneV); 1465 if (!IdxLaneI || !isa<Instruction>(OpIdxLaneV)) 1466 return 0; 1467 return R.areAllUsersVectorized(IdxLaneI, None) 1468 ? LookAheadHeuristics::ScoreAllUserVectorized 1469 : 0; 1470 } 1471 1472 /// Score scaling factor for fully compatible instructions but with 1473 /// different number of external uses. Allows better selection of the 1474 /// instructions with less external uses. 1475 static const int ScoreScaleFactor = 10; 1476 1477 /// \Returns the look-ahead score, which tells us how much the sub-trees 1478 /// rooted at \p LHS and \p RHS match, the more they match the higher the 1479 /// score. This helps break ties in an informed way when we cannot decide on 1480 /// the order of the operands by just considering the immediate 1481 /// predecessors. 1482 int getLookAheadScore(Value *LHS, Value *RHS, ArrayRef<Value *> MainAltOps, 1483 int Lane, unsigned OpIdx, unsigned Idx, 1484 bool &IsUsed) { 1485 LookAheadHeuristics LookAhead(DL, SE, R, getNumLanes(), 1486 LookAheadMaxDepth); 1487 // Keep track of the instruction stack as we recurse into the operands 1488 // during the look-ahead score exploration. 1489 int Score = 1490 LookAhead.getScoreAtLevelRec(LHS, RHS, /*U1=*/nullptr, /*U2=*/nullptr, 1491 /*CurrLevel=*/1, MainAltOps); 1492 if (Score) { 1493 int SplatScore = getSplatScore(Lane, OpIdx, Idx); 1494 if (Score <= -SplatScore) { 1495 // Set the minimum score for splat-like sequence to avoid setting 1496 // failed state. 1497 Score = 1; 1498 } else { 1499 Score += SplatScore; 1500 // Scale score to see the difference between different operands 1501 // and similar operands but all vectorized/not all vectorized 1502 // uses. It does not affect actual selection of the best 1503 // compatible operand in general, just allows to select the 1504 // operand with all vectorized uses. 1505 Score *= ScoreScaleFactor; 1506 Score += getExternalUseScore(Lane, OpIdx, Idx); 1507 IsUsed = true; 1508 } 1509 } 1510 return Score; 1511 } 1512 1513 /// Best defined scores per lanes between the passes. Used to choose the 1514 /// best operand (with the highest score) between the passes. 1515 /// The key - {Operand Index, Lane}. 1516 /// The value - the best score between the passes for the lane and the 1517 /// operand. 1518 SmallDenseMap<std::pair<unsigned, unsigned>, unsigned, 8> 1519 BestScoresPerLanes; 1520 1521 // Search all operands in Ops[*][Lane] for the one that matches best 1522 // Ops[OpIdx][LastLane] and return its opreand index. 1523 // If no good match can be found, return None. 1524 Optional<unsigned> getBestOperand(unsigned OpIdx, int Lane, int LastLane, 1525 ArrayRef<ReorderingMode> ReorderingModes, 1526 ArrayRef<Value *> MainAltOps) { 1527 unsigned NumOperands = getNumOperands(); 1528 1529 // The operand of the previous lane at OpIdx. 1530 Value *OpLastLane = getData(OpIdx, LastLane).V; 1531 1532 // Our strategy mode for OpIdx. 1533 ReorderingMode RMode = ReorderingModes[OpIdx]; 1534 if (RMode == ReorderingMode::Failed) 1535 return None; 1536 1537 // The linearized opcode of the operand at OpIdx, Lane. 1538 bool OpIdxAPO = getData(OpIdx, Lane).APO; 1539 1540 // The best operand index and its score. 1541 // Sometimes we have more than one option (e.g., Opcode and Undefs), so we 1542 // are using the score to differentiate between the two. 1543 struct BestOpData { 1544 Optional<unsigned> Idx = None; 1545 unsigned Score = 0; 1546 } BestOp; 1547 BestOp.Score = 1548 BestScoresPerLanes.try_emplace(std::make_pair(OpIdx, Lane), 0) 1549 .first->second; 1550 1551 // Track if the operand must be marked as used. If the operand is set to 1552 // Score 1 explicitly (because of non power-of-2 unique scalars, we may 1553 // want to reestimate the operands again on the following iterations). 1554 bool IsUsed = 1555 RMode == ReorderingMode::Splat || RMode == ReorderingMode::Constant; 1556 // Iterate through all unused operands and look for the best. 1557 for (unsigned Idx = 0; Idx != NumOperands; ++Idx) { 1558 // Get the operand at Idx and Lane. 1559 OperandData &OpData = getData(Idx, Lane); 1560 Value *Op = OpData.V; 1561 bool OpAPO = OpData.APO; 1562 1563 // Skip already selected operands. 1564 if (OpData.IsUsed) 1565 continue; 1566 1567 // Skip if we are trying to move the operand to a position with a 1568 // different opcode in the linearized tree form. This would break the 1569 // semantics. 1570 if (OpAPO != OpIdxAPO) 1571 continue; 1572 1573 // Look for an operand that matches the current mode. 1574 switch (RMode) { 1575 case ReorderingMode::Load: 1576 case ReorderingMode::Constant: 1577 case ReorderingMode::Opcode: { 1578 bool LeftToRight = Lane > LastLane; 1579 Value *OpLeft = (LeftToRight) ? OpLastLane : Op; 1580 Value *OpRight = (LeftToRight) ? Op : OpLastLane; 1581 int Score = getLookAheadScore(OpLeft, OpRight, MainAltOps, Lane, 1582 OpIdx, Idx, IsUsed); 1583 if (Score > static_cast<int>(BestOp.Score)) { 1584 BestOp.Idx = Idx; 1585 BestOp.Score = Score; 1586 BestScoresPerLanes[std::make_pair(OpIdx, Lane)] = Score; 1587 } 1588 break; 1589 } 1590 case ReorderingMode::Splat: 1591 if (Op == OpLastLane) 1592 BestOp.Idx = Idx; 1593 break; 1594 case ReorderingMode::Failed: 1595 llvm_unreachable("Not expected Failed reordering mode."); 1596 } 1597 } 1598 1599 if (BestOp.Idx) { 1600 getData(BestOp.Idx.getValue(), Lane).IsUsed = IsUsed; 1601 return BestOp.Idx; 1602 } 1603 // If we could not find a good match return None. 1604 return None; 1605 } 1606 1607 /// Helper for reorderOperandVecs. 1608 /// \returns the lane that we should start reordering from. This is the one 1609 /// which has the least number of operands that can freely move about or 1610 /// less profitable because it already has the most optimal set of operands. 1611 unsigned getBestLaneToStartReordering() const { 1612 unsigned Min = UINT_MAX; 1613 unsigned SameOpNumber = 0; 1614 // std::pair<unsigned, unsigned> is used to implement a simple voting 1615 // algorithm and choose the lane with the least number of operands that 1616 // can freely move about or less profitable because it already has the 1617 // most optimal set of operands. The first unsigned is a counter for 1618 // voting, the second unsigned is the counter of lanes with instructions 1619 // with same/alternate opcodes and same parent basic block. 1620 MapVector<unsigned, std::pair<unsigned, unsigned>> HashMap; 1621 // Try to be closer to the original results, if we have multiple lanes 1622 // with same cost. If 2 lanes have the same cost, use the one with the 1623 // lowest index. 1624 for (int I = getNumLanes(); I > 0; --I) { 1625 unsigned Lane = I - 1; 1626 OperandsOrderData NumFreeOpsHash = 1627 getMaxNumOperandsThatCanBeReordered(Lane); 1628 // Compare the number of operands that can move and choose the one with 1629 // the least number. 1630 if (NumFreeOpsHash.NumOfAPOs < Min) { 1631 Min = NumFreeOpsHash.NumOfAPOs; 1632 SameOpNumber = NumFreeOpsHash.NumOpsWithSameOpcodeParent; 1633 HashMap.clear(); 1634 HashMap[NumFreeOpsHash.Hash] = std::make_pair(1, Lane); 1635 } else if (NumFreeOpsHash.NumOfAPOs == Min && 1636 NumFreeOpsHash.NumOpsWithSameOpcodeParent < SameOpNumber) { 1637 // Select the most optimal lane in terms of number of operands that 1638 // should be moved around. 1639 SameOpNumber = NumFreeOpsHash.NumOpsWithSameOpcodeParent; 1640 HashMap[NumFreeOpsHash.Hash] = std::make_pair(1, Lane); 1641 } else if (NumFreeOpsHash.NumOfAPOs == Min && 1642 NumFreeOpsHash.NumOpsWithSameOpcodeParent == SameOpNumber) { 1643 auto It = HashMap.find(NumFreeOpsHash.Hash); 1644 if (It == HashMap.end()) 1645 HashMap[NumFreeOpsHash.Hash] = std::make_pair(1, Lane); 1646 else 1647 ++It->second.first; 1648 } 1649 } 1650 // Select the lane with the minimum counter. 1651 unsigned BestLane = 0; 1652 unsigned CntMin = UINT_MAX; 1653 for (const auto &Data : reverse(HashMap)) { 1654 if (Data.second.first < CntMin) { 1655 CntMin = Data.second.first; 1656 BestLane = Data.second.second; 1657 } 1658 } 1659 return BestLane; 1660 } 1661 1662 /// Data structure that helps to reorder operands. 1663 struct OperandsOrderData { 1664 /// The best number of operands with the same APOs, which can be 1665 /// reordered. 1666 unsigned NumOfAPOs = UINT_MAX; 1667 /// Number of operands with the same/alternate instruction opcode and 1668 /// parent. 1669 unsigned NumOpsWithSameOpcodeParent = 0; 1670 /// Hash for the actual operands ordering. 1671 /// Used to count operands, actually their position id and opcode 1672 /// value. It is used in the voting mechanism to find the lane with the 1673 /// least number of operands that can freely move about or less profitable 1674 /// because it already has the most optimal set of operands. Can be 1675 /// replaced with SmallVector<unsigned> instead but hash code is faster 1676 /// and requires less memory. 1677 unsigned Hash = 0; 1678 }; 1679 /// \returns the maximum number of operands that are allowed to be reordered 1680 /// for \p Lane and the number of compatible instructions(with the same 1681 /// parent/opcode). This is used as a heuristic for selecting the first lane 1682 /// to start operand reordering. 1683 OperandsOrderData getMaxNumOperandsThatCanBeReordered(unsigned Lane) const { 1684 unsigned CntTrue = 0; 1685 unsigned NumOperands = getNumOperands(); 1686 // Operands with the same APO can be reordered. We therefore need to count 1687 // how many of them we have for each APO, like this: Cnt[APO] = x. 1688 // Since we only have two APOs, namely true and false, we can avoid using 1689 // a map. Instead we can simply count the number of operands that 1690 // correspond to one of them (in this case the 'true' APO), and calculate 1691 // the other by subtracting it from the total number of operands. 1692 // Operands with the same instruction opcode and parent are more 1693 // profitable since we don't need to move them in many cases, with a high 1694 // probability such lane already can be vectorized effectively. 1695 bool AllUndefs = true; 1696 unsigned NumOpsWithSameOpcodeParent = 0; 1697 Instruction *OpcodeI = nullptr; 1698 BasicBlock *Parent = nullptr; 1699 unsigned Hash = 0; 1700 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1701 const OperandData &OpData = getData(OpIdx, Lane); 1702 if (OpData.APO) 1703 ++CntTrue; 1704 // Use Boyer-Moore majority voting for finding the majority opcode and 1705 // the number of times it occurs. 1706 if (auto *I = dyn_cast<Instruction>(OpData.V)) { 1707 if (!OpcodeI || !getSameOpcode({OpcodeI, I}).getOpcode() || 1708 I->getParent() != Parent) { 1709 if (NumOpsWithSameOpcodeParent == 0) { 1710 NumOpsWithSameOpcodeParent = 1; 1711 OpcodeI = I; 1712 Parent = I->getParent(); 1713 } else { 1714 --NumOpsWithSameOpcodeParent; 1715 } 1716 } else { 1717 ++NumOpsWithSameOpcodeParent; 1718 } 1719 } 1720 Hash = hash_combine( 1721 Hash, hash_value((OpIdx + 1) * (OpData.V->getValueID() + 1))); 1722 AllUndefs = AllUndefs && isa<UndefValue>(OpData.V); 1723 } 1724 if (AllUndefs) 1725 return {}; 1726 OperandsOrderData Data; 1727 Data.NumOfAPOs = std::max(CntTrue, NumOperands - CntTrue); 1728 Data.NumOpsWithSameOpcodeParent = NumOpsWithSameOpcodeParent; 1729 Data.Hash = Hash; 1730 return Data; 1731 } 1732 1733 /// Go through the instructions in VL and append their operands. 1734 void appendOperandsOfVL(ArrayRef<Value *> VL) { 1735 assert(!VL.empty() && "Bad VL"); 1736 assert((empty() || VL.size() == getNumLanes()) && 1737 "Expected same number of lanes"); 1738 assert(isa<Instruction>(VL[0]) && "Expected instruction"); 1739 unsigned NumOperands = cast<Instruction>(VL[0])->getNumOperands(); 1740 OpsVec.resize(NumOperands); 1741 unsigned NumLanes = VL.size(); 1742 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1743 OpsVec[OpIdx].resize(NumLanes); 1744 for (unsigned Lane = 0; Lane != NumLanes; ++Lane) { 1745 assert(isa<Instruction>(VL[Lane]) && "Expected instruction"); 1746 // Our tree has just 3 nodes: the root and two operands. 1747 // It is therefore trivial to get the APO. We only need to check the 1748 // opcode of VL[Lane] and whether the operand at OpIdx is the LHS or 1749 // RHS operand. The LHS operand of both add and sub is never attached 1750 // to an inversese operation in the linearized form, therefore its APO 1751 // is false. The RHS is true only if VL[Lane] is an inverse operation. 1752 1753 // Since operand reordering is performed on groups of commutative 1754 // operations or alternating sequences (e.g., +, -), we can safely 1755 // tell the inverse operations by checking commutativity. 1756 bool IsInverseOperation = !isCommutative(cast<Instruction>(VL[Lane])); 1757 bool APO = (OpIdx == 0) ? false : IsInverseOperation; 1758 OpsVec[OpIdx][Lane] = {cast<Instruction>(VL[Lane])->getOperand(OpIdx), 1759 APO, false}; 1760 } 1761 } 1762 } 1763 1764 /// \returns the number of operands. 1765 unsigned getNumOperands() const { return OpsVec.size(); } 1766 1767 /// \returns the number of lanes. 1768 unsigned getNumLanes() const { return OpsVec[0].size(); } 1769 1770 /// \returns the operand value at \p OpIdx and \p Lane. 1771 Value *getValue(unsigned OpIdx, unsigned Lane) const { 1772 return getData(OpIdx, Lane).V; 1773 } 1774 1775 /// \returns true if the data structure is empty. 1776 bool empty() const { return OpsVec.empty(); } 1777 1778 /// Clears the data. 1779 void clear() { OpsVec.clear(); } 1780 1781 /// \Returns true if there are enough operands identical to \p Op to fill 1782 /// the whole vector. 1783 /// Note: This modifies the 'IsUsed' flag, so a cleanUsed() must follow. 1784 bool shouldBroadcast(Value *Op, unsigned OpIdx, unsigned Lane) { 1785 bool OpAPO = getData(OpIdx, Lane).APO; 1786 for (unsigned Ln = 0, Lns = getNumLanes(); Ln != Lns; ++Ln) { 1787 if (Ln == Lane) 1788 continue; 1789 // This is set to true if we found a candidate for broadcast at Lane. 1790 bool FoundCandidate = false; 1791 for (unsigned OpI = 0, OpE = getNumOperands(); OpI != OpE; ++OpI) { 1792 OperandData &Data = getData(OpI, Ln); 1793 if (Data.APO != OpAPO || Data.IsUsed) 1794 continue; 1795 if (Data.V == Op) { 1796 FoundCandidate = true; 1797 Data.IsUsed = true; 1798 break; 1799 } 1800 } 1801 if (!FoundCandidate) 1802 return false; 1803 } 1804 return true; 1805 } 1806 1807 public: 1808 /// Initialize with all the operands of the instruction vector \p RootVL. 1809 VLOperands(ArrayRef<Value *> RootVL, const DataLayout &DL, 1810 ScalarEvolution &SE, const BoUpSLP &R) 1811 : DL(DL), SE(SE), R(R) { 1812 // Append all the operands of RootVL. 1813 appendOperandsOfVL(RootVL); 1814 } 1815 1816 /// \Returns a value vector with the operands across all lanes for the 1817 /// opearnd at \p OpIdx. 1818 ValueList getVL(unsigned OpIdx) const { 1819 ValueList OpVL(OpsVec[OpIdx].size()); 1820 assert(OpsVec[OpIdx].size() == getNumLanes() && 1821 "Expected same num of lanes across all operands"); 1822 for (unsigned Lane = 0, Lanes = getNumLanes(); Lane != Lanes; ++Lane) 1823 OpVL[Lane] = OpsVec[OpIdx][Lane].V; 1824 return OpVL; 1825 } 1826 1827 // Performs operand reordering for 2 or more operands. 1828 // The original operands are in OrigOps[OpIdx][Lane]. 1829 // The reordered operands are returned in 'SortedOps[OpIdx][Lane]'. 1830 void reorder() { 1831 unsigned NumOperands = getNumOperands(); 1832 unsigned NumLanes = getNumLanes(); 1833 // Each operand has its own mode. We are using this mode to help us select 1834 // the instructions for each lane, so that they match best with the ones 1835 // we have selected so far. 1836 SmallVector<ReorderingMode, 2> ReorderingModes(NumOperands); 1837 1838 // This is a greedy single-pass algorithm. We are going over each lane 1839 // once and deciding on the best order right away with no back-tracking. 1840 // However, in order to increase its effectiveness, we start with the lane 1841 // that has operands that can move the least. For example, given the 1842 // following lanes: 1843 // Lane 0 : A[0] = B[0] + C[0] // Visited 3rd 1844 // Lane 1 : A[1] = C[1] - B[1] // Visited 1st 1845 // Lane 2 : A[2] = B[2] + C[2] // Visited 2nd 1846 // Lane 3 : A[3] = C[3] - B[3] // Visited 4th 1847 // we will start at Lane 1, since the operands of the subtraction cannot 1848 // be reordered. Then we will visit the rest of the lanes in a circular 1849 // fashion. That is, Lanes 2, then Lane 0, and finally Lane 3. 1850 1851 // Find the first lane that we will start our search from. 1852 unsigned FirstLane = getBestLaneToStartReordering(); 1853 1854 // Initialize the modes. 1855 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1856 Value *OpLane0 = getValue(OpIdx, FirstLane); 1857 // Keep track if we have instructions with all the same opcode on one 1858 // side. 1859 if (isa<LoadInst>(OpLane0)) 1860 ReorderingModes[OpIdx] = ReorderingMode::Load; 1861 else if (isa<Instruction>(OpLane0)) { 1862 // Check if OpLane0 should be broadcast. 1863 if (shouldBroadcast(OpLane0, OpIdx, FirstLane)) 1864 ReorderingModes[OpIdx] = ReorderingMode::Splat; 1865 else 1866 ReorderingModes[OpIdx] = ReorderingMode::Opcode; 1867 } 1868 else if (isa<Constant>(OpLane0)) 1869 ReorderingModes[OpIdx] = ReorderingMode::Constant; 1870 else if (isa<Argument>(OpLane0)) 1871 // Our best hope is a Splat. It may save some cost in some cases. 1872 ReorderingModes[OpIdx] = ReorderingMode::Splat; 1873 else 1874 // NOTE: This should be unreachable. 1875 ReorderingModes[OpIdx] = ReorderingMode::Failed; 1876 } 1877 1878 // Check that we don't have same operands. No need to reorder if operands 1879 // are just perfect diamond or shuffled diamond match. Do not do it only 1880 // for possible broadcasts or non-power of 2 number of scalars (just for 1881 // now). 1882 auto &&SkipReordering = [this]() { 1883 SmallPtrSet<Value *, 4> UniqueValues; 1884 ArrayRef<OperandData> Op0 = OpsVec.front(); 1885 for (const OperandData &Data : Op0) 1886 UniqueValues.insert(Data.V); 1887 for (ArrayRef<OperandData> Op : drop_begin(OpsVec, 1)) { 1888 if (any_of(Op, [&UniqueValues](const OperandData &Data) { 1889 return !UniqueValues.contains(Data.V); 1890 })) 1891 return false; 1892 } 1893 // TODO: Check if we can remove a check for non-power-2 number of 1894 // scalars after full support of non-power-2 vectorization. 1895 return UniqueValues.size() != 2 && isPowerOf2_32(UniqueValues.size()); 1896 }; 1897 1898 // If the initial strategy fails for any of the operand indexes, then we 1899 // perform reordering again in a second pass. This helps avoid assigning 1900 // high priority to the failed strategy, and should improve reordering for 1901 // the non-failed operand indexes. 1902 for (int Pass = 0; Pass != 2; ++Pass) { 1903 // Check if no need to reorder operands since they're are perfect or 1904 // shuffled diamond match. 1905 // Need to to do it to avoid extra external use cost counting for 1906 // shuffled matches, which may cause regressions. 1907 if (SkipReordering()) 1908 break; 1909 // Skip the second pass if the first pass did not fail. 1910 bool StrategyFailed = false; 1911 // Mark all operand data as free to use. 1912 clearUsed(); 1913 // We keep the original operand order for the FirstLane, so reorder the 1914 // rest of the lanes. We are visiting the nodes in a circular fashion, 1915 // using FirstLane as the center point and increasing the radius 1916 // distance. 1917 SmallVector<SmallVector<Value *, 2>> MainAltOps(NumOperands); 1918 for (unsigned I = 0; I < NumOperands; ++I) 1919 MainAltOps[I].push_back(getData(I, FirstLane).V); 1920 1921 for (unsigned Distance = 1; Distance != NumLanes; ++Distance) { 1922 // Visit the lane on the right and then the lane on the left. 1923 for (int Direction : {+1, -1}) { 1924 int Lane = FirstLane + Direction * Distance; 1925 if (Lane < 0 || Lane >= (int)NumLanes) 1926 continue; 1927 int LastLane = Lane - Direction; 1928 assert(LastLane >= 0 && LastLane < (int)NumLanes && 1929 "Out of bounds"); 1930 // Look for a good match for each operand. 1931 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1932 // Search for the operand that matches SortedOps[OpIdx][Lane-1]. 1933 Optional<unsigned> BestIdx = getBestOperand( 1934 OpIdx, Lane, LastLane, ReorderingModes, MainAltOps[OpIdx]); 1935 // By not selecting a value, we allow the operands that follow to 1936 // select a better matching value. We will get a non-null value in 1937 // the next run of getBestOperand(). 1938 if (BestIdx) { 1939 // Swap the current operand with the one returned by 1940 // getBestOperand(). 1941 swap(OpIdx, BestIdx.getValue(), Lane); 1942 } else { 1943 // We failed to find a best operand, set mode to 'Failed'. 1944 ReorderingModes[OpIdx] = ReorderingMode::Failed; 1945 // Enable the second pass. 1946 StrategyFailed = true; 1947 } 1948 // Try to get the alternate opcode and follow it during analysis. 1949 if (MainAltOps[OpIdx].size() != 2) { 1950 OperandData &AltOp = getData(OpIdx, Lane); 1951 InstructionsState OpS = 1952 getSameOpcode({MainAltOps[OpIdx].front(), AltOp.V}); 1953 if (OpS.getOpcode() && OpS.isAltShuffle()) 1954 MainAltOps[OpIdx].push_back(AltOp.V); 1955 } 1956 } 1957 } 1958 } 1959 // Skip second pass if the strategy did not fail. 1960 if (!StrategyFailed) 1961 break; 1962 } 1963 } 1964 1965 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 1966 LLVM_DUMP_METHOD static StringRef getModeStr(ReorderingMode RMode) { 1967 switch (RMode) { 1968 case ReorderingMode::Load: 1969 return "Load"; 1970 case ReorderingMode::Opcode: 1971 return "Opcode"; 1972 case ReorderingMode::Constant: 1973 return "Constant"; 1974 case ReorderingMode::Splat: 1975 return "Splat"; 1976 case ReorderingMode::Failed: 1977 return "Failed"; 1978 } 1979 llvm_unreachable("Unimplemented Reordering Type"); 1980 } 1981 1982 LLVM_DUMP_METHOD static raw_ostream &printMode(ReorderingMode RMode, 1983 raw_ostream &OS) { 1984 return OS << getModeStr(RMode); 1985 } 1986 1987 /// Debug print. 1988 LLVM_DUMP_METHOD static void dumpMode(ReorderingMode RMode) { 1989 printMode(RMode, dbgs()); 1990 } 1991 1992 friend raw_ostream &operator<<(raw_ostream &OS, ReorderingMode RMode) { 1993 return printMode(RMode, OS); 1994 } 1995 1996 LLVM_DUMP_METHOD raw_ostream &print(raw_ostream &OS) const { 1997 const unsigned Indent = 2; 1998 unsigned Cnt = 0; 1999 for (const OperandDataVec &OpDataVec : OpsVec) { 2000 OS << "Operand " << Cnt++ << "\n"; 2001 for (const OperandData &OpData : OpDataVec) { 2002 OS.indent(Indent) << "{"; 2003 if (Value *V = OpData.V) 2004 OS << *V; 2005 else 2006 OS << "null"; 2007 OS << ", APO:" << OpData.APO << "}\n"; 2008 } 2009 OS << "\n"; 2010 } 2011 return OS; 2012 } 2013 2014 /// Debug print. 2015 LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 2016 #endif 2017 }; 2018 2019 /// Evaluate each pair in \p Candidates and return index into \p Candidates 2020 /// for a pair which have highest score deemed to have best chance to form 2021 /// root of profitable tree to vectorize. Return None if no candidate scored 2022 /// above the LookAheadHeuristics::ScoreFail. 2023 /// \param Limit Lower limit of the cost, considered to be good enough score. 2024 Optional<int> 2025 findBestRootPair(ArrayRef<std::pair<Value *, Value *>> Candidates, 2026 int Limit = LookAheadHeuristics::ScoreFail) { 2027 LookAheadHeuristics LookAhead(*DL, *SE, *this, /*NumLanes=*/2, 2028 RootLookAheadMaxDepth); 2029 int BestScore = Limit; 2030 Optional<int> Index = None; 2031 for (int I : seq<int>(0, Candidates.size())) { 2032 int Score = LookAhead.getScoreAtLevelRec(Candidates[I].first, 2033 Candidates[I].second, 2034 /*U1=*/nullptr, /*U2=*/nullptr, 2035 /*Level=*/1, None); 2036 if (Score > BestScore) { 2037 BestScore = Score; 2038 Index = I; 2039 } 2040 } 2041 return Index; 2042 } 2043 2044 /// Checks if the instruction is marked for deletion. 2045 bool isDeleted(Instruction *I) const { return DeletedInstructions.count(I); } 2046 2047 /// Removes an instruction from its block and eventually deletes it. 2048 /// It's like Instruction::eraseFromParent() except that the actual deletion 2049 /// is delayed until BoUpSLP is destructed. 2050 void eraseInstruction(Instruction *I) { 2051 DeletedInstructions.insert(I); 2052 } 2053 2054 /// Checks if the instruction was already analyzed for being possible 2055 /// reduction root. 2056 bool isAnalyzedReductionRoot(Instruction *I) const { 2057 return AnalyzedReductionsRoots.count(I); 2058 } 2059 /// Register given instruction as already analyzed for being possible 2060 /// reduction root. 2061 void analyzedReductionRoot(Instruction *I) { 2062 AnalyzedReductionsRoots.insert(I); 2063 } 2064 /// Checks if the provided list of reduced values was checked already for 2065 /// vectorization. 2066 bool areAnalyzedReductionVals(ArrayRef<Value *> VL) { 2067 return AnalyzedReductionVals.contains(hash_value(VL)); 2068 } 2069 /// Adds the list of reduced values to list of already checked values for the 2070 /// vectorization. 2071 void analyzedReductionVals(ArrayRef<Value *> VL) { 2072 AnalyzedReductionVals.insert(hash_value(VL)); 2073 } 2074 /// Clear the list of the analyzed reduction root instructions. 2075 void clearReductionData() { 2076 AnalyzedReductionsRoots.clear(); 2077 AnalyzedReductionVals.clear(); 2078 } 2079 /// Checks if the given value is gathered in one of the nodes. 2080 bool isAnyGathered(const SmallDenseSet<Value *> &Vals) const { 2081 return any_of(MustGather, [&](Value *V) { return Vals.contains(V); }); 2082 } 2083 2084 ~BoUpSLP(); 2085 2086 private: 2087 /// Check if the operands on the edges \p Edges of the \p UserTE allows 2088 /// reordering (i.e. the operands can be reordered because they have only one 2089 /// user and reordarable). 2090 /// \param ReorderableGathers List of all gather nodes that require reordering 2091 /// (e.g., gather of extractlements or partially vectorizable loads). 2092 /// \param GatherOps List of gather operand nodes for \p UserTE that require 2093 /// reordering, subset of \p NonVectorized. 2094 bool 2095 canReorderOperands(TreeEntry *UserTE, 2096 SmallVectorImpl<std::pair<unsigned, TreeEntry *>> &Edges, 2097 ArrayRef<TreeEntry *> ReorderableGathers, 2098 SmallVectorImpl<TreeEntry *> &GatherOps); 2099 2100 /// Returns vectorized operand \p OpIdx of the node \p UserTE from the graph, 2101 /// if any. If it is not vectorized (gather node), returns nullptr. 2102 TreeEntry *getVectorizedOperand(TreeEntry *UserTE, unsigned OpIdx) { 2103 ArrayRef<Value *> VL = UserTE->getOperand(OpIdx); 2104 TreeEntry *TE = nullptr; 2105 const auto *It = find_if(VL, [this, &TE](Value *V) { 2106 TE = getTreeEntry(V); 2107 return TE; 2108 }); 2109 if (It != VL.end() && TE->isSame(VL)) 2110 return TE; 2111 return nullptr; 2112 } 2113 2114 /// Returns vectorized operand \p OpIdx of the node \p UserTE from the graph, 2115 /// if any. If it is not vectorized (gather node), returns nullptr. 2116 const TreeEntry *getVectorizedOperand(const TreeEntry *UserTE, 2117 unsigned OpIdx) const { 2118 return const_cast<BoUpSLP *>(this)->getVectorizedOperand( 2119 const_cast<TreeEntry *>(UserTE), OpIdx); 2120 } 2121 2122 /// Checks if all users of \p I are the part of the vectorization tree. 2123 bool areAllUsersVectorized(Instruction *I, 2124 ArrayRef<Value *> VectorizedVals) const; 2125 2126 /// \returns the cost of the vectorizable entry. 2127 InstructionCost getEntryCost(const TreeEntry *E, 2128 ArrayRef<Value *> VectorizedVals); 2129 2130 /// This is the recursive part of buildTree. 2131 void buildTree_rec(ArrayRef<Value *> Roots, unsigned Depth, 2132 const EdgeInfo &EI); 2133 2134 /// \returns true if the ExtractElement/ExtractValue instructions in \p VL can 2135 /// be vectorized to use the original vector (or aggregate "bitcast" to a 2136 /// vector) and sets \p CurrentOrder to the identity permutation; otherwise 2137 /// returns false, setting \p CurrentOrder to either an empty vector or a 2138 /// non-identity permutation that allows to reuse extract instructions. 2139 bool canReuseExtract(ArrayRef<Value *> VL, Value *OpValue, 2140 SmallVectorImpl<unsigned> &CurrentOrder) const; 2141 2142 /// Vectorize a single entry in the tree. 2143 Value *vectorizeTree(TreeEntry *E); 2144 2145 /// Vectorize a single entry in the tree, starting in \p VL. 2146 Value *vectorizeTree(ArrayRef<Value *> VL); 2147 2148 /// Create a new vector from a list of scalar values. Produces a sequence 2149 /// which exploits values reused across lanes, and arranges the inserts 2150 /// for ease of later optimization. 2151 Value *createBuildVector(ArrayRef<Value *> VL); 2152 2153 /// \returns the scalarization cost for this type. Scalarization in this 2154 /// context means the creation of vectors from a group of scalars. If \p 2155 /// NeedToShuffle is true, need to add a cost of reshuffling some of the 2156 /// vector elements. 2157 InstructionCost getGatherCost(FixedVectorType *Ty, 2158 const APInt &ShuffledIndices, 2159 bool NeedToShuffle) const; 2160 2161 /// Checks if the gathered \p VL can be represented as shuffle(s) of previous 2162 /// tree entries. 2163 /// \returns ShuffleKind, if gathered values can be represented as shuffles of 2164 /// previous tree entries. \p Mask is filled with the shuffle mask. 2165 Optional<TargetTransformInfo::ShuffleKind> 2166 isGatherShuffledEntry(const TreeEntry *TE, SmallVectorImpl<int> &Mask, 2167 SmallVectorImpl<const TreeEntry *> &Entries); 2168 2169 /// \returns the scalarization cost for this list of values. Assuming that 2170 /// this subtree gets vectorized, we may need to extract the values from the 2171 /// roots. This method calculates the cost of extracting the values. 2172 InstructionCost getGatherCost(ArrayRef<Value *> VL) const; 2173 2174 /// Set the Builder insert point to one after the last instruction in 2175 /// the bundle 2176 void setInsertPointAfterBundle(const TreeEntry *E); 2177 2178 /// \returns a vector from a collection of scalars in \p VL. 2179 Value *gather(ArrayRef<Value *> VL); 2180 2181 /// \returns whether the VectorizableTree is fully vectorizable and will 2182 /// be beneficial even the tree height is tiny. 2183 bool isFullyVectorizableTinyTree(bool ForReduction) const; 2184 2185 /// Reorder commutative or alt operands to get better probability of 2186 /// generating vectorized code. 2187 static void reorderInputsAccordingToOpcode(ArrayRef<Value *> VL, 2188 SmallVectorImpl<Value *> &Left, 2189 SmallVectorImpl<Value *> &Right, 2190 const DataLayout &DL, 2191 ScalarEvolution &SE, 2192 const BoUpSLP &R); 2193 2194 /// Helper for `findExternalStoreUsersReorderIndices()`. It iterates over the 2195 /// users of \p TE and collects the stores. It returns the map from the store 2196 /// pointers to the collected stores. 2197 DenseMap<Value *, SmallVector<StoreInst *, 4>> 2198 collectUserStores(const BoUpSLP::TreeEntry *TE) const; 2199 2200 /// Helper for `findExternalStoreUsersReorderIndices()`. It checks if the 2201 /// stores in \p StoresVec can for a vector instruction. If so it returns true 2202 /// and populates \p ReorderIndices with the shuffle indices of the the stores 2203 /// when compared to the sorted vector. 2204 bool CanFormVector(const SmallVector<StoreInst *, 4> &StoresVec, 2205 OrdersType &ReorderIndices) const; 2206 2207 /// Iterates through the users of \p TE, looking for scalar stores that can be 2208 /// potentially vectorized in a future SLP-tree. If found, it keeps track of 2209 /// their order and builds an order index vector for each store bundle. It 2210 /// returns all these order vectors found. 2211 /// We run this after the tree has formed, otherwise we may come across user 2212 /// instructions that are not yet in the tree. 2213 SmallVector<OrdersType, 1> 2214 findExternalStoreUsersReorderIndices(TreeEntry *TE) const; 2215 2216 struct TreeEntry { 2217 using VecTreeTy = SmallVector<std::unique_ptr<TreeEntry>, 8>; 2218 TreeEntry(VecTreeTy &Container) : Container(Container) {} 2219 2220 /// \returns true if the scalars in VL are equal to this entry. 2221 bool isSame(ArrayRef<Value *> VL) const { 2222 auto &&IsSame = [VL](ArrayRef<Value *> Scalars, ArrayRef<int> Mask) { 2223 if (Mask.size() != VL.size() && VL.size() == Scalars.size()) 2224 return std::equal(VL.begin(), VL.end(), Scalars.begin()); 2225 return VL.size() == Mask.size() && 2226 std::equal(VL.begin(), VL.end(), Mask.begin(), 2227 [Scalars](Value *V, int Idx) { 2228 return (isa<UndefValue>(V) && 2229 Idx == UndefMaskElem) || 2230 (Idx != UndefMaskElem && V == Scalars[Idx]); 2231 }); 2232 }; 2233 if (!ReorderIndices.empty()) { 2234 // TODO: implement matching if the nodes are just reordered, still can 2235 // treat the vector as the same if the list of scalars matches VL 2236 // directly, without reordering. 2237 SmallVector<int> Mask; 2238 inversePermutation(ReorderIndices, Mask); 2239 if (VL.size() == Scalars.size()) 2240 return IsSame(Scalars, Mask); 2241 if (VL.size() == ReuseShuffleIndices.size()) { 2242 ::addMask(Mask, ReuseShuffleIndices); 2243 return IsSame(Scalars, Mask); 2244 } 2245 return false; 2246 } 2247 return IsSame(Scalars, ReuseShuffleIndices); 2248 } 2249 2250 /// \returns true if current entry has same operands as \p TE. 2251 bool hasEqualOperands(const TreeEntry &TE) const { 2252 if (TE.getNumOperands() != getNumOperands()) 2253 return false; 2254 SmallBitVector Used(getNumOperands()); 2255 for (unsigned I = 0, E = getNumOperands(); I < E; ++I) { 2256 unsigned PrevCount = Used.count(); 2257 for (unsigned K = 0; K < E; ++K) { 2258 if (Used.test(K)) 2259 continue; 2260 if (getOperand(K) == TE.getOperand(I)) { 2261 Used.set(K); 2262 break; 2263 } 2264 } 2265 // Check if we actually found the matching operand. 2266 if (PrevCount == Used.count()) 2267 return false; 2268 } 2269 return true; 2270 } 2271 2272 /// \return Final vectorization factor for the node. Defined by the total 2273 /// number of vectorized scalars, including those, used several times in the 2274 /// entry and counted in the \a ReuseShuffleIndices, if any. 2275 unsigned getVectorFactor() const { 2276 if (!ReuseShuffleIndices.empty()) 2277 return ReuseShuffleIndices.size(); 2278 return Scalars.size(); 2279 }; 2280 2281 /// A vector of scalars. 2282 ValueList Scalars; 2283 2284 /// The Scalars are vectorized into this value. It is initialized to Null. 2285 Value *VectorizedValue = nullptr; 2286 2287 /// Do we need to gather this sequence or vectorize it 2288 /// (either with vector instruction or with scatter/gather 2289 /// intrinsics for store/load)? 2290 enum EntryState { Vectorize, ScatterVectorize, NeedToGather }; 2291 EntryState State; 2292 2293 /// Does this sequence require some shuffling? 2294 SmallVector<int, 4> ReuseShuffleIndices; 2295 2296 /// Does this entry require reordering? 2297 SmallVector<unsigned, 4> ReorderIndices; 2298 2299 /// Points back to the VectorizableTree. 2300 /// 2301 /// Only used for Graphviz right now. Unfortunately GraphTrait::NodeRef has 2302 /// to be a pointer and needs to be able to initialize the child iterator. 2303 /// Thus we need a reference back to the container to translate the indices 2304 /// to entries. 2305 VecTreeTy &Container; 2306 2307 /// The TreeEntry index containing the user of this entry. We can actually 2308 /// have multiple users so the data structure is not truly a tree. 2309 SmallVector<EdgeInfo, 1> UserTreeIndices; 2310 2311 /// The index of this treeEntry in VectorizableTree. 2312 int Idx = -1; 2313 2314 private: 2315 /// The operands of each instruction in each lane Operands[op_index][lane]. 2316 /// Note: This helps avoid the replication of the code that performs the 2317 /// reordering of operands during buildTree_rec() and vectorizeTree(). 2318 SmallVector<ValueList, 2> Operands; 2319 2320 /// The main/alternate instruction. 2321 Instruction *MainOp = nullptr; 2322 Instruction *AltOp = nullptr; 2323 2324 public: 2325 /// Set this bundle's \p OpIdx'th operand to \p OpVL. 2326 void setOperand(unsigned OpIdx, ArrayRef<Value *> OpVL) { 2327 if (Operands.size() < OpIdx + 1) 2328 Operands.resize(OpIdx + 1); 2329 assert(Operands[OpIdx].empty() && "Already resized?"); 2330 assert(OpVL.size() <= Scalars.size() && 2331 "Number of operands is greater than the number of scalars."); 2332 Operands[OpIdx].resize(OpVL.size()); 2333 copy(OpVL, Operands[OpIdx].begin()); 2334 } 2335 2336 /// Set the operands of this bundle in their original order. 2337 void setOperandsInOrder() { 2338 assert(Operands.empty() && "Already initialized?"); 2339 auto *I0 = cast<Instruction>(Scalars[0]); 2340 Operands.resize(I0->getNumOperands()); 2341 unsigned NumLanes = Scalars.size(); 2342 for (unsigned OpIdx = 0, NumOperands = I0->getNumOperands(); 2343 OpIdx != NumOperands; ++OpIdx) { 2344 Operands[OpIdx].resize(NumLanes); 2345 for (unsigned Lane = 0; Lane != NumLanes; ++Lane) { 2346 auto *I = cast<Instruction>(Scalars[Lane]); 2347 assert(I->getNumOperands() == NumOperands && 2348 "Expected same number of operands"); 2349 Operands[OpIdx][Lane] = I->getOperand(OpIdx); 2350 } 2351 } 2352 } 2353 2354 /// Reorders operands of the node to the given mask \p Mask. 2355 void reorderOperands(ArrayRef<int> Mask) { 2356 for (ValueList &Operand : Operands) 2357 reorderScalars(Operand, Mask); 2358 } 2359 2360 /// \returns the \p OpIdx operand of this TreeEntry. 2361 ValueList &getOperand(unsigned OpIdx) { 2362 assert(OpIdx < Operands.size() && "Off bounds"); 2363 return Operands[OpIdx]; 2364 } 2365 2366 /// \returns the \p OpIdx operand of this TreeEntry. 2367 ArrayRef<Value *> getOperand(unsigned OpIdx) const { 2368 assert(OpIdx < Operands.size() && "Off bounds"); 2369 return Operands[OpIdx]; 2370 } 2371 2372 /// \returns the number of operands. 2373 unsigned getNumOperands() const { return Operands.size(); } 2374 2375 /// \return the single \p OpIdx operand. 2376 Value *getSingleOperand(unsigned OpIdx) const { 2377 assert(OpIdx < Operands.size() && "Off bounds"); 2378 assert(!Operands[OpIdx].empty() && "No operand available"); 2379 return Operands[OpIdx][0]; 2380 } 2381 2382 /// Some of the instructions in the list have alternate opcodes. 2383 bool isAltShuffle() const { return MainOp != AltOp; } 2384 2385 bool isOpcodeOrAlt(Instruction *I) const { 2386 unsigned CheckedOpcode = I->getOpcode(); 2387 return (getOpcode() == CheckedOpcode || 2388 getAltOpcode() == CheckedOpcode); 2389 } 2390 2391 /// Chooses the correct key for scheduling data. If \p Op has the same (or 2392 /// alternate) opcode as \p OpValue, the key is \p Op. Otherwise the key is 2393 /// \p OpValue. 2394 Value *isOneOf(Value *Op) const { 2395 auto *I = dyn_cast<Instruction>(Op); 2396 if (I && isOpcodeOrAlt(I)) 2397 return Op; 2398 return MainOp; 2399 } 2400 2401 void setOperations(const InstructionsState &S) { 2402 MainOp = S.MainOp; 2403 AltOp = S.AltOp; 2404 } 2405 2406 Instruction *getMainOp() const { 2407 return MainOp; 2408 } 2409 2410 Instruction *getAltOp() const { 2411 return AltOp; 2412 } 2413 2414 /// The main/alternate opcodes for the list of instructions. 2415 unsigned getOpcode() const { 2416 return MainOp ? MainOp->getOpcode() : 0; 2417 } 2418 2419 unsigned getAltOpcode() const { 2420 return AltOp ? AltOp->getOpcode() : 0; 2421 } 2422 2423 /// When ReuseReorderShuffleIndices is empty it just returns position of \p 2424 /// V within vector of Scalars. Otherwise, try to remap on its reuse index. 2425 int findLaneForValue(Value *V) const { 2426 unsigned FoundLane = std::distance(Scalars.begin(), find(Scalars, V)); 2427 assert(FoundLane < Scalars.size() && "Couldn't find extract lane"); 2428 if (!ReorderIndices.empty()) 2429 FoundLane = ReorderIndices[FoundLane]; 2430 assert(FoundLane < Scalars.size() && "Couldn't find extract lane"); 2431 if (!ReuseShuffleIndices.empty()) { 2432 FoundLane = std::distance(ReuseShuffleIndices.begin(), 2433 find(ReuseShuffleIndices, FoundLane)); 2434 } 2435 return FoundLane; 2436 } 2437 2438 #ifndef NDEBUG 2439 /// Debug printer. 2440 LLVM_DUMP_METHOD void dump() const { 2441 dbgs() << Idx << ".\n"; 2442 for (unsigned OpI = 0, OpE = Operands.size(); OpI != OpE; ++OpI) { 2443 dbgs() << "Operand " << OpI << ":\n"; 2444 for (const Value *V : Operands[OpI]) 2445 dbgs().indent(2) << *V << "\n"; 2446 } 2447 dbgs() << "Scalars: \n"; 2448 for (Value *V : Scalars) 2449 dbgs().indent(2) << *V << "\n"; 2450 dbgs() << "State: "; 2451 switch (State) { 2452 case Vectorize: 2453 dbgs() << "Vectorize\n"; 2454 break; 2455 case ScatterVectorize: 2456 dbgs() << "ScatterVectorize\n"; 2457 break; 2458 case NeedToGather: 2459 dbgs() << "NeedToGather\n"; 2460 break; 2461 } 2462 dbgs() << "MainOp: "; 2463 if (MainOp) 2464 dbgs() << *MainOp << "\n"; 2465 else 2466 dbgs() << "NULL\n"; 2467 dbgs() << "AltOp: "; 2468 if (AltOp) 2469 dbgs() << *AltOp << "\n"; 2470 else 2471 dbgs() << "NULL\n"; 2472 dbgs() << "VectorizedValue: "; 2473 if (VectorizedValue) 2474 dbgs() << *VectorizedValue << "\n"; 2475 else 2476 dbgs() << "NULL\n"; 2477 dbgs() << "ReuseShuffleIndices: "; 2478 if (ReuseShuffleIndices.empty()) 2479 dbgs() << "Empty"; 2480 else 2481 for (int ReuseIdx : ReuseShuffleIndices) 2482 dbgs() << ReuseIdx << ", "; 2483 dbgs() << "\n"; 2484 dbgs() << "ReorderIndices: "; 2485 for (unsigned ReorderIdx : ReorderIndices) 2486 dbgs() << ReorderIdx << ", "; 2487 dbgs() << "\n"; 2488 dbgs() << "UserTreeIndices: "; 2489 for (const auto &EInfo : UserTreeIndices) 2490 dbgs() << EInfo << ", "; 2491 dbgs() << "\n"; 2492 } 2493 #endif 2494 }; 2495 2496 #ifndef NDEBUG 2497 void dumpTreeCosts(const TreeEntry *E, InstructionCost ReuseShuffleCost, 2498 InstructionCost VecCost, 2499 InstructionCost ScalarCost) const { 2500 dbgs() << "SLP: Calculated costs for Tree:\n"; E->dump(); 2501 dbgs() << "SLP: Costs:\n"; 2502 dbgs() << "SLP: ReuseShuffleCost = " << ReuseShuffleCost << "\n"; 2503 dbgs() << "SLP: VectorCost = " << VecCost << "\n"; 2504 dbgs() << "SLP: ScalarCost = " << ScalarCost << "\n"; 2505 dbgs() << "SLP: ReuseShuffleCost + VecCost - ScalarCost = " << 2506 ReuseShuffleCost + VecCost - ScalarCost << "\n"; 2507 } 2508 #endif 2509 2510 /// Create a new VectorizableTree entry. 2511 TreeEntry *newTreeEntry(ArrayRef<Value *> VL, Optional<ScheduleData *> Bundle, 2512 const InstructionsState &S, 2513 const EdgeInfo &UserTreeIdx, 2514 ArrayRef<int> ReuseShuffleIndices = None, 2515 ArrayRef<unsigned> ReorderIndices = None) { 2516 TreeEntry::EntryState EntryState = 2517 Bundle ? TreeEntry::Vectorize : TreeEntry::NeedToGather; 2518 return newTreeEntry(VL, EntryState, Bundle, S, UserTreeIdx, 2519 ReuseShuffleIndices, ReorderIndices); 2520 } 2521 2522 TreeEntry *newTreeEntry(ArrayRef<Value *> VL, 2523 TreeEntry::EntryState EntryState, 2524 Optional<ScheduleData *> Bundle, 2525 const InstructionsState &S, 2526 const EdgeInfo &UserTreeIdx, 2527 ArrayRef<int> ReuseShuffleIndices = None, 2528 ArrayRef<unsigned> ReorderIndices = None) { 2529 assert(((!Bundle && EntryState == TreeEntry::NeedToGather) || 2530 (Bundle && EntryState != TreeEntry::NeedToGather)) && 2531 "Need to vectorize gather entry?"); 2532 VectorizableTree.push_back(std::make_unique<TreeEntry>(VectorizableTree)); 2533 TreeEntry *Last = VectorizableTree.back().get(); 2534 Last->Idx = VectorizableTree.size() - 1; 2535 Last->State = EntryState; 2536 Last->ReuseShuffleIndices.append(ReuseShuffleIndices.begin(), 2537 ReuseShuffleIndices.end()); 2538 if (ReorderIndices.empty()) { 2539 Last->Scalars.assign(VL.begin(), VL.end()); 2540 Last->setOperations(S); 2541 } else { 2542 // Reorder scalars and build final mask. 2543 Last->Scalars.assign(VL.size(), nullptr); 2544 transform(ReorderIndices, Last->Scalars.begin(), 2545 [VL](unsigned Idx) -> Value * { 2546 if (Idx >= VL.size()) 2547 return UndefValue::get(VL.front()->getType()); 2548 return VL[Idx]; 2549 }); 2550 InstructionsState S = getSameOpcode(Last->Scalars); 2551 Last->setOperations(S); 2552 Last->ReorderIndices.append(ReorderIndices.begin(), ReorderIndices.end()); 2553 } 2554 if (Last->State != TreeEntry::NeedToGather) { 2555 for (Value *V : VL) { 2556 assert(!getTreeEntry(V) && "Scalar already in tree!"); 2557 ScalarToTreeEntry[V] = Last; 2558 } 2559 // Update the scheduler bundle to point to this TreeEntry. 2560 ScheduleData *BundleMember = Bundle.getValue(); 2561 assert((BundleMember || isa<PHINode>(S.MainOp) || 2562 isVectorLikeInstWithConstOps(S.MainOp) || 2563 doesNotNeedToSchedule(VL)) && 2564 "Bundle and VL out of sync"); 2565 if (BundleMember) { 2566 for (Value *V : VL) { 2567 if (doesNotNeedToBeScheduled(V)) 2568 continue; 2569 assert(BundleMember && "Unexpected end of bundle."); 2570 BundleMember->TE = Last; 2571 BundleMember = BundleMember->NextInBundle; 2572 } 2573 } 2574 assert(!BundleMember && "Bundle and VL out of sync"); 2575 } else { 2576 MustGather.insert(VL.begin(), VL.end()); 2577 } 2578 2579 if (UserTreeIdx.UserTE) 2580 Last->UserTreeIndices.push_back(UserTreeIdx); 2581 2582 return Last; 2583 } 2584 2585 /// -- Vectorization State -- 2586 /// Holds all of the tree entries. 2587 TreeEntry::VecTreeTy VectorizableTree; 2588 2589 #ifndef NDEBUG 2590 /// Debug printer. 2591 LLVM_DUMP_METHOD void dumpVectorizableTree() const { 2592 for (unsigned Id = 0, IdE = VectorizableTree.size(); Id != IdE; ++Id) { 2593 VectorizableTree[Id]->dump(); 2594 dbgs() << "\n"; 2595 } 2596 } 2597 #endif 2598 2599 TreeEntry *getTreeEntry(Value *V) { return ScalarToTreeEntry.lookup(V); } 2600 2601 const TreeEntry *getTreeEntry(Value *V) const { 2602 return ScalarToTreeEntry.lookup(V); 2603 } 2604 2605 /// Maps a specific scalar to its tree entry. 2606 SmallDenseMap<Value*, TreeEntry *> ScalarToTreeEntry; 2607 2608 /// Maps a value to the proposed vectorizable size. 2609 SmallDenseMap<Value *, unsigned> InstrElementSize; 2610 2611 /// A list of scalars that we found that we need to keep as scalars. 2612 ValueSet MustGather; 2613 2614 /// This POD struct describes one external user in the vectorized tree. 2615 struct ExternalUser { 2616 ExternalUser(Value *S, llvm::User *U, int L) 2617 : Scalar(S), User(U), Lane(L) {} 2618 2619 // Which scalar in our function. 2620 Value *Scalar; 2621 2622 // Which user that uses the scalar. 2623 llvm::User *User; 2624 2625 // Which lane does the scalar belong to. 2626 int Lane; 2627 }; 2628 using UserList = SmallVector<ExternalUser, 16>; 2629 2630 /// Checks if two instructions may access the same memory. 2631 /// 2632 /// \p Loc1 is the location of \p Inst1. It is passed explicitly because it 2633 /// is invariant in the calling loop. 2634 bool isAliased(const MemoryLocation &Loc1, Instruction *Inst1, 2635 Instruction *Inst2) { 2636 // First check if the result is already in the cache. 2637 AliasCacheKey key = std::make_pair(Inst1, Inst2); 2638 Optional<bool> &result = AliasCache[key]; 2639 if (result.hasValue()) { 2640 return result.getValue(); 2641 } 2642 bool aliased = true; 2643 if (Loc1.Ptr && isSimple(Inst1)) 2644 aliased = isModOrRefSet(BatchAA.getModRefInfo(Inst2, Loc1)); 2645 // Store the result in the cache. 2646 result = aliased; 2647 return aliased; 2648 } 2649 2650 using AliasCacheKey = std::pair<Instruction *, Instruction *>; 2651 2652 /// Cache for alias results. 2653 /// TODO: consider moving this to the AliasAnalysis itself. 2654 DenseMap<AliasCacheKey, Optional<bool>> AliasCache; 2655 2656 // Cache for pointerMayBeCaptured calls inside AA. This is preserved 2657 // globally through SLP because we don't perform any action which 2658 // invalidates capture results. 2659 BatchAAResults BatchAA; 2660 2661 /// Temporary store for deleted instructions. Instructions will be deleted 2662 /// eventually when the BoUpSLP is destructed. The deferral is required to 2663 /// ensure that there are no incorrect collisions in the AliasCache, which 2664 /// can happen if a new instruction is allocated at the same address as a 2665 /// previously deleted instruction. 2666 DenseSet<Instruction *> DeletedInstructions; 2667 2668 /// Set of the instruction, being analyzed already for reductions. 2669 SmallPtrSet<Instruction *, 16> AnalyzedReductionsRoots; 2670 2671 /// Set of hashes for the list of reduction values already being analyzed. 2672 DenseSet<size_t> AnalyzedReductionVals; 2673 2674 /// A list of values that need to extracted out of the tree. 2675 /// This list holds pairs of (Internal Scalar : External User). External User 2676 /// can be nullptr, it means that this Internal Scalar will be used later, 2677 /// after vectorization. 2678 UserList ExternalUses; 2679 2680 /// Values used only by @llvm.assume calls. 2681 SmallPtrSet<const Value *, 32> EphValues; 2682 2683 /// Holds all of the instructions that we gathered. 2684 SetVector<Instruction *> GatherShuffleSeq; 2685 2686 /// A list of blocks that we are going to CSE. 2687 SetVector<BasicBlock *> CSEBlocks; 2688 2689 /// Contains all scheduling relevant data for an instruction. 2690 /// A ScheduleData either represents a single instruction or a member of an 2691 /// instruction bundle (= a group of instructions which is combined into a 2692 /// vector instruction). 2693 struct ScheduleData { 2694 // The initial value for the dependency counters. It means that the 2695 // dependencies are not calculated yet. 2696 enum { InvalidDeps = -1 }; 2697 2698 ScheduleData() = default; 2699 2700 void init(int BlockSchedulingRegionID, Value *OpVal) { 2701 FirstInBundle = this; 2702 NextInBundle = nullptr; 2703 NextLoadStore = nullptr; 2704 IsScheduled = false; 2705 SchedulingRegionID = BlockSchedulingRegionID; 2706 clearDependencies(); 2707 OpValue = OpVal; 2708 TE = nullptr; 2709 } 2710 2711 /// Verify basic self consistency properties 2712 void verify() { 2713 if (hasValidDependencies()) { 2714 assert(UnscheduledDeps <= Dependencies && "invariant"); 2715 } else { 2716 assert(UnscheduledDeps == Dependencies && "invariant"); 2717 } 2718 2719 if (IsScheduled) { 2720 assert(isSchedulingEntity() && 2721 "unexpected scheduled state"); 2722 for (const ScheduleData *BundleMember = this; BundleMember; 2723 BundleMember = BundleMember->NextInBundle) { 2724 assert(BundleMember->hasValidDependencies() && 2725 BundleMember->UnscheduledDeps == 0 && 2726 "unexpected scheduled state"); 2727 assert((BundleMember == this || !BundleMember->IsScheduled) && 2728 "only bundle is marked scheduled"); 2729 } 2730 } 2731 2732 assert(Inst->getParent() == FirstInBundle->Inst->getParent() && 2733 "all bundle members must be in same basic block"); 2734 } 2735 2736 /// Returns true if the dependency information has been calculated. 2737 /// Note that depenendency validity can vary between instructions within 2738 /// a single bundle. 2739 bool hasValidDependencies() const { return Dependencies != InvalidDeps; } 2740 2741 /// Returns true for single instructions and for bundle representatives 2742 /// (= the head of a bundle). 2743 bool isSchedulingEntity() const { return FirstInBundle == this; } 2744 2745 /// Returns true if it represents an instruction bundle and not only a 2746 /// single instruction. 2747 bool isPartOfBundle() const { 2748 return NextInBundle != nullptr || FirstInBundle != this || TE; 2749 } 2750 2751 /// Returns true if it is ready for scheduling, i.e. it has no more 2752 /// unscheduled depending instructions/bundles. 2753 bool isReady() const { 2754 assert(isSchedulingEntity() && 2755 "can't consider non-scheduling entity for ready list"); 2756 return unscheduledDepsInBundle() == 0 && !IsScheduled; 2757 } 2758 2759 /// Modifies the number of unscheduled dependencies for this instruction, 2760 /// and returns the number of remaining dependencies for the containing 2761 /// bundle. 2762 int incrementUnscheduledDeps(int Incr) { 2763 assert(hasValidDependencies() && 2764 "increment of unscheduled deps would be meaningless"); 2765 UnscheduledDeps += Incr; 2766 return FirstInBundle->unscheduledDepsInBundle(); 2767 } 2768 2769 /// Sets the number of unscheduled dependencies to the number of 2770 /// dependencies. 2771 void resetUnscheduledDeps() { 2772 UnscheduledDeps = Dependencies; 2773 } 2774 2775 /// Clears all dependency information. 2776 void clearDependencies() { 2777 Dependencies = InvalidDeps; 2778 resetUnscheduledDeps(); 2779 MemoryDependencies.clear(); 2780 ControlDependencies.clear(); 2781 } 2782 2783 int unscheduledDepsInBundle() const { 2784 assert(isSchedulingEntity() && "only meaningful on the bundle"); 2785 int Sum = 0; 2786 for (const ScheduleData *BundleMember = this; BundleMember; 2787 BundleMember = BundleMember->NextInBundle) { 2788 if (BundleMember->UnscheduledDeps == InvalidDeps) 2789 return InvalidDeps; 2790 Sum += BundleMember->UnscheduledDeps; 2791 } 2792 return Sum; 2793 } 2794 2795 void dump(raw_ostream &os) const { 2796 if (!isSchedulingEntity()) { 2797 os << "/ " << *Inst; 2798 } else if (NextInBundle) { 2799 os << '[' << *Inst; 2800 ScheduleData *SD = NextInBundle; 2801 while (SD) { 2802 os << ';' << *SD->Inst; 2803 SD = SD->NextInBundle; 2804 } 2805 os << ']'; 2806 } else { 2807 os << *Inst; 2808 } 2809 } 2810 2811 Instruction *Inst = nullptr; 2812 2813 /// Opcode of the current instruction in the schedule data. 2814 Value *OpValue = nullptr; 2815 2816 /// The TreeEntry that this instruction corresponds to. 2817 TreeEntry *TE = nullptr; 2818 2819 /// Points to the head in an instruction bundle (and always to this for 2820 /// single instructions). 2821 ScheduleData *FirstInBundle = nullptr; 2822 2823 /// Single linked list of all instructions in a bundle. Null if it is a 2824 /// single instruction. 2825 ScheduleData *NextInBundle = nullptr; 2826 2827 /// Single linked list of all memory instructions (e.g. load, store, call) 2828 /// in the block - until the end of the scheduling region. 2829 ScheduleData *NextLoadStore = nullptr; 2830 2831 /// The dependent memory instructions. 2832 /// This list is derived on demand in calculateDependencies(). 2833 SmallVector<ScheduleData *, 4> MemoryDependencies; 2834 2835 /// List of instructions which this instruction could be control dependent 2836 /// on. Allowing such nodes to be scheduled below this one could introduce 2837 /// a runtime fault which didn't exist in the original program. 2838 /// ex: this is a load or udiv following a readonly call which inf loops 2839 SmallVector<ScheduleData *, 4> ControlDependencies; 2840 2841 /// This ScheduleData is in the current scheduling region if this matches 2842 /// the current SchedulingRegionID of BlockScheduling. 2843 int SchedulingRegionID = 0; 2844 2845 /// Used for getting a "good" final ordering of instructions. 2846 int SchedulingPriority = 0; 2847 2848 /// The number of dependencies. Constitutes of the number of users of the 2849 /// instruction plus the number of dependent memory instructions (if any). 2850 /// This value is calculated on demand. 2851 /// If InvalidDeps, the number of dependencies is not calculated yet. 2852 int Dependencies = InvalidDeps; 2853 2854 /// The number of dependencies minus the number of dependencies of scheduled 2855 /// instructions. As soon as this is zero, the instruction/bundle gets ready 2856 /// for scheduling. 2857 /// Note that this is negative as long as Dependencies is not calculated. 2858 int UnscheduledDeps = InvalidDeps; 2859 2860 /// True if this instruction is scheduled (or considered as scheduled in the 2861 /// dry-run). 2862 bool IsScheduled = false; 2863 }; 2864 2865 #ifndef NDEBUG 2866 friend inline raw_ostream &operator<<(raw_ostream &os, 2867 const BoUpSLP::ScheduleData &SD) { 2868 SD.dump(os); 2869 return os; 2870 } 2871 #endif 2872 2873 friend struct GraphTraits<BoUpSLP *>; 2874 friend struct DOTGraphTraits<BoUpSLP *>; 2875 2876 /// Contains all scheduling data for a basic block. 2877 /// It does not schedules instructions, which are not memory read/write 2878 /// instructions and their operands are either constants, or arguments, or 2879 /// phis, or instructions from others blocks, or their users are phis or from 2880 /// the other blocks. The resulting vector instructions can be placed at the 2881 /// beginning of the basic block without scheduling (if operands does not need 2882 /// to be scheduled) or at the end of the block (if users are outside of the 2883 /// block). It allows to save some compile time and memory used by the 2884 /// compiler. 2885 /// ScheduleData is assigned for each instruction in between the boundaries of 2886 /// the tree entry, even for those, which are not part of the graph. It is 2887 /// required to correctly follow the dependencies between the instructions and 2888 /// their correct scheduling. The ScheduleData is not allocated for the 2889 /// instructions, which do not require scheduling, like phis, nodes with 2890 /// extractelements/insertelements only or nodes with instructions, with 2891 /// uses/operands outside of the block. 2892 struct BlockScheduling { 2893 BlockScheduling(BasicBlock *BB) 2894 : BB(BB), ChunkSize(BB->size()), ChunkPos(ChunkSize) {} 2895 2896 void clear() { 2897 ReadyInsts.clear(); 2898 ScheduleStart = nullptr; 2899 ScheduleEnd = nullptr; 2900 FirstLoadStoreInRegion = nullptr; 2901 LastLoadStoreInRegion = nullptr; 2902 RegionHasStackSave = false; 2903 2904 // Reduce the maximum schedule region size by the size of the 2905 // previous scheduling run. 2906 ScheduleRegionSizeLimit -= ScheduleRegionSize; 2907 if (ScheduleRegionSizeLimit < MinScheduleRegionSize) 2908 ScheduleRegionSizeLimit = MinScheduleRegionSize; 2909 ScheduleRegionSize = 0; 2910 2911 // Make a new scheduling region, i.e. all existing ScheduleData is not 2912 // in the new region yet. 2913 ++SchedulingRegionID; 2914 } 2915 2916 ScheduleData *getScheduleData(Instruction *I) { 2917 if (BB != I->getParent()) 2918 // Avoid lookup if can't possibly be in map. 2919 return nullptr; 2920 ScheduleData *SD = ScheduleDataMap.lookup(I); 2921 if (SD && isInSchedulingRegion(SD)) 2922 return SD; 2923 return nullptr; 2924 } 2925 2926 ScheduleData *getScheduleData(Value *V) { 2927 if (auto *I = dyn_cast<Instruction>(V)) 2928 return getScheduleData(I); 2929 return nullptr; 2930 } 2931 2932 ScheduleData *getScheduleData(Value *V, Value *Key) { 2933 if (V == Key) 2934 return getScheduleData(V); 2935 auto I = ExtraScheduleDataMap.find(V); 2936 if (I != ExtraScheduleDataMap.end()) { 2937 ScheduleData *SD = I->second.lookup(Key); 2938 if (SD && isInSchedulingRegion(SD)) 2939 return SD; 2940 } 2941 return nullptr; 2942 } 2943 2944 bool isInSchedulingRegion(ScheduleData *SD) const { 2945 return SD->SchedulingRegionID == SchedulingRegionID; 2946 } 2947 2948 /// Marks an instruction as scheduled and puts all dependent ready 2949 /// instructions into the ready-list. 2950 template <typename ReadyListType> 2951 void schedule(ScheduleData *SD, ReadyListType &ReadyList) { 2952 SD->IsScheduled = true; 2953 LLVM_DEBUG(dbgs() << "SLP: schedule " << *SD << "\n"); 2954 2955 for (ScheduleData *BundleMember = SD; BundleMember; 2956 BundleMember = BundleMember->NextInBundle) { 2957 if (BundleMember->Inst != BundleMember->OpValue) 2958 continue; 2959 2960 // Handle the def-use chain dependencies. 2961 2962 // Decrement the unscheduled counter and insert to ready list if ready. 2963 auto &&DecrUnsched = [this, &ReadyList](Instruction *I) { 2964 doForAllOpcodes(I, [&ReadyList](ScheduleData *OpDef) { 2965 if (OpDef && OpDef->hasValidDependencies() && 2966 OpDef->incrementUnscheduledDeps(-1) == 0) { 2967 // There are no more unscheduled dependencies after 2968 // decrementing, so we can put the dependent instruction 2969 // into the ready list. 2970 ScheduleData *DepBundle = OpDef->FirstInBundle; 2971 assert(!DepBundle->IsScheduled && 2972 "already scheduled bundle gets ready"); 2973 ReadyList.insert(DepBundle); 2974 LLVM_DEBUG(dbgs() 2975 << "SLP: gets ready (def): " << *DepBundle << "\n"); 2976 } 2977 }); 2978 }; 2979 2980 // If BundleMember is a vector bundle, its operands may have been 2981 // reordered during buildTree(). We therefore need to get its operands 2982 // through the TreeEntry. 2983 if (TreeEntry *TE = BundleMember->TE) { 2984 // Need to search for the lane since the tree entry can be reordered. 2985 int Lane = std::distance(TE->Scalars.begin(), 2986 find(TE->Scalars, BundleMember->Inst)); 2987 assert(Lane >= 0 && "Lane not set"); 2988 2989 // Since vectorization tree is being built recursively this assertion 2990 // ensures that the tree entry has all operands set before reaching 2991 // this code. Couple of exceptions known at the moment are extracts 2992 // where their second (immediate) operand is not added. Since 2993 // immediates do not affect scheduler behavior this is considered 2994 // okay. 2995 auto *In = BundleMember->Inst; 2996 assert(In && 2997 (isa<ExtractValueInst>(In) || isa<ExtractElementInst>(In) || 2998 In->getNumOperands() == TE->getNumOperands()) && 2999 "Missed TreeEntry operands?"); 3000 (void)In; // fake use to avoid build failure when assertions disabled 3001 3002 for (unsigned OpIdx = 0, NumOperands = TE->getNumOperands(); 3003 OpIdx != NumOperands; ++OpIdx) 3004 if (auto *I = dyn_cast<Instruction>(TE->getOperand(OpIdx)[Lane])) 3005 DecrUnsched(I); 3006 } else { 3007 // If BundleMember is a stand-alone instruction, no operand reordering 3008 // has taken place, so we directly access its operands. 3009 for (Use &U : BundleMember->Inst->operands()) 3010 if (auto *I = dyn_cast<Instruction>(U.get())) 3011 DecrUnsched(I); 3012 } 3013 // Handle the memory dependencies. 3014 for (ScheduleData *MemoryDepSD : BundleMember->MemoryDependencies) { 3015 if (MemoryDepSD->hasValidDependencies() && 3016 MemoryDepSD->incrementUnscheduledDeps(-1) == 0) { 3017 // There are no more unscheduled dependencies after decrementing, 3018 // so we can put the dependent instruction into the ready list. 3019 ScheduleData *DepBundle = MemoryDepSD->FirstInBundle; 3020 assert(!DepBundle->IsScheduled && 3021 "already scheduled bundle gets ready"); 3022 ReadyList.insert(DepBundle); 3023 LLVM_DEBUG(dbgs() 3024 << "SLP: gets ready (mem): " << *DepBundle << "\n"); 3025 } 3026 } 3027 // Handle the control dependencies. 3028 for (ScheduleData *DepSD : BundleMember->ControlDependencies) { 3029 if (DepSD->incrementUnscheduledDeps(-1) == 0) { 3030 // There are no more unscheduled dependencies after decrementing, 3031 // so we can put the dependent instruction into the ready list. 3032 ScheduleData *DepBundle = DepSD->FirstInBundle; 3033 assert(!DepBundle->IsScheduled && 3034 "already scheduled bundle gets ready"); 3035 ReadyList.insert(DepBundle); 3036 LLVM_DEBUG(dbgs() 3037 << "SLP: gets ready (ctl): " << *DepBundle << "\n"); 3038 } 3039 } 3040 3041 } 3042 } 3043 3044 /// Verify basic self consistency properties of the data structure. 3045 void verify() { 3046 if (!ScheduleStart) 3047 return; 3048 3049 assert(ScheduleStart->getParent() == ScheduleEnd->getParent() && 3050 ScheduleStart->comesBefore(ScheduleEnd) && 3051 "Not a valid scheduling region?"); 3052 3053 for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 3054 auto *SD = getScheduleData(I); 3055 if (!SD) 3056 continue; 3057 assert(isInSchedulingRegion(SD) && 3058 "primary schedule data not in window?"); 3059 assert(isInSchedulingRegion(SD->FirstInBundle) && 3060 "entire bundle in window!"); 3061 (void)SD; 3062 doForAllOpcodes(I, [](ScheduleData *SD) { SD->verify(); }); 3063 } 3064 3065 for (auto *SD : ReadyInsts) { 3066 assert(SD->isSchedulingEntity() && SD->isReady() && 3067 "item in ready list not ready?"); 3068 (void)SD; 3069 } 3070 } 3071 3072 void doForAllOpcodes(Value *V, 3073 function_ref<void(ScheduleData *SD)> Action) { 3074 if (ScheduleData *SD = getScheduleData(V)) 3075 Action(SD); 3076 auto I = ExtraScheduleDataMap.find(V); 3077 if (I != ExtraScheduleDataMap.end()) 3078 for (auto &P : I->second) 3079 if (isInSchedulingRegion(P.second)) 3080 Action(P.second); 3081 } 3082 3083 /// Put all instructions into the ReadyList which are ready for scheduling. 3084 template <typename ReadyListType> 3085 void initialFillReadyList(ReadyListType &ReadyList) { 3086 for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 3087 doForAllOpcodes(I, [&](ScheduleData *SD) { 3088 if (SD->isSchedulingEntity() && SD->hasValidDependencies() && 3089 SD->isReady()) { 3090 ReadyList.insert(SD); 3091 LLVM_DEBUG(dbgs() 3092 << "SLP: initially in ready list: " << *SD << "\n"); 3093 } 3094 }); 3095 } 3096 } 3097 3098 /// Build a bundle from the ScheduleData nodes corresponding to the 3099 /// scalar instruction for each lane. 3100 ScheduleData *buildBundle(ArrayRef<Value *> VL); 3101 3102 /// Checks if a bundle of instructions can be scheduled, i.e. has no 3103 /// cyclic dependencies. This is only a dry-run, no instructions are 3104 /// actually moved at this stage. 3105 /// \returns the scheduling bundle. The returned Optional value is non-None 3106 /// if \p VL is allowed to be scheduled. 3107 Optional<ScheduleData *> 3108 tryScheduleBundle(ArrayRef<Value *> VL, BoUpSLP *SLP, 3109 const InstructionsState &S); 3110 3111 /// Un-bundles a group of instructions. 3112 void cancelScheduling(ArrayRef<Value *> VL, Value *OpValue); 3113 3114 /// Allocates schedule data chunk. 3115 ScheduleData *allocateScheduleDataChunks(); 3116 3117 /// Extends the scheduling region so that V is inside the region. 3118 /// \returns true if the region size is within the limit. 3119 bool extendSchedulingRegion(Value *V, const InstructionsState &S); 3120 3121 /// Initialize the ScheduleData structures for new instructions in the 3122 /// scheduling region. 3123 void initScheduleData(Instruction *FromI, Instruction *ToI, 3124 ScheduleData *PrevLoadStore, 3125 ScheduleData *NextLoadStore); 3126 3127 /// Updates the dependency information of a bundle and of all instructions/ 3128 /// bundles which depend on the original bundle. 3129 void calculateDependencies(ScheduleData *SD, bool InsertInReadyList, 3130 BoUpSLP *SLP); 3131 3132 /// Sets all instruction in the scheduling region to un-scheduled. 3133 void resetSchedule(); 3134 3135 BasicBlock *BB; 3136 3137 /// Simple memory allocation for ScheduleData. 3138 std::vector<std::unique_ptr<ScheduleData[]>> ScheduleDataChunks; 3139 3140 /// The size of a ScheduleData array in ScheduleDataChunks. 3141 int ChunkSize; 3142 3143 /// The allocator position in the current chunk, which is the last entry 3144 /// of ScheduleDataChunks. 3145 int ChunkPos; 3146 3147 /// Attaches ScheduleData to Instruction. 3148 /// Note that the mapping survives during all vectorization iterations, i.e. 3149 /// ScheduleData structures are recycled. 3150 DenseMap<Instruction *, ScheduleData *> ScheduleDataMap; 3151 3152 /// Attaches ScheduleData to Instruction with the leading key. 3153 DenseMap<Value *, SmallDenseMap<Value *, ScheduleData *>> 3154 ExtraScheduleDataMap; 3155 3156 /// The ready-list for scheduling (only used for the dry-run). 3157 SetVector<ScheduleData *> ReadyInsts; 3158 3159 /// The first instruction of the scheduling region. 3160 Instruction *ScheduleStart = nullptr; 3161 3162 /// The first instruction _after_ the scheduling region. 3163 Instruction *ScheduleEnd = nullptr; 3164 3165 /// The first memory accessing instruction in the scheduling region 3166 /// (can be null). 3167 ScheduleData *FirstLoadStoreInRegion = nullptr; 3168 3169 /// The last memory accessing instruction in the scheduling region 3170 /// (can be null). 3171 ScheduleData *LastLoadStoreInRegion = nullptr; 3172 3173 /// Is there an llvm.stacksave or llvm.stackrestore in the scheduling 3174 /// region? Used to optimize the dependence calculation for the 3175 /// common case where there isn't. 3176 bool RegionHasStackSave = false; 3177 3178 /// The current size of the scheduling region. 3179 int ScheduleRegionSize = 0; 3180 3181 /// The maximum size allowed for the scheduling region. 3182 int ScheduleRegionSizeLimit = ScheduleRegionSizeBudget; 3183 3184 /// The ID of the scheduling region. For a new vectorization iteration this 3185 /// is incremented which "removes" all ScheduleData from the region. 3186 /// Make sure that the initial SchedulingRegionID is greater than the 3187 /// initial SchedulingRegionID in ScheduleData (which is 0). 3188 int SchedulingRegionID = 1; 3189 }; 3190 3191 /// Attaches the BlockScheduling structures to basic blocks. 3192 MapVector<BasicBlock *, std::unique_ptr<BlockScheduling>> BlocksSchedules; 3193 3194 /// Performs the "real" scheduling. Done before vectorization is actually 3195 /// performed in a basic block. 3196 void scheduleBlock(BlockScheduling *BS); 3197 3198 /// List of users to ignore during scheduling and that don't need extracting. 3199 const SmallDenseSet<Value *> *UserIgnoreList = nullptr; 3200 3201 /// A DenseMapInfo implementation for holding DenseMaps and DenseSets of 3202 /// sorted SmallVectors of unsigned. 3203 struct OrdersTypeDenseMapInfo { 3204 static OrdersType getEmptyKey() { 3205 OrdersType V; 3206 V.push_back(~1U); 3207 return V; 3208 } 3209 3210 static OrdersType getTombstoneKey() { 3211 OrdersType V; 3212 V.push_back(~2U); 3213 return V; 3214 } 3215 3216 static unsigned getHashValue(const OrdersType &V) { 3217 return static_cast<unsigned>(hash_combine_range(V.begin(), V.end())); 3218 } 3219 3220 static bool isEqual(const OrdersType &LHS, const OrdersType &RHS) { 3221 return LHS == RHS; 3222 } 3223 }; 3224 3225 // Analysis and block reference. 3226 Function *F; 3227 ScalarEvolution *SE; 3228 TargetTransformInfo *TTI; 3229 TargetLibraryInfo *TLI; 3230 LoopInfo *LI; 3231 DominatorTree *DT; 3232 AssumptionCache *AC; 3233 DemandedBits *DB; 3234 const DataLayout *DL; 3235 OptimizationRemarkEmitter *ORE; 3236 3237 unsigned MaxVecRegSize; // This is set by TTI or overridden by cl::opt. 3238 unsigned MinVecRegSize; // Set by cl::opt (default: 128). 3239 3240 /// Instruction builder to construct the vectorized tree. 3241 IRBuilder<> Builder; 3242 3243 /// A map of scalar integer values to the smallest bit width with which they 3244 /// can legally be represented. The values map to (width, signed) pairs, 3245 /// where "width" indicates the minimum bit width and "signed" is True if the 3246 /// value must be signed-extended, rather than zero-extended, back to its 3247 /// original width. 3248 MapVector<Value *, std::pair<uint64_t, bool>> MinBWs; 3249 }; 3250 3251 } // end namespace slpvectorizer 3252 3253 template <> struct GraphTraits<BoUpSLP *> { 3254 using TreeEntry = BoUpSLP::TreeEntry; 3255 3256 /// NodeRef has to be a pointer per the GraphWriter. 3257 using NodeRef = TreeEntry *; 3258 3259 using ContainerTy = BoUpSLP::TreeEntry::VecTreeTy; 3260 3261 /// Add the VectorizableTree to the index iterator to be able to return 3262 /// TreeEntry pointers. 3263 struct ChildIteratorType 3264 : public iterator_adaptor_base< 3265 ChildIteratorType, SmallVector<BoUpSLP::EdgeInfo, 1>::iterator> { 3266 ContainerTy &VectorizableTree; 3267 3268 ChildIteratorType(SmallVector<BoUpSLP::EdgeInfo, 1>::iterator W, 3269 ContainerTy &VT) 3270 : ChildIteratorType::iterator_adaptor_base(W), VectorizableTree(VT) {} 3271 3272 NodeRef operator*() { return I->UserTE; } 3273 }; 3274 3275 static NodeRef getEntryNode(BoUpSLP &R) { 3276 return R.VectorizableTree[0].get(); 3277 } 3278 3279 static ChildIteratorType child_begin(NodeRef N) { 3280 return {N->UserTreeIndices.begin(), N->Container}; 3281 } 3282 3283 static ChildIteratorType child_end(NodeRef N) { 3284 return {N->UserTreeIndices.end(), N->Container}; 3285 } 3286 3287 /// For the node iterator we just need to turn the TreeEntry iterator into a 3288 /// TreeEntry* iterator so that it dereferences to NodeRef. 3289 class nodes_iterator { 3290 using ItTy = ContainerTy::iterator; 3291 ItTy It; 3292 3293 public: 3294 nodes_iterator(const ItTy &It2) : It(It2) {} 3295 NodeRef operator*() { return It->get(); } 3296 nodes_iterator operator++() { 3297 ++It; 3298 return *this; 3299 } 3300 bool operator!=(const nodes_iterator &N2) const { return N2.It != It; } 3301 }; 3302 3303 static nodes_iterator nodes_begin(BoUpSLP *R) { 3304 return nodes_iterator(R->VectorizableTree.begin()); 3305 } 3306 3307 static nodes_iterator nodes_end(BoUpSLP *R) { 3308 return nodes_iterator(R->VectorizableTree.end()); 3309 } 3310 3311 static unsigned size(BoUpSLP *R) { return R->VectorizableTree.size(); } 3312 }; 3313 3314 template <> struct DOTGraphTraits<BoUpSLP *> : public DefaultDOTGraphTraits { 3315 using TreeEntry = BoUpSLP::TreeEntry; 3316 3317 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {} 3318 3319 std::string getNodeLabel(const TreeEntry *Entry, const BoUpSLP *R) { 3320 std::string Str; 3321 raw_string_ostream OS(Str); 3322 if (isSplat(Entry->Scalars)) 3323 OS << "<splat> "; 3324 for (auto V : Entry->Scalars) { 3325 OS << *V; 3326 if (llvm::any_of(R->ExternalUses, [&](const BoUpSLP::ExternalUser &EU) { 3327 return EU.Scalar == V; 3328 })) 3329 OS << " <extract>"; 3330 OS << "\n"; 3331 } 3332 return Str; 3333 } 3334 3335 static std::string getNodeAttributes(const TreeEntry *Entry, 3336 const BoUpSLP *) { 3337 if (Entry->State == TreeEntry::NeedToGather) 3338 return "color=red"; 3339 return ""; 3340 } 3341 }; 3342 3343 } // end namespace llvm 3344 3345 BoUpSLP::~BoUpSLP() { 3346 SmallVector<WeakTrackingVH> DeadInsts; 3347 for (auto *I : DeletedInstructions) { 3348 for (Use &U : I->operands()) { 3349 auto *Op = dyn_cast<Instruction>(U.get()); 3350 if (Op && !DeletedInstructions.count(Op) && Op->hasOneUser() && 3351 wouldInstructionBeTriviallyDead(Op, TLI)) 3352 DeadInsts.emplace_back(Op); 3353 } 3354 I->dropAllReferences(); 3355 } 3356 for (auto *I : DeletedInstructions) { 3357 assert(I->use_empty() && 3358 "trying to erase instruction with users."); 3359 I->eraseFromParent(); 3360 } 3361 3362 // Cleanup any dead scalar code feeding the vectorized instructions 3363 RecursivelyDeleteTriviallyDeadInstructions(DeadInsts, TLI); 3364 3365 #ifdef EXPENSIVE_CHECKS 3366 // If we could guarantee that this call is not extremely slow, we could 3367 // remove the ifdef limitation (see PR47712). 3368 assert(!verifyFunction(*F, &dbgs())); 3369 #endif 3370 } 3371 3372 /// Reorders the given \p Reuses mask according to the given \p Mask. \p Reuses 3373 /// contains original mask for the scalars reused in the node. Procedure 3374 /// transform this mask in accordance with the given \p Mask. 3375 static void reorderReuses(SmallVectorImpl<int> &Reuses, ArrayRef<int> Mask) { 3376 assert(!Mask.empty() && Reuses.size() == Mask.size() && 3377 "Expected non-empty mask."); 3378 SmallVector<int> Prev(Reuses.begin(), Reuses.end()); 3379 Prev.swap(Reuses); 3380 for (unsigned I = 0, E = Prev.size(); I < E; ++I) 3381 if (Mask[I] != UndefMaskElem) 3382 Reuses[Mask[I]] = Prev[I]; 3383 } 3384 3385 /// Reorders the given \p Order according to the given \p Mask. \p Order - is 3386 /// the original order of the scalars. Procedure transforms the provided order 3387 /// in accordance with the given \p Mask. If the resulting \p Order is just an 3388 /// identity order, \p Order is cleared. 3389 static void reorderOrder(SmallVectorImpl<unsigned> &Order, ArrayRef<int> Mask) { 3390 assert(!Mask.empty() && "Expected non-empty mask."); 3391 SmallVector<int> MaskOrder; 3392 if (Order.empty()) { 3393 MaskOrder.resize(Mask.size()); 3394 std::iota(MaskOrder.begin(), MaskOrder.end(), 0); 3395 } else { 3396 inversePermutation(Order, MaskOrder); 3397 } 3398 reorderReuses(MaskOrder, Mask); 3399 if (ShuffleVectorInst::isIdentityMask(MaskOrder)) { 3400 Order.clear(); 3401 return; 3402 } 3403 Order.assign(Mask.size(), Mask.size()); 3404 for (unsigned I = 0, E = Mask.size(); I < E; ++I) 3405 if (MaskOrder[I] != UndefMaskElem) 3406 Order[MaskOrder[I]] = I; 3407 fixupOrderingIndices(Order); 3408 } 3409 3410 Optional<BoUpSLP::OrdersType> 3411 BoUpSLP::findReusedOrderedScalars(const BoUpSLP::TreeEntry &TE) { 3412 assert(TE.State == TreeEntry::NeedToGather && "Expected gather node only."); 3413 unsigned NumScalars = TE.Scalars.size(); 3414 OrdersType CurrentOrder(NumScalars, NumScalars); 3415 SmallVector<int> Positions; 3416 SmallBitVector UsedPositions(NumScalars); 3417 const TreeEntry *STE = nullptr; 3418 // Try to find all gathered scalars that are gets vectorized in other 3419 // vectorize node. Here we can have only one single tree vector node to 3420 // correctly identify order of the gathered scalars. 3421 for (unsigned I = 0; I < NumScalars; ++I) { 3422 Value *V = TE.Scalars[I]; 3423 if (!isa<LoadInst, ExtractElementInst, ExtractValueInst>(V)) 3424 continue; 3425 if (const auto *LocalSTE = getTreeEntry(V)) { 3426 if (!STE) 3427 STE = LocalSTE; 3428 else if (STE != LocalSTE) 3429 // Take the order only from the single vector node. 3430 return None; 3431 unsigned Lane = 3432 std::distance(STE->Scalars.begin(), find(STE->Scalars, V)); 3433 if (Lane >= NumScalars) 3434 return None; 3435 if (CurrentOrder[Lane] != NumScalars) { 3436 if (Lane != I) 3437 continue; 3438 UsedPositions.reset(CurrentOrder[Lane]); 3439 } 3440 // The partial identity (where only some elements of the gather node are 3441 // in the identity order) is good. 3442 CurrentOrder[Lane] = I; 3443 UsedPositions.set(I); 3444 } 3445 } 3446 // Need to keep the order if we have a vector entry and at least 2 scalars or 3447 // the vectorized entry has just 2 scalars. 3448 if (STE && (UsedPositions.count() > 1 || STE->Scalars.size() == 2)) { 3449 auto &&IsIdentityOrder = [NumScalars](ArrayRef<unsigned> CurrentOrder) { 3450 for (unsigned I = 0; I < NumScalars; ++I) 3451 if (CurrentOrder[I] != I && CurrentOrder[I] != NumScalars) 3452 return false; 3453 return true; 3454 }; 3455 if (IsIdentityOrder(CurrentOrder)) { 3456 CurrentOrder.clear(); 3457 return CurrentOrder; 3458 } 3459 auto *It = CurrentOrder.begin(); 3460 for (unsigned I = 0; I < NumScalars;) { 3461 if (UsedPositions.test(I)) { 3462 ++I; 3463 continue; 3464 } 3465 if (*It == NumScalars) { 3466 *It = I; 3467 ++I; 3468 } 3469 ++It; 3470 } 3471 return CurrentOrder; 3472 } 3473 return None; 3474 } 3475 3476 namespace { 3477 /// Tracks the state we can represent the loads in the given sequence. 3478 enum class LoadsState { Gather, Vectorize, ScatterVectorize }; 3479 } // anonymous namespace 3480 3481 /// Checks if the given array of loads can be represented as a vectorized, 3482 /// scatter or just simple gather. 3483 static LoadsState canVectorizeLoads(ArrayRef<Value *> VL, const Value *VL0, 3484 const TargetTransformInfo &TTI, 3485 const DataLayout &DL, ScalarEvolution &SE, 3486 SmallVectorImpl<unsigned> &Order, 3487 SmallVectorImpl<Value *> &PointerOps) { 3488 // Check that a vectorized load would load the same memory as a scalar 3489 // load. For example, we don't want to vectorize loads that are smaller 3490 // than 8-bit. Even though we have a packed struct {<i2, i2, i2, i2>} LLVM 3491 // treats loading/storing it as an i8 struct. If we vectorize loads/stores 3492 // from such a struct, we read/write packed bits disagreeing with the 3493 // unvectorized version. 3494 Type *ScalarTy = VL0->getType(); 3495 3496 if (DL.getTypeSizeInBits(ScalarTy) != DL.getTypeAllocSizeInBits(ScalarTy)) 3497 return LoadsState::Gather; 3498 3499 // Make sure all loads in the bundle are simple - we can't vectorize 3500 // atomic or volatile loads. 3501 PointerOps.clear(); 3502 PointerOps.resize(VL.size()); 3503 auto *POIter = PointerOps.begin(); 3504 for (Value *V : VL) { 3505 auto *L = cast<LoadInst>(V); 3506 if (!L->isSimple()) 3507 return LoadsState::Gather; 3508 *POIter = L->getPointerOperand(); 3509 ++POIter; 3510 } 3511 3512 Order.clear(); 3513 // Check the order of pointer operands. 3514 if (llvm::sortPtrAccesses(PointerOps, ScalarTy, DL, SE, Order)) { 3515 Value *Ptr0; 3516 Value *PtrN; 3517 if (Order.empty()) { 3518 Ptr0 = PointerOps.front(); 3519 PtrN = PointerOps.back(); 3520 } else { 3521 Ptr0 = PointerOps[Order.front()]; 3522 PtrN = PointerOps[Order.back()]; 3523 } 3524 Optional<int> Diff = 3525 getPointersDiff(ScalarTy, Ptr0, ScalarTy, PtrN, DL, SE); 3526 // Check that the sorted loads are consecutive. 3527 if (static_cast<unsigned>(*Diff) == VL.size() - 1) 3528 return LoadsState::Vectorize; 3529 Align CommonAlignment = cast<LoadInst>(VL0)->getAlign(); 3530 for (Value *V : VL) 3531 CommonAlignment = 3532 commonAlignment(CommonAlignment, cast<LoadInst>(V)->getAlign()); 3533 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 3534 if (TTI.isLegalMaskedGather(VecTy, CommonAlignment) && 3535 !TTI.forceScalarizeMaskedGather(VecTy, CommonAlignment)) 3536 return LoadsState::ScatterVectorize; 3537 } 3538 3539 return LoadsState::Gather; 3540 } 3541 3542 bool clusterSortPtrAccesses(ArrayRef<Value *> VL, Type *ElemTy, 3543 const DataLayout &DL, ScalarEvolution &SE, 3544 SmallVectorImpl<unsigned> &SortedIndices) { 3545 assert(llvm::all_of( 3546 VL, [](const Value *V) { return V->getType()->isPointerTy(); }) && 3547 "Expected list of pointer operands."); 3548 // Map from bases to a vector of (Ptr, Offset, OrigIdx), which we insert each 3549 // Ptr into, sort and return the sorted indices with values next to one 3550 // another. 3551 MapVector<Value *, SmallVector<std::tuple<Value *, int, unsigned>>> Bases; 3552 Bases[VL[0]].push_back(std::make_tuple(VL[0], 0U, 0U)); 3553 3554 unsigned Cnt = 1; 3555 for (Value *Ptr : VL.drop_front()) { 3556 bool Found = any_of(Bases, [&](auto &Base) { 3557 Optional<int> Diff = 3558 getPointersDiff(ElemTy, Base.first, ElemTy, Ptr, DL, SE, 3559 /*StrictCheck=*/true); 3560 if (!Diff) 3561 return false; 3562 3563 Base.second.emplace_back(Ptr, *Diff, Cnt++); 3564 return true; 3565 }); 3566 3567 if (!Found) { 3568 // If we haven't found enough to usefully cluster, return early. 3569 if (Bases.size() > VL.size() / 2 - 1) 3570 return false; 3571 3572 // Not found already - add a new Base 3573 Bases[Ptr].emplace_back(Ptr, 0, Cnt++); 3574 } 3575 } 3576 3577 // For each of the bases sort the pointers by Offset and check if any of the 3578 // base become consecutively allocated. 3579 bool AnyConsecutive = false; 3580 for (auto &Base : Bases) { 3581 auto &Vec = Base.second; 3582 if (Vec.size() > 1) { 3583 llvm::stable_sort(Vec, [](const std::tuple<Value *, int, unsigned> &X, 3584 const std::tuple<Value *, int, unsigned> &Y) { 3585 return std::get<1>(X) < std::get<1>(Y); 3586 }); 3587 int InitialOffset = std::get<1>(Vec[0]); 3588 AnyConsecutive |= all_of(enumerate(Vec), [InitialOffset](auto &P) { 3589 return std::get<1>(P.value()) == int(P.index()) + InitialOffset; 3590 }); 3591 } 3592 } 3593 3594 // Fill SortedIndices array only if it looks worth-while to sort the ptrs. 3595 SortedIndices.clear(); 3596 if (!AnyConsecutive) 3597 return false; 3598 3599 for (auto &Base : Bases) { 3600 for (auto &T : Base.second) 3601 SortedIndices.push_back(std::get<2>(T)); 3602 } 3603 3604 assert(SortedIndices.size() == VL.size() && 3605 "Expected SortedIndices to be the size of VL"); 3606 return true; 3607 } 3608 3609 Optional<BoUpSLP::OrdersType> 3610 BoUpSLP::findPartiallyOrderedLoads(const BoUpSLP::TreeEntry &TE) { 3611 assert(TE.State == TreeEntry::NeedToGather && "Expected gather node only."); 3612 Type *ScalarTy = TE.Scalars[0]->getType(); 3613 3614 SmallVector<Value *> Ptrs; 3615 Ptrs.reserve(TE.Scalars.size()); 3616 for (Value *V : TE.Scalars) { 3617 auto *L = dyn_cast<LoadInst>(V); 3618 if (!L || !L->isSimple()) 3619 return None; 3620 Ptrs.push_back(L->getPointerOperand()); 3621 } 3622 3623 BoUpSLP::OrdersType Order; 3624 if (clusterSortPtrAccesses(Ptrs, ScalarTy, *DL, *SE, Order)) 3625 return Order; 3626 return None; 3627 } 3628 3629 Optional<BoUpSLP::OrdersType> BoUpSLP::getReorderingData(const TreeEntry &TE, 3630 bool TopToBottom) { 3631 // No need to reorder if need to shuffle reuses, still need to shuffle the 3632 // node. 3633 if (!TE.ReuseShuffleIndices.empty()) 3634 return None; 3635 if (TE.State == TreeEntry::Vectorize && 3636 (isa<LoadInst, ExtractElementInst, ExtractValueInst>(TE.getMainOp()) || 3637 (TopToBottom && isa<StoreInst, InsertElementInst>(TE.getMainOp()))) && 3638 !TE.isAltShuffle()) 3639 return TE.ReorderIndices; 3640 if (TE.State == TreeEntry::NeedToGather) { 3641 // TODO: add analysis of other gather nodes with extractelement 3642 // instructions and other values/instructions, not only undefs. 3643 if (((TE.getOpcode() == Instruction::ExtractElement && 3644 !TE.isAltShuffle()) || 3645 (all_of(TE.Scalars, 3646 [](Value *V) { 3647 return isa<UndefValue, ExtractElementInst>(V); 3648 }) && 3649 any_of(TE.Scalars, 3650 [](Value *V) { return isa<ExtractElementInst>(V); }))) && 3651 all_of(TE.Scalars, 3652 [](Value *V) { 3653 auto *EE = dyn_cast<ExtractElementInst>(V); 3654 return !EE || isa<FixedVectorType>(EE->getVectorOperandType()); 3655 }) && 3656 allSameType(TE.Scalars)) { 3657 // Check that gather of extractelements can be represented as 3658 // just a shuffle of a single vector. 3659 OrdersType CurrentOrder; 3660 bool Reuse = canReuseExtract(TE.Scalars, TE.getMainOp(), CurrentOrder); 3661 if (Reuse || !CurrentOrder.empty()) { 3662 if (!CurrentOrder.empty()) 3663 fixupOrderingIndices(CurrentOrder); 3664 return CurrentOrder; 3665 } 3666 } 3667 if (Optional<OrdersType> CurrentOrder = findReusedOrderedScalars(TE)) 3668 return CurrentOrder; 3669 if (TE.Scalars.size() >= 4) 3670 if (Optional<OrdersType> Order = findPartiallyOrderedLoads(TE)) 3671 return Order; 3672 } 3673 return None; 3674 } 3675 3676 void BoUpSLP::reorderTopToBottom() { 3677 // Maps VF to the graph nodes. 3678 DenseMap<unsigned, SetVector<TreeEntry *>> VFToOrderedEntries; 3679 // ExtractElement gather nodes which can be vectorized and need to handle 3680 // their ordering. 3681 DenseMap<const TreeEntry *, OrdersType> GathersToOrders; 3682 3683 // Maps a TreeEntry to the reorder indices of external users. 3684 DenseMap<const TreeEntry *, SmallVector<OrdersType, 1>> 3685 ExternalUserReorderMap; 3686 // Find all reorderable nodes with the given VF. 3687 // Currently the are vectorized stores,loads,extracts + some gathering of 3688 // extracts. 3689 for_each(VectorizableTree, [this, &VFToOrderedEntries, &GathersToOrders, 3690 &ExternalUserReorderMap]( 3691 const std::unique_ptr<TreeEntry> &TE) { 3692 // Look for external users that will probably be vectorized. 3693 SmallVector<OrdersType, 1> ExternalUserReorderIndices = 3694 findExternalStoreUsersReorderIndices(TE.get()); 3695 if (!ExternalUserReorderIndices.empty()) { 3696 VFToOrderedEntries[TE->Scalars.size()].insert(TE.get()); 3697 ExternalUserReorderMap.try_emplace(TE.get(), 3698 std::move(ExternalUserReorderIndices)); 3699 } 3700 3701 if (Optional<OrdersType> CurrentOrder = 3702 getReorderingData(*TE, /*TopToBottom=*/true)) { 3703 // Do not include ordering for nodes used in the alt opcode vectorization, 3704 // better to reorder them during bottom-to-top stage. If follow the order 3705 // here, it causes reordering of the whole graph though actually it is 3706 // profitable just to reorder the subgraph that starts from the alternate 3707 // opcode vectorization node. Such nodes already end-up with the shuffle 3708 // instruction and it is just enough to change this shuffle rather than 3709 // rotate the scalars for the whole graph. 3710 unsigned Cnt = 0; 3711 const TreeEntry *UserTE = TE.get(); 3712 while (UserTE && Cnt < RecursionMaxDepth) { 3713 if (UserTE->UserTreeIndices.size() != 1) 3714 break; 3715 if (all_of(UserTE->UserTreeIndices, [](const EdgeInfo &EI) { 3716 return EI.UserTE->State == TreeEntry::Vectorize && 3717 EI.UserTE->isAltShuffle() && EI.UserTE->Idx != 0; 3718 })) 3719 return; 3720 if (UserTE->UserTreeIndices.empty()) 3721 UserTE = nullptr; 3722 else 3723 UserTE = UserTE->UserTreeIndices.back().UserTE; 3724 ++Cnt; 3725 } 3726 VFToOrderedEntries[TE->Scalars.size()].insert(TE.get()); 3727 if (TE->State != TreeEntry::Vectorize) 3728 GathersToOrders.try_emplace(TE.get(), *CurrentOrder); 3729 } 3730 }); 3731 3732 // Reorder the graph nodes according to their vectorization factor. 3733 for (unsigned VF = VectorizableTree.front()->Scalars.size(); VF > 1; 3734 VF /= 2) { 3735 auto It = VFToOrderedEntries.find(VF); 3736 if (It == VFToOrderedEntries.end()) 3737 continue; 3738 // Try to find the most profitable order. We just are looking for the most 3739 // used order and reorder scalar elements in the nodes according to this 3740 // mostly used order. 3741 ArrayRef<TreeEntry *> OrderedEntries = It->second.getArrayRef(); 3742 // All operands are reordered and used only in this node - propagate the 3743 // most used order to the user node. 3744 MapVector<OrdersType, unsigned, 3745 DenseMap<OrdersType, unsigned, OrdersTypeDenseMapInfo>> 3746 OrdersUses; 3747 SmallPtrSet<const TreeEntry *, 4> VisitedOps; 3748 for (const TreeEntry *OpTE : OrderedEntries) { 3749 // No need to reorder this nodes, still need to extend and to use shuffle, 3750 // just need to merge reordering shuffle and the reuse shuffle. 3751 if (!OpTE->ReuseShuffleIndices.empty()) 3752 continue; 3753 // Count number of orders uses. 3754 const auto &Order = [OpTE, &GathersToOrders]() -> const OrdersType & { 3755 if (OpTE->State == TreeEntry::NeedToGather) { 3756 auto It = GathersToOrders.find(OpTE); 3757 if (It != GathersToOrders.end()) 3758 return It->second; 3759 } 3760 return OpTE->ReorderIndices; 3761 }(); 3762 // First consider the order of the external scalar users. 3763 auto It = ExternalUserReorderMap.find(OpTE); 3764 if (It != ExternalUserReorderMap.end()) { 3765 const auto &ExternalUserReorderIndices = It->second; 3766 for (const OrdersType &ExtOrder : ExternalUserReorderIndices) 3767 ++OrdersUses.insert(std::make_pair(ExtOrder, 0)).first->second; 3768 // No other useful reorder data in this entry. 3769 if (Order.empty()) 3770 continue; 3771 } 3772 // Stores actually store the mask, not the order, need to invert. 3773 if (OpTE->State == TreeEntry::Vectorize && !OpTE->isAltShuffle() && 3774 OpTE->getOpcode() == Instruction::Store && !Order.empty()) { 3775 SmallVector<int> Mask; 3776 inversePermutation(Order, Mask); 3777 unsigned E = Order.size(); 3778 OrdersType CurrentOrder(E, E); 3779 transform(Mask, CurrentOrder.begin(), [E](int Idx) { 3780 return Idx == UndefMaskElem ? E : static_cast<unsigned>(Idx); 3781 }); 3782 fixupOrderingIndices(CurrentOrder); 3783 ++OrdersUses.insert(std::make_pair(CurrentOrder, 0)).first->second; 3784 } else { 3785 ++OrdersUses.insert(std::make_pair(Order, 0)).first->second; 3786 } 3787 } 3788 // Set order of the user node. 3789 if (OrdersUses.empty()) 3790 continue; 3791 // Choose the most used order. 3792 ArrayRef<unsigned> BestOrder = OrdersUses.front().first; 3793 unsigned Cnt = OrdersUses.front().second; 3794 for (const auto &Pair : drop_begin(OrdersUses)) { 3795 if (Cnt < Pair.second || (Cnt == Pair.second && Pair.first.empty())) { 3796 BestOrder = Pair.first; 3797 Cnt = Pair.second; 3798 } 3799 } 3800 // Set order of the user node. 3801 if (BestOrder.empty()) 3802 continue; 3803 SmallVector<int> Mask; 3804 inversePermutation(BestOrder, Mask); 3805 SmallVector<int> MaskOrder(BestOrder.size(), UndefMaskElem); 3806 unsigned E = BestOrder.size(); 3807 transform(BestOrder, MaskOrder.begin(), [E](unsigned I) { 3808 return I < E ? static_cast<int>(I) : UndefMaskElem; 3809 }); 3810 // Do an actual reordering, if profitable. 3811 for (std::unique_ptr<TreeEntry> &TE : VectorizableTree) { 3812 // Just do the reordering for the nodes with the given VF. 3813 if (TE->Scalars.size() != VF) { 3814 if (TE->ReuseShuffleIndices.size() == VF) { 3815 // Need to reorder the reuses masks of the operands with smaller VF to 3816 // be able to find the match between the graph nodes and scalar 3817 // operands of the given node during vectorization/cost estimation. 3818 assert(all_of(TE->UserTreeIndices, 3819 [VF, &TE](const EdgeInfo &EI) { 3820 return EI.UserTE->Scalars.size() == VF || 3821 EI.UserTE->Scalars.size() == 3822 TE->Scalars.size(); 3823 }) && 3824 "All users must be of VF size."); 3825 // Update ordering of the operands with the smaller VF than the given 3826 // one. 3827 reorderReuses(TE->ReuseShuffleIndices, Mask); 3828 } 3829 continue; 3830 } 3831 if (TE->State == TreeEntry::Vectorize && 3832 isa<ExtractElementInst, ExtractValueInst, LoadInst, StoreInst, 3833 InsertElementInst>(TE->getMainOp()) && 3834 !TE->isAltShuffle()) { 3835 // Build correct orders for extract{element,value}, loads and 3836 // stores. 3837 reorderOrder(TE->ReorderIndices, Mask); 3838 if (isa<InsertElementInst, StoreInst>(TE->getMainOp())) 3839 TE->reorderOperands(Mask); 3840 } else { 3841 // Reorder the node and its operands. 3842 TE->reorderOperands(Mask); 3843 assert(TE->ReorderIndices.empty() && 3844 "Expected empty reorder sequence."); 3845 reorderScalars(TE->Scalars, Mask); 3846 } 3847 if (!TE->ReuseShuffleIndices.empty()) { 3848 // Apply reversed order to keep the original ordering of the reused 3849 // elements to avoid extra reorder indices shuffling. 3850 OrdersType CurrentOrder; 3851 reorderOrder(CurrentOrder, MaskOrder); 3852 SmallVector<int> NewReuses; 3853 inversePermutation(CurrentOrder, NewReuses); 3854 addMask(NewReuses, TE->ReuseShuffleIndices); 3855 TE->ReuseShuffleIndices.swap(NewReuses); 3856 } 3857 } 3858 } 3859 } 3860 3861 bool BoUpSLP::canReorderOperands( 3862 TreeEntry *UserTE, SmallVectorImpl<std::pair<unsigned, TreeEntry *>> &Edges, 3863 ArrayRef<TreeEntry *> ReorderableGathers, 3864 SmallVectorImpl<TreeEntry *> &GatherOps) { 3865 for (unsigned I = 0, E = UserTE->getNumOperands(); I < E; ++I) { 3866 if (any_of(Edges, [I](const std::pair<unsigned, TreeEntry *> &OpData) { 3867 return OpData.first == I && 3868 OpData.second->State == TreeEntry::Vectorize; 3869 })) 3870 continue; 3871 if (TreeEntry *TE = getVectorizedOperand(UserTE, I)) { 3872 // Do not reorder if operand node is used by many user nodes. 3873 if (any_of(TE->UserTreeIndices, 3874 [UserTE](const EdgeInfo &EI) { return EI.UserTE != UserTE; })) 3875 return false; 3876 // Add the node to the list of the ordered nodes with the identity 3877 // order. 3878 Edges.emplace_back(I, TE); 3879 // Add ScatterVectorize nodes to the list of operands, where just 3880 // reordering of the scalars is required. Similar to the gathers, so 3881 // simply add to the list of gathered ops. 3882 if (TE->State != TreeEntry::Vectorize) 3883 GatherOps.push_back(TE); 3884 continue; 3885 } 3886 ArrayRef<Value *> VL = UserTE->getOperand(I); 3887 TreeEntry *Gather = nullptr; 3888 if (count_if(ReorderableGathers, [VL, &Gather](TreeEntry *TE) { 3889 assert(TE->State != TreeEntry::Vectorize && 3890 "Only non-vectorized nodes are expected."); 3891 if (TE->isSame(VL)) { 3892 Gather = TE; 3893 return true; 3894 } 3895 return false; 3896 }) > 1) 3897 return false; 3898 if (Gather) 3899 GatherOps.push_back(Gather); 3900 } 3901 return true; 3902 } 3903 3904 void BoUpSLP::reorderBottomToTop(bool IgnoreReorder) { 3905 SetVector<TreeEntry *> OrderedEntries; 3906 DenseMap<const TreeEntry *, OrdersType> GathersToOrders; 3907 // Find all reorderable leaf nodes with the given VF. 3908 // Currently the are vectorized loads,extracts without alternate operands + 3909 // some gathering of extracts. 3910 SmallVector<TreeEntry *> NonVectorized; 3911 for_each(VectorizableTree, [this, &OrderedEntries, &GathersToOrders, 3912 &NonVectorized]( 3913 const std::unique_ptr<TreeEntry> &TE) { 3914 if (TE->State != TreeEntry::Vectorize) 3915 NonVectorized.push_back(TE.get()); 3916 if (Optional<OrdersType> CurrentOrder = 3917 getReorderingData(*TE, /*TopToBottom=*/false)) { 3918 OrderedEntries.insert(TE.get()); 3919 if (TE->State != TreeEntry::Vectorize) 3920 GathersToOrders.try_emplace(TE.get(), *CurrentOrder); 3921 } 3922 }); 3923 3924 // 1. Propagate order to the graph nodes, which use only reordered nodes. 3925 // I.e., if the node has operands, that are reordered, try to make at least 3926 // one operand order in the natural order and reorder others + reorder the 3927 // user node itself. 3928 SmallPtrSet<const TreeEntry *, 4> Visited; 3929 while (!OrderedEntries.empty()) { 3930 // 1. Filter out only reordered nodes. 3931 // 2. If the entry has multiple uses - skip it and jump to the next node. 3932 DenseMap<TreeEntry *, SmallVector<std::pair<unsigned, TreeEntry *>>> Users; 3933 SmallVector<TreeEntry *> Filtered; 3934 for (TreeEntry *TE : OrderedEntries) { 3935 if (!(TE->State == TreeEntry::Vectorize || 3936 (TE->State == TreeEntry::NeedToGather && 3937 GathersToOrders.count(TE))) || 3938 TE->UserTreeIndices.empty() || !TE->ReuseShuffleIndices.empty() || 3939 !all_of(drop_begin(TE->UserTreeIndices), 3940 [TE](const EdgeInfo &EI) { 3941 return EI.UserTE == TE->UserTreeIndices.front().UserTE; 3942 }) || 3943 !Visited.insert(TE).second) { 3944 Filtered.push_back(TE); 3945 continue; 3946 } 3947 // Build a map between user nodes and their operands order to speedup 3948 // search. The graph currently does not provide this dependency directly. 3949 for (EdgeInfo &EI : TE->UserTreeIndices) { 3950 TreeEntry *UserTE = EI.UserTE; 3951 auto It = Users.find(UserTE); 3952 if (It == Users.end()) 3953 It = Users.insert({UserTE, {}}).first; 3954 It->second.emplace_back(EI.EdgeIdx, TE); 3955 } 3956 } 3957 // Erase filtered entries. 3958 for_each(Filtered, 3959 [&OrderedEntries](TreeEntry *TE) { OrderedEntries.remove(TE); }); 3960 SmallVector< 3961 std::pair<TreeEntry *, SmallVector<std::pair<unsigned, TreeEntry *>>>> 3962 UsersVec(Users.begin(), Users.end()); 3963 sort(UsersVec, [](const auto &Data1, const auto &Data2) { 3964 return Data1.first->Idx > Data2.first->Idx; 3965 }); 3966 for (auto &Data : UsersVec) { 3967 // Check that operands are used only in the User node. 3968 SmallVector<TreeEntry *> GatherOps; 3969 if (!canReorderOperands(Data.first, Data.second, NonVectorized, 3970 GatherOps)) { 3971 for_each(Data.second, 3972 [&OrderedEntries](const std::pair<unsigned, TreeEntry *> &Op) { 3973 OrderedEntries.remove(Op.second); 3974 }); 3975 continue; 3976 } 3977 // All operands are reordered and used only in this node - propagate the 3978 // most used order to the user node. 3979 MapVector<OrdersType, unsigned, 3980 DenseMap<OrdersType, unsigned, OrdersTypeDenseMapInfo>> 3981 OrdersUses; 3982 // Do the analysis for each tree entry only once, otherwise the order of 3983 // the same node my be considered several times, though might be not 3984 // profitable. 3985 SmallPtrSet<const TreeEntry *, 4> VisitedOps; 3986 SmallPtrSet<const TreeEntry *, 4> VisitedUsers; 3987 for (const auto &Op : Data.second) { 3988 TreeEntry *OpTE = Op.second; 3989 if (!VisitedOps.insert(OpTE).second) 3990 continue; 3991 if (!OpTE->ReuseShuffleIndices.empty() || 3992 (IgnoreReorder && OpTE == VectorizableTree.front().get())) 3993 continue; 3994 const auto &Order = [OpTE, &GathersToOrders]() -> const OrdersType & { 3995 if (OpTE->State == TreeEntry::NeedToGather) 3996 return GathersToOrders.find(OpTE)->second; 3997 return OpTE->ReorderIndices; 3998 }(); 3999 unsigned NumOps = count_if( 4000 Data.second, [OpTE](const std::pair<unsigned, TreeEntry *> &P) { 4001 return P.second == OpTE; 4002 }); 4003 // Stores actually store the mask, not the order, need to invert. 4004 if (OpTE->State == TreeEntry::Vectorize && !OpTE->isAltShuffle() && 4005 OpTE->getOpcode() == Instruction::Store && !Order.empty()) { 4006 SmallVector<int> Mask; 4007 inversePermutation(Order, Mask); 4008 unsigned E = Order.size(); 4009 OrdersType CurrentOrder(E, E); 4010 transform(Mask, CurrentOrder.begin(), [E](int Idx) { 4011 return Idx == UndefMaskElem ? E : static_cast<unsigned>(Idx); 4012 }); 4013 fixupOrderingIndices(CurrentOrder); 4014 OrdersUses.insert(std::make_pair(CurrentOrder, 0)).first->second += 4015 NumOps; 4016 } else { 4017 OrdersUses.insert(std::make_pair(Order, 0)).first->second += NumOps; 4018 } 4019 auto Res = OrdersUses.insert(std::make_pair(OrdersType(), 0)); 4020 const auto &&AllowsReordering = [IgnoreReorder, &GathersToOrders]( 4021 const TreeEntry *TE) { 4022 if (!TE->ReorderIndices.empty() || !TE->ReuseShuffleIndices.empty() || 4023 (TE->State == TreeEntry::Vectorize && TE->isAltShuffle()) || 4024 (IgnoreReorder && TE->Idx == 0)) 4025 return true; 4026 if (TE->State == TreeEntry::NeedToGather) { 4027 auto It = GathersToOrders.find(TE); 4028 if (It != GathersToOrders.end()) 4029 return !It->second.empty(); 4030 return true; 4031 } 4032 return false; 4033 }; 4034 for (const EdgeInfo &EI : OpTE->UserTreeIndices) { 4035 TreeEntry *UserTE = EI.UserTE; 4036 if (!VisitedUsers.insert(UserTE).second) 4037 continue; 4038 // May reorder user node if it requires reordering, has reused 4039 // scalars, is an alternate op vectorize node or its op nodes require 4040 // reordering. 4041 if (AllowsReordering(UserTE)) 4042 continue; 4043 // Check if users allow reordering. 4044 // Currently look up just 1 level of operands to avoid increase of 4045 // the compile time. 4046 // Profitable to reorder if definitely more operands allow 4047 // reordering rather than those with natural order. 4048 ArrayRef<std::pair<unsigned, TreeEntry *>> Ops = Users[UserTE]; 4049 if (static_cast<unsigned>(count_if( 4050 Ops, [UserTE, &AllowsReordering]( 4051 const std::pair<unsigned, TreeEntry *> &Op) { 4052 return AllowsReordering(Op.second) && 4053 all_of(Op.second->UserTreeIndices, 4054 [UserTE](const EdgeInfo &EI) { 4055 return EI.UserTE == UserTE; 4056 }); 4057 })) <= Ops.size() / 2) 4058 ++Res.first->second; 4059 } 4060 } 4061 // If no orders - skip current nodes and jump to the next one, if any. 4062 if (OrdersUses.empty()) { 4063 for_each(Data.second, 4064 [&OrderedEntries](const std::pair<unsigned, TreeEntry *> &Op) { 4065 OrderedEntries.remove(Op.second); 4066 }); 4067 continue; 4068 } 4069 // Choose the best order. 4070 ArrayRef<unsigned> BestOrder = OrdersUses.front().first; 4071 unsigned Cnt = OrdersUses.front().second; 4072 for (const auto &Pair : drop_begin(OrdersUses)) { 4073 if (Cnt < Pair.second || (Cnt == Pair.second && Pair.first.empty())) { 4074 BestOrder = Pair.first; 4075 Cnt = Pair.second; 4076 } 4077 } 4078 // Set order of the user node (reordering of operands and user nodes). 4079 if (BestOrder.empty()) { 4080 for_each(Data.second, 4081 [&OrderedEntries](const std::pair<unsigned, TreeEntry *> &Op) { 4082 OrderedEntries.remove(Op.second); 4083 }); 4084 continue; 4085 } 4086 // Erase operands from OrderedEntries list and adjust their orders. 4087 VisitedOps.clear(); 4088 SmallVector<int> Mask; 4089 inversePermutation(BestOrder, Mask); 4090 SmallVector<int> MaskOrder(BestOrder.size(), UndefMaskElem); 4091 unsigned E = BestOrder.size(); 4092 transform(BestOrder, MaskOrder.begin(), [E](unsigned I) { 4093 return I < E ? static_cast<int>(I) : UndefMaskElem; 4094 }); 4095 for (const std::pair<unsigned, TreeEntry *> &Op : Data.second) { 4096 TreeEntry *TE = Op.second; 4097 OrderedEntries.remove(TE); 4098 if (!VisitedOps.insert(TE).second) 4099 continue; 4100 if (TE->ReuseShuffleIndices.size() == BestOrder.size()) { 4101 // Just reorder reuses indices. 4102 reorderReuses(TE->ReuseShuffleIndices, Mask); 4103 continue; 4104 } 4105 // Gathers are processed separately. 4106 if (TE->State != TreeEntry::Vectorize) 4107 continue; 4108 assert((BestOrder.size() == TE->ReorderIndices.size() || 4109 TE->ReorderIndices.empty()) && 4110 "Non-matching sizes of user/operand entries."); 4111 reorderOrder(TE->ReorderIndices, Mask); 4112 } 4113 // For gathers just need to reorder its scalars. 4114 for (TreeEntry *Gather : GatherOps) { 4115 assert(Gather->ReorderIndices.empty() && 4116 "Unexpected reordering of gathers."); 4117 if (!Gather->ReuseShuffleIndices.empty()) { 4118 // Just reorder reuses indices. 4119 reorderReuses(Gather->ReuseShuffleIndices, Mask); 4120 continue; 4121 } 4122 reorderScalars(Gather->Scalars, Mask); 4123 OrderedEntries.remove(Gather); 4124 } 4125 // Reorder operands of the user node and set the ordering for the user 4126 // node itself. 4127 if (Data.first->State != TreeEntry::Vectorize || 4128 !isa<ExtractElementInst, ExtractValueInst, LoadInst>( 4129 Data.first->getMainOp()) || 4130 Data.first->isAltShuffle()) 4131 Data.first->reorderOperands(Mask); 4132 if (!isa<InsertElementInst, StoreInst>(Data.first->getMainOp()) || 4133 Data.first->isAltShuffle()) { 4134 reorderScalars(Data.first->Scalars, Mask); 4135 reorderOrder(Data.first->ReorderIndices, MaskOrder); 4136 if (Data.first->ReuseShuffleIndices.empty() && 4137 !Data.first->ReorderIndices.empty() && 4138 !Data.first->isAltShuffle()) { 4139 // Insert user node to the list to try to sink reordering deeper in 4140 // the graph. 4141 OrderedEntries.insert(Data.first); 4142 } 4143 } else { 4144 reorderOrder(Data.first->ReorderIndices, Mask); 4145 } 4146 } 4147 } 4148 // If the reordering is unnecessary, just remove the reorder. 4149 if (IgnoreReorder && !VectorizableTree.front()->ReorderIndices.empty() && 4150 VectorizableTree.front()->ReuseShuffleIndices.empty()) 4151 VectorizableTree.front()->ReorderIndices.clear(); 4152 } 4153 4154 void BoUpSLP::buildExternalUses( 4155 const ExtraValueToDebugLocsMap &ExternallyUsedValues) { 4156 // Collect the values that we need to extract from the tree. 4157 for (auto &TEPtr : VectorizableTree) { 4158 TreeEntry *Entry = TEPtr.get(); 4159 4160 // No need to handle users of gathered values. 4161 if (Entry->State == TreeEntry::NeedToGather) 4162 continue; 4163 4164 // For each lane: 4165 for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) { 4166 Value *Scalar = Entry->Scalars[Lane]; 4167 int FoundLane = Entry->findLaneForValue(Scalar); 4168 4169 // Check if the scalar is externally used as an extra arg. 4170 auto ExtI = ExternallyUsedValues.find(Scalar); 4171 if (ExtI != ExternallyUsedValues.end()) { 4172 LLVM_DEBUG(dbgs() << "SLP: Need to extract: Extra arg from lane " 4173 << Lane << " from " << *Scalar << ".\n"); 4174 ExternalUses.emplace_back(Scalar, nullptr, FoundLane); 4175 } 4176 for (User *U : Scalar->users()) { 4177 LLVM_DEBUG(dbgs() << "SLP: Checking user:" << *U << ".\n"); 4178 4179 Instruction *UserInst = dyn_cast<Instruction>(U); 4180 if (!UserInst) 4181 continue; 4182 4183 if (isDeleted(UserInst)) 4184 continue; 4185 4186 // Skip in-tree scalars that become vectors 4187 if (TreeEntry *UseEntry = getTreeEntry(U)) { 4188 Value *UseScalar = UseEntry->Scalars[0]; 4189 // Some in-tree scalars will remain as scalar in vectorized 4190 // instructions. If that is the case, the one in Lane 0 will 4191 // be used. 4192 if (UseScalar != U || 4193 UseEntry->State == TreeEntry::ScatterVectorize || 4194 !InTreeUserNeedToExtract(Scalar, UserInst, TLI)) { 4195 LLVM_DEBUG(dbgs() << "SLP: \tInternal user will be removed:" << *U 4196 << ".\n"); 4197 assert(UseEntry->State != TreeEntry::NeedToGather && "Bad state"); 4198 continue; 4199 } 4200 } 4201 4202 // Ignore users in the user ignore list. 4203 if (UserIgnoreList && UserIgnoreList->contains(UserInst)) 4204 continue; 4205 4206 LLVM_DEBUG(dbgs() << "SLP: Need to extract:" << *U << " from lane " 4207 << Lane << " from " << *Scalar << ".\n"); 4208 ExternalUses.push_back(ExternalUser(Scalar, U, FoundLane)); 4209 } 4210 } 4211 } 4212 } 4213 4214 DenseMap<Value *, SmallVector<StoreInst *, 4>> 4215 BoUpSLP::collectUserStores(const BoUpSLP::TreeEntry *TE) const { 4216 DenseMap<Value *, SmallVector<StoreInst *, 4>> PtrToStoresMap; 4217 for (unsigned Lane : seq<unsigned>(0, TE->Scalars.size())) { 4218 Value *V = TE->Scalars[Lane]; 4219 // To save compilation time we don't visit if we have too many users. 4220 static constexpr unsigned UsersLimit = 4; 4221 if (V->hasNUsesOrMore(UsersLimit)) 4222 break; 4223 4224 // Collect stores per pointer object. 4225 for (User *U : V->users()) { 4226 auto *SI = dyn_cast<StoreInst>(U); 4227 if (SI == nullptr || !SI->isSimple() || 4228 !isValidElementType(SI->getValueOperand()->getType())) 4229 continue; 4230 // Skip entry if already 4231 if (getTreeEntry(U)) 4232 continue; 4233 4234 Value *Ptr = getUnderlyingObject(SI->getPointerOperand()); 4235 auto &StoresVec = PtrToStoresMap[Ptr]; 4236 // For now just keep one store per pointer object per lane. 4237 // TODO: Extend this to support multiple stores per pointer per lane 4238 if (StoresVec.size() > Lane) 4239 continue; 4240 // Skip if in different BBs. 4241 if (!StoresVec.empty() && 4242 SI->getParent() != StoresVec.back()->getParent()) 4243 continue; 4244 // Make sure that the stores are of the same type. 4245 if (!StoresVec.empty() && 4246 SI->getValueOperand()->getType() != 4247 StoresVec.back()->getValueOperand()->getType()) 4248 continue; 4249 StoresVec.push_back(SI); 4250 } 4251 } 4252 return PtrToStoresMap; 4253 } 4254 4255 bool BoUpSLP::CanFormVector(const SmallVector<StoreInst *, 4> &StoresVec, 4256 OrdersType &ReorderIndices) const { 4257 // We check whether the stores in StoreVec can form a vector by sorting them 4258 // and checking whether they are consecutive. 4259 4260 // To avoid calling getPointersDiff() while sorting we create a vector of 4261 // pairs {store, offset from first} and sort this instead. 4262 SmallVector<std::pair<StoreInst *, int>, 4> StoreOffsetVec(StoresVec.size()); 4263 StoreInst *S0 = StoresVec[0]; 4264 StoreOffsetVec[0] = {S0, 0}; 4265 Type *S0Ty = S0->getValueOperand()->getType(); 4266 Value *S0Ptr = S0->getPointerOperand(); 4267 for (unsigned Idx : seq<unsigned>(1, StoresVec.size())) { 4268 StoreInst *SI = StoresVec[Idx]; 4269 Optional<int> Diff = 4270 getPointersDiff(S0Ty, S0Ptr, SI->getValueOperand()->getType(), 4271 SI->getPointerOperand(), *DL, *SE, 4272 /*StrictCheck=*/true); 4273 // We failed to compare the pointers so just abandon this StoresVec. 4274 if (!Diff) 4275 return false; 4276 StoreOffsetVec[Idx] = {StoresVec[Idx], *Diff}; 4277 } 4278 4279 // Sort the vector based on the pointers. We create a copy because we may 4280 // need the original later for calculating the reorder (shuffle) indices. 4281 stable_sort(StoreOffsetVec, [](const std::pair<StoreInst *, int> &Pair1, 4282 const std::pair<StoreInst *, int> &Pair2) { 4283 int Offset1 = Pair1.second; 4284 int Offset2 = Pair2.second; 4285 return Offset1 < Offset2; 4286 }); 4287 4288 // Check if the stores are consecutive by checking if their difference is 1. 4289 for (unsigned Idx : seq<unsigned>(1, StoreOffsetVec.size())) 4290 if (StoreOffsetVec[Idx].second != StoreOffsetVec[Idx-1].second + 1) 4291 return false; 4292 4293 // Calculate the shuffle indices according to their offset against the sorted 4294 // StoreOffsetVec. 4295 ReorderIndices.reserve(StoresVec.size()); 4296 for (StoreInst *SI : StoresVec) { 4297 unsigned Idx = find_if(StoreOffsetVec, 4298 [SI](const std::pair<StoreInst *, int> &Pair) { 4299 return Pair.first == SI; 4300 }) - 4301 StoreOffsetVec.begin(); 4302 ReorderIndices.push_back(Idx); 4303 } 4304 // Identity order (e.g., {0,1,2,3}) is modeled as an empty OrdersType in 4305 // reorderTopToBottom() and reorderBottomToTop(), so we are following the 4306 // same convention here. 4307 auto IsIdentityOrder = [](const OrdersType &Order) { 4308 for (unsigned Idx : seq<unsigned>(0, Order.size())) 4309 if (Idx != Order[Idx]) 4310 return false; 4311 return true; 4312 }; 4313 if (IsIdentityOrder(ReorderIndices)) 4314 ReorderIndices.clear(); 4315 4316 return true; 4317 } 4318 4319 #ifndef NDEBUG 4320 LLVM_DUMP_METHOD static void dumpOrder(const BoUpSLP::OrdersType &Order) { 4321 for (unsigned Idx : Order) 4322 dbgs() << Idx << ", "; 4323 dbgs() << "\n"; 4324 } 4325 #endif 4326 4327 SmallVector<BoUpSLP::OrdersType, 1> 4328 BoUpSLP::findExternalStoreUsersReorderIndices(TreeEntry *TE) const { 4329 unsigned NumLanes = TE->Scalars.size(); 4330 4331 DenseMap<Value *, SmallVector<StoreInst *, 4>> PtrToStoresMap = 4332 collectUserStores(TE); 4333 4334 // Holds the reorder indices for each candidate store vector that is a user of 4335 // the current TreeEntry. 4336 SmallVector<OrdersType, 1> ExternalReorderIndices; 4337 4338 // Now inspect the stores collected per pointer and look for vectorization 4339 // candidates. For each candidate calculate the reorder index vector and push 4340 // it into `ExternalReorderIndices` 4341 for (const auto &Pair : PtrToStoresMap) { 4342 auto &StoresVec = Pair.second; 4343 // If we have fewer than NumLanes stores, then we can't form a vector. 4344 if (StoresVec.size() != NumLanes) 4345 continue; 4346 4347 // If the stores are not consecutive then abandon this StoresVec. 4348 OrdersType ReorderIndices; 4349 if (!CanFormVector(StoresVec, ReorderIndices)) 4350 continue; 4351 4352 // We now know that the scalars in StoresVec can form a vector instruction, 4353 // so set the reorder indices. 4354 ExternalReorderIndices.push_back(ReorderIndices); 4355 } 4356 return ExternalReorderIndices; 4357 } 4358 4359 void BoUpSLP::buildTree(ArrayRef<Value *> Roots, 4360 const SmallDenseSet<Value *> &UserIgnoreLst) { 4361 deleteTree(); 4362 UserIgnoreList = &UserIgnoreLst; 4363 if (!allSameType(Roots)) 4364 return; 4365 buildTree_rec(Roots, 0, EdgeInfo()); 4366 } 4367 4368 void BoUpSLP::buildTree(ArrayRef<Value *> Roots) { 4369 deleteTree(); 4370 if (!allSameType(Roots)) 4371 return; 4372 buildTree_rec(Roots, 0, EdgeInfo()); 4373 } 4374 4375 /// \return true if the specified list of values has only one instruction that 4376 /// requires scheduling, false otherwise. 4377 #ifndef NDEBUG 4378 static bool needToScheduleSingleInstruction(ArrayRef<Value *> VL) { 4379 Value *NeedsScheduling = nullptr; 4380 for (Value *V : VL) { 4381 if (doesNotNeedToBeScheduled(V)) 4382 continue; 4383 if (!NeedsScheduling) { 4384 NeedsScheduling = V; 4385 continue; 4386 } 4387 return false; 4388 } 4389 return NeedsScheduling; 4390 } 4391 #endif 4392 4393 /// Generates key/subkey pair for the given value to provide effective sorting 4394 /// of the values and better detection of the vectorizable values sequences. The 4395 /// keys/subkeys can be used for better sorting of the values themselves (keys) 4396 /// and in values subgroups (subkeys). 4397 static std::pair<size_t, size_t> generateKeySubkey( 4398 Value *V, const TargetLibraryInfo *TLI, 4399 function_ref<hash_code(size_t, LoadInst *)> LoadsSubkeyGenerator, 4400 bool AllowAlternate) { 4401 hash_code Key = hash_value(V->getValueID() + 2); 4402 hash_code SubKey = hash_value(0); 4403 // Sort the loads by the distance between the pointers. 4404 if (auto *LI = dyn_cast<LoadInst>(V)) { 4405 Key = hash_combine(hash_value(Instruction::Load), Key); 4406 if (LI->isSimple()) 4407 SubKey = hash_value(LoadsSubkeyGenerator(Key, LI)); 4408 else 4409 SubKey = hash_value(LI); 4410 } else if (isVectorLikeInstWithConstOps(V)) { 4411 // Sort extracts by the vector operands. 4412 if (isa<ExtractElementInst, UndefValue>(V)) 4413 Key = hash_value(Value::UndefValueVal + 1); 4414 if (auto *EI = dyn_cast<ExtractElementInst>(V)) { 4415 if (!isUndefVector(EI->getVectorOperand()) && 4416 !isa<UndefValue>(EI->getIndexOperand())) 4417 SubKey = hash_value(EI->getVectorOperand()); 4418 } 4419 } else if (auto *I = dyn_cast<Instruction>(V)) { 4420 // Sort other instructions just by the opcodes except for CMPInst. 4421 // For CMP also sort by the predicate kind. 4422 if ((isa<BinaryOperator>(I) || isa<CastInst>(I)) && 4423 isValidForAlternation(I->getOpcode())) { 4424 if (AllowAlternate) 4425 Key = hash_value(isa<BinaryOperator>(I) ? 1 : 0); 4426 else 4427 Key = hash_combine(hash_value(I->getOpcode()), Key); 4428 SubKey = hash_combine( 4429 hash_value(I->getOpcode()), hash_value(I->getType()), 4430 hash_value(isa<BinaryOperator>(I) 4431 ? I->getType() 4432 : cast<CastInst>(I)->getOperand(0)->getType())); 4433 // For casts, look through the only operand to improve compile time. 4434 if (isa<CastInst>(I)) { 4435 std::pair<size_t, size_t> OpVals = 4436 generateKeySubkey(I->getOperand(0), TLI, LoadsSubkeyGenerator, 4437 /*=AllowAlternate*/ true); 4438 Key = hash_combine(OpVals.first, Key); 4439 SubKey = hash_combine(OpVals.first, SubKey); 4440 } 4441 } else if (auto *CI = dyn_cast<CmpInst>(I)) { 4442 CmpInst::Predicate Pred = CI->getPredicate(); 4443 if (CI->isCommutative()) 4444 Pred = std::min(Pred, CmpInst::getInversePredicate(Pred)); 4445 CmpInst::Predicate SwapPred = CmpInst::getSwappedPredicate(Pred); 4446 SubKey = hash_combine(hash_value(I->getOpcode()), hash_value(Pred), 4447 hash_value(SwapPred), 4448 hash_value(CI->getOperand(0)->getType())); 4449 } else if (auto *Call = dyn_cast<CallInst>(I)) { 4450 Intrinsic::ID ID = getVectorIntrinsicIDForCall(Call, TLI); 4451 if (isTriviallyVectorizable(ID)) { 4452 SubKey = hash_combine(hash_value(I->getOpcode()), hash_value(ID)); 4453 } else if (!VFDatabase(*Call).getMappings(*Call).empty()) { 4454 SubKey = hash_combine(hash_value(I->getOpcode()), 4455 hash_value(Call->getCalledFunction())); 4456 } else { 4457 Key = hash_combine(hash_value(Call), Key); 4458 SubKey = hash_combine(hash_value(I->getOpcode()), hash_value(Call)); 4459 } 4460 for (const CallBase::BundleOpInfo &Op : Call->bundle_op_infos()) 4461 SubKey = hash_combine(hash_value(Op.Begin), hash_value(Op.End), 4462 hash_value(Op.Tag), SubKey); 4463 } else if (auto *Gep = dyn_cast<GetElementPtrInst>(I)) { 4464 if (Gep->getNumOperands() == 2 && isa<ConstantInt>(Gep->getOperand(1))) 4465 SubKey = hash_value(Gep->getPointerOperand()); 4466 else 4467 SubKey = hash_value(Gep); 4468 } else if (BinaryOperator::isIntDivRem(I->getOpcode()) && 4469 !isa<ConstantInt>(I->getOperand(1))) { 4470 // Do not try to vectorize instructions with potentially high cost. 4471 SubKey = hash_value(I); 4472 } else { 4473 SubKey = hash_value(I->getOpcode()); 4474 } 4475 Key = hash_combine(hash_value(I->getParent()), Key); 4476 } 4477 return std::make_pair(Key, SubKey); 4478 } 4479 4480 void BoUpSLP::buildTree_rec(ArrayRef<Value *> VL, unsigned Depth, 4481 const EdgeInfo &UserTreeIdx) { 4482 assert((allConstant(VL) || allSameType(VL)) && "Invalid types!"); 4483 4484 SmallVector<int> ReuseShuffleIndicies; 4485 SmallVector<Value *> UniqueValues; 4486 auto &&TryToFindDuplicates = [&VL, &ReuseShuffleIndicies, &UniqueValues, 4487 &UserTreeIdx, 4488 this](const InstructionsState &S) { 4489 // Check that every instruction appears once in this bundle. 4490 DenseMap<Value *, unsigned> UniquePositions; 4491 for (Value *V : VL) { 4492 if (isConstant(V)) { 4493 ReuseShuffleIndicies.emplace_back( 4494 isa<UndefValue>(V) ? UndefMaskElem : UniqueValues.size()); 4495 UniqueValues.emplace_back(V); 4496 continue; 4497 } 4498 auto Res = UniquePositions.try_emplace(V, UniqueValues.size()); 4499 ReuseShuffleIndicies.emplace_back(Res.first->second); 4500 if (Res.second) 4501 UniqueValues.emplace_back(V); 4502 } 4503 size_t NumUniqueScalarValues = UniqueValues.size(); 4504 if (NumUniqueScalarValues == VL.size()) { 4505 ReuseShuffleIndicies.clear(); 4506 } else { 4507 LLVM_DEBUG(dbgs() << "SLP: Shuffle for reused scalars.\n"); 4508 if (NumUniqueScalarValues <= 1 || 4509 (UniquePositions.size() == 1 && all_of(UniqueValues, 4510 [](Value *V) { 4511 return isa<UndefValue>(V) || 4512 !isConstant(V); 4513 })) || 4514 !llvm::isPowerOf2_32(NumUniqueScalarValues)) { 4515 LLVM_DEBUG(dbgs() << "SLP: Scalar used twice in bundle.\n"); 4516 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4517 return false; 4518 } 4519 VL = UniqueValues; 4520 } 4521 return true; 4522 }; 4523 4524 InstructionsState S = getSameOpcode(VL); 4525 if (Depth == RecursionMaxDepth) { 4526 LLVM_DEBUG(dbgs() << "SLP: Gathering due to max recursion depth.\n"); 4527 if (TryToFindDuplicates(S)) 4528 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4529 ReuseShuffleIndicies); 4530 return; 4531 } 4532 4533 // Don't handle scalable vectors 4534 if (S.getOpcode() == Instruction::ExtractElement && 4535 isa<ScalableVectorType>( 4536 cast<ExtractElementInst>(S.OpValue)->getVectorOperandType())) { 4537 LLVM_DEBUG(dbgs() << "SLP: Gathering due to scalable vector type.\n"); 4538 if (TryToFindDuplicates(S)) 4539 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4540 ReuseShuffleIndicies); 4541 return; 4542 } 4543 4544 // Don't handle vectors. 4545 if (S.OpValue->getType()->isVectorTy() && 4546 !isa<InsertElementInst>(S.OpValue)) { 4547 LLVM_DEBUG(dbgs() << "SLP: Gathering due to vector type.\n"); 4548 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4549 return; 4550 } 4551 4552 if (StoreInst *SI = dyn_cast<StoreInst>(S.OpValue)) 4553 if (SI->getValueOperand()->getType()->isVectorTy()) { 4554 LLVM_DEBUG(dbgs() << "SLP: Gathering due to store vector type.\n"); 4555 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4556 return; 4557 } 4558 4559 // If all of the operands are identical or constant we have a simple solution. 4560 // If we deal with insert/extract instructions, they all must have constant 4561 // indices, otherwise we should gather them, not try to vectorize. 4562 // If alternate op node with 2 elements with gathered operands - do not 4563 // vectorize. 4564 auto &&NotProfitableForVectorization = [&S, this, 4565 Depth](ArrayRef<Value *> VL) { 4566 if (!S.getOpcode() || !S.isAltShuffle() || VL.size() > 2) 4567 return false; 4568 if (VectorizableTree.size() < MinTreeSize) 4569 return false; 4570 if (Depth >= RecursionMaxDepth - 1) 4571 return true; 4572 // Check if all operands are extracts, part of vector node or can build a 4573 // regular vectorize node. 4574 SmallVector<unsigned, 2> InstsCount(VL.size(), 0); 4575 for (Value *V : VL) { 4576 auto *I = cast<Instruction>(V); 4577 InstsCount.push_back(count_if(I->operand_values(), [](Value *Op) { 4578 return isa<Instruction>(Op) || isVectorLikeInstWithConstOps(Op); 4579 })); 4580 } 4581 bool IsCommutative = isCommutative(S.MainOp) || isCommutative(S.AltOp); 4582 if ((IsCommutative && 4583 std::accumulate(InstsCount.begin(), InstsCount.end(), 0) < 2) || 4584 (!IsCommutative && 4585 all_of(InstsCount, [](unsigned ICnt) { return ICnt < 2; }))) 4586 return true; 4587 assert(VL.size() == 2 && "Expected only 2 alternate op instructions."); 4588 SmallVector<SmallVector<std::pair<Value *, Value *>>> Candidates; 4589 auto *I1 = cast<Instruction>(VL.front()); 4590 auto *I2 = cast<Instruction>(VL.back()); 4591 for (int Op = 0, E = S.MainOp->getNumOperands(); Op < E; ++Op) 4592 Candidates.emplace_back().emplace_back(I1->getOperand(Op), 4593 I2->getOperand(Op)); 4594 if (count_if( 4595 Candidates, [this](ArrayRef<std::pair<Value *, Value *>> Cand) { 4596 return findBestRootPair(Cand, LookAheadHeuristics::ScoreSplat); 4597 }) >= S.MainOp->getNumOperands() / 2) 4598 return false; 4599 if (S.MainOp->getNumOperands() > 2) 4600 return true; 4601 if (IsCommutative) { 4602 // Check permuted operands. 4603 Candidates.clear(); 4604 for (int Op = 0, E = S.MainOp->getNumOperands(); Op < E; ++Op) 4605 Candidates.emplace_back().emplace_back(I1->getOperand(Op), 4606 I2->getOperand((Op + 1) % E)); 4607 if (any_of( 4608 Candidates, [this](ArrayRef<std::pair<Value *, Value *>> Cand) { 4609 return findBestRootPair(Cand, LookAheadHeuristics::ScoreSplat); 4610 })) 4611 return false; 4612 } 4613 return true; 4614 }; 4615 if (allConstant(VL) || isSplat(VL) || !allSameBlock(VL) || !S.getOpcode() || 4616 (isa<InsertElementInst, ExtractValueInst, ExtractElementInst>(S.MainOp) && 4617 !all_of(VL, isVectorLikeInstWithConstOps)) || 4618 NotProfitableForVectorization(VL)) { 4619 LLVM_DEBUG(dbgs() << "SLP: Gathering due to C,S,B,O, small shuffle. \n"); 4620 if (TryToFindDuplicates(S)) 4621 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4622 ReuseShuffleIndicies); 4623 return; 4624 } 4625 4626 // We now know that this is a vector of instructions of the same type from 4627 // the same block. 4628 4629 // Don't vectorize ephemeral values. 4630 if (!EphValues.empty()) { 4631 for (Value *V : VL) { 4632 if (EphValues.count(V)) { 4633 LLVM_DEBUG(dbgs() << "SLP: The instruction (" << *V 4634 << ") is ephemeral.\n"); 4635 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4636 return; 4637 } 4638 } 4639 } 4640 4641 // Check if this is a duplicate of another entry. 4642 if (TreeEntry *E = getTreeEntry(S.OpValue)) { 4643 LLVM_DEBUG(dbgs() << "SLP: \tChecking bundle: " << *S.OpValue << ".\n"); 4644 if (!E->isSame(VL)) { 4645 LLVM_DEBUG(dbgs() << "SLP: Gathering due to partial overlap.\n"); 4646 if (TryToFindDuplicates(S)) 4647 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4648 ReuseShuffleIndicies); 4649 return; 4650 } 4651 // Record the reuse of the tree node. FIXME, currently this is only used to 4652 // properly draw the graph rather than for the actual vectorization. 4653 E->UserTreeIndices.push_back(UserTreeIdx); 4654 LLVM_DEBUG(dbgs() << "SLP: Perfect diamond merge at " << *S.OpValue 4655 << ".\n"); 4656 return; 4657 } 4658 4659 // Check that none of the instructions in the bundle are already in the tree. 4660 for (Value *V : VL) { 4661 auto *I = dyn_cast<Instruction>(V); 4662 if (!I) 4663 continue; 4664 if (getTreeEntry(I)) { 4665 LLVM_DEBUG(dbgs() << "SLP: The instruction (" << *V 4666 << ") is already in tree.\n"); 4667 if (TryToFindDuplicates(S)) 4668 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4669 ReuseShuffleIndicies); 4670 return; 4671 } 4672 } 4673 4674 // The reduction nodes (stored in UserIgnoreList) also should stay scalar. 4675 if (UserIgnoreList && !UserIgnoreList->empty()) { 4676 for (Value *V : VL) { 4677 if (UserIgnoreList && UserIgnoreList->contains(V)) { 4678 LLVM_DEBUG(dbgs() << "SLP: Gathering due to gathered scalar.\n"); 4679 if (TryToFindDuplicates(S)) 4680 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4681 ReuseShuffleIndicies); 4682 return; 4683 } 4684 } 4685 } 4686 4687 // Check that all of the users of the scalars that we want to vectorize are 4688 // schedulable. 4689 auto *VL0 = cast<Instruction>(S.OpValue); 4690 BasicBlock *BB = VL0->getParent(); 4691 4692 if (!DT->isReachableFromEntry(BB)) { 4693 // Don't go into unreachable blocks. They may contain instructions with 4694 // dependency cycles which confuse the final scheduling. 4695 LLVM_DEBUG(dbgs() << "SLP: bundle in unreachable block.\n"); 4696 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4697 return; 4698 } 4699 4700 // Check that every instruction appears once in this bundle. 4701 if (!TryToFindDuplicates(S)) 4702 return; 4703 4704 auto &BSRef = BlocksSchedules[BB]; 4705 if (!BSRef) 4706 BSRef = std::make_unique<BlockScheduling>(BB); 4707 4708 BlockScheduling &BS = *BSRef; 4709 4710 Optional<ScheduleData *> Bundle = BS.tryScheduleBundle(VL, this, S); 4711 #ifdef EXPENSIVE_CHECKS 4712 // Make sure we didn't break any internal invariants 4713 BS.verify(); 4714 #endif 4715 if (!Bundle) { 4716 LLVM_DEBUG(dbgs() << "SLP: We are not able to schedule this bundle!\n"); 4717 assert((!BS.getScheduleData(VL0) || 4718 !BS.getScheduleData(VL0)->isPartOfBundle()) && 4719 "tryScheduleBundle should cancelScheduling on failure"); 4720 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4721 ReuseShuffleIndicies); 4722 return; 4723 } 4724 LLVM_DEBUG(dbgs() << "SLP: We are able to schedule this bundle.\n"); 4725 4726 unsigned ShuffleOrOp = S.isAltShuffle() ? 4727 (unsigned) Instruction::ShuffleVector : S.getOpcode(); 4728 switch (ShuffleOrOp) { 4729 case Instruction::PHI: { 4730 auto *PH = cast<PHINode>(VL0); 4731 4732 // Check for terminator values (e.g. invoke). 4733 for (Value *V : VL) 4734 for (Value *Incoming : cast<PHINode>(V)->incoming_values()) { 4735 Instruction *Term = dyn_cast<Instruction>(Incoming); 4736 if (Term && Term->isTerminator()) { 4737 LLVM_DEBUG(dbgs() 4738 << "SLP: Need to swizzle PHINodes (terminator use).\n"); 4739 BS.cancelScheduling(VL, VL0); 4740 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4741 ReuseShuffleIndicies); 4742 return; 4743 } 4744 } 4745 4746 TreeEntry *TE = 4747 newTreeEntry(VL, Bundle, S, UserTreeIdx, ReuseShuffleIndicies); 4748 LLVM_DEBUG(dbgs() << "SLP: added a vector of PHINodes.\n"); 4749 4750 // Keeps the reordered operands to avoid code duplication. 4751 SmallVector<ValueList, 2> OperandsVec; 4752 for (unsigned I = 0, E = PH->getNumIncomingValues(); I < E; ++I) { 4753 if (!DT->isReachableFromEntry(PH->getIncomingBlock(I))) { 4754 ValueList Operands(VL.size(), PoisonValue::get(PH->getType())); 4755 TE->setOperand(I, Operands); 4756 OperandsVec.push_back(Operands); 4757 continue; 4758 } 4759 ValueList Operands; 4760 // Prepare the operand vector. 4761 for (Value *V : VL) 4762 Operands.push_back(cast<PHINode>(V)->getIncomingValueForBlock( 4763 PH->getIncomingBlock(I))); 4764 TE->setOperand(I, Operands); 4765 OperandsVec.push_back(Operands); 4766 } 4767 for (unsigned OpIdx = 0, OpE = OperandsVec.size(); OpIdx != OpE; ++OpIdx) 4768 buildTree_rec(OperandsVec[OpIdx], Depth + 1, {TE, OpIdx}); 4769 return; 4770 } 4771 case Instruction::ExtractValue: 4772 case Instruction::ExtractElement: { 4773 OrdersType CurrentOrder; 4774 bool Reuse = canReuseExtract(VL, VL0, CurrentOrder); 4775 if (Reuse) { 4776 LLVM_DEBUG(dbgs() << "SLP: Reusing or shuffling extract sequence.\n"); 4777 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4778 ReuseShuffleIndicies); 4779 // This is a special case, as it does not gather, but at the same time 4780 // we are not extending buildTree_rec() towards the operands. 4781 ValueList Op0; 4782 Op0.assign(VL.size(), VL0->getOperand(0)); 4783 VectorizableTree.back()->setOperand(0, Op0); 4784 return; 4785 } 4786 if (!CurrentOrder.empty()) { 4787 LLVM_DEBUG({ 4788 dbgs() << "SLP: Reusing or shuffling of reordered extract sequence " 4789 "with order"; 4790 for (unsigned Idx : CurrentOrder) 4791 dbgs() << " " << Idx; 4792 dbgs() << "\n"; 4793 }); 4794 fixupOrderingIndices(CurrentOrder); 4795 // Insert new order with initial value 0, if it does not exist, 4796 // otherwise return the iterator to the existing one. 4797 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4798 ReuseShuffleIndicies, CurrentOrder); 4799 // This is a special case, as it does not gather, but at the same time 4800 // we are not extending buildTree_rec() towards the operands. 4801 ValueList Op0; 4802 Op0.assign(VL.size(), VL0->getOperand(0)); 4803 VectorizableTree.back()->setOperand(0, Op0); 4804 return; 4805 } 4806 LLVM_DEBUG(dbgs() << "SLP: Gather extract sequence.\n"); 4807 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4808 ReuseShuffleIndicies); 4809 BS.cancelScheduling(VL, VL0); 4810 return; 4811 } 4812 case Instruction::InsertElement: { 4813 assert(ReuseShuffleIndicies.empty() && "All inserts should be unique"); 4814 4815 // Check that we have a buildvector and not a shuffle of 2 or more 4816 // different vectors. 4817 ValueSet SourceVectors; 4818 for (Value *V : VL) { 4819 SourceVectors.insert(cast<Instruction>(V)->getOperand(0)); 4820 assert(getInsertIndex(V) != None && "Non-constant or undef index?"); 4821 } 4822 4823 if (count_if(VL, [&SourceVectors](Value *V) { 4824 return !SourceVectors.contains(V); 4825 }) >= 2) { 4826 // Found 2nd source vector - cancel. 4827 LLVM_DEBUG(dbgs() << "SLP: Gather of insertelement vectors with " 4828 "different source vectors.\n"); 4829 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4830 BS.cancelScheduling(VL, VL0); 4831 return; 4832 } 4833 4834 auto OrdCompare = [](const std::pair<int, int> &P1, 4835 const std::pair<int, int> &P2) { 4836 return P1.first > P2.first; 4837 }; 4838 PriorityQueue<std::pair<int, int>, SmallVector<std::pair<int, int>>, 4839 decltype(OrdCompare)> 4840 Indices(OrdCompare); 4841 for (int I = 0, E = VL.size(); I < E; ++I) { 4842 unsigned Idx = *getInsertIndex(VL[I]); 4843 Indices.emplace(Idx, I); 4844 } 4845 OrdersType CurrentOrder(VL.size(), VL.size()); 4846 bool IsIdentity = true; 4847 for (int I = 0, E = VL.size(); I < E; ++I) { 4848 CurrentOrder[Indices.top().second] = I; 4849 IsIdentity &= Indices.top().second == I; 4850 Indices.pop(); 4851 } 4852 if (IsIdentity) 4853 CurrentOrder.clear(); 4854 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4855 None, CurrentOrder); 4856 LLVM_DEBUG(dbgs() << "SLP: added inserts bundle.\n"); 4857 4858 constexpr int NumOps = 2; 4859 ValueList VectorOperands[NumOps]; 4860 for (int I = 0; I < NumOps; ++I) { 4861 for (Value *V : VL) 4862 VectorOperands[I].push_back(cast<Instruction>(V)->getOperand(I)); 4863 4864 TE->setOperand(I, VectorOperands[I]); 4865 } 4866 buildTree_rec(VectorOperands[NumOps - 1], Depth + 1, {TE, NumOps - 1}); 4867 return; 4868 } 4869 case Instruction::Load: { 4870 // Check that a vectorized load would load the same memory as a scalar 4871 // load. For example, we don't want to vectorize loads that are smaller 4872 // than 8-bit. Even though we have a packed struct {<i2, i2, i2, i2>} LLVM 4873 // treats loading/storing it as an i8 struct. If we vectorize loads/stores 4874 // from such a struct, we read/write packed bits disagreeing with the 4875 // unvectorized version. 4876 SmallVector<Value *> PointerOps; 4877 OrdersType CurrentOrder; 4878 TreeEntry *TE = nullptr; 4879 switch (canVectorizeLoads(VL, VL0, *TTI, *DL, *SE, CurrentOrder, 4880 PointerOps)) { 4881 case LoadsState::Vectorize: 4882 if (CurrentOrder.empty()) { 4883 // Original loads are consecutive and does not require reordering. 4884 TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4885 ReuseShuffleIndicies); 4886 LLVM_DEBUG(dbgs() << "SLP: added a vector of loads.\n"); 4887 } else { 4888 fixupOrderingIndices(CurrentOrder); 4889 // Need to reorder. 4890 TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4891 ReuseShuffleIndicies, CurrentOrder); 4892 LLVM_DEBUG(dbgs() << "SLP: added a vector of jumbled loads.\n"); 4893 } 4894 TE->setOperandsInOrder(); 4895 break; 4896 case LoadsState::ScatterVectorize: 4897 // Vectorizing non-consecutive loads with `llvm.masked.gather`. 4898 TE = newTreeEntry(VL, TreeEntry::ScatterVectorize, Bundle, S, 4899 UserTreeIdx, ReuseShuffleIndicies); 4900 TE->setOperandsInOrder(); 4901 buildTree_rec(PointerOps, Depth + 1, {TE, 0}); 4902 LLVM_DEBUG(dbgs() << "SLP: added a vector of non-consecutive loads.\n"); 4903 break; 4904 case LoadsState::Gather: 4905 BS.cancelScheduling(VL, VL0); 4906 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4907 ReuseShuffleIndicies); 4908 #ifndef NDEBUG 4909 Type *ScalarTy = VL0->getType(); 4910 if (DL->getTypeSizeInBits(ScalarTy) != 4911 DL->getTypeAllocSizeInBits(ScalarTy)) 4912 LLVM_DEBUG(dbgs() << "SLP: Gathering loads of non-packed type.\n"); 4913 else if (any_of(VL, [](Value *V) { 4914 return !cast<LoadInst>(V)->isSimple(); 4915 })) 4916 LLVM_DEBUG(dbgs() << "SLP: Gathering non-simple loads.\n"); 4917 else 4918 LLVM_DEBUG(dbgs() << "SLP: Gathering non-consecutive loads.\n"); 4919 #endif // NDEBUG 4920 break; 4921 } 4922 return; 4923 } 4924 case Instruction::ZExt: 4925 case Instruction::SExt: 4926 case Instruction::FPToUI: 4927 case Instruction::FPToSI: 4928 case Instruction::FPExt: 4929 case Instruction::PtrToInt: 4930 case Instruction::IntToPtr: 4931 case Instruction::SIToFP: 4932 case Instruction::UIToFP: 4933 case Instruction::Trunc: 4934 case Instruction::FPTrunc: 4935 case Instruction::BitCast: { 4936 Type *SrcTy = VL0->getOperand(0)->getType(); 4937 for (Value *V : VL) { 4938 Type *Ty = cast<Instruction>(V)->getOperand(0)->getType(); 4939 if (Ty != SrcTy || !isValidElementType(Ty)) { 4940 BS.cancelScheduling(VL, VL0); 4941 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4942 ReuseShuffleIndicies); 4943 LLVM_DEBUG(dbgs() 4944 << "SLP: Gathering casts with different src types.\n"); 4945 return; 4946 } 4947 } 4948 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4949 ReuseShuffleIndicies); 4950 LLVM_DEBUG(dbgs() << "SLP: added a vector of casts.\n"); 4951 4952 TE->setOperandsInOrder(); 4953 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 4954 ValueList Operands; 4955 // Prepare the operand vector. 4956 for (Value *V : VL) 4957 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 4958 4959 buildTree_rec(Operands, Depth + 1, {TE, i}); 4960 } 4961 return; 4962 } 4963 case Instruction::ICmp: 4964 case Instruction::FCmp: { 4965 // Check that all of the compares have the same predicate. 4966 CmpInst::Predicate P0 = cast<CmpInst>(VL0)->getPredicate(); 4967 CmpInst::Predicate SwapP0 = CmpInst::getSwappedPredicate(P0); 4968 Type *ComparedTy = VL0->getOperand(0)->getType(); 4969 for (Value *V : VL) { 4970 CmpInst *Cmp = cast<CmpInst>(V); 4971 if ((Cmp->getPredicate() != P0 && Cmp->getPredicate() != SwapP0) || 4972 Cmp->getOperand(0)->getType() != ComparedTy) { 4973 BS.cancelScheduling(VL, VL0); 4974 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4975 ReuseShuffleIndicies); 4976 LLVM_DEBUG(dbgs() 4977 << "SLP: Gathering cmp with different predicate.\n"); 4978 return; 4979 } 4980 } 4981 4982 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4983 ReuseShuffleIndicies); 4984 LLVM_DEBUG(dbgs() << "SLP: added a vector of compares.\n"); 4985 4986 ValueList Left, Right; 4987 if (cast<CmpInst>(VL0)->isCommutative()) { 4988 // Commutative predicate - collect + sort operands of the instructions 4989 // so that each side is more likely to have the same opcode. 4990 assert(P0 == SwapP0 && "Commutative Predicate mismatch"); 4991 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 4992 } else { 4993 // Collect operands - commute if it uses the swapped predicate. 4994 for (Value *V : VL) { 4995 auto *Cmp = cast<CmpInst>(V); 4996 Value *LHS = Cmp->getOperand(0); 4997 Value *RHS = Cmp->getOperand(1); 4998 if (Cmp->getPredicate() != P0) 4999 std::swap(LHS, RHS); 5000 Left.push_back(LHS); 5001 Right.push_back(RHS); 5002 } 5003 } 5004 TE->setOperand(0, Left); 5005 TE->setOperand(1, Right); 5006 buildTree_rec(Left, Depth + 1, {TE, 0}); 5007 buildTree_rec(Right, Depth + 1, {TE, 1}); 5008 return; 5009 } 5010 case Instruction::Select: 5011 case Instruction::FNeg: 5012 case Instruction::Add: 5013 case Instruction::FAdd: 5014 case Instruction::Sub: 5015 case Instruction::FSub: 5016 case Instruction::Mul: 5017 case Instruction::FMul: 5018 case Instruction::UDiv: 5019 case Instruction::SDiv: 5020 case Instruction::FDiv: 5021 case Instruction::URem: 5022 case Instruction::SRem: 5023 case Instruction::FRem: 5024 case Instruction::Shl: 5025 case Instruction::LShr: 5026 case Instruction::AShr: 5027 case Instruction::And: 5028 case Instruction::Or: 5029 case Instruction::Xor: { 5030 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5031 ReuseShuffleIndicies); 5032 LLVM_DEBUG(dbgs() << "SLP: added a vector of un/bin op.\n"); 5033 5034 // Sort operands of the instructions so that each side is more likely to 5035 // have the same opcode. 5036 if (isa<BinaryOperator>(VL0) && VL0->isCommutative()) { 5037 ValueList Left, Right; 5038 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 5039 TE->setOperand(0, Left); 5040 TE->setOperand(1, Right); 5041 buildTree_rec(Left, Depth + 1, {TE, 0}); 5042 buildTree_rec(Right, Depth + 1, {TE, 1}); 5043 return; 5044 } 5045 5046 TE->setOperandsInOrder(); 5047 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 5048 ValueList Operands; 5049 // Prepare the operand vector. 5050 for (Value *V : VL) 5051 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 5052 5053 buildTree_rec(Operands, Depth + 1, {TE, i}); 5054 } 5055 return; 5056 } 5057 case Instruction::GetElementPtr: { 5058 // We don't combine GEPs with complicated (nested) indexing. 5059 for (Value *V : VL) { 5060 if (cast<Instruction>(V)->getNumOperands() != 2) { 5061 LLVM_DEBUG(dbgs() << "SLP: not-vectorizable GEP (nested indexes).\n"); 5062 BS.cancelScheduling(VL, VL0); 5063 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5064 ReuseShuffleIndicies); 5065 return; 5066 } 5067 } 5068 5069 // We can't combine several GEPs into one vector if they operate on 5070 // different types. 5071 Type *Ty0 = cast<GEPOperator>(VL0)->getSourceElementType(); 5072 for (Value *V : VL) { 5073 Type *CurTy = cast<GEPOperator>(V)->getSourceElementType(); 5074 if (Ty0 != CurTy) { 5075 LLVM_DEBUG(dbgs() 5076 << "SLP: not-vectorizable GEP (different types).\n"); 5077 BS.cancelScheduling(VL, VL0); 5078 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5079 ReuseShuffleIndicies); 5080 return; 5081 } 5082 } 5083 5084 // We don't combine GEPs with non-constant indexes. 5085 Type *Ty1 = VL0->getOperand(1)->getType(); 5086 for (Value *V : VL) { 5087 auto Op = cast<Instruction>(V)->getOperand(1); 5088 if (!isa<ConstantInt>(Op) || 5089 (Op->getType() != Ty1 && 5090 Op->getType()->getScalarSizeInBits() > 5091 DL->getIndexSizeInBits( 5092 V->getType()->getPointerAddressSpace()))) { 5093 LLVM_DEBUG(dbgs() 5094 << "SLP: not-vectorizable GEP (non-constant indexes).\n"); 5095 BS.cancelScheduling(VL, VL0); 5096 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5097 ReuseShuffleIndicies); 5098 return; 5099 } 5100 } 5101 5102 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5103 ReuseShuffleIndicies); 5104 LLVM_DEBUG(dbgs() << "SLP: added a vector of GEPs.\n"); 5105 SmallVector<ValueList, 2> Operands(2); 5106 // Prepare the operand vector for pointer operands. 5107 for (Value *V : VL) 5108 Operands.front().push_back( 5109 cast<GetElementPtrInst>(V)->getPointerOperand()); 5110 TE->setOperand(0, Operands.front()); 5111 // Need to cast all indices to the same type before vectorization to 5112 // avoid crash. 5113 // Required to be able to find correct matches between different gather 5114 // nodes and reuse the vectorized values rather than trying to gather them 5115 // again. 5116 int IndexIdx = 1; 5117 Type *VL0Ty = VL0->getOperand(IndexIdx)->getType(); 5118 Type *Ty = all_of(VL, 5119 [VL0Ty, IndexIdx](Value *V) { 5120 return VL0Ty == cast<GetElementPtrInst>(V) 5121 ->getOperand(IndexIdx) 5122 ->getType(); 5123 }) 5124 ? VL0Ty 5125 : DL->getIndexType(cast<GetElementPtrInst>(VL0) 5126 ->getPointerOperandType() 5127 ->getScalarType()); 5128 // Prepare the operand vector. 5129 for (Value *V : VL) { 5130 auto *Op = cast<Instruction>(V)->getOperand(IndexIdx); 5131 auto *CI = cast<ConstantInt>(Op); 5132 Operands.back().push_back(ConstantExpr::getIntegerCast( 5133 CI, Ty, CI->getValue().isSignBitSet())); 5134 } 5135 TE->setOperand(IndexIdx, Operands.back()); 5136 5137 for (unsigned I = 0, Ops = Operands.size(); I < Ops; ++I) 5138 buildTree_rec(Operands[I], Depth + 1, {TE, I}); 5139 return; 5140 } 5141 case Instruction::Store: { 5142 // Check if the stores are consecutive or if we need to swizzle them. 5143 llvm::Type *ScalarTy = cast<StoreInst>(VL0)->getValueOperand()->getType(); 5144 // Avoid types that are padded when being allocated as scalars, while 5145 // being packed together in a vector (such as i1). 5146 if (DL->getTypeSizeInBits(ScalarTy) != 5147 DL->getTypeAllocSizeInBits(ScalarTy)) { 5148 BS.cancelScheduling(VL, VL0); 5149 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5150 ReuseShuffleIndicies); 5151 LLVM_DEBUG(dbgs() << "SLP: Gathering stores of non-packed type.\n"); 5152 return; 5153 } 5154 // Make sure all stores in the bundle are simple - we can't vectorize 5155 // atomic or volatile stores. 5156 SmallVector<Value *, 4> PointerOps(VL.size()); 5157 ValueList Operands(VL.size()); 5158 auto POIter = PointerOps.begin(); 5159 auto OIter = Operands.begin(); 5160 for (Value *V : VL) { 5161 auto *SI = cast<StoreInst>(V); 5162 if (!SI->isSimple()) { 5163 BS.cancelScheduling(VL, VL0); 5164 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5165 ReuseShuffleIndicies); 5166 LLVM_DEBUG(dbgs() << "SLP: Gathering non-simple stores.\n"); 5167 return; 5168 } 5169 *POIter = SI->getPointerOperand(); 5170 *OIter = SI->getValueOperand(); 5171 ++POIter; 5172 ++OIter; 5173 } 5174 5175 OrdersType CurrentOrder; 5176 // Check the order of pointer operands. 5177 if (llvm::sortPtrAccesses(PointerOps, ScalarTy, *DL, *SE, CurrentOrder)) { 5178 Value *Ptr0; 5179 Value *PtrN; 5180 if (CurrentOrder.empty()) { 5181 Ptr0 = PointerOps.front(); 5182 PtrN = PointerOps.back(); 5183 } else { 5184 Ptr0 = PointerOps[CurrentOrder.front()]; 5185 PtrN = PointerOps[CurrentOrder.back()]; 5186 } 5187 Optional<int> Dist = 5188 getPointersDiff(ScalarTy, Ptr0, ScalarTy, PtrN, *DL, *SE); 5189 // Check that the sorted pointer operands are consecutive. 5190 if (static_cast<unsigned>(*Dist) == VL.size() - 1) { 5191 if (CurrentOrder.empty()) { 5192 // Original stores are consecutive and does not require reordering. 5193 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, 5194 UserTreeIdx, ReuseShuffleIndicies); 5195 TE->setOperandsInOrder(); 5196 buildTree_rec(Operands, Depth + 1, {TE, 0}); 5197 LLVM_DEBUG(dbgs() << "SLP: added a vector of stores.\n"); 5198 } else { 5199 fixupOrderingIndices(CurrentOrder); 5200 TreeEntry *TE = 5201 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5202 ReuseShuffleIndicies, CurrentOrder); 5203 TE->setOperandsInOrder(); 5204 buildTree_rec(Operands, Depth + 1, {TE, 0}); 5205 LLVM_DEBUG(dbgs() << "SLP: added a vector of jumbled stores.\n"); 5206 } 5207 return; 5208 } 5209 } 5210 5211 BS.cancelScheduling(VL, VL0); 5212 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5213 ReuseShuffleIndicies); 5214 LLVM_DEBUG(dbgs() << "SLP: Non-consecutive store.\n"); 5215 return; 5216 } 5217 case Instruction::Call: { 5218 // Check if the calls are all to the same vectorizable intrinsic or 5219 // library function. 5220 CallInst *CI = cast<CallInst>(VL0); 5221 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 5222 5223 VFShape Shape = VFShape::get( 5224 *CI, ElementCount::getFixed(static_cast<unsigned int>(VL.size())), 5225 false /*HasGlobalPred*/); 5226 Function *VecFunc = VFDatabase(*CI).getVectorizedFunction(Shape); 5227 5228 if (!VecFunc && !isTriviallyVectorizable(ID)) { 5229 BS.cancelScheduling(VL, VL0); 5230 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5231 ReuseShuffleIndicies); 5232 LLVM_DEBUG(dbgs() << "SLP: Non-vectorizable call.\n"); 5233 return; 5234 } 5235 Function *F = CI->getCalledFunction(); 5236 unsigned NumArgs = CI->arg_size(); 5237 SmallVector<Value*, 4> ScalarArgs(NumArgs, nullptr); 5238 for (unsigned j = 0; j != NumArgs; ++j) 5239 if (isVectorIntrinsicWithScalarOpAtArg(ID, j)) 5240 ScalarArgs[j] = CI->getArgOperand(j); 5241 for (Value *V : VL) { 5242 CallInst *CI2 = dyn_cast<CallInst>(V); 5243 if (!CI2 || CI2->getCalledFunction() != F || 5244 getVectorIntrinsicIDForCall(CI2, TLI) != ID || 5245 (VecFunc && 5246 VecFunc != VFDatabase(*CI2).getVectorizedFunction(Shape)) || 5247 !CI->hasIdenticalOperandBundleSchema(*CI2)) { 5248 BS.cancelScheduling(VL, VL0); 5249 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5250 ReuseShuffleIndicies); 5251 LLVM_DEBUG(dbgs() << "SLP: mismatched calls:" << *CI << "!=" << *V 5252 << "\n"); 5253 return; 5254 } 5255 // Some intrinsics have scalar arguments and should be same in order for 5256 // them to be vectorized. 5257 for (unsigned j = 0; j != NumArgs; ++j) { 5258 if (isVectorIntrinsicWithScalarOpAtArg(ID, j)) { 5259 Value *A1J = CI2->getArgOperand(j); 5260 if (ScalarArgs[j] != A1J) { 5261 BS.cancelScheduling(VL, VL0); 5262 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5263 ReuseShuffleIndicies); 5264 LLVM_DEBUG(dbgs() << "SLP: mismatched arguments in call:" << *CI 5265 << " argument " << ScalarArgs[j] << "!=" << A1J 5266 << "\n"); 5267 return; 5268 } 5269 } 5270 } 5271 // Verify that the bundle operands are identical between the two calls. 5272 if (CI->hasOperandBundles() && 5273 !std::equal(CI->op_begin() + CI->getBundleOperandsStartIndex(), 5274 CI->op_begin() + CI->getBundleOperandsEndIndex(), 5275 CI2->op_begin() + CI2->getBundleOperandsStartIndex())) { 5276 BS.cancelScheduling(VL, VL0); 5277 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5278 ReuseShuffleIndicies); 5279 LLVM_DEBUG(dbgs() << "SLP: mismatched bundle operands in calls:" 5280 << *CI << "!=" << *V << '\n'); 5281 return; 5282 } 5283 } 5284 5285 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5286 ReuseShuffleIndicies); 5287 TE->setOperandsInOrder(); 5288 for (unsigned i = 0, e = CI->arg_size(); i != e; ++i) { 5289 // For scalar operands no need to to create an entry since no need to 5290 // vectorize it. 5291 if (isVectorIntrinsicWithScalarOpAtArg(ID, i)) 5292 continue; 5293 ValueList Operands; 5294 // Prepare the operand vector. 5295 for (Value *V : VL) { 5296 auto *CI2 = cast<CallInst>(V); 5297 Operands.push_back(CI2->getArgOperand(i)); 5298 } 5299 buildTree_rec(Operands, Depth + 1, {TE, i}); 5300 } 5301 return; 5302 } 5303 case Instruction::ShuffleVector: { 5304 // If this is not an alternate sequence of opcode like add-sub 5305 // then do not vectorize this instruction. 5306 if (!S.isAltShuffle()) { 5307 BS.cancelScheduling(VL, VL0); 5308 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5309 ReuseShuffleIndicies); 5310 LLVM_DEBUG(dbgs() << "SLP: ShuffleVector are not vectorized.\n"); 5311 return; 5312 } 5313 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5314 ReuseShuffleIndicies); 5315 LLVM_DEBUG(dbgs() << "SLP: added a ShuffleVector op.\n"); 5316 5317 // Reorder operands if reordering would enable vectorization. 5318 auto *CI = dyn_cast<CmpInst>(VL0); 5319 if (isa<BinaryOperator>(VL0) || CI) { 5320 ValueList Left, Right; 5321 if (!CI || all_of(VL, [](Value *V) { 5322 return cast<CmpInst>(V)->isCommutative(); 5323 })) { 5324 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 5325 } else { 5326 CmpInst::Predicate P0 = CI->getPredicate(); 5327 CmpInst::Predicate AltP0 = cast<CmpInst>(S.AltOp)->getPredicate(); 5328 assert(P0 != AltP0 && 5329 "Expected different main/alternate predicates."); 5330 CmpInst::Predicate AltP0Swapped = CmpInst::getSwappedPredicate(AltP0); 5331 Value *BaseOp0 = VL0->getOperand(0); 5332 Value *BaseOp1 = VL0->getOperand(1); 5333 // Collect operands - commute if it uses the swapped predicate or 5334 // alternate operation. 5335 for (Value *V : VL) { 5336 auto *Cmp = cast<CmpInst>(V); 5337 Value *LHS = Cmp->getOperand(0); 5338 Value *RHS = Cmp->getOperand(1); 5339 CmpInst::Predicate CurrentPred = Cmp->getPredicate(); 5340 if (P0 == AltP0Swapped) { 5341 if (CI != Cmp && S.AltOp != Cmp && 5342 ((P0 == CurrentPred && 5343 !areCompatibleCmpOps(BaseOp0, BaseOp1, LHS, RHS)) || 5344 (AltP0 == CurrentPred && 5345 areCompatibleCmpOps(BaseOp0, BaseOp1, LHS, RHS)))) 5346 std::swap(LHS, RHS); 5347 } else if (P0 != CurrentPred && AltP0 != CurrentPred) { 5348 std::swap(LHS, RHS); 5349 } 5350 Left.push_back(LHS); 5351 Right.push_back(RHS); 5352 } 5353 } 5354 TE->setOperand(0, Left); 5355 TE->setOperand(1, Right); 5356 buildTree_rec(Left, Depth + 1, {TE, 0}); 5357 buildTree_rec(Right, Depth + 1, {TE, 1}); 5358 return; 5359 } 5360 5361 TE->setOperandsInOrder(); 5362 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 5363 ValueList Operands; 5364 // Prepare the operand vector. 5365 for (Value *V : VL) 5366 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 5367 5368 buildTree_rec(Operands, Depth + 1, {TE, i}); 5369 } 5370 return; 5371 } 5372 default: 5373 BS.cancelScheduling(VL, VL0); 5374 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5375 ReuseShuffleIndicies); 5376 LLVM_DEBUG(dbgs() << "SLP: Gathering unknown instruction.\n"); 5377 return; 5378 } 5379 } 5380 5381 unsigned BoUpSLP::canMapToVector(Type *T, const DataLayout &DL) const { 5382 unsigned N = 1; 5383 Type *EltTy = T; 5384 5385 while (isa<StructType>(EltTy) || isa<ArrayType>(EltTy) || 5386 isa<VectorType>(EltTy)) { 5387 if (auto *ST = dyn_cast<StructType>(EltTy)) { 5388 // Check that struct is homogeneous. 5389 for (const auto *Ty : ST->elements()) 5390 if (Ty != *ST->element_begin()) 5391 return 0; 5392 N *= ST->getNumElements(); 5393 EltTy = *ST->element_begin(); 5394 } else if (auto *AT = dyn_cast<ArrayType>(EltTy)) { 5395 N *= AT->getNumElements(); 5396 EltTy = AT->getElementType(); 5397 } else { 5398 auto *VT = cast<FixedVectorType>(EltTy); 5399 N *= VT->getNumElements(); 5400 EltTy = VT->getElementType(); 5401 } 5402 } 5403 5404 if (!isValidElementType(EltTy)) 5405 return 0; 5406 uint64_t VTSize = DL.getTypeStoreSizeInBits(FixedVectorType::get(EltTy, N)); 5407 if (VTSize < MinVecRegSize || VTSize > MaxVecRegSize || VTSize != DL.getTypeStoreSizeInBits(T)) 5408 return 0; 5409 return N; 5410 } 5411 5412 bool BoUpSLP::canReuseExtract(ArrayRef<Value *> VL, Value *OpValue, 5413 SmallVectorImpl<unsigned> &CurrentOrder) const { 5414 const auto *It = find_if(VL, [](Value *V) { 5415 return isa<ExtractElementInst, ExtractValueInst>(V); 5416 }); 5417 assert(It != VL.end() && "Expected at least one extract instruction."); 5418 auto *E0 = cast<Instruction>(*It); 5419 assert(all_of(VL, 5420 [](Value *V) { 5421 return isa<UndefValue, ExtractElementInst, ExtractValueInst>( 5422 V); 5423 }) && 5424 "Invalid opcode"); 5425 // Check if all of the extracts come from the same vector and from the 5426 // correct offset. 5427 Value *Vec = E0->getOperand(0); 5428 5429 CurrentOrder.clear(); 5430 5431 // We have to extract from a vector/aggregate with the same number of elements. 5432 unsigned NElts; 5433 if (E0->getOpcode() == Instruction::ExtractValue) { 5434 const DataLayout &DL = E0->getModule()->getDataLayout(); 5435 NElts = canMapToVector(Vec->getType(), DL); 5436 if (!NElts) 5437 return false; 5438 // Check if load can be rewritten as load of vector. 5439 LoadInst *LI = dyn_cast<LoadInst>(Vec); 5440 if (!LI || !LI->isSimple() || !LI->hasNUses(VL.size())) 5441 return false; 5442 } else { 5443 NElts = cast<FixedVectorType>(Vec->getType())->getNumElements(); 5444 } 5445 5446 if (NElts != VL.size()) 5447 return false; 5448 5449 // Check that all of the indices extract from the correct offset. 5450 bool ShouldKeepOrder = true; 5451 unsigned E = VL.size(); 5452 // Assign to all items the initial value E + 1 so we can check if the extract 5453 // instruction index was used already. 5454 // Also, later we can check that all the indices are used and we have a 5455 // consecutive access in the extract instructions, by checking that no 5456 // element of CurrentOrder still has value E + 1. 5457 CurrentOrder.assign(E, E); 5458 unsigned I = 0; 5459 for (; I < E; ++I) { 5460 auto *Inst = dyn_cast<Instruction>(VL[I]); 5461 if (!Inst) 5462 continue; 5463 if (Inst->getOperand(0) != Vec) 5464 break; 5465 if (auto *EE = dyn_cast<ExtractElementInst>(Inst)) 5466 if (isa<UndefValue>(EE->getIndexOperand())) 5467 continue; 5468 Optional<unsigned> Idx = getExtractIndex(Inst); 5469 if (!Idx) 5470 break; 5471 const unsigned ExtIdx = *Idx; 5472 if (ExtIdx != I) { 5473 if (ExtIdx >= E || CurrentOrder[ExtIdx] != E) 5474 break; 5475 ShouldKeepOrder = false; 5476 CurrentOrder[ExtIdx] = I; 5477 } else { 5478 if (CurrentOrder[I] != E) 5479 break; 5480 CurrentOrder[I] = I; 5481 } 5482 } 5483 if (I < E) { 5484 CurrentOrder.clear(); 5485 return false; 5486 } 5487 if (ShouldKeepOrder) 5488 CurrentOrder.clear(); 5489 5490 return ShouldKeepOrder; 5491 } 5492 5493 bool BoUpSLP::areAllUsersVectorized(Instruction *I, 5494 ArrayRef<Value *> VectorizedVals) const { 5495 return (I->hasOneUse() && is_contained(VectorizedVals, I)) || 5496 all_of(I->users(), [this](User *U) { 5497 return ScalarToTreeEntry.count(U) > 0 || 5498 isVectorLikeInstWithConstOps(U) || 5499 (isa<ExtractElementInst>(U) && MustGather.contains(U)); 5500 }); 5501 } 5502 5503 static std::pair<InstructionCost, InstructionCost> 5504 getVectorCallCosts(CallInst *CI, FixedVectorType *VecTy, 5505 TargetTransformInfo *TTI, TargetLibraryInfo *TLI) { 5506 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 5507 5508 // Calculate the cost of the scalar and vector calls. 5509 SmallVector<Type *, 4> VecTys; 5510 for (Use &Arg : CI->args()) 5511 VecTys.push_back( 5512 FixedVectorType::get(Arg->getType(), VecTy->getNumElements())); 5513 FastMathFlags FMF; 5514 if (auto *FPCI = dyn_cast<FPMathOperator>(CI)) 5515 FMF = FPCI->getFastMathFlags(); 5516 SmallVector<const Value *> Arguments(CI->args()); 5517 IntrinsicCostAttributes CostAttrs(ID, VecTy, Arguments, VecTys, FMF, 5518 dyn_cast<IntrinsicInst>(CI)); 5519 auto IntrinsicCost = 5520 TTI->getIntrinsicInstrCost(CostAttrs, TTI::TCK_RecipThroughput); 5521 5522 auto Shape = VFShape::get(*CI, ElementCount::getFixed(static_cast<unsigned>( 5523 VecTy->getNumElements())), 5524 false /*HasGlobalPred*/); 5525 Function *VecFunc = VFDatabase(*CI).getVectorizedFunction(Shape); 5526 auto LibCost = IntrinsicCost; 5527 if (!CI->isNoBuiltin() && VecFunc) { 5528 // Calculate the cost of the vector library call. 5529 // If the corresponding vector call is cheaper, return its cost. 5530 LibCost = TTI->getCallInstrCost(nullptr, VecTy, VecTys, 5531 TTI::TCK_RecipThroughput); 5532 } 5533 return {IntrinsicCost, LibCost}; 5534 } 5535 5536 /// Compute the cost of creating a vector of type \p VecTy containing the 5537 /// extracted values from \p VL. 5538 static InstructionCost 5539 computeExtractCost(ArrayRef<Value *> VL, FixedVectorType *VecTy, 5540 TargetTransformInfo::ShuffleKind ShuffleKind, 5541 ArrayRef<int> Mask, TargetTransformInfo &TTI) { 5542 unsigned NumOfParts = TTI.getNumberOfParts(VecTy); 5543 5544 if (ShuffleKind != TargetTransformInfo::SK_PermuteSingleSrc || !NumOfParts || 5545 VecTy->getNumElements() < NumOfParts) 5546 return TTI.getShuffleCost(ShuffleKind, VecTy, Mask); 5547 5548 bool AllConsecutive = true; 5549 unsigned EltsPerVector = VecTy->getNumElements() / NumOfParts; 5550 unsigned Idx = -1; 5551 InstructionCost Cost = 0; 5552 5553 // Process extracts in blocks of EltsPerVector to check if the source vector 5554 // operand can be re-used directly. If not, add the cost of creating a shuffle 5555 // to extract the values into a vector register. 5556 SmallVector<int> RegMask(EltsPerVector, UndefMaskElem); 5557 for (auto *V : VL) { 5558 ++Idx; 5559 5560 // Reached the start of a new vector registers. 5561 if (Idx % EltsPerVector == 0) { 5562 RegMask.assign(EltsPerVector, UndefMaskElem); 5563 AllConsecutive = true; 5564 continue; 5565 } 5566 5567 // Need to exclude undefs from analysis. 5568 if (isa<UndefValue>(V) || Mask[Idx] == UndefMaskElem) 5569 continue; 5570 5571 // Check all extracts for a vector register on the target directly 5572 // extract values in order. 5573 unsigned CurrentIdx = *getExtractIndex(cast<Instruction>(V)); 5574 if (!isa<UndefValue>(VL[Idx - 1]) && Mask[Idx - 1] != UndefMaskElem) { 5575 unsigned PrevIdx = *getExtractIndex(cast<Instruction>(VL[Idx - 1])); 5576 AllConsecutive &= PrevIdx + 1 == CurrentIdx && 5577 CurrentIdx % EltsPerVector == Idx % EltsPerVector; 5578 RegMask[Idx % EltsPerVector] = CurrentIdx % EltsPerVector; 5579 } 5580 5581 if (AllConsecutive) 5582 continue; 5583 5584 // Skip all indices, except for the last index per vector block. 5585 if ((Idx + 1) % EltsPerVector != 0 && Idx + 1 != VL.size()) 5586 continue; 5587 5588 // If we have a series of extracts which are not consecutive and hence 5589 // cannot re-use the source vector register directly, compute the shuffle 5590 // cost to extract the vector with EltsPerVector elements. 5591 Cost += TTI.getShuffleCost( 5592 TargetTransformInfo::SK_PermuteSingleSrc, 5593 FixedVectorType::get(VecTy->getElementType(), EltsPerVector), RegMask); 5594 } 5595 return Cost; 5596 } 5597 5598 /// Build shuffle mask for shuffle graph entries and lists of main and alternate 5599 /// operations operands. 5600 static void 5601 buildShuffleEntryMask(ArrayRef<Value *> VL, ArrayRef<unsigned> ReorderIndices, 5602 ArrayRef<int> ReusesIndices, 5603 const function_ref<bool(Instruction *)> IsAltOp, 5604 SmallVectorImpl<int> &Mask, 5605 SmallVectorImpl<Value *> *OpScalars = nullptr, 5606 SmallVectorImpl<Value *> *AltScalars = nullptr) { 5607 unsigned Sz = VL.size(); 5608 Mask.assign(Sz, UndefMaskElem); 5609 SmallVector<int> OrderMask; 5610 if (!ReorderIndices.empty()) 5611 inversePermutation(ReorderIndices, OrderMask); 5612 for (unsigned I = 0; I < Sz; ++I) { 5613 unsigned Idx = I; 5614 if (!ReorderIndices.empty()) 5615 Idx = OrderMask[I]; 5616 auto *OpInst = cast<Instruction>(VL[Idx]); 5617 if (IsAltOp(OpInst)) { 5618 Mask[I] = Sz + Idx; 5619 if (AltScalars) 5620 AltScalars->push_back(OpInst); 5621 } else { 5622 Mask[I] = Idx; 5623 if (OpScalars) 5624 OpScalars->push_back(OpInst); 5625 } 5626 } 5627 if (!ReusesIndices.empty()) { 5628 SmallVector<int> NewMask(ReusesIndices.size(), UndefMaskElem); 5629 transform(ReusesIndices, NewMask.begin(), [&Mask](int Idx) { 5630 return Idx != UndefMaskElem ? Mask[Idx] : UndefMaskElem; 5631 }); 5632 Mask.swap(NewMask); 5633 } 5634 } 5635 5636 /// Checks if the specified instruction \p I is an alternate operation for the 5637 /// given \p MainOp and \p AltOp instructions. 5638 static bool isAlternateInstruction(const Instruction *I, 5639 const Instruction *MainOp, 5640 const Instruction *AltOp) { 5641 if (auto *CI0 = dyn_cast<CmpInst>(MainOp)) { 5642 auto *AltCI0 = cast<CmpInst>(AltOp); 5643 auto *CI = cast<CmpInst>(I); 5644 CmpInst::Predicate P0 = CI0->getPredicate(); 5645 CmpInst::Predicate AltP0 = AltCI0->getPredicate(); 5646 assert(P0 != AltP0 && "Expected different main/alternate predicates."); 5647 CmpInst::Predicate AltP0Swapped = CmpInst::getSwappedPredicate(AltP0); 5648 CmpInst::Predicate CurrentPred = CI->getPredicate(); 5649 if (P0 == AltP0Swapped) 5650 return I == AltCI0 || 5651 (I != MainOp && 5652 !areCompatibleCmpOps(CI0->getOperand(0), CI0->getOperand(1), 5653 CI->getOperand(0), CI->getOperand(1))); 5654 return AltP0 == CurrentPred || AltP0Swapped == CurrentPred; 5655 } 5656 return I->getOpcode() == AltOp->getOpcode(); 5657 } 5658 5659 InstructionCost BoUpSLP::getEntryCost(const TreeEntry *E, 5660 ArrayRef<Value *> VectorizedVals) { 5661 ArrayRef<Value*> VL = E->Scalars; 5662 5663 Type *ScalarTy = VL[0]->getType(); 5664 if (StoreInst *SI = dyn_cast<StoreInst>(VL[0])) 5665 ScalarTy = SI->getValueOperand()->getType(); 5666 else if (CmpInst *CI = dyn_cast<CmpInst>(VL[0])) 5667 ScalarTy = CI->getOperand(0)->getType(); 5668 else if (auto *IE = dyn_cast<InsertElementInst>(VL[0])) 5669 ScalarTy = IE->getOperand(1)->getType(); 5670 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 5671 TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput; 5672 5673 // If we have computed a smaller type for the expression, update VecTy so 5674 // that the costs will be accurate. 5675 if (MinBWs.count(VL[0])) 5676 VecTy = FixedVectorType::get( 5677 IntegerType::get(F->getContext(), MinBWs[VL[0]].first), VL.size()); 5678 unsigned EntryVF = E->getVectorFactor(); 5679 auto *FinalVecTy = FixedVectorType::get(VecTy->getElementType(), EntryVF); 5680 5681 bool NeedToShuffleReuses = !E->ReuseShuffleIndices.empty(); 5682 // FIXME: it tries to fix a problem with MSVC buildbots. 5683 TargetTransformInfo &TTIRef = *TTI; 5684 auto &&AdjustExtractsCost = [this, &TTIRef, CostKind, VL, VecTy, 5685 VectorizedVals, E](InstructionCost &Cost) { 5686 DenseMap<Value *, int> ExtractVectorsTys; 5687 SmallPtrSet<Value *, 4> CheckedExtracts; 5688 for (auto *V : VL) { 5689 if (isa<UndefValue>(V)) 5690 continue; 5691 // If all users of instruction are going to be vectorized and this 5692 // instruction itself is not going to be vectorized, consider this 5693 // instruction as dead and remove its cost from the final cost of the 5694 // vectorized tree. 5695 // Also, avoid adjusting the cost for extractelements with multiple uses 5696 // in different graph entries. 5697 const TreeEntry *VE = getTreeEntry(V); 5698 if (!CheckedExtracts.insert(V).second || 5699 !areAllUsersVectorized(cast<Instruction>(V), VectorizedVals) || 5700 (VE && VE != E)) 5701 continue; 5702 auto *EE = cast<ExtractElementInst>(V); 5703 Optional<unsigned> EEIdx = getExtractIndex(EE); 5704 if (!EEIdx) 5705 continue; 5706 unsigned Idx = *EEIdx; 5707 if (TTIRef.getNumberOfParts(VecTy) != 5708 TTIRef.getNumberOfParts(EE->getVectorOperandType())) { 5709 auto It = 5710 ExtractVectorsTys.try_emplace(EE->getVectorOperand(), Idx).first; 5711 It->getSecond() = std::min<int>(It->second, Idx); 5712 } 5713 // Take credit for instruction that will become dead. 5714 if (EE->hasOneUse()) { 5715 Instruction *Ext = EE->user_back(); 5716 if ((isa<SExtInst>(Ext) || isa<ZExtInst>(Ext)) && 5717 all_of(Ext->users(), 5718 [](User *U) { return isa<GetElementPtrInst>(U); })) { 5719 // Use getExtractWithExtendCost() to calculate the cost of 5720 // extractelement/ext pair. 5721 Cost -= 5722 TTIRef.getExtractWithExtendCost(Ext->getOpcode(), Ext->getType(), 5723 EE->getVectorOperandType(), Idx); 5724 // Add back the cost of s|zext which is subtracted separately. 5725 Cost += TTIRef.getCastInstrCost( 5726 Ext->getOpcode(), Ext->getType(), EE->getType(), 5727 TTI::getCastContextHint(Ext), CostKind, Ext); 5728 continue; 5729 } 5730 } 5731 Cost -= TTIRef.getVectorInstrCost(Instruction::ExtractElement, 5732 EE->getVectorOperandType(), Idx); 5733 } 5734 // Add a cost for subvector extracts/inserts if required. 5735 for (const auto &Data : ExtractVectorsTys) { 5736 auto *EEVTy = cast<FixedVectorType>(Data.first->getType()); 5737 unsigned NumElts = VecTy->getNumElements(); 5738 if (Data.second % NumElts == 0) 5739 continue; 5740 if (TTIRef.getNumberOfParts(EEVTy) > TTIRef.getNumberOfParts(VecTy)) { 5741 unsigned Idx = (Data.second / NumElts) * NumElts; 5742 unsigned EENumElts = EEVTy->getNumElements(); 5743 if (Idx + NumElts <= EENumElts) { 5744 Cost += 5745 TTIRef.getShuffleCost(TargetTransformInfo::SK_ExtractSubvector, 5746 EEVTy, None, Idx, VecTy); 5747 } else { 5748 // Need to round up the subvector type vectorization factor to avoid a 5749 // crash in cost model functions. Make SubVT so that Idx + VF of SubVT 5750 // <= EENumElts. 5751 auto *SubVT = 5752 FixedVectorType::get(VecTy->getElementType(), EENumElts - Idx); 5753 Cost += 5754 TTIRef.getShuffleCost(TargetTransformInfo::SK_ExtractSubvector, 5755 EEVTy, None, Idx, SubVT); 5756 } 5757 } else { 5758 Cost += TTIRef.getShuffleCost(TargetTransformInfo::SK_InsertSubvector, 5759 VecTy, None, 0, EEVTy); 5760 } 5761 } 5762 }; 5763 if (E->State == TreeEntry::NeedToGather) { 5764 if (allConstant(VL)) 5765 return 0; 5766 if (isa<InsertElementInst>(VL[0])) 5767 return InstructionCost::getInvalid(); 5768 SmallVector<int> Mask; 5769 SmallVector<const TreeEntry *> Entries; 5770 Optional<TargetTransformInfo::ShuffleKind> Shuffle = 5771 isGatherShuffledEntry(E, Mask, Entries); 5772 if (Shuffle.hasValue()) { 5773 InstructionCost GatherCost = 0; 5774 if (ShuffleVectorInst::isIdentityMask(Mask)) { 5775 // Perfect match in the graph, will reuse the previously vectorized 5776 // node. Cost is 0. 5777 LLVM_DEBUG( 5778 dbgs() 5779 << "SLP: perfect diamond match for gather bundle that starts with " 5780 << *VL.front() << ".\n"); 5781 if (NeedToShuffleReuses) 5782 GatherCost = 5783 TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, 5784 FinalVecTy, E->ReuseShuffleIndices); 5785 } else { 5786 LLVM_DEBUG(dbgs() << "SLP: shuffled " << Entries.size() 5787 << " entries for bundle that starts with " 5788 << *VL.front() << ".\n"); 5789 // Detected that instead of gather we can emit a shuffle of single/two 5790 // previously vectorized nodes. Add the cost of the permutation rather 5791 // than gather. 5792 ::addMask(Mask, E->ReuseShuffleIndices); 5793 GatherCost = TTI->getShuffleCost(*Shuffle, FinalVecTy, Mask); 5794 } 5795 return GatherCost; 5796 } 5797 if ((E->getOpcode() == Instruction::ExtractElement || 5798 all_of(E->Scalars, 5799 [](Value *V) { 5800 return isa<ExtractElementInst, UndefValue>(V); 5801 })) && 5802 allSameType(VL)) { 5803 // Check that gather of extractelements can be represented as just a 5804 // shuffle of a single/two vectors the scalars are extracted from. 5805 SmallVector<int> Mask; 5806 Optional<TargetTransformInfo::ShuffleKind> ShuffleKind = 5807 isFixedVectorShuffle(VL, Mask); 5808 if (ShuffleKind.hasValue()) { 5809 // Found the bunch of extractelement instructions that must be gathered 5810 // into a vector and can be represented as a permutation elements in a 5811 // single input vector or of 2 input vectors. 5812 InstructionCost Cost = 5813 computeExtractCost(VL, VecTy, *ShuffleKind, Mask, *TTI); 5814 AdjustExtractsCost(Cost); 5815 if (NeedToShuffleReuses) 5816 Cost += TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, 5817 FinalVecTy, E->ReuseShuffleIndices); 5818 return Cost; 5819 } 5820 } 5821 if (isSplat(VL)) { 5822 // Found the broadcasting of the single scalar, calculate the cost as the 5823 // broadcast. 5824 assert(VecTy == FinalVecTy && 5825 "No reused scalars expected for broadcast."); 5826 return TTI->getShuffleCost(TargetTransformInfo::SK_Broadcast, VecTy, 5827 /*Mask=*/None, /*Index=*/0, 5828 /*SubTp=*/nullptr, /*Args=*/VL[0]); 5829 } 5830 InstructionCost ReuseShuffleCost = 0; 5831 if (NeedToShuffleReuses) 5832 ReuseShuffleCost = TTI->getShuffleCost( 5833 TTI::SK_PermuteSingleSrc, FinalVecTy, E->ReuseShuffleIndices); 5834 // Improve gather cost for gather of loads, if we can group some of the 5835 // loads into vector loads. 5836 if (VL.size() > 2 && E->getOpcode() == Instruction::Load && 5837 !E->isAltShuffle()) { 5838 BoUpSLP::ValueSet VectorizedLoads; 5839 unsigned StartIdx = 0; 5840 unsigned VF = VL.size() / 2; 5841 unsigned VectorizedCnt = 0; 5842 unsigned ScatterVectorizeCnt = 0; 5843 const unsigned Sz = DL->getTypeSizeInBits(E->getMainOp()->getType()); 5844 for (unsigned MinVF = getMinVF(2 * Sz); VF >= MinVF; VF /= 2) { 5845 for (unsigned Cnt = StartIdx, End = VL.size(); Cnt + VF <= End; 5846 Cnt += VF) { 5847 ArrayRef<Value *> Slice = VL.slice(Cnt, VF); 5848 if (!VectorizedLoads.count(Slice.front()) && 5849 !VectorizedLoads.count(Slice.back()) && allSameBlock(Slice)) { 5850 SmallVector<Value *> PointerOps; 5851 OrdersType CurrentOrder; 5852 LoadsState LS = canVectorizeLoads(Slice, Slice.front(), *TTI, *DL, 5853 *SE, CurrentOrder, PointerOps); 5854 switch (LS) { 5855 case LoadsState::Vectorize: 5856 case LoadsState::ScatterVectorize: 5857 // Mark the vectorized loads so that we don't vectorize them 5858 // again. 5859 if (LS == LoadsState::Vectorize) 5860 ++VectorizedCnt; 5861 else 5862 ++ScatterVectorizeCnt; 5863 VectorizedLoads.insert(Slice.begin(), Slice.end()); 5864 // If we vectorized initial block, no need to try to vectorize it 5865 // again. 5866 if (Cnt == StartIdx) 5867 StartIdx += VF; 5868 break; 5869 case LoadsState::Gather: 5870 break; 5871 } 5872 } 5873 } 5874 // Check if the whole array was vectorized already - exit. 5875 if (StartIdx >= VL.size()) 5876 break; 5877 // Found vectorizable parts - exit. 5878 if (!VectorizedLoads.empty()) 5879 break; 5880 } 5881 if (!VectorizedLoads.empty()) { 5882 InstructionCost GatherCost = 0; 5883 unsigned NumParts = TTI->getNumberOfParts(VecTy); 5884 bool NeedInsertSubvectorAnalysis = 5885 !NumParts || (VL.size() / VF) > NumParts; 5886 // Get the cost for gathered loads. 5887 for (unsigned I = 0, End = VL.size(); I < End; I += VF) { 5888 if (VectorizedLoads.contains(VL[I])) 5889 continue; 5890 GatherCost += getGatherCost(VL.slice(I, VF)); 5891 } 5892 // The cost for vectorized loads. 5893 InstructionCost ScalarsCost = 0; 5894 for (Value *V : VectorizedLoads) { 5895 auto *LI = cast<LoadInst>(V); 5896 ScalarsCost += TTI->getMemoryOpCost( 5897 Instruction::Load, LI->getType(), LI->getAlign(), 5898 LI->getPointerAddressSpace(), CostKind, LI); 5899 } 5900 auto *LI = cast<LoadInst>(E->getMainOp()); 5901 auto *LoadTy = FixedVectorType::get(LI->getType(), VF); 5902 Align Alignment = LI->getAlign(); 5903 GatherCost += 5904 VectorizedCnt * 5905 TTI->getMemoryOpCost(Instruction::Load, LoadTy, Alignment, 5906 LI->getPointerAddressSpace(), CostKind, LI); 5907 GatherCost += ScatterVectorizeCnt * 5908 TTI->getGatherScatterOpCost( 5909 Instruction::Load, LoadTy, LI->getPointerOperand(), 5910 /*VariableMask=*/false, Alignment, CostKind, LI); 5911 if (NeedInsertSubvectorAnalysis) { 5912 // Add the cost for the subvectors insert. 5913 for (int I = VF, E = VL.size(); I < E; I += VF) 5914 GatherCost += TTI->getShuffleCost(TTI::SK_InsertSubvector, VecTy, 5915 None, I, LoadTy); 5916 } 5917 return ReuseShuffleCost + GatherCost - ScalarsCost; 5918 } 5919 } 5920 return ReuseShuffleCost + getGatherCost(VL); 5921 } 5922 InstructionCost CommonCost = 0; 5923 SmallVector<int> Mask; 5924 if (!E->ReorderIndices.empty()) { 5925 SmallVector<int> NewMask; 5926 if (E->getOpcode() == Instruction::Store) { 5927 // For stores the order is actually a mask. 5928 NewMask.resize(E->ReorderIndices.size()); 5929 copy(E->ReorderIndices, NewMask.begin()); 5930 } else { 5931 inversePermutation(E->ReorderIndices, NewMask); 5932 } 5933 ::addMask(Mask, NewMask); 5934 } 5935 if (NeedToShuffleReuses) 5936 ::addMask(Mask, E->ReuseShuffleIndices); 5937 if (!Mask.empty() && !ShuffleVectorInst::isIdentityMask(Mask)) 5938 CommonCost = 5939 TTI->getShuffleCost(TTI::SK_PermuteSingleSrc, FinalVecTy, Mask); 5940 assert((E->State == TreeEntry::Vectorize || 5941 E->State == TreeEntry::ScatterVectorize) && 5942 "Unhandled state"); 5943 assert(E->getOpcode() && allSameType(VL) && allSameBlock(VL) && "Invalid VL"); 5944 Instruction *VL0 = E->getMainOp(); 5945 unsigned ShuffleOrOp = 5946 E->isAltShuffle() ? (unsigned)Instruction::ShuffleVector : E->getOpcode(); 5947 switch (ShuffleOrOp) { 5948 case Instruction::PHI: 5949 return 0; 5950 5951 case Instruction::ExtractValue: 5952 case Instruction::ExtractElement: { 5953 // The common cost of removal ExtractElement/ExtractValue instructions + 5954 // the cost of shuffles, if required to resuffle the original vector. 5955 if (NeedToShuffleReuses) { 5956 unsigned Idx = 0; 5957 for (unsigned I : E->ReuseShuffleIndices) { 5958 if (ShuffleOrOp == Instruction::ExtractElement) { 5959 auto *EE = cast<ExtractElementInst>(VL[I]); 5960 CommonCost -= TTI->getVectorInstrCost(Instruction::ExtractElement, 5961 EE->getVectorOperandType(), 5962 *getExtractIndex(EE)); 5963 } else { 5964 CommonCost -= TTI->getVectorInstrCost(Instruction::ExtractElement, 5965 VecTy, Idx); 5966 ++Idx; 5967 } 5968 } 5969 Idx = EntryVF; 5970 for (Value *V : VL) { 5971 if (ShuffleOrOp == Instruction::ExtractElement) { 5972 auto *EE = cast<ExtractElementInst>(V); 5973 CommonCost += TTI->getVectorInstrCost(Instruction::ExtractElement, 5974 EE->getVectorOperandType(), 5975 *getExtractIndex(EE)); 5976 } else { 5977 --Idx; 5978 CommonCost += TTI->getVectorInstrCost(Instruction::ExtractElement, 5979 VecTy, Idx); 5980 } 5981 } 5982 } 5983 if (ShuffleOrOp == Instruction::ExtractValue) { 5984 for (unsigned I = 0, E = VL.size(); I < E; ++I) { 5985 auto *EI = cast<Instruction>(VL[I]); 5986 // Take credit for instruction that will become dead. 5987 if (EI->hasOneUse()) { 5988 Instruction *Ext = EI->user_back(); 5989 if ((isa<SExtInst>(Ext) || isa<ZExtInst>(Ext)) && 5990 all_of(Ext->users(), 5991 [](User *U) { return isa<GetElementPtrInst>(U); })) { 5992 // Use getExtractWithExtendCost() to calculate the cost of 5993 // extractelement/ext pair. 5994 CommonCost -= TTI->getExtractWithExtendCost( 5995 Ext->getOpcode(), Ext->getType(), VecTy, I); 5996 // Add back the cost of s|zext which is subtracted separately. 5997 CommonCost += TTI->getCastInstrCost( 5998 Ext->getOpcode(), Ext->getType(), EI->getType(), 5999 TTI::getCastContextHint(Ext), CostKind, Ext); 6000 continue; 6001 } 6002 } 6003 CommonCost -= 6004 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, I); 6005 } 6006 } else { 6007 AdjustExtractsCost(CommonCost); 6008 } 6009 return CommonCost; 6010 } 6011 case Instruction::InsertElement: { 6012 assert(E->ReuseShuffleIndices.empty() && 6013 "Unique insertelements only are expected."); 6014 auto *SrcVecTy = cast<FixedVectorType>(VL0->getType()); 6015 unsigned const NumElts = SrcVecTy->getNumElements(); 6016 unsigned const NumScalars = VL.size(); 6017 6018 unsigned NumOfParts = TTI->getNumberOfParts(SrcVecTy); 6019 6020 unsigned OffsetBeg = *getInsertIndex(VL.front()); 6021 unsigned OffsetEnd = OffsetBeg; 6022 for (Value *V : VL.drop_front()) { 6023 unsigned Idx = *getInsertIndex(V); 6024 if (OffsetBeg > Idx) 6025 OffsetBeg = Idx; 6026 else if (OffsetEnd < Idx) 6027 OffsetEnd = Idx; 6028 } 6029 unsigned VecScalarsSz = PowerOf2Ceil(NumElts); 6030 if (NumOfParts > 0) 6031 VecScalarsSz = PowerOf2Ceil((NumElts + NumOfParts - 1) / NumOfParts); 6032 unsigned VecSz = 6033 (1 + OffsetEnd / VecScalarsSz - OffsetBeg / VecScalarsSz) * 6034 VecScalarsSz; 6035 unsigned Offset = VecScalarsSz * (OffsetBeg / VecScalarsSz); 6036 unsigned InsertVecSz = std::min<unsigned>( 6037 PowerOf2Ceil(OffsetEnd - OffsetBeg + 1), 6038 ((OffsetEnd - OffsetBeg + VecScalarsSz) / VecScalarsSz) * 6039 VecScalarsSz); 6040 6041 APInt DemandedElts = APInt::getZero(NumElts); 6042 // TODO: Add support for Instruction::InsertValue. 6043 SmallVector<int> Mask; 6044 if (!E->ReorderIndices.empty()) { 6045 inversePermutation(E->ReorderIndices, Mask); 6046 Mask.append(InsertVecSz - Mask.size(), UndefMaskElem); 6047 } else { 6048 Mask.assign(VecSz, UndefMaskElem); 6049 std::iota(Mask.begin(), std::next(Mask.begin(), InsertVecSz), 0); 6050 } 6051 bool IsIdentity = true; 6052 SmallVector<int> PrevMask(InsertVecSz, UndefMaskElem); 6053 Mask.swap(PrevMask); 6054 for (unsigned I = 0; I < NumScalars; ++I) { 6055 unsigned InsertIdx = *getInsertIndex(VL[PrevMask[I]]); 6056 DemandedElts.setBit(InsertIdx); 6057 IsIdentity &= InsertIdx - OffsetBeg == I; 6058 Mask[InsertIdx - OffsetBeg] = I; 6059 } 6060 assert(Offset < NumElts && "Failed to find vector index offset"); 6061 6062 InstructionCost Cost = 0; 6063 Cost -= TTI->getScalarizationOverhead(SrcVecTy, DemandedElts, 6064 /*Insert*/ true, /*Extract*/ false); 6065 6066 // First cost - resize to actual vector size if not identity shuffle or 6067 // need to shift the vector. 6068 // Do not calculate the cost if the actual size is the register size and 6069 // we can merge this shuffle with the following SK_Select. 6070 auto *InsertVecTy = 6071 FixedVectorType::get(SrcVecTy->getElementType(), InsertVecSz); 6072 if (!IsIdentity) 6073 Cost += TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, 6074 InsertVecTy, Mask); 6075 auto *FirstInsert = cast<Instruction>(*find_if(E->Scalars, [E](Value *V) { 6076 return !is_contained(E->Scalars, cast<Instruction>(V)->getOperand(0)); 6077 })); 6078 // Second cost - permutation with subvector, if some elements are from the 6079 // initial vector or inserting a subvector. 6080 // TODO: Implement the analysis of the FirstInsert->getOperand(0) 6081 // subvector of ActualVecTy. 6082 if (!isUndefVector(FirstInsert->getOperand(0)) && NumScalars != NumElts && 6083 (Offset != OffsetBeg || (OffsetEnd + 1) % VecScalarsSz != 0)) { 6084 if (InsertVecSz != VecSz) { 6085 auto *ActualVecTy = 6086 FixedVectorType::get(SrcVecTy->getElementType(), VecSz); 6087 Cost += TTI->getShuffleCost(TTI::SK_InsertSubvector, ActualVecTy, 6088 None, OffsetBeg - Offset, InsertVecTy); 6089 } else { 6090 for (unsigned I = 0, End = OffsetBeg - Offset; I < End; ++I) 6091 Mask[I] = I; 6092 for (unsigned I = OffsetBeg - Offset, End = OffsetEnd - Offset; 6093 I <= End; ++I) 6094 if (Mask[I] != UndefMaskElem) 6095 Mask[I] = I + VecSz; 6096 for (unsigned I = OffsetEnd + 1 - Offset; I < VecSz; ++I) 6097 Mask[I] = I; 6098 Cost += TTI->getShuffleCost(TTI::SK_PermuteTwoSrc, InsertVecTy, Mask); 6099 } 6100 } 6101 return Cost; 6102 } 6103 case Instruction::ZExt: 6104 case Instruction::SExt: 6105 case Instruction::FPToUI: 6106 case Instruction::FPToSI: 6107 case Instruction::FPExt: 6108 case Instruction::PtrToInt: 6109 case Instruction::IntToPtr: 6110 case Instruction::SIToFP: 6111 case Instruction::UIToFP: 6112 case Instruction::Trunc: 6113 case Instruction::FPTrunc: 6114 case Instruction::BitCast: { 6115 Type *SrcTy = VL0->getOperand(0)->getType(); 6116 InstructionCost ScalarEltCost = 6117 TTI->getCastInstrCost(E->getOpcode(), ScalarTy, SrcTy, 6118 TTI::getCastContextHint(VL0), CostKind, VL0); 6119 if (NeedToShuffleReuses) { 6120 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6121 } 6122 6123 // Calculate the cost of this instruction. 6124 InstructionCost ScalarCost = VL.size() * ScalarEltCost; 6125 6126 auto *SrcVecTy = FixedVectorType::get(SrcTy, VL.size()); 6127 InstructionCost VecCost = 0; 6128 // Check if the values are candidates to demote. 6129 if (!MinBWs.count(VL0) || VecTy != SrcVecTy) { 6130 VecCost = CommonCost + TTI->getCastInstrCost( 6131 E->getOpcode(), VecTy, SrcVecTy, 6132 TTI::getCastContextHint(VL0), CostKind, VL0); 6133 } 6134 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6135 return VecCost - ScalarCost; 6136 } 6137 case Instruction::FCmp: 6138 case Instruction::ICmp: 6139 case Instruction::Select: { 6140 // Calculate the cost of this instruction. 6141 InstructionCost ScalarEltCost = 6142 TTI->getCmpSelInstrCost(E->getOpcode(), ScalarTy, Builder.getInt1Ty(), 6143 CmpInst::BAD_ICMP_PREDICATE, CostKind, VL0); 6144 if (NeedToShuffleReuses) { 6145 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6146 } 6147 auto *MaskTy = FixedVectorType::get(Builder.getInt1Ty(), VL.size()); 6148 InstructionCost ScalarCost = VecTy->getNumElements() * ScalarEltCost; 6149 6150 // Check if all entries in VL are either compares or selects with compares 6151 // as condition that have the same predicates. 6152 CmpInst::Predicate VecPred = CmpInst::BAD_ICMP_PREDICATE; 6153 bool First = true; 6154 for (auto *V : VL) { 6155 CmpInst::Predicate CurrentPred; 6156 auto MatchCmp = m_Cmp(CurrentPred, m_Value(), m_Value()); 6157 if ((!match(V, m_Select(MatchCmp, m_Value(), m_Value())) && 6158 !match(V, MatchCmp)) || 6159 (!First && VecPred != CurrentPred)) { 6160 VecPred = CmpInst::BAD_ICMP_PREDICATE; 6161 break; 6162 } 6163 First = false; 6164 VecPred = CurrentPred; 6165 } 6166 6167 InstructionCost VecCost = TTI->getCmpSelInstrCost( 6168 E->getOpcode(), VecTy, MaskTy, VecPred, CostKind, VL0); 6169 // Check if it is possible and profitable to use min/max for selects in 6170 // VL. 6171 // 6172 auto IntrinsicAndUse = canConvertToMinOrMaxIntrinsic(VL); 6173 if (IntrinsicAndUse.first != Intrinsic::not_intrinsic) { 6174 IntrinsicCostAttributes CostAttrs(IntrinsicAndUse.first, VecTy, 6175 {VecTy, VecTy}); 6176 InstructionCost IntrinsicCost = 6177 TTI->getIntrinsicInstrCost(CostAttrs, CostKind); 6178 // If the selects are the only uses of the compares, they will be dead 6179 // and we can adjust the cost by removing their cost. 6180 if (IntrinsicAndUse.second) 6181 IntrinsicCost -= TTI->getCmpSelInstrCost(Instruction::ICmp, VecTy, 6182 MaskTy, VecPred, CostKind); 6183 VecCost = std::min(VecCost, IntrinsicCost); 6184 } 6185 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6186 return CommonCost + VecCost - ScalarCost; 6187 } 6188 case Instruction::FNeg: 6189 case Instruction::Add: 6190 case Instruction::FAdd: 6191 case Instruction::Sub: 6192 case Instruction::FSub: 6193 case Instruction::Mul: 6194 case Instruction::FMul: 6195 case Instruction::UDiv: 6196 case Instruction::SDiv: 6197 case Instruction::FDiv: 6198 case Instruction::URem: 6199 case Instruction::SRem: 6200 case Instruction::FRem: 6201 case Instruction::Shl: 6202 case Instruction::LShr: 6203 case Instruction::AShr: 6204 case Instruction::And: 6205 case Instruction::Or: 6206 case Instruction::Xor: { 6207 // Certain instructions can be cheaper to vectorize if they have a 6208 // constant second vector operand. 6209 TargetTransformInfo::OperandValueKind Op1VK = 6210 TargetTransformInfo::OK_AnyValue; 6211 TargetTransformInfo::OperandValueKind Op2VK = 6212 TargetTransformInfo::OK_UniformConstantValue; 6213 TargetTransformInfo::OperandValueProperties Op1VP = 6214 TargetTransformInfo::OP_None; 6215 TargetTransformInfo::OperandValueProperties Op2VP = 6216 TargetTransformInfo::OP_PowerOf2; 6217 6218 // If all operands are exactly the same ConstantInt then set the 6219 // operand kind to OK_UniformConstantValue. 6220 // If instead not all operands are constants, then set the operand kind 6221 // to OK_AnyValue. If all operands are constants but not the same, 6222 // then set the operand kind to OK_NonUniformConstantValue. 6223 ConstantInt *CInt0 = nullptr; 6224 for (unsigned i = 0, e = VL.size(); i < e; ++i) { 6225 const Instruction *I = cast<Instruction>(VL[i]); 6226 unsigned OpIdx = isa<BinaryOperator>(I) ? 1 : 0; 6227 ConstantInt *CInt = dyn_cast<ConstantInt>(I->getOperand(OpIdx)); 6228 if (!CInt) { 6229 Op2VK = TargetTransformInfo::OK_AnyValue; 6230 Op2VP = TargetTransformInfo::OP_None; 6231 break; 6232 } 6233 if (Op2VP == TargetTransformInfo::OP_PowerOf2 && 6234 !CInt->getValue().isPowerOf2()) 6235 Op2VP = TargetTransformInfo::OP_None; 6236 if (i == 0) { 6237 CInt0 = CInt; 6238 continue; 6239 } 6240 if (CInt0 != CInt) 6241 Op2VK = TargetTransformInfo::OK_NonUniformConstantValue; 6242 } 6243 6244 SmallVector<const Value *, 4> Operands(VL0->operand_values()); 6245 InstructionCost ScalarEltCost = 6246 TTI->getArithmeticInstrCost(E->getOpcode(), ScalarTy, CostKind, Op1VK, 6247 Op2VK, Op1VP, Op2VP, Operands, VL0); 6248 if (NeedToShuffleReuses) { 6249 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6250 } 6251 InstructionCost ScalarCost = VecTy->getNumElements() * ScalarEltCost; 6252 InstructionCost VecCost = 6253 TTI->getArithmeticInstrCost(E->getOpcode(), VecTy, CostKind, Op1VK, 6254 Op2VK, Op1VP, Op2VP, Operands, VL0); 6255 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6256 return CommonCost + VecCost - ScalarCost; 6257 } 6258 case Instruction::GetElementPtr: { 6259 TargetTransformInfo::OperandValueKind Op1VK = 6260 TargetTransformInfo::OK_AnyValue; 6261 TargetTransformInfo::OperandValueKind Op2VK = 6262 TargetTransformInfo::OK_UniformConstantValue; 6263 6264 InstructionCost ScalarEltCost = TTI->getArithmeticInstrCost( 6265 Instruction::Add, ScalarTy, CostKind, Op1VK, Op2VK); 6266 if (NeedToShuffleReuses) { 6267 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6268 } 6269 InstructionCost ScalarCost = VecTy->getNumElements() * ScalarEltCost; 6270 InstructionCost VecCost = TTI->getArithmeticInstrCost( 6271 Instruction::Add, VecTy, CostKind, Op1VK, Op2VK); 6272 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6273 return CommonCost + VecCost - ScalarCost; 6274 } 6275 case Instruction::Load: { 6276 // Cost of wide load - cost of scalar loads. 6277 Align Alignment = cast<LoadInst>(VL0)->getAlign(); 6278 InstructionCost ScalarEltCost = TTI->getMemoryOpCost( 6279 Instruction::Load, ScalarTy, Alignment, 0, CostKind, VL0); 6280 if (NeedToShuffleReuses) { 6281 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6282 } 6283 InstructionCost ScalarLdCost = VecTy->getNumElements() * ScalarEltCost; 6284 InstructionCost VecLdCost; 6285 if (E->State == TreeEntry::Vectorize) { 6286 VecLdCost = TTI->getMemoryOpCost(Instruction::Load, VecTy, Alignment, 0, 6287 CostKind, VL0); 6288 } else { 6289 assert(E->State == TreeEntry::ScatterVectorize && "Unknown EntryState"); 6290 Align CommonAlignment = Alignment; 6291 for (Value *V : VL) 6292 CommonAlignment = 6293 commonAlignment(CommonAlignment, cast<LoadInst>(V)->getAlign()); 6294 VecLdCost = TTI->getGatherScatterOpCost( 6295 Instruction::Load, VecTy, cast<LoadInst>(VL0)->getPointerOperand(), 6296 /*VariableMask=*/false, CommonAlignment, CostKind, VL0); 6297 } 6298 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecLdCost, ScalarLdCost)); 6299 return CommonCost + VecLdCost - ScalarLdCost; 6300 } 6301 case Instruction::Store: { 6302 // We know that we can merge the stores. Calculate the cost. 6303 bool IsReorder = !E->ReorderIndices.empty(); 6304 auto *SI = 6305 cast<StoreInst>(IsReorder ? VL[E->ReorderIndices.front()] : VL0); 6306 Align Alignment = SI->getAlign(); 6307 InstructionCost ScalarEltCost = TTI->getMemoryOpCost( 6308 Instruction::Store, ScalarTy, Alignment, 0, CostKind, VL0); 6309 InstructionCost ScalarStCost = VecTy->getNumElements() * ScalarEltCost; 6310 InstructionCost VecStCost = TTI->getMemoryOpCost( 6311 Instruction::Store, VecTy, Alignment, 0, CostKind, VL0); 6312 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecStCost, ScalarStCost)); 6313 return CommonCost + VecStCost - ScalarStCost; 6314 } 6315 case Instruction::Call: { 6316 CallInst *CI = cast<CallInst>(VL0); 6317 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 6318 6319 // Calculate the cost of the scalar and vector calls. 6320 IntrinsicCostAttributes CostAttrs(ID, *CI, 1); 6321 InstructionCost ScalarEltCost = 6322 TTI->getIntrinsicInstrCost(CostAttrs, CostKind); 6323 if (NeedToShuffleReuses) { 6324 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6325 } 6326 InstructionCost ScalarCallCost = VecTy->getNumElements() * ScalarEltCost; 6327 6328 auto VecCallCosts = getVectorCallCosts(CI, VecTy, TTI, TLI); 6329 InstructionCost VecCallCost = 6330 std::min(VecCallCosts.first, VecCallCosts.second); 6331 6332 LLVM_DEBUG(dbgs() << "SLP: Call cost " << VecCallCost - ScalarCallCost 6333 << " (" << VecCallCost << "-" << ScalarCallCost << ")" 6334 << " for " << *CI << "\n"); 6335 6336 return CommonCost + VecCallCost - ScalarCallCost; 6337 } 6338 case Instruction::ShuffleVector: { 6339 assert(E->isAltShuffle() && 6340 ((Instruction::isBinaryOp(E->getOpcode()) && 6341 Instruction::isBinaryOp(E->getAltOpcode())) || 6342 (Instruction::isCast(E->getOpcode()) && 6343 Instruction::isCast(E->getAltOpcode())) || 6344 (isa<CmpInst>(VL0) && isa<CmpInst>(E->getAltOp()))) && 6345 "Invalid Shuffle Vector Operand"); 6346 InstructionCost ScalarCost = 0; 6347 if (NeedToShuffleReuses) { 6348 for (unsigned Idx : E->ReuseShuffleIndices) { 6349 Instruction *I = cast<Instruction>(VL[Idx]); 6350 CommonCost -= TTI->getInstructionCost(I, CostKind); 6351 } 6352 for (Value *V : VL) { 6353 Instruction *I = cast<Instruction>(V); 6354 CommonCost += TTI->getInstructionCost(I, CostKind); 6355 } 6356 } 6357 for (Value *V : VL) { 6358 Instruction *I = cast<Instruction>(V); 6359 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 6360 ScalarCost += TTI->getInstructionCost(I, CostKind); 6361 } 6362 // VecCost is equal to sum of the cost of creating 2 vectors 6363 // and the cost of creating shuffle. 6364 InstructionCost VecCost = 0; 6365 // Try to find the previous shuffle node with the same operands and same 6366 // main/alternate ops. 6367 auto &&TryFindNodeWithEqualOperands = [this, E]() { 6368 for (const std::unique_ptr<TreeEntry> &TE : VectorizableTree) { 6369 if (TE.get() == E) 6370 break; 6371 if (TE->isAltShuffle() && 6372 ((TE->getOpcode() == E->getOpcode() && 6373 TE->getAltOpcode() == E->getAltOpcode()) || 6374 (TE->getOpcode() == E->getAltOpcode() && 6375 TE->getAltOpcode() == E->getOpcode())) && 6376 TE->hasEqualOperands(*E)) 6377 return true; 6378 } 6379 return false; 6380 }; 6381 if (TryFindNodeWithEqualOperands()) { 6382 LLVM_DEBUG({ 6383 dbgs() << "SLP: diamond match for alternate node found.\n"; 6384 E->dump(); 6385 }); 6386 // No need to add new vector costs here since we're going to reuse 6387 // same main/alternate vector ops, just do different shuffling. 6388 } else if (Instruction::isBinaryOp(E->getOpcode())) { 6389 VecCost = TTI->getArithmeticInstrCost(E->getOpcode(), VecTy, CostKind); 6390 VecCost += TTI->getArithmeticInstrCost(E->getAltOpcode(), VecTy, 6391 CostKind); 6392 } else if (auto *CI0 = dyn_cast<CmpInst>(VL0)) { 6393 VecCost = TTI->getCmpSelInstrCost(E->getOpcode(), ScalarTy, 6394 Builder.getInt1Ty(), 6395 CI0->getPredicate(), CostKind, VL0); 6396 VecCost += TTI->getCmpSelInstrCost( 6397 E->getOpcode(), ScalarTy, Builder.getInt1Ty(), 6398 cast<CmpInst>(E->getAltOp())->getPredicate(), CostKind, 6399 E->getAltOp()); 6400 } else { 6401 Type *Src0SclTy = E->getMainOp()->getOperand(0)->getType(); 6402 Type *Src1SclTy = E->getAltOp()->getOperand(0)->getType(); 6403 auto *Src0Ty = FixedVectorType::get(Src0SclTy, VL.size()); 6404 auto *Src1Ty = FixedVectorType::get(Src1SclTy, VL.size()); 6405 VecCost = TTI->getCastInstrCost(E->getOpcode(), VecTy, Src0Ty, 6406 TTI::CastContextHint::None, CostKind); 6407 VecCost += TTI->getCastInstrCost(E->getAltOpcode(), VecTy, Src1Ty, 6408 TTI::CastContextHint::None, CostKind); 6409 } 6410 6411 if (E->ReuseShuffleIndices.empty()) { 6412 CommonCost = 6413 TTI->getShuffleCost(TargetTransformInfo::SK_Select, FinalVecTy); 6414 } else { 6415 SmallVector<int> Mask; 6416 buildShuffleEntryMask( 6417 E->Scalars, E->ReorderIndices, E->ReuseShuffleIndices, 6418 [E](Instruction *I) { 6419 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 6420 return I->getOpcode() == E->getAltOpcode(); 6421 }, 6422 Mask); 6423 CommonCost = TTI->getShuffleCost(TargetTransformInfo::SK_PermuteTwoSrc, 6424 FinalVecTy, Mask); 6425 } 6426 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6427 return CommonCost + VecCost - ScalarCost; 6428 } 6429 default: 6430 llvm_unreachable("Unknown instruction"); 6431 } 6432 } 6433 6434 bool BoUpSLP::isFullyVectorizableTinyTree(bool ForReduction) const { 6435 LLVM_DEBUG(dbgs() << "SLP: Check whether the tree with height " 6436 << VectorizableTree.size() << " is fully vectorizable .\n"); 6437 6438 auto &&AreVectorizableGathers = [this](const TreeEntry *TE, unsigned Limit) { 6439 SmallVector<int> Mask; 6440 return TE->State == TreeEntry::NeedToGather && 6441 !any_of(TE->Scalars, 6442 [this](Value *V) { return EphValues.contains(V); }) && 6443 (allConstant(TE->Scalars) || isSplat(TE->Scalars) || 6444 TE->Scalars.size() < Limit || 6445 ((TE->getOpcode() == Instruction::ExtractElement || 6446 all_of(TE->Scalars, 6447 [](Value *V) { 6448 return isa<ExtractElementInst, UndefValue>(V); 6449 })) && 6450 isFixedVectorShuffle(TE->Scalars, Mask)) || 6451 (TE->State == TreeEntry::NeedToGather && 6452 TE->getOpcode() == Instruction::Load && !TE->isAltShuffle())); 6453 }; 6454 6455 // We only handle trees of heights 1 and 2. 6456 if (VectorizableTree.size() == 1 && 6457 (VectorizableTree[0]->State == TreeEntry::Vectorize || 6458 (ForReduction && 6459 AreVectorizableGathers(VectorizableTree[0].get(), 6460 VectorizableTree[0]->Scalars.size()) && 6461 VectorizableTree[0]->getVectorFactor() > 2))) 6462 return true; 6463 6464 if (VectorizableTree.size() != 2) 6465 return false; 6466 6467 // Handle splat and all-constants stores. Also try to vectorize tiny trees 6468 // with the second gather nodes if they have less scalar operands rather than 6469 // the initial tree element (may be profitable to shuffle the second gather) 6470 // or they are extractelements, which form shuffle. 6471 SmallVector<int> Mask; 6472 if (VectorizableTree[0]->State == TreeEntry::Vectorize && 6473 AreVectorizableGathers(VectorizableTree[1].get(), 6474 VectorizableTree[0]->Scalars.size())) 6475 return true; 6476 6477 // Gathering cost would be too much for tiny trees. 6478 if (VectorizableTree[0]->State == TreeEntry::NeedToGather || 6479 (VectorizableTree[1]->State == TreeEntry::NeedToGather && 6480 VectorizableTree[0]->State != TreeEntry::ScatterVectorize)) 6481 return false; 6482 6483 return true; 6484 } 6485 6486 static bool isLoadCombineCandidateImpl(Value *Root, unsigned NumElts, 6487 TargetTransformInfo *TTI, 6488 bool MustMatchOrInst) { 6489 // Look past the root to find a source value. Arbitrarily follow the 6490 // path through operand 0 of any 'or'. Also, peek through optional 6491 // shift-left-by-multiple-of-8-bits. 6492 Value *ZextLoad = Root; 6493 const APInt *ShAmtC; 6494 bool FoundOr = false; 6495 while (!isa<ConstantExpr>(ZextLoad) && 6496 (match(ZextLoad, m_Or(m_Value(), m_Value())) || 6497 (match(ZextLoad, m_Shl(m_Value(), m_APInt(ShAmtC))) && 6498 ShAmtC->urem(8) == 0))) { 6499 auto *BinOp = cast<BinaryOperator>(ZextLoad); 6500 ZextLoad = BinOp->getOperand(0); 6501 if (BinOp->getOpcode() == Instruction::Or) 6502 FoundOr = true; 6503 } 6504 // Check if the input is an extended load of the required or/shift expression. 6505 Value *Load; 6506 if ((MustMatchOrInst && !FoundOr) || ZextLoad == Root || 6507 !match(ZextLoad, m_ZExt(m_Value(Load))) || !isa<LoadInst>(Load)) 6508 return false; 6509 6510 // Require that the total load bit width is a legal integer type. 6511 // For example, <8 x i8> --> i64 is a legal integer on a 64-bit target. 6512 // But <16 x i8> --> i128 is not, so the backend probably can't reduce it. 6513 Type *SrcTy = Load->getType(); 6514 unsigned LoadBitWidth = SrcTy->getIntegerBitWidth() * NumElts; 6515 if (!TTI->isTypeLegal(IntegerType::get(Root->getContext(), LoadBitWidth))) 6516 return false; 6517 6518 // Everything matched - assume that we can fold the whole sequence using 6519 // load combining. 6520 LLVM_DEBUG(dbgs() << "SLP: Assume load combining for tree starting at " 6521 << *(cast<Instruction>(Root)) << "\n"); 6522 6523 return true; 6524 } 6525 6526 bool BoUpSLP::isLoadCombineReductionCandidate(RecurKind RdxKind) const { 6527 if (RdxKind != RecurKind::Or) 6528 return false; 6529 6530 unsigned NumElts = VectorizableTree[0]->Scalars.size(); 6531 Value *FirstReduced = VectorizableTree[0]->Scalars[0]; 6532 return isLoadCombineCandidateImpl(FirstReduced, NumElts, TTI, 6533 /* MatchOr */ false); 6534 } 6535 6536 bool BoUpSLP::isLoadCombineCandidate() const { 6537 // Peek through a final sequence of stores and check if all operations are 6538 // likely to be load-combined. 6539 unsigned NumElts = VectorizableTree[0]->Scalars.size(); 6540 for (Value *Scalar : VectorizableTree[0]->Scalars) { 6541 Value *X; 6542 if (!match(Scalar, m_Store(m_Value(X), m_Value())) || 6543 !isLoadCombineCandidateImpl(X, NumElts, TTI, /* MatchOr */ true)) 6544 return false; 6545 } 6546 return true; 6547 } 6548 6549 bool BoUpSLP::isTreeTinyAndNotFullyVectorizable(bool ForReduction) const { 6550 // No need to vectorize inserts of gathered values. 6551 if (VectorizableTree.size() == 2 && 6552 isa<InsertElementInst>(VectorizableTree[0]->Scalars[0]) && 6553 VectorizableTree[1]->State == TreeEntry::NeedToGather && 6554 (VectorizableTree[1]->getVectorFactor() <= 2 || 6555 !(isSplat(VectorizableTree[1]->Scalars) || 6556 allConstant(VectorizableTree[1]->Scalars)))) 6557 return true; 6558 6559 // We can vectorize the tree if its size is greater than or equal to the 6560 // minimum size specified by the MinTreeSize command line option. 6561 if (VectorizableTree.size() >= MinTreeSize) 6562 return false; 6563 6564 // If we have a tiny tree (a tree whose size is less than MinTreeSize), we 6565 // can vectorize it if we can prove it fully vectorizable. 6566 if (isFullyVectorizableTinyTree(ForReduction)) 6567 return false; 6568 6569 assert(VectorizableTree.empty() 6570 ? ExternalUses.empty() 6571 : true && "We shouldn't have any external users"); 6572 6573 // Otherwise, we can't vectorize the tree. It is both tiny and not fully 6574 // vectorizable. 6575 return true; 6576 } 6577 6578 InstructionCost BoUpSLP::getSpillCost() const { 6579 // Walk from the bottom of the tree to the top, tracking which values are 6580 // live. When we see a call instruction that is not part of our tree, 6581 // query TTI to see if there is a cost to keeping values live over it 6582 // (for example, if spills and fills are required). 6583 unsigned BundleWidth = VectorizableTree.front()->Scalars.size(); 6584 InstructionCost Cost = 0; 6585 6586 SmallPtrSet<Instruction*, 4> LiveValues; 6587 Instruction *PrevInst = nullptr; 6588 6589 // The entries in VectorizableTree are not necessarily ordered by their 6590 // position in basic blocks. Collect them and order them by dominance so later 6591 // instructions are guaranteed to be visited first. For instructions in 6592 // different basic blocks, we only scan to the beginning of the block, so 6593 // their order does not matter, as long as all instructions in a basic block 6594 // are grouped together. Using dominance ensures a deterministic order. 6595 SmallVector<Instruction *, 16> OrderedScalars; 6596 for (const auto &TEPtr : VectorizableTree) { 6597 Instruction *Inst = dyn_cast<Instruction>(TEPtr->Scalars[0]); 6598 if (!Inst) 6599 continue; 6600 OrderedScalars.push_back(Inst); 6601 } 6602 llvm::sort(OrderedScalars, [&](Instruction *A, Instruction *B) { 6603 auto *NodeA = DT->getNode(A->getParent()); 6604 auto *NodeB = DT->getNode(B->getParent()); 6605 assert(NodeA && "Should only process reachable instructions"); 6606 assert(NodeB && "Should only process reachable instructions"); 6607 assert((NodeA == NodeB) == (NodeA->getDFSNumIn() == NodeB->getDFSNumIn()) && 6608 "Different nodes should have different DFS numbers"); 6609 if (NodeA != NodeB) 6610 return NodeA->getDFSNumIn() < NodeB->getDFSNumIn(); 6611 return B->comesBefore(A); 6612 }); 6613 6614 for (Instruction *Inst : OrderedScalars) { 6615 if (!PrevInst) { 6616 PrevInst = Inst; 6617 continue; 6618 } 6619 6620 // Update LiveValues. 6621 LiveValues.erase(PrevInst); 6622 for (auto &J : PrevInst->operands()) { 6623 if (isa<Instruction>(&*J) && getTreeEntry(&*J)) 6624 LiveValues.insert(cast<Instruction>(&*J)); 6625 } 6626 6627 LLVM_DEBUG({ 6628 dbgs() << "SLP: #LV: " << LiveValues.size(); 6629 for (auto *X : LiveValues) 6630 dbgs() << " " << X->getName(); 6631 dbgs() << ", Looking at "; 6632 Inst->dump(); 6633 }); 6634 6635 // Now find the sequence of instructions between PrevInst and Inst. 6636 unsigned NumCalls = 0; 6637 BasicBlock::reverse_iterator InstIt = ++Inst->getIterator().getReverse(), 6638 PrevInstIt = 6639 PrevInst->getIterator().getReverse(); 6640 while (InstIt != PrevInstIt) { 6641 if (PrevInstIt == PrevInst->getParent()->rend()) { 6642 PrevInstIt = Inst->getParent()->rbegin(); 6643 continue; 6644 } 6645 6646 // Debug information does not impact spill cost. 6647 if ((isa<CallInst>(&*PrevInstIt) && 6648 !isa<DbgInfoIntrinsic>(&*PrevInstIt)) && 6649 &*PrevInstIt != PrevInst) 6650 NumCalls++; 6651 6652 ++PrevInstIt; 6653 } 6654 6655 if (NumCalls) { 6656 SmallVector<Type*, 4> V; 6657 for (auto *II : LiveValues) { 6658 auto *ScalarTy = II->getType(); 6659 if (auto *VectorTy = dyn_cast<FixedVectorType>(ScalarTy)) 6660 ScalarTy = VectorTy->getElementType(); 6661 V.push_back(FixedVectorType::get(ScalarTy, BundleWidth)); 6662 } 6663 Cost += NumCalls * TTI->getCostOfKeepingLiveOverCall(V); 6664 } 6665 6666 PrevInst = Inst; 6667 } 6668 6669 return Cost; 6670 } 6671 6672 /// Check if two insertelement instructions are from the same buildvector. 6673 static bool areTwoInsertFromSameBuildVector(InsertElementInst *VU, 6674 InsertElementInst *V) { 6675 // Instructions must be from the same basic blocks. 6676 if (VU->getParent() != V->getParent()) 6677 return false; 6678 // Checks if 2 insertelements are from the same buildvector. 6679 if (VU->getType() != V->getType()) 6680 return false; 6681 // Multiple used inserts are separate nodes. 6682 if (!VU->hasOneUse() && !V->hasOneUse()) 6683 return false; 6684 auto *IE1 = VU; 6685 auto *IE2 = V; 6686 unsigned Idx1 = *getInsertIndex(IE1); 6687 unsigned Idx2 = *getInsertIndex(IE2); 6688 // Go through the vector operand of insertelement instructions trying to find 6689 // either VU as the original vector for IE2 or V as the original vector for 6690 // IE1. 6691 do { 6692 if (IE2 == VU) 6693 return VU->hasOneUse(); 6694 if (IE1 == V) 6695 return V->hasOneUse(); 6696 if (IE1) { 6697 if ((IE1 != VU && !IE1->hasOneUse()) || 6698 getInsertIndex(IE1).getValueOr(Idx2) == Idx2) 6699 IE1 = nullptr; 6700 else 6701 IE1 = dyn_cast<InsertElementInst>(IE1->getOperand(0)); 6702 } 6703 if (IE2) { 6704 if ((IE2 != V && !IE2->hasOneUse()) || 6705 getInsertIndex(IE2).getValueOr(Idx1) == Idx1) 6706 IE2 = nullptr; 6707 else 6708 IE2 = dyn_cast<InsertElementInst>(IE2->getOperand(0)); 6709 } 6710 } while (IE1 || IE2); 6711 return false; 6712 } 6713 6714 /// Checks if the \p IE1 instructions is followed by \p IE2 instruction in the 6715 /// buildvector sequence. 6716 static bool isFirstInsertElement(const InsertElementInst *IE1, 6717 const InsertElementInst *IE2) { 6718 if (IE1 == IE2) 6719 return false; 6720 const auto *I1 = IE1; 6721 const auto *I2 = IE2; 6722 const InsertElementInst *PrevI1; 6723 const InsertElementInst *PrevI2; 6724 unsigned Idx1 = *getInsertIndex(IE1); 6725 unsigned Idx2 = *getInsertIndex(IE2); 6726 do { 6727 if (I2 == IE1) 6728 return true; 6729 if (I1 == IE2) 6730 return false; 6731 PrevI1 = I1; 6732 PrevI2 = I2; 6733 if (I1 && (I1 == IE1 || I1->hasOneUse()) && 6734 getInsertIndex(I1).getValueOr(Idx2) != Idx2) 6735 I1 = dyn_cast<InsertElementInst>(I1->getOperand(0)); 6736 if (I2 && ((I2 == IE2 || I2->hasOneUse())) && 6737 getInsertIndex(I2).getValueOr(Idx1) != Idx1) 6738 I2 = dyn_cast<InsertElementInst>(I2->getOperand(0)); 6739 } while ((I1 && PrevI1 != I1) || (I2 && PrevI2 != I2)); 6740 llvm_unreachable("Two different buildvectors not expected."); 6741 } 6742 6743 namespace { 6744 /// Returns incoming Value *, if the requested type is Value * too, or a default 6745 /// value, otherwise. 6746 struct ValueSelect { 6747 template <typename U> 6748 static typename std::enable_if<std::is_same<Value *, U>::value, Value *>::type 6749 get(Value *V) { 6750 return V; 6751 } 6752 template <typename U> 6753 static typename std::enable_if<!std::is_same<Value *, U>::value, U>::type 6754 get(Value *) { 6755 return U(); 6756 } 6757 }; 6758 } // namespace 6759 6760 /// Does the analysis of the provided shuffle masks and performs the requested 6761 /// actions on the vectors with the given shuffle masks. It tries to do it in 6762 /// several steps. 6763 /// 1. If the Base vector is not undef vector, resizing the very first mask to 6764 /// have common VF and perform action for 2 input vectors (including non-undef 6765 /// Base). Other shuffle masks are combined with the resulting after the 1 stage 6766 /// and processed as a shuffle of 2 elements. 6767 /// 2. If the Base is undef vector and have only 1 shuffle mask, perform the 6768 /// action only for 1 vector with the given mask, if it is not the identity 6769 /// mask. 6770 /// 3. If > 2 masks are used, perform the remaining shuffle actions for 2 6771 /// vectors, combing the masks properly between the steps. 6772 template <typename T> 6773 static T *performExtractsShuffleAction( 6774 MutableArrayRef<std::pair<T *, SmallVector<int>>> ShuffleMask, Value *Base, 6775 function_ref<unsigned(T *)> GetVF, 6776 function_ref<std::pair<T *, bool>(T *, ArrayRef<int>)> ResizeAction, 6777 function_ref<T *(ArrayRef<int>, ArrayRef<T *>)> Action) { 6778 assert(!ShuffleMask.empty() && "Empty list of shuffles for inserts."); 6779 SmallVector<int> Mask(ShuffleMask.begin()->second); 6780 auto VMIt = std::next(ShuffleMask.begin()); 6781 T *Prev = nullptr; 6782 bool IsBaseNotUndef = !isUndefVector(Base); 6783 if (IsBaseNotUndef) { 6784 // Base is not undef, need to combine it with the next subvectors. 6785 std::pair<T *, bool> Res = ResizeAction(ShuffleMask.begin()->first, Mask); 6786 for (unsigned Idx = 0, VF = Mask.size(); Idx < VF; ++Idx) { 6787 if (Mask[Idx] == UndefMaskElem) 6788 Mask[Idx] = Idx; 6789 else 6790 Mask[Idx] = (Res.second ? Idx : Mask[Idx]) + VF; 6791 } 6792 auto *V = ValueSelect::get<T *>(Base); 6793 (void)V; 6794 assert((!V || GetVF(V) == Mask.size()) && 6795 "Expected base vector of VF number of elements."); 6796 Prev = Action(Mask, {nullptr, Res.first}); 6797 } else if (ShuffleMask.size() == 1) { 6798 // Base is undef and only 1 vector is shuffled - perform the action only for 6799 // single vector, if the mask is not the identity mask. 6800 std::pair<T *, bool> Res = ResizeAction(ShuffleMask.begin()->first, Mask); 6801 if (Res.second) 6802 // Identity mask is found. 6803 Prev = Res.first; 6804 else 6805 Prev = Action(Mask, {ShuffleMask.begin()->first}); 6806 } else { 6807 // Base is undef and at least 2 input vectors shuffled - perform 2 vectors 6808 // shuffles step by step, combining shuffle between the steps. 6809 unsigned Vec1VF = GetVF(ShuffleMask.begin()->first); 6810 unsigned Vec2VF = GetVF(VMIt->first); 6811 if (Vec1VF == Vec2VF) { 6812 // No need to resize the input vectors since they are of the same size, we 6813 // can shuffle them directly. 6814 ArrayRef<int> SecMask = VMIt->second; 6815 for (unsigned I = 0, VF = Mask.size(); I < VF; ++I) { 6816 if (SecMask[I] != UndefMaskElem) { 6817 assert(Mask[I] == UndefMaskElem && "Multiple uses of scalars."); 6818 Mask[I] = SecMask[I] + Vec1VF; 6819 } 6820 } 6821 Prev = Action(Mask, {ShuffleMask.begin()->first, VMIt->first}); 6822 } else { 6823 // Vectors of different sizes - resize and reshuffle. 6824 std::pair<T *, bool> Res1 = 6825 ResizeAction(ShuffleMask.begin()->first, Mask); 6826 std::pair<T *, bool> Res2 = ResizeAction(VMIt->first, VMIt->second); 6827 ArrayRef<int> SecMask = VMIt->second; 6828 for (unsigned I = 0, VF = Mask.size(); I < VF; ++I) { 6829 if (Mask[I] != UndefMaskElem) { 6830 assert(SecMask[I] == UndefMaskElem && "Multiple uses of scalars."); 6831 if (Res1.second) 6832 Mask[I] = I; 6833 } else if (SecMask[I] != UndefMaskElem) { 6834 assert(Mask[I] == UndefMaskElem && "Multiple uses of scalars."); 6835 Mask[I] = (Res2.second ? I : SecMask[I]) + VF; 6836 } 6837 } 6838 Prev = Action(Mask, {Res1.first, Res2.first}); 6839 } 6840 VMIt = std::next(VMIt); 6841 } 6842 // Perform requested actions for the remaining masks/vectors. 6843 for (auto E = ShuffleMask.end(); VMIt != E; ++VMIt) { 6844 // Shuffle other input vectors, if any. 6845 std::pair<T *, bool> Res = ResizeAction(VMIt->first, VMIt->second); 6846 ArrayRef<int> SecMask = VMIt->second; 6847 for (unsigned I = 0, VF = Mask.size(); I < VF; ++I) { 6848 if (SecMask[I] != UndefMaskElem) { 6849 assert((Mask[I] == UndefMaskElem || IsBaseNotUndef) && 6850 "Multiple uses of scalars."); 6851 Mask[I] = (Res.second ? I : SecMask[I]) + VF; 6852 } else if (Mask[I] != UndefMaskElem) { 6853 Mask[I] = I; 6854 } 6855 } 6856 Prev = Action(Mask, {Prev, Res.first}); 6857 } 6858 return Prev; 6859 } 6860 6861 InstructionCost BoUpSLP::getTreeCost(ArrayRef<Value *> VectorizedVals) { 6862 InstructionCost Cost = 0; 6863 LLVM_DEBUG(dbgs() << "SLP: Calculating cost for tree of size " 6864 << VectorizableTree.size() << ".\n"); 6865 6866 unsigned BundleWidth = VectorizableTree[0]->Scalars.size(); 6867 6868 for (unsigned I = 0, E = VectorizableTree.size(); I < E; ++I) { 6869 TreeEntry &TE = *VectorizableTree[I]; 6870 6871 InstructionCost C = getEntryCost(&TE, VectorizedVals); 6872 Cost += C; 6873 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 6874 << " for bundle that starts with " << *TE.Scalars[0] 6875 << ".\n" 6876 << "SLP: Current total cost = " << Cost << "\n"); 6877 } 6878 6879 SmallPtrSet<Value *, 16> ExtractCostCalculated; 6880 InstructionCost ExtractCost = 0; 6881 SmallVector<MapVector<const TreeEntry *, SmallVector<int>>> ShuffleMasks; 6882 SmallVector<std::pair<Value *, const TreeEntry *>> FirstUsers; 6883 SmallVector<APInt> DemandedElts; 6884 for (ExternalUser &EU : ExternalUses) { 6885 // We only add extract cost once for the same scalar. 6886 if (!isa_and_nonnull<InsertElementInst>(EU.User) && 6887 !ExtractCostCalculated.insert(EU.Scalar).second) 6888 continue; 6889 6890 // Uses by ephemeral values are free (because the ephemeral value will be 6891 // removed prior to code generation, and so the extraction will be 6892 // removed as well). 6893 if (EphValues.count(EU.User)) 6894 continue; 6895 6896 // No extract cost for vector "scalar" 6897 if (isa<FixedVectorType>(EU.Scalar->getType())) 6898 continue; 6899 6900 // Already counted the cost for external uses when tried to adjust the cost 6901 // for extractelements, no need to add it again. 6902 if (isa<ExtractElementInst>(EU.Scalar)) 6903 continue; 6904 6905 // If found user is an insertelement, do not calculate extract cost but try 6906 // to detect it as a final shuffled/identity match. 6907 if (auto *VU = dyn_cast_or_null<InsertElementInst>(EU.User)) { 6908 if (auto *FTy = dyn_cast<FixedVectorType>(VU->getType())) { 6909 Optional<unsigned> InsertIdx = getInsertIndex(VU); 6910 if (InsertIdx) { 6911 const TreeEntry *ScalarTE = getTreeEntry(EU.Scalar); 6912 auto *It = 6913 find_if(FirstUsers, 6914 [VU](const std::pair<Value *, const TreeEntry *> &Pair) { 6915 return areTwoInsertFromSameBuildVector( 6916 VU, cast<InsertElementInst>(Pair.first)); 6917 }); 6918 int VecId = -1; 6919 if (It == FirstUsers.end()) { 6920 (void)ShuffleMasks.emplace_back(); 6921 SmallVectorImpl<int> &Mask = ShuffleMasks.back()[ScalarTE]; 6922 if (Mask.empty()) 6923 Mask.assign(FTy->getNumElements(), UndefMaskElem); 6924 // Find the insertvector, vectorized in tree, if any. 6925 Value *Base = VU; 6926 while (auto *IEBase = dyn_cast<InsertElementInst>(Base)) { 6927 if (IEBase != EU.User && 6928 (!IEBase->hasOneUse() || 6929 getInsertIndex(IEBase).getValueOr(*InsertIdx) == *InsertIdx)) 6930 break; 6931 // Build the mask for the vectorized insertelement instructions. 6932 if (const TreeEntry *E = getTreeEntry(IEBase)) { 6933 VU = IEBase; 6934 do { 6935 IEBase = cast<InsertElementInst>(Base); 6936 int Idx = *getInsertIndex(IEBase); 6937 assert(Mask[Idx] == UndefMaskElem && 6938 "InsertElementInstruction used already."); 6939 Mask[Idx] = Idx; 6940 Base = IEBase->getOperand(0); 6941 } while (E == getTreeEntry(Base)); 6942 break; 6943 } 6944 Base = cast<InsertElementInst>(Base)->getOperand(0); 6945 } 6946 FirstUsers.emplace_back(VU, ScalarTE); 6947 DemandedElts.push_back(APInt::getZero(FTy->getNumElements())); 6948 VecId = FirstUsers.size() - 1; 6949 } else { 6950 if (isFirstInsertElement(VU, cast<InsertElementInst>(It->first))) 6951 It->first = VU; 6952 VecId = std::distance(FirstUsers.begin(), It); 6953 } 6954 int InIdx = *InsertIdx; 6955 SmallVectorImpl<int> &Mask = ShuffleMasks[VecId][ScalarTE]; 6956 if (Mask.empty()) 6957 Mask.assign(FTy->getNumElements(), UndefMaskElem); 6958 Mask[InIdx] = EU.Lane; 6959 DemandedElts[VecId].setBit(InIdx); 6960 continue; 6961 } 6962 } 6963 } 6964 6965 // If we plan to rewrite the tree in a smaller type, we will need to sign 6966 // extend the extracted value back to the original type. Here, we account 6967 // for the extract and the added cost of the sign extend if needed. 6968 auto *VecTy = FixedVectorType::get(EU.Scalar->getType(), BundleWidth); 6969 auto *ScalarRoot = VectorizableTree[0]->Scalars[0]; 6970 if (MinBWs.count(ScalarRoot)) { 6971 auto *MinTy = IntegerType::get(F->getContext(), MinBWs[ScalarRoot].first); 6972 auto Extend = 6973 MinBWs[ScalarRoot].second ? Instruction::SExt : Instruction::ZExt; 6974 VecTy = FixedVectorType::get(MinTy, BundleWidth); 6975 ExtractCost += TTI->getExtractWithExtendCost(Extend, EU.Scalar->getType(), 6976 VecTy, EU.Lane); 6977 } else { 6978 ExtractCost += 6979 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, EU.Lane); 6980 } 6981 } 6982 6983 InstructionCost SpillCost = getSpillCost(); 6984 Cost += SpillCost + ExtractCost; 6985 auto &&ResizeToVF = [this, &Cost](const TreeEntry *TE, ArrayRef<int> Mask) { 6986 InstructionCost C = 0; 6987 unsigned VF = Mask.size(); 6988 unsigned VecVF = TE->getVectorFactor(); 6989 if (VF != VecVF && 6990 (any_of(Mask, [VF](int Idx) { return Idx >= static_cast<int>(VF); }) || 6991 (all_of(Mask, 6992 [VF](int Idx) { return Idx < 2 * static_cast<int>(VF); }) && 6993 !ShuffleVectorInst::isIdentityMask(Mask)))) { 6994 SmallVector<int> OrigMask(VecVF, UndefMaskElem); 6995 std::copy(Mask.begin(), std::next(Mask.begin(), std::min(VF, VecVF)), 6996 OrigMask.begin()); 6997 C = TTI->getShuffleCost( 6998 TTI::SK_PermuteSingleSrc, 6999 FixedVectorType::get(TE->getMainOp()->getType(), VecVF), OrigMask); 7000 LLVM_DEBUG( 7001 dbgs() << "SLP: Adding cost " << C 7002 << " for final shuffle of insertelement external users.\n"; 7003 TE->dump(); dbgs() << "SLP: Current total cost = " << Cost << "\n"); 7004 Cost += C; 7005 return std::make_pair(TE, true); 7006 } 7007 return std::make_pair(TE, false); 7008 }; 7009 // Calculate the cost of the reshuffled vectors, if any. 7010 for (int I = 0, E = FirstUsers.size(); I < E; ++I) { 7011 Value *Base = cast<Instruction>(FirstUsers[I].first)->getOperand(0); 7012 unsigned VF = ShuffleMasks[I].begin()->second.size(); 7013 auto *FTy = FixedVectorType::get( 7014 cast<VectorType>(FirstUsers[I].first->getType())->getElementType(), VF); 7015 auto Vector = ShuffleMasks[I].takeVector(); 7016 auto &&EstimateShufflesCost = [this, FTy, 7017 &Cost](ArrayRef<int> Mask, 7018 ArrayRef<const TreeEntry *> TEs) { 7019 assert((TEs.size() == 1 || TEs.size() == 2) && 7020 "Expected exactly 1 or 2 tree entries."); 7021 if (TEs.size() == 1) { 7022 int Limit = 2 * Mask.size(); 7023 if (!all_of(Mask, [Limit](int Idx) { return Idx < Limit; }) || 7024 !ShuffleVectorInst::isIdentityMask(Mask)) { 7025 InstructionCost C = 7026 TTI->getShuffleCost(TTI::SK_PermuteSingleSrc, FTy, Mask); 7027 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 7028 << " for final shuffle of insertelement " 7029 "external users.\n"; 7030 TEs.front()->dump(); 7031 dbgs() << "SLP: Current total cost = " << Cost << "\n"); 7032 Cost += C; 7033 } 7034 } else { 7035 InstructionCost C = 7036 TTI->getShuffleCost(TTI::SK_PermuteTwoSrc, FTy, Mask); 7037 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 7038 << " for final shuffle of vector node and external " 7039 "insertelement users.\n"; 7040 if (TEs.front()) { TEs.front()->dump(); } TEs.back()->dump(); 7041 dbgs() << "SLP: Current total cost = " << Cost << "\n"); 7042 Cost += C; 7043 } 7044 return TEs.back(); 7045 }; 7046 (void)performExtractsShuffleAction<const TreeEntry>( 7047 makeMutableArrayRef(Vector.data(), Vector.size()), Base, 7048 [](const TreeEntry *E) { return E->getVectorFactor(); }, ResizeToVF, 7049 EstimateShufflesCost); 7050 InstructionCost InsertCost = TTI->getScalarizationOverhead( 7051 cast<FixedVectorType>(FirstUsers[I].first->getType()), DemandedElts[I], 7052 /*Insert*/ true, /*Extract*/ false); 7053 Cost -= InsertCost; 7054 } 7055 7056 #ifndef NDEBUG 7057 SmallString<256> Str; 7058 { 7059 raw_svector_ostream OS(Str); 7060 OS << "SLP: Spill Cost = " << SpillCost << ".\n" 7061 << "SLP: Extract Cost = " << ExtractCost << ".\n" 7062 << "SLP: Total Cost = " << Cost << ".\n"; 7063 } 7064 LLVM_DEBUG(dbgs() << Str); 7065 if (ViewSLPTree) 7066 ViewGraph(this, "SLP" + F->getName(), false, Str); 7067 #endif 7068 7069 return Cost; 7070 } 7071 7072 Optional<TargetTransformInfo::ShuffleKind> 7073 BoUpSLP::isGatherShuffledEntry(const TreeEntry *TE, SmallVectorImpl<int> &Mask, 7074 SmallVectorImpl<const TreeEntry *> &Entries) { 7075 // TODO: currently checking only for Scalars in the tree entry, need to count 7076 // reused elements too for better cost estimation. 7077 Mask.assign(TE->Scalars.size(), UndefMaskElem); 7078 Entries.clear(); 7079 // Build a lists of values to tree entries. 7080 DenseMap<Value *, SmallPtrSet<const TreeEntry *, 4>> ValueToTEs; 7081 for (const std::unique_ptr<TreeEntry> &EntryPtr : VectorizableTree) { 7082 if (EntryPtr.get() == TE) 7083 break; 7084 if (EntryPtr->State != TreeEntry::NeedToGather) 7085 continue; 7086 for (Value *V : EntryPtr->Scalars) 7087 ValueToTEs.try_emplace(V).first->getSecond().insert(EntryPtr.get()); 7088 } 7089 // Find all tree entries used by the gathered values. If no common entries 7090 // found - not a shuffle. 7091 // Here we build a set of tree nodes for each gathered value and trying to 7092 // find the intersection between these sets. If we have at least one common 7093 // tree node for each gathered value - we have just a permutation of the 7094 // single vector. If we have 2 different sets, we're in situation where we 7095 // have a permutation of 2 input vectors. 7096 SmallVector<SmallPtrSet<const TreeEntry *, 4>> UsedTEs; 7097 DenseMap<Value *, int> UsedValuesEntry; 7098 for (Value *V : TE->Scalars) { 7099 if (isa<UndefValue>(V)) 7100 continue; 7101 // Build a list of tree entries where V is used. 7102 SmallPtrSet<const TreeEntry *, 4> VToTEs; 7103 auto It = ValueToTEs.find(V); 7104 if (It != ValueToTEs.end()) 7105 VToTEs = It->second; 7106 if (const TreeEntry *VTE = getTreeEntry(V)) 7107 VToTEs.insert(VTE); 7108 if (VToTEs.empty()) 7109 return None; 7110 if (UsedTEs.empty()) { 7111 // The first iteration, just insert the list of nodes to vector. 7112 UsedTEs.push_back(VToTEs); 7113 } else { 7114 // Need to check if there are any previously used tree nodes which use V. 7115 // If there are no such nodes, consider that we have another one input 7116 // vector. 7117 SmallPtrSet<const TreeEntry *, 4> SavedVToTEs(VToTEs); 7118 unsigned Idx = 0; 7119 for (SmallPtrSet<const TreeEntry *, 4> &Set : UsedTEs) { 7120 // Do we have a non-empty intersection of previously listed tree entries 7121 // and tree entries using current V? 7122 set_intersect(VToTEs, Set); 7123 if (!VToTEs.empty()) { 7124 // Yes, write the new subset and continue analysis for the next 7125 // scalar. 7126 Set.swap(VToTEs); 7127 break; 7128 } 7129 VToTEs = SavedVToTEs; 7130 ++Idx; 7131 } 7132 // No non-empty intersection found - need to add a second set of possible 7133 // source vectors. 7134 if (Idx == UsedTEs.size()) { 7135 // If the number of input vectors is greater than 2 - not a permutation, 7136 // fallback to the regular gather. 7137 if (UsedTEs.size() == 2) 7138 return None; 7139 UsedTEs.push_back(SavedVToTEs); 7140 Idx = UsedTEs.size() - 1; 7141 } 7142 UsedValuesEntry.try_emplace(V, Idx); 7143 } 7144 } 7145 7146 if (UsedTEs.empty()) { 7147 assert(all_of(TE->Scalars, UndefValue::classof) && 7148 "Expected vector of undefs only."); 7149 return None; 7150 } 7151 7152 unsigned VF = 0; 7153 if (UsedTEs.size() == 1) { 7154 // Try to find the perfect match in another gather node at first. 7155 auto It = find_if(UsedTEs.front(), [TE](const TreeEntry *EntryPtr) { 7156 return EntryPtr->isSame(TE->Scalars); 7157 }); 7158 if (It != UsedTEs.front().end()) { 7159 Entries.push_back(*It); 7160 std::iota(Mask.begin(), Mask.end(), 0); 7161 return TargetTransformInfo::SK_PermuteSingleSrc; 7162 } 7163 // No perfect match, just shuffle, so choose the first tree node. 7164 Entries.push_back(*UsedTEs.front().begin()); 7165 } else { 7166 // Try to find nodes with the same vector factor. 7167 assert(UsedTEs.size() == 2 && "Expected at max 2 permuted entries."); 7168 DenseMap<int, const TreeEntry *> VFToTE; 7169 for (const TreeEntry *TE : UsedTEs.front()) 7170 VFToTE.try_emplace(TE->getVectorFactor(), TE); 7171 for (const TreeEntry *TE : UsedTEs.back()) { 7172 auto It = VFToTE.find(TE->getVectorFactor()); 7173 if (It != VFToTE.end()) { 7174 VF = It->first; 7175 Entries.push_back(It->second); 7176 Entries.push_back(TE); 7177 break; 7178 } 7179 } 7180 // No 2 source vectors with the same vector factor - give up and do regular 7181 // gather. 7182 if (Entries.empty()) 7183 return None; 7184 } 7185 7186 // Build a shuffle mask for better cost estimation and vector emission. 7187 for (int I = 0, E = TE->Scalars.size(); I < E; ++I) { 7188 Value *V = TE->Scalars[I]; 7189 if (isa<UndefValue>(V)) 7190 continue; 7191 unsigned Idx = UsedValuesEntry.lookup(V); 7192 const TreeEntry *VTE = Entries[Idx]; 7193 int FoundLane = VTE->findLaneForValue(V); 7194 Mask[I] = Idx * VF + FoundLane; 7195 // Extra check required by isSingleSourceMaskImpl function (called by 7196 // ShuffleVectorInst::isSingleSourceMask). 7197 if (Mask[I] >= 2 * E) 7198 return None; 7199 } 7200 switch (Entries.size()) { 7201 case 1: 7202 return TargetTransformInfo::SK_PermuteSingleSrc; 7203 case 2: 7204 return TargetTransformInfo::SK_PermuteTwoSrc; 7205 default: 7206 break; 7207 } 7208 return None; 7209 } 7210 7211 InstructionCost BoUpSLP::getGatherCost(FixedVectorType *Ty, 7212 const APInt &ShuffledIndices, 7213 bool NeedToShuffle) const { 7214 InstructionCost Cost = 7215 TTI->getScalarizationOverhead(Ty, ~ShuffledIndices, /*Insert*/ true, 7216 /*Extract*/ false); 7217 if (NeedToShuffle) 7218 Cost += TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, Ty); 7219 return Cost; 7220 } 7221 7222 InstructionCost BoUpSLP::getGatherCost(ArrayRef<Value *> VL) const { 7223 // Find the type of the operands in VL. 7224 Type *ScalarTy = VL[0]->getType(); 7225 if (StoreInst *SI = dyn_cast<StoreInst>(VL[0])) 7226 ScalarTy = SI->getValueOperand()->getType(); 7227 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 7228 bool DuplicateNonConst = false; 7229 // Find the cost of inserting/extracting values from the vector. 7230 // Check if the same elements are inserted several times and count them as 7231 // shuffle candidates. 7232 APInt ShuffledElements = APInt::getZero(VL.size()); 7233 DenseSet<Value *> UniqueElements; 7234 // Iterate in reverse order to consider insert elements with the high cost. 7235 for (unsigned I = VL.size(); I > 0; --I) { 7236 unsigned Idx = I - 1; 7237 // No need to shuffle duplicates for constants. 7238 if (isConstant(VL[Idx])) { 7239 ShuffledElements.setBit(Idx); 7240 continue; 7241 } 7242 if (!UniqueElements.insert(VL[Idx]).second) { 7243 DuplicateNonConst = true; 7244 ShuffledElements.setBit(Idx); 7245 } 7246 } 7247 return getGatherCost(VecTy, ShuffledElements, DuplicateNonConst); 7248 } 7249 7250 // Perform operand reordering on the instructions in VL and return the reordered 7251 // operands in Left and Right. 7252 void BoUpSLP::reorderInputsAccordingToOpcode(ArrayRef<Value *> VL, 7253 SmallVectorImpl<Value *> &Left, 7254 SmallVectorImpl<Value *> &Right, 7255 const DataLayout &DL, 7256 ScalarEvolution &SE, 7257 const BoUpSLP &R) { 7258 if (VL.empty()) 7259 return; 7260 VLOperands Ops(VL, DL, SE, R); 7261 // Reorder the operands in place. 7262 Ops.reorder(); 7263 Left = Ops.getVL(0); 7264 Right = Ops.getVL(1); 7265 } 7266 7267 void BoUpSLP::setInsertPointAfterBundle(const TreeEntry *E) { 7268 // Get the basic block this bundle is in. All instructions in the bundle 7269 // should be in this block (except for extractelement-like instructions with 7270 // constant indeces). 7271 auto *Front = E->getMainOp(); 7272 auto *BB = Front->getParent(); 7273 assert(llvm::all_of(E->Scalars, [=](Value *V) -> bool { 7274 auto *I = cast<Instruction>(V); 7275 return !E->isOpcodeOrAlt(I) || I->getParent() == BB || 7276 isVectorLikeInstWithConstOps(I); 7277 })); 7278 7279 auto &&FindLastInst = [E, Front, this, &BB]() { 7280 Instruction *LastInst = Front; 7281 for (Value *V : E->Scalars) { 7282 auto *I = dyn_cast<Instruction>(V); 7283 if (!I) 7284 continue; 7285 if (LastInst->getParent() == I->getParent()) { 7286 if (LastInst->comesBefore(I)) 7287 LastInst = I; 7288 continue; 7289 } 7290 assert(isVectorLikeInstWithConstOps(LastInst) && 7291 isVectorLikeInstWithConstOps(I) && 7292 "Expected vector-like insts only."); 7293 if (!DT->isReachableFromEntry(LastInst->getParent())) { 7294 LastInst = I; 7295 continue; 7296 } 7297 if (!DT->isReachableFromEntry(I->getParent())) 7298 continue; 7299 auto *NodeA = DT->getNode(LastInst->getParent()); 7300 auto *NodeB = DT->getNode(I->getParent()); 7301 assert(NodeA && "Should only process reachable instructions"); 7302 assert(NodeB && "Should only process reachable instructions"); 7303 assert((NodeA == NodeB) == 7304 (NodeA->getDFSNumIn() == NodeB->getDFSNumIn()) && 7305 "Different nodes should have different DFS numbers"); 7306 if (NodeA->getDFSNumIn() < NodeB->getDFSNumIn()) 7307 LastInst = I; 7308 } 7309 BB = LastInst->getParent(); 7310 return LastInst; 7311 }; 7312 7313 auto &&FindFirstInst = [E, Front]() { 7314 Instruction *FirstInst = Front; 7315 for (Value *V : E->Scalars) { 7316 auto *I = dyn_cast<Instruction>(V); 7317 if (!I) 7318 continue; 7319 if (I->comesBefore(FirstInst)) 7320 FirstInst = I; 7321 } 7322 return FirstInst; 7323 }; 7324 7325 // Set the insert point to the beginning of the basic block if the entry 7326 // should not be scheduled. 7327 if (E->State != TreeEntry::NeedToGather && 7328 doesNotNeedToSchedule(E->Scalars)) { 7329 Instruction *InsertInst; 7330 if (all_of(E->Scalars, isUsedOutsideBlock)) 7331 InsertInst = FindLastInst(); 7332 else 7333 InsertInst = FindFirstInst(); 7334 // If the instruction is PHI, set the insert point after all the PHIs. 7335 if (isa<PHINode>(InsertInst)) 7336 InsertInst = BB->getFirstNonPHI(); 7337 BasicBlock::iterator InsertPt = InsertInst->getIterator(); 7338 Builder.SetInsertPoint(BB, InsertPt); 7339 Builder.SetCurrentDebugLocation(Front->getDebugLoc()); 7340 return; 7341 } 7342 7343 // The last instruction in the bundle in program order. 7344 Instruction *LastInst = nullptr; 7345 7346 // Find the last instruction. The common case should be that BB has been 7347 // scheduled, and the last instruction is VL.back(). So we start with 7348 // VL.back() and iterate over schedule data until we reach the end of the 7349 // bundle. The end of the bundle is marked by null ScheduleData. 7350 if (BlocksSchedules.count(BB)) { 7351 Value *V = E->isOneOf(E->Scalars.back()); 7352 if (doesNotNeedToBeScheduled(V)) 7353 V = *find_if_not(E->Scalars, doesNotNeedToBeScheduled); 7354 auto *Bundle = BlocksSchedules[BB]->getScheduleData(V); 7355 if (Bundle && Bundle->isPartOfBundle()) 7356 for (; Bundle; Bundle = Bundle->NextInBundle) 7357 if (Bundle->OpValue == Bundle->Inst) 7358 LastInst = Bundle->Inst; 7359 } 7360 7361 // LastInst can still be null at this point if there's either not an entry 7362 // for BB in BlocksSchedules or there's no ScheduleData available for 7363 // VL.back(). This can be the case if buildTree_rec aborts for various 7364 // reasons (e.g., the maximum recursion depth is reached, the maximum region 7365 // size is reached, etc.). ScheduleData is initialized in the scheduling 7366 // "dry-run". 7367 // 7368 // If this happens, we can still find the last instruction by brute force. We 7369 // iterate forwards from Front (inclusive) until we either see all 7370 // instructions in the bundle or reach the end of the block. If Front is the 7371 // last instruction in program order, LastInst will be set to Front, and we 7372 // will visit all the remaining instructions in the block. 7373 // 7374 // One of the reasons we exit early from buildTree_rec is to place an upper 7375 // bound on compile-time. Thus, taking an additional compile-time hit here is 7376 // not ideal. However, this should be exceedingly rare since it requires that 7377 // we both exit early from buildTree_rec and that the bundle be out-of-order 7378 // (causing us to iterate all the way to the end of the block). 7379 if (!LastInst) { 7380 LastInst = FindLastInst(); 7381 // If the instruction is PHI, set the insert point after all the PHIs. 7382 if (isa<PHINode>(LastInst)) 7383 LastInst = BB->getFirstNonPHI()->getPrevNode(); 7384 } 7385 assert(LastInst && "Failed to find last instruction in bundle"); 7386 7387 // Set the insertion point after the last instruction in the bundle. Set the 7388 // debug location to Front. 7389 Builder.SetInsertPoint(BB, std::next(LastInst->getIterator())); 7390 Builder.SetCurrentDebugLocation(Front->getDebugLoc()); 7391 } 7392 7393 Value *BoUpSLP::gather(ArrayRef<Value *> VL) { 7394 // List of instructions/lanes from current block and/or the blocks which are 7395 // part of the current loop. These instructions will be inserted at the end to 7396 // make it possible to optimize loops and hoist invariant instructions out of 7397 // the loops body with better chances for success. 7398 SmallVector<std::pair<Value *, unsigned>, 4> PostponedInsts; 7399 SmallSet<int, 4> PostponedIndices; 7400 Loop *L = LI->getLoopFor(Builder.GetInsertBlock()); 7401 auto &&CheckPredecessor = [](BasicBlock *InstBB, BasicBlock *InsertBB) { 7402 SmallPtrSet<BasicBlock *, 4> Visited; 7403 while (InsertBB && InsertBB != InstBB && Visited.insert(InsertBB).second) 7404 InsertBB = InsertBB->getSinglePredecessor(); 7405 return InsertBB && InsertBB == InstBB; 7406 }; 7407 for (int I = 0, E = VL.size(); I < E; ++I) { 7408 if (auto *Inst = dyn_cast<Instruction>(VL[I])) 7409 if ((CheckPredecessor(Inst->getParent(), Builder.GetInsertBlock()) || 7410 getTreeEntry(Inst) || (L && (L->contains(Inst)))) && 7411 PostponedIndices.insert(I).second) 7412 PostponedInsts.emplace_back(Inst, I); 7413 } 7414 7415 auto &&CreateInsertElement = [this](Value *Vec, Value *V, unsigned Pos) { 7416 Vec = Builder.CreateInsertElement(Vec, V, Builder.getInt32(Pos)); 7417 auto *InsElt = dyn_cast<InsertElementInst>(Vec); 7418 if (!InsElt) 7419 return Vec; 7420 GatherShuffleSeq.insert(InsElt); 7421 CSEBlocks.insert(InsElt->getParent()); 7422 // Add to our 'need-to-extract' list. 7423 if (TreeEntry *Entry = getTreeEntry(V)) { 7424 // Find which lane we need to extract. 7425 unsigned FoundLane = Entry->findLaneForValue(V); 7426 ExternalUses.emplace_back(V, InsElt, FoundLane); 7427 } 7428 return Vec; 7429 }; 7430 Value *Val0 = 7431 isa<StoreInst>(VL[0]) ? cast<StoreInst>(VL[0])->getValueOperand() : VL[0]; 7432 FixedVectorType *VecTy = FixedVectorType::get(Val0->getType(), VL.size()); 7433 Value *Vec = PoisonValue::get(VecTy); 7434 SmallVector<int> NonConsts; 7435 // Insert constant values at first. 7436 for (int I = 0, E = VL.size(); I < E; ++I) { 7437 if (PostponedIndices.contains(I)) 7438 continue; 7439 if (!isConstant(VL[I])) { 7440 NonConsts.push_back(I); 7441 continue; 7442 } 7443 Vec = CreateInsertElement(Vec, VL[I], I); 7444 } 7445 // Insert non-constant values. 7446 for (int I : NonConsts) 7447 Vec = CreateInsertElement(Vec, VL[I], I); 7448 // Append instructions, which are/may be part of the loop, in the end to make 7449 // it possible to hoist non-loop-based instructions. 7450 for (const std::pair<Value *, unsigned> &Pair : PostponedInsts) 7451 Vec = CreateInsertElement(Vec, Pair.first, Pair.second); 7452 7453 return Vec; 7454 } 7455 7456 namespace { 7457 /// Merges shuffle masks and emits final shuffle instruction, if required. 7458 class ShuffleInstructionBuilder { 7459 IRBuilderBase &Builder; 7460 const unsigned VF = 0; 7461 bool IsFinalized = false; 7462 SmallVector<int, 4> Mask; 7463 /// Holds all of the instructions that we gathered. 7464 SetVector<Instruction *> &GatherShuffleSeq; 7465 /// A list of blocks that we are going to CSE. 7466 SetVector<BasicBlock *> &CSEBlocks; 7467 7468 public: 7469 ShuffleInstructionBuilder(IRBuilderBase &Builder, unsigned VF, 7470 SetVector<Instruction *> &GatherShuffleSeq, 7471 SetVector<BasicBlock *> &CSEBlocks) 7472 : Builder(Builder), VF(VF), GatherShuffleSeq(GatherShuffleSeq), 7473 CSEBlocks(CSEBlocks) {} 7474 7475 /// Adds a mask, inverting it before applying. 7476 void addInversedMask(ArrayRef<unsigned> SubMask) { 7477 if (SubMask.empty()) 7478 return; 7479 SmallVector<int, 4> NewMask; 7480 inversePermutation(SubMask, NewMask); 7481 addMask(NewMask); 7482 } 7483 7484 /// Functions adds masks, merging them into single one. 7485 void addMask(ArrayRef<unsigned> SubMask) { 7486 SmallVector<int, 4> NewMask(SubMask.begin(), SubMask.end()); 7487 addMask(NewMask); 7488 } 7489 7490 void addMask(ArrayRef<int> SubMask) { ::addMask(Mask, SubMask); } 7491 7492 Value *finalize(Value *V) { 7493 IsFinalized = true; 7494 unsigned ValueVF = cast<FixedVectorType>(V->getType())->getNumElements(); 7495 if (VF == ValueVF && Mask.empty()) 7496 return V; 7497 SmallVector<int, 4> NormalizedMask(VF, UndefMaskElem); 7498 std::iota(NormalizedMask.begin(), NormalizedMask.end(), 0); 7499 addMask(NormalizedMask); 7500 7501 if (VF == ValueVF && ShuffleVectorInst::isIdentityMask(Mask)) 7502 return V; 7503 Value *Vec = Builder.CreateShuffleVector(V, Mask, "shuffle"); 7504 if (auto *I = dyn_cast<Instruction>(Vec)) { 7505 GatherShuffleSeq.insert(I); 7506 CSEBlocks.insert(I->getParent()); 7507 } 7508 return Vec; 7509 } 7510 7511 ~ShuffleInstructionBuilder() { 7512 assert((IsFinalized || Mask.empty()) && 7513 "Shuffle construction must be finalized."); 7514 } 7515 }; 7516 } // namespace 7517 7518 Value *BoUpSLP::vectorizeTree(ArrayRef<Value *> VL) { 7519 const unsigned VF = VL.size(); 7520 InstructionsState S = getSameOpcode(VL); 7521 if (S.getOpcode()) { 7522 if (TreeEntry *E = getTreeEntry(S.OpValue)) 7523 if (E->isSame(VL)) { 7524 Value *V = vectorizeTree(E); 7525 if (VF != cast<FixedVectorType>(V->getType())->getNumElements()) { 7526 if (!E->ReuseShuffleIndices.empty()) { 7527 // Reshuffle to get only unique values. 7528 // If some of the scalars are duplicated in the vectorization tree 7529 // entry, we do not vectorize them but instead generate a mask for 7530 // the reuses. But if there are several users of the same entry, 7531 // they may have different vectorization factors. This is especially 7532 // important for PHI nodes. In this case, we need to adapt the 7533 // resulting instruction for the user vectorization factor and have 7534 // to reshuffle it again to take only unique elements of the vector. 7535 // Without this code the function incorrectly returns reduced vector 7536 // instruction with the same elements, not with the unique ones. 7537 7538 // block: 7539 // %phi = phi <2 x > { .., %entry} {%shuffle, %block} 7540 // %2 = shuffle <2 x > %phi, poison, <4 x > <1, 1, 0, 0> 7541 // ... (use %2) 7542 // %shuffle = shuffle <2 x> %2, poison, <2 x> {2, 0} 7543 // br %block 7544 SmallVector<int> UniqueIdxs(VF, UndefMaskElem); 7545 SmallSet<int, 4> UsedIdxs; 7546 int Pos = 0; 7547 int Sz = VL.size(); 7548 for (int Idx : E->ReuseShuffleIndices) { 7549 if (Idx != Sz && Idx != UndefMaskElem && 7550 UsedIdxs.insert(Idx).second) 7551 UniqueIdxs[Idx] = Pos; 7552 ++Pos; 7553 } 7554 assert(VF >= UsedIdxs.size() && "Expected vectorization factor " 7555 "less than original vector size."); 7556 UniqueIdxs.append(VF - UsedIdxs.size(), UndefMaskElem); 7557 V = Builder.CreateShuffleVector(V, UniqueIdxs, "shrink.shuffle"); 7558 } else { 7559 assert(VF < cast<FixedVectorType>(V->getType())->getNumElements() && 7560 "Expected vectorization factor less " 7561 "than original vector size."); 7562 SmallVector<int> UniformMask(VF, 0); 7563 std::iota(UniformMask.begin(), UniformMask.end(), 0); 7564 V = Builder.CreateShuffleVector(V, UniformMask, "shrink.shuffle"); 7565 } 7566 if (auto *I = dyn_cast<Instruction>(V)) { 7567 GatherShuffleSeq.insert(I); 7568 CSEBlocks.insert(I->getParent()); 7569 } 7570 } 7571 return V; 7572 } 7573 } 7574 7575 // Can't vectorize this, so simply build a new vector with each lane 7576 // corresponding to the requested value. 7577 return createBuildVector(VL); 7578 } 7579 Value *BoUpSLP::createBuildVector(ArrayRef<Value *> VL) { 7580 unsigned VF = VL.size(); 7581 // Exploit possible reuse of values across lanes. 7582 SmallVector<int> ReuseShuffleIndicies; 7583 SmallVector<Value *> UniqueValues; 7584 if (VL.size() > 2) { 7585 DenseMap<Value *, unsigned> UniquePositions; 7586 unsigned NumValues = 7587 std::distance(VL.begin(), find_if(reverse(VL), [](Value *V) { 7588 return !isa<UndefValue>(V); 7589 }).base()); 7590 VF = std::max<unsigned>(VF, PowerOf2Ceil(NumValues)); 7591 int UniqueVals = 0; 7592 for (Value *V : VL.drop_back(VL.size() - VF)) { 7593 if (isa<UndefValue>(V)) { 7594 ReuseShuffleIndicies.emplace_back(UndefMaskElem); 7595 continue; 7596 } 7597 if (isConstant(V)) { 7598 ReuseShuffleIndicies.emplace_back(UniqueValues.size()); 7599 UniqueValues.emplace_back(V); 7600 continue; 7601 } 7602 auto Res = UniquePositions.try_emplace(V, UniqueValues.size()); 7603 ReuseShuffleIndicies.emplace_back(Res.first->second); 7604 if (Res.second) { 7605 UniqueValues.emplace_back(V); 7606 ++UniqueVals; 7607 } 7608 } 7609 if (UniqueVals == 1 && UniqueValues.size() == 1) { 7610 // Emit pure splat vector. 7611 ReuseShuffleIndicies.append(VF - ReuseShuffleIndicies.size(), 7612 UndefMaskElem); 7613 } else if (UniqueValues.size() >= VF - 1 || UniqueValues.size() <= 1) { 7614 if (UniqueValues.empty()) { 7615 assert(all_of(VL, UndefValue::classof) && "Expected list of undefs."); 7616 NumValues = VF; 7617 } 7618 ReuseShuffleIndicies.clear(); 7619 UniqueValues.clear(); 7620 UniqueValues.append(VL.begin(), std::next(VL.begin(), NumValues)); 7621 } 7622 UniqueValues.append(VF - UniqueValues.size(), 7623 PoisonValue::get(VL[0]->getType())); 7624 VL = UniqueValues; 7625 } 7626 7627 ShuffleInstructionBuilder ShuffleBuilder(Builder, VF, GatherShuffleSeq, 7628 CSEBlocks); 7629 Value *Vec = gather(VL); 7630 if (!ReuseShuffleIndicies.empty()) { 7631 ShuffleBuilder.addMask(ReuseShuffleIndicies); 7632 Vec = ShuffleBuilder.finalize(Vec); 7633 } 7634 return Vec; 7635 } 7636 7637 Value *BoUpSLP::vectorizeTree(TreeEntry *E) { 7638 IRBuilder<>::InsertPointGuard Guard(Builder); 7639 7640 if (E->VectorizedValue) { 7641 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *E->Scalars[0] << ".\n"); 7642 return E->VectorizedValue; 7643 } 7644 7645 bool NeedToShuffleReuses = !E->ReuseShuffleIndices.empty(); 7646 unsigned VF = E->getVectorFactor(); 7647 ShuffleInstructionBuilder ShuffleBuilder(Builder, VF, GatherShuffleSeq, 7648 CSEBlocks); 7649 if (E->State == TreeEntry::NeedToGather) { 7650 if (E->getMainOp()) 7651 setInsertPointAfterBundle(E); 7652 Value *Vec; 7653 SmallVector<int> Mask; 7654 SmallVector<const TreeEntry *> Entries; 7655 Optional<TargetTransformInfo::ShuffleKind> Shuffle = 7656 isGatherShuffledEntry(E, Mask, Entries); 7657 if (Shuffle.hasValue()) { 7658 assert((Entries.size() == 1 || Entries.size() == 2) && 7659 "Expected shuffle of 1 or 2 entries."); 7660 Vec = Builder.CreateShuffleVector(Entries.front()->VectorizedValue, 7661 Entries.back()->VectorizedValue, Mask); 7662 if (auto *I = dyn_cast<Instruction>(Vec)) { 7663 GatherShuffleSeq.insert(I); 7664 CSEBlocks.insert(I->getParent()); 7665 } 7666 } else { 7667 Vec = gather(E->Scalars); 7668 } 7669 if (NeedToShuffleReuses) { 7670 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7671 Vec = ShuffleBuilder.finalize(Vec); 7672 } 7673 E->VectorizedValue = Vec; 7674 return Vec; 7675 } 7676 7677 assert((E->State == TreeEntry::Vectorize || 7678 E->State == TreeEntry::ScatterVectorize) && 7679 "Unhandled state"); 7680 unsigned ShuffleOrOp = 7681 E->isAltShuffle() ? (unsigned)Instruction::ShuffleVector : E->getOpcode(); 7682 Instruction *VL0 = E->getMainOp(); 7683 Type *ScalarTy = VL0->getType(); 7684 if (auto *Store = dyn_cast<StoreInst>(VL0)) 7685 ScalarTy = Store->getValueOperand()->getType(); 7686 else if (auto *IE = dyn_cast<InsertElementInst>(VL0)) 7687 ScalarTy = IE->getOperand(1)->getType(); 7688 auto *VecTy = FixedVectorType::get(ScalarTy, E->Scalars.size()); 7689 switch (ShuffleOrOp) { 7690 case Instruction::PHI: { 7691 assert( 7692 (E->ReorderIndices.empty() || E != VectorizableTree.front().get()) && 7693 "PHI reordering is free."); 7694 auto *PH = cast<PHINode>(VL0); 7695 Builder.SetInsertPoint(PH->getParent()->getFirstNonPHI()); 7696 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 7697 PHINode *NewPhi = Builder.CreatePHI(VecTy, PH->getNumIncomingValues()); 7698 Value *V = NewPhi; 7699 7700 // Adjust insertion point once all PHI's have been generated. 7701 Builder.SetInsertPoint(&*PH->getParent()->getFirstInsertionPt()); 7702 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 7703 7704 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7705 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7706 V = ShuffleBuilder.finalize(V); 7707 7708 E->VectorizedValue = V; 7709 7710 // PHINodes may have multiple entries from the same block. We want to 7711 // visit every block once. 7712 SmallPtrSet<BasicBlock*, 4> VisitedBBs; 7713 7714 for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) { 7715 ValueList Operands; 7716 BasicBlock *IBB = PH->getIncomingBlock(i); 7717 7718 if (!VisitedBBs.insert(IBB).second) { 7719 NewPhi->addIncoming(NewPhi->getIncomingValueForBlock(IBB), IBB); 7720 continue; 7721 } 7722 7723 Builder.SetInsertPoint(IBB->getTerminator()); 7724 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 7725 Value *Vec = vectorizeTree(E->getOperand(i)); 7726 NewPhi->addIncoming(Vec, IBB); 7727 } 7728 7729 assert(NewPhi->getNumIncomingValues() == PH->getNumIncomingValues() && 7730 "Invalid number of incoming values"); 7731 return V; 7732 } 7733 7734 case Instruction::ExtractElement: { 7735 Value *V = E->getSingleOperand(0); 7736 Builder.SetInsertPoint(VL0); 7737 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7738 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7739 V = ShuffleBuilder.finalize(V); 7740 E->VectorizedValue = V; 7741 return V; 7742 } 7743 case Instruction::ExtractValue: { 7744 auto *LI = cast<LoadInst>(E->getSingleOperand(0)); 7745 Builder.SetInsertPoint(LI); 7746 auto *PtrTy = PointerType::get(VecTy, LI->getPointerAddressSpace()); 7747 Value *Ptr = Builder.CreateBitCast(LI->getOperand(0), PtrTy); 7748 LoadInst *V = Builder.CreateAlignedLoad(VecTy, Ptr, LI->getAlign()); 7749 Value *NewV = propagateMetadata(V, E->Scalars); 7750 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7751 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7752 NewV = ShuffleBuilder.finalize(NewV); 7753 E->VectorizedValue = NewV; 7754 return NewV; 7755 } 7756 case Instruction::InsertElement: { 7757 assert(E->ReuseShuffleIndices.empty() && "All inserts should be unique"); 7758 Builder.SetInsertPoint(cast<Instruction>(E->Scalars.back())); 7759 Value *V = vectorizeTree(E->getOperand(1)); 7760 7761 // Create InsertVector shuffle if necessary 7762 auto *FirstInsert = cast<Instruction>(*find_if(E->Scalars, [E](Value *V) { 7763 return !is_contained(E->Scalars, cast<Instruction>(V)->getOperand(0)); 7764 })); 7765 const unsigned NumElts = 7766 cast<FixedVectorType>(FirstInsert->getType())->getNumElements(); 7767 const unsigned NumScalars = E->Scalars.size(); 7768 7769 unsigned Offset = *getInsertIndex(VL0); 7770 assert(Offset < NumElts && "Failed to find vector index offset"); 7771 7772 // Create shuffle to resize vector 7773 SmallVector<int> Mask; 7774 if (!E->ReorderIndices.empty()) { 7775 inversePermutation(E->ReorderIndices, Mask); 7776 Mask.append(NumElts - NumScalars, UndefMaskElem); 7777 } else { 7778 Mask.assign(NumElts, UndefMaskElem); 7779 std::iota(Mask.begin(), std::next(Mask.begin(), NumScalars), 0); 7780 } 7781 // Create InsertVector shuffle if necessary 7782 bool IsIdentity = true; 7783 SmallVector<int> PrevMask(NumElts, UndefMaskElem); 7784 Mask.swap(PrevMask); 7785 for (unsigned I = 0; I < NumScalars; ++I) { 7786 Value *Scalar = E->Scalars[PrevMask[I]]; 7787 unsigned InsertIdx = *getInsertIndex(Scalar); 7788 IsIdentity &= InsertIdx - Offset == I; 7789 Mask[InsertIdx - Offset] = I; 7790 } 7791 if (!IsIdentity || NumElts != NumScalars) { 7792 V = Builder.CreateShuffleVector(V, Mask); 7793 if (auto *I = dyn_cast<Instruction>(V)) { 7794 GatherShuffleSeq.insert(I); 7795 CSEBlocks.insert(I->getParent()); 7796 } 7797 } 7798 7799 if ((!IsIdentity || Offset != 0 || 7800 !isUndefVector(FirstInsert->getOperand(0))) && 7801 NumElts != NumScalars) { 7802 SmallVector<int> InsertMask(NumElts); 7803 std::iota(InsertMask.begin(), InsertMask.end(), 0); 7804 for (unsigned I = 0; I < NumElts; I++) { 7805 if (Mask[I] != UndefMaskElem) 7806 InsertMask[Offset + I] = NumElts + I; 7807 } 7808 7809 V = Builder.CreateShuffleVector( 7810 FirstInsert->getOperand(0), V, InsertMask, 7811 cast<Instruction>(E->Scalars.back())->getName()); 7812 if (auto *I = dyn_cast<Instruction>(V)) { 7813 GatherShuffleSeq.insert(I); 7814 CSEBlocks.insert(I->getParent()); 7815 } 7816 } 7817 7818 ++NumVectorInstructions; 7819 E->VectorizedValue = V; 7820 return V; 7821 } 7822 case Instruction::ZExt: 7823 case Instruction::SExt: 7824 case Instruction::FPToUI: 7825 case Instruction::FPToSI: 7826 case Instruction::FPExt: 7827 case Instruction::PtrToInt: 7828 case Instruction::IntToPtr: 7829 case Instruction::SIToFP: 7830 case Instruction::UIToFP: 7831 case Instruction::Trunc: 7832 case Instruction::FPTrunc: 7833 case Instruction::BitCast: { 7834 setInsertPointAfterBundle(E); 7835 7836 Value *InVec = vectorizeTree(E->getOperand(0)); 7837 7838 if (E->VectorizedValue) { 7839 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7840 return E->VectorizedValue; 7841 } 7842 7843 auto *CI = cast<CastInst>(VL0); 7844 Value *V = Builder.CreateCast(CI->getOpcode(), InVec, VecTy); 7845 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7846 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7847 V = ShuffleBuilder.finalize(V); 7848 7849 E->VectorizedValue = V; 7850 ++NumVectorInstructions; 7851 return V; 7852 } 7853 case Instruction::FCmp: 7854 case Instruction::ICmp: { 7855 setInsertPointAfterBundle(E); 7856 7857 Value *L = vectorizeTree(E->getOperand(0)); 7858 Value *R = vectorizeTree(E->getOperand(1)); 7859 7860 if (E->VectorizedValue) { 7861 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7862 return E->VectorizedValue; 7863 } 7864 7865 CmpInst::Predicate P0 = cast<CmpInst>(VL0)->getPredicate(); 7866 Value *V = Builder.CreateCmp(P0, L, R); 7867 propagateIRFlags(V, E->Scalars, VL0); 7868 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7869 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7870 V = ShuffleBuilder.finalize(V); 7871 7872 E->VectorizedValue = V; 7873 ++NumVectorInstructions; 7874 return V; 7875 } 7876 case Instruction::Select: { 7877 setInsertPointAfterBundle(E); 7878 7879 Value *Cond = vectorizeTree(E->getOperand(0)); 7880 Value *True = vectorizeTree(E->getOperand(1)); 7881 Value *False = vectorizeTree(E->getOperand(2)); 7882 7883 if (E->VectorizedValue) { 7884 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7885 return E->VectorizedValue; 7886 } 7887 7888 Value *V = Builder.CreateSelect(Cond, True, False); 7889 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7890 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7891 V = ShuffleBuilder.finalize(V); 7892 7893 E->VectorizedValue = V; 7894 ++NumVectorInstructions; 7895 return V; 7896 } 7897 case Instruction::FNeg: { 7898 setInsertPointAfterBundle(E); 7899 7900 Value *Op = vectorizeTree(E->getOperand(0)); 7901 7902 if (E->VectorizedValue) { 7903 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7904 return E->VectorizedValue; 7905 } 7906 7907 Value *V = Builder.CreateUnOp( 7908 static_cast<Instruction::UnaryOps>(E->getOpcode()), Op); 7909 propagateIRFlags(V, E->Scalars, VL0); 7910 if (auto *I = dyn_cast<Instruction>(V)) 7911 V = propagateMetadata(I, E->Scalars); 7912 7913 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7914 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7915 V = ShuffleBuilder.finalize(V); 7916 7917 E->VectorizedValue = V; 7918 ++NumVectorInstructions; 7919 7920 return V; 7921 } 7922 case Instruction::Add: 7923 case Instruction::FAdd: 7924 case Instruction::Sub: 7925 case Instruction::FSub: 7926 case Instruction::Mul: 7927 case Instruction::FMul: 7928 case Instruction::UDiv: 7929 case Instruction::SDiv: 7930 case Instruction::FDiv: 7931 case Instruction::URem: 7932 case Instruction::SRem: 7933 case Instruction::FRem: 7934 case Instruction::Shl: 7935 case Instruction::LShr: 7936 case Instruction::AShr: 7937 case Instruction::And: 7938 case Instruction::Or: 7939 case Instruction::Xor: { 7940 setInsertPointAfterBundle(E); 7941 7942 Value *LHS = vectorizeTree(E->getOperand(0)); 7943 Value *RHS = vectorizeTree(E->getOperand(1)); 7944 7945 if (E->VectorizedValue) { 7946 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7947 return E->VectorizedValue; 7948 } 7949 7950 Value *V = Builder.CreateBinOp( 7951 static_cast<Instruction::BinaryOps>(E->getOpcode()), LHS, 7952 RHS); 7953 propagateIRFlags(V, E->Scalars, VL0); 7954 if (auto *I = dyn_cast<Instruction>(V)) 7955 V = propagateMetadata(I, E->Scalars); 7956 7957 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7958 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7959 V = ShuffleBuilder.finalize(V); 7960 7961 E->VectorizedValue = V; 7962 ++NumVectorInstructions; 7963 7964 return V; 7965 } 7966 case Instruction::Load: { 7967 // Loads are inserted at the head of the tree because we don't want to 7968 // sink them all the way down past store instructions. 7969 setInsertPointAfterBundle(E); 7970 7971 LoadInst *LI = cast<LoadInst>(VL0); 7972 Instruction *NewLI; 7973 unsigned AS = LI->getPointerAddressSpace(); 7974 Value *PO = LI->getPointerOperand(); 7975 if (E->State == TreeEntry::Vectorize) { 7976 Value *VecPtr = Builder.CreateBitCast(PO, VecTy->getPointerTo(AS)); 7977 NewLI = Builder.CreateAlignedLoad(VecTy, VecPtr, LI->getAlign()); 7978 7979 // The pointer operand uses an in-tree scalar so we add the new BitCast 7980 // or LoadInst to ExternalUses list to make sure that an extract will 7981 // be generated in the future. 7982 if (TreeEntry *Entry = getTreeEntry(PO)) { 7983 // Find which lane we need to extract. 7984 unsigned FoundLane = Entry->findLaneForValue(PO); 7985 ExternalUses.emplace_back( 7986 PO, PO != VecPtr ? cast<User>(VecPtr) : NewLI, FoundLane); 7987 } 7988 } else { 7989 assert(E->State == TreeEntry::ScatterVectorize && "Unhandled state"); 7990 Value *VecPtr = vectorizeTree(E->getOperand(0)); 7991 // Use the minimum alignment of the gathered loads. 7992 Align CommonAlignment = LI->getAlign(); 7993 for (Value *V : E->Scalars) 7994 CommonAlignment = 7995 commonAlignment(CommonAlignment, cast<LoadInst>(V)->getAlign()); 7996 NewLI = Builder.CreateMaskedGather(VecTy, VecPtr, CommonAlignment); 7997 } 7998 Value *V = propagateMetadata(NewLI, E->Scalars); 7999 8000 ShuffleBuilder.addInversedMask(E->ReorderIndices); 8001 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 8002 V = ShuffleBuilder.finalize(V); 8003 E->VectorizedValue = V; 8004 ++NumVectorInstructions; 8005 return V; 8006 } 8007 case Instruction::Store: { 8008 auto *SI = cast<StoreInst>(VL0); 8009 unsigned AS = SI->getPointerAddressSpace(); 8010 8011 setInsertPointAfterBundle(E); 8012 8013 Value *VecValue = vectorizeTree(E->getOperand(0)); 8014 ShuffleBuilder.addMask(E->ReorderIndices); 8015 VecValue = ShuffleBuilder.finalize(VecValue); 8016 8017 Value *ScalarPtr = SI->getPointerOperand(); 8018 Value *VecPtr = Builder.CreateBitCast( 8019 ScalarPtr, VecValue->getType()->getPointerTo(AS)); 8020 StoreInst *ST = 8021 Builder.CreateAlignedStore(VecValue, VecPtr, SI->getAlign()); 8022 8023 // The pointer operand uses an in-tree scalar, so add the new BitCast or 8024 // StoreInst to ExternalUses to make sure that an extract will be 8025 // generated in the future. 8026 if (TreeEntry *Entry = getTreeEntry(ScalarPtr)) { 8027 // Find which lane we need to extract. 8028 unsigned FoundLane = Entry->findLaneForValue(ScalarPtr); 8029 ExternalUses.push_back(ExternalUser( 8030 ScalarPtr, ScalarPtr != VecPtr ? cast<User>(VecPtr) : ST, 8031 FoundLane)); 8032 } 8033 8034 Value *V = propagateMetadata(ST, E->Scalars); 8035 8036 E->VectorizedValue = V; 8037 ++NumVectorInstructions; 8038 return V; 8039 } 8040 case Instruction::GetElementPtr: { 8041 auto *GEP0 = cast<GetElementPtrInst>(VL0); 8042 setInsertPointAfterBundle(E); 8043 8044 Value *Op0 = vectorizeTree(E->getOperand(0)); 8045 8046 SmallVector<Value *> OpVecs; 8047 for (int J = 1, N = GEP0->getNumOperands(); J < N; ++J) { 8048 Value *OpVec = vectorizeTree(E->getOperand(J)); 8049 OpVecs.push_back(OpVec); 8050 } 8051 8052 Value *V = Builder.CreateGEP(GEP0->getSourceElementType(), Op0, OpVecs); 8053 if (Instruction *I = dyn_cast<Instruction>(V)) 8054 V = propagateMetadata(I, E->Scalars); 8055 8056 ShuffleBuilder.addInversedMask(E->ReorderIndices); 8057 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 8058 V = ShuffleBuilder.finalize(V); 8059 8060 E->VectorizedValue = V; 8061 ++NumVectorInstructions; 8062 8063 return V; 8064 } 8065 case Instruction::Call: { 8066 CallInst *CI = cast<CallInst>(VL0); 8067 setInsertPointAfterBundle(E); 8068 8069 Intrinsic::ID IID = Intrinsic::not_intrinsic; 8070 if (Function *FI = CI->getCalledFunction()) 8071 IID = FI->getIntrinsicID(); 8072 8073 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 8074 8075 auto VecCallCosts = getVectorCallCosts(CI, VecTy, TTI, TLI); 8076 bool UseIntrinsic = ID != Intrinsic::not_intrinsic && 8077 VecCallCosts.first <= VecCallCosts.second; 8078 8079 Value *ScalarArg = nullptr; 8080 std::vector<Value *> OpVecs; 8081 SmallVector<Type *, 2> TysForDecl = 8082 {FixedVectorType::get(CI->getType(), E->Scalars.size())}; 8083 for (int j = 0, e = CI->arg_size(); j < e; ++j) { 8084 ValueList OpVL; 8085 // Some intrinsics have scalar arguments. This argument should not be 8086 // vectorized. 8087 if (UseIntrinsic && isVectorIntrinsicWithScalarOpAtArg(IID, j)) { 8088 CallInst *CEI = cast<CallInst>(VL0); 8089 ScalarArg = CEI->getArgOperand(j); 8090 OpVecs.push_back(CEI->getArgOperand(j)); 8091 if (isVectorIntrinsicWithOverloadTypeAtArg(IID, j)) 8092 TysForDecl.push_back(ScalarArg->getType()); 8093 continue; 8094 } 8095 8096 Value *OpVec = vectorizeTree(E->getOperand(j)); 8097 LLVM_DEBUG(dbgs() << "SLP: OpVec[" << j << "]: " << *OpVec << "\n"); 8098 OpVecs.push_back(OpVec); 8099 if (isVectorIntrinsicWithOverloadTypeAtArg(IID, j)) 8100 TysForDecl.push_back(OpVec->getType()); 8101 } 8102 8103 Function *CF; 8104 if (!UseIntrinsic) { 8105 VFShape Shape = 8106 VFShape::get(*CI, ElementCount::getFixed(static_cast<unsigned>( 8107 VecTy->getNumElements())), 8108 false /*HasGlobalPred*/); 8109 CF = VFDatabase(*CI).getVectorizedFunction(Shape); 8110 } else { 8111 CF = Intrinsic::getDeclaration(F->getParent(), ID, TysForDecl); 8112 } 8113 8114 SmallVector<OperandBundleDef, 1> OpBundles; 8115 CI->getOperandBundlesAsDefs(OpBundles); 8116 Value *V = Builder.CreateCall(CF, OpVecs, OpBundles); 8117 8118 // The scalar argument uses an in-tree scalar so we add the new vectorized 8119 // call to ExternalUses list to make sure that an extract will be 8120 // generated in the future. 8121 if (ScalarArg) { 8122 if (TreeEntry *Entry = getTreeEntry(ScalarArg)) { 8123 // Find which lane we need to extract. 8124 unsigned FoundLane = Entry->findLaneForValue(ScalarArg); 8125 ExternalUses.push_back( 8126 ExternalUser(ScalarArg, cast<User>(V), FoundLane)); 8127 } 8128 } 8129 8130 propagateIRFlags(V, E->Scalars, VL0); 8131 ShuffleBuilder.addInversedMask(E->ReorderIndices); 8132 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 8133 V = ShuffleBuilder.finalize(V); 8134 8135 E->VectorizedValue = V; 8136 ++NumVectorInstructions; 8137 return V; 8138 } 8139 case Instruction::ShuffleVector: { 8140 assert(E->isAltShuffle() && 8141 ((Instruction::isBinaryOp(E->getOpcode()) && 8142 Instruction::isBinaryOp(E->getAltOpcode())) || 8143 (Instruction::isCast(E->getOpcode()) && 8144 Instruction::isCast(E->getAltOpcode())) || 8145 (isa<CmpInst>(VL0) && isa<CmpInst>(E->getAltOp()))) && 8146 "Invalid Shuffle Vector Operand"); 8147 8148 Value *LHS = nullptr, *RHS = nullptr; 8149 if (Instruction::isBinaryOp(E->getOpcode()) || isa<CmpInst>(VL0)) { 8150 setInsertPointAfterBundle(E); 8151 LHS = vectorizeTree(E->getOperand(0)); 8152 RHS = vectorizeTree(E->getOperand(1)); 8153 } else { 8154 setInsertPointAfterBundle(E); 8155 LHS = vectorizeTree(E->getOperand(0)); 8156 } 8157 8158 if (E->VectorizedValue) { 8159 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 8160 return E->VectorizedValue; 8161 } 8162 8163 Value *V0, *V1; 8164 if (Instruction::isBinaryOp(E->getOpcode())) { 8165 V0 = Builder.CreateBinOp( 8166 static_cast<Instruction::BinaryOps>(E->getOpcode()), LHS, RHS); 8167 V1 = Builder.CreateBinOp( 8168 static_cast<Instruction::BinaryOps>(E->getAltOpcode()), LHS, RHS); 8169 } else if (auto *CI0 = dyn_cast<CmpInst>(VL0)) { 8170 V0 = Builder.CreateCmp(CI0->getPredicate(), LHS, RHS); 8171 auto *AltCI = cast<CmpInst>(E->getAltOp()); 8172 CmpInst::Predicate AltPred = AltCI->getPredicate(); 8173 V1 = Builder.CreateCmp(AltPred, LHS, RHS); 8174 } else { 8175 V0 = Builder.CreateCast( 8176 static_cast<Instruction::CastOps>(E->getOpcode()), LHS, VecTy); 8177 V1 = Builder.CreateCast( 8178 static_cast<Instruction::CastOps>(E->getAltOpcode()), LHS, VecTy); 8179 } 8180 // Add V0 and V1 to later analysis to try to find and remove matching 8181 // instruction, if any. 8182 for (Value *V : {V0, V1}) { 8183 if (auto *I = dyn_cast<Instruction>(V)) { 8184 GatherShuffleSeq.insert(I); 8185 CSEBlocks.insert(I->getParent()); 8186 } 8187 } 8188 8189 // Create shuffle to take alternate operations from the vector. 8190 // Also, gather up main and alt scalar ops to propagate IR flags to 8191 // each vector operation. 8192 ValueList OpScalars, AltScalars; 8193 SmallVector<int> Mask; 8194 buildShuffleEntryMask( 8195 E->Scalars, E->ReorderIndices, E->ReuseShuffleIndices, 8196 [E](Instruction *I) { 8197 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 8198 return isAlternateInstruction(I, E->getMainOp(), E->getAltOp()); 8199 }, 8200 Mask, &OpScalars, &AltScalars); 8201 8202 propagateIRFlags(V0, OpScalars); 8203 propagateIRFlags(V1, AltScalars); 8204 8205 Value *V = Builder.CreateShuffleVector(V0, V1, Mask); 8206 if (auto *I = dyn_cast<Instruction>(V)) { 8207 V = propagateMetadata(I, E->Scalars); 8208 GatherShuffleSeq.insert(I); 8209 CSEBlocks.insert(I->getParent()); 8210 } 8211 V = ShuffleBuilder.finalize(V); 8212 8213 E->VectorizedValue = V; 8214 ++NumVectorInstructions; 8215 8216 return V; 8217 } 8218 default: 8219 llvm_unreachable("unknown inst"); 8220 } 8221 return nullptr; 8222 } 8223 8224 Value *BoUpSLP::vectorizeTree() { 8225 ExtraValueToDebugLocsMap ExternallyUsedValues; 8226 return vectorizeTree(ExternallyUsedValues); 8227 } 8228 8229 namespace { 8230 /// Data type for handling buildvector sequences with the reused scalars from 8231 /// other tree entries. 8232 struct ShuffledInsertData { 8233 /// List of insertelements to be replaced by shuffles. 8234 SmallVector<InsertElementInst *> InsertElements; 8235 /// The parent vectors and shuffle mask for the given list of inserts. 8236 MapVector<Value *, SmallVector<int>> ValueMasks; 8237 }; 8238 } // namespace 8239 8240 Value * 8241 BoUpSLP::vectorizeTree(ExtraValueToDebugLocsMap &ExternallyUsedValues) { 8242 // All blocks must be scheduled before any instructions are inserted. 8243 for (auto &BSIter : BlocksSchedules) { 8244 scheduleBlock(BSIter.second.get()); 8245 } 8246 8247 Builder.SetInsertPoint(&F->getEntryBlock().front()); 8248 auto *VectorRoot = vectorizeTree(VectorizableTree[0].get()); 8249 8250 // If the vectorized tree can be rewritten in a smaller type, we truncate the 8251 // vectorized root. InstCombine will then rewrite the entire expression. We 8252 // sign extend the extracted values below. 8253 auto *ScalarRoot = VectorizableTree[0]->Scalars[0]; 8254 if (MinBWs.count(ScalarRoot)) { 8255 if (auto *I = dyn_cast<Instruction>(VectorRoot)) { 8256 // If current instr is a phi and not the last phi, insert it after the 8257 // last phi node. 8258 if (isa<PHINode>(I)) 8259 Builder.SetInsertPoint(&*I->getParent()->getFirstInsertionPt()); 8260 else 8261 Builder.SetInsertPoint(&*++BasicBlock::iterator(I)); 8262 } 8263 auto BundleWidth = VectorizableTree[0]->Scalars.size(); 8264 auto *MinTy = IntegerType::get(F->getContext(), MinBWs[ScalarRoot].first); 8265 auto *VecTy = FixedVectorType::get(MinTy, BundleWidth); 8266 auto *Trunc = Builder.CreateTrunc(VectorRoot, VecTy); 8267 VectorizableTree[0]->VectorizedValue = Trunc; 8268 } 8269 8270 LLVM_DEBUG(dbgs() << "SLP: Extracting " << ExternalUses.size() 8271 << " values .\n"); 8272 8273 SmallVector<ShuffledInsertData> ShuffledInserts; 8274 // Maps vector instruction to original insertelement instruction 8275 DenseMap<Value *, InsertElementInst *> VectorToInsertElement; 8276 // Extract all of the elements with the external uses. 8277 for (const auto &ExternalUse : ExternalUses) { 8278 Value *Scalar = ExternalUse.Scalar; 8279 llvm::User *User = ExternalUse.User; 8280 8281 // Skip users that we already RAUW. This happens when one instruction 8282 // has multiple uses of the same value. 8283 if (User && !is_contained(Scalar->users(), User)) 8284 continue; 8285 TreeEntry *E = getTreeEntry(Scalar); 8286 assert(E && "Invalid scalar"); 8287 assert(E->State != TreeEntry::NeedToGather && 8288 "Extracting from a gather list"); 8289 8290 Value *Vec = E->VectorizedValue; 8291 assert(Vec && "Can't find vectorizable value"); 8292 8293 Value *Lane = Builder.getInt32(ExternalUse.Lane); 8294 auto ExtractAndExtendIfNeeded = [&](Value *Vec) { 8295 if (Scalar->getType() != Vec->getType()) { 8296 Value *Ex; 8297 // "Reuse" the existing extract to improve final codegen. 8298 if (auto *ES = dyn_cast<ExtractElementInst>(Scalar)) { 8299 Ex = Builder.CreateExtractElement(ES->getOperand(0), 8300 ES->getOperand(1)); 8301 } else { 8302 Ex = Builder.CreateExtractElement(Vec, Lane); 8303 } 8304 // If necessary, sign-extend or zero-extend ScalarRoot 8305 // to the larger type. 8306 if (!MinBWs.count(ScalarRoot)) 8307 return Ex; 8308 if (MinBWs[ScalarRoot].second) 8309 return Builder.CreateSExt(Ex, Scalar->getType()); 8310 return Builder.CreateZExt(Ex, Scalar->getType()); 8311 } 8312 assert(isa<FixedVectorType>(Scalar->getType()) && 8313 isa<InsertElementInst>(Scalar) && 8314 "In-tree scalar of vector type is not insertelement?"); 8315 auto *IE = cast<InsertElementInst>(Scalar); 8316 VectorToInsertElement.try_emplace(Vec, IE); 8317 return Vec; 8318 }; 8319 // If User == nullptr, the Scalar is used as extra arg. Generate 8320 // ExtractElement instruction and update the record for this scalar in 8321 // ExternallyUsedValues. 8322 if (!User) { 8323 assert(ExternallyUsedValues.count(Scalar) && 8324 "Scalar with nullptr as an external user must be registered in " 8325 "ExternallyUsedValues map"); 8326 if (auto *VecI = dyn_cast<Instruction>(Vec)) { 8327 Builder.SetInsertPoint(VecI->getParent(), 8328 std::next(VecI->getIterator())); 8329 } else { 8330 Builder.SetInsertPoint(&F->getEntryBlock().front()); 8331 } 8332 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8333 CSEBlocks.insert(cast<Instruction>(Scalar)->getParent()); 8334 auto &NewInstLocs = ExternallyUsedValues[NewInst]; 8335 auto It = ExternallyUsedValues.find(Scalar); 8336 assert(It != ExternallyUsedValues.end() && 8337 "Externally used scalar is not found in ExternallyUsedValues"); 8338 NewInstLocs.append(It->second); 8339 ExternallyUsedValues.erase(Scalar); 8340 // Required to update internally referenced instructions. 8341 Scalar->replaceAllUsesWith(NewInst); 8342 continue; 8343 } 8344 8345 if (auto *VU = dyn_cast<InsertElementInst>(User)) { 8346 // Skip if the scalar is another vector op or Vec is not an instruction. 8347 if (!Scalar->getType()->isVectorTy() && isa<Instruction>(Vec)) { 8348 if (auto *FTy = dyn_cast<FixedVectorType>(User->getType())) { 8349 Optional<unsigned> InsertIdx = getInsertIndex(VU); 8350 if (InsertIdx) { 8351 auto *It = 8352 find_if(ShuffledInserts, [VU](const ShuffledInsertData &Data) { 8353 // Checks if 2 insertelements are from the same buildvector. 8354 InsertElementInst *VecInsert = Data.InsertElements.front(); 8355 return areTwoInsertFromSameBuildVector(VU, VecInsert); 8356 }); 8357 unsigned Idx = *InsertIdx; 8358 if (It == ShuffledInserts.end()) { 8359 (void)ShuffledInserts.emplace_back(); 8360 It = std::next(ShuffledInserts.begin(), 8361 ShuffledInserts.size() - 1); 8362 SmallVectorImpl<int> &Mask = It->ValueMasks[Vec]; 8363 if (Mask.empty()) 8364 Mask.assign(FTy->getNumElements(), UndefMaskElem); 8365 // Find the insertvector, vectorized in tree, if any. 8366 Value *Base = VU; 8367 while (auto *IEBase = dyn_cast<InsertElementInst>(Base)) { 8368 if (IEBase != User && 8369 (!IEBase->hasOneUse() || 8370 getInsertIndex(IEBase).getValueOr(Idx) == Idx)) 8371 break; 8372 // Build the mask for the vectorized insertelement instructions. 8373 if (const TreeEntry *E = getTreeEntry(IEBase)) { 8374 do { 8375 IEBase = cast<InsertElementInst>(Base); 8376 int IEIdx = *getInsertIndex(IEBase); 8377 assert(Mask[Idx] == UndefMaskElem && 8378 "InsertElementInstruction used already."); 8379 Mask[IEIdx] = IEIdx; 8380 Base = IEBase->getOperand(0); 8381 } while (E == getTreeEntry(Base)); 8382 break; 8383 } 8384 Base = cast<InsertElementInst>(Base)->getOperand(0); 8385 // After the vectorization the def-use chain has changed, need 8386 // to look through original insertelement instructions, if they 8387 // get replaced by vector instructions. 8388 auto It = VectorToInsertElement.find(Base); 8389 if (It != VectorToInsertElement.end()) 8390 Base = It->second; 8391 } 8392 } 8393 SmallVectorImpl<int> &Mask = It->ValueMasks[Vec]; 8394 if (Mask.empty()) 8395 Mask.assign(FTy->getNumElements(), UndefMaskElem); 8396 Mask[Idx] = ExternalUse.Lane; 8397 It->InsertElements.push_back(cast<InsertElementInst>(User)); 8398 continue; 8399 } 8400 } 8401 } 8402 } 8403 8404 // Generate extracts for out-of-tree users. 8405 // Find the insertion point for the extractelement lane. 8406 if (auto *VecI = dyn_cast<Instruction>(Vec)) { 8407 if (PHINode *PH = dyn_cast<PHINode>(User)) { 8408 for (int i = 0, e = PH->getNumIncomingValues(); i != e; ++i) { 8409 if (PH->getIncomingValue(i) == Scalar) { 8410 Instruction *IncomingTerminator = 8411 PH->getIncomingBlock(i)->getTerminator(); 8412 if (isa<CatchSwitchInst>(IncomingTerminator)) { 8413 Builder.SetInsertPoint(VecI->getParent(), 8414 std::next(VecI->getIterator())); 8415 } else { 8416 Builder.SetInsertPoint(PH->getIncomingBlock(i)->getTerminator()); 8417 } 8418 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8419 CSEBlocks.insert(PH->getIncomingBlock(i)); 8420 PH->setOperand(i, NewInst); 8421 } 8422 } 8423 } else { 8424 Builder.SetInsertPoint(cast<Instruction>(User)); 8425 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8426 CSEBlocks.insert(cast<Instruction>(User)->getParent()); 8427 User->replaceUsesOfWith(Scalar, NewInst); 8428 } 8429 } else { 8430 Builder.SetInsertPoint(&F->getEntryBlock().front()); 8431 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8432 CSEBlocks.insert(&F->getEntryBlock()); 8433 User->replaceUsesOfWith(Scalar, NewInst); 8434 } 8435 8436 LLVM_DEBUG(dbgs() << "SLP: Replaced:" << *User << ".\n"); 8437 } 8438 8439 // Checks if the mask is an identity mask. 8440 auto &&IsIdentityMask = [](ArrayRef<int> Mask, FixedVectorType *VecTy) { 8441 int Limit = Mask.size(); 8442 return VecTy->getNumElements() == Mask.size() && 8443 all_of(Mask, [Limit](int Idx) { return Idx < Limit; }) && 8444 ShuffleVectorInst::isIdentityMask(Mask); 8445 }; 8446 // Tries to combine 2 different masks into single one. 8447 auto &&CombineMasks = [](SmallVectorImpl<int> &Mask, ArrayRef<int> ExtMask) { 8448 SmallVector<int> NewMask(ExtMask.size(), UndefMaskElem); 8449 for (int I = 0, Sz = ExtMask.size(); I < Sz; ++I) { 8450 if (ExtMask[I] == UndefMaskElem) 8451 continue; 8452 NewMask[I] = Mask[ExtMask[I]]; 8453 } 8454 Mask.swap(NewMask); 8455 }; 8456 // Peek through shuffles, trying to simplify the final shuffle code. 8457 auto &&PeekThroughShuffles = 8458 [&IsIdentityMask, &CombineMasks](Value *&V, SmallVectorImpl<int> &Mask, 8459 bool CheckForLengthChange = false) { 8460 while (auto *SV = dyn_cast<ShuffleVectorInst>(V)) { 8461 // Exit if not a fixed vector type or changing size shuffle. 8462 if (!isa<FixedVectorType>(SV->getType()) || 8463 (CheckForLengthChange && SV->changesLength())) 8464 break; 8465 // Exit if the identity or broadcast mask is found. 8466 if (IsIdentityMask(Mask, cast<FixedVectorType>(SV->getType())) || 8467 SV->isZeroEltSplat()) 8468 break; 8469 bool IsOp1Undef = isUndefVector(SV->getOperand(0)); 8470 bool IsOp2Undef = isUndefVector(SV->getOperand(1)); 8471 if (!IsOp1Undef && !IsOp2Undef) 8472 break; 8473 SmallVector<int> ShuffleMask(SV->getShuffleMask().begin(), 8474 SV->getShuffleMask().end()); 8475 CombineMasks(ShuffleMask, Mask); 8476 Mask.swap(ShuffleMask); 8477 if (IsOp2Undef) 8478 V = SV->getOperand(0); 8479 else 8480 V = SV->getOperand(1); 8481 } 8482 }; 8483 // Smart shuffle instruction emission, walks through shuffles trees and 8484 // tries to find the best matching vector for the actual shuffle 8485 // instruction. 8486 auto &&CreateShuffle = [this, &IsIdentityMask, &PeekThroughShuffles, 8487 &CombineMasks](Value *V1, Value *V2, 8488 ArrayRef<int> Mask) -> Value * { 8489 assert(V1 && "Expected at least one vector value."); 8490 if (V2 && !isUndefVector(V2)) { 8491 // Peek through shuffles. 8492 Value *Op1 = V1; 8493 Value *Op2 = V2; 8494 int VF = 8495 cast<VectorType>(V1->getType())->getElementCount().getKnownMinValue(); 8496 SmallVector<int> CombinedMask1(Mask.size(), UndefMaskElem); 8497 SmallVector<int> CombinedMask2(Mask.size(), UndefMaskElem); 8498 for (int I = 0, E = Mask.size(); I < E; ++I) { 8499 if (Mask[I] < VF) 8500 CombinedMask1[I] = Mask[I]; 8501 else 8502 CombinedMask2[I] = Mask[I] - VF; 8503 } 8504 Value *PrevOp1; 8505 Value *PrevOp2; 8506 do { 8507 PrevOp1 = Op1; 8508 PrevOp2 = Op2; 8509 PeekThroughShuffles(Op1, CombinedMask1, /*CheckForLengthChange=*/true); 8510 PeekThroughShuffles(Op2, CombinedMask2, /*CheckForLengthChange=*/true); 8511 // Check if we have 2 resizing shuffles - need to peek through operands 8512 // again. 8513 if (auto *SV1 = dyn_cast<ShuffleVectorInst>(Op1)) 8514 if (auto *SV2 = dyn_cast<ShuffleVectorInst>(Op2)) 8515 if (SV1->getOperand(0)->getType() == 8516 SV2->getOperand(0)->getType() && 8517 SV1->getOperand(0)->getType() != SV1->getType() && 8518 isUndefVector(SV1->getOperand(1)) && 8519 isUndefVector(SV2->getOperand(1))) { 8520 Op1 = SV1->getOperand(0); 8521 Op2 = SV2->getOperand(0); 8522 SmallVector<int> ShuffleMask1(SV1->getShuffleMask().begin(), 8523 SV1->getShuffleMask().end()); 8524 CombineMasks(ShuffleMask1, CombinedMask1); 8525 CombinedMask1.swap(ShuffleMask1); 8526 SmallVector<int> ShuffleMask2(SV2->getShuffleMask().begin(), 8527 SV2->getShuffleMask().end()); 8528 CombineMasks(ShuffleMask2, CombinedMask2); 8529 CombinedMask2.swap(ShuffleMask2); 8530 } 8531 } while (PrevOp1 != Op1 || PrevOp2 != Op2); 8532 VF = cast<VectorType>(Op1->getType()) 8533 ->getElementCount() 8534 .getKnownMinValue(); 8535 for (int I = 0, E = Mask.size(); I < E; ++I) { 8536 if (CombinedMask2[I] != UndefMaskElem) { 8537 assert(CombinedMask1[I] == UndefMaskElem && 8538 "Expected undefined mask element"); 8539 CombinedMask1[I] = CombinedMask2[I] + (Op1 == Op2 ? 0 : VF); 8540 } 8541 } 8542 Value *Vec = Builder.CreateShuffleVector( 8543 Op1, Op1 == Op2 ? PoisonValue::get(Op1->getType()) : Op2, 8544 CombinedMask1); 8545 if (auto *I = dyn_cast<Instruction>(Vec)) { 8546 GatherShuffleSeq.insert(I); 8547 CSEBlocks.insert(I->getParent()); 8548 } 8549 return Vec; 8550 } 8551 if (isa<PoisonValue>(V1)) 8552 return PoisonValue::get(FixedVectorType::get( 8553 cast<VectorType>(V1->getType())->getElementType(), Mask.size())); 8554 Value *Op = V1; 8555 SmallVector<int> CombinedMask(Mask.begin(), Mask.end()); 8556 PeekThroughShuffles(Op, CombinedMask); 8557 if (!isa<FixedVectorType>(Op->getType()) || 8558 !IsIdentityMask(CombinedMask, cast<FixedVectorType>(Op->getType()))) { 8559 Value *Vec = Builder.CreateShuffleVector(Op, CombinedMask); 8560 if (auto *I = dyn_cast<Instruction>(Vec)) { 8561 GatherShuffleSeq.insert(I); 8562 CSEBlocks.insert(I->getParent()); 8563 } 8564 return Vec; 8565 } 8566 return Op; 8567 }; 8568 8569 auto &&ResizeToVF = [&CreateShuffle](Value *Vec, ArrayRef<int> Mask) { 8570 unsigned VF = Mask.size(); 8571 unsigned VecVF = cast<FixedVectorType>(Vec->getType())->getNumElements(); 8572 if (VF != VecVF) { 8573 if (any_of(Mask, [VF](int Idx) { return Idx >= static_cast<int>(VF); })) { 8574 Vec = CreateShuffle(Vec, nullptr, Mask); 8575 return std::make_pair(Vec, true); 8576 } 8577 SmallVector<int> ResizeMask(VF, UndefMaskElem); 8578 for (unsigned I = 0; I < VF; ++I) { 8579 if (Mask[I] != UndefMaskElem) 8580 ResizeMask[Mask[I]] = Mask[I]; 8581 } 8582 Vec = CreateShuffle(Vec, nullptr, ResizeMask); 8583 } 8584 8585 return std::make_pair(Vec, false); 8586 }; 8587 // Perform shuffling of the vectorize tree entries for better handling of 8588 // external extracts. 8589 for (int I = 0, E = ShuffledInserts.size(); I < E; ++I) { 8590 // Find the first and the last instruction in the list of insertelements. 8591 sort(ShuffledInserts[I].InsertElements, isFirstInsertElement); 8592 InsertElementInst *FirstInsert = ShuffledInserts[I].InsertElements.front(); 8593 InsertElementInst *LastInsert = ShuffledInserts[I].InsertElements.back(); 8594 Builder.SetInsertPoint(LastInsert); 8595 auto Vector = ShuffledInserts[I].ValueMasks.takeVector(); 8596 Value *NewInst = performExtractsShuffleAction<Value>( 8597 makeMutableArrayRef(Vector.data(), Vector.size()), 8598 FirstInsert->getOperand(0), 8599 [](Value *Vec) { 8600 return cast<VectorType>(Vec->getType()) 8601 ->getElementCount() 8602 .getKnownMinValue(); 8603 }, 8604 ResizeToVF, 8605 [FirstInsert, &CreateShuffle](ArrayRef<int> Mask, 8606 ArrayRef<Value *> Vals) { 8607 assert((Vals.size() == 1 || Vals.size() == 2) && 8608 "Expected exactly 1 or 2 input values."); 8609 if (Vals.size() == 1) { 8610 // Do not create shuffle if the mask is a simple identity 8611 // non-resizing mask. 8612 if (Mask.size() != cast<FixedVectorType>(Vals.front()->getType()) 8613 ->getNumElements() || 8614 !ShuffleVectorInst::isIdentityMask(Mask)) 8615 return CreateShuffle(Vals.front(), nullptr, Mask); 8616 return Vals.front(); 8617 } 8618 return CreateShuffle(Vals.front() ? Vals.front() 8619 : FirstInsert->getOperand(0), 8620 Vals.back(), Mask); 8621 }); 8622 auto It = ShuffledInserts[I].InsertElements.rbegin(); 8623 // Rebuild buildvector chain. 8624 InsertElementInst *II = nullptr; 8625 if (It != ShuffledInserts[I].InsertElements.rend()) 8626 II = *It; 8627 SmallVector<Instruction *> Inserts; 8628 while (It != ShuffledInserts[I].InsertElements.rend()) { 8629 assert(II && "Must be an insertelement instruction."); 8630 if (*It == II) 8631 ++It; 8632 else 8633 Inserts.push_back(cast<Instruction>(II)); 8634 II = dyn_cast<InsertElementInst>(II->getOperand(0)); 8635 } 8636 for (Instruction *II : reverse(Inserts)) { 8637 II->replaceUsesOfWith(II->getOperand(0), NewInst); 8638 if (auto *NewI = dyn_cast<Instruction>(NewInst)) 8639 if (II->getParent() == NewI->getParent() && II->comesBefore(NewI)) 8640 II->moveAfter(NewI); 8641 NewInst = II; 8642 } 8643 LastInsert->replaceAllUsesWith(NewInst); 8644 for (InsertElementInst *IE : reverse(ShuffledInserts[I].InsertElements)) { 8645 IE->replaceUsesOfWith(IE->getOperand(1), 8646 PoisonValue::get(IE->getOperand(1)->getType())); 8647 eraseInstruction(IE); 8648 } 8649 CSEBlocks.insert(LastInsert->getParent()); 8650 } 8651 8652 // For each vectorized value: 8653 for (auto &TEPtr : VectorizableTree) { 8654 TreeEntry *Entry = TEPtr.get(); 8655 8656 // No need to handle users of gathered values. 8657 if (Entry->State == TreeEntry::NeedToGather) 8658 continue; 8659 8660 assert(Entry->VectorizedValue && "Can't find vectorizable value"); 8661 8662 // For each lane: 8663 for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) { 8664 Value *Scalar = Entry->Scalars[Lane]; 8665 8666 #ifndef NDEBUG 8667 Type *Ty = Scalar->getType(); 8668 if (!Ty->isVoidTy()) { 8669 for (User *U : Scalar->users()) { 8670 LLVM_DEBUG(dbgs() << "SLP: \tvalidating user:" << *U << ".\n"); 8671 8672 // It is legal to delete users in the ignorelist. 8673 assert((getTreeEntry(U) || 8674 (UserIgnoreList && UserIgnoreList->contains(U)) || 8675 (isa_and_nonnull<Instruction>(U) && 8676 isDeleted(cast<Instruction>(U)))) && 8677 "Deleting out-of-tree value"); 8678 } 8679 } 8680 #endif 8681 LLVM_DEBUG(dbgs() << "SLP: \tErasing scalar:" << *Scalar << ".\n"); 8682 eraseInstruction(cast<Instruction>(Scalar)); 8683 } 8684 } 8685 8686 Builder.ClearInsertionPoint(); 8687 InstrElementSize.clear(); 8688 8689 return VectorizableTree[0]->VectorizedValue; 8690 } 8691 8692 void BoUpSLP::optimizeGatherSequence() { 8693 LLVM_DEBUG(dbgs() << "SLP: Optimizing " << GatherShuffleSeq.size() 8694 << " gather sequences instructions.\n"); 8695 // LICM InsertElementInst sequences. 8696 for (Instruction *I : GatherShuffleSeq) { 8697 if (isDeleted(I)) 8698 continue; 8699 8700 // Check if this block is inside a loop. 8701 Loop *L = LI->getLoopFor(I->getParent()); 8702 if (!L) 8703 continue; 8704 8705 // Check if it has a preheader. 8706 BasicBlock *PreHeader = L->getLoopPreheader(); 8707 if (!PreHeader) 8708 continue; 8709 8710 // If the vector or the element that we insert into it are 8711 // instructions that are defined in this basic block then we can't 8712 // hoist this instruction. 8713 if (any_of(I->operands(), [L](Value *V) { 8714 auto *OpI = dyn_cast<Instruction>(V); 8715 return OpI && L->contains(OpI); 8716 })) 8717 continue; 8718 8719 // We can hoist this instruction. Move it to the pre-header. 8720 I->moveBefore(PreHeader->getTerminator()); 8721 } 8722 8723 // Make a list of all reachable blocks in our CSE queue. 8724 SmallVector<const DomTreeNode *, 8> CSEWorkList; 8725 CSEWorkList.reserve(CSEBlocks.size()); 8726 for (BasicBlock *BB : CSEBlocks) 8727 if (DomTreeNode *N = DT->getNode(BB)) { 8728 assert(DT->isReachableFromEntry(N)); 8729 CSEWorkList.push_back(N); 8730 } 8731 8732 // Sort blocks by domination. This ensures we visit a block after all blocks 8733 // dominating it are visited. 8734 llvm::sort(CSEWorkList, [](const DomTreeNode *A, const DomTreeNode *B) { 8735 assert((A == B) == (A->getDFSNumIn() == B->getDFSNumIn()) && 8736 "Different nodes should have different DFS numbers"); 8737 return A->getDFSNumIn() < B->getDFSNumIn(); 8738 }); 8739 8740 // Less defined shuffles can be replaced by the more defined copies. 8741 // Between two shuffles one is less defined if it has the same vector operands 8742 // and its mask indeces are the same as in the first one or undefs. E.g. 8743 // shuffle %0, poison, <0, 0, 0, undef> is less defined than shuffle %0, 8744 // poison, <0, 0, 0, 0>. 8745 auto &&IsIdenticalOrLessDefined = [this](Instruction *I1, Instruction *I2, 8746 SmallVectorImpl<int> &NewMask) { 8747 if (I1->getType() != I2->getType()) 8748 return false; 8749 auto *SI1 = dyn_cast<ShuffleVectorInst>(I1); 8750 auto *SI2 = dyn_cast<ShuffleVectorInst>(I2); 8751 if (!SI1 || !SI2) 8752 return I1->isIdenticalTo(I2); 8753 if (SI1->isIdenticalTo(SI2)) 8754 return true; 8755 for (int I = 0, E = SI1->getNumOperands(); I < E; ++I) 8756 if (SI1->getOperand(I) != SI2->getOperand(I)) 8757 return false; 8758 // Check if the second instruction is more defined than the first one. 8759 NewMask.assign(SI2->getShuffleMask().begin(), SI2->getShuffleMask().end()); 8760 ArrayRef<int> SM1 = SI1->getShuffleMask(); 8761 // Count trailing undefs in the mask to check the final number of used 8762 // registers. 8763 unsigned LastUndefsCnt = 0; 8764 for (int I = 0, E = NewMask.size(); I < E; ++I) { 8765 if (SM1[I] == UndefMaskElem) 8766 ++LastUndefsCnt; 8767 else 8768 LastUndefsCnt = 0; 8769 if (NewMask[I] != UndefMaskElem && SM1[I] != UndefMaskElem && 8770 NewMask[I] != SM1[I]) 8771 return false; 8772 if (NewMask[I] == UndefMaskElem) 8773 NewMask[I] = SM1[I]; 8774 } 8775 // Check if the last undefs actually change the final number of used vector 8776 // registers. 8777 return SM1.size() - LastUndefsCnt > 1 && 8778 TTI->getNumberOfParts(SI1->getType()) == 8779 TTI->getNumberOfParts( 8780 FixedVectorType::get(SI1->getType()->getElementType(), 8781 SM1.size() - LastUndefsCnt)); 8782 }; 8783 // Perform O(N^2) search over the gather/shuffle sequences and merge identical 8784 // instructions. TODO: We can further optimize this scan if we split the 8785 // instructions into different buckets based on the insert lane. 8786 SmallVector<Instruction *, 16> Visited; 8787 for (auto I = CSEWorkList.begin(), E = CSEWorkList.end(); I != E; ++I) { 8788 assert(*I && 8789 (I == CSEWorkList.begin() || !DT->dominates(*I, *std::prev(I))) && 8790 "Worklist not sorted properly!"); 8791 BasicBlock *BB = (*I)->getBlock(); 8792 // For all instructions in blocks containing gather sequences: 8793 for (Instruction &In : llvm::make_early_inc_range(*BB)) { 8794 if (isDeleted(&In)) 8795 continue; 8796 if (!isa<InsertElementInst>(&In) && !isa<ExtractElementInst>(&In) && 8797 !isa<ShuffleVectorInst>(&In) && !GatherShuffleSeq.contains(&In)) 8798 continue; 8799 8800 // Check if we can replace this instruction with any of the 8801 // visited instructions. 8802 bool Replaced = false; 8803 for (Instruction *&V : Visited) { 8804 SmallVector<int> NewMask; 8805 if (IsIdenticalOrLessDefined(&In, V, NewMask) && 8806 DT->dominates(V->getParent(), In.getParent())) { 8807 In.replaceAllUsesWith(V); 8808 eraseInstruction(&In); 8809 if (auto *SI = dyn_cast<ShuffleVectorInst>(V)) 8810 if (!NewMask.empty()) 8811 SI->setShuffleMask(NewMask); 8812 Replaced = true; 8813 break; 8814 } 8815 if (isa<ShuffleVectorInst>(In) && isa<ShuffleVectorInst>(V) && 8816 GatherShuffleSeq.contains(V) && 8817 IsIdenticalOrLessDefined(V, &In, NewMask) && 8818 DT->dominates(In.getParent(), V->getParent())) { 8819 In.moveAfter(V); 8820 V->replaceAllUsesWith(&In); 8821 eraseInstruction(V); 8822 if (auto *SI = dyn_cast<ShuffleVectorInst>(&In)) 8823 if (!NewMask.empty()) 8824 SI->setShuffleMask(NewMask); 8825 V = &In; 8826 Replaced = true; 8827 break; 8828 } 8829 } 8830 if (!Replaced) { 8831 assert(!is_contained(Visited, &In)); 8832 Visited.push_back(&In); 8833 } 8834 } 8835 } 8836 CSEBlocks.clear(); 8837 GatherShuffleSeq.clear(); 8838 } 8839 8840 BoUpSLP::ScheduleData * 8841 BoUpSLP::BlockScheduling::buildBundle(ArrayRef<Value *> VL) { 8842 ScheduleData *Bundle = nullptr; 8843 ScheduleData *PrevInBundle = nullptr; 8844 for (Value *V : VL) { 8845 if (doesNotNeedToBeScheduled(V)) 8846 continue; 8847 ScheduleData *BundleMember = getScheduleData(V); 8848 assert(BundleMember && 8849 "no ScheduleData for bundle member " 8850 "(maybe not in same basic block)"); 8851 assert(BundleMember->isSchedulingEntity() && 8852 "bundle member already part of other bundle"); 8853 if (PrevInBundle) { 8854 PrevInBundle->NextInBundle = BundleMember; 8855 } else { 8856 Bundle = BundleMember; 8857 } 8858 8859 // Group the instructions to a bundle. 8860 BundleMember->FirstInBundle = Bundle; 8861 PrevInBundle = BundleMember; 8862 } 8863 assert(Bundle && "Failed to find schedule bundle"); 8864 return Bundle; 8865 } 8866 8867 // Groups the instructions to a bundle (which is then a single scheduling entity) 8868 // and schedules instructions until the bundle gets ready. 8869 Optional<BoUpSLP::ScheduleData *> 8870 BoUpSLP::BlockScheduling::tryScheduleBundle(ArrayRef<Value *> VL, BoUpSLP *SLP, 8871 const InstructionsState &S) { 8872 // No need to schedule PHIs, insertelement, extractelement and extractvalue 8873 // instructions. 8874 if (isa<PHINode>(S.OpValue) || isVectorLikeInstWithConstOps(S.OpValue) || 8875 doesNotNeedToSchedule(VL)) 8876 return nullptr; 8877 8878 // Initialize the instruction bundle. 8879 Instruction *OldScheduleEnd = ScheduleEnd; 8880 LLVM_DEBUG(dbgs() << "SLP: bundle: " << *S.OpValue << "\n"); 8881 8882 auto TryScheduleBundleImpl = [this, OldScheduleEnd, SLP](bool ReSchedule, 8883 ScheduleData *Bundle) { 8884 // The scheduling region got new instructions at the lower end (or it is a 8885 // new region for the first bundle). This makes it necessary to 8886 // recalculate all dependencies. 8887 // It is seldom that this needs to be done a second time after adding the 8888 // initial bundle to the region. 8889 if (ScheduleEnd != OldScheduleEnd) { 8890 for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) 8891 doForAllOpcodes(I, [](ScheduleData *SD) { SD->clearDependencies(); }); 8892 ReSchedule = true; 8893 } 8894 if (Bundle) { 8895 LLVM_DEBUG(dbgs() << "SLP: try schedule bundle " << *Bundle 8896 << " in block " << BB->getName() << "\n"); 8897 calculateDependencies(Bundle, /*InsertInReadyList=*/true, SLP); 8898 } 8899 8900 if (ReSchedule) { 8901 resetSchedule(); 8902 initialFillReadyList(ReadyInsts); 8903 } 8904 8905 // Now try to schedule the new bundle or (if no bundle) just calculate 8906 // dependencies. As soon as the bundle is "ready" it means that there are no 8907 // cyclic dependencies and we can schedule it. Note that's important that we 8908 // don't "schedule" the bundle yet (see cancelScheduling). 8909 while (((!Bundle && ReSchedule) || (Bundle && !Bundle->isReady())) && 8910 !ReadyInsts.empty()) { 8911 ScheduleData *Picked = ReadyInsts.pop_back_val(); 8912 assert(Picked->isSchedulingEntity() && Picked->isReady() && 8913 "must be ready to schedule"); 8914 schedule(Picked, ReadyInsts); 8915 } 8916 }; 8917 8918 // Make sure that the scheduling region contains all 8919 // instructions of the bundle. 8920 for (Value *V : VL) { 8921 if (doesNotNeedToBeScheduled(V)) 8922 continue; 8923 if (!extendSchedulingRegion(V, S)) { 8924 // If the scheduling region got new instructions at the lower end (or it 8925 // is a new region for the first bundle). This makes it necessary to 8926 // recalculate all dependencies. 8927 // Otherwise the compiler may crash trying to incorrectly calculate 8928 // dependencies and emit instruction in the wrong order at the actual 8929 // scheduling. 8930 TryScheduleBundleImpl(/*ReSchedule=*/false, nullptr); 8931 return None; 8932 } 8933 } 8934 8935 bool ReSchedule = false; 8936 for (Value *V : VL) { 8937 if (doesNotNeedToBeScheduled(V)) 8938 continue; 8939 ScheduleData *BundleMember = getScheduleData(V); 8940 assert(BundleMember && 8941 "no ScheduleData for bundle member (maybe not in same basic block)"); 8942 8943 // Make sure we don't leave the pieces of the bundle in the ready list when 8944 // whole bundle might not be ready. 8945 ReadyInsts.remove(BundleMember); 8946 8947 if (!BundleMember->IsScheduled) 8948 continue; 8949 // A bundle member was scheduled as single instruction before and now 8950 // needs to be scheduled as part of the bundle. We just get rid of the 8951 // existing schedule. 8952 LLVM_DEBUG(dbgs() << "SLP: reset schedule because " << *BundleMember 8953 << " was already scheduled\n"); 8954 ReSchedule = true; 8955 } 8956 8957 auto *Bundle = buildBundle(VL); 8958 TryScheduleBundleImpl(ReSchedule, Bundle); 8959 if (!Bundle->isReady()) { 8960 cancelScheduling(VL, S.OpValue); 8961 return None; 8962 } 8963 return Bundle; 8964 } 8965 8966 void BoUpSLP::BlockScheduling::cancelScheduling(ArrayRef<Value *> VL, 8967 Value *OpValue) { 8968 if (isa<PHINode>(OpValue) || isVectorLikeInstWithConstOps(OpValue) || 8969 doesNotNeedToSchedule(VL)) 8970 return; 8971 8972 if (doesNotNeedToBeScheduled(OpValue)) 8973 OpValue = *find_if_not(VL, doesNotNeedToBeScheduled); 8974 ScheduleData *Bundle = getScheduleData(OpValue); 8975 LLVM_DEBUG(dbgs() << "SLP: cancel scheduling of " << *Bundle << "\n"); 8976 assert(!Bundle->IsScheduled && 8977 "Can't cancel bundle which is already scheduled"); 8978 assert(Bundle->isSchedulingEntity() && 8979 (Bundle->isPartOfBundle() || needToScheduleSingleInstruction(VL)) && 8980 "tried to unbundle something which is not a bundle"); 8981 8982 // Remove the bundle from the ready list. 8983 if (Bundle->isReady()) 8984 ReadyInsts.remove(Bundle); 8985 8986 // Un-bundle: make single instructions out of the bundle. 8987 ScheduleData *BundleMember = Bundle; 8988 while (BundleMember) { 8989 assert(BundleMember->FirstInBundle == Bundle && "corrupt bundle links"); 8990 BundleMember->FirstInBundle = BundleMember; 8991 ScheduleData *Next = BundleMember->NextInBundle; 8992 BundleMember->NextInBundle = nullptr; 8993 BundleMember->TE = nullptr; 8994 if (BundleMember->unscheduledDepsInBundle() == 0) { 8995 ReadyInsts.insert(BundleMember); 8996 } 8997 BundleMember = Next; 8998 } 8999 } 9000 9001 BoUpSLP::ScheduleData *BoUpSLP::BlockScheduling::allocateScheduleDataChunks() { 9002 // Allocate a new ScheduleData for the instruction. 9003 if (ChunkPos >= ChunkSize) { 9004 ScheduleDataChunks.push_back(std::make_unique<ScheduleData[]>(ChunkSize)); 9005 ChunkPos = 0; 9006 } 9007 return &(ScheduleDataChunks.back()[ChunkPos++]); 9008 } 9009 9010 bool BoUpSLP::BlockScheduling::extendSchedulingRegion(Value *V, 9011 const InstructionsState &S) { 9012 if (getScheduleData(V, isOneOf(S, V))) 9013 return true; 9014 Instruction *I = dyn_cast<Instruction>(V); 9015 assert(I && "bundle member must be an instruction"); 9016 assert(!isa<PHINode>(I) && !isVectorLikeInstWithConstOps(I) && 9017 !doesNotNeedToBeScheduled(I) && 9018 "phi nodes/insertelements/extractelements/extractvalues don't need to " 9019 "be scheduled"); 9020 auto &&CheckScheduleForI = [this, &S](Instruction *I) -> bool { 9021 ScheduleData *ISD = getScheduleData(I); 9022 if (!ISD) 9023 return false; 9024 assert(isInSchedulingRegion(ISD) && 9025 "ScheduleData not in scheduling region"); 9026 ScheduleData *SD = allocateScheduleDataChunks(); 9027 SD->Inst = I; 9028 SD->init(SchedulingRegionID, S.OpValue); 9029 ExtraScheduleDataMap[I][S.OpValue] = SD; 9030 return true; 9031 }; 9032 if (CheckScheduleForI(I)) 9033 return true; 9034 if (!ScheduleStart) { 9035 // It's the first instruction in the new region. 9036 initScheduleData(I, I->getNextNode(), nullptr, nullptr); 9037 ScheduleStart = I; 9038 ScheduleEnd = I->getNextNode(); 9039 if (isOneOf(S, I) != I) 9040 CheckScheduleForI(I); 9041 assert(ScheduleEnd && "tried to vectorize a terminator?"); 9042 LLVM_DEBUG(dbgs() << "SLP: initialize schedule region to " << *I << "\n"); 9043 return true; 9044 } 9045 // Search up and down at the same time, because we don't know if the new 9046 // instruction is above or below the existing scheduling region. 9047 BasicBlock::reverse_iterator UpIter = 9048 ++ScheduleStart->getIterator().getReverse(); 9049 BasicBlock::reverse_iterator UpperEnd = BB->rend(); 9050 BasicBlock::iterator DownIter = ScheduleEnd->getIterator(); 9051 BasicBlock::iterator LowerEnd = BB->end(); 9052 while (UpIter != UpperEnd && DownIter != LowerEnd && &*UpIter != I && 9053 &*DownIter != I) { 9054 if (++ScheduleRegionSize > ScheduleRegionSizeLimit) { 9055 LLVM_DEBUG(dbgs() << "SLP: exceeded schedule region size limit\n"); 9056 return false; 9057 } 9058 9059 ++UpIter; 9060 ++DownIter; 9061 } 9062 if (DownIter == LowerEnd || (UpIter != UpperEnd && &*UpIter == I)) { 9063 assert(I->getParent() == ScheduleStart->getParent() && 9064 "Instruction is in wrong basic block."); 9065 initScheduleData(I, ScheduleStart, nullptr, FirstLoadStoreInRegion); 9066 ScheduleStart = I; 9067 if (isOneOf(S, I) != I) 9068 CheckScheduleForI(I); 9069 LLVM_DEBUG(dbgs() << "SLP: extend schedule region start to " << *I 9070 << "\n"); 9071 return true; 9072 } 9073 assert((UpIter == UpperEnd || (DownIter != LowerEnd && &*DownIter == I)) && 9074 "Expected to reach top of the basic block or instruction down the " 9075 "lower end."); 9076 assert(I->getParent() == ScheduleEnd->getParent() && 9077 "Instruction is in wrong basic block."); 9078 initScheduleData(ScheduleEnd, I->getNextNode(), LastLoadStoreInRegion, 9079 nullptr); 9080 ScheduleEnd = I->getNextNode(); 9081 if (isOneOf(S, I) != I) 9082 CheckScheduleForI(I); 9083 assert(ScheduleEnd && "tried to vectorize a terminator?"); 9084 LLVM_DEBUG(dbgs() << "SLP: extend schedule region end to " << *I << "\n"); 9085 return true; 9086 } 9087 9088 void BoUpSLP::BlockScheduling::initScheduleData(Instruction *FromI, 9089 Instruction *ToI, 9090 ScheduleData *PrevLoadStore, 9091 ScheduleData *NextLoadStore) { 9092 ScheduleData *CurrentLoadStore = PrevLoadStore; 9093 for (Instruction *I = FromI; I != ToI; I = I->getNextNode()) { 9094 // No need to allocate data for non-schedulable instructions. 9095 if (doesNotNeedToBeScheduled(I)) 9096 continue; 9097 ScheduleData *SD = ScheduleDataMap.lookup(I); 9098 if (!SD) { 9099 SD = allocateScheduleDataChunks(); 9100 ScheduleDataMap[I] = SD; 9101 SD->Inst = I; 9102 } 9103 assert(!isInSchedulingRegion(SD) && 9104 "new ScheduleData already in scheduling region"); 9105 SD->init(SchedulingRegionID, I); 9106 9107 if (I->mayReadOrWriteMemory() && 9108 (!isa<IntrinsicInst>(I) || 9109 (cast<IntrinsicInst>(I)->getIntrinsicID() != Intrinsic::sideeffect && 9110 cast<IntrinsicInst>(I)->getIntrinsicID() != 9111 Intrinsic::pseudoprobe))) { 9112 // Update the linked list of memory accessing instructions. 9113 if (CurrentLoadStore) { 9114 CurrentLoadStore->NextLoadStore = SD; 9115 } else { 9116 FirstLoadStoreInRegion = SD; 9117 } 9118 CurrentLoadStore = SD; 9119 } 9120 9121 if (match(I, m_Intrinsic<Intrinsic::stacksave>()) || 9122 match(I, m_Intrinsic<Intrinsic::stackrestore>())) 9123 RegionHasStackSave = true; 9124 } 9125 if (NextLoadStore) { 9126 if (CurrentLoadStore) 9127 CurrentLoadStore->NextLoadStore = NextLoadStore; 9128 } else { 9129 LastLoadStoreInRegion = CurrentLoadStore; 9130 } 9131 } 9132 9133 void BoUpSLP::BlockScheduling::calculateDependencies(ScheduleData *SD, 9134 bool InsertInReadyList, 9135 BoUpSLP *SLP) { 9136 assert(SD->isSchedulingEntity()); 9137 9138 SmallVector<ScheduleData *, 10> WorkList; 9139 WorkList.push_back(SD); 9140 9141 while (!WorkList.empty()) { 9142 ScheduleData *SD = WorkList.pop_back_val(); 9143 for (ScheduleData *BundleMember = SD; BundleMember; 9144 BundleMember = BundleMember->NextInBundle) { 9145 assert(isInSchedulingRegion(BundleMember)); 9146 if (BundleMember->hasValidDependencies()) 9147 continue; 9148 9149 LLVM_DEBUG(dbgs() << "SLP: update deps of " << *BundleMember 9150 << "\n"); 9151 BundleMember->Dependencies = 0; 9152 BundleMember->resetUnscheduledDeps(); 9153 9154 // Handle def-use chain dependencies. 9155 if (BundleMember->OpValue != BundleMember->Inst) { 9156 if (ScheduleData *UseSD = getScheduleData(BundleMember->Inst)) { 9157 BundleMember->Dependencies++; 9158 ScheduleData *DestBundle = UseSD->FirstInBundle; 9159 if (!DestBundle->IsScheduled) 9160 BundleMember->incrementUnscheduledDeps(1); 9161 if (!DestBundle->hasValidDependencies()) 9162 WorkList.push_back(DestBundle); 9163 } 9164 } else { 9165 for (User *U : BundleMember->Inst->users()) { 9166 if (ScheduleData *UseSD = getScheduleData(cast<Instruction>(U))) { 9167 BundleMember->Dependencies++; 9168 ScheduleData *DestBundle = UseSD->FirstInBundle; 9169 if (!DestBundle->IsScheduled) 9170 BundleMember->incrementUnscheduledDeps(1); 9171 if (!DestBundle->hasValidDependencies()) 9172 WorkList.push_back(DestBundle); 9173 } 9174 } 9175 } 9176 9177 auto makeControlDependent = [&](Instruction *I) { 9178 auto *DepDest = getScheduleData(I); 9179 assert(DepDest && "must be in schedule window"); 9180 DepDest->ControlDependencies.push_back(BundleMember); 9181 BundleMember->Dependencies++; 9182 ScheduleData *DestBundle = DepDest->FirstInBundle; 9183 if (!DestBundle->IsScheduled) 9184 BundleMember->incrementUnscheduledDeps(1); 9185 if (!DestBundle->hasValidDependencies()) 9186 WorkList.push_back(DestBundle); 9187 }; 9188 9189 // Any instruction which isn't safe to speculate at the begining of the 9190 // block is control dependend on any early exit or non-willreturn call 9191 // which proceeds it. 9192 if (!isGuaranteedToTransferExecutionToSuccessor(BundleMember->Inst)) { 9193 for (Instruction *I = BundleMember->Inst->getNextNode(); 9194 I != ScheduleEnd; I = I->getNextNode()) { 9195 if (isSafeToSpeculativelyExecute(I, &*BB->begin())) 9196 continue; 9197 9198 // Add the dependency 9199 makeControlDependent(I); 9200 9201 if (!isGuaranteedToTransferExecutionToSuccessor(I)) 9202 // Everything past here must be control dependent on I. 9203 break; 9204 } 9205 } 9206 9207 if (RegionHasStackSave) { 9208 // If we have an inalloc alloca instruction, it needs to be scheduled 9209 // after any preceeding stacksave. We also need to prevent any alloca 9210 // from reordering above a preceeding stackrestore. 9211 if (match(BundleMember->Inst, m_Intrinsic<Intrinsic::stacksave>()) || 9212 match(BundleMember->Inst, m_Intrinsic<Intrinsic::stackrestore>())) { 9213 for (Instruction *I = BundleMember->Inst->getNextNode(); 9214 I != ScheduleEnd; I = I->getNextNode()) { 9215 if (match(I, m_Intrinsic<Intrinsic::stacksave>()) || 9216 match(I, m_Intrinsic<Intrinsic::stackrestore>())) 9217 // Any allocas past here must be control dependent on I, and I 9218 // must be memory dependend on BundleMember->Inst. 9219 break; 9220 9221 if (!isa<AllocaInst>(I)) 9222 continue; 9223 9224 // Add the dependency 9225 makeControlDependent(I); 9226 } 9227 } 9228 9229 // In addition to the cases handle just above, we need to prevent 9230 // allocas from moving below a stacksave. The stackrestore case 9231 // is currently thought to be conservatism. 9232 if (isa<AllocaInst>(BundleMember->Inst)) { 9233 for (Instruction *I = BundleMember->Inst->getNextNode(); 9234 I != ScheduleEnd; I = I->getNextNode()) { 9235 if (!match(I, m_Intrinsic<Intrinsic::stacksave>()) && 9236 !match(I, m_Intrinsic<Intrinsic::stackrestore>())) 9237 continue; 9238 9239 // Add the dependency 9240 makeControlDependent(I); 9241 break; 9242 } 9243 } 9244 } 9245 9246 // Handle the memory dependencies (if any). 9247 ScheduleData *DepDest = BundleMember->NextLoadStore; 9248 if (!DepDest) 9249 continue; 9250 Instruction *SrcInst = BundleMember->Inst; 9251 assert(SrcInst->mayReadOrWriteMemory() && 9252 "NextLoadStore list for non memory effecting bundle?"); 9253 MemoryLocation SrcLoc = getLocation(SrcInst); 9254 bool SrcMayWrite = BundleMember->Inst->mayWriteToMemory(); 9255 unsigned numAliased = 0; 9256 unsigned DistToSrc = 1; 9257 9258 for ( ; DepDest; DepDest = DepDest->NextLoadStore) { 9259 assert(isInSchedulingRegion(DepDest)); 9260 9261 // We have two limits to reduce the complexity: 9262 // 1) AliasedCheckLimit: It's a small limit to reduce calls to 9263 // SLP->isAliased (which is the expensive part in this loop). 9264 // 2) MaxMemDepDistance: It's for very large blocks and it aborts 9265 // the whole loop (even if the loop is fast, it's quadratic). 9266 // It's important for the loop break condition (see below) to 9267 // check this limit even between two read-only instructions. 9268 if (DistToSrc >= MaxMemDepDistance || 9269 ((SrcMayWrite || DepDest->Inst->mayWriteToMemory()) && 9270 (numAliased >= AliasedCheckLimit || 9271 SLP->isAliased(SrcLoc, SrcInst, DepDest->Inst)))) { 9272 9273 // We increment the counter only if the locations are aliased 9274 // (instead of counting all alias checks). This gives a better 9275 // balance between reduced runtime and accurate dependencies. 9276 numAliased++; 9277 9278 DepDest->MemoryDependencies.push_back(BundleMember); 9279 BundleMember->Dependencies++; 9280 ScheduleData *DestBundle = DepDest->FirstInBundle; 9281 if (!DestBundle->IsScheduled) { 9282 BundleMember->incrementUnscheduledDeps(1); 9283 } 9284 if (!DestBundle->hasValidDependencies()) { 9285 WorkList.push_back(DestBundle); 9286 } 9287 } 9288 9289 // Example, explaining the loop break condition: Let's assume our 9290 // starting instruction is i0 and MaxMemDepDistance = 3. 9291 // 9292 // +--------v--v--v 9293 // i0,i1,i2,i3,i4,i5,i6,i7,i8 9294 // +--------^--^--^ 9295 // 9296 // MaxMemDepDistance let us stop alias-checking at i3 and we add 9297 // dependencies from i0 to i3,i4,.. (even if they are not aliased). 9298 // Previously we already added dependencies from i3 to i6,i7,i8 9299 // (because of MaxMemDepDistance). As we added a dependency from 9300 // i0 to i3, we have transitive dependencies from i0 to i6,i7,i8 9301 // and we can abort this loop at i6. 9302 if (DistToSrc >= 2 * MaxMemDepDistance) 9303 break; 9304 DistToSrc++; 9305 } 9306 } 9307 if (InsertInReadyList && SD->isReady()) { 9308 ReadyInsts.insert(SD); 9309 LLVM_DEBUG(dbgs() << "SLP: gets ready on update: " << *SD->Inst 9310 << "\n"); 9311 } 9312 } 9313 } 9314 9315 void BoUpSLP::BlockScheduling::resetSchedule() { 9316 assert(ScheduleStart && 9317 "tried to reset schedule on block which has not been scheduled"); 9318 for (Instruction *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 9319 doForAllOpcodes(I, [&](ScheduleData *SD) { 9320 assert(isInSchedulingRegion(SD) && 9321 "ScheduleData not in scheduling region"); 9322 SD->IsScheduled = false; 9323 SD->resetUnscheduledDeps(); 9324 }); 9325 } 9326 ReadyInsts.clear(); 9327 } 9328 9329 void BoUpSLP::scheduleBlock(BlockScheduling *BS) { 9330 if (!BS->ScheduleStart) 9331 return; 9332 9333 LLVM_DEBUG(dbgs() << "SLP: schedule block " << BS->BB->getName() << "\n"); 9334 9335 // A key point - if we got here, pre-scheduling was able to find a valid 9336 // scheduling of the sub-graph of the scheduling window which consists 9337 // of all vector bundles and their transitive users. As such, we do not 9338 // need to reschedule anything *outside of* that subgraph. 9339 9340 BS->resetSchedule(); 9341 9342 // For the real scheduling we use a more sophisticated ready-list: it is 9343 // sorted by the original instruction location. This lets the final schedule 9344 // be as close as possible to the original instruction order. 9345 // WARNING: If changing this order causes a correctness issue, that means 9346 // there is some missing dependence edge in the schedule data graph. 9347 struct ScheduleDataCompare { 9348 bool operator()(ScheduleData *SD1, ScheduleData *SD2) const { 9349 return SD2->SchedulingPriority < SD1->SchedulingPriority; 9350 } 9351 }; 9352 std::set<ScheduleData *, ScheduleDataCompare> ReadyInsts; 9353 9354 // Ensure that all dependency data is updated (for nodes in the sub-graph) 9355 // and fill the ready-list with initial instructions. 9356 int Idx = 0; 9357 for (auto *I = BS->ScheduleStart; I != BS->ScheduleEnd; 9358 I = I->getNextNode()) { 9359 BS->doForAllOpcodes(I, [this, &Idx, BS](ScheduleData *SD) { 9360 TreeEntry *SDTE = getTreeEntry(SD->Inst); 9361 (void)SDTE; 9362 assert((isVectorLikeInstWithConstOps(SD->Inst) || 9363 SD->isPartOfBundle() == 9364 (SDTE && !doesNotNeedToSchedule(SDTE->Scalars))) && 9365 "scheduler and vectorizer bundle mismatch"); 9366 SD->FirstInBundle->SchedulingPriority = Idx++; 9367 9368 if (SD->isSchedulingEntity() && SD->isPartOfBundle()) 9369 BS->calculateDependencies(SD, false, this); 9370 }); 9371 } 9372 BS->initialFillReadyList(ReadyInsts); 9373 9374 Instruction *LastScheduledInst = BS->ScheduleEnd; 9375 9376 // Do the "real" scheduling. 9377 while (!ReadyInsts.empty()) { 9378 ScheduleData *picked = *ReadyInsts.begin(); 9379 ReadyInsts.erase(ReadyInsts.begin()); 9380 9381 // Move the scheduled instruction(s) to their dedicated places, if not 9382 // there yet. 9383 for (ScheduleData *BundleMember = picked; BundleMember; 9384 BundleMember = BundleMember->NextInBundle) { 9385 Instruction *pickedInst = BundleMember->Inst; 9386 if (pickedInst->getNextNode() != LastScheduledInst) 9387 pickedInst->moveBefore(LastScheduledInst); 9388 LastScheduledInst = pickedInst; 9389 } 9390 9391 BS->schedule(picked, ReadyInsts); 9392 } 9393 9394 // Check that we didn't break any of our invariants. 9395 #ifdef EXPENSIVE_CHECKS 9396 BS->verify(); 9397 #endif 9398 9399 #if !defined(NDEBUG) || defined(EXPENSIVE_CHECKS) 9400 // Check that all schedulable entities got scheduled 9401 for (auto *I = BS->ScheduleStart; I != BS->ScheduleEnd; I = I->getNextNode()) { 9402 BS->doForAllOpcodes(I, [&](ScheduleData *SD) { 9403 if (SD->isSchedulingEntity() && SD->hasValidDependencies()) { 9404 assert(SD->IsScheduled && "must be scheduled at this point"); 9405 } 9406 }); 9407 } 9408 #endif 9409 9410 // Avoid duplicate scheduling of the block. 9411 BS->ScheduleStart = nullptr; 9412 } 9413 9414 unsigned BoUpSLP::getVectorElementSize(Value *V) { 9415 // If V is a store, just return the width of the stored value (or value 9416 // truncated just before storing) without traversing the expression tree. 9417 // This is the common case. 9418 if (auto *Store = dyn_cast<StoreInst>(V)) 9419 return DL->getTypeSizeInBits(Store->getValueOperand()->getType()); 9420 9421 if (auto *IEI = dyn_cast<InsertElementInst>(V)) 9422 return getVectorElementSize(IEI->getOperand(1)); 9423 9424 auto E = InstrElementSize.find(V); 9425 if (E != InstrElementSize.end()) 9426 return E->second; 9427 9428 // If V is not a store, we can traverse the expression tree to find loads 9429 // that feed it. The type of the loaded value may indicate a more suitable 9430 // width than V's type. We want to base the vector element size on the width 9431 // of memory operations where possible. 9432 SmallVector<std::pair<Instruction *, BasicBlock *>, 16> Worklist; 9433 SmallPtrSet<Instruction *, 16> Visited; 9434 if (auto *I = dyn_cast<Instruction>(V)) { 9435 Worklist.emplace_back(I, I->getParent()); 9436 Visited.insert(I); 9437 } 9438 9439 // Traverse the expression tree in bottom-up order looking for loads. If we 9440 // encounter an instruction we don't yet handle, we give up. 9441 auto Width = 0u; 9442 while (!Worklist.empty()) { 9443 Instruction *I; 9444 BasicBlock *Parent; 9445 std::tie(I, Parent) = Worklist.pop_back_val(); 9446 9447 // We should only be looking at scalar instructions here. If the current 9448 // instruction has a vector type, skip. 9449 auto *Ty = I->getType(); 9450 if (isa<VectorType>(Ty)) 9451 continue; 9452 9453 // If the current instruction is a load, update MaxWidth to reflect the 9454 // width of the loaded value. 9455 if (isa<LoadInst>(I) || isa<ExtractElementInst>(I) || 9456 isa<ExtractValueInst>(I)) 9457 Width = std::max<unsigned>(Width, DL->getTypeSizeInBits(Ty)); 9458 9459 // Otherwise, we need to visit the operands of the instruction. We only 9460 // handle the interesting cases from buildTree here. If an operand is an 9461 // instruction we haven't yet visited and from the same basic block as the 9462 // user or the use is a PHI node, we add it to the worklist. 9463 else if (isa<PHINode>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) || 9464 isa<CmpInst>(I) || isa<SelectInst>(I) || isa<BinaryOperator>(I) || 9465 isa<UnaryOperator>(I)) { 9466 for (Use &U : I->operands()) 9467 if (auto *J = dyn_cast<Instruction>(U.get())) 9468 if (Visited.insert(J).second && 9469 (isa<PHINode>(I) || J->getParent() == Parent)) 9470 Worklist.emplace_back(J, J->getParent()); 9471 } else { 9472 break; 9473 } 9474 } 9475 9476 // If we didn't encounter a memory access in the expression tree, or if we 9477 // gave up for some reason, just return the width of V. Otherwise, return the 9478 // maximum width we found. 9479 if (!Width) { 9480 if (auto *CI = dyn_cast<CmpInst>(V)) 9481 V = CI->getOperand(0); 9482 Width = DL->getTypeSizeInBits(V->getType()); 9483 } 9484 9485 for (Instruction *I : Visited) 9486 InstrElementSize[I] = Width; 9487 9488 return Width; 9489 } 9490 9491 // Determine if a value V in a vectorizable expression Expr can be demoted to a 9492 // smaller type with a truncation. We collect the values that will be demoted 9493 // in ToDemote and additional roots that require investigating in Roots. 9494 static bool collectValuesToDemote(Value *V, SmallPtrSetImpl<Value *> &Expr, 9495 SmallVectorImpl<Value *> &ToDemote, 9496 SmallVectorImpl<Value *> &Roots) { 9497 // We can always demote constants. 9498 if (isa<Constant>(V)) { 9499 ToDemote.push_back(V); 9500 return true; 9501 } 9502 9503 // If the value is not an instruction in the expression with only one use, it 9504 // cannot be demoted. 9505 auto *I = dyn_cast<Instruction>(V); 9506 if (!I || !I->hasOneUse() || !Expr.count(I)) 9507 return false; 9508 9509 switch (I->getOpcode()) { 9510 9511 // We can always demote truncations and extensions. Since truncations can 9512 // seed additional demotion, we save the truncated value. 9513 case Instruction::Trunc: 9514 Roots.push_back(I->getOperand(0)); 9515 break; 9516 case Instruction::ZExt: 9517 case Instruction::SExt: 9518 if (isa<ExtractElementInst>(I->getOperand(0)) || 9519 isa<InsertElementInst>(I->getOperand(0))) 9520 return false; 9521 break; 9522 9523 // We can demote certain binary operations if we can demote both of their 9524 // operands. 9525 case Instruction::Add: 9526 case Instruction::Sub: 9527 case Instruction::Mul: 9528 case Instruction::And: 9529 case Instruction::Or: 9530 case Instruction::Xor: 9531 if (!collectValuesToDemote(I->getOperand(0), Expr, ToDemote, Roots) || 9532 !collectValuesToDemote(I->getOperand(1), Expr, ToDemote, Roots)) 9533 return false; 9534 break; 9535 9536 // We can demote selects if we can demote their true and false values. 9537 case Instruction::Select: { 9538 SelectInst *SI = cast<SelectInst>(I); 9539 if (!collectValuesToDemote(SI->getTrueValue(), Expr, ToDemote, Roots) || 9540 !collectValuesToDemote(SI->getFalseValue(), Expr, ToDemote, Roots)) 9541 return false; 9542 break; 9543 } 9544 9545 // We can demote phis if we can demote all their incoming operands. Note that 9546 // we don't need to worry about cycles since we ensure single use above. 9547 case Instruction::PHI: { 9548 PHINode *PN = cast<PHINode>(I); 9549 for (Value *IncValue : PN->incoming_values()) 9550 if (!collectValuesToDemote(IncValue, Expr, ToDemote, Roots)) 9551 return false; 9552 break; 9553 } 9554 9555 // Otherwise, conservatively give up. 9556 default: 9557 return false; 9558 } 9559 9560 // Record the value that we can demote. 9561 ToDemote.push_back(V); 9562 return true; 9563 } 9564 9565 void BoUpSLP::computeMinimumValueSizes() { 9566 // If there are no external uses, the expression tree must be rooted by a 9567 // store. We can't demote in-memory values, so there is nothing to do here. 9568 if (ExternalUses.empty()) 9569 return; 9570 9571 // We only attempt to truncate integer expressions. 9572 auto &TreeRoot = VectorizableTree[0]->Scalars; 9573 auto *TreeRootIT = dyn_cast<IntegerType>(TreeRoot[0]->getType()); 9574 if (!TreeRootIT) 9575 return; 9576 9577 // If the expression is not rooted by a store, these roots should have 9578 // external uses. We will rely on InstCombine to rewrite the expression in 9579 // the narrower type. However, InstCombine only rewrites single-use values. 9580 // This means that if a tree entry other than a root is used externally, it 9581 // must have multiple uses and InstCombine will not rewrite it. The code 9582 // below ensures that only the roots are used externally. 9583 SmallPtrSet<Value *, 32> Expr(TreeRoot.begin(), TreeRoot.end()); 9584 for (auto &EU : ExternalUses) 9585 if (!Expr.erase(EU.Scalar)) 9586 return; 9587 if (!Expr.empty()) 9588 return; 9589 9590 // Collect the scalar values of the vectorizable expression. We will use this 9591 // context to determine which values can be demoted. If we see a truncation, 9592 // we mark it as seeding another demotion. 9593 for (auto &EntryPtr : VectorizableTree) 9594 Expr.insert(EntryPtr->Scalars.begin(), EntryPtr->Scalars.end()); 9595 9596 // Ensure the roots of the vectorizable tree don't form a cycle. They must 9597 // have a single external user that is not in the vectorizable tree. 9598 for (auto *Root : TreeRoot) 9599 if (!Root->hasOneUse() || Expr.count(*Root->user_begin())) 9600 return; 9601 9602 // Conservatively determine if we can actually truncate the roots of the 9603 // expression. Collect the values that can be demoted in ToDemote and 9604 // additional roots that require investigating in Roots. 9605 SmallVector<Value *, 32> ToDemote; 9606 SmallVector<Value *, 4> Roots; 9607 for (auto *Root : TreeRoot) 9608 if (!collectValuesToDemote(Root, Expr, ToDemote, Roots)) 9609 return; 9610 9611 // The maximum bit width required to represent all the values that can be 9612 // demoted without loss of precision. It would be safe to truncate the roots 9613 // of the expression to this width. 9614 auto MaxBitWidth = 8u; 9615 9616 // We first check if all the bits of the roots are demanded. If they're not, 9617 // we can truncate the roots to this narrower type. 9618 for (auto *Root : TreeRoot) { 9619 auto Mask = DB->getDemandedBits(cast<Instruction>(Root)); 9620 MaxBitWidth = std::max<unsigned>( 9621 Mask.getBitWidth() - Mask.countLeadingZeros(), MaxBitWidth); 9622 } 9623 9624 // True if the roots can be zero-extended back to their original type, rather 9625 // than sign-extended. We know that if the leading bits are not demanded, we 9626 // can safely zero-extend. So we initialize IsKnownPositive to True. 9627 bool IsKnownPositive = true; 9628 9629 // If all the bits of the roots are demanded, we can try a little harder to 9630 // compute a narrower type. This can happen, for example, if the roots are 9631 // getelementptr indices. InstCombine promotes these indices to the pointer 9632 // width. Thus, all their bits are technically demanded even though the 9633 // address computation might be vectorized in a smaller type. 9634 // 9635 // We start by looking at each entry that can be demoted. We compute the 9636 // maximum bit width required to store the scalar by using ValueTracking to 9637 // compute the number of high-order bits we can truncate. 9638 if (MaxBitWidth == DL->getTypeSizeInBits(TreeRoot[0]->getType()) && 9639 llvm::all_of(TreeRoot, [](Value *R) { 9640 assert(R->hasOneUse() && "Root should have only one use!"); 9641 return isa<GetElementPtrInst>(R->user_back()); 9642 })) { 9643 MaxBitWidth = 8u; 9644 9645 // Determine if the sign bit of all the roots is known to be zero. If not, 9646 // IsKnownPositive is set to False. 9647 IsKnownPositive = llvm::all_of(TreeRoot, [&](Value *R) { 9648 KnownBits Known = computeKnownBits(R, *DL); 9649 return Known.isNonNegative(); 9650 }); 9651 9652 // Determine the maximum number of bits required to store the scalar 9653 // values. 9654 for (auto *Scalar : ToDemote) { 9655 auto NumSignBits = ComputeNumSignBits(Scalar, *DL, 0, AC, nullptr, DT); 9656 auto NumTypeBits = DL->getTypeSizeInBits(Scalar->getType()); 9657 MaxBitWidth = std::max<unsigned>(NumTypeBits - NumSignBits, MaxBitWidth); 9658 } 9659 9660 // If we can't prove that the sign bit is zero, we must add one to the 9661 // maximum bit width to account for the unknown sign bit. This preserves 9662 // the existing sign bit so we can safely sign-extend the root back to the 9663 // original type. Otherwise, if we know the sign bit is zero, we will 9664 // zero-extend the root instead. 9665 // 9666 // FIXME: This is somewhat suboptimal, as there will be cases where adding 9667 // one to the maximum bit width will yield a larger-than-necessary 9668 // type. In general, we need to add an extra bit only if we can't 9669 // prove that the upper bit of the original type is equal to the 9670 // upper bit of the proposed smaller type. If these two bits are the 9671 // same (either zero or one) we know that sign-extending from the 9672 // smaller type will result in the same value. Here, since we can't 9673 // yet prove this, we are just making the proposed smaller type 9674 // larger to ensure correctness. 9675 if (!IsKnownPositive) 9676 ++MaxBitWidth; 9677 } 9678 9679 // Round MaxBitWidth up to the next power-of-two. 9680 if (!isPowerOf2_64(MaxBitWidth)) 9681 MaxBitWidth = NextPowerOf2(MaxBitWidth); 9682 9683 // If the maximum bit width we compute is less than the with of the roots' 9684 // type, we can proceed with the narrowing. Otherwise, do nothing. 9685 if (MaxBitWidth >= TreeRootIT->getBitWidth()) 9686 return; 9687 9688 // If we can truncate the root, we must collect additional values that might 9689 // be demoted as a result. That is, those seeded by truncations we will 9690 // modify. 9691 while (!Roots.empty()) 9692 collectValuesToDemote(Roots.pop_back_val(), Expr, ToDemote, Roots); 9693 9694 // Finally, map the values we can demote to the maximum bit with we computed. 9695 for (auto *Scalar : ToDemote) 9696 MinBWs[Scalar] = std::make_pair(MaxBitWidth, !IsKnownPositive); 9697 } 9698 9699 namespace { 9700 9701 /// The SLPVectorizer Pass. 9702 struct SLPVectorizer : public FunctionPass { 9703 SLPVectorizerPass Impl; 9704 9705 /// Pass identification, replacement for typeid 9706 static char ID; 9707 9708 explicit SLPVectorizer() : FunctionPass(ID) { 9709 initializeSLPVectorizerPass(*PassRegistry::getPassRegistry()); 9710 } 9711 9712 bool doInitialization(Module &M) override { return false; } 9713 9714 bool runOnFunction(Function &F) override { 9715 if (skipFunction(F)) 9716 return false; 9717 9718 auto *SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE(); 9719 auto *TTI = &getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F); 9720 auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>(); 9721 auto *TLI = TLIP ? &TLIP->getTLI(F) : nullptr; 9722 auto *AA = &getAnalysis<AAResultsWrapperPass>().getAAResults(); 9723 auto *LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo(); 9724 auto *DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 9725 auto *AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F); 9726 auto *DB = &getAnalysis<DemandedBitsWrapperPass>().getDemandedBits(); 9727 auto *ORE = &getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE(); 9728 9729 return Impl.runImpl(F, SE, TTI, TLI, AA, LI, DT, AC, DB, ORE); 9730 } 9731 9732 void getAnalysisUsage(AnalysisUsage &AU) const override { 9733 FunctionPass::getAnalysisUsage(AU); 9734 AU.addRequired<AssumptionCacheTracker>(); 9735 AU.addRequired<ScalarEvolutionWrapperPass>(); 9736 AU.addRequired<AAResultsWrapperPass>(); 9737 AU.addRequired<TargetTransformInfoWrapperPass>(); 9738 AU.addRequired<LoopInfoWrapperPass>(); 9739 AU.addRequired<DominatorTreeWrapperPass>(); 9740 AU.addRequired<DemandedBitsWrapperPass>(); 9741 AU.addRequired<OptimizationRemarkEmitterWrapperPass>(); 9742 AU.addRequired<InjectTLIMappingsLegacy>(); 9743 AU.addPreserved<LoopInfoWrapperPass>(); 9744 AU.addPreserved<DominatorTreeWrapperPass>(); 9745 AU.addPreserved<AAResultsWrapperPass>(); 9746 AU.addPreserved<GlobalsAAWrapperPass>(); 9747 AU.setPreservesCFG(); 9748 } 9749 }; 9750 9751 } // end anonymous namespace 9752 9753 PreservedAnalyses SLPVectorizerPass::run(Function &F, FunctionAnalysisManager &AM) { 9754 auto *SE = &AM.getResult<ScalarEvolutionAnalysis>(F); 9755 auto *TTI = &AM.getResult<TargetIRAnalysis>(F); 9756 auto *TLI = AM.getCachedResult<TargetLibraryAnalysis>(F); 9757 auto *AA = &AM.getResult<AAManager>(F); 9758 auto *LI = &AM.getResult<LoopAnalysis>(F); 9759 auto *DT = &AM.getResult<DominatorTreeAnalysis>(F); 9760 auto *AC = &AM.getResult<AssumptionAnalysis>(F); 9761 auto *DB = &AM.getResult<DemandedBitsAnalysis>(F); 9762 auto *ORE = &AM.getResult<OptimizationRemarkEmitterAnalysis>(F); 9763 9764 bool Changed = runImpl(F, SE, TTI, TLI, AA, LI, DT, AC, DB, ORE); 9765 if (!Changed) 9766 return PreservedAnalyses::all(); 9767 9768 PreservedAnalyses PA; 9769 PA.preserveSet<CFGAnalyses>(); 9770 return PA; 9771 } 9772 9773 bool SLPVectorizerPass::runImpl(Function &F, ScalarEvolution *SE_, 9774 TargetTransformInfo *TTI_, 9775 TargetLibraryInfo *TLI_, AAResults *AA_, 9776 LoopInfo *LI_, DominatorTree *DT_, 9777 AssumptionCache *AC_, DemandedBits *DB_, 9778 OptimizationRemarkEmitter *ORE_) { 9779 if (!RunSLPVectorization) 9780 return false; 9781 SE = SE_; 9782 TTI = TTI_; 9783 TLI = TLI_; 9784 AA = AA_; 9785 LI = LI_; 9786 DT = DT_; 9787 AC = AC_; 9788 DB = DB_; 9789 DL = &F.getParent()->getDataLayout(); 9790 9791 Stores.clear(); 9792 GEPs.clear(); 9793 bool Changed = false; 9794 9795 // If the target claims to have no vector registers don't attempt 9796 // vectorization. 9797 if (!TTI->getNumberOfRegisters(TTI->getRegisterClassForType(true))) { 9798 LLVM_DEBUG( 9799 dbgs() << "SLP: Didn't find any vector registers for target, abort.\n"); 9800 return false; 9801 } 9802 9803 // Don't vectorize when the attribute NoImplicitFloat is used. 9804 if (F.hasFnAttribute(Attribute::NoImplicitFloat)) 9805 return false; 9806 9807 LLVM_DEBUG(dbgs() << "SLP: Analyzing blocks in " << F.getName() << ".\n"); 9808 9809 // Use the bottom up slp vectorizer to construct chains that start with 9810 // store instructions. 9811 BoUpSLP R(&F, SE, TTI, TLI, AA, LI, DT, AC, DB, DL, ORE_); 9812 9813 // A general note: the vectorizer must use BoUpSLP::eraseInstruction() to 9814 // delete instructions. 9815 9816 // Update DFS numbers now so that we can use them for ordering. 9817 DT->updateDFSNumbers(); 9818 9819 // Scan the blocks in the function in post order. 9820 for (auto BB : post_order(&F.getEntryBlock())) { 9821 // Start new block - clear the list of reduction roots. 9822 R.clearReductionData(); 9823 collectSeedInstructions(BB); 9824 9825 // Vectorize trees that end at stores. 9826 if (!Stores.empty()) { 9827 LLVM_DEBUG(dbgs() << "SLP: Found stores for " << Stores.size() 9828 << " underlying objects.\n"); 9829 Changed |= vectorizeStoreChains(R); 9830 } 9831 9832 // Vectorize trees that end at reductions. 9833 Changed |= vectorizeChainsInBlock(BB, R); 9834 9835 // Vectorize the index computations of getelementptr instructions. This 9836 // is primarily intended to catch gather-like idioms ending at 9837 // non-consecutive loads. 9838 if (!GEPs.empty()) { 9839 LLVM_DEBUG(dbgs() << "SLP: Found GEPs for " << GEPs.size() 9840 << " underlying objects.\n"); 9841 Changed |= vectorizeGEPIndices(BB, R); 9842 } 9843 } 9844 9845 if (Changed) { 9846 R.optimizeGatherSequence(); 9847 LLVM_DEBUG(dbgs() << "SLP: vectorized \"" << F.getName() << "\"\n"); 9848 } 9849 return Changed; 9850 } 9851 9852 bool SLPVectorizerPass::vectorizeStoreChain(ArrayRef<Value *> Chain, BoUpSLP &R, 9853 unsigned Idx, unsigned MinVF) { 9854 LLVM_DEBUG(dbgs() << "SLP: Analyzing a store chain of length " << Chain.size() 9855 << "\n"); 9856 const unsigned Sz = R.getVectorElementSize(Chain[0]); 9857 unsigned VF = Chain.size(); 9858 9859 if (!isPowerOf2_32(Sz) || !isPowerOf2_32(VF) || VF < 2 || VF < MinVF) 9860 return false; 9861 9862 LLVM_DEBUG(dbgs() << "SLP: Analyzing " << VF << " stores at offset " << Idx 9863 << "\n"); 9864 9865 R.buildTree(Chain); 9866 if (R.isTreeTinyAndNotFullyVectorizable()) 9867 return false; 9868 if (R.isLoadCombineCandidate()) 9869 return false; 9870 R.reorderTopToBottom(); 9871 R.reorderBottomToTop(); 9872 R.buildExternalUses(); 9873 9874 R.computeMinimumValueSizes(); 9875 9876 InstructionCost Cost = R.getTreeCost(); 9877 9878 LLVM_DEBUG(dbgs() << "SLP: Found cost = " << Cost << " for VF =" << VF << "\n"); 9879 if (Cost < -SLPCostThreshold) { 9880 LLVM_DEBUG(dbgs() << "SLP: Decided to vectorize cost = " << Cost << "\n"); 9881 9882 using namespace ore; 9883 9884 R.getORE()->emit(OptimizationRemark(SV_NAME, "StoresVectorized", 9885 cast<StoreInst>(Chain[0])) 9886 << "Stores SLP vectorized with cost " << NV("Cost", Cost) 9887 << " and with tree size " 9888 << NV("TreeSize", R.getTreeSize())); 9889 9890 R.vectorizeTree(); 9891 return true; 9892 } 9893 9894 return false; 9895 } 9896 9897 bool SLPVectorizerPass::vectorizeStores(ArrayRef<StoreInst *> Stores, 9898 BoUpSLP &R) { 9899 // We may run into multiple chains that merge into a single chain. We mark the 9900 // stores that we vectorized so that we don't visit the same store twice. 9901 BoUpSLP::ValueSet VectorizedStores; 9902 bool Changed = false; 9903 9904 int E = Stores.size(); 9905 SmallBitVector Tails(E, false); 9906 int MaxIter = MaxStoreLookup.getValue(); 9907 SmallVector<std::pair<int, int>, 16> ConsecutiveChain( 9908 E, std::make_pair(E, INT_MAX)); 9909 SmallVector<SmallBitVector, 4> CheckedPairs(E, SmallBitVector(E, false)); 9910 int IterCnt; 9911 auto &&FindConsecutiveAccess = [this, &Stores, &Tails, &IterCnt, MaxIter, 9912 &CheckedPairs, 9913 &ConsecutiveChain](int K, int Idx) { 9914 if (IterCnt >= MaxIter) 9915 return true; 9916 if (CheckedPairs[Idx].test(K)) 9917 return ConsecutiveChain[K].second == 1 && 9918 ConsecutiveChain[K].first == Idx; 9919 ++IterCnt; 9920 CheckedPairs[Idx].set(K); 9921 CheckedPairs[K].set(Idx); 9922 Optional<int> Diff = getPointersDiff( 9923 Stores[K]->getValueOperand()->getType(), Stores[K]->getPointerOperand(), 9924 Stores[Idx]->getValueOperand()->getType(), 9925 Stores[Idx]->getPointerOperand(), *DL, *SE, /*StrictCheck=*/true); 9926 if (!Diff || *Diff == 0) 9927 return false; 9928 int Val = *Diff; 9929 if (Val < 0) { 9930 if (ConsecutiveChain[Idx].second > -Val) { 9931 Tails.set(K); 9932 ConsecutiveChain[Idx] = std::make_pair(K, -Val); 9933 } 9934 return false; 9935 } 9936 if (ConsecutiveChain[K].second <= Val) 9937 return false; 9938 9939 Tails.set(Idx); 9940 ConsecutiveChain[K] = std::make_pair(Idx, Val); 9941 return Val == 1; 9942 }; 9943 // Do a quadratic search on all of the given stores in reverse order and find 9944 // all of the pairs of stores that follow each other. 9945 for (int Idx = E - 1; Idx >= 0; --Idx) { 9946 // If a store has multiple consecutive store candidates, search according 9947 // to the sequence: Idx-1, Idx+1, Idx-2, Idx+2, ... 9948 // This is because usually pairing with immediate succeeding or preceding 9949 // candidate create the best chance to find slp vectorization opportunity. 9950 const int MaxLookDepth = std::max(E - Idx, Idx + 1); 9951 IterCnt = 0; 9952 for (int Offset = 1, F = MaxLookDepth; Offset < F; ++Offset) 9953 if ((Idx >= Offset && FindConsecutiveAccess(Idx - Offset, Idx)) || 9954 (Idx + Offset < E && FindConsecutiveAccess(Idx + Offset, Idx))) 9955 break; 9956 } 9957 9958 // Tracks if we tried to vectorize stores starting from the given tail 9959 // already. 9960 SmallBitVector TriedTails(E, false); 9961 // For stores that start but don't end a link in the chain: 9962 for (int Cnt = E; Cnt > 0; --Cnt) { 9963 int I = Cnt - 1; 9964 if (ConsecutiveChain[I].first == E || Tails.test(I)) 9965 continue; 9966 // We found a store instr that starts a chain. Now follow the chain and try 9967 // to vectorize it. 9968 BoUpSLP::ValueList Operands; 9969 // Collect the chain into a list. 9970 while (I != E && !VectorizedStores.count(Stores[I])) { 9971 Operands.push_back(Stores[I]); 9972 Tails.set(I); 9973 if (ConsecutiveChain[I].second != 1) { 9974 // Mark the new end in the chain and go back, if required. It might be 9975 // required if the original stores come in reversed order, for example. 9976 if (ConsecutiveChain[I].first != E && 9977 Tails.test(ConsecutiveChain[I].first) && !TriedTails.test(I) && 9978 !VectorizedStores.count(Stores[ConsecutiveChain[I].first])) { 9979 TriedTails.set(I); 9980 Tails.reset(ConsecutiveChain[I].first); 9981 if (Cnt < ConsecutiveChain[I].first + 2) 9982 Cnt = ConsecutiveChain[I].first + 2; 9983 } 9984 break; 9985 } 9986 // Move to the next value in the chain. 9987 I = ConsecutiveChain[I].first; 9988 } 9989 assert(!Operands.empty() && "Expected non-empty list of stores."); 9990 9991 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 9992 unsigned EltSize = R.getVectorElementSize(Operands[0]); 9993 unsigned MaxElts = llvm::PowerOf2Floor(MaxVecRegSize / EltSize); 9994 9995 unsigned MaxVF = std::min(R.getMaximumVF(EltSize, Instruction::Store), 9996 MaxElts); 9997 auto *Store = cast<StoreInst>(Operands[0]); 9998 Type *StoreTy = Store->getValueOperand()->getType(); 9999 Type *ValueTy = StoreTy; 10000 if (auto *Trunc = dyn_cast<TruncInst>(Store->getValueOperand())) 10001 ValueTy = Trunc->getSrcTy(); 10002 unsigned MinVF = TTI->getStoreMinimumVF( 10003 R.getMinVF(DL->getTypeSizeInBits(ValueTy)), StoreTy, ValueTy); 10004 10005 // FIXME: Is division-by-2 the correct step? Should we assert that the 10006 // register size is a power-of-2? 10007 unsigned StartIdx = 0; 10008 for (unsigned Size = MaxVF; Size >= MinVF; Size /= 2) { 10009 for (unsigned Cnt = StartIdx, E = Operands.size(); Cnt + Size <= E;) { 10010 ArrayRef<Value *> Slice = makeArrayRef(Operands).slice(Cnt, Size); 10011 if (!VectorizedStores.count(Slice.front()) && 10012 !VectorizedStores.count(Slice.back()) && 10013 vectorizeStoreChain(Slice, R, Cnt, MinVF)) { 10014 // Mark the vectorized stores so that we don't vectorize them again. 10015 VectorizedStores.insert(Slice.begin(), Slice.end()); 10016 Changed = true; 10017 // If we vectorized initial block, no need to try to vectorize it 10018 // again. 10019 if (Cnt == StartIdx) 10020 StartIdx += Size; 10021 Cnt += Size; 10022 continue; 10023 } 10024 ++Cnt; 10025 } 10026 // Check if the whole array was vectorized already - exit. 10027 if (StartIdx >= Operands.size()) 10028 break; 10029 } 10030 } 10031 10032 return Changed; 10033 } 10034 10035 void SLPVectorizerPass::collectSeedInstructions(BasicBlock *BB) { 10036 // Initialize the collections. We will make a single pass over the block. 10037 Stores.clear(); 10038 GEPs.clear(); 10039 10040 // Visit the store and getelementptr instructions in BB and organize them in 10041 // Stores and GEPs according to the underlying objects of their pointer 10042 // operands. 10043 for (Instruction &I : *BB) { 10044 // Ignore store instructions that are volatile or have a pointer operand 10045 // that doesn't point to a scalar type. 10046 if (auto *SI = dyn_cast<StoreInst>(&I)) { 10047 if (!SI->isSimple()) 10048 continue; 10049 if (!isValidElementType(SI->getValueOperand()->getType())) 10050 continue; 10051 Stores[getUnderlyingObject(SI->getPointerOperand())].push_back(SI); 10052 } 10053 10054 // Ignore getelementptr instructions that have more than one index, a 10055 // constant index, or a pointer operand that doesn't point to a scalar 10056 // type. 10057 else if (auto *GEP = dyn_cast<GetElementPtrInst>(&I)) { 10058 auto Idx = GEP->idx_begin()->get(); 10059 if (GEP->getNumIndices() > 1 || isa<Constant>(Idx)) 10060 continue; 10061 if (!isValidElementType(Idx->getType())) 10062 continue; 10063 if (GEP->getType()->isVectorTy()) 10064 continue; 10065 GEPs[GEP->getPointerOperand()].push_back(GEP); 10066 } 10067 } 10068 } 10069 10070 bool SLPVectorizerPass::tryToVectorizePair(Value *A, Value *B, BoUpSLP &R) { 10071 if (!A || !B) 10072 return false; 10073 if (isa<InsertElementInst>(A) || isa<InsertElementInst>(B)) 10074 return false; 10075 Value *VL[] = {A, B}; 10076 return tryToVectorizeList(VL, R); 10077 } 10078 10079 bool SLPVectorizerPass::tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R, 10080 bool LimitForRegisterSize) { 10081 if (VL.size() < 2) 10082 return false; 10083 10084 LLVM_DEBUG(dbgs() << "SLP: Trying to vectorize a list of length = " 10085 << VL.size() << ".\n"); 10086 10087 // Check that all of the parts are instructions of the same type, 10088 // we permit an alternate opcode via InstructionsState. 10089 InstructionsState S = getSameOpcode(VL); 10090 if (!S.getOpcode()) 10091 return false; 10092 10093 Instruction *I0 = cast<Instruction>(S.OpValue); 10094 // Make sure invalid types (including vector type) are rejected before 10095 // determining vectorization factor for scalar instructions. 10096 for (Value *V : VL) { 10097 Type *Ty = V->getType(); 10098 if (!isa<InsertElementInst>(V) && !isValidElementType(Ty)) { 10099 // NOTE: the following will give user internal llvm type name, which may 10100 // not be useful. 10101 R.getORE()->emit([&]() { 10102 std::string type_str; 10103 llvm::raw_string_ostream rso(type_str); 10104 Ty->print(rso); 10105 return OptimizationRemarkMissed(SV_NAME, "UnsupportedType", I0) 10106 << "Cannot SLP vectorize list: type " 10107 << rso.str() + " is unsupported by vectorizer"; 10108 }); 10109 return false; 10110 } 10111 } 10112 10113 unsigned Sz = R.getVectorElementSize(I0); 10114 unsigned MinVF = R.getMinVF(Sz); 10115 unsigned MaxVF = std::max<unsigned>(PowerOf2Floor(VL.size()), MinVF); 10116 MaxVF = std::min(R.getMaximumVF(Sz, S.getOpcode()), MaxVF); 10117 if (MaxVF < 2) { 10118 R.getORE()->emit([&]() { 10119 return OptimizationRemarkMissed(SV_NAME, "SmallVF", I0) 10120 << "Cannot SLP vectorize list: vectorization factor " 10121 << "less than 2 is not supported"; 10122 }); 10123 return false; 10124 } 10125 10126 bool Changed = false; 10127 bool CandidateFound = false; 10128 InstructionCost MinCost = SLPCostThreshold.getValue(); 10129 Type *ScalarTy = VL[0]->getType(); 10130 if (auto *IE = dyn_cast<InsertElementInst>(VL[0])) 10131 ScalarTy = IE->getOperand(1)->getType(); 10132 10133 unsigned NextInst = 0, MaxInst = VL.size(); 10134 for (unsigned VF = MaxVF; NextInst + 1 < MaxInst && VF >= MinVF; VF /= 2) { 10135 // No actual vectorization should happen, if number of parts is the same as 10136 // provided vectorization factor (i.e. the scalar type is used for vector 10137 // code during codegen). 10138 auto *VecTy = FixedVectorType::get(ScalarTy, VF); 10139 if (TTI->getNumberOfParts(VecTy) == VF) 10140 continue; 10141 for (unsigned I = NextInst; I < MaxInst; ++I) { 10142 unsigned OpsWidth = 0; 10143 10144 if (I + VF > MaxInst) 10145 OpsWidth = MaxInst - I; 10146 else 10147 OpsWidth = VF; 10148 10149 if (!isPowerOf2_32(OpsWidth)) 10150 continue; 10151 10152 if ((LimitForRegisterSize && OpsWidth < MaxVF) || 10153 (VF > MinVF && OpsWidth <= VF / 2) || (VF == MinVF && OpsWidth < 2)) 10154 break; 10155 10156 ArrayRef<Value *> Ops = VL.slice(I, OpsWidth); 10157 // Check that a previous iteration of this loop did not delete the Value. 10158 if (llvm::any_of(Ops, [&R](Value *V) { 10159 auto *I = dyn_cast<Instruction>(V); 10160 return I && R.isDeleted(I); 10161 })) 10162 continue; 10163 10164 LLVM_DEBUG(dbgs() << "SLP: Analyzing " << OpsWidth << " operations " 10165 << "\n"); 10166 10167 R.buildTree(Ops); 10168 if (R.isTreeTinyAndNotFullyVectorizable()) 10169 continue; 10170 R.reorderTopToBottom(); 10171 R.reorderBottomToTop(!isa<InsertElementInst>(Ops.front())); 10172 R.buildExternalUses(); 10173 10174 R.computeMinimumValueSizes(); 10175 InstructionCost Cost = R.getTreeCost(); 10176 CandidateFound = true; 10177 MinCost = std::min(MinCost, Cost); 10178 10179 if (Cost < -SLPCostThreshold) { 10180 LLVM_DEBUG(dbgs() << "SLP: Vectorizing list at cost:" << Cost << ".\n"); 10181 R.getORE()->emit(OptimizationRemark(SV_NAME, "VectorizedList", 10182 cast<Instruction>(Ops[0])) 10183 << "SLP vectorized with cost " << ore::NV("Cost", Cost) 10184 << " and with tree size " 10185 << ore::NV("TreeSize", R.getTreeSize())); 10186 10187 R.vectorizeTree(); 10188 // Move to the next bundle. 10189 I += VF - 1; 10190 NextInst = I + 1; 10191 Changed = true; 10192 } 10193 } 10194 } 10195 10196 if (!Changed && CandidateFound) { 10197 R.getORE()->emit([&]() { 10198 return OptimizationRemarkMissed(SV_NAME, "NotBeneficial", I0) 10199 << "List vectorization was possible but not beneficial with cost " 10200 << ore::NV("Cost", MinCost) << " >= " 10201 << ore::NV("Treshold", -SLPCostThreshold); 10202 }); 10203 } else if (!Changed) { 10204 R.getORE()->emit([&]() { 10205 return OptimizationRemarkMissed(SV_NAME, "NotPossible", I0) 10206 << "Cannot SLP vectorize list: vectorization was impossible" 10207 << " with available vectorization factors"; 10208 }); 10209 } 10210 return Changed; 10211 } 10212 10213 bool SLPVectorizerPass::tryToVectorize(Instruction *I, BoUpSLP &R) { 10214 if (!I) 10215 return false; 10216 10217 if ((!isa<BinaryOperator>(I) && !isa<CmpInst>(I)) || 10218 isa<VectorType>(I->getType())) 10219 return false; 10220 10221 Value *P = I->getParent(); 10222 10223 // Vectorize in current basic block only. 10224 auto *Op0 = dyn_cast<Instruction>(I->getOperand(0)); 10225 auto *Op1 = dyn_cast<Instruction>(I->getOperand(1)); 10226 if (!Op0 || !Op1 || Op0->getParent() != P || Op1->getParent() != P) 10227 return false; 10228 10229 // First collect all possible candidates 10230 SmallVector<std::pair<Value *, Value *>, 4> Candidates; 10231 Candidates.emplace_back(Op0, Op1); 10232 10233 auto *A = dyn_cast<BinaryOperator>(Op0); 10234 auto *B = dyn_cast<BinaryOperator>(Op1); 10235 // Try to skip B. 10236 if (A && B && B->hasOneUse()) { 10237 auto *B0 = dyn_cast<BinaryOperator>(B->getOperand(0)); 10238 auto *B1 = dyn_cast<BinaryOperator>(B->getOperand(1)); 10239 if (B0 && B0->getParent() == P) 10240 Candidates.emplace_back(A, B0); 10241 if (B1 && B1->getParent() == P) 10242 Candidates.emplace_back(A, B1); 10243 } 10244 // Try to skip A. 10245 if (B && A && A->hasOneUse()) { 10246 auto *A0 = dyn_cast<BinaryOperator>(A->getOperand(0)); 10247 auto *A1 = dyn_cast<BinaryOperator>(A->getOperand(1)); 10248 if (A0 && A0->getParent() == P) 10249 Candidates.emplace_back(A0, B); 10250 if (A1 && A1->getParent() == P) 10251 Candidates.emplace_back(A1, B); 10252 } 10253 10254 if (Candidates.size() == 1) 10255 return tryToVectorizePair(Op0, Op1, R); 10256 10257 // We have multiple options. Try to pick the single best. 10258 Optional<int> BestCandidate = R.findBestRootPair(Candidates); 10259 if (!BestCandidate) 10260 return false; 10261 return tryToVectorizePair(Candidates[*BestCandidate].first, 10262 Candidates[*BestCandidate].second, R); 10263 } 10264 10265 namespace { 10266 10267 /// Model horizontal reductions. 10268 /// 10269 /// A horizontal reduction is a tree of reduction instructions that has values 10270 /// that can be put into a vector as its leaves. For example: 10271 /// 10272 /// mul mul mul mul 10273 /// \ / \ / 10274 /// + + 10275 /// \ / 10276 /// + 10277 /// This tree has "mul" as its leaf values and "+" as its reduction 10278 /// instructions. A reduction can feed into a store or a binary operation 10279 /// feeding a phi. 10280 /// ... 10281 /// \ / 10282 /// + 10283 /// | 10284 /// phi += 10285 /// 10286 /// Or: 10287 /// ... 10288 /// \ / 10289 /// + 10290 /// | 10291 /// *p = 10292 /// 10293 class HorizontalReduction { 10294 using ReductionOpsType = SmallVector<Value *, 16>; 10295 using ReductionOpsListType = SmallVector<ReductionOpsType, 2>; 10296 ReductionOpsListType ReductionOps; 10297 /// List of possibly reduced values. 10298 SmallVector<SmallVector<Value *>> ReducedVals; 10299 /// Maps reduced value to the corresponding reduction operation. 10300 DenseMap<Value *, SmallVector<Instruction *>> ReducedValsToOps; 10301 // Use map vector to make stable output. 10302 MapVector<Instruction *, Value *> ExtraArgs; 10303 WeakTrackingVH ReductionRoot; 10304 /// The type of reduction operation. 10305 RecurKind RdxKind; 10306 10307 static bool isCmpSelMinMax(Instruction *I) { 10308 return match(I, m_Select(m_Cmp(), m_Value(), m_Value())) && 10309 RecurrenceDescriptor::isMinMaxRecurrenceKind(getRdxKind(I)); 10310 } 10311 10312 // And/or are potentially poison-safe logical patterns like: 10313 // select x, y, false 10314 // select x, true, y 10315 static bool isBoolLogicOp(Instruction *I) { 10316 return match(I, m_LogicalAnd(m_Value(), m_Value())) || 10317 match(I, m_LogicalOr(m_Value(), m_Value())); 10318 } 10319 10320 /// Checks if instruction is associative and can be vectorized. 10321 static bool isVectorizable(RecurKind Kind, Instruction *I) { 10322 if (Kind == RecurKind::None) 10323 return false; 10324 10325 // Integer ops that map to select instructions or intrinsics are fine. 10326 if (RecurrenceDescriptor::isIntMinMaxRecurrenceKind(Kind) || 10327 isBoolLogicOp(I)) 10328 return true; 10329 10330 if (Kind == RecurKind::FMax || Kind == RecurKind::FMin) { 10331 // FP min/max are associative except for NaN and -0.0. We do not 10332 // have to rule out -0.0 here because the intrinsic semantics do not 10333 // specify a fixed result for it. 10334 return I->getFastMathFlags().noNaNs(); 10335 } 10336 10337 return I->isAssociative(); 10338 } 10339 10340 static Value *getRdxOperand(Instruction *I, unsigned Index) { 10341 // Poison-safe 'or' takes the form: select X, true, Y 10342 // To make that work with the normal operand processing, we skip the 10343 // true value operand. 10344 // TODO: Change the code and data structures to handle this without a hack. 10345 if (getRdxKind(I) == RecurKind::Or && isa<SelectInst>(I) && Index == 1) 10346 return I->getOperand(2); 10347 return I->getOperand(Index); 10348 } 10349 10350 /// Creates reduction operation with the current opcode. 10351 static Value *createOp(IRBuilder<> &Builder, RecurKind Kind, Value *LHS, 10352 Value *RHS, const Twine &Name, bool UseSelect) { 10353 unsigned RdxOpcode = RecurrenceDescriptor::getOpcode(Kind); 10354 switch (Kind) { 10355 case RecurKind::Or: 10356 if (UseSelect && 10357 LHS->getType() == CmpInst::makeCmpResultType(LHS->getType())) 10358 return Builder.CreateSelect(LHS, Builder.getTrue(), RHS, Name); 10359 return Builder.CreateBinOp((Instruction::BinaryOps)RdxOpcode, LHS, RHS, 10360 Name); 10361 case RecurKind::And: 10362 if (UseSelect && 10363 LHS->getType() == CmpInst::makeCmpResultType(LHS->getType())) 10364 return Builder.CreateSelect(LHS, RHS, Builder.getFalse(), Name); 10365 return Builder.CreateBinOp((Instruction::BinaryOps)RdxOpcode, LHS, RHS, 10366 Name); 10367 case RecurKind::Add: 10368 case RecurKind::Mul: 10369 case RecurKind::Xor: 10370 case RecurKind::FAdd: 10371 case RecurKind::FMul: 10372 return Builder.CreateBinOp((Instruction::BinaryOps)RdxOpcode, LHS, RHS, 10373 Name); 10374 case RecurKind::FMax: 10375 return Builder.CreateBinaryIntrinsic(Intrinsic::maxnum, LHS, RHS); 10376 case RecurKind::FMin: 10377 return Builder.CreateBinaryIntrinsic(Intrinsic::minnum, LHS, RHS); 10378 case RecurKind::SMax: 10379 if (UseSelect) { 10380 Value *Cmp = Builder.CreateICmpSGT(LHS, RHS, Name); 10381 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10382 } 10383 return Builder.CreateBinaryIntrinsic(Intrinsic::smax, LHS, RHS); 10384 case RecurKind::SMin: 10385 if (UseSelect) { 10386 Value *Cmp = Builder.CreateICmpSLT(LHS, RHS, Name); 10387 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10388 } 10389 return Builder.CreateBinaryIntrinsic(Intrinsic::smin, LHS, RHS); 10390 case RecurKind::UMax: 10391 if (UseSelect) { 10392 Value *Cmp = Builder.CreateICmpUGT(LHS, RHS, Name); 10393 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10394 } 10395 return Builder.CreateBinaryIntrinsic(Intrinsic::umax, LHS, RHS); 10396 case RecurKind::UMin: 10397 if (UseSelect) { 10398 Value *Cmp = Builder.CreateICmpULT(LHS, RHS, Name); 10399 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10400 } 10401 return Builder.CreateBinaryIntrinsic(Intrinsic::umin, LHS, RHS); 10402 default: 10403 llvm_unreachable("Unknown reduction operation."); 10404 } 10405 } 10406 10407 /// Creates reduction operation with the current opcode with the IR flags 10408 /// from \p ReductionOps, dropping nuw/nsw flags. 10409 static Value *createOp(IRBuilder<> &Builder, RecurKind RdxKind, Value *LHS, 10410 Value *RHS, const Twine &Name, 10411 const ReductionOpsListType &ReductionOps) { 10412 bool UseSelect = ReductionOps.size() == 2 || 10413 // Logical or/and. 10414 (ReductionOps.size() == 1 && 10415 isa<SelectInst>(ReductionOps.front().front())); 10416 assert((!UseSelect || ReductionOps.size() != 2 || 10417 isa<SelectInst>(ReductionOps[1][0])) && 10418 "Expected cmp + select pairs for reduction"); 10419 Value *Op = createOp(Builder, RdxKind, LHS, RHS, Name, UseSelect); 10420 if (RecurrenceDescriptor::isIntMinMaxRecurrenceKind(RdxKind)) { 10421 if (auto *Sel = dyn_cast<SelectInst>(Op)) { 10422 propagateIRFlags(Sel->getCondition(), ReductionOps[0], nullptr, 10423 /*IncludeWrapFlags=*/false); 10424 propagateIRFlags(Op, ReductionOps[1], nullptr, 10425 /*IncludeWrapFlags=*/false); 10426 return Op; 10427 } 10428 } 10429 propagateIRFlags(Op, ReductionOps[0], nullptr, /*IncludeWrapFlags=*/false); 10430 return Op; 10431 } 10432 10433 static RecurKind getRdxKind(Value *V) { 10434 auto *I = dyn_cast<Instruction>(V); 10435 if (!I) 10436 return RecurKind::None; 10437 if (match(I, m_Add(m_Value(), m_Value()))) 10438 return RecurKind::Add; 10439 if (match(I, m_Mul(m_Value(), m_Value()))) 10440 return RecurKind::Mul; 10441 if (match(I, m_And(m_Value(), m_Value())) || 10442 match(I, m_LogicalAnd(m_Value(), m_Value()))) 10443 return RecurKind::And; 10444 if (match(I, m_Or(m_Value(), m_Value())) || 10445 match(I, m_LogicalOr(m_Value(), m_Value()))) 10446 return RecurKind::Or; 10447 if (match(I, m_Xor(m_Value(), m_Value()))) 10448 return RecurKind::Xor; 10449 if (match(I, m_FAdd(m_Value(), m_Value()))) 10450 return RecurKind::FAdd; 10451 if (match(I, m_FMul(m_Value(), m_Value()))) 10452 return RecurKind::FMul; 10453 10454 if (match(I, m_Intrinsic<Intrinsic::maxnum>(m_Value(), m_Value()))) 10455 return RecurKind::FMax; 10456 if (match(I, m_Intrinsic<Intrinsic::minnum>(m_Value(), m_Value()))) 10457 return RecurKind::FMin; 10458 10459 // This matches either cmp+select or intrinsics. SLP is expected to handle 10460 // either form. 10461 // TODO: If we are canonicalizing to intrinsics, we can remove several 10462 // special-case paths that deal with selects. 10463 if (match(I, m_SMax(m_Value(), m_Value()))) 10464 return RecurKind::SMax; 10465 if (match(I, m_SMin(m_Value(), m_Value()))) 10466 return RecurKind::SMin; 10467 if (match(I, m_UMax(m_Value(), m_Value()))) 10468 return RecurKind::UMax; 10469 if (match(I, m_UMin(m_Value(), m_Value()))) 10470 return RecurKind::UMin; 10471 10472 if (auto *Select = dyn_cast<SelectInst>(I)) { 10473 // Try harder: look for min/max pattern based on instructions producing 10474 // same values such as: select ((cmp Inst1, Inst2), Inst1, Inst2). 10475 // During the intermediate stages of SLP, it's very common to have 10476 // pattern like this (since optimizeGatherSequence is run only once 10477 // at the end): 10478 // %1 = extractelement <2 x i32> %a, i32 0 10479 // %2 = extractelement <2 x i32> %a, i32 1 10480 // %cond = icmp sgt i32 %1, %2 10481 // %3 = extractelement <2 x i32> %a, i32 0 10482 // %4 = extractelement <2 x i32> %a, i32 1 10483 // %select = select i1 %cond, i32 %3, i32 %4 10484 CmpInst::Predicate Pred; 10485 Instruction *L1; 10486 Instruction *L2; 10487 10488 Value *LHS = Select->getTrueValue(); 10489 Value *RHS = Select->getFalseValue(); 10490 Value *Cond = Select->getCondition(); 10491 10492 // TODO: Support inverse predicates. 10493 if (match(Cond, m_Cmp(Pred, m_Specific(LHS), m_Instruction(L2)))) { 10494 if (!isa<ExtractElementInst>(RHS) || 10495 !L2->isIdenticalTo(cast<Instruction>(RHS))) 10496 return RecurKind::None; 10497 } else if (match(Cond, m_Cmp(Pred, m_Instruction(L1), m_Specific(RHS)))) { 10498 if (!isa<ExtractElementInst>(LHS) || 10499 !L1->isIdenticalTo(cast<Instruction>(LHS))) 10500 return RecurKind::None; 10501 } else { 10502 if (!isa<ExtractElementInst>(LHS) || !isa<ExtractElementInst>(RHS)) 10503 return RecurKind::None; 10504 if (!match(Cond, m_Cmp(Pred, m_Instruction(L1), m_Instruction(L2))) || 10505 !L1->isIdenticalTo(cast<Instruction>(LHS)) || 10506 !L2->isIdenticalTo(cast<Instruction>(RHS))) 10507 return RecurKind::None; 10508 } 10509 10510 switch (Pred) { 10511 default: 10512 return RecurKind::None; 10513 case CmpInst::ICMP_SGT: 10514 case CmpInst::ICMP_SGE: 10515 return RecurKind::SMax; 10516 case CmpInst::ICMP_SLT: 10517 case CmpInst::ICMP_SLE: 10518 return RecurKind::SMin; 10519 case CmpInst::ICMP_UGT: 10520 case CmpInst::ICMP_UGE: 10521 return RecurKind::UMax; 10522 case CmpInst::ICMP_ULT: 10523 case CmpInst::ICMP_ULE: 10524 return RecurKind::UMin; 10525 } 10526 } 10527 return RecurKind::None; 10528 } 10529 10530 /// Get the index of the first operand. 10531 static unsigned getFirstOperandIndex(Instruction *I) { 10532 return isCmpSelMinMax(I) ? 1 : 0; 10533 } 10534 10535 /// Total number of operands in the reduction operation. 10536 static unsigned getNumberOfOperands(Instruction *I) { 10537 return isCmpSelMinMax(I) ? 3 : 2; 10538 } 10539 10540 /// Checks if the instruction is in basic block \p BB. 10541 /// For a cmp+sel min/max reduction check that both ops are in \p BB. 10542 static bool hasSameParent(Instruction *I, BasicBlock *BB) { 10543 if (isCmpSelMinMax(I) || (isBoolLogicOp(I) && isa<SelectInst>(I))) { 10544 auto *Sel = cast<SelectInst>(I); 10545 auto *Cmp = dyn_cast<Instruction>(Sel->getCondition()); 10546 return Sel->getParent() == BB && Cmp && Cmp->getParent() == BB; 10547 } 10548 return I->getParent() == BB; 10549 } 10550 10551 /// Expected number of uses for reduction operations/reduced values. 10552 static bool hasRequiredNumberOfUses(bool IsCmpSelMinMax, Instruction *I) { 10553 if (IsCmpSelMinMax) { 10554 // SelectInst must be used twice while the condition op must have single 10555 // use only. 10556 if (auto *Sel = dyn_cast<SelectInst>(I)) 10557 return Sel->hasNUses(2) && Sel->getCondition()->hasOneUse(); 10558 return I->hasNUses(2); 10559 } 10560 10561 // Arithmetic reduction operation must be used once only. 10562 return I->hasOneUse(); 10563 } 10564 10565 /// Initializes the list of reduction operations. 10566 void initReductionOps(Instruction *I) { 10567 if (isCmpSelMinMax(I)) 10568 ReductionOps.assign(2, ReductionOpsType()); 10569 else 10570 ReductionOps.assign(1, ReductionOpsType()); 10571 } 10572 10573 /// Add all reduction operations for the reduction instruction \p I. 10574 void addReductionOps(Instruction *I) { 10575 if (isCmpSelMinMax(I)) { 10576 ReductionOps[0].emplace_back(cast<SelectInst>(I)->getCondition()); 10577 ReductionOps[1].emplace_back(I); 10578 } else { 10579 ReductionOps[0].emplace_back(I); 10580 } 10581 } 10582 10583 static Value *getLHS(RecurKind Kind, Instruction *I) { 10584 if (Kind == RecurKind::None) 10585 return nullptr; 10586 return I->getOperand(getFirstOperandIndex(I)); 10587 } 10588 static Value *getRHS(RecurKind Kind, Instruction *I) { 10589 if (Kind == RecurKind::None) 10590 return nullptr; 10591 return I->getOperand(getFirstOperandIndex(I) + 1); 10592 } 10593 10594 public: 10595 HorizontalReduction() = default; 10596 10597 /// Try to find a reduction tree. 10598 bool matchAssociativeReduction(PHINode *Phi, Instruction *Inst, 10599 ScalarEvolution &SE, const DataLayout &DL, 10600 const TargetLibraryInfo &TLI) { 10601 assert((!Phi || is_contained(Phi->operands(), Inst)) && 10602 "Phi needs to use the binary operator"); 10603 assert((isa<BinaryOperator>(Inst) || isa<SelectInst>(Inst) || 10604 isa<IntrinsicInst>(Inst)) && 10605 "Expected binop, select, or intrinsic for reduction matching"); 10606 RdxKind = getRdxKind(Inst); 10607 10608 // We could have a initial reductions that is not an add. 10609 // r *= v1 + v2 + v3 + v4 10610 // In such a case start looking for a tree rooted in the first '+'. 10611 if (Phi) { 10612 if (getLHS(RdxKind, Inst) == Phi) { 10613 Phi = nullptr; 10614 Inst = dyn_cast<Instruction>(getRHS(RdxKind, Inst)); 10615 if (!Inst) 10616 return false; 10617 RdxKind = getRdxKind(Inst); 10618 } else if (getRHS(RdxKind, Inst) == Phi) { 10619 Phi = nullptr; 10620 Inst = dyn_cast<Instruction>(getLHS(RdxKind, Inst)); 10621 if (!Inst) 10622 return false; 10623 RdxKind = getRdxKind(Inst); 10624 } 10625 } 10626 10627 if (!isVectorizable(RdxKind, Inst)) 10628 return false; 10629 10630 // Analyze "regular" integer/FP types for reductions - no target-specific 10631 // types or pointers. 10632 Type *Ty = Inst->getType(); 10633 if (!isValidElementType(Ty) || Ty->isPointerTy()) 10634 return false; 10635 10636 // Though the ultimate reduction may have multiple uses, its condition must 10637 // have only single use. 10638 if (auto *Sel = dyn_cast<SelectInst>(Inst)) 10639 if (!Sel->getCondition()->hasOneUse()) 10640 return false; 10641 10642 ReductionRoot = Inst; 10643 10644 // Iterate through all the operands of the possible reduction tree and 10645 // gather all the reduced values, sorting them by their value id. 10646 BasicBlock *BB = Inst->getParent(); 10647 bool IsCmpSelMinMax = isCmpSelMinMax(Inst); 10648 SmallVector<Instruction *> Worklist(1, Inst); 10649 // Checks if the operands of the \p TreeN instruction are also reduction 10650 // operations or should be treated as reduced values or an extra argument, 10651 // which is not part of the reduction. 10652 auto &&CheckOperands = [this, IsCmpSelMinMax, 10653 BB](Instruction *TreeN, 10654 SmallVectorImpl<Value *> &ExtraArgs, 10655 SmallVectorImpl<Value *> &PossibleReducedVals, 10656 SmallVectorImpl<Instruction *> &ReductionOps) { 10657 for (int I = getFirstOperandIndex(TreeN), 10658 End = getNumberOfOperands(TreeN); 10659 I < End; ++I) { 10660 Value *EdgeVal = getRdxOperand(TreeN, I); 10661 ReducedValsToOps[EdgeVal].push_back(TreeN); 10662 auto *EdgeInst = dyn_cast<Instruction>(EdgeVal); 10663 // Edge has wrong parent - mark as an extra argument. 10664 if (EdgeInst && !isVectorLikeInstWithConstOps(EdgeInst) && 10665 !hasSameParent(EdgeInst, BB)) { 10666 ExtraArgs.push_back(EdgeVal); 10667 continue; 10668 } 10669 // If the edge is not an instruction, or it is different from the main 10670 // reduction opcode or has too many uses - possible reduced value. 10671 if (!EdgeInst || getRdxKind(EdgeInst) != RdxKind || 10672 IsCmpSelMinMax != isCmpSelMinMax(EdgeInst) || 10673 !hasRequiredNumberOfUses(IsCmpSelMinMax, EdgeInst) || 10674 !isVectorizable(getRdxKind(EdgeInst), EdgeInst)) { 10675 PossibleReducedVals.push_back(EdgeVal); 10676 continue; 10677 } 10678 ReductionOps.push_back(EdgeInst); 10679 } 10680 }; 10681 // Try to regroup reduced values so that it gets more profitable to try to 10682 // reduce them. Values are grouped by their value ids, instructions - by 10683 // instruction op id and/or alternate op id, plus do extra analysis for 10684 // loads (grouping them by the distabce between pointers) and cmp 10685 // instructions (grouping them by the predicate). 10686 MapVector<size_t, MapVector<size_t, MapVector<Value *, unsigned>>> 10687 PossibleReducedVals; 10688 initReductionOps(Inst); 10689 while (!Worklist.empty()) { 10690 Instruction *TreeN = Worklist.pop_back_val(); 10691 SmallVector<Value *> Args; 10692 SmallVector<Value *> PossibleRedVals; 10693 SmallVector<Instruction *> PossibleReductionOps; 10694 CheckOperands(TreeN, Args, PossibleRedVals, PossibleReductionOps); 10695 // If too many extra args - mark the instruction itself as a reduction 10696 // value, not a reduction operation. 10697 if (Args.size() < 2) { 10698 addReductionOps(TreeN); 10699 // Add extra args. 10700 if (!Args.empty()) { 10701 assert(Args.size() == 1 && "Expected only single argument."); 10702 ExtraArgs[TreeN] = Args.front(); 10703 } 10704 // Add reduction values. The values are sorted for better vectorization 10705 // results. 10706 for (Value *V : PossibleRedVals) { 10707 size_t Key, Idx; 10708 std::tie(Key, Idx) = generateKeySubkey( 10709 V, &TLI, 10710 [&PossibleReducedVals, &DL, &SE](size_t Key, LoadInst *LI) { 10711 auto It = PossibleReducedVals.find(Key); 10712 if (It != PossibleReducedVals.end()) { 10713 for (const auto &LoadData : It->second) { 10714 auto *RLI = cast<LoadInst>(LoadData.second.front().first); 10715 if (getPointersDiff(RLI->getType(), 10716 RLI->getPointerOperand(), LI->getType(), 10717 LI->getPointerOperand(), DL, SE, 10718 /*StrictCheck=*/true)) 10719 return hash_value(RLI->getPointerOperand()); 10720 } 10721 } 10722 return hash_value(LI->getPointerOperand()); 10723 }, 10724 /*AllowAlternate=*/false); 10725 ++PossibleReducedVals[Key][Idx] 10726 .insert(std::make_pair(V, 0)) 10727 .first->second; 10728 } 10729 Worklist.append(PossibleReductionOps.rbegin(), 10730 PossibleReductionOps.rend()); 10731 } else { 10732 size_t Key, Idx; 10733 std::tie(Key, Idx) = generateKeySubkey( 10734 TreeN, &TLI, 10735 [&PossibleReducedVals, &DL, &SE](size_t Key, LoadInst *LI) { 10736 auto It = PossibleReducedVals.find(Key); 10737 if (It != PossibleReducedVals.end()) { 10738 for (const auto &LoadData : It->second) { 10739 auto *RLI = cast<LoadInst>(LoadData.second.front().first); 10740 if (getPointersDiff(RLI->getType(), RLI->getPointerOperand(), 10741 LI->getType(), LI->getPointerOperand(), 10742 DL, SE, /*StrictCheck=*/true)) 10743 return hash_value(RLI->getPointerOperand()); 10744 } 10745 } 10746 return hash_value(LI->getPointerOperand()); 10747 }, 10748 /*AllowAlternate=*/false); 10749 ++PossibleReducedVals[Key][Idx] 10750 .insert(std::make_pair(TreeN, 0)) 10751 .first->second; 10752 } 10753 } 10754 auto PossibleReducedValsVect = PossibleReducedVals.takeVector(); 10755 // Sort values by the total number of values kinds to start the reduction 10756 // from the longest possible reduced values sequences. 10757 for (auto &PossibleReducedVals : PossibleReducedValsVect) { 10758 auto PossibleRedVals = PossibleReducedVals.second.takeVector(); 10759 SmallVector<SmallVector<Value *>> PossibleRedValsVect; 10760 for (auto It = PossibleRedVals.begin(), E = PossibleRedVals.end(); 10761 It != E; ++It) { 10762 PossibleRedValsVect.emplace_back(); 10763 auto RedValsVect = It->second.takeVector(); 10764 stable_sort(RedValsVect, [](const auto &P1, const auto &P2) { 10765 return P1.second < P2.second; 10766 }); 10767 for (const std::pair<Value *, unsigned> &Data : RedValsVect) 10768 PossibleRedValsVect.back().append(Data.second, Data.first); 10769 } 10770 stable_sort(PossibleRedValsVect, [](const auto &P1, const auto &P2) { 10771 return P1.size() > P2.size(); 10772 }); 10773 ReducedVals.emplace_back(); 10774 for (ArrayRef<Value *> Data : PossibleRedValsVect) 10775 ReducedVals.back().append(Data.rbegin(), Data.rend()); 10776 } 10777 // Sort the reduced values by number of same/alternate opcode and/or pointer 10778 // operand. 10779 stable_sort(ReducedVals, [](ArrayRef<Value *> P1, ArrayRef<Value *> P2) { 10780 return P1.size() > P2.size(); 10781 }); 10782 return true; 10783 } 10784 10785 /// Attempt to vectorize the tree found by matchAssociativeReduction. 10786 Value *tryToReduce(BoUpSLP &V, TargetTransformInfo *TTI) { 10787 constexpr int ReductionLimit = 4; 10788 constexpr unsigned RegMaxNumber = 4; 10789 constexpr unsigned RedValsMaxNumber = 128; 10790 // If there are a sufficient number of reduction values, reduce 10791 // to a nearby power-of-2. We can safely generate oversized 10792 // vectors and rely on the backend to split them to legal sizes. 10793 unsigned NumReducedVals = std::accumulate( 10794 ReducedVals.begin(), ReducedVals.end(), 0, 10795 [](int Num, ArrayRef<Value *> Vals) { return Num + Vals.size(); }); 10796 if (NumReducedVals < ReductionLimit) 10797 return nullptr; 10798 10799 IRBuilder<> Builder(cast<Instruction>(ReductionRoot)); 10800 10801 // Track the reduced values in case if they are replaced by extractelement 10802 // because of the vectorization. 10803 DenseMap<Value *, WeakTrackingVH> TrackedVals; 10804 BoUpSLP::ExtraValueToDebugLocsMap ExternallyUsedValues; 10805 // The same extra argument may be used several times, so log each attempt 10806 // to use it. 10807 for (const std::pair<Instruction *, Value *> &Pair : ExtraArgs) { 10808 assert(Pair.first && "DebugLoc must be set."); 10809 ExternallyUsedValues[Pair.second].push_back(Pair.first); 10810 TrackedVals.try_emplace(Pair.second, Pair.second); 10811 } 10812 10813 // The compare instruction of a min/max is the insertion point for new 10814 // instructions and may be replaced with a new compare instruction. 10815 auto &&GetCmpForMinMaxReduction = [](Instruction *RdxRootInst) { 10816 assert(isa<SelectInst>(RdxRootInst) && 10817 "Expected min/max reduction to have select root instruction"); 10818 Value *ScalarCond = cast<SelectInst>(RdxRootInst)->getCondition(); 10819 assert(isa<Instruction>(ScalarCond) && 10820 "Expected min/max reduction to have compare condition"); 10821 return cast<Instruction>(ScalarCond); 10822 }; 10823 10824 // The reduction root is used as the insertion point for new instructions, 10825 // so set it as externally used to prevent it from being deleted. 10826 ExternallyUsedValues[ReductionRoot]; 10827 SmallDenseSet<Value *> IgnoreList; 10828 for (ReductionOpsType &RdxOps : ReductionOps) 10829 for (Value *RdxOp : RdxOps) { 10830 if (!RdxOp) 10831 continue; 10832 IgnoreList.insert(RdxOp); 10833 } 10834 bool IsCmpSelMinMax = isCmpSelMinMax(cast<Instruction>(ReductionRoot)); 10835 10836 // Need to track reduced vals, they may be changed during vectorization of 10837 // subvectors. 10838 for (ArrayRef<Value *> Candidates : ReducedVals) 10839 for (Value *V : Candidates) 10840 TrackedVals.try_emplace(V, V); 10841 10842 DenseMap<Value *, unsigned> VectorizedVals; 10843 Value *VectorizedTree = nullptr; 10844 bool CheckForReusedReductionOps = false; 10845 // Try to vectorize elements based on their type. 10846 for (unsigned I = 0, E = ReducedVals.size(); I < E; ++I) { 10847 ArrayRef<Value *> OrigReducedVals = ReducedVals[I]; 10848 InstructionsState S = getSameOpcode(OrigReducedVals); 10849 SmallVector<Value *> Candidates; 10850 DenseMap<Value *, Value *> TrackedToOrig; 10851 for (unsigned Cnt = 0, Sz = OrigReducedVals.size(); Cnt < Sz; ++Cnt) { 10852 Value *RdxVal = TrackedVals.find(OrigReducedVals[Cnt])->second; 10853 // Check if the reduction value was not overriden by the extractelement 10854 // instruction because of the vectorization and exclude it, if it is not 10855 // compatible with other values. 10856 if (auto *Inst = dyn_cast<Instruction>(RdxVal)) 10857 if (isVectorLikeInstWithConstOps(Inst) && 10858 (!S.getOpcode() || !S.isOpcodeOrAlt(Inst))) 10859 continue; 10860 Candidates.push_back(RdxVal); 10861 TrackedToOrig.try_emplace(RdxVal, OrigReducedVals[Cnt]); 10862 } 10863 bool ShuffledExtracts = false; 10864 // Try to handle shuffled extractelements. 10865 if (S.getOpcode() == Instruction::ExtractElement && !S.isAltShuffle() && 10866 I + 1 < E) { 10867 InstructionsState NextS = getSameOpcode(ReducedVals[I + 1]); 10868 if (NextS.getOpcode() == Instruction::ExtractElement && 10869 !NextS.isAltShuffle()) { 10870 SmallVector<Value *> CommonCandidates(Candidates); 10871 for (Value *RV : ReducedVals[I + 1]) { 10872 Value *RdxVal = TrackedVals.find(RV)->second; 10873 // Check if the reduction value was not overriden by the 10874 // extractelement instruction because of the vectorization and 10875 // exclude it, if it is not compatible with other values. 10876 if (auto *Inst = dyn_cast<Instruction>(RdxVal)) 10877 if (!NextS.getOpcode() || !NextS.isOpcodeOrAlt(Inst)) 10878 continue; 10879 CommonCandidates.push_back(RdxVal); 10880 TrackedToOrig.try_emplace(RdxVal, RV); 10881 } 10882 SmallVector<int> Mask; 10883 if (isFixedVectorShuffle(CommonCandidates, Mask)) { 10884 ++I; 10885 Candidates.swap(CommonCandidates); 10886 ShuffledExtracts = true; 10887 } 10888 } 10889 } 10890 unsigned NumReducedVals = Candidates.size(); 10891 if (NumReducedVals < ReductionLimit) 10892 continue; 10893 10894 unsigned MaxVecRegSize = V.getMaxVecRegSize(); 10895 unsigned EltSize = V.getVectorElementSize(Candidates[0]); 10896 unsigned MaxElts = RegMaxNumber * PowerOf2Floor(MaxVecRegSize / EltSize); 10897 10898 unsigned ReduxWidth = std::min<unsigned>( 10899 PowerOf2Floor(NumReducedVals), std::max(RedValsMaxNumber, MaxElts)); 10900 unsigned Start = 0; 10901 unsigned Pos = Start; 10902 // Restarts vectorization attempt with lower vector factor. 10903 unsigned PrevReduxWidth = ReduxWidth; 10904 bool CheckForReusedReductionOpsLocal = false; 10905 auto &&AdjustReducedVals = [&Pos, &Start, &ReduxWidth, NumReducedVals, 10906 &CheckForReusedReductionOpsLocal, 10907 &PrevReduxWidth, &V, 10908 &IgnoreList](bool IgnoreVL = false) { 10909 bool IsAnyRedOpGathered = !IgnoreVL && V.isAnyGathered(IgnoreList); 10910 if (!CheckForReusedReductionOpsLocal && PrevReduxWidth == ReduxWidth) { 10911 // Check if any of the reduction ops are gathered. If so, worth 10912 // trying again with less number of reduction ops. 10913 CheckForReusedReductionOpsLocal |= IsAnyRedOpGathered; 10914 } 10915 ++Pos; 10916 if (Pos < NumReducedVals - ReduxWidth + 1) 10917 return IsAnyRedOpGathered; 10918 Pos = Start; 10919 ReduxWidth /= 2; 10920 return IsAnyRedOpGathered; 10921 }; 10922 while (Pos < NumReducedVals - ReduxWidth + 1 && 10923 ReduxWidth >= ReductionLimit) { 10924 // Dependency in tree of the reduction ops - drop this attempt, try 10925 // later. 10926 if (CheckForReusedReductionOpsLocal && PrevReduxWidth != ReduxWidth && 10927 Start == 0) { 10928 CheckForReusedReductionOps = true; 10929 break; 10930 } 10931 PrevReduxWidth = ReduxWidth; 10932 ArrayRef<Value *> VL(std::next(Candidates.begin(), Pos), ReduxWidth); 10933 // Beeing analyzed already - skip. 10934 if (V.areAnalyzedReductionVals(VL)) { 10935 (void)AdjustReducedVals(/*IgnoreVL=*/true); 10936 continue; 10937 } 10938 // Early exit if any of the reduction values were deleted during 10939 // previous vectorization attempts. 10940 if (any_of(VL, [&V](Value *RedVal) { 10941 auto *RedValI = dyn_cast<Instruction>(RedVal); 10942 if (!RedValI) 10943 return false; 10944 return V.isDeleted(RedValI); 10945 })) 10946 break; 10947 V.buildTree(VL, IgnoreList); 10948 if (V.isTreeTinyAndNotFullyVectorizable(/*ForReduction=*/true)) { 10949 if (!AdjustReducedVals()) 10950 V.analyzedReductionVals(VL); 10951 continue; 10952 } 10953 if (V.isLoadCombineReductionCandidate(RdxKind)) { 10954 if (!AdjustReducedVals()) 10955 V.analyzedReductionVals(VL); 10956 continue; 10957 } 10958 V.reorderTopToBottom(); 10959 // No need to reorder the root node at all. 10960 V.reorderBottomToTop(/*IgnoreReorder=*/true); 10961 // Keep extracted other reduction values, if they are used in the 10962 // vectorization trees. 10963 BoUpSLP::ExtraValueToDebugLocsMap LocalExternallyUsedValues( 10964 ExternallyUsedValues); 10965 for (unsigned Cnt = 0, Sz = ReducedVals.size(); Cnt < Sz; ++Cnt) { 10966 if (Cnt == I || (ShuffledExtracts && Cnt == I - 1)) 10967 continue; 10968 for_each(ReducedVals[Cnt], 10969 [&LocalExternallyUsedValues, &TrackedVals](Value *V) { 10970 if (isa<Instruction>(V)) 10971 LocalExternallyUsedValues[TrackedVals[V]]; 10972 }); 10973 } 10974 // Number of uses of the candidates in the vector of values. 10975 SmallDenseMap<Value *, unsigned> NumUses; 10976 for (unsigned Cnt = 0; Cnt < Pos; ++Cnt) { 10977 Value *V = Candidates[Cnt]; 10978 if (NumUses.count(V) > 0) 10979 continue; 10980 NumUses[V] = std::count(VL.begin(), VL.end(), V); 10981 } 10982 for (unsigned Cnt = Pos + ReduxWidth; Cnt < NumReducedVals; ++Cnt) { 10983 Value *V = Candidates[Cnt]; 10984 if (NumUses.count(V) > 0) 10985 continue; 10986 NumUses[V] = std::count(VL.begin(), VL.end(), V); 10987 } 10988 // Gather externally used values. 10989 SmallPtrSet<Value *, 4> Visited; 10990 for (unsigned Cnt = 0; Cnt < Pos; ++Cnt) { 10991 Value *V = Candidates[Cnt]; 10992 if (!Visited.insert(V).second) 10993 continue; 10994 unsigned NumOps = VectorizedVals.lookup(V) + NumUses[V]; 10995 if (NumOps != ReducedValsToOps.find(V)->second.size()) 10996 LocalExternallyUsedValues[V]; 10997 } 10998 for (unsigned Cnt = Pos + ReduxWidth; Cnt < NumReducedVals; ++Cnt) { 10999 Value *V = Candidates[Cnt]; 11000 if (!Visited.insert(V).second) 11001 continue; 11002 unsigned NumOps = VectorizedVals.lookup(V) + NumUses[V]; 11003 if (NumOps != ReducedValsToOps.find(V)->second.size()) 11004 LocalExternallyUsedValues[V]; 11005 } 11006 V.buildExternalUses(LocalExternallyUsedValues); 11007 11008 V.computeMinimumValueSizes(); 11009 11010 // Intersect the fast-math-flags from all reduction operations. 11011 FastMathFlags RdxFMF; 11012 RdxFMF.set(); 11013 for (Value *U : IgnoreList) 11014 if (auto *FPMO = dyn_cast<FPMathOperator>(U)) 11015 RdxFMF &= FPMO->getFastMathFlags(); 11016 // Estimate cost. 11017 InstructionCost TreeCost = V.getTreeCost(VL); 11018 InstructionCost ReductionCost = 11019 getReductionCost(TTI, VL, ReduxWidth, RdxFMF); 11020 InstructionCost Cost = TreeCost + ReductionCost; 11021 if (!Cost.isValid()) { 11022 LLVM_DEBUG(dbgs() << "Encountered invalid baseline cost.\n"); 11023 return nullptr; 11024 } 11025 if (Cost >= -SLPCostThreshold) { 11026 V.getORE()->emit([&]() { 11027 return OptimizationRemarkMissed( 11028 SV_NAME, "HorSLPNotBeneficial", 11029 ReducedValsToOps.find(VL[0])->second.front()) 11030 << "Vectorizing horizontal reduction is possible" 11031 << "but not beneficial with cost " << ore::NV("Cost", Cost) 11032 << " and threshold " 11033 << ore::NV("Threshold", -SLPCostThreshold); 11034 }); 11035 if (!AdjustReducedVals()) 11036 V.analyzedReductionVals(VL); 11037 continue; 11038 } 11039 11040 LLVM_DEBUG(dbgs() << "SLP: Vectorizing horizontal reduction at cost:" 11041 << Cost << ". (HorRdx)\n"); 11042 V.getORE()->emit([&]() { 11043 return OptimizationRemark( 11044 SV_NAME, "VectorizedHorizontalReduction", 11045 ReducedValsToOps.find(VL[0])->second.front()) 11046 << "Vectorized horizontal reduction with cost " 11047 << ore::NV("Cost", Cost) << " and with tree size " 11048 << ore::NV("TreeSize", V.getTreeSize()); 11049 }); 11050 11051 Builder.setFastMathFlags(RdxFMF); 11052 11053 // Vectorize a tree. 11054 Value *VectorizedRoot = V.vectorizeTree(LocalExternallyUsedValues); 11055 11056 // Emit a reduction. If the root is a select (min/max idiom), the insert 11057 // point is the compare condition of that select. 11058 Instruction *RdxRootInst = cast<Instruction>(ReductionRoot); 11059 if (IsCmpSelMinMax) 11060 Builder.SetInsertPoint(GetCmpForMinMaxReduction(RdxRootInst)); 11061 else 11062 Builder.SetInsertPoint(RdxRootInst); 11063 11064 // To prevent poison from leaking across what used to be sequential, 11065 // safe, scalar boolean logic operations, the reduction operand must be 11066 // frozen. 11067 if (isa<SelectInst>(RdxRootInst) && isBoolLogicOp(RdxRootInst)) 11068 VectorizedRoot = Builder.CreateFreeze(VectorizedRoot); 11069 11070 Value *ReducedSubTree = 11071 emitReduction(VectorizedRoot, Builder, ReduxWidth, TTI); 11072 11073 if (!VectorizedTree) { 11074 // Initialize the final value in the reduction. 11075 VectorizedTree = ReducedSubTree; 11076 } else { 11077 // Update the final value in the reduction. 11078 Builder.SetCurrentDebugLocation( 11079 cast<Instruction>(ReductionOps.front().front())->getDebugLoc()); 11080 VectorizedTree = createOp(Builder, RdxKind, VectorizedTree, 11081 ReducedSubTree, "op.rdx", ReductionOps); 11082 } 11083 // Count vectorized reduced values to exclude them from final reduction. 11084 for (Value *V : VL) 11085 ++VectorizedVals.try_emplace(TrackedToOrig.find(V)->second, 0) 11086 .first->getSecond(); 11087 Pos += ReduxWidth; 11088 Start = Pos; 11089 ReduxWidth = PowerOf2Floor(NumReducedVals - Pos); 11090 } 11091 } 11092 if (VectorizedTree) { 11093 // Finish the reduction. 11094 // Need to add extra arguments and not vectorized possible reduction 11095 // values. 11096 // Try to avoid dependencies between the scalar remainders after 11097 // reductions. 11098 auto &&FinalGen = 11099 [this, &Builder, 11100 &TrackedVals](ArrayRef<std::pair<Instruction *, Value *>> InstVals) { 11101 unsigned Sz = InstVals.size(); 11102 SmallVector<std::pair<Instruction *, Value *>> ExtraReds(Sz / 2 + 11103 Sz % 2); 11104 for (unsigned I = 0, E = (Sz / 2) * 2; I < E; I += 2) { 11105 Instruction *RedOp = InstVals[I + 1].first; 11106 Builder.SetCurrentDebugLocation(RedOp->getDebugLoc()); 11107 Value *RdxVal1 = InstVals[I].second; 11108 Value *StableRdxVal1 = RdxVal1; 11109 auto It1 = TrackedVals.find(RdxVal1); 11110 if (It1 != TrackedVals.end()) 11111 StableRdxVal1 = It1->second; 11112 Value *RdxVal2 = InstVals[I + 1].second; 11113 Value *StableRdxVal2 = RdxVal2; 11114 auto It2 = TrackedVals.find(RdxVal2); 11115 if (It2 != TrackedVals.end()) 11116 StableRdxVal2 = It2->second; 11117 Value *ExtraRed = createOp(Builder, RdxKind, StableRdxVal1, 11118 StableRdxVal2, "op.rdx", ReductionOps); 11119 ExtraReds[I / 2] = std::make_pair(InstVals[I].first, ExtraRed); 11120 } 11121 if (Sz % 2 == 1) 11122 ExtraReds[Sz / 2] = InstVals.back(); 11123 return ExtraReds; 11124 }; 11125 SmallVector<std::pair<Instruction *, Value *>> ExtraReductions; 11126 SmallPtrSet<Value *, 8> Visited; 11127 for (ArrayRef<Value *> Candidates : ReducedVals) { 11128 for (Value *RdxVal : Candidates) { 11129 if (!Visited.insert(RdxVal).second) 11130 continue; 11131 unsigned NumOps = VectorizedVals.lookup(RdxVal); 11132 for (Instruction *RedOp : 11133 makeArrayRef(ReducedValsToOps.find(RdxVal)->second) 11134 .drop_back(NumOps)) 11135 ExtraReductions.emplace_back(RedOp, RdxVal); 11136 } 11137 } 11138 for (auto &Pair : ExternallyUsedValues) { 11139 // Add each externally used value to the final reduction. 11140 for (auto *I : Pair.second) 11141 ExtraReductions.emplace_back(I, Pair.first); 11142 } 11143 // Iterate through all not-vectorized reduction values/extra arguments. 11144 while (ExtraReductions.size() > 1) { 11145 SmallVector<std::pair<Instruction *, Value *>> NewReds = 11146 FinalGen(ExtraReductions); 11147 ExtraReductions.swap(NewReds); 11148 } 11149 // Final reduction. 11150 if (ExtraReductions.size() == 1) { 11151 Instruction *RedOp = ExtraReductions.back().first; 11152 Builder.SetCurrentDebugLocation(RedOp->getDebugLoc()); 11153 Value *RdxVal = ExtraReductions.back().second; 11154 Value *StableRdxVal = RdxVal; 11155 auto It = TrackedVals.find(RdxVal); 11156 if (It != TrackedVals.end()) 11157 StableRdxVal = It->second; 11158 VectorizedTree = createOp(Builder, RdxKind, VectorizedTree, 11159 StableRdxVal, "op.rdx", ReductionOps); 11160 } 11161 11162 ReductionRoot->replaceAllUsesWith(VectorizedTree); 11163 11164 // The original scalar reduction is expected to have no remaining 11165 // uses outside the reduction tree itself. Assert that we got this 11166 // correct, replace internal uses with undef, and mark for eventual 11167 // deletion. 11168 #ifndef NDEBUG 11169 SmallSet<Value *, 4> IgnoreSet; 11170 for (ArrayRef<Value *> RdxOps : ReductionOps) 11171 IgnoreSet.insert(RdxOps.begin(), RdxOps.end()); 11172 #endif 11173 for (ArrayRef<Value *> RdxOps : ReductionOps) { 11174 for (Value *Ignore : RdxOps) { 11175 if (!Ignore) 11176 continue; 11177 #ifndef NDEBUG 11178 for (auto *U : Ignore->users()) { 11179 assert(IgnoreSet.count(U) && 11180 "All users must be either in the reduction ops list."); 11181 } 11182 #endif 11183 if (!Ignore->use_empty()) { 11184 Value *Undef = UndefValue::get(Ignore->getType()); 11185 Ignore->replaceAllUsesWith(Undef); 11186 } 11187 V.eraseInstruction(cast<Instruction>(Ignore)); 11188 } 11189 } 11190 } else if (!CheckForReusedReductionOps) { 11191 for (ReductionOpsType &RdxOps : ReductionOps) 11192 for (Value *RdxOp : RdxOps) 11193 V.analyzedReductionRoot(cast<Instruction>(RdxOp)); 11194 } 11195 return VectorizedTree; 11196 } 11197 11198 private: 11199 /// Calculate the cost of a reduction. 11200 InstructionCost getReductionCost(TargetTransformInfo *TTI, 11201 ArrayRef<Value *> ReducedVals, 11202 unsigned ReduxWidth, FastMathFlags FMF) { 11203 TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput; 11204 Value *FirstReducedVal = ReducedVals.front(); 11205 Type *ScalarTy = FirstReducedVal->getType(); 11206 FixedVectorType *VectorTy = FixedVectorType::get(ScalarTy, ReduxWidth); 11207 InstructionCost VectorCost = 0, ScalarCost; 11208 // If all of the reduced values are constant, the vector cost is 0, since 11209 // the reduction value can be calculated at the compile time. 11210 bool AllConsts = all_of(ReducedVals, isConstant); 11211 switch (RdxKind) { 11212 case RecurKind::Add: 11213 case RecurKind::Mul: 11214 case RecurKind::Or: 11215 case RecurKind::And: 11216 case RecurKind::Xor: 11217 case RecurKind::FAdd: 11218 case RecurKind::FMul: { 11219 unsigned RdxOpcode = RecurrenceDescriptor::getOpcode(RdxKind); 11220 if (!AllConsts) 11221 VectorCost = 11222 TTI->getArithmeticReductionCost(RdxOpcode, VectorTy, FMF, CostKind); 11223 ScalarCost = TTI->getArithmeticInstrCost(RdxOpcode, ScalarTy, CostKind); 11224 break; 11225 } 11226 case RecurKind::FMax: 11227 case RecurKind::FMin: { 11228 auto *SclCondTy = CmpInst::makeCmpResultType(ScalarTy); 11229 if (!AllConsts) { 11230 auto *VecCondTy = 11231 cast<VectorType>(CmpInst::makeCmpResultType(VectorTy)); 11232 VectorCost = 11233 TTI->getMinMaxReductionCost(VectorTy, VecCondTy, 11234 /*IsUnsigned=*/false, CostKind); 11235 } 11236 CmpInst::Predicate RdxPred = getMinMaxReductionPredicate(RdxKind); 11237 ScalarCost = TTI->getCmpSelInstrCost(Instruction::FCmp, ScalarTy, 11238 SclCondTy, RdxPred, CostKind) + 11239 TTI->getCmpSelInstrCost(Instruction::Select, ScalarTy, 11240 SclCondTy, RdxPred, CostKind); 11241 break; 11242 } 11243 case RecurKind::SMax: 11244 case RecurKind::SMin: 11245 case RecurKind::UMax: 11246 case RecurKind::UMin: { 11247 auto *SclCondTy = CmpInst::makeCmpResultType(ScalarTy); 11248 if (!AllConsts) { 11249 auto *VecCondTy = 11250 cast<VectorType>(CmpInst::makeCmpResultType(VectorTy)); 11251 bool IsUnsigned = 11252 RdxKind == RecurKind::UMax || RdxKind == RecurKind::UMin; 11253 VectorCost = TTI->getMinMaxReductionCost(VectorTy, VecCondTy, 11254 IsUnsigned, CostKind); 11255 } 11256 CmpInst::Predicate RdxPred = getMinMaxReductionPredicate(RdxKind); 11257 ScalarCost = TTI->getCmpSelInstrCost(Instruction::ICmp, ScalarTy, 11258 SclCondTy, RdxPred, CostKind) + 11259 TTI->getCmpSelInstrCost(Instruction::Select, ScalarTy, 11260 SclCondTy, RdxPred, CostKind); 11261 break; 11262 } 11263 default: 11264 llvm_unreachable("Expected arithmetic or min/max reduction operation"); 11265 } 11266 11267 // Scalar cost is repeated for N-1 elements. 11268 ScalarCost *= (ReduxWidth - 1); 11269 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << VectorCost - ScalarCost 11270 << " for reduction that starts with " << *FirstReducedVal 11271 << " (It is a splitting reduction)\n"); 11272 return VectorCost - ScalarCost; 11273 } 11274 11275 /// Emit a horizontal reduction of the vectorized value. 11276 Value *emitReduction(Value *VectorizedValue, IRBuilder<> &Builder, 11277 unsigned ReduxWidth, const TargetTransformInfo *TTI) { 11278 assert(VectorizedValue && "Need to have a vectorized tree node"); 11279 assert(isPowerOf2_32(ReduxWidth) && 11280 "We only handle power-of-two reductions for now"); 11281 assert(RdxKind != RecurKind::FMulAdd && 11282 "A call to the llvm.fmuladd intrinsic is not handled yet"); 11283 11284 ++NumVectorInstructions; 11285 return createSimpleTargetReduction(Builder, TTI, VectorizedValue, RdxKind); 11286 } 11287 }; 11288 11289 } // end anonymous namespace 11290 11291 static Optional<unsigned> getAggregateSize(Instruction *InsertInst) { 11292 if (auto *IE = dyn_cast<InsertElementInst>(InsertInst)) 11293 return cast<FixedVectorType>(IE->getType())->getNumElements(); 11294 11295 unsigned AggregateSize = 1; 11296 auto *IV = cast<InsertValueInst>(InsertInst); 11297 Type *CurrentType = IV->getType(); 11298 do { 11299 if (auto *ST = dyn_cast<StructType>(CurrentType)) { 11300 for (auto *Elt : ST->elements()) 11301 if (Elt != ST->getElementType(0)) // check homogeneity 11302 return None; 11303 AggregateSize *= ST->getNumElements(); 11304 CurrentType = ST->getElementType(0); 11305 } else if (auto *AT = dyn_cast<ArrayType>(CurrentType)) { 11306 AggregateSize *= AT->getNumElements(); 11307 CurrentType = AT->getElementType(); 11308 } else if (auto *VT = dyn_cast<FixedVectorType>(CurrentType)) { 11309 AggregateSize *= VT->getNumElements(); 11310 return AggregateSize; 11311 } else if (CurrentType->isSingleValueType()) { 11312 return AggregateSize; 11313 } else { 11314 return None; 11315 } 11316 } while (true); 11317 } 11318 11319 static void findBuildAggregate_rec(Instruction *LastInsertInst, 11320 TargetTransformInfo *TTI, 11321 SmallVectorImpl<Value *> &BuildVectorOpds, 11322 SmallVectorImpl<Value *> &InsertElts, 11323 unsigned OperandOffset) { 11324 do { 11325 Value *InsertedOperand = LastInsertInst->getOperand(1); 11326 Optional<unsigned> OperandIndex = 11327 getInsertIndex(LastInsertInst, OperandOffset); 11328 if (!OperandIndex) 11329 return; 11330 if (isa<InsertElementInst>(InsertedOperand) || 11331 isa<InsertValueInst>(InsertedOperand)) { 11332 findBuildAggregate_rec(cast<Instruction>(InsertedOperand), TTI, 11333 BuildVectorOpds, InsertElts, *OperandIndex); 11334 11335 } else { 11336 BuildVectorOpds[*OperandIndex] = InsertedOperand; 11337 InsertElts[*OperandIndex] = LastInsertInst; 11338 } 11339 LastInsertInst = dyn_cast<Instruction>(LastInsertInst->getOperand(0)); 11340 } while (LastInsertInst != nullptr && 11341 (isa<InsertValueInst>(LastInsertInst) || 11342 isa<InsertElementInst>(LastInsertInst)) && 11343 LastInsertInst->hasOneUse()); 11344 } 11345 11346 /// Recognize construction of vectors like 11347 /// %ra = insertelement <4 x float> poison, float %s0, i32 0 11348 /// %rb = insertelement <4 x float> %ra, float %s1, i32 1 11349 /// %rc = insertelement <4 x float> %rb, float %s2, i32 2 11350 /// %rd = insertelement <4 x float> %rc, float %s3, i32 3 11351 /// starting from the last insertelement or insertvalue instruction. 11352 /// 11353 /// Also recognize homogeneous aggregates like {<2 x float>, <2 x float>}, 11354 /// {{float, float}, {float, float}}, [2 x {float, float}] and so on. 11355 /// See llvm/test/Transforms/SLPVectorizer/X86/pr42022.ll for examples. 11356 /// 11357 /// Assume LastInsertInst is of InsertElementInst or InsertValueInst type. 11358 /// 11359 /// \return true if it matches. 11360 static bool findBuildAggregate(Instruction *LastInsertInst, 11361 TargetTransformInfo *TTI, 11362 SmallVectorImpl<Value *> &BuildVectorOpds, 11363 SmallVectorImpl<Value *> &InsertElts) { 11364 11365 assert((isa<InsertElementInst>(LastInsertInst) || 11366 isa<InsertValueInst>(LastInsertInst)) && 11367 "Expected insertelement or insertvalue instruction!"); 11368 11369 assert((BuildVectorOpds.empty() && InsertElts.empty()) && 11370 "Expected empty result vectors!"); 11371 11372 Optional<unsigned> AggregateSize = getAggregateSize(LastInsertInst); 11373 if (!AggregateSize) 11374 return false; 11375 BuildVectorOpds.resize(*AggregateSize); 11376 InsertElts.resize(*AggregateSize); 11377 11378 findBuildAggregate_rec(LastInsertInst, TTI, BuildVectorOpds, InsertElts, 0); 11379 llvm::erase_value(BuildVectorOpds, nullptr); 11380 llvm::erase_value(InsertElts, nullptr); 11381 if (BuildVectorOpds.size() >= 2) 11382 return true; 11383 11384 return false; 11385 } 11386 11387 /// Try and get a reduction value from a phi node. 11388 /// 11389 /// Given a phi node \p P in a block \p ParentBB, consider possible reductions 11390 /// if they come from either \p ParentBB or a containing loop latch. 11391 /// 11392 /// \returns A candidate reduction value if possible, or \code nullptr \endcode 11393 /// if not possible. 11394 static Value *getReductionValue(const DominatorTree *DT, PHINode *P, 11395 BasicBlock *ParentBB, LoopInfo *LI) { 11396 // There are situations where the reduction value is not dominated by the 11397 // reduction phi. Vectorizing such cases has been reported to cause 11398 // miscompiles. See PR25787. 11399 auto DominatedReduxValue = [&](Value *R) { 11400 return isa<Instruction>(R) && 11401 DT->dominates(P->getParent(), cast<Instruction>(R)->getParent()); 11402 }; 11403 11404 Value *Rdx = nullptr; 11405 11406 // Return the incoming value if it comes from the same BB as the phi node. 11407 if (P->getIncomingBlock(0) == ParentBB) { 11408 Rdx = P->getIncomingValue(0); 11409 } else if (P->getIncomingBlock(1) == ParentBB) { 11410 Rdx = P->getIncomingValue(1); 11411 } 11412 11413 if (Rdx && DominatedReduxValue(Rdx)) 11414 return Rdx; 11415 11416 // Otherwise, check whether we have a loop latch to look at. 11417 Loop *BBL = LI->getLoopFor(ParentBB); 11418 if (!BBL) 11419 return nullptr; 11420 BasicBlock *BBLatch = BBL->getLoopLatch(); 11421 if (!BBLatch) 11422 return nullptr; 11423 11424 // There is a loop latch, return the incoming value if it comes from 11425 // that. This reduction pattern occasionally turns up. 11426 if (P->getIncomingBlock(0) == BBLatch) { 11427 Rdx = P->getIncomingValue(0); 11428 } else if (P->getIncomingBlock(1) == BBLatch) { 11429 Rdx = P->getIncomingValue(1); 11430 } 11431 11432 if (Rdx && DominatedReduxValue(Rdx)) 11433 return Rdx; 11434 11435 return nullptr; 11436 } 11437 11438 static bool matchRdxBop(Instruction *I, Value *&V0, Value *&V1) { 11439 if (match(I, m_BinOp(m_Value(V0), m_Value(V1)))) 11440 return true; 11441 if (match(I, m_Intrinsic<Intrinsic::maxnum>(m_Value(V0), m_Value(V1)))) 11442 return true; 11443 if (match(I, m_Intrinsic<Intrinsic::minnum>(m_Value(V0), m_Value(V1)))) 11444 return true; 11445 if (match(I, m_Intrinsic<Intrinsic::smax>(m_Value(V0), m_Value(V1)))) 11446 return true; 11447 if (match(I, m_Intrinsic<Intrinsic::smin>(m_Value(V0), m_Value(V1)))) 11448 return true; 11449 if (match(I, m_Intrinsic<Intrinsic::umax>(m_Value(V0), m_Value(V1)))) 11450 return true; 11451 if (match(I, m_Intrinsic<Intrinsic::umin>(m_Value(V0), m_Value(V1)))) 11452 return true; 11453 return false; 11454 } 11455 11456 /// Attempt to reduce a horizontal reduction. 11457 /// If it is legal to match a horizontal reduction feeding the phi node \a P 11458 /// with reduction operators \a Root (or one of its operands) in a basic block 11459 /// \a BB, then check if it can be done. If horizontal reduction is not found 11460 /// and root instruction is a binary operation, vectorization of the operands is 11461 /// attempted. 11462 /// \returns true if a horizontal reduction was matched and reduced or operands 11463 /// of one of the binary instruction were vectorized. 11464 /// \returns false if a horizontal reduction was not matched (or not possible) 11465 /// or no vectorization of any binary operation feeding \a Root instruction was 11466 /// performed. 11467 static bool tryToVectorizeHorReductionOrInstOperands( 11468 PHINode *P, Instruction *Root, BasicBlock *BB, BoUpSLP &R, 11469 TargetTransformInfo *TTI, ScalarEvolution &SE, const DataLayout &DL, 11470 const TargetLibraryInfo &TLI, 11471 const function_ref<bool(Instruction *, BoUpSLP &)> Vectorize) { 11472 if (!ShouldVectorizeHor) 11473 return false; 11474 11475 if (!Root) 11476 return false; 11477 11478 if (Root->getParent() != BB || isa<PHINode>(Root)) 11479 return false; 11480 // Start analysis starting from Root instruction. If horizontal reduction is 11481 // found, try to vectorize it. If it is not a horizontal reduction or 11482 // vectorization is not possible or not effective, and currently analyzed 11483 // instruction is a binary operation, try to vectorize the operands, using 11484 // pre-order DFS traversal order. If the operands were not vectorized, repeat 11485 // the same procedure considering each operand as a possible root of the 11486 // horizontal reduction. 11487 // Interrupt the process if the Root instruction itself was vectorized or all 11488 // sub-trees not higher that RecursionMaxDepth were analyzed/vectorized. 11489 // Skip the analysis of CmpInsts. Compiler implements postanalysis of the 11490 // CmpInsts so we can skip extra attempts in 11491 // tryToVectorizeHorReductionOrInstOperands and save compile time. 11492 std::queue<std::pair<Instruction *, unsigned>> Stack; 11493 Stack.emplace(Root, 0); 11494 SmallPtrSet<Value *, 8> VisitedInstrs; 11495 SmallVector<WeakTrackingVH> PostponedInsts; 11496 bool Res = false; 11497 auto &&TryToReduce = [TTI, &SE, &DL, &P, &R, &TLI](Instruction *Inst, 11498 Value *&B0, 11499 Value *&B1) -> Value * { 11500 if (R.isAnalyzedReductionRoot(Inst)) 11501 return nullptr; 11502 bool IsBinop = matchRdxBop(Inst, B0, B1); 11503 bool IsSelect = match(Inst, m_Select(m_Value(), m_Value(), m_Value())); 11504 if (IsBinop || IsSelect) { 11505 HorizontalReduction HorRdx; 11506 if (HorRdx.matchAssociativeReduction(P, Inst, SE, DL, TLI)) 11507 return HorRdx.tryToReduce(R, TTI); 11508 } 11509 return nullptr; 11510 }; 11511 while (!Stack.empty()) { 11512 Instruction *Inst; 11513 unsigned Level; 11514 std::tie(Inst, Level) = Stack.front(); 11515 Stack.pop(); 11516 // Do not try to analyze instruction that has already been vectorized. 11517 // This may happen when we vectorize instruction operands on a previous 11518 // iteration while stack was populated before that happened. 11519 if (R.isDeleted(Inst)) 11520 continue; 11521 Value *B0 = nullptr, *B1 = nullptr; 11522 if (Value *V = TryToReduce(Inst, B0, B1)) { 11523 Res = true; 11524 // Set P to nullptr to avoid re-analysis of phi node in 11525 // matchAssociativeReduction function unless this is the root node. 11526 P = nullptr; 11527 if (auto *I = dyn_cast<Instruction>(V)) { 11528 // Try to find another reduction. 11529 Stack.emplace(I, Level); 11530 continue; 11531 } 11532 } else { 11533 bool IsBinop = B0 && B1; 11534 if (P && IsBinop) { 11535 Inst = dyn_cast<Instruction>(B0); 11536 if (Inst == P) 11537 Inst = dyn_cast<Instruction>(B1); 11538 if (!Inst) { 11539 // Set P to nullptr to avoid re-analysis of phi node in 11540 // matchAssociativeReduction function unless this is the root node. 11541 P = nullptr; 11542 continue; 11543 } 11544 } 11545 // Set P to nullptr to avoid re-analysis of phi node in 11546 // matchAssociativeReduction function unless this is the root node. 11547 P = nullptr; 11548 // Do not try to vectorize CmpInst operands, this is done separately. 11549 // Final attempt for binop args vectorization should happen after the loop 11550 // to try to find reductions. 11551 if (!isa<CmpInst, InsertElementInst, InsertValueInst>(Inst)) 11552 PostponedInsts.push_back(Inst); 11553 } 11554 11555 // Try to vectorize operands. 11556 // Continue analysis for the instruction from the same basic block only to 11557 // save compile time. 11558 if (++Level < RecursionMaxDepth) 11559 for (auto *Op : Inst->operand_values()) 11560 if (VisitedInstrs.insert(Op).second) 11561 if (auto *I = dyn_cast<Instruction>(Op)) 11562 // Do not try to vectorize CmpInst operands, this is done 11563 // separately. 11564 if (!isa<PHINode, CmpInst, InsertElementInst, InsertValueInst>(I) && 11565 !R.isDeleted(I) && I->getParent() == BB) 11566 Stack.emplace(I, Level); 11567 } 11568 // Try to vectorized binops where reductions were not found. 11569 for (Value *V : PostponedInsts) 11570 if (auto *Inst = dyn_cast<Instruction>(V)) 11571 if (!R.isDeleted(Inst)) 11572 Res |= Vectorize(Inst, R); 11573 return Res; 11574 } 11575 11576 bool SLPVectorizerPass::vectorizeRootInstruction(PHINode *P, Value *V, 11577 BasicBlock *BB, BoUpSLP &R, 11578 TargetTransformInfo *TTI) { 11579 auto *I = dyn_cast_or_null<Instruction>(V); 11580 if (!I) 11581 return false; 11582 11583 if (!isa<BinaryOperator>(I)) 11584 P = nullptr; 11585 // Try to match and vectorize a horizontal reduction. 11586 auto &&ExtraVectorization = [this](Instruction *I, BoUpSLP &R) -> bool { 11587 return tryToVectorize(I, R); 11588 }; 11589 return tryToVectorizeHorReductionOrInstOperands(P, I, BB, R, TTI, *SE, *DL, 11590 *TLI, ExtraVectorization); 11591 } 11592 11593 bool SLPVectorizerPass::vectorizeInsertValueInst(InsertValueInst *IVI, 11594 BasicBlock *BB, BoUpSLP &R) { 11595 const DataLayout &DL = BB->getModule()->getDataLayout(); 11596 if (!R.canMapToVector(IVI->getType(), DL)) 11597 return false; 11598 11599 SmallVector<Value *, 16> BuildVectorOpds; 11600 SmallVector<Value *, 16> BuildVectorInsts; 11601 if (!findBuildAggregate(IVI, TTI, BuildVectorOpds, BuildVectorInsts)) 11602 return false; 11603 11604 LLVM_DEBUG(dbgs() << "SLP: array mappable to vector: " << *IVI << "\n"); 11605 // Aggregate value is unlikely to be processed in vector register. 11606 return tryToVectorizeList(BuildVectorOpds, R); 11607 } 11608 11609 bool SLPVectorizerPass::vectorizeInsertElementInst(InsertElementInst *IEI, 11610 BasicBlock *BB, BoUpSLP &R) { 11611 SmallVector<Value *, 16> BuildVectorInsts; 11612 SmallVector<Value *, 16> BuildVectorOpds; 11613 SmallVector<int> Mask; 11614 if (!findBuildAggregate(IEI, TTI, BuildVectorOpds, BuildVectorInsts) || 11615 (llvm::all_of( 11616 BuildVectorOpds, 11617 [](Value *V) { return isa<ExtractElementInst, UndefValue>(V); }) && 11618 isFixedVectorShuffle(BuildVectorOpds, Mask))) 11619 return false; 11620 11621 LLVM_DEBUG(dbgs() << "SLP: array mappable to vector: " << *IEI << "\n"); 11622 return tryToVectorizeList(BuildVectorInsts, R); 11623 } 11624 11625 template <typename T> 11626 static bool 11627 tryToVectorizeSequence(SmallVectorImpl<T *> &Incoming, 11628 function_ref<unsigned(T *)> Limit, 11629 function_ref<bool(T *, T *)> Comparator, 11630 function_ref<bool(T *, T *)> AreCompatible, 11631 function_ref<bool(ArrayRef<T *>, bool)> TryToVectorizeHelper, 11632 bool LimitForRegisterSize) { 11633 bool Changed = false; 11634 // Sort by type, parent, operands. 11635 stable_sort(Incoming, Comparator); 11636 11637 // Try to vectorize elements base on their type. 11638 SmallVector<T *> Candidates; 11639 for (auto *IncIt = Incoming.begin(), *E = Incoming.end(); IncIt != E;) { 11640 // Look for the next elements with the same type, parent and operand 11641 // kinds. 11642 auto *SameTypeIt = IncIt; 11643 while (SameTypeIt != E && AreCompatible(*SameTypeIt, *IncIt)) 11644 ++SameTypeIt; 11645 11646 // Try to vectorize them. 11647 unsigned NumElts = (SameTypeIt - IncIt); 11648 LLVM_DEBUG(dbgs() << "SLP: Trying to vectorize starting at nodes (" 11649 << NumElts << ")\n"); 11650 // The vectorization is a 3-state attempt: 11651 // 1. Try to vectorize instructions with the same/alternate opcodes with the 11652 // size of maximal register at first. 11653 // 2. Try to vectorize remaining instructions with the same type, if 11654 // possible. This may result in the better vectorization results rather than 11655 // if we try just to vectorize instructions with the same/alternate opcodes. 11656 // 3. Final attempt to try to vectorize all instructions with the 11657 // same/alternate ops only, this may result in some extra final 11658 // vectorization. 11659 if (NumElts > 1 && 11660 TryToVectorizeHelper(makeArrayRef(IncIt, NumElts), LimitForRegisterSize)) { 11661 // Success start over because instructions might have been changed. 11662 Changed = true; 11663 } else if (NumElts < Limit(*IncIt) && 11664 (Candidates.empty() || 11665 Candidates.front()->getType() == (*IncIt)->getType())) { 11666 Candidates.append(IncIt, std::next(IncIt, NumElts)); 11667 } 11668 // Final attempt to vectorize instructions with the same types. 11669 if (Candidates.size() > 1 && 11670 (SameTypeIt == E || (*SameTypeIt)->getType() != (*IncIt)->getType())) { 11671 if (TryToVectorizeHelper(Candidates, /*LimitForRegisterSize=*/false)) { 11672 // Success start over because instructions might have been changed. 11673 Changed = true; 11674 } else if (LimitForRegisterSize) { 11675 // Try to vectorize using small vectors. 11676 for (auto *It = Candidates.begin(), *End = Candidates.end(); 11677 It != End;) { 11678 auto *SameTypeIt = It; 11679 while (SameTypeIt != End && AreCompatible(*SameTypeIt, *It)) 11680 ++SameTypeIt; 11681 unsigned NumElts = (SameTypeIt - It); 11682 if (NumElts > 1 && TryToVectorizeHelper(makeArrayRef(It, NumElts), 11683 /*LimitForRegisterSize=*/false)) 11684 Changed = true; 11685 It = SameTypeIt; 11686 } 11687 } 11688 Candidates.clear(); 11689 } 11690 11691 // Start over at the next instruction of a different type (or the end). 11692 IncIt = SameTypeIt; 11693 } 11694 return Changed; 11695 } 11696 11697 /// Compare two cmp instructions. If IsCompatibility is true, function returns 11698 /// true if 2 cmps have same/swapped predicates and mos compatible corresponding 11699 /// operands. If IsCompatibility is false, function implements strict weak 11700 /// ordering relation between two cmp instructions, returning true if the first 11701 /// instruction is "less" than the second, i.e. its predicate is less than the 11702 /// predicate of the second or the operands IDs are less than the operands IDs 11703 /// of the second cmp instruction. 11704 template <bool IsCompatibility> 11705 static bool compareCmp(Value *V, Value *V2, 11706 function_ref<bool(Instruction *)> IsDeleted) { 11707 auto *CI1 = cast<CmpInst>(V); 11708 auto *CI2 = cast<CmpInst>(V2); 11709 if (IsDeleted(CI2) || !isValidElementType(CI2->getType())) 11710 return false; 11711 if (CI1->getOperand(0)->getType()->getTypeID() < 11712 CI2->getOperand(0)->getType()->getTypeID()) 11713 return !IsCompatibility; 11714 if (CI1->getOperand(0)->getType()->getTypeID() > 11715 CI2->getOperand(0)->getType()->getTypeID()) 11716 return false; 11717 CmpInst::Predicate Pred1 = CI1->getPredicate(); 11718 CmpInst::Predicate Pred2 = CI2->getPredicate(); 11719 CmpInst::Predicate SwapPred1 = CmpInst::getSwappedPredicate(Pred1); 11720 CmpInst::Predicate SwapPred2 = CmpInst::getSwappedPredicate(Pred2); 11721 CmpInst::Predicate BasePred1 = std::min(Pred1, SwapPred1); 11722 CmpInst::Predicate BasePred2 = std::min(Pred2, SwapPred2); 11723 if (BasePred1 < BasePred2) 11724 return !IsCompatibility; 11725 if (BasePred1 > BasePred2) 11726 return false; 11727 // Compare operands. 11728 bool LEPreds = Pred1 <= Pred2; 11729 bool GEPreds = Pred1 >= Pred2; 11730 for (int I = 0, E = CI1->getNumOperands(); I < E; ++I) { 11731 auto *Op1 = CI1->getOperand(LEPreds ? I : E - I - 1); 11732 auto *Op2 = CI2->getOperand(GEPreds ? I : E - I - 1); 11733 if (Op1->getValueID() < Op2->getValueID()) 11734 return !IsCompatibility; 11735 if (Op1->getValueID() > Op2->getValueID()) 11736 return false; 11737 if (auto *I1 = dyn_cast<Instruction>(Op1)) 11738 if (auto *I2 = dyn_cast<Instruction>(Op2)) { 11739 if (I1->getParent() != I2->getParent()) 11740 return false; 11741 InstructionsState S = getSameOpcode({I1, I2}); 11742 if (S.getOpcode()) 11743 continue; 11744 return false; 11745 } 11746 } 11747 return IsCompatibility; 11748 } 11749 11750 bool SLPVectorizerPass::vectorizeSimpleInstructions( 11751 SmallVectorImpl<Instruction *> &Instructions, BasicBlock *BB, BoUpSLP &R, 11752 bool AtTerminator) { 11753 bool OpsChanged = false; 11754 SmallVector<Instruction *, 4> PostponedCmps; 11755 for (auto *I : reverse(Instructions)) { 11756 if (R.isDeleted(I)) 11757 continue; 11758 if (auto *LastInsertValue = dyn_cast<InsertValueInst>(I)) { 11759 OpsChanged |= vectorizeInsertValueInst(LastInsertValue, BB, R); 11760 } else if (auto *LastInsertElem = dyn_cast<InsertElementInst>(I)) { 11761 OpsChanged |= vectorizeInsertElementInst(LastInsertElem, BB, R); 11762 } else if (isa<CmpInst>(I)) { 11763 PostponedCmps.push_back(I); 11764 continue; 11765 } 11766 // Try to find reductions in buildvector sequnces. 11767 OpsChanged |= vectorizeRootInstruction(nullptr, I, BB, R, TTI); 11768 } 11769 if (AtTerminator) { 11770 // Try to find reductions first. 11771 for (Instruction *I : PostponedCmps) { 11772 if (R.isDeleted(I)) 11773 continue; 11774 for (Value *Op : I->operands()) 11775 OpsChanged |= vectorizeRootInstruction(nullptr, Op, BB, R, TTI); 11776 } 11777 // Try to vectorize operands as vector bundles. 11778 for (Instruction *I : PostponedCmps) { 11779 if (R.isDeleted(I)) 11780 continue; 11781 OpsChanged |= tryToVectorize(I, R); 11782 } 11783 // Try to vectorize list of compares. 11784 // Sort by type, compare predicate, etc. 11785 auto &&CompareSorter = [&R](Value *V, Value *V2) { 11786 return compareCmp<false>(V, V2, 11787 [&R](Instruction *I) { return R.isDeleted(I); }); 11788 }; 11789 11790 auto &&AreCompatibleCompares = [&R](Value *V1, Value *V2) { 11791 if (V1 == V2) 11792 return true; 11793 return compareCmp<true>(V1, V2, 11794 [&R](Instruction *I) { return R.isDeleted(I); }); 11795 }; 11796 auto Limit = [&R](Value *V) { 11797 unsigned EltSize = R.getVectorElementSize(V); 11798 return std::max(2U, R.getMaxVecRegSize() / EltSize); 11799 }; 11800 11801 SmallVector<Value *> Vals(PostponedCmps.begin(), PostponedCmps.end()); 11802 OpsChanged |= tryToVectorizeSequence<Value>( 11803 Vals, Limit, CompareSorter, AreCompatibleCompares, 11804 [this, &R](ArrayRef<Value *> Candidates, bool LimitForRegisterSize) { 11805 // Exclude possible reductions from other blocks. 11806 bool ArePossiblyReducedInOtherBlock = 11807 any_of(Candidates, [](Value *V) { 11808 return any_of(V->users(), [V](User *U) { 11809 return isa<SelectInst>(U) && 11810 cast<SelectInst>(U)->getParent() != 11811 cast<Instruction>(V)->getParent(); 11812 }); 11813 }); 11814 if (ArePossiblyReducedInOtherBlock) 11815 return false; 11816 return tryToVectorizeList(Candidates, R, LimitForRegisterSize); 11817 }, 11818 /*LimitForRegisterSize=*/true); 11819 Instructions.clear(); 11820 } else { 11821 // Insert in reverse order since the PostponedCmps vector was filled in 11822 // reverse order. 11823 Instructions.assign(PostponedCmps.rbegin(), PostponedCmps.rend()); 11824 } 11825 return OpsChanged; 11826 } 11827 11828 bool SLPVectorizerPass::vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R) { 11829 bool Changed = false; 11830 SmallVector<Value *, 4> Incoming; 11831 SmallPtrSet<Value *, 16> VisitedInstrs; 11832 // Maps phi nodes to the non-phi nodes found in the use tree for each phi 11833 // node. Allows better to identify the chains that can be vectorized in the 11834 // better way. 11835 DenseMap<Value *, SmallVector<Value *, 4>> PHIToOpcodes; 11836 auto PHICompare = [this, &PHIToOpcodes](Value *V1, Value *V2) { 11837 assert(isValidElementType(V1->getType()) && 11838 isValidElementType(V2->getType()) && 11839 "Expected vectorizable types only."); 11840 // It is fine to compare type IDs here, since we expect only vectorizable 11841 // types, like ints, floats and pointers, we don't care about other type. 11842 if (V1->getType()->getTypeID() < V2->getType()->getTypeID()) 11843 return true; 11844 if (V1->getType()->getTypeID() > V2->getType()->getTypeID()) 11845 return false; 11846 ArrayRef<Value *> Opcodes1 = PHIToOpcodes[V1]; 11847 ArrayRef<Value *> Opcodes2 = PHIToOpcodes[V2]; 11848 if (Opcodes1.size() < Opcodes2.size()) 11849 return true; 11850 if (Opcodes1.size() > Opcodes2.size()) 11851 return false; 11852 Optional<bool> ConstOrder; 11853 for (int I = 0, E = Opcodes1.size(); I < E; ++I) { 11854 // Undefs are compatible with any other value. 11855 if (isa<UndefValue>(Opcodes1[I]) || isa<UndefValue>(Opcodes2[I])) { 11856 if (!ConstOrder) 11857 ConstOrder = 11858 !isa<UndefValue>(Opcodes1[I]) && isa<UndefValue>(Opcodes2[I]); 11859 continue; 11860 } 11861 if (auto *I1 = dyn_cast<Instruction>(Opcodes1[I])) 11862 if (auto *I2 = dyn_cast<Instruction>(Opcodes2[I])) { 11863 DomTreeNodeBase<BasicBlock> *NodeI1 = DT->getNode(I1->getParent()); 11864 DomTreeNodeBase<BasicBlock> *NodeI2 = DT->getNode(I2->getParent()); 11865 if (!NodeI1) 11866 return NodeI2 != nullptr; 11867 if (!NodeI2) 11868 return false; 11869 assert((NodeI1 == NodeI2) == 11870 (NodeI1->getDFSNumIn() == NodeI2->getDFSNumIn()) && 11871 "Different nodes should have different DFS numbers"); 11872 if (NodeI1 != NodeI2) 11873 return NodeI1->getDFSNumIn() < NodeI2->getDFSNumIn(); 11874 InstructionsState S = getSameOpcode({I1, I2}); 11875 if (S.getOpcode()) 11876 continue; 11877 return I1->getOpcode() < I2->getOpcode(); 11878 } 11879 if (isa<Constant>(Opcodes1[I]) && isa<Constant>(Opcodes2[I])) { 11880 if (!ConstOrder) 11881 ConstOrder = Opcodes1[I]->getValueID() < Opcodes2[I]->getValueID(); 11882 continue; 11883 } 11884 if (Opcodes1[I]->getValueID() < Opcodes2[I]->getValueID()) 11885 return true; 11886 if (Opcodes1[I]->getValueID() > Opcodes2[I]->getValueID()) 11887 return false; 11888 } 11889 return ConstOrder && *ConstOrder; 11890 }; 11891 auto AreCompatiblePHIs = [&PHIToOpcodes](Value *V1, Value *V2) { 11892 if (V1 == V2) 11893 return true; 11894 if (V1->getType() != V2->getType()) 11895 return false; 11896 ArrayRef<Value *> Opcodes1 = PHIToOpcodes[V1]; 11897 ArrayRef<Value *> Opcodes2 = PHIToOpcodes[V2]; 11898 if (Opcodes1.size() != Opcodes2.size()) 11899 return false; 11900 for (int I = 0, E = Opcodes1.size(); I < E; ++I) { 11901 // Undefs are compatible with any other value. 11902 if (isa<UndefValue>(Opcodes1[I]) || isa<UndefValue>(Opcodes2[I])) 11903 continue; 11904 if (auto *I1 = dyn_cast<Instruction>(Opcodes1[I])) 11905 if (auto *I2 = dyn_cast<Instruction>(Opcodes2[I])) { 11906 if (I1->getParent() != I2->getParent()) 11907 return false; 11908 InstructionsState S = getSameOpcode({I1, I2}); 11909 if (S.getOpcode()) 11910 continue; 11911 return false; 11912 } 11913 if (isa<Constant>(Opcodes1[I]) && isa<Constant>(Opcodes2[I])) 11914 continue; 11915 if (Opcodes1[I]->getValueID() != Opcodes2[I]->getValueID()) 11916 return false; 11917 } 11918 return true; 11919 }; 11920 auto Limit = [&R](Value *V) { 11921 unsigned EltSize = R.getVectorElementSize(V); 11922 return std::max(2U, R.getMaxVecRegSize() / EltSize); 11923 }; 11924 11925 bool HaveVectorizedPhiNodes = false; 11926 do { 11927 // Collect the incoming values from the PHIs. 11928 Incoming.clear(); 11929 for (Instruction &I : *BB) { 11930 PHINode *P = dyn_cast<PHINode>(&I); 11931 if (!P) 11932 break; 11933 11934 // No need to analyze deleted, vectorized and non-vectorizable 11935 // instructions. 11936 if (!VisitedInstrs.count(P) && !R.isDeleted(P) && 11937 isValidElementType(P->getType())) 11938 Incoming.push_back(P); 11939 } 11940 11941 // Find the corresponding non-phi nodes for better matching when trying to 11942 // build the tree. 11943 for (Value *V : Incoming) { 11944 SmallVectorImpl<Value *> &Opcodes = 11945 PHIToOpcodes.try_emplace(V).first->getSecond(); 11946 if (!Opcodes.empty()) 11947 continue; 11948 SmallVector<Value *, 4> Nodes(1, V); 11949 SmallPtrSet<Value *, 4> Visited; 11950 while (!Nodes.empty()) { 11951 auto *PHI = cast<PHINode>(Nodes.pop_back_val()); 11952 if (!Visited.insert(PHI).second) 11953 continue; 11954 for (Value *V : PHI->incoming_values()) { 11955 if (auto *PHI1 = dyn_cast<PHINode>((V))) { 11956 Nodes.push_back(PHI1); 11957 continue; 11958 } 11959 Opcodes.emplace_back(V); 11960 } 11961 } 11962 } 11963 11964 HaveVectorizedPhiNodes = tryToVectorizeSequence<Value>( 11965 Incoming, Limit, PHICompare, AreCompatiblePHIs, 11966 [this, &R](ArrayRef<Value *> Candidates, bool LimitForRegisterSize) { 11967 return tryToVectorizeList(Candidates, R, LimitForRegisterSize); 11968 }, 11969 /*LimitForRegisterSize=*/true); 11970 Changed |= HaveVectorizedPhiNodes; 11971 VisitedInstrs.insert(Incoming.begin(), Incoming.end()); 11972 } while (HaveVectorizedPhiNodes); 11973 11974 VisitedInstrs.clear(); 11975 11976 SmallVector<Instruction *, 8> PostProcessInstructions; 11977 SmallDenseSet<Instruction *, 4> KeyNodes; 11978 for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) { 11979 // Skip instructions with scalable type. The num of elements is unknown at 11980 // compile-time for scalable type. 11981 if (isa<ScalableVectorType>(it->getType())) 11982 continue; 11983 11984 // Skip instructions marked for the deletion. 11985 if (R.isDeleted(&*it)) 11986 continue; 11987 // We may go through BB multiple times so skip the one we have checked. 11988 if (!VisitedInstrs.insert(&*it).second) { 11989 if (it->use_empty() && KeyNodes.contains(&*it) && 11990 vectorizeSimpleInstructions(PostProcessInstructions, BB, R, 11991 it->isTerminator())) { 11992 // We would like to start over since some instructions are deleted 11993 // and the iterator may become invalid value. 11994 Changed = true; 11995 it = BB->begin(); 11996 e = BB->end(); 11997 } 11998 continue; 11999 } 12000 12001 if (isa<DbgInfoIntrinsic>(it)) 12002 continue; 12003 12004 // Try to vectorize reductions that use PHINodes. 12005 if (PHINode *P = dyn_cast<PHINode>(it)) { 12006 // Check that the PHI is a reduction PHI. 12007 if (P->getNumIncomingValues() == 2) { 12008 // Try to match and vectorize a horizontal reduction. 12009 if (vectorizeRootInstruction(P, getReductionValue(DT, P, BB, LI), BB, R, 12010 TTI)) { 12011 Changed = true; 12012 it = BB->begin(); 12013 e = BB->end(); 12014 continue; 12015 } 12016 } 12017 // Try to vectorize the incoming values of the PHI, to catch reductions 12018 // that feed into PHIs. 12019 for (unsigned I = 0, E = P->getNumIncomingValues(); I != E; I++) { 12020 // Skip if the incoming block is the current BB for now. Also, bypass 12021 // unreachable IR for efficiency and to avoid crashing. 12022 // TODO: Collect the skipped incoming values and try to vectorize them 12023 // after processing BB. 12024 if (BB == P->getIncomingBlock(I) || 12025 !DT->isReachableFromEntry(P->getIncomingBlock(I))) 12026 continue; 12027 12028 Changed |= vectorizeRootInstruction(nullptr, P->getIncomingValue(I), 12029 P->getIncomingBlock(I), R, TTI); 12030 } 12031 continue; 12032 } 12033 12034 // Ran into an instruction without users, like terminator, or function call 12035 // with ignored return value, store. Ignore unused instructions (basing on 12036 // instruction type, except for CallInst and InvokeInst). 12037 if (it->use_empty() && (it->getType()->isVoidTy() || isa<CallInst>(it) || 12038 isa<InvokeInst>(it))) { 12039 KeyNodes.insert(&*it); 12040 bool OpsChanged = false; 12041 if (ShouldStartVectorizeHorAtStore || !isa<StoreInst>(it)) { 12042 for (auto *V : it->operand_values()) { 12043 // Try to match and vectorize a horizontal reduction. 12044 OpsChanged |= vectorizeRootInstruction(nullptr, V, BB, R, TTI); 12045 } 12046 } 12047 // Start vectorization of post-process list of instructions from the 12048 // top-tree instructions to try to vectorize as many instructions as 12049 // possible. 12050 OpsChanged |= vectorizeSimpleInstructions(PostProcessInstructions, BB, R, 12051 it->isTerminator()); 12052 if (OpsChanged) { 12053 // We would like to start over since some instructions are deleted 12054 // and the iterator may become invalid value. 12055 Changed = true; 12056 it = BB->begin(); 12057 e = BB->end(); 12058 continue; 12059 } 12060 } 12061 12062 if (isa<InsertElementInst>(it) || isa<CmpInst>(it) || 12063 isa<InsertValueInst>(it)) 12064 PostProcessInstructions.push_back(&*it); 12065 } 12066 12067 return Changed; 12068 } 12069 12070 bool SLPVectorizerPass::vectorizeGEPIndices(BasicBlock *BB, BoUpSLP &R) { 12071 auto Changed = false; 12072 for (auto &Entry : GEPs) { 12073 // If the getelementptr list has fewer than two elements, there's nothing 12074 // to do. 12075 if (Entry.second.size() < 2) 12076 continue; 12077 12078 LLVM_DEBUG(dbgs() << "SLP: Analyzing a getelementptr list of length " 12079 << Entry.second.size() << ".\n"); 12080 12081 // Process the GEP list in chunks suitable for the target's supported 12082 // vector size. If a vector register can't hold 1 element, we are done. We 12083 // are trying to vectorize the index computations, so the maximum number of 12084 // elements is based on the size of the index expression, rather than the 12085 // size of the GEP itself (the target's pointer size). 12086 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 12087 unsigned EltSize = R.getVectorElementSize(*Entry.second[0]->idx_begin()); 12088 if (MaxVecRegSize < EltSize) 12089 continue; 12090 12091 unsigned MaxElts = MaxVecRegSize / EltSize; 12092 for (unsigned BI = 0, BE = Entry.second.size(); BI < BE; BI += MaxElts) { 12093 auto Len = std::min<unsigned>(BE - BI, MaxElts); 12094 ArrayRef<GetElementPtrInst *> GEPList(&Entry.second[BI], Len); 12095 12096 // Initialize a set a candidate getelementptrs. Note that we use a 12097 // SetVector here to preserve program order. If the index computations 12098 // are vectorizable and begin with loads, we want to minimize the chance 12099 // of having to reorder them later. 12100 SetVector<Value *> Candidates(GEPList.begin(), GEPList.end()); 12101 12102 // Some of the candidates may have already been vectorized after we 12103 // initially collected them. If so, they are marked as deleted, so remove 12104 // them from the set of candidates. 12105 Candidates.remove_if( 12106 [&R](Value *I) { return R.isDeleted(cast<Instruction>(I)); }); 12107 12108 // Remove from the set of candidates all pairs of getelementptrs with 12109 // constant differences. Such getelementptrs are likely not good 12110 // candidates for vectorization in a bottom-up phase since one can be 12111 // computed from the other. We also ensure all candidate getelementptr 12112 // indices are unique. 12113 for (int I = 0, E = GEPList.size(); I < E && Candidates.size() > 1; ++I) { 12114 auto *GEPI = GEPList[I]; 12115 if (!Candidates.count(GEPI)) 12116 continue; 12117 auto *SCEVI = SE->getSCEV(GEPList[I]); 12118 for (int J = I + 1; J < E && Candidates.size() > 1; ++J) { 12119 auto *GEPJ = GEPList[J]; 12120 auto *SCEVJ = SE->getSCEV(GEPList[J]); 12121 if (isa<SCEVConstant>(SE->getMinusSCEV(SCEVI, SCEVJ))) { 12122 Candidates.remove(GEPI); 12123 Candidates.remove(GEPJ); 12124 } else if (GEPI->idx_begin()->get() == GEPJ->idx_begin()->get()) { 12125 Candidates.remove(GEPJ); 12126 } 12127 } 12128 } 12129 12130 // We break out of the above computation as soon as we know there are 12131 // fewer than two candidates remaining. 12132 if (Candidates.size() < 2) 12133 continue; 12134 12135 // Add the single, non-constant index of each candidate to the bundle. We 12136 // ensured the indices met these constraints when we originally collected 12137 // the getelementptrs. 12138 SmallVector<Value *, 16> Bundle(Candidates.size()); 12139 auto BundleIndex = 0u; 12140 for (auto *V : Candidates) { 12141 auto *GEP = cast<GetElementPtrInst>(V); 12142 auto *GEPIdx = GEP->idx_begin()->get(); 12143 assert(GEP->getNumIndices() == 1 || !isa<Constant>(GEPIdx)); 12144 Bundle[BundleIndex++] = GEPIdx; 12145 } 12146 12147 // Try and vectorize the indices. We are currently only interested in 12148 // gather-like cases of the form: 12149 // 12150 // ... = g[a[0] - b[0]] + g[a[1] - b[1]] + ... 12151 // 12152 // where the loads of "a", the loads of "b", and the subtractions can be 12153 // performed in parallel. It's likely that detecting this pattern in a 12154 // bottom-up phase will be simpler and less costly than building a 12155 // full-blown top-down phase beginning at the consecutive loads. 12156 Changed |= tryToVectorizeList(Bundle, R); 12157 } 12158 } 12159 return Changed; 12160 } 12161 12162 bool SLPVectorizerPass::vectorizeStoreChains(BoUpSLP &R) { 12163 bool Changed = false; 12164 // Sort by type, base pointers and values operand. Value operands must be 12165 // compatible (have the same opcode, same parent), otherwise it is 12166 // definitely not profitable to try to vectorize them. 12167 auto &&StoreSorter = [this](StoreInst *V, StoreInst *V2) { 12168 if (V->getPointerOperandType()->getTypeID() < 12169 V2->getPointerOperandType()->getTypeID()) 12170 return true; 12171 if (V->getPointerOperandType()->getTypeID() > 12172 V2->getPointerOperandType()->getTypeID()) 12173 return false; 12174 // UndefValues are compatible with all other values. 12175 if (isa<UndefValue>(V->getValueOperand()) || 12176 isa<UndefValue>(V2->getValueOperand())) 12177 return false; 12178 if (auto *I1 = dyn_cast<Instruction>(V->getValueOperand())) 12179 if (auto *I2 = dyn_cast<Instruction>(V2->getValueOperand())) { 12180 DomTreeNodeBase<llvm::BasicBlock> *NodeI1 = 12181 DT->getNode(I1->getParent()); 12182 DomTreeNodeBase<llvm::BasicBlock> *NodeI2 = 12183 DT->getNode(I2->getParent()); 12184 assert(NodeI1 && "Should only process reachable instructions"); 12185 assert(NodeI2 && "Should only process reachable instructions"); 12186 assert((NodeI1 == NodeI2) == 12187 (NodeI1->getDFSNumIn() == NodeI2->getDFSNumIn()) && 12188 "Different nodes should have different DFS numbers"); 12189 if (NodeI1 != NodeI2) 12190 return NodeI1->getDFSNumIn() < NodeI2->getDFSNumIn(); 12191 InstructionsState S = getSameOpcode({I1, I2}); 12192 if (S.getOpcode()) 12193 return false; 12194 return I1->getOpcode() < I2->getOpcode(); 12195 } 12196 if (isa<Constant>(V->getValueOperand()) && 12197 isa<Constant>(V2->getValueOperand())) 12198 return false; 12199 return V->getValueOperand()->getValueID() < 12200 V2->getValueOperand()->getValueID(); 12201 }; 12202 12203 auto &&AreCompatibleStores = [](StoreInst *V1, StoreInst *V2) { 12204 if (V1 == V2) 12205 return true; 12206 if (V1->getPointerOperandType() != V2->getPointerOperandType()) 12207 return false; 12208 // Undefs are compatible with any other value. 12209 if (isa<UndefValue>(V1->getValueOperand()) || 12210 isa<UndefValue>(V2->getValueOperand())) 12211 return true; 12212 if (auto *I1 = dyn_cast<Instruction>(V1->getValueOperand())) 12213 if (auto *I2 = dyn_cast<Instruction>(V2->getValueOperand())) { 12214 if (I1->getParent() != I2->getParent()) 12215 return false; 12216 InstructionsState S = getSameOpcode({I1, I2}); 12217 return S.getOpcode() > 0; 12218 } 12219 if (isa<Constant>(V1->getValueOperand()) && 12220 isa<Constant>(V2->getValueOperand())) 12221 return true; 12222 return V1->getValueOperand()->getValueID() == 12223 V2->getValueOperand()->getValueID(); 12224 }; 12225 auto Limit = [&R, this](StoreInst *SI) { 12226 unsigned EltSize = DL->getTypeSizeInBits(SI->getValueOperand()->getType()); 12227 return R.getMinVF(EltSize); 12228 }; 12229 12230 // Attempt to sort and vectorize each of the store-groups. 12231 for (auto &Pair : Stores) { 12232 if (Pair.second.size() < 2) 12233 continue; 12234 12235 LLVM_DEBUG(dbgs() << "SLP: Analyzing a store chain of length " 12236 << Pair.second.size() << ".\n"); 12237 12238 if (!isValidElementType(Pair.second.front()->getValueOperand()->getType())) 12239 continue; 12240 12241 Changed |= tryToVectorizeSequence<StoreInst>( 12242 Pair.second, Limit, StoreSorter, AreCompatibleStores, 12243 [this, &R](ArrayRef<StoreInst *> Candidates, bool) { 12244 return vectorizeStores(Candidates, R); 12245 }, 12246 /*LimitForRegisterSize=*/false); 12247 } 12248 return Changed; 12249 } 12250 12251 char SLPVectorizer::ID = 0; 12252 12253 static const char lv_name[] = "SLP Vectorizer"; 12254 12255 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false) 12256 INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass) 12257 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass) 12258 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 12259 INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass) 12260 INITIALIZE_PASS_DEPENDENCY(LoopSimplify) 12261 INITIALIZE_PASS_DEPENDENCY(DemandedBitsWrapperPass) 12262 INITIALIZE_PASS_DEPENDENCY(OptimizationRemarkEmitterWrapperPass) 12263 INITIALIZE_PASS_DEPENDENCY(InjectTLIMappingsLegacy) 12264 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false) 12265 12266 Pass *llvm::createSLPVectorizerPass() { return new SLPVectorizer(); } 12267