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 bool clusterSortPtrAccesses(ArrayRef<Value *> VL, Type *ElemTy, 3477 const DataLayout &DL, ScalarEvolution &SE, 3478 SmallVectorImpl<unsigned> &SortedIndices) { 3479 assert(llvm::all_of( 3480 VL, [](const Value *V) { return V->getType()->isPointerTy(); }) && 3481 "Expected list of pointer operands."); 3482 // Map from bases to a vector of (Ptr, Offset, OrigIdx), which we insert each 3483 // Ptr into, sort and return the sorted indices with values next to one 3484 // another. 3485 MapVector<Value *, SmallVector<std::tuple<Value *, int, unsigned>>> Bases; 3486 Bases[VL[0]].push_back(std::make_tuple(VL[0], 0U, 0U)); 3487 3488 unsigned Cnt = 1; 3489 for (Value *Ptr : VL.drop_front()) { 3490 bool Found = any_of(Bases, [&](auto &Base) { 3491 Optional<int> Diff = 3492 getPointersDiff(ElemTy, Base.first, ElemTy, Ptr, DL, SE, 3493 /*StrictCheck=*/true); 3494 if (!Diff) 3495 return false; 3496 3497 Base.second.emplace_back(Ptr, *Diff, Cnt++); 3498 return true; 3499 }); 3500 3501 if (!Found) { 3502 // If we haven't found enough to usefully cluster, return early. 3503 if (Bases.size() > VL.size() / 2 - 1) 3504 return false; 3505 3506 // Not found already - add a new Base 3507 Bases[Ptr].emplace_back(Ptr, 0, Cnt++); 3508 } 3509 } 3510 3511 // For each of the bases sort the pointers by Offset and check if any of the 3512 // base become consecutively allocated. 3513 bool AnyConsecutive = false; 3514 for (auto &Base : Bases) { 3515 auto &Vec = Base.second; 3516 if (Vec.size() > 1) { 3517 llvm::stable_sort(Vec, [](const std::tuple<Value *, int, unsigned> &X, 3518 const std::tuple<Value *, int, unsigned> &Y) { 3519 return std::get<1>(X) < std::get<1>(Y); 3520 }); 3521 int InitialOffset = std::get<1>(Vec[0]); 3522 AnyConsecutive |= all_of(enumerate(Vec), [InitialOffset](auto &P) { 3523 return std::get<1>(P.value()) == int(P.index()) + InitialOffset; 3524 }); 3525 } 3526 } 3527 3528 // Fill SortedIndices array only if it looks worth-while to sort the ptrs. 3529 SortedIndices.clear(); 3530 if (!AnyConsecutive) 3531 return false; 3532 3533 for (auto &Base : Bases) { 3534 for (auto &T : Base.second) 3535 SortedIndices.push_back(std::get<2>(T)); 3536 } 3537 3538 assert(SortedIndices.size() == VL.size() && 3539 "Expected SortedIndices to be the size of VL"); 3540 return true; 3541 } 3542 3543 Optional<BoUpSLP::OrdersType> 3544 BoUpSLP::findPartiallyOrderedLoads(const BoUpSLP::TreeEntry &TE) { 3545 assert(TE.State == TreeEntry::NeedToGather && "Expected gather node only."); 3546 Type *ScalarTy = TE.Scalars[0]->getType(); 3547 3548 SmallVector<Value *> Ptrs; 3549 Ptrs.reserve(TE.Scalars.size()); 3550 for (Value *V : TE.Scalars) { 3551 auto *L = dyn_cast<LoadInst>(V); 3552 if (!L || !L->isSimple()) 3553 return None; 3554 Ptrs.push_back(L->getPointerOperand()); 3555 } 3556 3557 BoUpSLP::OrdersType Order; 3558 if (clusterSortPtrAccesses(Ptrs, ScalarTy, *DL, *SE, Order)) 3559 return Order; 3560 return None; 3561 } 3562 3563 Optional<BoUpSLP::OrdersType> BoUpSLP::getReorderingData(const TreeEntry &TE, 3564 bool TopToBottom) { 3565 // No need to reorder if need to shuffle reuses, still need to shuffle the 3566 // node. 3567 if (!TE.ReuseShuffleIndices.empty()) 3568 return None; 3569 if (TE.State == TreeEntry::Vectorize && 3570 (isa<LoadInst, ExtractElementInst, ExtractValueInst>(TE.getMainOp()) || 3571 (TopToBottom && isa<StoreInst, InsertElementInst>(TE.getMainOp()))) && 3572 !TE.isAltShuffle()) 3573 return TE.ReorderIndices; 3574 if (TE.State == TreeEntry::NeedToGather) { 3575 // TODO: add analysis of other gather nodes with extractelement 3576 // instructions and other values/instructions, not only undefs. 3577 if (((TE.getOpcode() == Instruction::ExtractElement && 3578 !TE.isAltShuffle()) || 3579 (all_of(TE.Scalars, 3580 [](Value *V) { 3581 return isa<UndefValue, ExtractElementInst>(V); 3582 }) && 3583 any_of(TE.Scalars, 3584 [](Value *V) { return isa<ExtractElementInst>(V); }))) && 3585 all_of(TE.Scalars, 3586 [](Value *V) { 3587 auto *EE = dyn_cast<ExtractElementInst>(V); 3588 return !EE || isa<FixedVectorType>(EE->getVectorOperandType()); 3589 }) && 3590 allSameType(TE.Scalars)) { 3591 // Check that gather of extractelements can be represented as 3592 // just a shuffle of a single vector. 3593 OrdersType CurrentOrder; 3594 bool Reuse = canReuseExtract(TE.Scalars, TE.getMainOp(), CurrentOrder); 3595 if (Reuse || !CurrentOrder.empty()) { 3596 if (!CurrentOrder.empty()) 3597 fixupOrderingIndices(CurrentOrder); 3598 return CurrentOrder; 3599 } 3600 } 3601 if (Optional<OrdersType> CurrentOrder = findReusedOrderedScalars(TE)) 3602 return CurrentOrder; 3603 if (TE.Scalars.size() >= 4) 3604 if (Optional<OrdersType> Order = findPartiallyOrderedLoads(TE)) 3605 return Order; 3606 } 3607 return None; 3608 } 3609 3610 void BoUpSLP::reorderTopToBottom() { 3611 // Maps VF to the graph nodes. 3612 DenseMap<unsigned, SetVector<TreeEntry *>> VFToOrderedEntries; 3613 // ExtractElement gather nodes which can be vectorized and need to handle 3614 // their ordering. 3615 DenseMap<const TreeEntry *, OrdersType> GathersToOrders; 3616 3617 // Maps a TreeEntry to the reorder indices of external users. 3618 DenseMap<const TreeEntry *, SmallVector<OrdersType, 1>> 3619 ExternalUserReorderMap; 3620 // Find all reorderable nodes with the given VF. 3621 // Currently the are vectorized stores,loads,extracts + some gathering of 3622 // extracts. 3623 for_each(VectorizableTree, [this, &VFToOrderedEntries, &GathersToOrders, 3624 &ExternalUserReorderMap]( 3625 const std::unique_ptr<TreeEntry> &TE) { 3626 // Look for external users that will probably be vectorized. 3627 SmallVector<OrdersType, 1> ExternalUserReorderIndices = 3628 findExternalStoreUsersReorderIndices(TE.get()); 3629 if (!ExternalUserReorderIndices.empty()) { 3630 VFToOrderedEntries[TE->Scalars.size()].insert(TE.get()); 3631 ExternalUserReorderMap.try_emplace(TE.get(), 3632 std::move(ExternalUserReorderIndices)); 3633 } 3634 3635 if (Optional<OrdersType> CurrentOrder = 3636 getReorderingData(*TE, /*TopToBottom=*/true)) { 3637 // Do not include ordering for nodes used in the alt opcode vectorization, 3638 // better to reorder them during bottom-to-top stage. If follow the order 3639 // here, it causes reordering of the whole graph though actually it is 3640 // profitable just to reorder the subgraph that starts from the alternate 3641 // opcode vectorization node. Such nodes already end-up with the shuffle 3642 // instruction and it is just enough to change this shuffle rather than 3643 // rotate the scalars for the whole graph. 3644 unsigned Cnt = 0; 3645 const TreeEntry *UserTE = TE.get(); 3646 while (UserTE && Cnt < RecursionMaxDepth) { 3647 if (UserTE->UserTreeIndices.size() != 1) 3648 break; 3649 if (all_of(UserTE->UserTreeIndices, [](const EdgeInfo &EI) { 3650 return EI.UserTE->State == TreeEntry::Vectorize && 3651 EI.UserTE->isAltShuffle() && EI.UserTE->Idx != 0; 3652 })) 3653 return; 3654 if (UserTE->UserTreeIndices.empty()) 3655 UserTE = nullptr; 3656 else 3657 UserTE = UserTE->UserTreeIndices.back().UserTE; 3658 ++Cnt; 3659 } 3660 VFToOrderedEntries[TE->Scalars.size()].insert(TE.get()); 3661 if (TE->State != TreeEntry::Vectorize) 3662 GathersToOrders.try_emplace(TE.get(), *CurrentOrder); 3663 } 3664 }); 3665 3666 // Reorder the graph nodes according to their vectorization factor. 3667 for (unsigned VF = VectorizableTree.front()->Scalars.size(); VF > 1; 3668 VF /= 2) { 3669 auto It = VFToOrderedEntries.find(VF); 3670 if (It == VFToOrderedEntries.end()) 3671 continue; 3672 // Try to find the most profitable order. We just are looking for the most 3673 // used order and reorder scalar elements in the nodes according to this 3674 // mostly used order. 3675 ArrayRef<TreeEntry *> OrderedEntries = It->second.getArrayRef(); 3676 // All operands are reordered and used only in this node - propagate the 3677 // most used order to the user node. 3678 MapVector<OrdersType, unsigned, 3679 DenseMap<OrdersType, unsigned, OrdersTypeDenseMapInfo>> 3680 OrdersUses; 3681 SmallPtrSet<const TreeEntry *, 4> VisitedOps; 3682 for (const TreeEntry *OpTE : OrderedEntries) { 3683 // No need to reorder this nodes, still need to extend and to use shuffle, 3684 // just need to merge reordering shuffle and the reuse shuffle. 3685 if (!OpTE->ReuseShuffleIndices.empty()) 3686 continue; 3687 // Count number of orders uses. 3688 const auto &Order = [OpTE, &GathersToOrders]() -> const OrdersType & { 3689 if (OpTE->State == TreeEntry::NeedToGather) { 3690 auto It = GathersToOrders.find(OpTE); 3691 if (It != GathersToOrders.end()) 3692 return It->second; 3693 } 3694 return OpTE->ReorderIndices; 3695 }(); 3696 // First consider the order of the external scalar users. 3697 auto It = ExternalUserReorderMap.find(OpTE); 3698 if (It != ExternalUserReorderMap.end()) { 3699 const auto &ExternalUserReorderIndices = It->second; 3700 for (const OrdersType &ExtOrder : ExternalUserReorderIndices) 3701 ++OrdersUses.insert(std::make_pair(ExtOrder, 0)).first->second; 3702 // No other useful reorder data in this entry. 3703 if (Order.empty()) 3704 continue; 3705 } 3706 // Stores actually store the mask, not the order, need to invert. 3707 if (OpTE->State == TreeEntry::Vectorize && !OpTE->isAltShuffle() && 3708 OpTE->getOpcode() == Instruction::Store && !Order.empty()) { 3709 SmallVector<int> Mask; 3710 inversePermutation(Order, Mask); 3711 unsigned E = Order.size(); 3712 OrdersType CurrentOrder(E, E); 3713 transform(Mask, CurrentOrder.begin(), [E](int Idx) { 3714 return Idx == UndefMaskElem ? E : static_cast<unsigned>(Idx); 3715 }); 3716 fixupOrderingIndices(CurrentOrder); 3717 ++OrdersUses.insert(std::make_pair(CurrentOrder, 0)).first->second; 3718 } else { 3719 ++OrdersUses.insert(std::make_pair(Order, 0)).first->second; 3720 } 3721 } 3722 // Set order of the user node. 3723 if (OrdersUses.empty()) 3724 continue; 3725 // Choose the most used order. 3726 ArrayRef<unsigned> BestOrder = OrdersUses.front().first; 3727 unsigned Cnt = OrdersUses.front().second; 3728 for (const auto &Pair : drop_begin(OrdersUses)) { 3729 if (Cnt < Pair.second || (Cnt == Pair.second && Pair.first.empty())) { 3730 BestOrder = Pair.first; 3731 Cnt = Pair.second; 3732 } 3733 } 3734 // Set order of the user node. 3735 if (BestOrder.empty()) 3736 continue; 3737 SmallVector<int> Mask; 3738 inversePermutation(BestOrder, Mask); 3739 SmallVector<int> MaskOrder(BestOrder.size(), UndefMaskElem); 3740 unsigned E = BestOrder.size(); 3741 transform(BestOrder, MaskOrder.begin(), [E](unsigned I) { 3742 return I < E ? static_cast<int>(I) : UndefMaskElem; 3743 }); 3744 // Do an actual reordering, if profitable. 3745 for (std::unique_ptr<TreeEntry> &TE : VectorizableTree) { 3746 // Just do the reordering for the nodes with the given VF. 3747 if (TE->Scalars.size() != VF) { 3748 if (TE->ReuseShuffleIndices.size() == VF) { 3749 // Need to reorder the reuses masks of the operands with smaller VF to 3750 // be able to find the match between the graph nodes and scalar 3751 // operands of the given node during vectorization/cost estimation. 3752 assert(all_of(TE->UserTreeIndices, 3753 [VF, &TE](const EdgeInfo &EI) { 3754 return EI.UserTE->Scalars.size() == VF || 3755 EI.UserTE->Scalars.size() == 3756 TE->Scalars.size(); 3757 }) && 3758 "All users must be of VF size."); 3759 // Update ordering of the operands with the smaller VF than the given 3760 // one. 3761 reorderReuses(TE->ReuseShuffleIndices, Mask); 3762 } 3763 continue; 3764 } 3765 if (TE->State == TreeEntry::Vectorize && 3766 isa<ExtractElementInst, ExtractValueInst, LoadInst, StoreInst, 3767 InsertElementInst>(TE->getMainOp()) && 3768 !TE->isAltShuffle()) { 3769 // Build correct orders for extract{element,value}, loads and 3770 // stores. 3771 reorderOrder(TE->ReorderIndices, Mask); 3772 if (isa<InsertElementInst, StoreInst>(TE->getMainOp())) 3773 TE->reorderOperands(Mask); 3774 } else { 3775 // Reorder the node and its operands. 3776 TE->reorderOperands(Mask); 3777 assert(TE->ReorderIndices.empty() && 3778 "Expected empty reorder sequence."); 3779 reorderScalars(TE->Scalars, Mask); 3780 } 3781 if (!TE->ReuseShuffleIndices.empty()) { 3782 // Apply reversed order to keep the original ordering of the reused 3783 // elements to avoid extra reorder indices shuffling. 3784 OrdersType CurrentOrder; 3785 reorderOrder(CurrentOrder, MaskOrder); 3786 SmallVector<int> NewReuses; 3787 inversePermutation(CurrentOrder, NewReuses); 3788 addMask(NewReuses, TE->ReuseShuffleIndices); 3789 TE->ReuseShuffleIndices.swap(NewReuses); 3790 } 3791 } 3792 } 3793 } 3794 3795 bool BoUpSLP::canReorderOperands( 3796 TreeEntry *UserTE, SmallVectorImpl<std::pair<unsigned, TreeEntry *>> &Edges, 3797 ArrayRef<TreeEntry *> ReorderableGathers, 3798 SmallVectorImpl<TreeEntry *> &GatherOps) { 3799 for (unsigned I = 0, E = UserTE->getNumOperands(); I < E; ++I) { 3800 if (any_of(Edges, [I](const std::pair<unsigned, TreeEntry *> &OpData) { 3801 return OpData.first == I && 3802 OpData.second->State == TreeEntry::Vectorize; 3803 })) 3804 continue; 3805 if (TreeEntry *TE = getVectorizedOperand(UserTE, I)) { 3806 // Do not reorder if operand node is used by many user nodes. 3807 if (any_of(TE->UserTreeIndices, 3808 [UserTE](const EdgeInfo &EI) { return EI.UserTE != UserTE; })) 3809 return false; 3810 // Add the node to the list of the ordered nodes with the identity 3811 // order. 3812 Edges.emplace_back(I, TE); 3813 continue; 3814 } 3815 ArrayRef<Value *> VL = UserTE->getOperand(I); 3816 TreeEntry *Gather = nullptr; 3817 if (count_if(ReorderableGathers, [VL, &Gather](TreeEntry *TE) { 3818 assert(TE->State != TreeEntry::Vectorize && 3819 "Only non-vectorized nodes are expected."); 3820 if (TE->isSame(VL)) { 3821 Gather = TE; 3822 return true; 3823 } 3824 return false; 3825 }) > 1) 3826 return false; 3827 if (Gather) 3828 GatherOps.push_back(Gather); 3829 } 3830 return true; 3831 } 3832 3833 void BoUpSLP::reorderBottomToTop(bool IgnoreReorder) { 3834 SetVector<TreeEntry *> OrderedEntries; 3835 DenseMap<const TreeEntry *, OrdersType> GathersToOrders; 3836 // Find all reorderable leaf nodes with the given VF. 3837 // Currently the are vectorized loads,extracts without alternate operands + 3838 // some gathering of extracts. 3839 SmallVector<TreeEntry *> NonVectorized; 3840 for_each(VectorizableTree, [this, &OrderedEntries, &GathersToOrders, 3841 &NonVectorized]( 3842 const std::unique_ptr<TreeEntry> &TE) { 3843 if (TE->State != TreeEntry::Vectorize) 3844 NonVectorized.push_back(TE.get()); 3845 if (Optional<OrdersType> CurrentOrder = 3846 getReorderingData(*TE, /*TopToBottom=*/false)) { 3847 OrderedEntries.insert(TE.get()); 3848 if (TE->State != TreeEntry::Vectorize) 3849 GathersToOrders.try_emplace(TE.get(), *CurrentOrder); 3850 } 3851 }); 3852 3853 // 1. Propagate order to the graph nodes, which use only reordered nodes. 3854 // I.e., if the node has operands, that are reordered, try to make at least 3855 // one operand order in the natural order and reorder others + reorder the 3856 // user node itself. 3857 SmallPtrSet<const TreeEntry *, 4> Visited; 3858 while (!OrderedEntries.empty()) { 3859 // 1. Filter out only reordered nodes. 3860 // 2. If the entry has multiple uses - skip it and jump to the next node. 3861 DenseMap<TreeEntry *, SmallVector<std::pair<unsigned, TreeEntry *>>> Users; 3862 SmallVector<TreeEntry *> Filtered; 3863 for (TreeEntry *TE : OrderedEntries) { 3864 if (!(TE->State == TreeEntry::Vectorize || 3865 (TE->State == TreeEntry::NeedToGather && 3866 GathersToOrders.count(TE))) || 3867 TE->UserTreeIndices.empty() || !TE->ReuseShuffleIndices.empty() || 3868 !all_of(drop_begin(TE->UserTreeIndices), 3869 [TE](const EdgeInfo &EI) { 3870 return EI.UserTE == TE->UserTreeIndices.front().UserTE; 3871 }) || 3872 !Visited.insert(TE).second) { 3873 Filtered.push_back(TE); 3874 continue; 3875 } 3876 // Build a map between user nodes and their operands order to speedup 3877 // search. The graph currently does not provide this dependency directly. 3878 for (EdgeInfo &EI : TE->UserTreeIndices) { 3879 TreeEntry *UserTE = EI.UserTE; 3880 auto It = Users.find(UserTE); 3881 if (It == Users.end()) 3882 It = Users.insert({UserTE, {}}).first; 3883 It->second.emplace_back(EI.EdgeIdx, TE); 3884 } 3885 } 3886 // Erase filtered entries. 3887 for_each(Filtered, 3888 [&OrderedEntries](TreeEntry *TE) { OrderedEntries.remove(TE); }); 3889 SmallVector< 3890 std::pair<TreeEntry *, SmallVector<std::pair<unsigned, TreeEntry *>>>> 3891 UsersVec(Users.begin(), Users.end()); 3892 sort(UsersVec, [](const auto &Data1, const auto &Data2) { 3893 return Data1.first->Idx > Data2.first->Idx; 3894 }); 3895 for (auto &Data : UsersVec) { 3896 // Check that operands are used only in the User node. 3897 SmallVector<TreeEntry *> GatherOps; 3898 if (!canReorderOperands(Data.first, Data.second, NonVectorized, 3899 GatherOps)) { 3900 for_each(Data.second, 3901 [&OrderedEntries](const std::pair<unsigned, TreeEntry *> &Op) { 3902 OrderedEntries.remove(Op.second); 3903 }); 3904 continue; 3905 } 3906 // All operands are reordered and used only in this node - propagate the 3907 // most used order to the user node. 3908 MapVector<OrdersType, unsigned, 3909 DenseMap<OrdersType, unsigned, OrdersTypeDenseMapInfo>> 3910 OrdersUses; 3911 // Do the analysis for each tree entry only once, otherwise the order of 3912 // the same node my be considered several times, though might be not 3913 // profitable. 3914 SmallPtrSet<const TreeEntry *, 4> VisitedOps; 3915 SmallPtrSet<const TreeEntry *, 4> VisitedUsers; 3916 for (const auto &Op : Data.second) { 3917 TreeEntry *OpTE = Op.second; 3918 if (!VisitedOps.insert(OpTE).second) 3919 continue; 3920 if (!OpTE->ReuseShuffleIndices.empty() || 3921 (IgnoreReorder && OpTE == VectorizableTree.front().get())) 3922 continue; 3923 const auto &Order = [OpTE, &GathersToOrders]() -> const OrdersType & { 3924 if (OpTE->State == TreeEntry::NeedToGather) 3925 return GathersToOrders.find(OpTE)->second; 3926 return OpTE->ReorderIndices; 3927 }(); 3928 unsigned NumOps = count_if( 3929 Data.second, [OpTE](const std::pair<unsigned, TreeEntry *> &P) { 3930 return P.second == OpTE; 3931 }); 3932 // Stores actually store the mask, not the order, need to invert. 3933 if (OpTE->State == TreeEntry::Vectorize && !OpTE->isAltShuffle() && 3934 OpTE->getOpcode() == Instruction::Store && !Order.empty()) { 3935 SmallVector<int> Mask; 3936 inversePermutation(Order, Mask); 3937 unsigned E = Order.size(); 3938 OrdersType CurrentOrder(E, E); 3939 transform(Mask, CurrentOrder.begin(), [E](int Idx) { 3940 return Idx == UndefMaskElem ? E : static_cast<unsigned>(Idx); 3941 }); 3942 fixupOrderingIndices(CurrentOrder); 3943 OrdersUses.insert(std::make_pair(CurrentOrder, 0)).first->second += 3944 NumOps; 3945 } else { 3946 OrdersUses.insert(std::make_pair(Order, 0)).first->second += NumOps; 3947 } 3948 auto Res = OrdersUses.insert(std::make_pair(OrdersType(), 0)); 3949 const auto &&AllowsReordering = [IgnoreReorder, &GathersToOrders]( 3950 const TreeEntry *TE) { 3951 if (!TE->ReorderIndices.empty() || !TE->ReuseShuffleIndices.empty() || 3952 (TE->State == TreeEntry::Vectorize && TE->isAltShuffle()) || 3953 (IgnoreReorder && TE->Idx == 0)) 3954 return true; 3955 if (TE->State == TreeEntry::NeedToGather) { 3956 auto It = GathersToOrders.find(TE); 3957 if (It != GathersToOrders.end()) 3958 return !It->second.empty(); 3959 return true; 3960 } 3961 return false; 3962 }; 3963 for (const EdgeInfo &EI : OpTE->UserTreeIndices) { 3964 TreeEntry *UserTE = EI.UserTE; 3965 if (!VisitedUsers.insert(UserTE).second) 3966 continue; 3967 // May reorder user node if it requires reordering, has reused 3968 // scalars, is an alternate op vectorize node or its op nodes require 3969 // reordering. 3970 if (AllowsReordering(UserTE)) 3971 continue; 3972 // Check if users allow reordering. 3973 // Currently look up just 1 level of operands to avoid increase of 3974 // the compile time. 3975 // Profitable to reorder if definitely more operands allow 3976 // reordering rather than those with natural order. 3977 ArrayRef<std::pair<unsigned, TreeEntry *>> Ops = Users[UserTE]; 3978 if (static_cast<unsigned>(count_if( 3979 Ops, [UserTE, &AllowsReordering]( 3980 const std::pair<unsigned, TreeEntry *> &Op) { 3981 return AllowsReordering(Op.second) && 3982 all_of(Op.second->UserTreeIndices, 3983 [UserTE](const EdgeInfo &EI) { 3984 return EI.UserTE == UserTE; 3985 }); 3986 })) <= Ops.size() / 2) 3987 ++Res.first->second; 3988 } 3989 } 3990 // If no orders - skip current nodes and jump to the next one, if any. 3991 if (OrdersUses.empty()) { 3992 for_each(Data.second, 3993 [&OrderedEntries](const std::pair<unsigned, TreeEntry *> &Op) { 3994 OrderedEntries.remove(Op.second); 3995 }); 3996 continue; 3997 } 3998 // Choose the best order. 3999 ArrayRef<unsigned> BestOrder = OrdersUses.front().first; 4000 unsigned Cnt = OrdersUses.front().second; 4001 for (const auto &Pair : drop_begin(OrdersUses)) { 4002 if (Cnt < Pair.second || (Cnt == Pair.second && Pair.first.empty())) { 4003 BestOrder = Pair.first; 4004 Cnt = Pair.second; 4005 } 4006 } 4007 // Set order of the user node (reordering of operands and user nodes). 4008 if (BestOrder.empty()) { 4009 for_each(Data.second, 4010 [&OrderedEntries](const std::pair<unsigned, TreeEntry *> &Op) { 4011 OrderedEntries.remove(Op.second); 4012 }); 4013 continue; 4014 } 4015 // Erase operands from OrderedEntries list and adjust their orders. 4016 VisitedOps.clear(); 4017 SmallVector<int> Mask; 4018 inversePermutation(BestOrder, Mask); 4019 SmallVector<int> MaskOrder(BestOrder.size(), UndefMaskElem); 4020 unsigned E = BestOrder.size(); 4021 transform(BestOrder, MaskOrder.begin(), [E](unsigned I) { 4022 return I < E ? static_cast<int>(I) : UndefMaskElem; 4023 }); 4024 for (const std::pair<unsigned, TreeEntry *> &Op : Data.second) { 4025 TreeEntry *TE = Op.second; 4026 OrderedEntries.remove(TE); 4027 if (!VisitedOps.insert(TE).second) 4028 continue; 4029 if (TE->ReuseShuffleIndices.size() == BestOrder.size()) { 4030 // Just reorder reuses indices. 4031 reorderReuses(TE->ReuseShuffleIndices, Mask); 4032 continue; 4033 } 4034 // Gathers are processed separately. 4035 if (TE->State != TreeEntry::Vectorize) 4036 continue; 4037 assert((BestOrder.size() == TE->ReorderIndices.size() || 4038 TE->ReorderIndices.empty()) && 4039 "Non-matching sizes of user/operand entries."); 4040 reorderOrder(TE->ReorderIndices, Mask); 4041 } 4042 // For gathers just need to reorder its scalars. 4043 for (TreeEntry *Gather : GatherOps) { 4044 assert(Gather->ReorderIndices.empty() && 4045 "Unexpected reordering of gathers."); 4046 if (!Gather->ReuseShuffleIndices.empty()) { 4047 // Just reorder reuses indices. 4048 reorderReuses(Gather->ReuseShuffleIndices, Mask); 4049 continue; 4050 } 4051 reorderScalars(Gather->Scalars, Mask); 4052 OrderedEntries.remove(Gather); 4053 } 4054 // Reorder operands of the user node and set the ordering for the user 4055 // node itself. 4056 if (Data.first->State != TreeEntry::Vectorize || 4057 !isa<ExtractElementInst, ExtractValueInst, LoadInst>( 4058 Data.first->getMainOp()) || 4059 Data.first->isAltShuffle()) 4060 Data.first->reorderOperands(Mask); 4061 if (!isa<InsertElementInst, StoreInst>(Data.first->getMainOp()) || 4062 Data.first->isAltShuffle()) { 4063 reorderScalars(Data.first->Scalars, Mask); 4064 reorderOrder(Data.first->ReorderIndices, MaskOrder); 4065 if (Data.first->ReuseShuffleIndices.empty() && 4066 !Data.first->ReorderIndices.empty() && 4067 !Data.first->isAltShuffle()) { 4068 // Insert user node to the list to try to sink reordering deeper in 4069 // the graph. 4070 OrderedEntries.insert(Data.first); 4071 } 4072 } else { 4073 reorderOrder(Data.first->ReorderIndices, Mask); 4074 } 4075 } 4076 } 4077 // If the reordering is unnecessary, just remove the reorder. 4078 if (IgnoreReorder && !VectorizableTree.front()->ReorderIndices.empty() && 4079 VectorizableTree.front()->ReuseShuffleIndices.empty()) 4080 VectorizableTree.front()->ReorderIndices.clear(); 4081 } 4082 4083 void BoUpSLP::buildExternalUses( 4084 const ExtraValueToDebugLocsMap &ExternallyUsedValues) { 4085 // Collect the values that we need to extract from the tree. 4086 for (auto &TEPtr : VectorizableTree) { 4087 TreeEntry *Entry = TEPtr.get(); 4088 4089 // No need to handle users of gathered values. 4090 if (Entry->State == TreeEntry::NeedToGather) 4091 continue; 4092 4093 // For each lane: 4094 for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) { 4095 Value *Scalar = Entry->Scalars[Lane]; 4096 int FoundLane = Entry->findLaneForValue(Scalar); 4097 4098 // Check if the scalar is externally used as an extra arg. 4099 auto ExtI = ExternallyUsedValues.find(Scalar); 4100 if (ExtI != ExternallyUsedValues.end()) { 4101 LLVM_DEBUG(dbgs() << "SLP: Need to extract: Extra arg from lane " 4102 << Lane << " from " << *Scalar << ".\n"); 4103 ExternalUses.emplace_back(Scalar, nullptr, FoundLane); 4104 } 4105 for (User *U : Scalar->users()) { 4106 LLVM_DEBUG(dbgs() << "SLP: Checking user:" << *U << ".\n"); 4107 4108 Instruction *UserInst = dyn_cast<Instruction>(U); 4109 if (!UserInst) 4110 continue; 4111 4112 if (isDeleted(UserInst)) 4113 continue; 4114 4115 // Skip in-tree scalars that become vectors 4116 if (TreeEntry *UseEntry = getTreeEntry(U)) { 4117 Value *UseScalar = UseEntry->Scalars[0]; 4118 // Some in-tree scalars will remain as scalar in vectorized 4119 // instructions. If that is the case, the one in Lane 0 will 4120 // be used. 4121 if (UseScalar != U || 4122 UseEntry->State == TreeEntry::ScatterVectorize || 4123 !InTreeUserNeedToExtract(Scalar, UserInst, TLI)) { 4124 LLVM_DEBUG(dbgs() << "SLP: \tInternal user will be removed:" << *U 4125 << ".\n"); 4126 assert(UseEntry->State != TreeEntry::NeedToGather && "Bad state"); 4127 continue; 4128 } 4129 } 4130 4131 // Ignore users in the user ignore list. 4132 if (UserIgnoreList && UserIgnoreList->contains(UserInst)) 4133 continue; 4134 4135 LLVM_DEBUG(dbgs() << "SLP: Need to extract:" << *U << " from lane " 4136 << Lane << " from " << *Scalar << ".\n"); 4137 ExternalUses.push_back(ExternalUser(Scalar, U, FoundLane)); 4138 } 4139 } 4140 } 4141 } 4142 4143 DenseMap<Value *, SmallVector<StoreInst *, 4>> 4144 BoUpSLP::collectUserStores(const BoUpSLP::TreeEntry *TE) const { 4145 DenseMap<Value *, SmallVector<StoreInst *, 4>> PtrToStoresMap; 4146 for (unsigned Lane : seq<unsigned>(0, TE->Scalars.size())) { 4147 Value *V = TE->Scalars[Lane]; 4148 // To save compilation time we don't visit if we have too many users. 4149 static constexpr unsigned UsersLimit = 4; 4150 if (V->hasNUsesOrMore(UsersLimit)) 4151 break; 4152 4153 // Collect stores per pointer object. 4154 for (User *U : V->users()) { 4155 auto *SI = dyn_cast<StoreInst>(U); 4156 if (SI == nullptr || !SI->isSimple() || 4157 !isValidElementType(SI->getValueOperand()->getType())) 4158 continue; 4159 // Skip entry if already 4160 if (getTreeEntry(U)) 4161 continue; 4162 4163 Value *Ptr = getUnderlyingObject(SI->getPointerOperand()); 4164 auto &StoresVec = PtrToStoresMap[Ptr]; 4165 // For now just keep one store per pointer object per lane. 4166 // TODO: Extend this to support multiple stores per pointer per lane 4167 if (StoresVec.size() > Lane) 4168 continue; 4169 // Skip if in different BBs. 4170 if (!StoresVec.empty() && 4171 SI->getParent() != StoresVec.back()->getParent()) 4172 continue; 4173 // Make sure that the stores are of the same type. 4174 if (!StoresVec.empty() && 4175 SI->getValueOperand()->getType() != 4176 StoresVec.back()->getValueOperand()->getType()) 4177 continue; 4178 StoresVec.push_back(SI); 4179 } 4180 } 4181 return PtrToStoresMap; 4182 } 4183 4184 bool BoUpSLP::CanFormVector(const SmallVector<StoreInst *, 4> &StoresVec, 4185 OrdersType &ReorderIndices) const { 4186 // We check whether the stores in StoreVec can form a vector by sorting them 4187 // and checking whether they are consecutive. 4188 4189 // To avoid calling getPointersDiff() while sorting we create a vector of 4190 // pairs {store, offset from first} and sort this instead. 4191 SmallVector<std::pair<StoreInst *, int>, 4> StoreOffsetVec(StoresVec.size()); 4192 StoreInst *S0 = StoresVec[0]; 4193 StoreOffsetVec[0] = {S0, 0}; 4194 Type *S0Ty = S0->getValueOperand()->getType(); 4195 Value *S0Ptr = S0->getPointerOperand(); 4196 for (unsigned Idx : seq<unsigned>(1, StoresVec.size())) { 4197 StoreInst *SI = StoresVec[Idx]; 4198 Optional<int> Diff = 4199 getPointersDiff(S0Ty, S0Ptr, SI->getValueOperand()->getType(), 4200 SI->getPointerOperand(), *DL, *SE, 4201 /*StrictCheck=*/true); 4202 // We failed to compare the pointers so just abandon this StoresVec. 4203 if (!Diff) 4204 return false; 4205 StoreOffsetVec[Idx] = {StoresVec[Idx], *Diff}; 4206 } 4207 4208 // Sort the vector based on the pointers. We create a copy because we may 4209 // need the original later for calculating the reorder (shuffle) indices. 4210 stable_sort(StoreOffsetVec, [](const std::pair<StoreInst *, int> &Pair1, 4211 const std::pair<StoreInst *, int> &Pair2) { 4212 int Offset1 = Pair1.second; 4213 int Offset2 = Pair2.second; 4214 return Offset1 < Offset2; 4215 }); 4216 4217 // Check if the stores are consecutive by checking if their difference is 1. 4218 for (unsigned Idx : seq<unsigned>(1, StoreOffsetVec.size())) 4219 if (StoreOffsetVec[Idx].second != StoreOffsetVec[Idx-1].second + 1) 4220 return false; 4221 4222 // Calculate the shuffle indices according to their offset against the sorted 4223 // StoreOffsetVec. 4224 ReorderIndices.reserve(StoresVec.size()); 4225 for (StoreInst *SI : StoresVec) { 4226 unsigned Idx = find_if(StoreOffsetVec, 4227 [SI](const std::pair<StoreInst *, int> &Pair) { 4228 return Pair.first == SI; 4229 }) - 4230 StoreOffsetVec.begin(); 4231 ReorderIndices.push_back(Idx); 4232 } 4233 // Identity order (e.g., {0,1,2,3}) is modeled as an empty OrdersType in 4234 // reorderTopToBottom() and reorderBottomToTop(), so we are following the 4235 // same convention here. 4236 auto IsIdentityOrder = [](const OrdersType &Order) { 4237 for (unsigned Idx : seq<unsigned>(0, Order.size())) 4238 if (Idx != Order[Idx]) 4239 return false; 4240 return true; 4241 }; 4242 if (IsIdentityOrder(ReorderIndices)) 4243 ReorderIndices.clear(); 4244 4245 return true; 4246 } 4247 4248 #ifndef NDEBUG 4249 LLVM_DUMP_METHOD static void dumpOrder(const BoUpSLP::OrdersType &Order) { 4250 for (unsigned Idx : Order) 4251 dbgs() << Idx << ", "; 4252 dbgs() << "\n"; 4253 } 4254 #endif 4255 4256 SmallVector<BoUpSLP::OrdersType, 1> 4257 BoUpSLP::findExternalStoreUsersReorderIndices(TreeEntry *TE) const { 4258 unsigned NumLanes = TE->Scalars.size(); 4259 4260 DenseMap<Value *, SmallVector<StoreInst *, 4>> PtrToStoresMap = 4261 collectUserStores(TE); 4262 4263 // Holds the reorder indices for each candidate store vector that is a user of 4264 // the current TreeEntry. 4265 SmallVector<OrdersType, 1> ExternalReorderIndices; 4266 4267 // Now inspect the stores collected per pointer and look for vectorization 4268 // candidates. For each candidate calculate the reorder index vector and push 4269 // it into `ExternalReorderIndices` 4270 for (const auto &Pair : PtrToStoresMap) { 4271 auto &StoresVec = Pair.second; 4272 // If we have fewer than NumLanes stores, then we can't form a vector. 4273 if (StoresVec.size() != NumLanes) 4274 continue; 4275 4276 // If the stores are not consecutive then abandon this StoresVec. 4277 OrdersType ReorderIndices; 4278 if (!CanFormVector(StoresVec, ReorderIndices)) 4279 continue; 4280 4281 // We now know that the scalars in StoresVec can form a vector instruction, 4282 // so set the reorder indices. 4283 ExternalReorderIndices.push_back(ReorderIndices); 4284 } 4285 return ExternalReorderIndices; 4286 } 4287 4288 void BoUpSLP::buildTree(ArrayRef<Value *> Roots, 4289 const SmallDenseSet<Value *> &UserIgnoreLst) { 4290 deleteTree(); 4291 UserIgnoreList = &UserIgnoreLst; 4292 if (!allSameType(Roots)) 4293 return; 4294 buildTree_rec(Roots, 0, EdgeInfo()); 4295 } 4296 4297 void BoUpSLP::buildTree(ArrayRef<Value *> Roots) { 4298 deleteTree(); 4299 if (!allSameType(Roots)) 4300 return; 4301 buildTree_rec(Roots, 0, EdgeInfo()); 4302 } 4303 4304 namespace { 4305 /// Tracks the state we can represent the loads in the given sequence. 4306 enum class LoadsState { Gather, Vectorize, ScatterVectorize }; 4307 } // anonymous namespace 4308 4309 /// Checks if the given array of loads can be represented as a vectorized, 4310 /// scatter or just simple gather. 4311 static LoadsState canVectorizeLoads(ArrayRef<Value *> VL, const Value *VL0, 4312 const TargetTransformInfo &TTI, 4313 const DataLayout &DL, ScalarEvolution &SE, 4314 SmallVectorImpl<unsigned> &Order, 4315 SmallVectorImpl<Value *> &PointerOps) { 4316 // Check that a vectorized load would load the same memory as a scalar 4317 // load. For example, we don't want to vectorize loads that are smaller 4318 // than 8-bit. Even though we have a packed struct {<i2, i2, i2, i2>} LLVM 4319 // treats loading/storing it as an i8 struct. If we vectorize loads/stores 4320 // from such a struct, we read/write packed bits disagreeing with the 4321 // unvectorized version. 4322 Type *ScalarTy = VL0->getType(); 4323 4324 if (DL.getTypeSizeInBits(ScalarTy) != DL.getTypeAllocSizeInBits(ScalarTy)) 4325 return LoadsState::Gather; 4326 4327 // Make sure all loads in the bundle are simple - we can't vectorize 4328 // atomic or volatile loads. 4329 PointerOps.clear(); 4330 PointerOps.resize(VL.size()); 4331 auto *POIter = PointerOps.begin(); 4332 for (Value *V : VL) { 4333 auto *L = cast<LoadInst>(V); 4334 if (!L->isSimple()) 4335 return LoadsState::Gather; 4336 *POIter = L->getPointerOperand(); 4337 ++POIter; 4338 } 4339 4340 Order.clear(); 4341 // Check the order of pointer operands. 4342 if (llvm::sortPtrAccesses(PointerOps, ScalarTy, DL, SE, Order)) { 4343 Value *Ptr0; 4344 Value *PtrN; 4345 if (Order.empty()) { 4346 Ptr0 = PointerOps.front(); 4347 PtrN = PointerOps.back(); 4348 } else { 4349 Ptr0 = PointerOps[Order.front()]; 4350 PtrN = PointerOps[Order.back()]; 4351 } 4352 Optional<int> Diff = 4353 getPointersDiff(ScalarTy, Ptr0, ScalarTy, PtrN, DL, SE); 4354 // Check that the sorted loads are consecutive. 4355 if (static_cast<unsigned>(*Diff) == VL.size() - 1) 4356 return LoadsState::Vectorize; 4357 Align CommonAlignment = cast<LoadInst>(VL0)->getAlign(); 4358 for (Value *V : VL) 4359 CommonAlignment = 4360 commonAlignment(CommonAlignment, cast<LoadInst>(V)->getAlign()); 4361 if (TTI.isLegalMaskedGather(FixedVectorType::get(ScalarTy, VL.size()), 4362 CommonAlignment)) 4363 return LoadsState::ScatterVectorize; 4364 } 4365 4366 return LoadsState::Gather; 4367 } 4368 4369 /// \return true if the specified list of values has only one instruction that 4370 /// requires scheduling, false otherwise. 4371 #ifndef NDEBUG 4372 static bool needToScheduleSingleInstruction(ArrayRef<Value *> VL) { 4373 Value *NeedsScheduling = nullptr; 4374 for (Value *V : VL) { 4375 if (doesNotNeedToBeScheduled(V)) 4376 continue; 4377 if (!NeedsScheduling) { 4378 NeedsScheduling = V; 4379 continue; 4380 } 4381 return false; 4382 } 4383 return NeedsScheduling; 4384 } 4385 #endif 4386 4387 /// Generates key/subkey pair for the given value to provide effective sorting 4388 /// of the values and better detection of the vectorizable values sequences. The 4389 /// keys/subkeys can be used for better sorting of the values themselves (keys) 4390 /// and in values subgroups (subkeys). 4391 static std::pair<size_t, size_t> generateKeySubkey( 4392 Value *V, const TargetLibraryInfo *TLI, 4393 function_ref<hash_code(size_t, LoadInst *)> LoadsSubkeyGenerator, 4394 bool AllowAlternate) { 4395 hash_code Key = hash_value(V->getValueID() + 2); 4396 hash_code SubKey = hash_value(0); 4397 // Sort the loads by the distance between the pointers. 4398 if (auto *LI = dyn_cast<LoadInst>(V)) { 4399 Key = hash_combine(hash_value(Instruction::Load), Key); 4400 if (LI->isSimple()) 4401 SubKey = hash_value(LoadsSubkeyGenerator(Key, LI)); 4402 else 4403 SubKey = hash_value(LI); 4404 } else if (isVectorLikeInstWithConstOps(V)) { 4405 // Sort extracts by the vector operands. 4406 if (isa<ExtractElementInst, UndefValue>(V)) 4407 Key = hash_value(Value::UndefValueVal + 1); 4408 if (auto *EI = dyn_cast<ExtractElementInst>(V)) { 4409 if (!isUndefVector(EI->getVectorOperand()) && 4410 !isa<UndefValue>(EI->getIndexOperand())) 4411 SubKey = hash_value(EI->getVectorOperand()); 4412 } 4413 } else if (auto *I = dyn_cast<Instruction>(V)) { 4414 // Sort other instructions just by the opcodes except for CMPInst. 4415 // For CMP also sort by the predicate kind. 4416 if ((isa<BinaryOperator>(I) || isa<CastInst>(I)) && 4417 isValidForAlternation(I->getOpcode())) { 4418 if (AllowAlternate) 4419 Key = hash_value(isa<BinaryOperator>(I) ? 1 : 0); 4420 else 4421 Key = hash_combine(hash_value(I->getOpcode()), Key); 4422 SubKey = hash_combine( 4423 hash_value(I->getOpcode()), hash_value(I->getType()), 4424 hash_value(isa<BinaryOperator>(I) 4425 ? I->getType() 4426 : cast<CastInst>(I)->getOperand(0)->getType())); 4427 } else if (auto *CI = dyn_cast<CmpInst>(I)) { 4428 CmpInst::Predicate Pred = CI->getPredicate(); 4429 if (CI->isCommutative()) 4430 Pred = std::min(Pred, CmpInst::getInversePredicate(Pred)); 4431 CmpInst::Predicate SwapPred = CmpInst::getSwappedPredicate(Pred); 4432 SubKey = hash_combine(hash_value(I->getOpcode()), hash_value(Pred), 4433 hash_value(SwapPred), 4434 hash_value(CI->getOperand(0)->getType())); 4435 } else if (auto *Call = dyn_cast<CallInst>(I)) { 4436 Intrinsic::ID ID = getVectorIntrinsicIDForCall(Call, TLI); 4437 if (isTriviallyVectorizable(ID)) 4438 SubKey = hash_combine(hash_value(I->getOpcode()), hash_value(ID)); 4439 else if (!VFDatabase(*Call).getMappings(*Call).empty()) 4440 SubKey = hash_combine(hash_value(I->getOpcode()), 4441 hash_value(Call->getCalledFunction())); 4442 else 4443 SubKey = hash_combine(hash_value(I->getOpcode()), hash_value(Call)); 4444 for (const CallBase::BundleOpInfo &Op : Call->bundle_op_infos()) 4445 SubKey = hash_combine(hash_value(Op.Begin), hash_value(Op.End), 4446 hash_value(Op.Tag), SubKey); 4447 } else if (auto *Gep = dyn_cast<GetElementPtrInst>(I)) { 4448 if (Gep->getNumOperands() == 2 && isa<ConstantInt>(Gep->getOperand(1))) 4449 SubKey = hash_value(Gep->getPointerOperand()); 4450 else 4451 SubKey = hash_value(Gep); 4452 } else if (BinaryOperator::isIntDivRem(I->getOpcode()) && 4453 !isa<ConstantInt>(I->getOperand(1))) { 4454 // Do not try to vectorize instructions with potentially high cost. 4455 SubKey = hash_value(I); 4456 } else { 4457 SubKey = hash_value(I->getOpcode()); 4458 } 4459 Key = hash_combine(hash_value(I->getParent()), Key); 4460 } 4461 return std::make_pair(Key, SubKey); 4462 } 4463 4464 void BoUpSLP::buildTree_rec(ArrayRef<Value *> VL, unsigned Depth, 4465 const EdgeInfo &UserTreeIdx) { 4466 assert((allConstant(VL) || allSameType(VL)) && "Invalid types!"); 4467 4468 SmallVector<int> ReuseShuffleIndicies; 4469 SmallVector<Value *> UniqueValues; 4470 auto &&TryToFindDuplicates = [&VL, &ReuseShuffleIndicies, &UniqueValues, 4471 &UserTreeIdx, 4472 this](const InstructionsState &S) { 4473 // Check that every instruction appears once in this bundle. 4474 DenseMap<Value *, unsigned> UniquePositions; 4475 for (Value *V : VL) { 4476 if (isConstant(V)) { 4477 ReuseShuffleIndicies.emplace_back( 4478 isa<UndefValue>(V) ? UndefMaskElem : UniqueValues.size()); 4479 UniqueValues.emplace_back(V); 4480 continue; 4481 } 4482 auto Res = UniquePositions.try_emplace(V, UniqueValues.size()); 4483 ReuseShuffleIndicies.emplace_back(Res.first->second); 4484 if (Res.second) 4485 UniqueValues.emplace_back(V); 4486 } 4487 size_t NumUniqueScalarValues = UniqueValues.size(); 4488 if (NumUniqueScalarValues == VL.size()) { 4489 ReuseShuffleIndicies.clear(); 4490 } else { 4491 LLVM_DEBUG(dbgs() << "SLP: Shuffle for reused scalars.\n"); 4492 if (NumUniqueScalarValues <= 1 || 4493 (UniquePositions.size() == 1 && all_of(UniqueValues, 4494 [](Value *V) { 4495 return isa<UndefValue>(V) || 4496 !isConstant(V); 4497 })) || 4498 !llvm::isPowerOf2_32(NumUniqueScalarValues)) { 4499 LLVM_DEBUG(dbgs() << "SLP: Scalar used twice in bundle.\n"); 4500 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4501 return false; 4502 } 4503 VL = UniqueValues; 4504 } 4505 return true; 4506 }; 4507 4508 InstructionsState S = getSameOpcode(VL); 4509 if (Depth == RecursionMaxDepth) { 4510 LLVM_DEBUG(dbgs() << "SLP: Gathering due to max recursion depth.\n"); 4511 if (TryToFindDuplicates(S)) 4512 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4513 ReuseShuffleIndicies); 4514 return; 4515 } 4516 4517 // Don't handle scalable vectors 4518 if (S.getOpcode() == Instruction::ExtractElement && 4519 isa<ScalableVectorType>( 4520 cast<ExtractElementInst>(S.OpValue)->getVectorOperandType())) { 4521 LLVM_DEBUG(dbgs() << "SLP: Gathering due to scalable vector type.\n"); 4522 if (TryToFindDuplicates(S)) 4523 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4524 ReuseShuffleIndicies); 4525 return; 4526 } 4527 4528 // Don't handle vectors. 4529 if (S.OpValue->getType()->isVectorTy() && 4530 !isa<InsertElementInst>(S.OpValue)) { 4531 LLVM_DEBUG(dbgs() << "SLP: Gathering due to vector type.\n"); 4532 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4533 return; 4534 } 4535 4536 if (StoreInst *SI = dyn_cast<StoreInst>(S.OpValue)) 4537 if (SI->getValueOperand()->getType()->isVectorTy()) { 4538 LLVM_DEBUG(dbgs() << "SLP: Gathering due to store vector type.\n"); 4539 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4540 return; 4541 } 4542 4543 // If all of the operands are identical or constant we have a simple solution. 4544 // If we deal with insert/extract instructions, they all must have constant 4545 // indices, otherwise we should gather them, not try to vectorize. 4546 // If alternate op node with 2 elements with gathered operands - do not 4547 // vectorize. 4548 auto &&NotProfitableForVectorization = [&S, this, 4549 Depth](ArrayRef<Value *> VL) { 4550 if (!S.getOpcode() || !S.isAltShuffle() || VL.size() > 2) 4551 return false; 4552 if (VectorizableTree.size() < MinTreeSize) 4553 return false; 4554 if (Depth >= RecursionMaxDepth - 1) 4555 return true; 4556 // Check if all operands are extracts, part of vector node or can build a 4557 // regular vectorize node. 4558 SmallVector<unsigned, 2> InstsCount(VL.size(), 0); 4559 for (Value *V : VL) { 4560 auto *I = cast<Instruction>(V); 4561 InstsCount.push_back(count_if(I->operand_values(), [](Value *Op) { 4562 return isa<Instruction>(Op) || isVectorLikeInstWithConstOps(Op); 4563 })); 4564 } 4565 bool IsCommutative = isCommutative(S.MainOp) || isCommutative(S.AltOp); 4566 if ((IsCommutative && 4567 std::accumulate(InstsCount.begin(), InstsCount.end(), 0) < 2) || 4568 (!IsCommutative && 4569 all_of(InstsCount, [](unsigned ICnt) { return ICnt < 2; }))) 4570 return true; 4571 assert(VL.size() == 2 && "Expected only 2 alternate op instructions."); 4572 SmallVector<SmallVector<std::pair<Value *, Value *>>> Candidates; 4573 auto *I1 = cast<Instruction>(VL.front()); 4574 auto *I2 = cast<Instruction>(VL.back()); 4575 for (int Op = 0, E = S.MainOp->getNumOperands(); Op < E; ++Op) 4576 Candidates.emplace_back().emplace_back(I1->getOperand(Op), 4577 I2->getOperand(Op)); 4578 if (count_if( 4579 Candidates, [this](ArrayRef<std::pair<Value *, Value *>> Cand) { 4580 return findBestRootPair(Cand, LookAheadHeuristics::ScoreSplat); 4581 }) >= S.MainOp->getNumOperands() / 2) 4582 return false; 4583 if (S.MainOp->getNumOperands() > 2) 4584 return true; 4585 if (IsCommutative) { 4586 // Check permuted operands. 4587 Candidates.clear(); 4588 for (int Op = 0, E = S.MainOp->getNumOperands(); Op < E; ++Op) 4589 Candidates.emplace_back().emplace_back(I1->getOperand(Op), 4590 I2->getOperand((Op + 1) % E)); 4591 if (any_of( 4592 Candidates, [this](ArrayRef<std::pair<Value *, Value *>> Cand) { 4593 return findBestRootPair(Cand, LookAheadHeuristics::ScoreSplat); 4594 })) 4595 return false; 4596 } 4597 return true; 4598 }; 4599 if (allConstant(VL) || isSplat(VL) || !allSameBlock(VL) || !S.getOpcode() || 4600 (isa<InsertElementInst, ExtractValueInst, ExtractElementInst>(S.MainOp) && 4601 !all_of(VL, isVectorLikeInstWithConstOps)) || 4602 NotProfitableForVectorization(VL)) { 4603 LLVM_DEBUG(dbgs() << "SLP: Gathering due to C,S,B,O, small shuffle. \n"); 4604 if (TryToFindDuplicates(S)) 4605 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4606 ReuseShuffleIndicies); 4607 return; 4608 } 4609 4610 // We now know that this is a vector of instructions of the same type from 4611 // the same block. 4612 4613 // Don't vectorize ephemeral values. 4614 if (!EphValues.empty()) { 4615 for (Value *V : VL) { 4616 if (EphValues.count(V)) { 4617 LLVM_DEBUG(dbgs() << "SLP: The instruction (" << *V 4618 << ") is ephemeral.\n"); 4619 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4620 return; 4621 } 4622 } 4623 } 4624 4625 // Check if this is a duplicate of another entry. 4626 if (TreeEntry *E = getTreeEntry(S.OpValue)) { 4627 LLVM_DEBUG(dbgs() << "SLP: \tChecking bundle: " << *S.OpValue << ".\n"); 4628 if (!E->isSame(VL)) { 4629 LLVM_DEBUG(dbgs() << "SLP: Gathering due to partial overlap.\n"); 4630 if (TryToFindDuplicates(S)) 4631 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4632 ReuseShuffleIndicies); 4633 return; 4634 } 4635 // Record the reuse of the tree node. FIXME, currently this is only used to 4636 // properly draw the graph rather than for the actual vectorization. 4637 E->UserTreeIndices.push_back(UserTreeIdx); 4638 LLVM_DEBUG(dbgs() << "SLP: Perfect diamond merge at " << *S.OpValue 4639 << ".\n"); 4640 return; 4641 } 4642 4643 // Check that none of the instructions in the bundle are already in the tree. 4644 for (Value *V : VL) { 4645 auto *I = dyn_cast<Instruction>(V); 4646 if (!I) 4647 continue; 4648 if (getTreeEntry(I)) { 4649 LLVM_DEBUG(dbgs() << "SLP: The instruction (" << *V 4650 << ") is already in tree.\n"); 4651 if (TryToFindDuplicates(S)) 4652 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4653 ReuseShuffleIndicies); 4654 return; 4655 } 4656 } 4657 4658 // The reduction nodes (stored in UserIgnoreList) also should stay scalar. 4659 if (UserIgnoreList && !UserIgnoreList->empty()) { 4660 for (Value *V : VL) { 4661 if (UserIgnoreList && UserIgnoreList->contains(V)) { 4662 LLVM_DEBUG(dbgs() << "SLP: Gathering due to gathered scalar.\n"); 4663 if (TryToFindDuplicates(S)) 4664 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4665 ReuseShuffleIndicies); 4666 return; 4667 } 4668 } 4669 } 4670 4671 // Check that all of the users of the scalars that we want to vectorize are 4672 // schedulable. 4673 auto *VL0 = cast<Instruction>(S.OpValue); 4674 BasicBlock *BB = VL0->getParent(); 4675 4676 if (!DT->isReachableFromEntry(BB)) { 4677 // Don't go into unreachable blocks. They may contain instructions with 4678 // dependency cycles which confuse the final scheduling. 4679 LLVM_DEBUG(dbgs() << "SLP: bundle in unreachable block.\n"); 4680 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4681 return; 4682 } 4683 4684 // Check that every instruction appears once in this bundle. 4685 if (!TryToFindDuplicates(S)) 4686 return; 4687 4688 auto &BSRef = BlocksSchedules[BB]; 4689 if (!BSRef) 4690 BSRef = std::make_unique<BlockScheduling>(BB); 4691 4692 BlockScheduling &BS = *BSRef; 4693 4694 Optional<ScheduleData *> Bundle = BS.tryScheduleBundle(VL, this, S); 4695 #ifdef EXPENSIVE_CHECKS 4696 // Make sure we didn't break any internal invariants 4697 BS.verify(); 4698 #endif 4699 if (!Bundle) { 4700 LLVM_DEBUG(dbgs() << "SLP: We are not able to schedule this bundle!\n"); 4701 assert((!BS.getScheduleData(VL0) || 4702 !BS.getScheduleData(VL0)->isPartOfBundle()) && 4703 "tryScheduleBundle should cancelScheduling on failure"); 4704 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4705 ReuseShuffleIndicies); 4706 return; 4707 } 4708 LLVM_DEBUG(dbgs() << "SLP: We are able to schedule this bundle.\n"); 4709 4710 unsigned ShuffleOrOp = S.isAltShuffle() ? 4711 (unsigned) Instruction::ShuffleVector : S.getOpcode(); 4712 switch (ShuffleOrOp) { 4713 case Instruction::PHI: { 4714 auto *PH = cast<PHINode>(VL0); 4715 4716 // Check for terminator values (e.g. invoke). 4717 for (Value *V : VL) 4718 for (Value *Incoming : cast<PHINode>(V)->incoming_values()) { 4719 Instruction *Term = dyn_cast<Instruction>(Incoming); 4720 if (Term && Term->isTerminator()) { 4721 LLVM_DEBUG(dbgs() 4722 << "SLP: Need to swizzle PHINodes (terminator use).\n"); 4723 BS.cancelScheduling(VL, VL0); 4724 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4725 ReuseShuffleIndicies); 4726 return; 4727 } 4728 } 4729 4730 TreeEntry *TE = 4731 newTreeEntry(VL, Bundle, S, UserTreeIdx, ReuseShuffleIndicies); 4732 LLVM_DEBUG(dbgs() << "SLP: added a vector of PHINodes.\n"); 4733 4734 // Keeps the reordered operands to avoid code duplication. 4735 SmallVector<ValueList, 2> OperandsVec; 4736 for (unsigned I = 0, E = PH->getNumIncomingValues(); I < E; ++I) { 4737 if (!DT->isReachableFromEntry(PH->getIncomingBlock(I))) { 4738 ValueList Operands(VL.size(), PoisonValue::get(PH->getType())); 4739 TE->setOperand(I, Operands); 4740 OperandsVec.push_back(Operands); 4741 continue; 4742 } 4743 ValueList Operands; 4744 // Prepare the operand vector. 4745 for (Value *V : VL) 4746 Operands.push_back(cast<PHINode>(V)->getIncomingValueForBlock( 4747 PH->getIncomingBlock(I))); 4748 TE->setOperand(I, Operands); 4749 OperandsVec.push_back(Operands); 4750 } 4751 for (unsigned OpIdx = 0, OpE = OperandsVec.size(); OpIdx != OpE; ++OpIdx) 4752 buildTree_rec(OperandsVec[OpIdx], Depth + 1, {TE, OpIdx}); 4753 return; 4754 } 4755 case Instruction::ExtractValue: 4756 case Instruction::ExtractElement: { 4757 OrdersType CurrentOrder; 4758 bool Reuse = canReuseExtract(VL, VL0, CurrentOrder); 4759 if (Reuse) { 4760 LLVM_DEBUG(dbgs() << "SLP: Reusing or shuffling extract sequence.\n"); 4761 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4762 ReuseShuffleIndicies); 4763 // This is a special case, as it does not gather, but at the same time 4764 // we are not extending buildTree_rec() towards the operands. 4765 ValueList Op0; 4766 Op0.assign(VL.size(), VL0->getOperand(0)); 4767 VectorizableTree.back()->setOperand(0, Op0); 4768 return; 4769 } 4770 if (!CurrentOrder.empty()) { 4771 LLVM_DEBUG({ 4772 dbgs() << "SLP: Reusing or shuffling of reordered extract sequence " 4773 "with order"; 4774 for (unsigned Idx : CurrentOrder) 4775 dbgs() << " " << Idx; 4776 dbgs() << "\n"; 4777 }); 4778 fixupOrderingIndices(CurrentOrder); 4779 // Insert new order with initial value 0, if it does not exist, 4780 // otherwise return the iterator to the existing one. 4781 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4782 ReuseShuffleIndicies, CurrentOrder); 4783 // This is a special case, as it does not gather, but at the same time 4784 // we are not extending buildTree_rec() towards the operands. 4785 ValueList Op0; 4786 Op0.assign(VL.size(), VL0->getOperand(0)); 4787 VectorizableTree.back()->setOperand(0, Op0); 4788 return; 4789 } 4790 LLVM_DEBUG(dbgs() << "SLP: Gather extract sequence.\n"); 4791 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4792 ReuseShuffleIndicies); 4793 BS.cancelScheduling(VL, VL0); 4794 return; 4795 } 4796 case Instruction::InsertElement: { 4797 assert(ReuseShuffleIndicies.empty() && "All inserts should be unique"); 4798 4799 // Check that we have a buildvector and not a shuffle of 2 or more 4800 // different vectors. 4801 ValueSet SourceVectors; 4802 for (Value *V : VL) { 4803 SourceVectors.insert(cast<Instruction>(V)->getOperand(0)); 4804 assert(getInsertIndex(V) != None && "Non-constant or undef index?"); 4805 } 4806 4807 if (count_if(VL, [&SourceVectors](Value *V) { 4808 return !SourceVectors.contains(V); 4809 }) >= 2) { 4810 // Found 2nd source vector - cancel. 4811 LLVM_DEBUG(dbgs() << "SLP: Gather of insertelement vectors with " 4812 "different source vectors.\n"); 4813 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 4814 BS.cancelScheduling(VL, VL0); 4815 return; 4816 } 4817 4818 auto OrdCompare = [](const std::pair<int, int> &P1, 4819 const std::pair<int, int> &P2) { 4820 return P1.first > P2.first; 4821 }; 4822 PriorityQueue<std::pair<int, int>, SmallVector<std::pair<int, int>>, 4823 decltype(OrdCompare)> 4824 Indices(OrdCompare); 4825 for (int I = 0, E = VL.size(); I < E; ++I) { 4826 unsigned Idx = *getInsertIndex(VL[I]); 4827 Indices.emplace(Idx, I); 4828 } 4829 OrdersType CurrentOrder(VL.size(), VL.size()); 4830 bool IsIdentity = true; 4831 for (int I = 0, E = VL.size(); I < E; ++I) { 4832 CurrentOrder[Indices.top().second] = I; 4833 IsIdentity &= Indices.top().second == I; 4834 Indices.pop(); 4835 } 4836 if (IsIdentity) 4837 CurrentOrder.clear(); 4838 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4839 None, CurrentOrder); 4840 LLVM_DEBUG(dbgs() << "SLP: added inserts bundle.\n"); 4841 4842 constexpr int NumOps = 2; 4843 ValueList VectorOperands[NumOps]; 4844 for (int I = 0; I < NumOps; ++I) { 4845 for (Value *V : VL) 4846 VectorOperands[I].push_back(cast<Instruction>(V)->getOperand(I)); 4847 4848 TE->setOperand(I, VectorOperands[I]); 4849 } 4850 buildTree_rec(VectorOperands[NumOps - 1], Depth + 1, {TE, NumOps - 1}); 4851 return; 4852 } 4853 case Instruction::Load: { 4854 // Check that a vectorized load would load the same memory as a scalar 4855 // load. For example, we don't want to vectorize loads that are smaller 4856 // than 8-bit. Even though we have a packed struct {<i2, i2, i2, i2>} LLVM 4857 // treats loading/storing it as an i8 struct. If we vectorize loads/stores 4858 // from such a struct, we read/write packed bits disagreeing with the 4859 // unvectorized version. 4860 SmallVector<Value *> PointerOps; 4861 OrdersType CurrentOrder; 4862 TreeEntry *TE = nullptr; 4863 switch (canVectorizeLoads(VL, VL0, *TTI, *DL, *SE, CurrentOrder, 4864 PointerOps)) { 4865 case LoadsState::Vectorize: 4866 if (CurrentOrder.empty()) { 4867 // Original loads are consecutive and does not require reordering. 4868 TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4869 ReuseShuffleIndicies); 4870 LLVM_DEBUG(dbgs() << "SLP: added a vector of loads.\n"); 4871 } else { 4872 fixupOrderingIndices(CurrentOrder); 4873 // Need to reorder. 4874 TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4875 ReuseShuffleIndicies, CurrentOrder); 4876 LLVM_DEBUG(dbgs() << "SLP: added a vector of jumbled loads.\n"); 4877 } 4878 TE->setOperandsInOrder(); 4879 break; 4880 case LoadsState::ScatterVectorize: 4881 // Vectorizing non-consecutive loads with `llvm.masked.gather`. 4882 TE = newTreeEntry(VL, TreeEntry::ScatterVectorize, Bundle, S, 4883 UserTreeIdx, ReuseShuffleIndicies); 4884 TE->setOperandsInOrder(); 4885 buildTree_rec(PointerOps, Depth + 1, {TE, 0}); 4886 LLVM_DEBUG(dbgs() << "SLP: added a vector of non-consecutive loads.\n"); 4887 break; 4888 case LoadsState::Gather: 4889 BS.cancelScheduling(VL, VL0); 4890 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4891 ReuseShuffleIndicies); 4892 #ifndef NDEBUG 4893 Type *ScalarTy = VL0->getType(); 4894 if (DL->getTypeSizeInBits(ScalarTy) != 4895 DL->getTypeAllocSizeInBits(ScalarTy)) 4896 LLVM_DEBUG(dbgs() << "SLP: Gathering loads of non-packed type.\n"); 4897 else if (any_of(VL, [](Value *V) { 4898 return !cast<LoadInst>(V)->isSimple(); 4899 })) 4900 LLVM_DEBUG(dbgs() << "SLP: Gathering non-simple loads.\n"); 4901 else 4902 LLVM_DEBUG(dbgs() << "SLP: Gathering non-consecutive loads.\n"); 4903 #endif // NDEBUG 4904 break; 4905 } 4906 return; 4907 } 4908 case Instruction::ZExt: 4909 case Instruction::SExt: 4910 case Instruction::FPToUI: 4911 case Instruction::FPToSI: 4912 case Instruction::FPExt: 4913 case Instruction::PtrToInt: 4914 case Instruction::IntToPtr: 4915 case Instruction::SIToFP: 4916 case Instruction::UIToFP: 4917 case Instruction::Trunc: 4918 case Instruction::FPTrunc: 4919 case Instruction::BitCast: { 4920 Type *SrcTy = VL0->getOperand(0)->getType(); 4921 for (Value *V : VL) { 4922 Type *Ty = cast<Instruction>(V)->getOperand(0)->getType(); 4923 if (Ty != SrcTy || !isValidElementType(Ty)) { 4924 BS.cancelScheduling(VL, VL0); 4925 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4926 ReuseShuffleIndicies); 4927 LLVM_DEBUG(dbgs() 4928 << "SLP: Gathering casts with different src types.\n"); 4929 return; 4930 } 4931 } 4932 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4933 ReuseShuffleIndicies); 4934 LLVM_DEBUG(dbgs() << "SLP: added a vector of casts.\n"); 4935 4936 TE->setOperandsInOrder(); 4937 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 4938 ValueList Operands; 4939 // Prepare the operand vector. 4940 for (Value *V : VL) 4941 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 4942 4943 buildTree_rec(Operands, Depth + 1, {TE, i}); 4944 } 4945 return; 4946 } 4947 case Instruction::ICmp: 4948 case Instruction::FCmp: { 4949 // Check that all of the compares have the same predicate. 4950 CmpInst::Predicate P0 = cast<CmpInst>(VL0)->getPredicate(); 4951 CmpInst::Predicate SwapP0 = CmpInst::getSwappedPredicate(P0); 4952 Type *ComparedTy = VL0->getOperand(0)->getType(); 4953 for (Value *V : VL) { 4954 CmpInst *Cmp = cast<CmpInst>(V); 4955 if ((Cmp->getPredicate() != P0 && Cmp->getPredicate() != SwapP0) || 4956 Cmp->getOperand(0)->getType() != ComparedTy) { 4957 BS.cancelScheduling(VL, VL0); 4958 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 4959 ReuseShuffleIndicies); 4960 LLVM_DEBUG(dbgs() 4961 << "SLP: Gathering cmp with different predicate.\n"); 4962 return; 4963 } 4964 } 4965 4966 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 4967 ReuseShuffleIndicies); 4968 LLVM_DEBUG(dbgs() << "SLP: added a vector of compares.\n"); 4969 4970 ValueList Left, Right; 4971 if (cast<CmpInst>(VL0)->isCommutative()) { 4972 // Commutative predicate - collect + sort operands of the instructions 4973 // so that each side is more likely to have the same opcode. 4974 assert(P0 == SwapP0 && "Commutative Predicate mismatch"); 4975 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 4976 } else { 4977 // Collect operands - commute if it uses the swapped predicate. 4978 for (Value *V : VL) { 4979 auto *Cmp = cast<CmpInst>(V); 4980 Value *LHS = Cmp->getOperand(0); 4981 Value *RHS = Cmp->getOperand(1); 4982 if (Cmp->getPredicate() != P0) 4983 std::swap(LHS, RHS); 4984 Left.push_back(LHS); 4985 Right.push_back(RHS); 4986 } 4987 } 4988 TE->setOperand(0, Left); 4989 TE->setOperand(1, Right); 4990 buildTree_rec(Left, Depth + 1, {TE, 0}); 4991 buildTree_rec(Right, Depth + 1, {TE, 1}); 4992 return; 4993 } 4994 case Instruction::Select: 4995 case Instruction::FNeg: 4996 case Instruction::Add: 4997 case Instruction::FAdd: 4998 case Instruction::Sub: 4999 case Instruction::FSub: 5000 case Instruction::Mul: 5001 case Instruction::FMul: 5002 case Instruction::UDiv: 5003 case Instruction::SDiv: 5004 case Instruction::FDiv: 5005 case Instruction::URem: 5006 case Instruction::SRem: 5007 case Instruction::FRem: 5008 case Instruction::Shl: 5009 case Instruction::LShr: 5010 case Instruction::AShr: 5011 case Instruction::And: 5012 case Instruction::Or: 5013 case Instruction::Xor: { 5014 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5015 ReuseShuffleIndicies); 5016 LLVM_DEBUG(dbgs() << "SLP: added a vector of un/bin op.\n"); 5017 5018 // Sort operands of the instructions so that each side is more likely to 5019 // have the same opcode. 5020 if (isa<BinaryOperator>(VL0) && VL0->isCommutative()) { 5021 ValueList Left, Right; 5022 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 5023 TE->setOperand(0, Left); 5024 TE->setOperand(1, Right); 5025 buildTree_rec(Left, Depth + 1, {TE, 0}); 5026 buildTree_rec(Right, Depth + 1, {TE, 1}); 5027 return; 5028 } 5029 5030 TE->setOperandsInOrder(); 5031 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 5032 ValueList Operands; 5033 // Prepare the operand vector. 5034 for (Value *V : VL) 5035 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 5036 5037 buildTree_rec(Operands, Depth + 1, {TE, i}); 5038 } 5039 return; 5040 } 5041 case Instruction::GetElementPtr: { 5042 // We don't combine GEPs with complicated (nested) indexing. 5043 for (Value *V : VL) { 5044 if (cast<Instruction>(V)->getNumOperands() != 2) { 5045 LLVM_DEBUG(dbgs() << "SLP: not-vectorizable GEP (nested indexes).\n"); 5046 BS.cancelScheduling(VL, VL0); 5047 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5048 ReuseShuffleIndicies); 5049 return; 5050 } 5051 } 5052 5053 // We can't combine several GEPs into one vector if they operate on 5054 // different types. 5055 Type *Ty0 = cast<GEPOperator>(VL0)->getSourceElementType(); 5056 for (Value *V : VL) { 5057 Type *CurTy = cast<GEPOperator>(V)->getSourceElementType(); 5058 if (Ty0 != CurTy) { 5059 LLVM_DEBUG(dbgs() 5060 << "SLP: not-vectorizable GEP (different types).\n"); 5061 BS.cancelScheduling(VL, VL0); 5062 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5063 ReuseShuffleIndicies); 5064 return; 5065 } 5066 } 5067 5068 // We don't combine GEPs with non-constant indexes. 5069 Type *Ty1 = VL0->getOperand(1)->getType(); 5070 for (Value *V : VL) { 5071 auto Op = cast<Instruction>(V)->getOperand(1); 5072 if (!isa<ConstantInt>(Op) || 5073 (Op->getType() != Ty1 && 5074 Op->getType()->getScalarSizeInBits() > 5075 DL->getIndexSizeInBits( 5076 V->getType()->getPointerAddressSpace()))) { 5077 LLVM_DEBUG(dbgs() 5078 << "SLP: not-vectorizable GEP (non-constant indexes).\n"); 5079 BS.cancelScheduling(VL, VL0); 5080 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5081 ReuseShuffleIndicies); 5082 return; 5083 } 5084 } 5085 5086 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5087 ReuseShuffleIndicies); 5088 LLVM_DEBUG(dbgs() << "SLP: added a vector of GEPs.\n"); 5089 SmallVector<ValueList, 2> Operands(2); 5090 // Prepare the operand vector for pointer operands. 5091 for (Value *V : VL) 5092 Operands.front().push_back( 5093 cast<GetElementPtrInst>(V)->getPointerOperand()); 5094 TE->setOperand(0, Operands.front()); 5095 // Need to cast all indices to the same type before vectorization to 5096 // avoid crash. 5097 // Required to be able to find correct matches between different gather 5098 // nodes and reuse the vectorized values rather than trying to gather them 5099 // again. 5100 int IndexIdx = 1; 5101 Type *VL0Ty = VL0->getOperand(IndexIdx)->getType(); 5102 Type *Ty = all_of(VL, 5103 [VL0Ty, IndexIdx](Value *V) { 5104 return VL0Ty == cast<GetElementPtrInst>(V) 5105 ->getOperand(IndexIdx) 5106 ->getType(); 5107 }) 5108 ? VL0Ty 5109 : DL->getIndexType(cast<GetElementPtrInst>(VL0) 5110 ->getPointerOperandType() 5111 ->getScalarType()); 5112 // Prepare the operand vector. 5113 for (Value *V : VL) { 5114 auto *Op = cast<Instruction>(V)->getOperand(IndexIdx); 5115 auto *CI = cast<ConstantInt>(Op); 5116 Operands.back().push_back(ConstantExpr::getIntegerCast( 5117 CI, Ty, CI->getValue().isSignBitSet())); 5118 } 5119 TE->setOperand(IndexIdx, Operands.back()); 5120 5121 for (unsigned I = 0, Ops = Operands.size(); I < Ops; ++I) 5122 buildTree_rec(Operands[I], Depth + 1, {TE, I}); 5123 return; 5124 } 5125 case Instruction::Store: { 5126 // Check if the stores are consecutive or if we need to swizzle them. 5127 llvm::Type *ScalarTy = cast<StoreInst>(VL0)->getValueOperand()->getType(); 5128 // Avoid types that are padded when being allocated as scalars, while 5129 // being packed together in a vector (such as i1). 5130 if (DL->getTypeSizeInBits(ScalarTy) != 5131 DL->getTypeAllocSizeInBits(ScalarTy)) { 5132 BS.cancelScheduling(VL, VL0); 5133 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5134 ReuseShuffleIndicies); 5135 LLVM_DEBUG(dbgs() << "SLP: Gathering stores of non-packed type.\n"); 5136 return; 5137 } 5138 // Make sure all stores in the bundle are simple - we can't vectorize 5139 // atomic or volatile stores. 5140 SmallVector<Value *, 4> PointerOps(VL.size()); 5141 ValueList Operands(VL.size()); 5142 auto POIter = PointerOps.begin(); 5143 auto OIter = Operands.begin(); 5144 for (Value *V : VL) { 5145 auto *SI = cast<StoreInst>(V); 5146 if (!SI->isSimple()) { 5147 BS.cancelScheduling(VL, VL0); 5148 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5149 ReuseShuffleIndicies); 5150 LLVM_DEBUG(dbgs() << "SLP: Gathering non-simple stores.\n"); 5151 return; 5152 } 5153 *POIter = SI->getPointerOperand(); 5154 *OIter = SI->getValueOperand(); 5155 ++POIter; 5156 ++OIter; 5157 } 5158 5159 OrdersType CurrentOrder; 5160 // Check the order of pointer operands. 5161 if (llvm::sortPtrAccesses(PointerOps, ScalarTy, *DL, *SE, CurrentOrder)) { 5162 Value *Ptr0; 5163 Value *PtrN; 5164 if (CurrentOrder.empty()) { 5165 Ptr0 = PointerOps.front(); 5166 PtrN = PointerOps.back(); 5167 } else { 5168 Ptr0 = PointerOps[CurrentOrder.front()]; 5169 PtrN = PointerOps[CurrentOrder.back()]; 5170 } 5171 Optional<int> Dist = 5172 getPointersDiff(ScalarTy, Ptr0, ScalarTy, PtrN, *DL, *SE); 5173 // Check that the sorted pointer operands are consecutive. 5174 if (static_cast<unsigned>(*Dist) == VL.size() - 1) { 5175 if (CurrentOrder.empty()) { 5176 // Original stores are consecutive and does not require reordering. 5177 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, 5178 UserTreeIdx, ReuseShuffleIndicies); 5179 TE->setOperandsInOrder(); 5180 buildTree_rec(Operands, Depth + 1, {TE, 0}); 5181 LLVM_DEBUG(dbgs() << "SLP: added a vector of stores.\n"); 5182 } else { 5183 fixupOrderingIndices(CurrentOrder); 5184 TreeEntry *TE = 5185 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5186 ReuseShuffleIndicies, CurrentOrder); 5187 TE->setOperandsInOrder(); 5188 buildTree_rec(Operands, Depth + 1, {TE, 0}); 5189 LLVM_DEBUG(dbgs() << "SLP: added a vector of jumbled stores.\n"); 5190 } 5191 return; 5192 } 5193 } 5194 5195 BS.cancelScheduling(VL, VL0); 5196 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5197 ReuseShuffleIndicies); 5198 LLVM_DEBUG(dbgs() << "SLP: Non-consecutive store.\n"); 5199 return; 5200 } 5201 case Instruction::Call: { 5202 // Check if the calls are all to the same vectorizable intrinsic or 5203 // library function. 5204 CallInst *CI = cast<CallInst>(VL0); 5205 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 5206 5207 VFShape Shape = VFShape::get( 5208 *CI, ElementCount::getFixed(static_cast<unsigned int>(VL.size())), 5209 false /*HasGlobalPred*/); 5210 Function *VecFunc = VFDatabase(*CI).getVectorizedFunction(Shape); 5211 5212 if (!VecFunc && !isTriviallyVectorizable(ID)) { 5213 BS.cancelScheduling(VL, VL0); 5214 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5215 ReuseShuffleIndicies); 5216 LLVM_DEBUG(dbgs() << "SLP: Non-vectorizable call.\n"); 5217 return; 5218 } 5219 Function *F = CI->getCalledFunction(); 5220 unsigned NumArgs = CI->arg_size(); 5221 SmallVector<Value*, 4> ScalarArgs(NumArgs, nullptr); 5222 for (unsigned j = 0; j != NumArgs; ++j) 5223 if (isVectorIntrinsicWithScalarOpAtArg(ID, j)) 5224 ScalarArgs[j] = CI->getArgOperand(j); 5225 for (Value *V : VL) { 5226 CallInst *CI2 = dyn_cast<CallInst>(V); 5227 if (!CI2 || CI2->getCalledFunction() != F || 5228 getVectorIntrinsicIDForCall(CI2, TLI) != ID || 5229 (VecFunc && 5230 VecFunc != VFDatabase(*CI2).getVectorizedFunction(Shape)) || 5231 !CI->hasIdenticalOperandBundleSchema(*CI2)) { 5232 BS.cancelScheduling(VL, VL0); 5233 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5234 ReuseShuffleIndicies); 5235 LLVM_DEBUG(dbgs() << "SLP: mismatched calls:" << *CI << "!=" << *V 5236 << "\n"); 5237 return; 5238 } 5239 // Some intrinsics have scalar arguments and should be same in order for 5240 // them to be vectorized. 5241 for (unsigned j = 0; j != NumArgs; ++j) { 5242 if (isVectorIntrinsicWithScalarOpAtArg(ID, j)) { 5243 Value *A1J = CI2->getArgOperand(j); 5244 if (ScalarArgs[j] != A1J) { 5245 BS.cancelScheduling(VL, VL0); 5246 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5247 ReuseShuffleIndicies); 5248 LLVM_DEBUG(dbgs() << "SLP: mismatched arguments in call:" << *CI 5249 << " argument " << ScalarArgs[j] << "!=" << A1J 5250 << "\n"); 5251 return; 5252 } 5253 } 5254 } 5255 // Verify that the bundle operands are identical between the two calls. 5256 if (CI->hasOperandBundles() && 5257 !std::equal(CI->op_begin() + CI->getBundleOperandsStartIndex(), 5258 CI->op_begin() + CI->getBundleOperandsEndIndex(), 5259 CI2->op_begin() + CI2->getBundleOperandsStartIndex())) { 5260 BS.cancelScheduling(VL, VL0); 5261 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5262 ReuseShuffleIndicies); 5263 LLVM_DEBUG(dbgs() << "SLP: mismatched bundle operands in calls:" 5264 << *CI << "!=" << *V << '\n'); 5265 return; 5266 } 5267 } 5268 5269 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5270 ReuseShuffleIndicies); 5271 TE->setOperandsInOrder(); 5272 for (unsigned i = 0, e = CI->arg_size(); i != e; ++i) { 5273 // For scalar operands no need to to create an entry since no need to 5274 // vectorize it. 5275 if (isVectorIntrinsicWithScalarOpAtArg(ID, i)) 5276 continue; 5277 ValueList Operands; 5278 // Prepare the operand vector. 5279 for (Value *V : VL) { 5280 auto *CI2 = cast<CallInst>(V); 5281 Operands.push_back(CI2->getArgOperand(i)); 5282 } 5283 buildTree_rec(Operands, Depth + 1, {TE, i}); 5284 } 5285 return; 5286 } 5287 case Instruction::ShuffleVector: { 5288 // If this is not an alternate sequence of opcode like add-sub 5289 // then do not vectorize this instruction. 5290 if (!S.isAltShuffle()) { 5291 BS.cancelScheduling(VL, VL0); 5292 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5293 ReuseShuffleIndicies); 5294 LLVM_DEBUG(dbgs() << "SLP: ShuffleVector are not vectorized.\n"); 5295 return; 5296 } 5297 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 5298 ReuseShuffleIndicies); 5299 LLVM_DEBUG(dbgs() << "SLP: added a ShuffleVector op.\n"); 5300 5301 // Reorder operands if reordering would enable vectorization. 5302 auto *CI = dyn_cast<CmpInst>(VL0); 5303 if (isa<BinaryOperator>(VL0) || CI) { 5304 ValueList Left, Right; 5305 if (!CI || all_of(VL, [](Value *V) { 5306 return cast<CmpInst>(V)->isCommutative(); 5307 })) { 5308 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 5309 } else { 5310 CmpInst::Predicate P0 = CI->getPredicate(); 5311 CmpInst::Predicate AltP0 = cast<CmpInst>(S.AltOp)->getPredicate(); 5312 assert(P0 != AltP0 && 5313 "Expected different main/alternate predicates."); 5314 CmpInst::Predicate AltP0Swapped = CmpInst::getSwappedPredicate(AltP0); 5315 Value *BaseOp0 = VL0->getOperand(0); 5316 Value *BaseOp1 = VL0->getOperand(1); 5317 // Collect operands - commute if it uses the swapped predicate or 5318 // alternate operation. 5319 for (Value *V : VL) { 5320 auto *Cmp = cast<CmpInst>(V); 5321 Value *LHS = Cmp->getOperand(0); 5322 Value *RHS = Cmp->getOperand(1); 5323 CmpInst::Predicate CurrentPred = Cmp->getPredicate(); 5324 if (P0 == AltP0Swapped) { 5325 if (CI != Cmp && S.AltOp != Cmp && 5326 ((P0 == CurrentPred && 5327 !areCompatibleCmpOps(BaseOp0, BaseOp1, LHS, RHS)) || 5328 (AltP0 == CurrentPred && 5329 areCompatibleCmpOps(BaseOp0, BaseOp1, LHS, RHS)))) 5330 std::swap(LHS, RHS); 5331 } else if (P0 != CurrentPred && AltP0 != CurrentPred) { 5332 std::swap(LHS, RHS); 5333 } 5334 Left.push_back(LHS); 5335 Right.push_back(RHS); 5336 } 5337 } 5338 TE->setOperand(0, Left); 5339 TE->setOperand(1, Right); 5340 buildTree_rec(Left, Depth + 1, {TE, 0}); 5341 buildTree_rec(Right, Depth + 1, {TE, 1}); 5342 return; 5343 } 5344 5345 TE->setOperandsInOrder(); 5346 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 5347 ValueList Operands; 5348 // Prepare the operand vector. 5349 for (Value *V : VL) 5350 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 5351 5352 buildTree_rec(Operands, Depth + 1, {TE, i}); 5353 } 5354 return; 5355 } 5356 default: 5357 BS.cancelScheduling(VL, VL0); 5358 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 5359 ReuseShuffleIndicies); 5360 LLVM_DEBUG(dbgs() << "SLP: Gathering unknown instruction.\n"); 5361 return; 5362 } 5363 } 5364 5365 unsigned BoUpSLP::canMapToVector(Type *T, const DataLayout &DL) const { 5366 unsigned N = 1; 5367 Type *EltTy = T; 5368 5369 while (isa<StructType>(EltTy) || isa<ArrayType>(EltTy) || 5370 isa<VectorType>(EltTy)) { 5371 if (auto *ST = dyn_cast<StructType>(EltTy)) { 5372 // Check that struct is homogeneous. 5373 for (const auto *Ty : ST->elements()) 5374 if (Ty != *ST->element_begin()) 5375 return 0; 5376 N *= ST->getNumElements(); 5377 EltTy = *ST->element_begin(); 5378 } else if (auto *AT = dyn_cast<ArrayType>(EltTy)) { 5379 N *= AT->getNumElements(); 5380 EltTy = AT->getElementType(); 5381 } else { 5382 auto *VT = cast<FixedVectorType>(EltTy); 5383 N *= VT->getNumElements(); 5384 EltTy = VT->getElementType(); 5385 } 5386 } 5387 5388 if (!isValidElementType(EltTy)) 5389 return 0; 5390 uint64_t VTSize = DL.getTypeStoreSizeInBits(FixedVectorType::get(EltTy, N)); 5391 if (VTSize < MinVecRegSize || VTSize > MaxVecRegSize || VTSize != DL.getTypeStoreSizeInBits(T)) 5392 return 0; 5393 return N; 5394 } 5395 5396 bool BoUpSLP::canReuseExtract(ArrayRef<Value *> VL, Value *OpValue, 5397 SmallVectorImpl<unsigned> &CurrentOrder) const { 5398 const auto *It = find_if(VL, [](Value *V) { 5399 return isa<ExtractElementInst, ExtractValueInst>(V); 5400 }); 5401 assert(It != VL.end() && "Expected at least one extract instruction."); 5402 auto *E0 = cast<Instruction>(*It); 5403 assert(all_of(VL, 5404 [](Value *V) { 5405 return isa<UndefValue, ExtractElementInst, ExtractValueInst>( 5406 V); 5407 }) && 5408 "Invalid opcode"); 5409 // Check if all of the extracts come from the same vector and from the 5410 // correct offset. 5411 Value *Vec = E0->getOperand(0); 5412 5413 CurrentOrder.clear(); 5414 5415 // We have to extract from a vector/aggregate with the same number of elements. 5416 unsigned NElts; 5417 if (E0->getOpcode() == Instruction::ExtractValue) { 5418 const DataLayout &DL = E0->getModule()->getDataLayout(); 5419 NElts = canMapToVector(Vec->getType(), DL); 5420 if (!NElts) 5421 return false; 5422 // Check if load can be rewritten as load of vector. 5423 LoadInst *LI = dyn_cast<LoadInst>(Vec); 5424 if (!LI || !LI->isSimple() || !LI->hasNUses(VL.size())) 5425 return false; 5426 } else { 5427 NElts = cast<FixedVectorType>(Vec->getType())->getNumElements(); 5428 } 5429 5430 if (NElts != VL.size()) 5431 return false; 5432 5433 // Check that all of the indices extract from the correct offset. 5434 bool ShouldKeepOrder = true; 5435 unsigned E = VL.size(); 5436 // Assign to all items the initial value E + 1 so we can check if the extract 5437 // instruction index was used already. 5438 // Also, later we can check that all the indices are used and we have a 5439 // consecutive access in the extract instructions, by checking that no 5440 // element of CurrentOrder still has value E + 1. 5441 CurrentOrder.assign(E, E); 5442 unsigned I = 0; 5443 for (; I < E; ++I) { 5444 auto *Inst = dyn_cast<Instruction>(VL[I]); 5445 if (!Inst) 5446 continue; 5447 if (Inst->getOperand(0) != Vec) 5448 break; 5449 if (auto *EE = dyn_cast<ExtractElementInst>(Inst)) 5450 if (isa<UndefValue>(EE->getIndexOperand())) 5451 continue; 5452 Optional<unsigned> Idx = getExtractIndex(Inst); 5453 if (!Idx) 5454 break; 5455 const unsigned ExtIdx = *Idx; 5456 if (ExtIdx != I) { 5457 if (ExtIdx >= E || CurrentOrder[ExtIdx] != E) 5458 break; 5459 ShouldKeepOrder = false; 5460 CurrentOrder[ExtIdx] = I; 5461 } else { 5462 if (CurrentOrder[I] != E) 5463 break; 5464 CurrentOrder[I] = I; 5465 } 5466 } 5467 if (I < E) { 5468 CurrentOrder.clear(); 5469 return false; 5470 } 5471 if (ShouldKeepOrder) 5472 CurrentOrder.clear(); 5473 5474 return ShouldKeepOrder; 5475 } 5476 5477 bool BoUpSLP::areAllUsersVectorized(Instruction *I, 5478 ArrayRef<Value *> VectorizedVals) const { 5479 return (I->hasOneUse() && is_contained(VectorizedVals, I)) || 5480 all_of(I->users(), [this](User *U) { 5481 return ScalarToTreeEntry.count(U) > 0 || 5482 isVectorLikeInstWithConstOps(U) || 5483 (isa<ExtractElementInst>(U) && MustGather.contains(U)); 5484 }); 5485 } 5486 5487 static std::pair<InstructionCost, InstructionCost> 5488 getVectorCallCosts(CallInst *CI, FixedVectorType *VecTy, 5489 TargetTransformInfo *TTI, TargetLibraryInfo *TLI) { 5490 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 5491 5492 // Calculate the cost of the scalar and vector calls. 5493 SmallVector<Type *, 4> VecTys; 5494 for (Use &Arg : CI->args()) 5495 VecTys.push_back( 5496 FixedVectorType::get(Arg->getType(), VecTy->getNumElements())); 5497 FastMathFlags FMF; 5498 if (auto *FPCI = dyn_cast<FPMathOperator>(CI)) 5499 FMF = FPCI->getFastMathFlags(); 5500 SmallVector<const Value *> Arguments(CI->args()); 5501 IntrinsicCostAttributes CostAttrs(ID, VecTy, Arguments, VecTys, FMF, 5502 dyn_cast<IntrinsicInst>(CI)); 5503 auto IntrinsicCost = 5504 TTI->getIntrinsicInstrCost(CostAttrs, TTI::TCK_RecipThroughput); 5505 5506 auto Shape = VFShape::get(*CI, ElementCount::getFixed(static_cast<unsigned>( 5507 VecTy->getNumElements())), 5508 false /*HasGlobalPred*/); 5509 Function *VecFunc = VFDatabase(*CI).getVectorizedFunction(Shape); 5510 auto LibCost = IntrinsicCost; 5511 if (!CI->isNoBuiltin() && VecFunc) { 5512 // Calculate the cost of the vector library call. 5513 // If the corresponding vector call is cheaper, return its cost. 5514 LibCost = TTI->getCallInstrCost(nullptr, VecTy, VecTys, 5515 TTI::TCK_RecipThroughput); 5516 } 5517 return {IntrinsicCost, LibCost}; 5518 } 5519 5520 /// Compute the cost of creating a vector of type \p VecTy containing the 5521 /// extracted values from \p VL. 5522 static InstructionCost 5523 computeExtractCost(ArrayRef<Value *> VL, FixedVectorType *VecTy, 5524 TargetTransformInfo::ShuffleKind ShuffleKind, 5525 ArrayRef<int> Mask, TargetTransformInfo &TTI) { 5526 unsigned NumOfParts = TTI.getNumberOfParts(VecTy); 5527 5528 if (ShuffleKind != TargetTransformInfo::SK_PermuteSingleSrc || !NumOfParts || 5529 VecTy->getNumElements() < NumOfParts) 5530 return TTI.getShuffleCost(ShuffleKind, VecTy, Mask); 5531 5532 bool AllConsecutive = true; 5533 unsigned EltsPerVector = VecTy->getNumElements() / NumOfParts; 5534 unsigned Idx = -1; 5535 InstructionCost Cost = 0; 5536 5537 // Process extracts in blocks of EltsPerVector to check if the source vector 5538 // operand can be re-used directly. If not, add the cost of creating a shuffle 5539 // to extract the values into a vector register. 5540 SmallVector<int> RegMask(EltsPerVector, UndefMaskElem); 5541 for (auto *V : VL) { 5542 ++Idx; 5543 5544 // Need to exclude undefs from analysis. 5545 if (isa<UndefValue>(V) || Mask[Idx] == UndefMaskElem) 5546 continue; 5547 5548 // Reached the start of a new vector registers. 5549 if (Idx % EltsPerVector == 0) { 5550 RegMask.assign(EltsPerVector, UndefMaskElem); 5551 AllConsecutive = true; 5552 continue; 5553 } 5554 5555 // Check all extracts for a vector register on the target directly 5556 // extract values in order. 5557 unsigned CurrentIdx = *getExtractIndex(cast<Instruction>(V)); 5558 if (!isa<UndefValue>(VL[Idx - 1]) && Mask[Idx - 1] != UndefMaskElem) { 5559 unsigned PrevIdx = *getExtractIndex(cast<Instruction>(VL[Idx - 1])); 5560 AllConsecutive &= PrevIdx + 1 == CurrentIdx && 5561 CurrentIdx % EltsPerVector == Idx % EltsPerVector; 5562 RegMask[Idx % EltsPerVector] = CurrentIdx % EltsPerVector; 5563 } 5564 5565 if (AllConsecutive) 5566 continue; 5567 5568 // Skip all indices, except for the last index per vector block. 5569 if ((Idx + 1) % EltsPerVector != 0 && Idx + 1 != VL.size()) 5570 continue; 5571 5572 // If we have a series of extracts which are not consecutive and hence 5573 // cannot re-use the source vector register directly, compute the shuffle 5574 // cost to extract the vector with EltsPerVector elements. 5575 Cost += TTI.getShuffleCost( 5576 TargetTransformInfo::SK_PermuteSingleSrc, 5577 FixedVectorType::get(VecTy->getElementType(), EltsPerVector), RegMask); 5578 } 5579 return Cost; 5580 } 5581 5582 /// Build shuffle mask for shuffle graph entries and lists of main and alternate 5583 /// operations operands. 5584 static void 5585 buildShuffleEntryMask(ArrayRef<Value *> VL, ArrayRef<unsigned> ReorderIndices, 5586 ArrayRef<int> ReusesIndices, 5587 const function_ref<bool(Instruction *)> IsAltOp, 5588 SmallVectorImpl<int> &Mask, 5589 SmallVectorImpl<Value *> *OpScalars = nullptr, 5590 SmallVectorImpl<Value *> *AltScalars = nullptr) { 5591 unsigned Sz = VL.size(); 5592 Mask.assign(Sz, UndefMaskElem); 5593 SmallVector<int> OrderMask; 5594 if (!ReorderIndices.empty()) 5595 inversePermutation(ReorderIndices, OrderMask); 5596 for (unsigned I = 0; I < Sz; ++I) { 5597 unsigned Idx = I; 5598 if (!ReorderIndices.empty()) 5599 Idx = OrderMask[I]; 5600 auto *OpInst = cast<Instruction>(VL[Idx]); 5601 if (IsAltOp(OpInst)) { 5602 Mask[I] = Sz + Idx; 5603 if (AltScalars) 5604 AltScalars->push_back(OpInst); 5605 } else { 5606 Mask[I] = Idx; 5607 if (OpScalars) 5608 OpScalars->push_back(OpInst); 5609 } 5610 } 5611 if (!ReusesIndices.empty()) { 5612 SmallVector<int> NewMask(ReusesIndices.size(), UndefMaskElem); 5613 transform(ReusesIndices, NewMask.begin(), [&Mask](int Idx) { 5614 return Idx != UndefMaskElem ? Mask[Idx] : UndefMaskElem; 5615 }); 5616 Mask.swap(NewMask); 5617 } 5618 } 5619 5620 /// Checks if the specified instruction \p I is an alternate operation for the 5621 /// given \p MainOp and \p AltOp instructions. 5622 static bool isAlternateInstruction(const Instruction *I, 5623 const Instruction *MainOp, 5624 const Instruction *AltOp) { 5625 if (auto *CI0 = dyn_cast<CmpInst>(MainOp)) { 5626 auto *AltCI0 = cast<CmpInst>(AltOp); 5627 auto *CI = cast<CmpInst>(I); 5628 CmpInst::Predicate P0 = CI0->getPredicate(); 5629 CmpInst::Predicate AltP0 = AltCI0->getPredicate(); 5630 assert(P0 != AltP0 && "Expected different main/alternate predicates."); 5631 CmpInst::Predicate AltP0Swapped = CmpInst::getSwappedPredicate(AltP0); 5632 CmpInst::Predicate CurrentPred = CI->getPredicate(); 5633 if (P0 == AltP0Swapped) 5634 return I == AltCI0 || 5635 (I != MainOp && 5636 !areCompatibleCmpOps(CI0->getOperand(0), CI0->getOperand(1), 5637 CI->getOperand(0), CI->getOperand(1))); 5638 return AltP0 == CurrentPred || AltP0Swapped == CurrentPred; 5639 } 5640 return I->getOpcode() == AltOp->getOpcode(); 5641 } 5642 5643 InstructionCost BoUpSLP::getEntryCost(const TreeEntry *E, 5644 ArrayRef<Value *> VectorizedVals) { 5645 ArrayRef<Value*> VL = E->Scalars; 5646 5647 Type *ScalarTy = VL[0]->getType(); 5648 if (StoreInst *SI = dyn_cast<StoreInst>(VL[0])) 5649 ScalarTy = SI->getValueOperand()->getType(); 5650 else if (CmpInst *CI = dyn_cast<CmpInst>(VL[0])) 5651 ScalarTy = CI->getOperand(0)->getType(); 5652 else if (auto *IE = dyn_cast<InsertElementInst>(VL[0])) 5653 ScalarTy = IE->getOperand(1)->getType(); 5654 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 5655 TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput; 5656 5657 // If we have computed a smaller type for the expression, update VecTy so 5658 // that the costs will be accurate. 5659 if (MinBWs.count(VL[0])) 5660 VecTy = FixedVectorType::get( 5661 IntegerType::get(F->getContext(), MinBWs[VL[0]].first), VL.size()); 5662 unsigned EntryVF = E->getVectorFactor(); 5663 auto *FinalVecTy = FixedVectorType::get(VecTy->getElementType(), EntryVF); 5664 5665 bool NeedToShuffleReuses = !E->ReuseShuffleIndices.empty(); 5666 // FIXME: it tries to fix a problem with MSVC buildbots. 5667 TargetTransformInfo &TTIRef = *TTI; 5668 auto &&AdjustExtractsCost = [this, &TTIRef, CostKind, VL, VecTy, 5669 VectorizedVals, E](InstructionCost &Cost) { 5670 DenseMap<Value *, int> ExtractVectorsTys; 5671 SmallPtrSet<Value *, 4> CheckedExtracts; 5672 for (auto *V : VL) { 5673 if (isa<UndefValue>(V)) 5674 continue; 5675 // If all users of instruction are going to be vectorized and this 5676 // instruction itself is not going to be vectorized, consider this 5677 // instruction as dead and remove its cost from the final cost of the 5678 // vectorized tree. 5679 // Also, avoid adjusting the cost for extractelements with multiple uses 5680 // in different graph entries. 5681 const TreeEntry *VE = getTreeEntry(V); 5682 if (!CheckedExtracts.insert(V).second || 5683 !areAllUsersVectorized(cast<Instruction>(V), VectorizedVals) || 5684 (VE && VE != E)) 5685 continue; 5686 auto *EE = cast<ExtractElementInst>(V); 5687 Optional<unsigned> EEIdx = getExtractIndex(EE); 5688 if (!EEIdx) 5689 continue; 5690 unsigned Idx = *EEIdx; 5691 if (TTIRef.getNumberOfParts(VecTy) != 5692 TTIRef.getNumberOfParts(EE->getVectorOperandType())) { 5693 auto It = 5694 ExtractVectorsTys.try_emplace(EE->getVectorOperand(), Idx).first; 5695 It->getSecond() = std::min<int>(It->second, Idx); 5696 } 5697 // Take credit for instruction that will become dead. 5698 if (EE->hasOneUse()) { 5699 Instruction *Ext = EE->user_back(); 5700 if ((isa<SExtInst>(Ext) || isa<ZExtInst>(Ext)) && 5701 all_of(Ext->users(), 5702 [](User *U) { return isa<GetElementPtrInst>(U); })) { 5703 // Use getExtractWithExtendCost() to calculate the cost of 5704 // extractelement/ext pair. 5705 Cost -= 5706 TTIRef.getExtractWithExtendCost(Ext->getOpcode(), Ext->getType(), 5707 EE->getVectorOperandType(), Idx); 5708 // Add back the cost of s|zext which is subtracted separately. 5709 Cost += TTIRef.getCastInstrCost( 5710 Ext->getOpcode(), Ext->getType(), EE->getType(), 5711 TTI::getCastContextHint(Ext), CostKind, Ext); 5712 continue; 5713 } 5714 } 5715 Cost -= TTIRef.getVectorInstrCost(Instruction::ExtractElement, 5716 EE->getVectorOperandType(), Idx); 5717 } 5718 // Add a cost for subvector extracts/inserts if required. 5719 for (const auto &Data : ExtractVectorsTys) { 5720 auto *EEVTy = cast<FixedVectorType>(Data.first->getType()); 5721 unsigned NumElts = VecTy->getNumElements(); 5722 if (Data.second % NumElts == 0) 5723 continue; 5724 if (TTIRef.getNumberOfParts(EEVTy) > TTIRef.getNumberOfParts(VecTy)) { 5725 unsigned Idx = (Data.second / NumElts) * NumElts; 5726 unsigned EENumElts = EEVTy->getNumElements(); 5727 if (Idx + NumElts <= EENumElts) { 5728 Cost += 5729 TTIRef.getShuffleCost(TargetTransformInfo::SK_ExtractSubvector, 5730 EEVTy, None, Idx, VecTy); 5731 } else { 5732 // Need to round up the subvector type vectorization factor to avoid a 5733 // crash in cost model functions. Make SubVT so that Idx + VF of SubVT 5734 // <= EENumElts. 5735 auto *SubVT = 5736 FixedVectorType::get(VecTy->getElementType(), EENumElts - Idx); 5737 Cost += 5738 TTIRef.getShuffleCost(TargetTransformInfo::SK_ExtractSubvector, 5739 EEVTy, None, Idx, SubVT); 5740 } 5741 } else { 5742 Cost += TTIRef.getShuffleCost(TargetTransformInfo::SK_InsertSubvector, 5743 VecTy, None, 0, EEVTy); 5744 } 5745 } 5746 }; 5747 if (E->State == TreeEntry::NeedToGather) { 5748 if (allConstant(VL)) 5749 return 0; 5750 if (isa<InsertElementInst>(VL[0])) 5751 return InstructionCost::getInvalid(); 5752 SmallVector<int> Mask; 5753 SmallVector<const TreeEntry *> Entries; 5754 Optional<TargetTransformInfo::ShuffleKind> Shuffle = 5755 isGatherShuffledEntry(E, Mask, Entries); 5756 if (Shuffle.hasValue()) { 5757 InstructionCost GatherCost = 0; 5758 if (ShuffleVectorInst::isIdentityMask(Mask)) { 5759 // Perfect match in the graph, will reuse the previously vectorized 5760 // node. Cost is 0. 5761 LLVM_DEBUG( 5762 dbgs() 5763 << "SLP: perfect diamond match for gather bundle that starts with " 5764 << *VL.front() << ".\n"); 5765 if (NeedToShuffleReuses) 5766 GatherCost = 5767 TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, 5768 FinalVecTy, E->ReuseShuffleIndices); 5769 } else { 5770 LLVM_DEBUG(dbgs() << "SLP: shuffled " << Entries.size() 5771 << " entries for bundle that starts with " 5772 << *VL.front() << ".\n"); 5773 // Detected that instead of gather we can emit a shuffle of single/two 5774 // previously vectorized nodes. Add the cost of the permutation rather 5775 // than gather. 5776 ::addMask(Mask, E->ReuseShuffleIndices); 5777 GatherCost = TTI->getShuffleCost(*Shuffle, FinalVecTy, Mask); 5778 } 5779 return GatherCost; 5780 } 5781 if ((E->getOpcode() == Instruction::ExtractElement || 5782 all_of(E->Scalars, 5783 [](Value *V) { 5784 return isa<ExtractElementInst, UndefValue>(V); 5785 })) && 5786 allSameType(VL)) { 5787 // Check that gather of extractelements can be represented as just a 5788 // shuffle of a single/two vectors the scalars are extracted from. 5789 SmallVector<int> Mask; 5790 Optional<TargetTransformInfo::ShuffleKind> ShuffleKind = 5791 isFixedVectorShuffle(VL, Mask); 5792 if (ShuffleKind.hasValue()) { 5793 // Found the bunch of extractelement instructions that must be gathered 5794 // into a vector and can be represented as a permutation elements in a 5795 // single input vector or of 2 input vectors. 5796 InstructionCost Cost = 5797 computeExtractCost(VL, VecTy, *ShuffleKind, Mask, *TTI); 5798 AdjustExtractsCost(Cost); 5799 if (NeedToShuffleReuses) 5800 Cost += TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, 5801 FinalVecTy, E->ReuseShuffleIndices); 5802 return Cost; 5803 } 5804 } 5805 if (isSplat(VL)) { 5806 // Found the broadcasting of the single scalar, calculate the cost as the 5807 // broadcast. 5808 assert(VecTy == FinalVecTy && 5809 "No reused scalars expected for broadcast."); 5810 return TTI->getShuffleCost(TargetTransformInfo::SK_Broadcast, VecTy, 5811 /*Mask=*/None, /*Index=*/0, 5812 /*SubTp=*/nullptr, /*Args=*/VL[0]); 5813 } 5814 InstructionCost ReuseShuffleCost = 0; 5815 if (NeedToShuffleReuses) 5816 ReuseShuffleCost = TTI->getShuffleCost( 5817 TTI::SK_PermuteSingleSrc, FinalVecTy, E->ReuseShuffleIndices); 5818 // Improve gather cost for gather of loads, if we can group some of the 5819 // loads into vector loads. 5820 if (VL.size() > 2 && E->getOpcode() == Instruction::Load && 5821 !E->isAltShuffle()) { 5822 BoUpSLP::ValueSet VectorizedLoads; 5823 unsigned StartIdx = 0; 5824 unsigned VF = VL.size() / 2; 5825 unsigned VectorizedCnt = 0; 5826 unsigned ScatterVectorizeCnt = 0; 5827 const unsigned Sz = DL->getTypeSizeInBits(E->getMainOp()->getType()); 5828 for (unsigned MinVF = getMinVF(2 * Sz); VF >= MinVF; VF /= 2) { 5829 for (unsigned Cnt = StartIdx, End = VL.size(); Cnt + VF <= End; 5830 Cnt += VF) { 5831 ArrayRef<Value *> Slice = VL.slice(Cnt, VF); 5832 if (!VectorizedLoads.count(Slice.front()) && 5833 !VectorizedLoads.count(Slice.back()) && allSameBlock(Slice)) { 5834 SmallVector<Value *> PointerOps; 5835 OrdersType CurrentOrder; 5836 LoadsState LS = canVectorizeLoads(Slice, Slice.front(), *TTI, *DL, 5837 *SE, CurrentOrder, PointerOps); 5838 switch (LS) { 5839 case LoadsState::Vectorize: 5840 case LoadsState::ScatterVectorize: 5841 // Mark the vectorized loads so that we don't vectorize them 5842 // again. 5843 if (LS == LoadsState::Vectorize) 5844 ++VectorizedCnt; 5845 else 5846 ++ScatterVectorizeCnt; 5847 VectorizedLoads.insert(Slice.begin(), Slice.end()); 5848 // If we vectorized initial block, no need to try to vectorize it 5849 // again. 5850 if (Cnt == StartIdx) 5851 StartIdx += VF; 5852 break; 5853 case LoadsState::Gather: 5854 break; 5855 } 5856 } 5857 } 5858 // Check if the whole array was vectorized already - exit. 5859 if (StartIdx >= VL.size()) 5860 break; 5861 // Found vectorizable parts - exit. 5862 if (!VectorizedLoads.empty()) 5863 break; 5864 } 5865 if (!VectorizedLoads.empty()) { 5866 InstructionCost GatherCost = 0; 5867 unsigned NumParts = TTI->getNumberOfParts(VecTy); 5868 bool NeedInsertSubvectorAnalysis = 5869 !NumParts || (VL.size() / VF) > NumParts; 5870 // Get the cost for gathered loads. 5871 for (unsigned I = 0, End = VL.size(); I < End; I += VF) { 5872 if (VectorizedLoads.contains(VL[I])) 5873 continue; 5874 GatherCost += getGatherCost(VL.slice(I, VF)); 5875 } 5876 // The cost for vectorized loads. 5877 InstructionCost ScalarsCost = 0; 5878 for (Value *V : VectorizedLoads) { 5879 auto *LI = cast<LoadInst>(V); 5880 ScalarsCost += TTI->getMemoryOpCost( 5881 Instruction::Load, LI->getType(), LI->getAlign(), 5882 LI->getPointerAddressSpace(), CostKind, LI); 5883 } 5884 auto *LI = cast<LoadInst>(E->getMainOp()); 5885 auto *LoadTy = FixedVectorType::get(LI->getType(), VF); 5886 Align Alignment = LI->getAlign(); 5887 GatherCost += 5888 VectorizedCnt * 5889 TTI->getMemoryOpCost(Instruction::Load, LoadTy, Alignment, 5890 LI->getPointerAddressSpace(), CostKind, LI); 5891 GatherCost += ScatterVectorizeCnt * 5892 TTI->getGatherScatterOpCost( 5893 Instruction::Load, LoadTy, LI->getPointerOperand(), 5894 /*VariableMask=*/false, Alignment, CostKind, LI); 5895 if (NeedInsertSubvectorAnalysis) { 5896 // Add the cost for the subvectors insert. 5897 for (int I = VF, E = VL.size(); I < E; I += VF) 5898 GatherCost += TTI->getShuffleCost(TTI::SK_InsertSubvector, VecTy, 5899 None, I, LoadTy); 5900 } 5901 return ReuseShuffleCost + GatherCost - ScalarsCost; 5902 } 5903 } 5904 return ReuseShuffleCost + getGatherCost(VL); 5905 } 5906 InstructionCost CommonCost = 0; 5907 SmallVector<int> Mask; 5908 if (!E->ReorderIndices.empty()) { 5909 SmallVector<int> NewMask; 5910 if (E->getOpcode() == Instruction::Store) { 5911 // For stores the order is actually a mask. 5912 NewMask.resize(E->ReorderIndices.size()); 5913 copy(E->ReorderIndices, NewMask.begin()); 5914 } else { 5915 inversePermutation(E->ReorderIndices, NewMask); 5916 } 5917 ::addMask(Mask, NewMask); 5918 } 5919 if (NeedToShuffleReuses) 5920 ::addMask(Mask, E->ReuseShuffleIndices); 5921 if (!Mask.empty() && !ShuffleVectorInst::isIdentityMask(Mask)) 5922 CommonCost = 5923 TTI->getShuffleCost(TTI::SK_PermuteSingleSrc, FinalVecTy, Mask); 5924 assert((E->State == TreeEntry::Vectorize || 5925 E->State == TreeEntry::ScatterVectorize) && 5926 "Unhandled state"); 5927 assert(E->getOpcode() && allSameType(VL) && allSameBlock(VL) && "Invalid VL"); 5928 Instruction *VL0 = E->getMainOp(); 5929 unsigned ShuffleOrOp = 5930 E->isAltShuffle() ? (unsigned)Instruction::ShuffleVector : E->getOpcode(); 5931 switch (ShuffleOrOp) { 5932 case Instruction::PHI: 5933 return 0; 5934 5935 case Instruction::ExtractValue: 5936 case Instruction::ExtractElement: { 5937 // The common cost of removal ExtractElement/ExtractValue instructions + 5938 // the cost of shuffles, if required to resuffle the original vector. 5939 if (NeedToShuffleReuses) { 5940 unsigned Idx = 0; 5941 for (unsigned I : E->ReuseShuffleIndices) { 5942 if (ShuffleOrOp == Instruction::ExtractElement) { 5943 auto *EE = cast<ExtractElementInst>(VL[I]); 5944 CommonCost -= TTI->getVectorInstrCost(Instruction::ExtractElement, 5945 EE->getVectorOperandType(), 5946 *getExtractIndex(EE)); 5947 } else { 5948 CommonCost -= TTI->getVectorInstrCost(Instruction::ExtractElement, 5949 VecTy, Idx); 5950 ++Idx; 5951 } 5952 } 5953 Idx = EntryVF; 5954 for (Value *V : VL) { 5955 if (ShuffleOrOp == Instruction::ExtractElement) { 5956 auto *EE = cast<ExtractElementInst>(V); 5957 CommonCost += TTI->getVectorInstrCost(Instruction::ExtractElement, 5958 EE->getVectorOperandType(), 5959 *getExtractIndex(EE)); 5960 } else { 5961 --Idx; 5962 CommonCost += TTI->getVectorInstrCost(Instruction::ExtractElement, 5963 VecTy, Idx); 5964 } 5965 } 5966 } 5967 if (ShuffleOrOp == Instruction::ExtractValue) { 5968 for (unsigned I = 0, E = VL.size(); I < E; ++I) { 5969 auto *EI = cast<Instruction>(VL[I]); 5970 // Take credit for instruction that will become dead. 5971 if (EI->hasOneUse()) { 5972 Instruction *Ext = EI->user_back(); 5973 if ((isa<SExtInst>(Ext) || isa<ZExtInst>(Ext)) && 5974 all_of(Ext->users(), 5975 [](User *U) { return isa<GetElementPtrInst>(U); })) { 5976 // Use getExtractWithExtendCost() to calculate the cost of 5977 // extractelement/ext pair. 5978 CommonCost -= TTI->getExtractWithExtendCost( 5979 Ext->getOpcode(), Ext->getType(), VecTy, I); 5980 // Add back the cost of s|zext which is subtracted separately. 5981 CommonCost += TTI->getCastInstrCost( 5982 Ext->getOpcode(), Ext->getType(), EI->getType(), 5983 TTI::getCastContextHint(Ext), CostKind, Ext); 5984 continue; 5985 } 5986 } 5987 CommonCost -= 5988 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, I); 5989 } 5990 } else { 5991 AdjustExtractsCost(CommonCost); 5992 } 5993 return CommonCost; 5994 } 5995 case Instruction::InsertElement: { 5996 assert(E->ReuseShuffleIndices.empty() && 5997 "Unique insertelements only are expected."); 5998 auto *SrcVecTy = cast<FixedVectorType>(VL0->getType()); 5999 6000 unsigned const NumElts = SrcVecTy->getNumElements(); 6001 unsigned const NumScalars = VL.size(); 6002 APInt DemandedElts = APInt::getZero(NumElts); 6003 // TODO: Add support for Instruction::InsertValue. 6004 SmallVector<int> Mask; 6005 if (!E->ReorderIndices.empty()) { 6006 inversePermutation(E->ReorderIndices, Mask); 6007 Mask.append(NumElts - NumScalars, UndefMaskElem); 6008 } else { 6009 Mask.assign(NumElts, UndefMaskElem); 6010 std::iota(Mask.begin(), std::next(Mask.begin(), NumScalars), 0); 6011 } 6012 unsigned Offset = *getInsertIndex(VL0); 6013 bool IsIdentity = true; 6014 SmallVector<int> PrevMask(NumElts, UndefMaskElem); 6015 Mask.swap(PrevMask); 6016 for (unsigned I = 0; I < NumScalars; ++I) { 6017 unsigned InsertIdx = *getInsertIndex(VL[PrevMask[I]]); 6018 DemandedElts.setBit(InsertIdx); 6019 IsIdentity &= InsertIdx - Offset == I; 6020 Mask[InsertIdx - Offset] = I; 6021 } 6022 assert(Offset < NumElts && "Failed to find vector index offset"); 6023 6024 InstructionCost Cost = 0; 6025 Cost -= TTI->getScalarizationOverhead(SrcVecTy, DemandedElts, 6026 /*Insert*/ true, /*Extract*/ false); 6027 6028 if (IsIdentity && NumElts != NumScalars && Offset % NumScalars != 0) { 6029 // FIXME: Replace with SK_InsertSubvector once it is properly supported. 6030 unsigned Sz = PowerOf2Ceil(Offset + NumScalars); 6031 Cost += TTI->getShuffleCost( 6032 TargetTransformInfo::SK_PermuteSingleSrc, 6033 FixedVectorType::get(SrcVecTy->getElementType(), Sz)); 6034 } else if (!IsIdentity) { 6035 auto *FirstInsert = 6036 cast<Instruction>(*find_if(E->Scalars, [E](Value *V) { 6037 return !is_contained(E->Scalars, 6038 cast<Instruction>(V)->getOperand(0)); 6039 })); 6040 if (isUndefVector(FirstInsert->getOperand(0))) { 6041 Cost += TTI->getShuffleCost(TTI::SK_PermuteSingleSrc, SrcVecTy, Mask); 6042 } else { 6043 SmallVector<int> InsertMask(NumElts); 6044 std::iota(InsertMask.begin(), InsertMask.end(), 0); 6045 for (unsigned I = 0; I < NumElts; I++) { 6046 if (Mask[I] != UndefMaskElem) 6047 InsertMask[Offset + I] = NumElts + I; 6048 } 6049 Cost += 6050 TTI->getShuffleCost(TTI::SK_PermuteTwoSrc, SrcVecTy, InsertMask); 6051 } 6052 } 6053 6054 return Cost; 6055 } 6056 case Instruction::ZExt: 6057 case Instruction::SExt: 6058 case Instruction::FPToUI: 6059 case Instruction::FPToSI: 6060 case Instruction::FPExt: 6061 case Instruction::PtrToInt: 6062 case Instruction::IntToPtr: 6063 case Instruction::SIToFP: 6064 case Instruction::UIToFP: 6065 case Instruction::Trunc: 6066 case Instruction::FPTrunc: 6067 case Instruction::BitCast: { 6068 Type *SrcTy = VL0->getOperand(0)->getType(); 6069 InstructionCost ScalarEltCost = 6070 TTI->getCastInstrCost(E->getOpcode(), ScalarTy, SrcTy, 6071 TTI::getCastContextHint(VL0), CostKind, VL0); 6072 if (NeedToShuffleReuses) { 6073 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6074 } 6075 6076 // Calculate the cost of this instruction. 6077 InstructionCost ScalarCost = VL.size() * ScalarEltCost; 6078 6079 auto *SrcVecTy = FixedVectorType::get(SrcTy, VL.size()); 6080 InstructionCost VecCost = 0; 6081 // Check if the values are candidates to demote. 6082 if (!MinBWs.count(VL0) || VecTy != SrcVecTy) { 6083 VecCost = CommonCost + TTI->getCastInstrCost( 6084 E->getOpcode(), VecTy, SrcVecTy, 6085 TTI::getCastContextHint(VL0), CostKind, VL0); 6086 } 6087 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6088 return VecCost - ScalarCost; 6089 } 6090 case Instruction::FCmp: 6091 case Instruction::ICmp: 6092 case Instruction::Select: { 6093 // Calculate the cost of this instruction. 6094 InstructionCost ScalarEltCost = 6095 TTI->getCmpSelInstrCost(E->getOpcode(), ScalarTy, Builder.getInt1Ty(), 6096 CmpInst::BAD_ICMP_PREDICATE, CostKind, VL0); 6097 if (NeedToShuffleReuses) { 6098 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6099 } 6100 auto *MaskTy = FixedVectorType::get(Builder.getInt1Ty(), VL.size()); 6101 InstructionCost ScalarCost = VecTy->getNumElements() * ScalarEltCost; 6102 6103 // Check if all entries in VL are either compares or selects with compares 6104 // as condition that have the same predicates. 6105 CmpInst::Predicate VecPred = CmpInst::BAD_ICMP_PREDICATE; 6106 bool First = true; 6107 for (auto *V : VL) { 6108 CmpInst::Predicate CurrentPred; 6109 auto MatchCmp = m_Cmp(CurrentPred, m_Value(), m_Value()); 6110 if ((!match(V, m_Select(MatchCmp, m_Value(), m_Value())) && 6111 !match(V, MatchCmp)) || 6112 (!First && VecPred != CurrentPred)) { 6113 VecPred = CmpInst::BAD_ICMP_PREDICATE; 6114 break; 6115 } 6116 First = false; 6117 VecPred = CurrentPred; 6118 } 6119 6120 InstructionCost VecCost = TTI->getCmpSelInstrCost( 6121 E->getOpcode(), VecTy, MaskTy, VecPred, CostKind, VL0); 6122 // Check if it is possible and profitable to use min/max for selects in 6123 // VL. 6124 // 6125 auto IntrinsicAndUse = canConvertToMinOrMaxIntrinsic(VL); 6126 if (IntrinsicAndUse.first != Intrinsic::not_intrinsic) { 6127 IntrinsicCostAttributes CostAttrs(IntrinsicAndUse.first, VecTy, 6128 {VecTy, VecTy}); 6129 InstructionCost IntrinsicCost = 6130 TTI->getIntrinsicInstrCost(CostAttrs, CostKind); 6131 // If the selects are the only uses of the compares, they will be dead 6132 // and we can adjust the cost by removing their cost. 6133 if (IntrinsicAndUse.second) 6134 IntrinsicCost -= TTI->getCmpSelInstrCost(Instruction::ICmp, VecTy, 6135 MaskTy, VecPred, CostKind); 6136 VecCost = std::min(VecCost, IntrinsicCost); 6137 } 6138 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6139 return CommonCost + VecCost - ScalarCost; 6140 } 6141 case Instruction::FNeg: 6142 case Instruction::Add: 6143 case Instruction::FAdd: 6144 case Instruction::Sub: 6145 case Instruction::FSub: 6146 case Instruction::Mul: 6147 case Instruction::FMul: 6148 case Instruction::UDiv: 6149 case Instruction::SDiv: 6150 case Instruction::FDiv: 6151 case Instruction::URem: 6152 case Instruction::SRem: 6153 case Instruction::FRem: 6154 case Instruction::Shl: 6155 case Instruction::LShr: 6156 case Instruction::AShr: 6157 case Instruction::And: 6158 case Instruction::Or: 6159 case Instruction::Xor: { 6160 // Certain instructions can be cheaper to vectorize if they have a 6161 // constant second vector operand. 6162 TargetTransformInfo::OperandValueKind Op1VK = 6163 TargetTransformInfo::OK_AnyValue; 6164 TargetTransformInfo::OperandValueKind Op2VK = 6165 TargetTransformInfo::OK_UniformConstantValue; 6166 TargetTransformInfo::OperandValueProperties Op1VP = 6167 TargetTransformInfo::OP_None; 6168 TargetTransformInfo::OperandValueProperties Op2VP = 6169 TargetTransformInfo::OP_PowerOf2; 6170 6171 // If all operands are exactly the same ConstantInt then set the 6172 // operand kind to OK_UniformConstantValue. 6173 // If instead not all operands are constants, then set the operand kind 6174 // to OK_AnyValue. If all operands are constants but not the same, 6175 // then set the operand kind to OK_NonUniformConstantValue. 6176 ConstantInt *CInt0 = nullptr; 6177 for (unsigned i = 0, e = VL.size(); i < e; ++i) { 6178 const Instruction *I = cast<Instruction>(VL[i]); 6179 unsigned OpIdx = isa<BinaryOperator>(I) ? 1 : 0; 6180 ConstantInt *CInt = dyn_cast<ConstantInt>(I->getOperand(OpIdx)); 6181 if (!CInt) { 6182 Op2VK = TargetTransformInfo::OK_AnyValue; 6183 Op2VP = TargetTransformInfo::OP_None; 6184 break; 6185 } 6186 if (Op2VP == TargetTransformInfo::OP_PowerOf2 && 6187 !CInt->getValue().isPowerOf2()) 6188 Op2VP = TargetTransformInfo::OP_None; 6189 if (i == 0) { 6190 CInt0 = CInt; 6191 continue; 6192 } 6193 if (CInt0 != CInt) 6194 Op2VK = TargetTransformInfo::OK_NonUniformConstantValue; 6195 } 6196 6197 SmallVector<const Value *, 4> Operands(VL0->operand_values()); 6198 InstructionCost ScalarEltCost = 6199 TTI->getArithmeticInstrCost(E->getOpcode(), ScalarTy, CostKind, Op1VK, 6200 Op2VK, Op1VP, Op2VP, Operands, VL0); 6201 if (NeedToShuffleReuses) { 6202 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6203 } 6204 InstructionCost ScalarCost = VecTy->getNumElements() * ScalarEltCost; 6205 InstructionCost VecCost = 6206 TTI->getArithmeticInstrCost(E->getOpcode(), VecTy, CostKind, Op1VK, 6207 Op2VK, Op1VP, Op2VP, Operands, VL0); 6208 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6209 return CommonCost + VecCost - ScalarCost; 6210 } 6211 case Instruction::GetElementPtr: { 6212 TargetTransformInfo::OperandValueKind Op1VK = 6213 TargetTransformInfo::OK_AnyValue; 6214 TargetTransformInfo::OperandValueKind Op2VK = 6215 TargetTransformInfo::OK_UniformConstantValue; 6216 6217 InstructionCost ScalarEltCost = TTI->getArithmeticInstrCost( 6218 Instruction::Add, ScalarTy, CostKind, Op1VK, Op2VK); 6219 if (NeedToShuffleReuses) { 6220 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6221 } 6222 InstructionCost ScalarCost = VecTy->getNumElements() * ScalarEltCost; 6223 InstructionCost VecCost = TTI->getArithmeticInstrCost( 6224 Instruction::Add, VecTy, CostKind, Op1VK, Op2VK); 6225 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6226 return CommonCost + VecCost - ScalarCost; 6227 } 6228 case Instruction::Load: { 6229 // Cost of wide load - cost of scalar loads. 6230 Align Alignment = cast<LoadInst>(VL0)->getAlign(); 6231 InstructionCost ScalarEltCost = TTI->getMemoryOpCost( 6232 Instruction::Load, ScalarTy, Alignment, 0, CostKind, VL0); 6233 if (NeedToShuffleReuses) { 6234 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6235 } 6236 InstructionCost ScalarLdCost = VecTy->getNumElements() * ScalarEltCost; 6237 InstructionCost VecLdCost; 6238 if (E->State == TreeEntry::Vectorize) { 6239 VecLdCost = TTI->getMemoryOpCost(Instruction::Load, VecTy, Alignment, 0, 6240 CostKind, VL0); 6241 } else { 6242 assert(E->State == TreeEntry::ScatterVectorize && "Unknown EntryState"); 6243 Align CommonAlignment = Alignment; 6244 for (Value *V : VL) 6245 CommonAlignment = 6246 commonAlignment(CommonAlignment, cast<LoadInst>(V)->getAlign()); 6247 VecLdCost = TTI->getGatherScatterOpCost( 6248 Instruction::Load, VecTy, cast<LoadInst>(VL0)->getPointerOperand(), 6249 /*VariableMask=*/false, CommonAlignment, CostKind, VL0); 6250 } 6251 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecLdCost, ScalarLdCost)); 6252 return CommonCost + VecLdCost - ScalarLdCost; 6253 } 6254 case Instruction::Store: { 6255 // We know that we can merge the stores. Calculate the cost. 6256 bool IsReorder = !E->ReorderIndices.empty(); 6257 auto *SI = 6258 cast<StoreInst>(IsReorder ? VL[E->ReorderIndices.front()] : VL0); 6259 Align Alignment = SI->getAlign(); 6260 InstructionCost ScalarEltCost = TTI->getMemoryOpCost( 6261 Instruction::Store, ScalarTy, Alignment, 0, CostKind, VL0); 6262 InstructionCost ScalarStCost = VecTy->getNumElements() * ScalarEltCost; 6263 InstructionCost VecStCost = TTI->getMemoryOpCost( 6264 Instruction::Store, VecTy, Alignment, 0, CostKind, VL0); 6265 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecStCost, ScalarStCost)); 6266 return CommonCost + VecStCost - ScalarStCost; 6267 } 6268 case Instruction::Call: { 6269 CallInst *CI = cast<CallInst>(VL0); 6270 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 6271 6272 // Calculate the cost of the scalar and vector calls. 6273 IntrinsicCostAttributes CostAttrs(ID, *CI, 1); 6274 InstructionCost ScalarEltCost = 6275 TTI->getIntrinsicInstrCost(CostAttrs, CostKind); 6276 if (NeedToShuffleReuses) { 6277 CommonCost -= (EntryVF - VL.size()) * ScalarEltCost; 6278 } 6279 InstructionCost ScalarCallCost = VecTy->getNumElements() * ScalarEltCost; 6280 6281 auto VecCallCosts = getVectorCallCosts(CI, VecTy, TTI, TLI); 6282 InstructionCost VecCallCost = 6283 std::min(VecCallCosts.first, VecCallCosts.second); 6284 6285 LLVM_DEBUG(dbgs() << "SLP: Call cost " << VecCallCost - ScalarCallCost 6286 << " (" << VecCallCost << "-" << ScalarCallCost << ")" 6287 << " for " << *CI << "\n"); 6288 6289 return CommonCost + VecCallCost - ScalarCallCost; 6290 } 6291 case Instruction::ShuffleVector: { 6292 assert(E->isAltShuffle() && 6293 ((Instruction::isBinaryOp(E->getOpcode()) && 6294 Instruction::isBinaryOp(E->getAltOpcode())) || 6295 (Instruction::isCast(E->getOpcode()) && 6296 Instruction::isCast(E->getAltOpcode())) || 6297 (isa<CmpInst>(VL0) && isa<CmpInst>(E->getAltOp()))) && 6298 "Invalid Shuffle Vector Operand"); 6299 InstructionCost ScalarCost = 0; 6300 if (NeedToShuffleReuses) { 6301 for (unsigned Idx : E->ReuseShuffleIndices) { 6302 Instruction *I = cast<Instruction>(VL[Idx]); 6303 CommonCost -= TTI->getInstructionCost(I, CostKind); 6304 } 6305 for (Value *V : VL) { 6306 Instruction *I = cast<Instruction>(V); 6307 CommonCost += TTI->getInstructionCost(I, CostKind); 6308 } 6309 } 6310 for (Value *V : VL) { 6311 Instruction *I = cast<Instruction>(V); 6312 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 6313 ScalarCost += TTI->getInstructionCost(I, CostKind); 6314 } 6315 // VecCost is equal to sum of the cost of creating 2 vectors 6316 // and the cost of creating shuffle. 6317 InstructionCost VecCost = 0; 6318 // Try to find the previous shuffle node with the same operands and same 6319 // main/alternate ops. 6320 auto &&TryFindNodeWithEqualOperands = [this, E]() { 6321 for (const std::unique_ptr<TreeEntry> &TE : VectorizableTree) { 6322 if (TE.get() == E) 6323 break; 6324 if (TE->isAltShuffle() && 6325 ((TE->getOpcode() == E->getOpcode() && 6326 TE->getAltOpcode() == E->getAltOpcode()) || 6327 (TE->getOpcode() == E->getAltOpcode() && 6328 TE->getAltOpcode() == E->getOpcode())) && 6329 TE->hasEqualOperands(*E)) 6330 return true; 6331 } 6332 return false; 6333 }; 6334 if (TryFindNodeWithEqualOperands()) { 6335 LLVM_DEBUG({ 6336 dbgs() << "SLP: diamond match for alternate node found.\n"; 6337 E->dump(); 6338 }); 6339 // No need to add new vector costs here since we're going to reuse 6340 // same main/alternate vector ops, just do different shuffling. 6341 } else if (Instruction::isBinaryOp(E->getOpcode())) { 6342 VecCost = TTI->getArithmeticInstrCost(E->getOpcode(), VecTy, CostKind); 6343 VecCost += TTI->getArithmeticInstrCost(E->getAltOpcode(), VecTy, 6344 CostKind); 6345 } else if (auto *CI0 = dyn_cast<CmpInst>(VL0)) { 6346 VecCost = TTI->getCmpSelInstrCost(E->getOpcode(), ScalarTy, 6347 Builder.getInt1Ty(), 6348 CI0->getPredicate(), CostKind, VL0); 6349 VecCost += TTI->getCmpSelInstrCost( 6350 E->getOpcode(), ScalarTy, Builder.getInt1Ty(), 6351 cast<CmpInst>(E->getAltOp())->getPredicate(), CostKind, 6352 E->getAltOp()); 6353 } else { 6354 Type *Src0SclTy = E->getMainOp()->getOperand(0)->getType(); 6355 Type *Src1SclTy = E->getAltOp()->getOperand(0)->getType(); 6356 auto *Src0Ty = FixedVectorType::get(Src0SclTy, VL.size()); 6357 auto *Src1Ty = FixedVectorType::get(Src1SclTy, VL.size()); 6358 VecCost = TTI->getCastInstrCost(E->getOpcode(), VecTy, Src0Ty, 6359 TTI::CastContextHint::None, CostKind); 6360 VecCost += TTI->getCastInstrCost(E->getAltOpcode(), VecTy, Src1Ty, 6361 TTI::CastContextHint::None, CostKind); 6362 } 6363 6364 if (E->ReuseShuffleIndices.empty()) { 6365 CommonCost = 6366 TTI->getShuffleCost(TargetTransformInfo::SK_Select, FinalVecTy); 6367 } else { 6368 SmallVector<int> Mask; 6369 buildShuffleEntryMask( 6370 E->Scalars, E->ReorderIndices, E->ReuseShuffleIndices, 6371 [E](Instruction *I) { 6372 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 6373 return I->getOpcode() == E->getAltOpcode(); 6374 }, 6375 Mask); 6376 CommonCost = TTI->getShuffleCost(TargetTransformInfo::SK_PermuteTwoSrc, 6377 FinalVecTy, Mask); 6378 } 6379 LLVM_DEBUG(dumpTreeCosts(E, CommonCost, VecCost, ScalarCost)); 6380 return CommonCost + VecCost - ScalarCost; 6381 } 6382 default: 6383 llvm_unreachable("Unknown instruction"); 6384 } 6385 } 6386 6387 bool BoUpSLP::isFullyVectorizableTinyTree(bool ForReduction) const { 6388 LLVM_DEBUG(dbgs() << "SLP: Check whether the tree with height " 6389 << VectorizableTree.size() << " is fully vectorizable .\n"); 6390 6391 auto &&AreVectorizableGathers = [this](const TreeEntry *TE, unsigned Limit) { 6392 SmallVector<int> Mask; 6393 return TE->State == TreeEntry::NeedToGather && 6394 !any_of(TE->Scalars, 6395 [this](Value *V) { return EphValues.contains(V); }) && 6396 (allConstant(TE->Scalars) || isSplat(TE->Scalars) || 6397 TE->Scalars.size() < Limit || 6398 ((TE->getOpcode() == Instruction::ExtractElement || 6399 all_of(TE->Scalars, 6400 [](Value *V) { 6401 return isa<ExtractElementInst, UndefValue>(V); 6402 })) && 6403 isFixedVectorShuffle(TE->Scalars, Mask)) || 6404 (TE->State == TreeEntry::NeedToGather && 6405 TE->getOpcode() == Instruction::Load && !TE->isAltShuffle())); 6406 }; 6407 6408 // We only handle trees of heights 1 and 2. 6409 if (VectorizableTree.size() == 1 && 6410 (VectorizableTree[0]->State == TreeEntry::Vectorize || 6411 (ForReduction && 6412 AreVectorizableGathers(VectorizableTree[0].get(), 6413 VectorizableTree[0]->Scalars.size()) && 6414 VectorizableTree[0]->getVectorFactor() > 2))) 6415 return true; 6416 6417 if (VectorizableTree.size() != 2) 6418 return false; 6419 6420 // Handle splat and all-constants stores. Also try to vectorize tiny trees 6421 // with the second gather nodes if they have less scalar operands rather than 6422 // the initial tree element (may be profitable to shuffle the second gather) 6423 // or they are extractelements, which form shuffle. 6424 SmallVector<int> Mask; 6425 if (VectorizableTree[0]->State == TreeEntry::Vectorize && 6426 AreVectorizableGathers(VectorizableTree[1].get(), 6427 VectorizableTree[0]->Scalars.size())) 6428 return true; 6429 6430 // Gathering cost would be too much for tiny trees. 6431 if (VectorizableTree[0]->State == TreeEntry::NeedToGather || 6432 (VectorizableTree[1]->State == TreeEntry::NeedToGather && 6433 VectorizableTree[0]->State != TreeEntry::ScatterVectorize)) 6434 return false; 6435 6436 return true; 6437 } 6438 6439 static bool isLoadCombineCandidateImpl(Value *Root, unsigned NumElts, 6440 TargetTransformInfo *TTI, 6441 bool MustMatchOrInst) { 6442 // Look past the root to find a source value. Arbitrarily follow the 6443 // path through operand 0 of any 'or'. Also, peek through optional 6444 // shift-left-by-multiple-of-8-bits. 6445 Value *ZextLoad = Root; 6446 const APInt *ShAmtC; 6447 bool FoundOr = false; 6448 while (!isa<ConstantExpr>(ZextLoad) && 6449 (match(ZextLoad, m_Or(m_Value(), m_Value())) || 6450 (match(ZextLoad, m_Shl(m_Value(), m_APInt(ShAmtC))) && 6451 ShAmtC->urem(8) == 0))) { 6452 auto *BinOp = cast<BinaryOperator>(ZextLoad); 6453 ZextLoad = BinOp->getOperand(0); 6454 if (BinOp->getOpcode() == Instruction::Or) 6455 FoundOr = true; 6456 } 6457 // Check if the input is an extended load of the required or/shift expression. 6458 Value *Load; 6459 if ((MustMatchOrInst && !FoundOr) || ZextLoad == Root || 6460 !match(ZextLoad, m_ZExt(m_Value(Load))) || !isa<LoadInst>(Load)) 6461 return false; 6462 6463 // Require that the total load bit width is a legal integer type. 6464 // For example, <8 x i8> --> i64 is a legal integer on a 64-bit target. 6465 // But <16 x i8> --> i128 is not, so the backend probably can't reduce it. 6466 Type *SrcTy = Load->getType(); 6467 unsigned LoadBitWidth = SrcTy->getIntegerBitWidth() * NumElts; 6468 if (!TTI->isTypeLegal(IntegerType::get(Root->getContext(), LoadBitWidth))) 6469 return false; 6470 6471 // Everything matched - assume that we can fold the whole sequence using 6472 // load combining. 6473 LLVM_DEBUG(dbgs() << "SLP: Assume load combining for tree starting at " 6474 << *(cast<Instruction>(Root)) << "\n"); 6475 6476 return true; 6477 } 6478 6479 bool BoUpSLP::isLoadCombineReductionCandidate(RecurKind RdxKind) const { 6480 if (RdxKind != RecurKind::Or) 6481 return false; 6482 6483 unsigned NumElts = VectorizableTree[0]->Scalars.size(); 6484 Value *FirstReduced = VectorizableTree[0]->Scalars[0]; 6485 return isLoadCombineCandidateImpl(FirstReduced, NumElts, TTI, 6486 /* MatchOr */ false); 6487 } 6488 6489 bool BoUpSLP::isLoadCombineCandidate() const { 6490 // Peek through a final sequence of stores and check if all operations are 6491 // likely to be load-combined. 6492 unsigned NumElts = VectorizableTree[0]->Scalars.size(); 6493 for (Value *Scalar : VectorizableTree[0]->Scalars) { 6494 Value *X; 6495 if (!match(Scalar, m_Store(m_Value(X), m_Value())) || 6496 !isLoadCombineCandidateImpl(X, NumElts, TTI, /* MatchOr */ true)) 6497 return false; 6498 } 6499 return true; 6500 } 6501 6502 bool BoUpSLP::isTreeTinyAndNotFullyVectorizable(bool ForReduction) const { 6503 // No need to vectorize inserts of gathered values. 6504 if (VectorizableTree.size() == 2 && 6505 isa<InsertElementInst>(VectorizableTree[0]->Scalars[0]) && 6506 VectorizableTree[1]->State == TreeEntry::NeedToGather) 6507 return true; 6508 6509 // We can vectorize the tree if its size is greater than or equal to the 6510 // minimum size specified by the MinTreeSize command line option. 6511 if (VectorizableTree.size() >= MinTreeSize) 6512 return false; 6513 6514 // If we have a tiny tree (a tree whose size is less than MinTreeSize), we 6515 // can vectorize it if we can prove it fully vectorizable. 6516 if (isFullyVectorizableTinyTree(ForReduction)) 6517 return false; 6518 6519 assert(VectorizableTree.empty() 6520 ? ExternalUses.empty() 6521 : true && "We shouldn't have any external users"); 6522 6523 // Otherwise, we can't vectorize the tree. It is both tiny and not fully 6524 // vectorizable. 6525 return true; 6526 } 6527 6528 InstructionCost BoUpSLP::getSpillCost() const { 6529 // Walk from the bottom of the tree to the top, tracking which values are 6530 // live. When we see a call instruction that is not part of our tree, 6531 // query TTI to see if there is a cost to keeping values live over it 6532 // (for example, if spills and fills are required). 6533 unsigned BundleWidth = VectorizableTree.front()->Scalars.size(); 6534 InstructionCost Cost = 0; 6535 6536 SmallPtrSet<Instruction*, 4> LiveValues; 6537 Instruction *PrevInst = nullptr; 6538 6539 // The entries in VectorizableTree are not necessarily ordered by their 6540 // position in basic blocks. Collect them and order them by dominance so later 6541 // instructions are guaranteed to be visited first. For instructions in 6542 // different basic blocks, we only scan to the beginning of the block, so 6543 // their order does not matter, as long as all instructions in a basic block 6544 // are grouped together. Using dominance ensures a deterministic order. 6545 SmallVector<Instruction *, 16> OrderedScalars; 6546 for (const auto &TEPtr : VectorizableTree) { 6547 Instruction *Inst = dyn_cast<Instruction>(TEPtr->Scalars[0]); 6548 if (!Inst) 6549 continue; 6550 OrderedScalars.push_back(Inst); 6551 } 6552 llvm::sort(OrderedScalars, [&](Instruction *A, Instruction *B) { 6553 auto *NodeA = DT->getNode(A->getParent()); 6554 auto *NodeB = DT->getNode(B->getParent()); 6555 assert(NodeA && "Should only process reachable instructions"); 6556 assert(NodeB && "Should only process reachable instructions"); 6557 assert((NodeA == NodeB) == (NodeA->getDFSNumIn() == NodeB->getDFSNumIn()) && 6558 "Different nodes should have different DFS numbers"); 6559 if (NodeA != NodeB) 6560 return NodeA->getDFSNumIn() < NodeB->getDFSNumIn(); 6561 return B->comesBefore(A); 6562 }); 6563 6564 for (Instruction *Inst : OrderedScalars) { 6565 if (!PrevInst) { 6566 PrevInst = Inst; 6567 continue; 6568 } 6569 6570 // Update LiveValues. 6571 LiveValues.erase(PrevInst); 6572 for (auto &J : PrevInst->operands()) { 6573 if (isa<Instruction>(&*J) && getTreeEntry(&*J)) 6574 LiveValues.insert(cast<Instruction>(&*J)); 6575 } 6576 6577 LLVM_DEBUG({ 6578 dbgs() << "SLP: #LV: " << LiveValues.size(); 6579 for (auto *X : LiveValues) 6580 dbgs() << " " << X->getName(); 6581 dbgs() << ", Looking at "; 6582 Inst->dump(); 6583 }); 6584 6585 // Now find the sequence of instructions between PrevInst and Inst. 6586 unsigned NumCalls = 0; 6587 BasicBlock::reverse_iterator InstIt = ++Inst->getIterator().getReverse(), 6588 PrevInstIt = 6589 PrevInst->getIterator().getReverse(); 6590 while (InstIt != PrevInstIt) { 6591 if (PrevInstIt == PrevInst->getParent()->rend()) { 6592 PrevInstIt = Inst->getParent()->rbegin(); 6593 continue; 6594 } 6595 6596 // Debug information does not impact spill cost. 6597 if ((isa<CallInst>(&*PrevInstIt) && 6598 !isa<DbgInfoIntrinsic>(&*PrevInstIt)) && 6599 &*PrevInstIt != PrevInst) 6600 NumCalls++; 6601 6602 ++PrevInstIt; 6603 } 6604 6605 if (NumCalls) { 6606 SmallVector<Type*, 4> V; 6607 for (auto *II : LiveValues) { 6608 auto *ScalarTy = II->getType(); 6609 if (auto *VectorTy = dyn_cast<FixedVectorType>(ScalarTy)) 6610 ScalarTy = VectorTy->getElementType(); 6611 V.push_back(FixedVectorType::get(ScalarTy, BundleWidth)); 6612 } 6613 Cost += NumCalls * TTI->getCostOfKeepingLiveOverCall(V); 6614 } 6615 6616 PrevInst = Inst; 6617 } 6618 6619 return Cost; 6620 } 6621 6622 /// Check if two insertelement instructions are from the same buildvector. 6623 static bool areTwoInsertFromSameBuildVector(InsertElementInst *VU, 6624 InsertElementInst *V) { 6625 // Instructions must be from the same basic blocks. 6626 if (VU->getParent() != V->getParent()) 6627 return false; 6628 // Checks if 2 insertelements are from the same buildvector. 6629 if (VU->getType() != V->getType()) 6630 return false; 6631 // Multiple used inserts are separate nodes. 6632 if (!VU->hasOneUse() && !V->hasOneUse()) 6633 return false; 6634 auto *IE1 = VU; 6635 auto *IE2 = V; 6636 unsigned Idx1 = *getInsertIndex(IE1); 6637 unsigned Idx2 = *getInsertIndex(IE2); 6638 // Go through the vector operand of insertelement instructions trying to find 6639 // either VU as the original vector for IE2 or V as the original vector for 6640 // IE1. 6641 do { 6642 if (IE2 == VU) 6643 return VU->hasOneUse(); 6644 if (IE1 == V) 6645 return V->hasOneUse(); 6646 if (IE1) { 6647 if ((IE1 != VU && !IE1->hasOneUse()) || 6648 getInsertIndex(IE1).getValueOr(Idx2) == Idx2) 6649 IE1 = nullptr; 6650 else 6651 IE1 = dyn_cast<InsertElementInst>(IE1->getOperand(0)); 6652 } 6653 if (IE2) { 6654 if ((IE2 != V && !IE2->hasOneUse()) || 6655 getInsertIndex(IE2).getValueOr(Idx1) == Idx1) 6656 IE2 = nullptr; 6657 else 6658 IE2 = dyn_cast<InsertElementInst>(IE2->getOperand(0)); 6659 } 6660 } while (IE1 || IE2); 6661 return false; 6662 } 6663 6664 /// Checks if the \p IE1 instructions is followed by \p IE2 instruction in the 6665 /// buildvector sequence. 6666 static bool isFirstInsertElement(const InsertElementInst *IE1, 6667 const InsertElementInst *IE2) { 6668 if (IE1 == IE2) 6669 return false; 6670 const auto *I1 = IE1; 6671 const auto *I2 = IE2; 6672 const InsertElementInst *PrevI1; 6673 const InsertElementInst *PrevI2; 6674 unsigned Idx1 = *getInsertIndex(IE1); 6675 unsigned Idx2 = *getInsertIndex(IE2); 6676 do { 6677 if (I2 == IE1) 6678 return true; 6679 if (I1 == IE2) 6680 return false; 6681 PrevI1 = I1; 6682 PrevI2 = I2; 6683 if (I1 && (I1 == IE1 || I1->hasOneUse()) && 6684 getInsertIndex(I1).getValueOr(Idx2) != Idx2) 6685 I1 = dyn_cast<InsertElementInst>(I1->getOperand(0)); 6686 if (I2 && ((I2 == IE2 || I2->hasOneUse())) && 6687 getInsertIndex(I2).getValueOr(Idx1) != Idx1) 6688 I2 = dyn_cast<InsertElementInst>(I2->getOperand(0)); 6689 } while ((I1 && PrevI1 != I1) || (I2 && PrevI2 != I2)); 6690 llvm_unreachable("Two different buildvectors not expected."); 6691 } 6692 6693 namespace { 6694 /// Returns incoming Value *, if the requested type is Value * too, or a default 6695 /// value, otherwise. 6696 struct ValueSelect { 6697 template <typename U> 6698 static typename std::enable_if<std::is_same<Value *, U>::value, Value *>::type 6699 get(Value *V) { 6700 return V; 6701 } 6702 template <typename U> 6703 static typename std::enable_if<!std::is_same<Value *, U>::value, U>::type 6704 get(Value *) { 6705 return U(); 6706 } 6707 }; 6708 } // namespace 6709 6710 /// Does the analysis of the provided shuffle masks and performs the requested 6711 /// actions on the vectors with the given shuffle masks. It tries to do it in 6712 /// several steps. 6713 /// 1. If the Base vector is not undef vector, resizing the very first mask to 6714 /// have common VF and perform action for 2 input vectors (including non-undef 6715 /// Base). Other shuffle masks are combined with the resulting after the 1 stage 6716 /// and processed as a shuffle of 2 elements. 6717 /// 2. If the Base is undef vector and have only 1 shuffle mask, perform the 6718 /// action only for 1 vector with the given mask, if it is not the identity 6719 /// mask. 6720 /// 3. If > 2 masks are used, perform the remaining shuffle actions for 2 6721 /// vectors, combing the masks properly between the steps. 6722 template <typename T> 6723 static T *performExtractsShuffleAction( 6724 MutableArrayRef<std::pair<T *, SmallVector<int>>> ShuffleMask, Value *Base, 6725 function_ref<unsigned(T *)> GetVF, 6726 function_ref<std::pair<T *, bool>(T *, ArrayRef<int>)> ResizeAction, 6727 function_ref<T *(ArrayRef<int>, ArrayRef<T *>)> Action) { 6728 assert(!ShuffleMask.empty() && "Empty list of shuffles for inserts."); 6729 SmallVector<int> Mask(ShuffleMask.begin()->second); 6730 auto VMIt = std::next(ShuffleMask.begin()); 6731 T *Prev = nullptr; 6732 bool IsBaseNotUndef = !isUndefVector(Base); 6733 if (IsBaseNotUndef) { 6734 // Base is not undef, need to combine it with the next subvectors. 6735 std::pair<T *, bool> Res = ResizeAction(ShuffleMask.begin()->first, Mask); 6736 for (unsigned Idx = 0, VF = Mask.size(); Idx < VF; ++Idx) { 6737 if (Mask[Idx] == UndefMaskElem) 6738 Mask[Idx] = Idx; 6739 else 6740 Mask[Idx] = (Res.second ? Idx : Mask[Idx]) + VF; 6741 } 6742 auto *V = ValueSelect::get<T *>(Base); 6743 (void)V; 6744 assert((!V || GetVF(V) == Mask.size()) && 6745 "Expected base vector of VF number of elements."); 6746 Prev = Action(Mask, {nullptr, Res.first}); 6747 } else if (ShuffleMask.size() == 1) { 6748 // Base is undef and only 1 vector is shuffled - perform the action only for 6749 // single vector, if the mask is not the identity mask. 6750 std::pair<T *, bool> Res = ResizeAction(ShuffleMask.begin()->first, Mask); 6751 if (Res.second) 6752 // Identity mask is found. 6753 Prev = Res.first; 6754 else 6755 Prev = Action(Mask, {ShuffleMask.begin()->first}); 6756 } else { 6757 // Base is undef and at least 2 input vectors shuffled - perform 2 vectors 6758 // shuffles step by step, combining shuffle between the steps. 6759 unsigned Vec1VF = GetVF(ShuffleMask.begin()->first); 6760 unsigned Vec2VF = GetVF(VMIt->first); 6761 if (Vec1VF == Vec2VF) { 6762 // No need to resize the input vectors since they are of the same size, we 6763 // can shuffle them directly. 6764 ArrayRef<int> SecMask = VMIt->second; 6765 for (unsigned I = 0, VF = Mask.size(); I < VF; ++I) { 6766 if (SecMask[I] != UndefMaskElem) { 6767 assert(Mask[I] == UndefMaskElem && "Multiple uses of scalars."); 6768 Mask[I] = SecMask[I] + Vec1VF; 6769 } 6770 } 6771 Prev = Action(Mask, {ShuffleMask.begin()->first, VMIt->first}); 6772 } else { 6773 // Vectors of different sizes - resize and reshuffle. 6774 std::pair<T *, bool> Res1 = 6775 ResizeAction(ShuffleMask.begin()->first, Mask); 6776 std::pair<T *, bool> Res2 = ResizeAction(VMIt->first, VMIt->second); 6777 ArrayRef<int> SecMask = VMIt->second; 6778 for (unsigned I = 0, VF = Mask.size(); I < VF; ++I) { 6779 if (Mask[I] != UndefMaskElem) { 6780 assert(SecMask[I] == UndefMaskElem && "Multiple uses of scalars."); 6781 if (Res1.second) 6782 Mask[I] = I; 6783 } else if (SecMask[I] != UndefMaskElem) { 6784 assert(Mask[I] == UndefMaskElem && "Multiple uses of scalars."); 6785 Mask[I] = (Res2.second ? I : SecMask[I]) + VF; 6786 } 6787 } 6788 Prev = Action(Mask, {Res1.first, Res2.first}); 6789 } 6790 VMIt = std::next(VMIt); 6791 } 6792 // Perform requested actions for the remaining masks/vectors. 6793 for (auto E = ShuffleMask.end(); VMIt != E; ++VMIt) { 6794 // Shuffle other input vectors, if any. 6795 std::pair<T *, bool> Res = ResizeAction(VMIt->first, VMIt->second); 6796 ArrayRef<int> SecMask = VMIt->second; 6797 for (unsigned I = 0, VF = Mask.size(); I < VF; ++I) { 6798 if (SecMask[I] != UndefMaskElem) { 6799 assert((Mask[I] == UndefMaskElem || IsBaseNotUndef) && 6800 "Multiple uses of scalars."); 6801 Mask[I] = (Res.second ? I : SecMask[I]) + VF; 6802 } else if (Mask[I] != UndefMaskElem) { 6803 Mask[I] = I; 6804 } 6805 } 6806 Prev = Action(Mask, {Prev, Res.first}); 6807 } 6808 return Prev; 6809 } 6810 6811 InstructionCost BoUpSLP::getTreeCost(ArrayRef<Value *> VectorizedVals) { 6812 InstructionCost Cost = 0; 6813 LLVM_DEBUG(dbgs() << "SLP: Calculating cost for tree of size " 6814 << VectorizableTree.size() << ".\n"); 6815 6816 unsigned BundleWidth = VectorizableTree[0]->Scalars.size(); 6817 6818 for (unsigned I = 0, E = VectorizableTree.size(); I < E; ++I) { 6819 TreeEntry &TE = *VectorizableTree[I]; 6820 6821 InstructionCost C = getEntryCost(&TE, VectorizedVals); 6822 Cost += C; 6823 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 6824 << " for bundle that starts with " << *TE.Scalars[0] 6825 << ".\n" 6826 << "SLP: Current total cost = " << Cost << "\n"); 6827 } 6828 6829 SmallPtrSet<Value *, 16> ExtractCostCalculated; 6830 InstructionCost ExtractCost = 0; 6831 SmallVector<MapVector<const TreeEntry *, SmallVector<int>>> ShuffleMasks; 6832 SmallVector<std::pair<Value *, const TreeEntry *>> FirstUsers; 6833 SmallVector<APInt> DemandedElts; 6834 for (ExternalUser &EU : ExternalUses) { 6835 // We only add extract cost once for the same scalar. 6836 if (!isa_and_nonnull<InsertElementInst>(EU.User) && 6837 !ExtractCostCalculated.insert(EU.Scalar).second) 6838 continue; 6839 6840 // Uses by ephemeral values are free (because the ephemeral value will be 6841 // removed prior to code generation, and so the extraction will be 6842 // removed as well). 6843 if (EphValues.count(EU.User)) 6844 continue; 6845 6846 // No extract cost for vector "scalar" 6847 if (isa<FixedVectorType>(EU.Scalar->getType())) 6848 continue; 6849 6850 // Already counted the cost for external uses when tried to adjust the cost 6851 // for extractelements, no need to add it again. 6852 if (isa<ExtractElementInst>(EU.Scalar)) 6853 continue; 6854 6855 // If found user is an insertelement, do not calculate extract cost but try 6856 // to detect it as a final shuffled/identity match. 6857 if (auto *VU = dyn_cast_or_null<InsertElementInst>(EU.User)) { 6858 if (auto *FTy = dyn_cast<FixedVectorType>(VU->getType())) { 6859 Optional<unsigned> InsertIdx = getInsertIndex(VU); 6860 if (InsertIdx) { 6861 const TreeEntry *ScalarTE = getTreeEntry(EU.Scalar); 6862 auto *It = 6863 find_if(FirstUsers, 6864 [VU](const std::pair<Value *, const TreeEntry *> &Pair) { 6865 return areTwoInsertFromSameBuildVector( 6866 VU, cast<InsertElementInst>(Pair.first)); 6867 }); 6868 int VecId = -1; 6869 if (It == FirstUsers.end()) { 6870 (void)ShuffleMasks.emplace_back(); 6871 SmallVectorImpl<int> &Mask = ShuffleMasks.back()[ScalarTE]; 6872 if (Mask.empty()) 6873 Mask.assign(FTy->getNumElements(), UndefMaskElem); 6874 // Find the insertvector, vectorized in tree, if any. 6875 Value *Base = VU; 6876 while (auto *IEBase = dyn_cast<InsertElementInst>(Base)) { 6877 if (IEBase != EU.User && 6878 (!IEBase->hasOneUse() || 6879 getInsertIndex(IEBase).getValueOr(*InsertIdx) == *InsertIdx)) 6880 break; 6881 // Build the mask for the vectorized insertelement instructions. 6882 if (const TreeEntry *E = getTreeEntry(IEBase)) { 6883 VU = IEBase; 6884 do { 6885 IEBase = cast<InsertElementInst>(Base); 6886 int Idx = *getInsertIndex(IEBase); 6887 assert(Mask[Idx] == UndefMaskElem && 6888 "InsertElementInstruction used already."); 6889 Mask[Idx] = Idx; 6890 Base = IEBase->getOperand(0); 6891 } while (E == getTreeEntry(Base)); 6892 break; 6893 } 6894 Base = cast<InsertElementInst>(Base)->getOperand(0); 6895 } 6896 FirstUsers.emplace_back(VU, ScalarTE); 6897 DemandedElts.push_back(APInt::getZero(FTy->getNumElements())); 6898 VecId = FirstUsers.size() - 1; 6899 } else { 6900 if (isFirstInsertElement(VU, cast<InsertElementInst>(It->first))) 6901 It->first = VU; 6902 VecId = std::distance(FirstUsers.begin(), It); 6903 } 6904 int InIdx = *InsertIdx; 6905 SmallVectorImpl<int> &Mask = ShuffleMasks[VecId][ScalarTE]; 6906 if (Mask.empty()) 6907 Mask.assign(FTy->getNumElements(), UndefMaskElem); 6908 Mask[InIdx] = EU.Lane; 6909 DemandedElts[VecId].setBit(InIdx); 6910 continue; 6911 } 6912 } 6913 } 6914 6915 // If we plan to rewrite the tree in a smaller type, we will need to sign 6916 // extend the extracted value back to the original type. Here, we account 6917 // for the extract and the added cost of the sign extend if needed. 6918 auto *VecTy = FixedVectorType::get(EU.Scalar->getType(), BundleWidth); 6919 auto *ScalarRoot = VectorizableTree[0]->Scalars[0]; 6920 if (MinBWs.count(ScalarRoot)) { 6921 auto *MinTy = IntegerType::get(F->getContext(), MinBWs[ScalarRoot].first); 6922 auto Extend = 6923 MinBWs[ScalarRoot].second ? Instruction::SExt : Instruction::ZExt; 6924 VecTy = FixedVectorType::get(MinTy, BundleWidth); 6925 ExtractCost += TTI->getExtractWithExtendCost(Extend, EU.Scalar->getType(), 6926 VecTy, EU.Lane); 6927 } else { 6928 ExtractCost += 6929 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, EU.Lane); 6930 } 6931 } 6932 6933 InstructionCost SpillCost = getSpillCost(); 6934 Cost += SpillCost + ExtractCost; 6935 auto &&ResizeToVF = [this, &Cost](const TreeEntry *TE, ArrayRef<int> Mask) { 6936 InstructionCost C = 0; 6937 unsigned VF = Mask.size(); 6938 unsigned VecVF = TE->getVectorFactor(); 6939 if (VF != VecVF && 6940 (any_of(Mask, [VF](int Idx) { return Idx >= static_cast<int>(VF); }) || 6941 (all_of(Mask, 6942 [VF](int Idx) { return Idx < 2 * static_cast<int>(VF); }) && 6943 !ShuffleVectorInst::isIdentityMask(Mask)))) { 6944 SmallVector<int> OrigMask(VecVF, UndefMaskElem); 6945 std::copy(Mask.begin(), std::next(Mask.begin(), std::min(VF, VecVF)), 6946 OrigMask.begin()); 6947 C = TTI->getShuffleCost( 6948 TTI::SK_PermuteSingleSrc, 6949 FixedVectorType::get(TE->getMainOp()->getType(), VecVF), OrigMask); 6950 LLVM_DEBUG( 6951 dbgs() << "SLP: Adding cost " << C 6952 << " for final shuffle of insertelement external users.\n"; 6953 TE->dump(); dbgs() << "SLP: Current total cost = " << Cost << "\n"); 6954 Cost += C; 6955 return std::make_pair(TE, true); 6956 } 6957 return std::make_pair(TE, false); 6958 }; 6959 // Calculate the cost of the reshuffled vectors, if any. 6960 for (int I = 0, E = FirstUsers.size(); I < E; ++I) { 6961 Value *Base = cast<Instruction>(FirstUsers[I].first)->getOperand(0); 6962 unsigned VF = ShuffleMasks[I].begin()->second.size(); 6963 auto *FTy = FixedVectorType::get( 6964 cast<VectorType>(FirstUsers[I].first->getType())->getElementType(), VF); 6965 auto Vector = ShuffleMasks[I].takeVector(); 6966 auto &&EstimateShufflesCost = [this, FTy, 6967 &Cost](ArrayRef<int> Mask, 6968 ArrayRef<const TreeEntry *> TEs) { 6969 assert((TEs.size() == 1 || TEs.size() == 2) && 6970 "Expected exactly 1 or 2 tree entries."); 6971 if (TEs.size() == 1) { 6972 int Limit = 2 * Mask.size(); 6973 if (!all_of(Mask, [Limit](int Idx) { return Idx < Limit; }) || 6974 !ShuffleVectorInst::isIdentityMask(Mask)) { 6975 InstructionCost C = 6976 TTI->getShuffleCost(TTI::SK_PermuteSingleSrc, FTy, Mask); 6977 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 6978 << " for final shuffle of insertelement " 6979 "external users.\n"; 6980 TEs.front()->dump(); 6981 dbgs() << "SLP: Current total cost = " << Cost << "\n"); 6982 Cost += C; 6983 } 6984 } else { 6985 InstructionCost C = 6986 TTI->getShuffleCost(TTI::SK_PermuteTwoSrc, FTy, Mask); 6987 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 6988 << " for final shuffle of vector node and external " 6989 "insertelement users.\n"; 6990 if (TEs.front()) { TEs.front()->dump(); } TEs.back()->dump(); 6991 dbgs() << "SLP: Current total cost = " << Cost << "\n"); 6992 Cost += C; 6993 } 6994 return TEs.back(); 6995 }; 6996 (void)performExtractsShuffleAction<const TreeEntry>( 6997 makeMutableArrayRef(Vector.data(), Vector.size()), Base, 6998 [](const TreeEntry *E) { return E->getVectorFactor(); }, ResizeToVF, 6999 EstimateShufflesCost); 7000 InstructionCost InsertCost = TTI->getScalarizationOverhead( 7001 cast<FixedVectorType>(FirstUsers[I].first->getType()), DemandedElts[I], 7002 /*Insert*/ true, /*Extract*/ false); 7003 Cost -= InsertCost; 7004 } 7005 7006 #ifndef NDEBUG 7007 SmallString<256> Str; 7008 { 7009 raw_svector_ostream OS(Str); 7010 OS << "SLP: Spill Cost = " << SpillCost << ".\n" 7011 << "SLP: Extract Cost = " << ExtractCost << ".\n" 7012 << "SLP: Total Cost = " << Cost << ".\n"; 7013 } 7014 LLVM_DEBUG(dbgs() << Str); 7015 if (ViewSLPTree) 7016 ViewGraph(this, "SLP" + F->getName(), false, Str); 7017 #endif 7018 7019 return Cost; 7020 } 7021 7022 Optional<TargetTransformInfo::ShuffleKind> 7023 BoUpSLP::isGatherShuffledEntry(const TreeEntry *TE, SmallVectorImpl<int> &Mask, 7024 SmallVectorImpl<const TreeEntry *> &Entries) { 7025 // TODO: currently checking only for Scalars in the tree entry, need to count 7026 // reused elements too for better cost estimation. 7027 Mask.assign(TE->Scalars.size(), UndefMaskElem); 7028 Entries.clear(); 7029 // Build a lists of values to tree entries. 7030 DenseMap<Value *, SmallPtrSet<const TreeEntry *, 4>> ValueToTEs; 7031 for (const std::unique_ptr<TreeEntry> &EntryPtr : VectorizableTree) { 7032 if (EntryPtr.get() == TE) 7033 break; 7034 if (EntryPtr->State != TreeEntry::NeedToGather) 7035 continue; 7036 for (Value *V : EntryPtr->Scalars) 7037 ValueToTEs.try_emplace(V).first->getSecond().insert(EntryPtr.get()); 7038 } 7039 // Find all tree entries used by the gathered values. If no common entries 7040 // found - not a shuffle. 7041 // Here we build a set of tree nodes for each gathered value and trying to 7042 // find the intersection between these sets. If we have at least one common 7043 // tree node for each gathered value - we have just a permutation of the 7044 // single vector. If we have 2 different sets, we're in situation where we 7045 // have a permutation of 2 input vectors. 7046 SmallVector<SmallPtrSet<const TreeEntry *, 4>> UsedTEs; 7047 DenseMap<Value *, int> UsedValuesEntry; 7048 for (Value *V : TE->Scalars) { 7049 if (isa<UndefValue>(V)) 7050 continue; 7051 // Build a list of tree entries where V is used. 7052 SmallPtrSet<const TreeEntry *, 4> VToTEs; 7053 auto It = ValueToTEs.find(V); 7054 if (It != ValueToTEs.end()) 7055 VToTEs = It->second; 7056 if (const TreeEntry *VTE = getTreeEntry(V)) 7057 VToTEs.insert(VTE); 7058 if (VToTEs.empty()) 7059 return None; 7060 if (UsedTEs.empty()) { 7061 // The first iteration, just insert the list of nodes to vector. 7062 UsedTEs.push_back(VToTEs); 7063 } else { 7064 // Need to check if there are any previously used tree nodes which use V. 7065 // If there are no such nodes, consider that we have another one input 7066 // vector. 7067 SmallPtrSet<const TreeEntry *, 4> SavedVToTEs(VToTEs); 7068 unsigned Idx = 0; 7069 for (SmallPtrSet<const TreeEntry *, 4> &Set : UsedTEs) { 7070 // Do we have a non-empty intersection of previously listed tree entries 7071 // and tree entries using current V? 7072 set_intersect(VToTEs, Set); 7073 if (!VToTEs.empty()) { 7074 // Yes, write the new subset and continue analysis for the next 7075 // scalar. 7076 Set.swap(VToTEs); 7077 break; 7078 } 7079 VToTEs = SavedVToTEs; 7080 ++Idx; 7081 } 7082 // No non-empty intersection found - need to add a second set of possible 7083 // source vectors. 7084 if (Idx == UsedTEs.size()) { 7085 // If the number of input vectors is greater than 2 - not a permutation, 7086 // fallback to the regular gather. 7087 if (UsedTEs.size() == 2) 7088 return None; 7089 UsedTEs.push_back(SavedVToTEs); 7090 Idx = UsedTEs.size() - 1; 7091 } 7092 UsedValuesEntry.try_emplace(V, Idx); 7093 } 7094 } 7095 7096 if (UsedTEs.empty()) { 7097 assert(all_of(TE->Scalars, UndefValue::classof) && 7098 "Expected vector of undefs only."); 7099 return None; 7100 } 7101 7102 unsigned VF = 0; 7103 if (UsedTEs.size() == 1) { 7104 // Try to find the perfect match in another gather node at first. 7105 auto It = find_if(UsedTEs.front(), [TE](const TreeEntry *EntryPtr) { 7106 return EntryPtr->isSame(TE->Scalars); 7107 }); 7108 if (It != UsedTEs.front().end()) { 7109 Entries.push_back(*It); 7110 std::iota(Mask.begin(), Mask.end(), 0); 7111 return TargetTransformInfo::SK_PermuteSingleSrc; 7112 } 7113 // No perfect match, just shuffle, so choose the first tree node. 7114 Entries.push_back(*UsedTEs.front().begin()); 7115 } else { 7116 // Try to find nodes with the same vector factor. 7117 assert(UsedTEs.size() == 2 && "Expected at max 2 permuted entries."); 7118 DenseMap<int, const TreeEntry *> VFToTE; 7119 for (const TreeEntry *TE : UsedTEs.front()) 7120 VFToTE.try_emplace(TE->getVectorFactor(), TE); 7121 for (const TreeEntry *TE : UsedTEs.back()) { 7122 auto It = VFToTE.find(TE->getVectorFactor()); 7123 if (It != VFToTE.end()) { 7124 VF = It->first; 7125 Entries.push_back(It->second); 7126 Entries.push_back(TE); 7127 break; 7128 } 7129 } 7130 // No 2 source vectors with the same vector factor - give up and do regular 7131 // gather. 7132 if (Entries.empty()) 7133 return None; 7134 } 7135 7136 // Build a shuffle mask for better cost estimation and vector emission. 7137 for (int I = 0, E = TE->Scalars.size(); I < E; ++I) { 7138 Value *V = TE->Scalars[I]; 7139 if (isa<UndefValue>(V)) 7140 continue; 7141 unsigned Idx = UsedValuesEntry.lookup(V); 7142 const TreeEntry *VTE = Entries[Idx]; 7143 int FoundLane = VTE->findLaneForValue(V); 7144 Mask[I] = Idx * VF + FoundLane; 7145 // Extra check required by isSingleSourceMaskImpl function (called by 7146 // ShuffleVectorInst::isSingleSourceMask). 7147 if (Mask[I] >= 2 * E) 7148 return None; 7149 } 7150 switch (Entries.size()) { 7151 case 1: 7152 return TargetTransformInfo::SK_PermuteSingleSrc; 7153 case 2: 7154 return TargetTransformInfo::SK_PermuteTwoSrc; 7155 default: 7156 break; 7157 } 7158 return None; 7159 } 7160 7161 InstructionCost BoUpSLP::getGatherCost(FixedVectorType *Ty, 7162 const APInt &ShuffledIndices, 7163 bool NeedToShuffle) const { 7164 InstructionCost Cost = 7165 TTI->getScalarizationOverhead(Ty, ~ShuffledIndices, /*Insert*/ true, 7166 /*Extract*/ false); 7167 if (NeedToShuffle) 7168 Cost += TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, Ty); 7169 return Cost; 7170 } 7171 7172 InstructionCost BoUpSLP::getGatherCost(ArrayRef<Value *> VL) const { 7173 // Find the type of the operands in VL. 7174 Type *ScalarTy = VL[0]->getType(); 7175 if (StoreInst *SI = dyn_cast<StoreInst>(VL[0])) 7176 ScalarTy = SI->getValueOperand()->getType(); 7177 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 7178 bool DuplicateNonConst = false; 7179 // Find the cost of inserting/extracting values from the vector. 7180 // Check if the same elements are inserted several times and count them as 7181 // shuffle candidates. 7182 APInt ShuffledElements = APInt::getZero(VL.size()); 7183 DenseSet<Value *> UniqueElements; 7184 // Iterate in reverse order to consider insert elements with the high cost. 7185 for (unsigned I = VL.size(); I > 0; --I) { 7186 unsigned Idx = I - 1; 7187 // No need to shuffle duplicates for constants. 7188 if (isConstant(VL[Idx])) { 7189 ShuffledElements.setBit(Idx); 7190 continue; 7191 } 7192 if (!UniqueElements.insert(VL[Idx]).second) { 7193 DuplicateNonConst = true; 7194 ShuffledElements.setBit(Idx); 7195 } 7196 } 7197 return getGatherCost(VecTy, ShuffledElements, DuplicateNonConst); 7198 } 7199 7200 // Perform operand reordering on the instructions in VL and return the reordered 7201 // operands in Left and Right. 7202 void BoUpSLP::reorderInputsAccordingToOpcode(ArrayRef<Value *> VL, 7203 SmallVectorImpl<Value *> &Left, 7204 SmallVectorImpl<Value *> &Right, 7205 const DataLayout &DL, 7206 ScalarEvolution &SE, 7207 const BoUpSLP &R) { 7208 if (VL.empty()) 7209 return; 7210 VLOperands Ops(VL, DL, SE, R); 7211 // Reorder the operands in place. 7212 Ops.reorder(); 7213 Left = Ops.getVL(0); 7214 Right = Ops.getVL(1); 7215 } 7216 7217 void BoUpSLP::setInsertPointAfterBundle(const TreeEntry *E) { 7218 // Get the basic block this bundle is in. All instructions in the bundle 7219 // should be in this block. 7220 auto *Front = E->getMainOp(); 7221 auto *BB = Front->getParent(); 7222 assert(llvm::all_of(E->Scalars, [=](Value *V) -> bool { 7223 auto *I = cast<Instruction>(V); 7224 return !E->isOpcodeOrAlt(I) || I->getParent() == BB; 7225 })); 7226 7227 auto &&FindLastInst = [E, Front]() { 7228 Instruction *LastInst = Front; 7229 for (Value *V : E->Scalars) { 7230 auto *I = dyn_cast<Instruction>(V); 7231 if (!I) 7232 continue; 7233 if (LastInst->comesBefore(I)) 7234 LastInst = I; 7235 } 7236 return LastInst; 7237 }; 7238 7239 auto &&FindFirstInst = [E, Front]() { 7240 Instruction *FirstInst = Front; 7241 for (Value *V : E->Scalars) { 7242 auto *I = dyn_cast<Instruction>(V); 7243 if (!I) 7244 continue; 7245 if (I->comesBefore(FirstInst)) 7246 FirstInst = I; 7247 } 7248 return FirstInst; 7249 }; 7250 7251 // Set the insert point to the beginning of the basic block if the entry 7252 // should not be scheduled. 7253 if (E->State != TreeEntry::NeedToGather && 7254 doesNotNeedToSchedule(E->Scalars)) { 7255 Instruction *InsertInst; 7256 if (all_of(E->Scalars, isUsedOutsideBlock)) 7257 InsertInst = FindLastInst(); 7258 else 7259 InsertInst = FindFirstInst(); 7260 // If the instruction is PHI, set the insert point after all the PHIs. 7261 if (isa<PHINode>(InsertInst)) 7262 InsertInst = BB->getFirstNonPHI(); 7263 BasicBlock::iterator InsertPt = InsertInst->getIterator(); 7264 Builder.SetInsertPoint(BB, InsertPt); 7265 Builder.SetCurrentDebugLocation(Front->getDebugLoc()); 7266 return; 7267 } 7268 7269 // The last instruction in the bundle in program order. 7270 Instruction *LastInst = nullptr; 7271 7272 // Find the last instruction. The common case should be that BB has been 7273 // scheduled, and the last instruction is VL.back(). So we start with 7274 // VL.back() and iterate over schedule data until we reach the end of the 7275 // bundle. The end of the bundle is marked by null ScheduleData. 7276 if (BlocksSchedules.count(BB)) { 7277 Value *V = E->isOneOf(E->Scalars.back()); 7278 if (doesNotNeedToBeScheduled(V)) 7279 V = *find_if_not(E->Scalars, doesNotNeedToBeScheduled); 7280 auto *Bundle = BlocksSchedules[BB]->getScheduleData(V); 7281 if (Bundle && Bundle->isPartOfBundle()) 7282 for (; Bundle; Bundle = Bundle->NextInBundle) 7283 if (Bundle->OpValue == Bundle->Inst) 7284 LastInst = Bundle->Inst; 7285 } 7286 7287 // LastInst can still be null at this point if there's either not an entry 7288 // for BB in BlocksSchedules or there's no ScheduleData available for 7289 // VL.back(). This can be the case if buildTree_rec aborts for various 7290 // reasons (e.g., the maximum recursion depth is reached, the maximum region 7291 // size is reached, etc.). ScheduleData is initialized in the scheduling 7292 // "dry-run". 7293 // 7294 // If this happens, we can still find the last instruction by brute force. We 7295 // iterate forwards from Front (inclusive) until we either see all 7296 // instructions in the bundle or reach the end of the block. If Front is the 7297 // last instruction in program order, LastInst will be set to Front, and we 7298 // will visit all the remaining instructions in the block. 7299 // 7300 // One of the reasons we exit early from buildTree_rec is to place an upper 7301 // bound on compile-time. Thus, taking an additional compile-time hit here is 7302 // not ideal. However, this should be exceedingly rare since it requires that 7303 // we both exit early from buildTree_rec and that the bundle be out-of-order 7304 // (causing us to iterate all the way to the end of the block). 7305 if (!LastInst) { 7306 LastInst = FindLastInst(); 7307 // If the instruction is PHI, set the insert point after all the PHIs. 7308 if (isa<PHINode>(LastInst)) 7309 LastInst = BB->getFirstNonPHI()->getPrevNode(); 7310 } 7311 assert(LastInst && "Failed to find last instruction in bundle"); 7312 7313 // Set the insertion point after the last instruction in the bundle. Set the 7314 // debug location to Front. 7315 Builder.SetInsertPoint(BB, std::next(LastInst->getIterator())); 7316 Builder.SetCurrentDebugLocation(Front->getDebugLoc()); 7317 } 7318 7319 Value *BoUpSLP::gather(ArrayRef<Value *> VL) { 7320 // List of instructions/lanes from current block and/or the blocks which are 7321 // part of the current loop. These instructions will be inserted at the end to 7322 // make it possible to optimize loops and hoist invariant instructions out of 7323 // the loops body with better chances for success. 7324 SmallVector<std::pair<Value *, unsigned>, 4> PostponedInsts; 7325 SmallSet<int, 4> PostponedIndices; 7326 Loop *L = LI->getLoopFor(Builder.GetInsertBlock()); 7327 auto &&CheckPredecessor = [](BasicBlock *InstBB, BasicBlock *InsertBB) { 7328 SmallPtrSet<BasicBlock *, 4> Visited; 7329 while (InsertBB && InsertBB != InstBB && Visited.insert(InsertBB).second) 7330 InsertBB = InsertBB->getSinglePredecessor(); 7331 return InsertBB && InsertBB == InstBB; 7332 }; 7333 for (int I = 0, E = VL.size(); I < E; ++I) { 7334 if (auto *Inst = dyn_cast<Instruction>(VL[I])) 7335 if ((CheckPredecessor(Inst->getParent(), Builder.GetInsertBlock()) || 7336 getTreeEntry(Inst) || (L && (L->contains(Inst)))) && 7337 PostponedIndices.insert(I).second) 7338 PostponedInsts.emplace_back(Inst, I); 7339 } 7340 7341 auto &&CreateInsertElement = [this](Value *Vec, Value *V, unsigned Pos) { 7342 Vec = Builder.CreateInsertElement(Vec, V, Builder.getInt32(Pos)); 7343 auto *InsElt = dyn_cast<InsertElementInst>(Vec); 7344 if (!InsElt) 7345 return Vec; 7346 GatherShuffleSeq.insert(InsElt); 7347 CSEBlocks.insert(InsElt->getParent()); 7348 // Add to our 'need-to-extract' list. 7349 if (TreeEntry *Entry = getTreeEntry(V)) { 7350 // Find which lane we need to extract. 7351 unsigned FoundLane = Entry->findLaneForValue(V); 7352 ExternalUses.emplace_back(V, InsElt, FoundLane); 7353 } 7354 return Vec; 7355 }; 7356 Value *Val0 = 7357 isa<StoreInst>(VL[0]) ? cast<StoreInst>(VL[0])->getValueOperand() : VL[0]; 7358 FixedVectorType *VecTy = FixedVectorType::get(Val0->getType(), VL.size()); 7359 Value *Vec = PoisonValue::get(VecTy); 7360 SmallVector<int> NonConsts; 7361 // Insert constant values at first. 7362 for (int I = 0, E = VL.size(); I < E; ++I) { 7363 if (PostponedIndices.contains(I)) 7364 continue; 7365 if (!isConstant(VL[I])) { 7366 NonConsts.push_back(I); 7367 continue; 7368 } 7369 Vec = CreateInsertElement(Vec, VL[I], I); 7370 } 7371 // Insert non-constant values. 7372 for (int I : NonConsts) 7373 Vec = CreateInsertElement(Vec, VL[I], I); 7374 // Append instructions, which are/may be part of the loop, in the end to make 7375 // it possible to hoist non-loop-based instructions. 7376 for (const std::pair<Value *, unsigned> &Pair : PostponedInsts) 7377 Vec = CreateInsertElement(Vec, Pair.first, Pair.second); 7378 7379 return Vec; 7380 } 7381 7382 namespace { 7383 /// Merges shuffle masks and emits final shuffle instruction, if required. 7384 class ShuffleInstructionBuilder { 7385 IRBuilderBase &Builder; 7386 const unsigned VF = 0; 7387 bool IsFinalized = false; 7388 SmallVector<int, 4> Mask; 7389 /// Holds all of the instructions that we gathered. 7390 SetVector<Instruction *> &GatherShuffleSeq; 7391 /// A list of blocks that we are going to CSE. 7392 SetVector<BasicBlock *> &CSEBlocks; 7393 7394 public: 7395 ShuffleInstructionBuilder(IRBuilderBase &Builder, unsigned VF, 7396 SetVector<Instruction *> &GatherShuffleSeq, 7397 SetVector<BasicBlock *> &CSEBlocks) 7398 : Builder(Builder), VF(VF), GatherShuffleSeq(GatherShuffleSeq), 7399 CSEBlocks(CSEBlocks) {} 7400 7401 /// Adds a mask, inverting it before applying. 7402 void addInversedMask(ArrayRef<unsigned> SubMask) { 7403 if (SubMask.empty()) 7404 return; 7405 SmallVector<int, 4> NewMask; 7406 inversePermutation(SubMask, NewMask); 7407 addMask(NewMask); 7408 } 7409 7410 /// Functions adds masks, merging them into single one. 7411 void addMask(ArrayRef<unsigned> SubMask) { 7412 SmallVector<int, 4> NewMask(SubMask.begin(), SubMask.end()); 7413 addMask(NewMask); 7414 } 7415 7416 void addMask(ArrayRef<int> SubMask) { ::addMask(Mask, SubMask); } 7417 7418 Value *finalize(Value *V) { 7419 IsFinalized = true; 7420 unsigned ValueVF = cast<FixedVectorType>(V->getType())->getNumElements(); 7421 if (VF == ValueVF && Mask.empty()) 7422 return V; 7423 SmallVector<int, 4> NormalizedMask(VF, UndefMaskElem); 7424 std::iota(NormalizedMask.begin(), NormalizedMask.end(), 0); 7425 addMask(NormalizedMask); 7426 7427 if (VF == ValueVF && ShuffleVectorInst::isIdentityMask(Mask)) 7428 return V; 7429 Value *Vec = Builder.CreateShuffleVector(V, Mask, "shuffle"); 7430 if (auto *I = dyn_cast<Instruction>(Vec)) { 7431 GatherShuffleSeq.insert(I); 7432 CSEBlocks.insert(I->getParent()); 7433 } 7434 return Vec; 7435 } 7436 7437 ~ShuffleInstructionBuilder() { 7438 assert((IsFinalized || Mask.empty()) && 7439 "Shuffle construction must be finalized."); 7440 } 7441 }; 7442 } // namespace 7443 7444 Value *BoUpSLP::vectorizeTree(ArrayRef<Value *> VL) { 7445 const unsigned VF = VL.size(); 7446 InstructionsState S = getSameOpcode(VL); 7447 if (S.getOpcode()) { 7448 if (TreeEntry *E = getTreeEntry(S.OpValue)) 7449 if (E->isSame(VL)) { 7450 Value *V = vectorizeTree(E); 7451 if (VF != cast<FixedVectorType>(V->getType())->getNumElements()) { 7452 if (!E->ReuseShuffleIndices.empty()) { 7453 // Reshuffle to get only unique values. 7454 // If some of the scalars are duplicated in the vectorization tree 7455 // entry, we do not vectorize them but instead generate a mask for 7456 // the reuses. But if there are several users of the same entry, 7457 // they may have different vectorization factors. This is especially 7458 // important for PHI nodes. In this case, we need to adapt the 7459 // resulting instruction for the user vectorization factor and have 7460 // to reshuffle it again to take only unique elements of the vector. 7461 // Without this code the function incorrectly returns reduced vector 7462 // instruction with the same elements, not with the unique ones. 7463 7464 // block: 7465 // %phi = phi <2 x > { .., %entry} {%shuffle, %block} 7466 // %2 = shuffle <2 x > %phi, poison, <4 x > <1, 1, 0, 0> 7467 // ... (use %2) 7468 // %shuffle = shuffle <2 x> %2, poison, <2 x> {2, 0} 7469 // br %block 7470 SmallVector<int> UniqueIdxs(VF, UndefMaskElem); 7471 SmallSet<int, 4> UsedIdxs; 7472 int Pos = 0; 7473 int Sz = VL.size(); 7474 for (int Idx : E->ReuseShuffleIndices) { 7475 if (Idx != Sz && Idx != UndefMaskElem && 7476 UsedIdxs.insert(Idx).second) 7477 UniqueIdxs[Idx] = Pos; 7478 ++Pos; 7479 } 7480 assert(VF >= UsedIdxs.size() && "Expected vectorization factor " 7481 "less than original vector size."); 7482 UniqueIdxs.append(VF - UsedIdxs.size(), UndefMaskElem); 7483 V = Builder.CreateShuffleVector(V, UniqueIdxs, "shrink.shuffle"); 7484 } else { 7485 assert(VF < cast<FixedVectorType>(V->getType())->getNumElements() && 7486 "Expected vectorization factor less " 7487 "than original vector size."); 7488 SmallVector<int> UniformMask(VF, 0); 7489 std::iota(UniformMask.begin(), UniformMask.end(), 0); 7490 V = Builder.CreateShuffleVector(V, UniformMask, "shrink.shuffle"); 7491 } 7492 if (auto *I = dyn_cast<Instruction>(V)) { 7493 GatherShuffleSeq.insert(I); 7494 CSEBlocks.insert(I->getParent()); 7495 } 7496 } 7497 return V; 7498 } 7499 } 7500 7501 // Can't vectorize this, so simply build a new vector with each lane 7502 // corresponding to the requested value. 7503 return createBuildVector(VL); 7504 } 7505 Value *BoUpSLP::createBuildVector(ArrayRef<Value *> VL) { 7506 unsigned VF = VL.size(); 7507 // Exploit possible reuse of values across lanes. 7508 SmallVector<int> ReuseShuffleIndicies; 7509 SmallVector<Value *> UniqueValues; 7510 if (VL.size() > 2) { 7511 DenseMap<Value *, unsigned> UniquePositions; 7512 unsigned NumValues = 7513 std::distance(VL.begin(), find_if(reverse(VL), [](Value *V) { 7514 return !isa<UndefValue>(V); 7515 }).base()); 7516 VF = std::max<unsigned>(VF, PowerOf2Ceil(NumValues)); 7517 int UniqueVals = 0; 7518 for (Value *V : VL.drop_back(VL.size() - VF)) { 7519 if (isa<UndefValue>(V)) { 7520 ReuseShuffleIndicies.emplace_back(UndefMaskElem); 7521 continue; 7522 } 7523 if (isConstant(V)) { 7524 ReuseShuffleIndicies.emplace_back(UniqueValues.size()); 7525 UniqueValues.emplace_back(V); 7526 continue; 7527 } 7528 auto Res = UniquePositions.try_emplace(V, UniqueValues.size()); 7529 ReuseShuffleIndicies.emplace_back(Res.first->second); 7530 if (Res.second) { 7531 UniqueValues.emplace_back(V); 7532 ++UniqueVals; 7533 } 7534 } 7535 if (UniqueVals == 1 && UniqueValues.size() == 1) { 7536 // Emit pure splat vector. 7537 ReuseShuffleIndicies.append(VF - ReuseShuffleIndicies.size(), 7538 UndefMaskElem); 7539 } else if (UniqueValues.size() >= VF - 1 || UniqueValues.size() <= 1) { 7540 ReuseShuffleIndicies.clear(); 7541 UniqueValues.clear(); 7542 UniqueValues.append(VL.begin(), std::next(VL.begin(), NumValues)); 7543 } 7544 UniqueValues.append(VF - UniqueValues.size(), 7545 PoisonValue::get(VL[0]->getType())); 7546 VL = UniqueValues; 7547 } 7548 7549 ShuffleInstructionBuilder ShuffleBuilder(Builder, VF, GatherShuffleSeq, 7550 CSEBlocks); 7551 Value *Vec = gather(VL); 7552 if (!ReuseShuffleIndicies.empty()) { 7553 ShuffleBuilder.addMask(ReuseShuffleIndicies); 7554 Vec = ShuffleBuilder.finalize(Vec); 7555 } 7556 return Vec; 7557 } 7558 7559 Value *BoUpSLP::vectorizeTree(TreeEntry *E) { 7560 IRBuilder<>::InsertPointGuard Guard(Builder); 7561 7562 if (E->VectorizedValue) { 7563 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *E->Scalars[0] << ".\n"); 7564 return E->VectorizedValue; 7565 } 7566 7567 bool NeedToShuffleReuses = !E->ReuseShuffleIndices.empty(); 7568 unsigned VF = E->getVectorFactor(); 7569 ShuffleInstructionBuilder ShuffleBuilder(Builder, VF, GatherShuffleSeq, 7570 CSEBlocks); 7571 if (E->State == TreeEntry::NeedToGather) { 7572 if (E->getMainOp()) 7573 setInsertPointAfterBundle(E); 7574 Value *Vec; 7575 SmallVector<int> Mask; 7576 SmallVector<const TreeEntry *> Entries; 7577 Optional<TargetTransformInfo::ShuffleKind> Shuffle = 7578 isGatherShuffledEntry(E, Mask, Entries); 7579 if (Shuffle.hasValue()) { 7580 assert((Entries.size() == 1 || Entries.size() == 2) && 7581 "Expected shuffle of 1 or 2 entries."); 7582 Vec = Builder.CreateShuffleVector(Entries.front()->VectorizedValue, 7583 Entries.back()->VectorizedValue, Mask); 7584 if (auto *I = dyn_cast<Instruction>(Vec)) { 7585 GatherShuffleSeq.insert(I); 7586 CSEBlocks.insert(I->getParent()); 7587 } 7588 } else { 7589 Vec = gather(E->Scalars); 7590 } 7591 if (NeedToShuffleReuses) { 7592 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7593 Vec = ShuffleBuilder.finalize(Vec); 7594 } 7595 E->VectorizedValue = Vec; 7596 return Vec; 7597 } 7598 7599 assert((E->State == TreeEntry::Vectorize || 7600 E->State == TreeEntry::ScatterVectorize) && 7601 "Unhandled state"); 7602 unsigned ShuffleOrOp = 7603 E->isAltShuffle() ? (unsigned)Instruction::ShuffleVector : E->getOpcode(); 7604 Instruction *VL0 = E->getMainOp(); 7605 Type *ScalarTy = VL0->getType(); 7606 if (auto *Store = dyn_cast<StoreInst>(VL0)) 7607 ScalarTy = Store->getValueOperand()->getType(); 7608 else if (auto *IE = dyn_cast<InsertElementInst>(VL0)) 7609 ScalarTy = IE->getOperand(1)->getType(); 7610 auto *VecTy = FixedVectorType::get(ScalarTy, E->Scalars.size()); 7611 switch (ShuffleOrOp) { 7612 case Instruction::PHI: { 7613 assert( 7614 (E->ReorderIndices.empty() || E != VectorizableTree.front().get()) && 7615 "PHI reordering is free."); 7616 auto *PH = cast<PHINode>(VL0); 7617 Builder.SetInsertPoint(PH->getParent()->getFirstNonPHI()); 7618 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 7619 PHINode *NewPhi = Builder.CreatePHI(VecTy, PH->getNumIncomingValues()); 7620 Value *V = NewPhi; 7621 7622 // Adjust insertion point once all PHI's have been generated. 7623 Builder.SetInsertPoint(&*PH->getParent()->getFirstInsertionPt()); 7624 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 7625 7626 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7627 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7628 V = ShuffleBuilder.finalize(V); 7629 7630 E->VectorizedValue = V; 7631 7632 // PHINodes may have multiple entries from the same block. We want to 7633 // visit every block once. 7634 SmallPtrSet<BasicBlock*, 4> VisitedBBs; 7635 7636 for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) { 7637 ValueList Operands; 7638 BasicBlock *IBB = PH->getIncomingBlock(i); 7639 7640 if (!VisitedBBs.insert(IBB).second) { 7641 NewPhi->addIncoming(NewPhi->getIncomingValueForBlock(IBB), IBB); 7642 continue; 7643 } 7644 7645 Builder.SetInsertPoint(IBB->getTerminator()); 7646 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 7647 Value *Vec = vectorizeTree(E->getOperand(i)); 7648 NewPhi->addIncoming(Vec, IBB); 7649 } 7650 7651 assert(NewPhi->getNumIncomingValues() == PH->getNumIncomingValues() && 7652 "Invalid number of incoming values"); 7653 return V; 7654 } 7655 7656 case Instruction::ExtractElement: { 7657 Value *V = E->getSingleOperand(0); 7658 Builder.SetInsertPoint(VL0); 7659 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7660 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7661 V = ShuffleBuilder.finalize(V); 7662 E->VectorizedValue = V; 7663 return V; 7664 } 7665 case Instruction::ExtractValue: { 7666 auto *LI = cast<LoadInst>(E->getSingleOperand(0)); 7667 Builder.SetInsertPoint(LI); 7668 auto *PtrTy = PointerType::get(VecTy, LI->getPointerAddressSpace()); 7669 Value *Ptr = Builder.CreateBitCast(LI->getOperand(0), PtrTy); 7670 LoadInst *V = Builder.CreateAlignedLoad(VecTy, Ptr, LI->getAlign()); 7671 Value *NewV = propagateMetadata(V, E->Scalars); 7672 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7673 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7674 NewV = ShuffleBuilder.finalize(NewV); 7675 E->VectorizedValue = NewV; 7676 return NewV; 7677 } 7678 case Instruction::InsertElement: { 7679 assert(E->ReuseShuffleIndices.empty() && "All inserts should be unique"); 7680 Builder.SetInsertPoint(cast<Instruction>(E->Scalars.back())); 7681 Value *V = vectorizeTree(E->getOperand(1)); 7682 7683 // Create InsertVector shuffle if necessary 7684 auto *FirstInsert = cast<Instruction>(*find_if(E->Scalars, [E](Value *V) { 7685 return !is_contained(E->Scalars, cast<Instruction>(V)->getOperand(0)); 7686 })); 7687 const unsigned NumElts = 7688 cast<FixedVectorType>(FirstInsert->getType())->getNumElements(); 7689 const unsigned NumScalars = E->Scalars.size(); 7690 7691 unsigned Offset = *getInsertIndex(VL0); 7692 assert(Offset < NumElts && "Failed to find vector index offset"); 7693 7694 // Create shuffle to resize vector 7695 SmallVector<int> Mask; 7696 if (!E->ReorderIndices.empty()) { 7697 inversePermutation(E->ReorderIndices, Mask); 7698 Mask.append(NumElts - NumScalars, UndefMaskElem); 7699 } else { 7700 Mask.assign(NumElts, UndefMaskElem); 7701 std::iota(Mask.begin(), std::next(Mask.begin(), NumScalars), 0); 7702 } 7703 // Create InsertVector shuffle if necessary 7704 bool IsIdentity = true; 7705 SmallVector<int> PrevMask(NumElts, UndefMaskElem); 7706 Mask.swap(PrevMask); 7707 for (unsigned I = 0; I < NumScalars; ++I) { 7708 Value *Scalar = E->Scalars[PrevMask[I]]; 7709 unsigned InsertIdx = *getInsertIndex(Scalar); 7710 IsIdentity &= InsertIdx - Offset == I; 7711 Mask[InsertIdx - Offset] = I; 7712 } 7713 if (!IsIdentity || NumElts != NumScalars) { 7714 V = Builder.CreateShuffleVector(V, Mask); 7715 if (auto *I = dyn_cast<Instruction>(V)) { 7716 GatherShuffleSeq.insert(I); 7717 CSEBlocks.insert(I->getParent()); 7718 } 7719 } 7720 7721 if ((!IsIdentity || Offset != 0 || 7722 !isUndefVector(FirstInsert->getOperand(0))) && 7723 NumElts != NumScalars) { 7724 SmallVector<int> InsertMask(NumElts); 7725 std::iota(InsertMask.begin(), InsertMask.end(), 0); 7726 for (unsigned I = 0; I < NumElts; I++) { 7727 if (Mask[I] != UndefMaskElem) 7728 InsertMask[Offset + I] = NumElts + I; 7729 } 7730 7731 V = Builder.CreateShuffleVector( 7732 FirstInsert->getOperand(0), V, InsertMask, 7733 cast<Instruction>(E->Scalars.back())->getName()); 7734 if (auto *I = dyn_cast<Instruction>(V)) { 7735 GatherShuffleSeq.insert(I); 7736 CSEBlocks.insert(I->getParent()); 7737 } 7738 } 7739 7740 ++NumVectorInstructions; 7741 E->VectorizedValue = V; 7742 return V; 7743 } 7744 case Instruction::ZExt: 7745 case Instruction::SExt: 7746 case Instruction::FPToUI: 7747 case Instruction::FPToSI: 7748 case Instruction::FPExt: 7749 case Instruction::PtrToInt: 7750 case Instruction::IntToPtr: 7751 case Instruction::SIToFP: 7752 case Instruction::UIToFP: 7753 case Instruction::Trunc: 7754 case Instruction::FPTrunc: 7755 case Instruction::BitCast: { 7756 setInsertPointAfterBundle(E); 7757 7758 Value *InVec = vectorizeTree(E->getOperand(0)); 7759 7760 if (E->VectorizedValue) { 7761 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7762 return E->VectorizedValue; 7763 } 7764 7765 auto *CI = cast<CastInst>(VL0); 7766 Value *V = Builder.CreateCast(CI->getOpcode(), InVec, VecTy); 7767 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7768 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7769 V = ShuffleBuilder.finalize(V); 7770 7771 E->VectorizedValue = V; 7772 ++NumVectorInstructions; 7773 return V; 7774 } 7775 case Instruction::FCmp: 7776 case Instruction::ICmp: { 7777 setInsertPointAfterBundle(E); 7778 7779 Value *L = vectorizeTree(E->getOperand(0)); 7780 Value *R = vectorizeTree(E->getOperand(1)); 7781 7782 if (E->VectorizedValue) { 7783 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7784 return E->VectorizedValue; 7785 } 7786 7787 CmpInst::Predicate P0 = cast<CmpInst>(VL0)->getPredicate(); 7788 Value *V = Builder.CreateCmp(P0, L, R); 7789 propagateIRFlags(V, E->Scalars, VL0); 7790 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7791 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7792 V = ShuffleBuilder.finalize(V); 7793 7794 E->VectorizedValue = V; 7795 ++NumVectorInstructions; 7796 return V; 7797 } 7798 case Instruction::Select: { 7799 setInsertPointAfterBundle(E); 7800 7801 Value *Cond = vectorizeTree(E->getOperand(0)); 7802 Value *True = vectorizeTree(E->getOperand(1)); 7803 Value *False = vectorizeTree(E->getOperand(2)); 7804 7805 if (E->VectorizedValue) { 7806 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7807 return E->VectorizedValue; 7808 } 7809 7810 Value *V = Builder.CreateSelect(Cond, True, False); 7811 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7812 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7813 V = ShuffleBuilder.finalize(V); 7814 7815 E->VectorizedValue = V; 7816 ++NumVectorInstructions; 7817 return V; 7818 } 7819 case Instruction::FNeg: { 7820 setInsertPointAfterBundle(E); 7821 7822 Value *Op = vectorizeTree(E->getOperand(0)); 7823 7824 if (E->VectorizedValue) { 7825 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7826 return E->VectorizedValue; 7827 } 7828 7829 Value *V = Builder.CreateUnOp( 7830 static_cast<Instruction::UnaryOps>(E->getOpcode()), Op); 7831 propagateIRFlags(V, E->Scalars, VL0); 7832 if (auto *I = dyn_cast<Instruction>(V)) 7833 V = propagateMetadata(I, E->Scalars); 7834 7835 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7836 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7837 V = ShuffleBuilder.finalize(V); 7838 7839 E->VectorizedValue = V; 7840 ++NumVectorInstructions; 7841 7842 return V; 7843 } 7844 case Instruction::Add: 7845 case Instruction::FAdd: 7846 case Instruction::Sub: 7847 case Instruction::FSub: 7848 case Instruction::Mul: 7849 case Instruction::FMul: 7850 case Instruction::UDiv: 7851 case Instruction::SDiv: 7852 case Instruction::FDiv: 7853 case Instruction::URem: 7854 case Instruction::SRem: 7855 case Instruction::FRem: 7856 case Instruction::Shl: 7857 case Instruction::LShr: 7858 case Instruction::AShr: 7859 case Instruction::And: 7860 case Instruction::Or: 7861 case Instruction::Xor: { 7862 setInsertPointAfterBundle(E); 7863 7864 Value *LHS = vectorizeTree(E->getOperand(0)); 7865 Value *RHS = vectorizeTree(E->getOperand(1)); 7866 7867 if (E->VectorizedValue) { 7868 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 7869 return E->VectorizedValue; 7870 } 7871 7872 Value *V = Builder.CreateBinOp( 7873 static_cast<Instruction::BinaryOps>(E->getOpcode()), LHS, 7874 RHS); 7875 propagateIRFlags(V, E->Scalars, VL0); 7876 if (auto *I = dyn_cast<Instruction>(V)) 7877 V = propagateMetadata(I, E->Scalars); 7878 7879 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7880 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7881 V = ShuffleBuilder.finalize(V); 7882 7883 E->VectorizedValue = V; 7884 ++NumVectorInstructions; 7885 7886 return V; 7887 } 7888 case Instruction::Load: { 7889 // Loads are inserted at the head of the tree because we don't want to 7890 // sink them all the way down past store instructions. 7891 setInsertPointAfterBundle(E); 7892 7893 LoadInst *LI = cast<LoadInst>(VL0); 7894 Instruction *NewLI; 7895 unsigned AS = LI->getPointerAddressSpace(); 7896 Value *PO = LI->getPointerOperand(); 7897 if (E->State == TreeEntry::Vectorize) { 7898 Value *VecPtr = Builder.CreateBitCast(PO, VecTy->getPointerTo(AS)); 7899 NewLI = Builder.CreateAlignedLoad(VecTy, VecPtr, LI->getAlign()); 7900 7901 // The pointer operand uses an in-tree scalar so we add the new BitCast 7902 // or LoadInst to ExternalUses list to make sure that an extract will 7903 // be generated in the future. 7904 if (TreeEntry *Entry = getTreeEntry(PO)) { 7905 // Find which lane we need to extract. 7906 unsigned FoundLane = Entry->findLaneForValue(PO); 7907 ExternalUses.emplace_back( 7908 PO, PO != VecPtr ? cast<User>(VecPtr) : NewLI, FoundLane); 7909 } 7910 } else { 7911 assert(E->State == TreeEntry::ScatterVectorize && "Unhandled state"); 7912 Value *VecPtr = vectorizeTree(E->getOperand(0)); 7913 // Use the minimum alignment of the gathered loads. 7914 Align CommonAlignment = LI->getAlign(); 7915 for (Value *V : E->Scalars) 7916 CommonAlignment = 7917 commonAlignment(CommonAlignment, cast<LoadInst>(V)->getAlign()); 7918 NewLI = Builder.CreateMaskedGather(VecTy, VecPtr, CommonAlignment); 7919 } 7920 Value *V = propagateMetadata(NewLI, E->Scalars); 7921 7922 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7923 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7924 V = ShuffleBuilder.finalize(V); 7925 E->VectorizedValue = V; 7926 ++NumVectorInstructions; 7927 return V; 7928 } 7929 case Instruction::Store: { 7930 auto *SI = cast<StoreInst>(VL0); 7931 unsigned AS = SI->getPointerAddressSpace(); 7932 7933 setInsertPointAfterBundle(E); 7934 7935 Value *VecValue = vectorizeTree(E->getOperand(0)); 7936 ShuffleBuilder.addMask(E->ReorderIndices); 7937 VecValue = ShuffleBuilder.finalize(VecValue); 7938 7939 Value *ScalarPtr = SI->getPointerOperand(); 7940 Value *VecPtr = Builder.CreateBitCast( 7941 ScalarPtr, VecValue->getType()->getPointerTo(AS)); 7942 StoreInst *ST = 7943 Builder.CreateAlignedStore(VecValue, VecPtr, SI->getAlign()); 7944 7945 // The pointer operand uses an in-tree scalar, so add the new BitCast or 7946 // StoreInst to ExternalUses to make sure that an extract will be 7947 // generated in the future. 7948 if (TreeEntry *Entry = getTreeEntry(ScalarPtr)) { 7949 // Find which lane we need to extract. 7950 unsigned FoundLane = Entry->findLaneForValue(ScalarPtr); 7951 ExternalUses.push_back(ExternalUser( 7952 ScalarPtr, ScalarPtr != VecPtr ? cast<User>(VecPtr) : ST, 7953 FoundLane)); 7954 } 7955 7956 Value *V = propagateMetadata(ST, E->Scalars); 7957 7958 E->VectorizedValue = V; 7959 ++NumVectorInstructions; 7960 return V; 7961 } 7962 case Instruction::GetElementPtr: { 7963 auto *GEP0 = cast<GetElementPtrInst>(VL0); 7964 setInsertPointAfterBundle(E); 7965 7966 Value *Op0 = vectorizeTree(E->getOperand(0)); 7967 7968 SmallVector<Value *> OpVecs; 7969 for (int J = 1, N = GEP0->getNumOperands(); J < N; ++J) { 7970 Value *OpVec = vectorizeTree(E->getOperand(J)); 7971 OpVecs.push_back(OpVec); 7972 } 7973 7974 Value *V = Builder.CreateGEP(GEP0->getSourceElementType(), Op0, OpVecs); 7975 if (Instruction *I = dyn_cast<Instruction>(V)) 7976 V = propagateMetadata(I, E->Scalars); 7977 7978 ShuffleBuilder.addInversedMask(E->ReorderIndices); 7979 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 7980 V = ShuffleBuilder.finalize(V); 7981 7982 E->VectorizedValue = V; 7983 ++NumVectorInstructions; 7984 7985 return V; 7986 } 7987 case Instruction::Call: { 7988 CallInst *CI = cast<CallInst>(VL0); 7989 setInsertPointAfterBundle(E); 7990 7991 Intrinsic::ID IID = Intrinsic::not_intrinsic; 7992 if (Function *FI = CI->getCalledFunction()) 7993 IID = FI->getIntrinsicID(); 7994 7995 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 7996 7997 auto VecCallCosts = getVectorCallCosts(CI, VecTy, TTI, TLI); 7998 bool UseIntrinsic = ID != Intrinsic::not_intrinsic && 7999 VecCallCosts.first <= VecCallCosts.second; 8000 8001 Value *ScalarArg = nullptr; 8002 std::vector<Value *> OpVecs; 8003 SmallVector<Type *, 2> TysForDecl = 8004 {FixedVectorType::get(CI->getType(), E->Scalars.size())}; 8005 for (int j = 0, e = CI->arg_size(); j < e; ++j) { 8006 ValueList OpVL; 8007 // Some intrinsics have scalar arguments. This argument should not be 8008 // vectorized. 8009 if (UseIntrinsic && isVectorIntrinsicWithScalarOpAtArg(IID, j)) { 8010 CallInst *CEI = cast<CallInst>(VL0); 8011 ScalarArg = CEI->getArgOperand(j); 8012 OpVecs.push_back(CEI->getArgOperand(j)); 8013 if (isVectorIntrinsicWithOverloadTypeAtArg(IID, j)) 8014 TysForDecl.push_back(ScalarArg->getType()); 8015 continue; 8016 } 8017 8018 Value *OpVec = vectorizeTree(E->getOperand(j)); 8019 LLVM_DEBUG(dbgs() << "SLP: OpVec[" << j << "]: " << *OpVec << "\n"); 8020 OpVecs.push_back(OpVec); 8021 if (isVectorIntrinsicWithOverloadTypeAtArg(IID, j)) 8022 TysForDecl.push_back(OpVec->getType()); 8023 } 8024 8025 Function *CF; 8026 if (!UseIntrinsic) { 8027 VFShape Shape = 8028 VFShape::get(*CI, ElementCount::getFixed(static_cast<unsigned>( 8029 VecTy->getNumElements())), 8030 false /*HasGlobalPred*/); 8031 CF = VFDatabase(*CI).getVectorizedFunction(Shape); 8032 } else { 8033 CF = Intrinsic::getDeclaration(F->getParent(), ID, TysForDecl); 8034 } 8035 8036 SmallVector<OperandBundleDef, 1> OpBundles; 8037 CI->getOperandBundlesAsDefs(OpBundles); 8038 Value *V = Builder.CreateCall(CF, OpVecs, OpBundles); 8039 8040 // The scalar argument uses an in-tree scalar so we add the new vectorized 8041 // call to ExternalUses list to make sure that an extract will be 8042 // generated in the future. 8043 if (ScalarArg) { 8044 if (TreeEntry *Entry = getTreeEntry(ScalarArg)) { 8045 // Find which lane we need to extract. 8046 unsigned FoundLane = Entry->findLaneForValue(ScalarArg); 8047 ExternalUses.push_back( 8048 ExternalUser(ScalarArg, cast<User>(V), FoundLane)); 8049 } 8050 } 8051 8052 propagateIRFlags(V, E->Scalars, VL0); 8053 ShuffleBuilder.addInversedMask(E->ReorderIndices); 8054 ShuffleBuilder.addMask(E->ReuseShuffleIndices); 8055 V = ShuffleBuilder.finalize(V); 8056 8057 E->VectorizedValue = V; 8058 ++NumVectorInstructions; 8059 return V; 8060 } 8061 case Instruction::ShuffleVector: { 8062 assert(E->isAltShuffle() && 8063 ((Instruction::isBinaryOp(E->getOpcode()) && 8064 Instruction::isBinaryOp(E->getAltOpcode())) || 8065 (Instruction::isCast(E->getOpcode()) && 8066 Instruction::isCast(E->getAltOpcode())) || 8067 (isa<CmpInst>(VL0) && isa<CmpInst>(E->getAltOp()))) && 8068 "Invalid Shuffle Vector Operand"); 8069 8070 Value *LHS = nullptr, *RHS = nullptr; 8071 if (Instruction::isBinaryOp(E->getOpcode()) || isa<CmpInst>(VL0)) { 8072 setInsertPointAfterBundle(E); 8073 LHS = vectorizeTree(E->getOperand(0)); 8074 RHS = vectorizeTree(E->getOperand(1)); 8075 } else { 8076 setInsertPointAfterBundle(E); 8077 LHS = vectorizeTree(E->getOperand(0)); 8078 } 8079 8080 if (E->VectorizedValue) { 8081 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 8082 return E->VectorizedValue; 8083 } 8084 8085 Value *V0, *V1; 8086 if (Instruction::isBinaryOp(E->getOpcode())) { 8087 V0 = Builder.CreateBinOp( 8088 static_cast<Instruction::BinaryOps>(E->getOpcode()), LHS, RHS); 8089 V1 = Builder.CreateBinOp( 8090 static_cast<Instruction::BinaryOps>(E->getAltOpcode()), LHS, RHS); 8091 } else if (auto *CI0 = dyn_cast<CmpInst>(VL0)) { 8092 V0 = Builder.CreateCmp(CI0->getPredicate(), LHS, RHS); 8093 auto *AltCI = cast<CmpInst>(E->getAltOp()); 8094 CmpInst::Predicate AltPred = AltCI->getPredicate(); 8095 V1 = Builder.CreateCmp(AltPred, LHS, RHS); 8096 } else { 8097 V0 = Builder.CreateCast( 8098 static_cast<Instruction::CastOps>(E->getOpcode()), LHS, VecTy); 8099 V1 = Builder.CreateCast( 8100 static_cast<Instruction::CastOps>(E->getAltOpcode()), LHS, VecTy); 8101 } 8102 // Add V0 and V1 to later analysis to try to find and remove matching 8103 // instruction, if any. 8104 for (Value *V : {V0, V1}) { 8105 if (auto *I = dyn_cast<Instruction>(V)) { 8106 GatherShuffleSeq.insert(I); 8107 CSEBlocks.insert(I->getParent()); 8108 } 8109 } 8110 8111 // Create shuffle to take alternate operations from the vector. 8112 // Also, gather up main and alt scalar ops to propagate IR flags to 8113 // each vector operation. 8114 ValueList OpScalars, AltScalars; 8115 SmallVector<int> Mask; 8116 buildShuffleEntryMask( 8117 E->Scalars, E->ReorderIndices, E->ReuseShuffleIndices, 8118 [E](Instruction *I) { 8119 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 8120 return isAlternateInstruction(I, E->getMainOp(), E->getAltOp()); 8121 }, 8122 Mask, &OpScalars, &AltScalars); 8123 8124 propagateIRFlags(V0, OpScalars); 8125 propagateIRFlags(V1, AltScalars); 8126 8127 Value *V = Builder.CreateShuffleVector(V0, V1, Mask); 8128 if (auto *I = dyn_cast<Instruction>(V)) { 8129 V = propagateMetadata(I, E->Scalars); 8130 GatherShuffleSeq.insert(I); 8131 CSEBlocks.insert(I->getParent()); 8132 } 8133 V = ShuffleBuilder.finalize(V); 8134 8135 E->VectorizedValue = V; 8136 ++NumVectorInstructions; 8137 8138 return V; 8139 } 8140 default: 8141 llvm_unreachable("unknown inst"); 8142 } 8143 return nullptr; 8144 } 8145 8146 Value *BoUpSLP::vectorizeTree() { 8147 ExtraValueToDebugLocsMap ExternallyUsedValues; 8148 return vectorizeTree(ExternallyUsedValues); 8149 } 8150 8151 namespace { 8152 /// Data type for handling buildvector sequences with the reused scalars from 8153 /// other tree entries. 8154 struct ShuffledInsertData { 8155 /// List of insertelements to be replaced by shuffles. 8156 SmallVector<InsertElementInst *> InsertElements; 8157 /// The parent vectors and shuffle mask for the given list of inserts. 8158 MapVector<Value *, SmallVector<int>> ValueMasks; 8159 }; 8160 } // namespace 8161 8162 Value * 8163 BoUpSLP::vectorizeTree(ExtraValueToDebugLocsMap &ExternallyUsedValues) { 8164 // All blocks must be scheduled before any instructions are inserted. 8165 for (auto &BSIter : BlocksSchedules) { 8166 scheduleBlock(BSIter.second.get()); 8167 } 8168 8169 Builder.SetInsertPoint(&F->getEntryBlock().front()); 8170 auto *VectorRoot = vectorizeTree(VectorizableTree[0].get()); 8171 8172 // If the vectorized tree can be rewritten in a smaller type, we truncate the 8173 // vectorized root. InstCombine will then rewrite the entire expression. We 8174 // sign extend the extracted values below. 8175 auto *ScalarRoot = VectorizableTree[0]->Scalars[0]; 8176 if (MinBWs.count(ScalarRoot)) { 8177 if (auto *I = dyn_cast<Instruction>(VectorRoot)) { 8178 // If current instr is a phi and not the last phi, insert it after the 8179 // last phi node. 8180 if (isa<PHINode>(I)) 8181 Builder.SetInsertPoint(&*I->getParent()->getFirstInsertionPt()); 8182 else 8183 Builder.SetInsertPoint(&*++BasicBlock::iterator(I)); 8184 } 8185 auto BundleWidth = VectorizableTree[0]->Scalars.size(); 8186 auto *MinTy = IntegerType::get(F->getContext(), MinBWs[ScalarRoot].first); 8187 auto *VecTy = FixedVectorType::get(MinTy, BundleWidth); 8188 auto *Trunc = Builder.CreateTrunc(VectorRoot, VecTy); 8189 VectorizableTree[0]->VectorizedValue = Trunc; 8190 } 8191 8192 LLVM_DEBUG(dbgs() << "SLP: Extracting " << ExternalUses.size() 8193 << " values .\n"); 8194 8195 SmallVector<ShuffledInsertData> ShuffledInserts; 8196 // Maps vector instruction to original insertelement instruction 8197 DenseMap<Value *, InsertElementInst *> VectorToInsertElement; 8198 // Extract all of the elements with the external uses. 8199 for (const auto &ExternalUse : ExternalUses) { 8200 Value *Scalar = ExternalUse.Scalar; 8201 llvm::User *User = ExternalUse.User; 8202 8203 // Skip users that we already RAUW. This happens when one instruction 8204 // has multiple uses of the same value. 8205 if (User && !is_contained(Scalar->users(), User)) 8206 continue; 8207 TreeEntry *E = getTreeEntry(Scalar); 8208 assert(E && "Invalid scalar"); 8209 assert(E->State != TreeEntry::NeedToGather && 8210 "Extracting from a gather list"); 8211 8212 Value *Vec = E->VectorizedValue; 8213 assert(Vec && "Can't find vectorizable value"); 8214 8215 Value *Lane = Builder.getInt32(ExternalUse.Lane); 8216 auto ExtractAndExtendIfNeeded = [&](Value *Vec) { 8217 if (Scalar->getType() != Vec->getType()) { 8218 Value *Ex; 8219 // "Reuse" the existing extract to improve final codegen. 8220 if (auto *ES = dyn_cast<ExtractElementInst>(Scalar)) { 8221 Ex = Builder.CreateExtractElement(ES->getOperand(0), 8222 ES->getOperand(1)); 8223 } else { 8224 Ex = Builder.CreateExtractElement(Vec, Lane); 8225 } 8226 // If necessary, sign-extend or zero-extend ScalarRoot 8227 // to the larger type. 8228 if (!MinBWs.count(ScalarRoot)) 8229 return Ex; 8230 if (MinBWs[ScalarRoot].second) 8231 return Builder.CreateSExt(Ex, Scalar->getType()); 8232 return Builder.CreateZExt(Ex, Scalar->getType()); 8233 } 8234 assert(isa<FixedVectorType>(Scalar->getType()) && 8235 isa<InsertElementInst>(Scalar) && 8236 "In-tree scalar of vector type is not insertelement?"); 8237 auto *IE = cast<InsertElementInst>(Scalar); 8238 VectorToInsertElement.try_emplace(Vec, IE); 8239 return Vec; 8240 }; 8241 // If User == nullptr, the Scalar is used as extra arg. Generate 8242 // ExtractElement instruction and update the record for this scalar in 8243 // ExternallyUsedValues. 8244 if (!User) { 8245 assert(ExternallyUsedValues.count(Scalar) && 8246 "Scalar with nullptr as an external user must be registered in " 8247 "ExternallyUsedValues map"); 8248 if (auto *VecI = dyn_cast<Instruction>(Vec)) { 8249 Builder.SetInsertPoint(VecI->getParent(), 8250 std::next(VecI->getIterator())); 8251 } else { 8252 Builder.SetInsertPoint(&F->getEntryBlock().front()); 8253 } 8254 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8255 CSEBlocks.insert(cast<Instruction>(Scalar)->getParent()); 8256 auto &NewInstLocs = ExternallyUsedValues[NewInst]; 8257 auto It = ExternallyUsedValues.find(Scalar); 8258 assert(It != ExternallyUsedValues.end() && 8259 "Externally used scalar is not found in ExternallyUsedValues"); 8260 NewInstLocs.append(It->second); 8261 ExternallyUsedValues.erase(Scalar); 8262 // Required to update internally referenced instructions. 8263 Scalar->replaceAllUsesWith(NewInst); 8264 continue; 8265 } 8266 8267 if (auto *VU = dyn_cast<InsertElementInst>(User)) { 8268 // Skip if the scalar is another vector op or Vec is not an instruction. 8269 if (!Scalar->getType()->isVectorTy() && isa<Instruction>(Vec)) { 8270 if (auto *FTy = dyn_cast<FixedVectorType>(User->getType())) { 8271 Optional<unsigned> InsertIdx = getInsertIndex(VU); 8272 if (InsertIdx) { 8273 auto *It = 8274 find_if(ShuffledInserts, [VU](const ShuffledInsertData &Data) { 8275 // Checks if 2 insertelements are from the same buildvector. 8276 InsertElementInst *VecInsert = Data.InsertElements.front(); 8277 return areTwoInsertFromSameBuildVector(VU, VecInsert); 8278 }); 8279 unsigned Idx = *InsertIdx; 8280 if (It == ShuffledInserts.end()) { 8281 (void)ShuffledInserts.emplace_back(); 8282 It = std::next(ShuffledInserts.begin(), 8283 ShuffledInserts.size() - 1); 8284 SmallVectorImpl<int> &Mask = It->ValueMasks[Vec]; 8285 if (Mask.empty()) 8286 Mask.assign(FTy->getNumElements(), UndefMaskElem); 8287 // Find the insertvector, vectorized in tree, if any. 8288 Value *Base = VU; 8289 while (auto *IEBase = dyn_cast<InsertElementInst>(Base)) { 8290 if (IEBase != User && 8291 (!IEBase->hasOneUse() || 8292 getInsertIndex(IEBase).getValueOr(Idx) == Idx)) 8293 break; 8294 // Build the mask for the vectorized insertelement instructions. 8295 if (const TreeEntry *E = getTreeEntry(IEBase)) { 8296 do { 8297 IEBase = cast<InsertElementInst>(Base); 8298 int IEIdx = *getInsertIndex(IEBase); 8299 assert(Mask[Idx] == UndefMaskElem && 8300 "InsertElementInstruction used already."); 8301 Mask[IEIdx] = IEIdx; 8302 Base = IEBase->getOperand(0); 8303 } while (E == getTreeEntry(Base)); 8304 break; 8305 } 8306 Base = cast<InsertElementInst>(Base)->getOperand(0); 8307 // After the vectorization the def-use chain has changed, need 8308 // to look through original insertelement instructions, if they 8309 // get replaced by vector instructions. 8310 auto It = VectorToInsertElement.find(Base); 8311 if (It != VectorToInsertElement.end()) 8312 Base = It->second; 8313 } 8314 } 8315 SmallVectorImpl<int> &Mask = It->ValueMasks[Vec]; 8316 if (Mask.empty()) 8317 Mask.assign(FTy->getNumElements(), UndefMaskElem); 8318 Mask[Idx] = ExternalUse.Lane; 8319 It->InsertElements.push_back(cast<InsertElementInst>(User)); 8320 continue; 8321 } 8322 } 8323 } 8324 } 8325 8326 // Generate extracts for out-of-tree users. 8327 // Find the insertion point for the extractelement lane. 8328 if (auto *VecI = dyn_cast<Instruction>(Vec)) { 8329 if (PHINode *PH = dyn_cast<PHINode>(User)) { 8330 for (int i = 0, e = PH->getNumIncomingValues(); i != e; ++i) { 8331 if (PH->getIncomingValue(i) == Scalar) { 8332 Instruction *IncomingTerminator = 8333 PH->getIncomingBlock(i)->getTerminator(); 8334 if (isa<CatchSwitchInst>(IncomingTerminator)) { 8335 Builder.SetInsertPoint(VecI->getParent(), 8336 std::next(VecI->getIterator())); 8337 } else { 8338 Builder.SetInsertPoint(PH->getIncomingBlock(i)->getTerminator()); 8339 } 8340 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8341 CSEBlocks.insert(PH->getIncomingBlock(i)); 8342 PH->setOperand(i, NewInst); 8343 } 8344 } 8345 } else { 8346 Builder.SetInsertPoint(cast<Instruction>(User)); 8347 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8348 CSEBlocks.insert(cast<Instruction>(User)->getParent()); 8349 User->replaceUsesOfWith(Scalar, NewInst); 8350 } 8351 } else { 8352 Builder.SetInsertPoint(&F->getEntryBlock().front()); 8353 Value *NewInst = ExtractAndExtendIfNeeded(Vec); 8354 CSEBlocks.insert(&F->getEntryBlock()); 8355 User->replaceUsesOfWith(Scalar, NewInst); 8356 } 8357 8358 LLVM_DEBUG(dbgs() << "SLP: Replaced:" << *User << ".\n"); 8359 } 8360 8361 // Checks if the mask is an identity mask. 8362 auto &&IsIdentityMask = [](ArrayRef<int> Mask, FixedVectorType *VecTy) { 8363 int Limit = Mask.size(); 8364 return VecTy->getNumElements() == Mask.size() && 8365 all_of(Mask, [Limit](int Idx) { return Idx < Limit; }) && 8366 ShuffleVectorInst::isIdentityMask(Mask); 8367 }; 8368 // Tries to combine 2 different masks into single one. 8369 auto &&CombineMasks = [](SmallVectorImpl<int> &Mask, ArrayRef<int> ExtMask) { 8370 SmallVector<int> NewMask(ExtMask.size(), UndefMaskElem); 8371 for (int I = 0, Sz = ExtMask.size(); I < Sz; ++I) { 8372 if (ExtMask[I] == UndefMaskElem) 8373 continue; 8374 NewMask[I] = Mask[ExtMask[I]]; 8375 } 8376 Mask.swap(NewMask); 8377 }; 8378 // Peek through shuffles, trying to simplify the final shuffle code. 8379 auto &&PeekThroughShuffles = 8380 [&IsIdentityMask, &CombineMasks](Value *&V, SmallVectorImpl<int> &Mask, 8381 bool CheckForLengthChange = false) { 8382 while (auto *SV = dyn_cast<ShuffleVectorInst>(V)) { 8383 // Exit if not a fixed vector type or changing size shuffle. 8384 if (!isa<FixedVectorType>(SV->getType()) || 8385 (CheckForLengthChange && SV->changesLength())) 8386 break; 8387 // Exit if the identity or broadcast mask is found. 8388 if (IsIdentityMask(Mask, cast<FixedVectorType>(SV->getType())) || 8389 SV->isZeroEltSplat()) 8390 break; 8391 bool IsOp1Undef = isUndefVector(SV->getOperand(0)); 8392 bool IsOp2Undef = isUndefVector(SV->getOperand(1)); 8393 if (!IsOp1Undef && !IsOp2Undef) 8394 break; 8395 SmallVector<int> ShuffleMask(SV->getShuffleMask().begin(), 8396 SV->getShuffleMask().end()); 8397 CombineMasks(ShuffleMask, Mask); 8398 Mask.swap(ShuffleMask); 8399 if (IsOp2Undef) 8400 V = SV->getOperand(0); 8401 else 8402 V = SV->getOperand(1); 8403 } 8404 }; 8405 // Smart shuffle instruction emission, walks through shuffles trees and 8406 // tries to find the best matching vector for the actual shuffle 8407 // instruction. 8408 auto &&CreateShuffle = [this, &IsIdentityMask, &PeekThroughShuffles, 8409 &CombineMasks](Value *V1, Value *V2, 8410 ArrayRef<int> Mask) -> Value * { 8411 assert(V1 && "Expected at least one vector value."); 8412 if (V2 && !isUndefVector(V2)) { 8413 // Peek through shuffles. 8414 Value *Op1 = V1; 8415 Value *Op2 = V2; 8416 int VF = 8417 cast<VectorType>(V1->getType())->getElementCount().getKnownMinValue(); 8418 SmallVector<int> CombinedMask1(Mask.size(), UndefMaskElem); 8419 SmallVector<int> CombinedMask2(Mask.size(), UndefMaskElem); 8420 for (int I = 0, E = Mask.size(); I < E; ++I) { 8421 if (Mask[I] < VF) 8422 CombinedMask1[I] = Mask[I]; 8423 else 8424 CombinedMask2[I] = Mask[I] - VF; 8425 } 8426 Value *PrevOp1; 8427 Value *PrevOp2; 8428 do { 8429 PrevOp1 = Op1; 8430 PrevOp2 = Op2; 8431 PeekThroughShuffles(Op1, CombinedMask1, /*CheckForLengthChange=*/true); 8432 PeekThroughShuffles(Op2, CombinedMask2, /*CheckForLengthChange=*/true); 8433 // Check if we have 2 resizing shuffles - need to peek through operands 8434 // again. 8435 if (auto *SV1 = dyn_cast<ShuffleVectorInst>(Op1)) 8436 if (auto *SV2 = dyn_cast<ShuffleVectorInst>(Op2)) 8437 if (SV1->getOperand(0)->getType() == 8438 SV2->getOperand(0)->getType() && 8439 SV1->getOperand(0)->getType() != SV1->getType() && 8440 isUndefVector(SV1->getOperand(1)) && 8441 isUndefVector(SV2->getOperand(1))) { 8442 Op1 = SV1->getOperand(0); 8443 Op2 = SV2->getOperand(0); 8444 SmallVector<int> ShuffleMask1(SV1->getShuffleMask().begin(), 8445 SV1->getShuffleMask().end()); 8446 CombineMasks(ShuffleMask1, CombinedMask1); 8447 CombinedMask1.swap(ShuffleMask1); 8448 SmallVector<int> ShuffleMask2(SV2->getShuffleMask().begin(), 8449 SV2->getShuffleMask().end()); 8450 CombineMasks(ShuffleMask2, CombinedMask2); 8451 CombinedMask2.swap(ShuffleMask2); 8452 } 8453 } while (PrevOp1 != Op1 || PrevOp2 != Op2); 8454 VF = cast<VectorType>(Op1->getType()) 8455 ->getElementCount() 8456 .getKnownMinValue(); 8457 for (int I = 0, E = Mask.size(); I < E; ++I) { 8458 if (CombinedMask2[I] != UndefMaskElem) { 8459 assert(CombinedMask1[I] == UndefMaskElem && 8460 "Expected undefined mask element"); 8461 CombinedMask1[I] = CombinedMask2[I] + (Op1 == Op2 ? 0 : VF); 8462 } 8463 } 8464 Value *Vec = Builder.CreateShuffleVector( 8465 Op1, Op1 == Op2 ? PoisonValue::get(Op1->getType()) : Op2, 8466 CombinedMask1); 8467 if (auto *I = dyn_cast<Instruction>(Vec)) { 8468 GatherShuffleSeq.insert(I); 8469 CSEBlocks.insert(I->getParent()); 8470 } 8471 return Vec; 8472 } 8473 if (isa<PoisonValue>(V1)) 8474 return PoisonValue::get(FixedVectorType::get( 8475 cast<VectorType>(V1->getType())->getElementType(), Mask.size())); 8476 Value *Op = V1; 8477 SmallVector<int> CombinedMask(Mask.begin(), Mask.end()); 8478 PeekThroughShuffles(Op, CombinedMask); 8479 if (!isa<FixedVectorType>(Op->getType()) || 8480 !IsIdentityMask(CombinedMask, cast<FixedVectorType>(Op->getType()))) { 8481 Value *Vec = Builder.CreateShuffleVector(Op, CombinedMask); 8482 if (auto *I = dyn_cast<Instruction>(Vec)) { 8483 GatherShuffleSeq.insert(I); 8484 CSEBlocks.insert(I->getParent()); 8485 } 8486 return Vec; 8487 } 8488 return Op; 8489 }; 8490 8491 auto &&ResizeToVF = [&CreateShuffle](Value *Vec, ArrayRef<int> Mask) { 8492 unsigned VF = Mask.size(); 8493 unsigned VecVF = cast<FixedVectorType>(Vec->getType())->getNumElements(); 8494 if (VF != VecVF) { 8495 if (any_of(Mask, [VF](int Idx) { return Idx >= static_cast<int>(VF); })) { 8496 Vec = CreateShuffle(Vec, nullptr, Mask); 8497 return std::make_pair(Vec, true); 8498 } 8499 SmallVector<int> ResizeMask(VF, UndefMaskElem); 8500 for (unsigned I = 0; I < VF; ++I) { 8501 if (Mask[I] != UndefMaskElem) 8502 ResizeMask[Mask[I]] = Mask[I]; 8503 } 8504 Vec = CreateShuffle(Vec, nullptr, ResizeMask); 8505 } 8506 8507 return std::make_pair(Vec, false); 8508 }; 8509 // Perform shuffling of the vectorize tree entries for better handling of 8510 // external extracts. 8511 for (int I = 0, E = ShuffledInserts.size(); I < E; ++I) { 8512 // Find the first and the last instruction in the list of insertelements. 8513 sort(ShuffledInserts[I].InsertElements, isFirstInsertElement); 8514 InsertElementInst *FirstInsert = ShuffledInserts[I].InsertElements.front(); 8515 InsertElementInst *LastInsert = ShuffledInserts[I].InsertElements.back(); 8516 Builder.SetInsertPoint(LastInsert); 8517 auto Vector = ShuffledInserts[I].ValueMasks.takeVector(); 8518 Value *NewInst = performExtractsShuffleAction<Value>( 8519 makeMutableArrayRef(Vector.data(), Vector.size()), 8520 FirstInsert->getOperand(0), 8521 [](Value *Vec) { 8522 return cast<VectorType>(Vec->getType()) 8523 ->getElementCount() 8524 .getKnownMinValue(); 8525 }, 8526 ResizeToVF, 8527 [FirstInsert, &CreateShuffle](ArrayRef<int> Mask, 8528 ArrayRef<Value *> Vals) { 8529 assert((Vals.size() == 1 || Vals.size() == 2) && 8530 "Expected exactly 1 or 2 input values."); 8531 if (Vals.size() == 1) { 8532 // Do not create shuffle if the mask is a simple identity 8533 // non-resizing mask. 8534 if (Mask.size() != cast<FixedVectorType>(Vals.front()->getType()) 8535 ->getNumElements() || 8536 !ShuffleVectorInst::isIdentityMask(Mask)) 8537 return CreateShuffle(Vals.front(), nullptr, Mask); 8538 return Vals.front(); 8539 } 8540 return CreateShuffle(Vals.front() ? Vals.front() 8541 : FirstInsert->getOperand(0), 8542 Vals.back(), Mask); 8543 }); 8544 auto It = ShuffledInserts[I].InsertElements.rbegin(); 8545 // Rebuild buildvector chain. 8546 InsertElementInst *II = nullptr; 8547 if (It != ShuffledInserts[I].InsertElements.rend()) 8548 II = *It; 8549 SmallVector<Instruction *> Inserts; 8550 while (It != ShuffledInserts[I].InsertElements.rend()) { 8551 assert(II && "Must be an insertelement instruction."); 8552 if (*It == II) 8553 ++It; 8554 else 8555 Inserts.push_back(cast<Instruction>(II)); 8556 II = dyn_cast<InsertElementInst>(II->getOperand(0)); 8557 } 8558 for (Instruction *II : reverse(Inserts)) { 8559 II->replaceUsesOfWith(II->getOperand(0), NewInst); 8560 if (auto *NewI = dyn_cast<Instruction>(NewInst)) 8561 if (II->getParent() == NewI->getParent() && II->comesBefore(NewI)) 8562 II->moveAfter(NewI); 8563 NewInst = II; 8564 } 8565 LastInsert->replaceAllUsesWith(NewInst); 8566 for (InsertElementInst *IE : reverse(ShuffledInserts[I].InsertElements)) { 8567 IE->replaceUsesOfWith(IE->getOperand(1), 8568 PoisonValue::get(IE->getOperand(1)->getType())); 8569 eraseInstruction(IE); 8570 } 8571 CSEBlocks.insert(LastInsert->getParent()); 8572 } 8573 8574 // For each vectorized value: 8575 for (auto &TEPtr : VectorizableTree) { 8576 TreeEntry *Entry = TEPtr.get(); 8577 8578 // No need to handle users of gathered values. 8579 if (Entry->State == TreeEntry::NeedToGather) 8580 continue; 8581 8582 assert(Entry->VectorizedValue && "Can't find vectorizable value"); 8583 8584 // For each lane: 8585 for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) { 8586 Value *Scalar = Entry->Scalars[Lane]; 8587 8588 #ifndef NDEBUG 8589 Type *Ty = Scalar->getType(); 8590 if (!Ty->isVoidTy()) { 8591 for (User *U : Scalar->users()) { 8592 LLVM_DEBUG(dbgs() << "SLP: \tvalidating user:" << *U << ".\n"); 8593 8594 // It is legal to delete users in the ignorelist. 8595 assert((getTreeEntry(U) || 8596 (UserIgnoreList && UserIgnoreList->contains(U)) || 8597 (isa_and_nonnull<Instruction>(U) && 8598 isDeleted(cast<Instruction>(U)))) && 8599 "Deleting out-of-tree value"); 8600 } 8601 } 8602 #endif 8603 LLVM_DEBUG(dbgs() << "SLP: \tErasing scalar:" << *Scalar << ".\n"); 8604 eraseInstruction(cast<Instruction>(Scalar)); 8605 } 8606 } 8607 8608 Builder.ClearInsertionPoint(); 8609 InstrElementSize.clear(); 8610 8611 return VectorizableTree[0]->VectorizedValue; 8612 } 8613 8614 void BoUpSLP::optimizeGatherSequence() { 8615 LLVM_DEBUG(dbgs() << "SLP: Optimizing " << GatherShuffleSeq.size() 8616 << " gather sequences instructions.\n"); 8617 // LICM InsertElementInst sequences. 8618 for (Instruction *I : GatherShuffleSeq) { 8619 if (isDeleted(I)) 8620 continue; 8621 8622 // Check if this block is inside a loop. 8623 Loop *L = LI->getLoopFor(I->getParent()); 8624 if (!L) 8625 continue; 8626 8627 // Check if it has a preheader. 8628 BasicBlock *PreHeader = L->getLoopPreheader(); 8629 if (!PreHeader) 8630 continue; 8631 8632 // If the vector or the element that we insert into it are 8633 // instructions that are defined in this basic block then we can't 8634 // hoist this instruction. 8635 if (any_of(I->operands(), [L](Value *V) { 8636 auto *OpI = dyn_cast<Instruction>(V); 8637 return OpI && L->contains(OpI); 8638 })) 8639 continue; 8640 8641 // We can hoist this instruction. Move it to the pre-header. 8642 I->moveBefore(PreHeader->getTerminator()); 8643 } 8644 8645 // Make a list of all reachable blocks in our CSE queue. 8646 SmallVector<const DomTreeNode *, 8> CSEWorkList; 8647 CSEWorkList.reserve(CSEBlocks.size()); 8648 for (BasicBlock *BB : CSEBlocks) 8649 if (DomTreeNode *N = DT->getNode(BB)) { 8650 assert(DT->isReachableFromEntry(N)); 8651 CSEWorkList.push_back(N); 8652 } 8653 8654 // Sort blocks by domination. This ensures we visit a block after all blocks 8655 // dominating it are visited. 8656 llvm::sort(CSEWorkList, [](const DomTreeNode *A, const DomTreeNode *B) { 8657 assert((A == B) == (A->getDFSNumIn() == B->getDFSNumIn()) && 8658 "Different nodes should have different DFS numbers"); 8659 return A->getDFSNumIn() < B->getDFSNumIn(); 8660 }); 8661 8662 // Less defined shuffles can be replaced by the more defined copies. 8663 // Between two shuffles one is less defined if it has the same vector operands 8664 // and its mask indeces are the same as in the first one or undefs. E.g. 8665 // shuffle %0, poison, <0, 0, 0, undef> is less defined than shuffle %0, 8666 // poison, <0, 0, 0, 0>. 8667 auto &&IsIdenticalOrLessDefined = [this](Instruction *I1, Instruction *I2, 8668 SmallVectorImpl<int> &NewMask) { 8669 if (I1->getType() != I2->getType()) 8670 return false; 8671 auto *SI1 = dyn_cast<ShuffleVectorInst>(I1); 8672 auto *SI2 = dyn_cast<ShuffleVectorInst>(I2); 8673 if (!SI1 || !SI2) 8674 return I1->isIdenticalTo(I2); 8675 if (SI1->isIdenticalTo(SI2)) 8676 return true; 8677 for (int I = 0, E = SI1->getNumOperands(); I < E; ++I) 8678 if (SI1->getOperand(I) != SI2->getOperand(I)) 8679 return false; 8680 // Check if the second instruction is more defined than the first one. 8681 NewMask.assign(SI2->getShuffleMask().begin(), SI2->getShuffleMask().end()); 8682 ArrayRef<int> SM1 = SI1->getShuffleMask(); 8683 // Count trailing undefs in the mask to check the final number of used 8684 // registers. 8685 unsigned LastUndefsCnt = 0; 8686 for (int I = 0, E = NewMask.size(); I < E; ++I) { 8687 if (SM1[I] == UndefMaskElem) 8688 ++LastUndefsCnt; 8689 else 8690 LastUndefsCnt = 0; 8691 if (NewMask[I] != UndefMaskElem && SM1[I] != UndefMaskElem && 8692 NewMask[I] != SM1[I]) 8693 return false; 8694 if (NewMask[I] == UndefMaskElem) 8695 NewMask[I] = SM1[I]; 8696 } 8697 // Check if the last undefs actually change the final number of used vector 8698 // registers. 8699 return SM1.size() - LastUndefsCnt > 1 && 8700 TTI->getNumberOfParts(SI1->getType()) == 8701 TTI->getNumberOfParts( 8702 FixedVectorType::get(SI1->getType()->getElementType(), 8703 SM1.size() - LastUndefsCnt)); 8704 }; 8705 // Perform O(N^2) search over the gather/shuffle sequences and merge identical 8706 // instructions. TODO: We can further optimize this scan if we split the 8707 // instructions into different buckets based on the insert lane. 8708 SmallVector<Instruction *, 16> Visited; 8709 for (auto I = CSEWorkList.begin(), E = CSEWorkList.end(); I != E; ++I) { 8710 assert(*I && 8711 (I == CSEWorkList.begin() || !DT->dominates(*I, *std::prev(I))) && 8712 "Worklist not sorted properly!"); 8713 BasicBlock *BB = (*I)->getBlock(); 8714 // For all instructions in blocks containing gather sequences: 8715 for (Instruction &In : llvm::make_early_inc_range(*BB)) { 8716 if (isDeleted(&In)) 8717 continue; 8718 if (!isa<InsertElementInst>(&In) && !isa<ExtractElementInst>(&In) && 8719 !isa<ShuffleVectorInst>(&In) && !GatherShuffleSeq.contains(&In)) 8720 continue; 8721 8722 // Check if we can replace this instruction with any of the 8723 // visited instructions. 8724 bool Replaced = false; 8725 for (Instruction *&V : Visited) { 8726 SmallVector<int> NewMask; 8727 if (IsIdenticalOrLessDefined(&In, V, NewMask) && 8728 DT->dominates(V->getParent(), In.getParent())) { 8729 In.replaceAllUsesWith(V); 8730 eraseInstruction(&In); 8731 if (auto *SI = dyn_cast<ShuffleVectorInst>(V)) 8732 if (!NewMask.empty()) 8733 SI->setShuffleMask(NewMask); 8734 Replaced = true; 8735 break; 8736 } 8737 if (isa<ShuffleVectorInst>(In) && isa<ShuffleVectorInst>(V) && 8738 GatherShuffleSeq.contains(V) && 8739 IsIdenticalOrLessDefined(V, &In, NewMask) && 8740 DT->dominates(In.getParent(), V->getParent())) { 8741 In.moveAfter(V); 8742 V->replaceAllUsesWith(&In); 8743 eraseInstruction(V); 8744 if (auto *SI = dyn_cast<ShuffleVectorInst>(&In)) 8745 if (!NewMask.empty()) 8746 SI->setShuffleMask(NewMask); 8747 V = &In; 8748 Replaced = true; 8749 break; 8750 } 8751 } 8752 if (!Replaced) { 8753 assert(!is_contained(Visited, &In)); 8754 Visited.push_back(&In); 8755 } 8756 } 8757 } 8758 CSEBlocks.clear(); 8759 GatherShuffleSeq.clear(); 8760 } 8761 8762 BoUpSLP::ScheduleData * 8763 BoUpSLP::BlockScheduling::buildBundle(ArrayRef<Value *> VL) { 8764 ScheduleData *Bundle = nullptr; 8765 ScheduleData *PrevInBundle = nullptr; 8766 for (Value *V : VL) { 8767 if (doesNotNeedToBeScheduled(V)) 8768 continue; 8769 ScheduleData *BundleMember = getScheduleData(V); 8770 assert(BundleMember && 8771 "no ScheduleData for bundle member " 8772 "(maybe not in same basic block)"); 8773 assert(BundleMember->isSchedulingEntity() && 8774 "bundle member already part of other bundle"); 8775 if (PrevInBundle) { 8776 PrevInBundle->NextInBundle = BundleMember; 8777 } else { 8778 Bundle = BundleMember; 8779 } 8780 8781 // Group the instructions to a bundle. 8782 BundleMember->FirstInBundle = Bundle; 8783 PrevInBundle = BundleMember; 8784 } 8785 assert(Bundle && "Failed to find schedule bundle"); 8786 return Bundle; 8787 } 8788 8789 // Groups the instructions to a bundle (which is then a single scheduling entity) 8790 // and schedules instructions until the bundle gets ready. 8791 Optional<BoUpSLP::ScheduleData *> 8792 BoUpSLP::BlockScheduling::tryScheduleBundle(ArrayRef<Value *> VL, BoUpSLP *SLP, 8793 const InstructionsState &S) { 8794 // No need to schedule PHIs, insertelement, extractelement and extractvalue 8795 // instructions. 8796 if (isa<PHINode>(S.OpValue) || isVectorLikeInstWithConstOps(S.OpValue) || 8797 doesNotNeedToSchedule(VL)) 8798 return nullptr; 8799 8800 // Initialize the instruction bundle. 8801 Instruction *OldScheduleEnd = ScheduleEnd; 8802 LLVM_DEBUG(dbgs() << "SLP: bundle: " << *S.OpValue << "\n"); 8803 8804 auto TryScheduleBundleImpl = [this, OldScheduleEnd, SLP](bool ReSchedule, 8805 ScheduleData *Bundle) { 8806 // The scheduling region got new instructions at the lower end (or it is a 8807 // new region for the first bundle). This makes it necessary to 8808 // recalculate all dependencies. 8809 // It is seldom that this needs to be done a second time after adding the 8810 // initial bundle to the region. 8811 if (ScheduleEnd != OldScheduleEnd) { 8812 for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) 8813 doForAllOpcodes(I, [](ScheduleData *SD) { SD->clearDependencies(); }); 8814 ReSchedule = true; 8815 } 8816 if (Bundle) { 8817 LLVM_DEBUG(dbgs() << "SLP: try schedule bundle " << *Bundle 8818 << " in block " << BB->getName() << "\n"); 8819 calculateDependencies(Bundle, /*InsertInReadyList=*/true, SLP); 8820 } 8821 8822 if (ReSchedule) { 8823 resetSchedule(); 8824 initialFillReadyList(ReadyInsts); 8825 } 8826 8827 // Now try to schedule the new bundle or (if no bundle) just calculate 8828 // dependencies. As soon as the bundle is "ready" it means that there are no 8829 // cyclic dependencies and we can schedule it. Note that's important that we 8830 // don't "schedule" the bundle yet (see cancelScheduling). 8831 while (((!Bundle && ReSchedule) || (Bundle && !Bundle->isReady())) && 8832 !ReadyInsts.empty()) { 8833 ScheduleData *Picked = ReadyInsts.pop_back_val(); 8834 assert(Picked->isSchedulingEntity() && Picked->isReady() && 8835 "must be ready to schedule"); 8836 schedule(Picked, ReadyInsts); 8837 } 8838 }; 8839 8840 // Make sure that the scheduling region contains all 8841 // instructions of the bundle. 8842 for (Value *V : VL) { 8843 if (doesNotNeedToBeScheduled(V)) 8844 continue; 8845 if (!extendSchedulingRegion(V, S)) { 8846 // If the scheduling region got new instructions at the lower end (or it 8847 // is a new region for the first bundle). This makes it necessary to 8848 // recalculate all dependencies. 8849 // Otherwise the compiler may crash trying to incorrectly calculate 8850 // dependencies and emit instruction in the wrong order at the actual 8851 // scheduling. 8852 TryScheduleBundleImpl(/*ReSchedule=*/false, nullptr); 8853 return None; 8854 } 8855 } 8856 8857 bool ReSchedule = false; 8858 for (Value *V : VL) { 8859 if (doesNotNeedToBeScheduled(V)) 8860 continue; 8861 ScheduleData *BundleMember = getScheduleData(V); 8862 assert(BundleMember && 8863 "no ScheduleData for bundle member (maybe not in same basic block)"); 8864 8865 // Make sure we don't leave the pieces of the bundle in the ready list when 8866 // whole bundle might not be ready. 8867 ReadyInsts.remove(BundleMember); 8868 8869 if (!BundleMember->IsScheduled) 8870 continue; 8871 // A bundle member was scheduled as single instruction before and now 8872 // needs to be scheduled as part of the bundle. We just get rid of the 8873 // existing schedule. 8874 LLVM_DEBUG(dbgs() << "SLP: reset schedule because " << *BundleMember 8875 << " was already scheduled\n"); 8876 ReSchedule = true; 8877 } 8878 8879 auto *Bundle = buildBundle(VL); 8880 TryScheduleBundleImpl(ReSchedule, Bundle); 8881 if (!Bundle->isReady()) { 8882 cancelScheduling(VL, S.OpValue); 8883 return None; 8884 } 8885 return Bundle; 8886 } 8887 8888 void BoUpSLP::BlockScheduling::cancelScheduling(ArrayRef<Value *> VL, 8889 Value *OpValue) { 8890 if (isa<PHINode>(OpValue) || isVectorLikeInstWithConstOps(OpValue) || 8891 doesNotNeedToSchedule(VL)) 8892 return; 8893 8894 if (doesNotNeedToBeScheduled(OpValue)) 8895 OpValue = *find_if_not(VL, doesNotNeedToBeScheduled); 8896 ScheduleData *Bundle = getScheduleData(OpValue); 8897 LLVM_DEBUG(dbgs() << "SLP: cancel scheduling of " << *Bundle << "\n"); 8898 assert(!Bundle->IsScheduled && 8899 "Can't cancel bundle which is already scheduled"); 8900 assert(Bundle->isSchedulingEntity() && 8901 (Bundle->isPartOfBundle() || needToScheduleSingleInstruction(VL)) && 8902 "tried to unbundle something which is not a bundle"); 8903 8904 // Remove the bundle from the ready list. 8905 if (Bundle->isReady()) 8906 ReadyInsts.remove(Bundle); 8907 8908 // Un-bundle: make single instructions out of the bundle. 8909 ScheduleData *BundleMember = Bundle; 8910 while (BundleMember) { 8911 assert(BundleMember->FirstInBundle == Bundle && "corrupt bundle links"); 8912 BundleMember->FirstInBundle = BundleMember; 8913 ScheduleData *Next = BundleMember->NextInBundle; 8914 BundleMember->NextInBundle = nullptr; 8915 BundleMember->TE = nullptr; 8916 if (BundleMember->unscheduledDepsInBundle() == 0) { 8917 ReadyInsts.insert(BundleMember); 8918 } 8919 BundleMember = Next; 8920 } 8921 } 8922 8923 BoUpSLP::ScheduleData *BoUpSLP::BlockScheduling::allocateScheduleDataChunks() { 8924 // Allocate a new ScheduleData for the instruction. 8925 if (ChunkPos >= ChunkSize) { 8926 ScheduleDataChunks.push_back(std::make_unique<ScheduleData[]>(ChunkSize)); 8927 ChunkPos = 0; 8928 } 8929 return &(ScheduleDataChunks.back()[ChunkPos++]); 8930 } 8931 8932 bool BoUpSLP::BlockScheduling::extendSchedulingRegion(Value *V, 8933 const InstructionsState &S) { 8934 if (getScheduleData(V, isOneOf(S, V))) 8935 return true; 8936 Instruction *I = dyn_cast<Instruction>(V); 8937 assert(I && "bundle member must be an instruction"); 8938 assert(!isa<PHINode>(I) && !isVectorLikeInstWithConstOps(I) && 8939 !doesNotNeedToBeScheduled(I) && 8940 "phi nodes/insertelements/extractelements/extractvalues don't need to " 8941 "be scheduled"); 8942 auto &&CheckScheduleForI = [this, &S](Instruction *I) -> bool { 8943 ScheduleData *ISD = getScheduleData(I); 8944 if (!ISD) 8945 return false; 8946 assert(isInSchedulingRegion(ISD) && 8947 "ScheduleData not in scheduling region"); 8948 ScheduleData *SD = allocateScheduleDataChunks(); 8949 SD->Inst = I; 8950 SD->init(SchedulingRegionID, S.OpValue); 8951 ExtraScheduleDataMap[I][S.OpValue] = SD; 8952 return true; 8953 }; 8954 if (CheckScheduleForI(I)) 8955 return true; 8956 if (!ScheduleStart) { 8957 // It's the first instruction in the new region. 8958 initScheduleData(I, I->getNextNode(), nullptr, nullptr); 8959 ScheduleStart = I; 8960 ScheduleEnd = I->getNextNode(); 8961 if (isOneOf(S, I) != I) 8962 CheckScheduleForI(I); 8963 assert(ScheduleEnd && "tried to vectorize a terminator?"); 8964 LLVM_DEBUG(dbgs() << "SLP: initialize schedule region to " << *I << "\n"); 8965 return true; 8966 } 8967 // Search up and down at the same time, because we don't know if the new 8968 // instruction is above or below the existing scheduling region. 8969 BasicBlock::reverse_iterator UpIter = 8970 ++ScheduleStart->getIterator().getReverse(); 8971 BasicBlock::reverse_iterator UpperEnd = BB->rend(); 8972 BasicBlock::iterator DownIter = ScheduleEnd->getIterator(); 8973 BasicBlock::iterator LowerEnd = BB->end(); 8974 while (UpIter != UpperEnd && DownIter != LowerEnd && &*UpIter != I && 8975 &*DownIter != I) { 8976 if (++ScheduleRegionSize > ScheduleRegionSizeLimit) { 8977 LLVM_DEBUG(dbgs() << "SLP: exceeded schedule region size limit\n"); 8978 return false; 8979 } 8980 8981 ++UpIter; 8982 ++DownIter; 8983 } 8984 if (DownIter == LowerEnd || (UpIter != UpperEnd && &*UpIter == I)) { 8985 assert(I->getParent() == ScheduleStart->getParent() && 8986 "Instruction is in wrong basic block."); 8987 initScheduleData(I, ScheduleStart, nullptr, FirstLoadStoreInRegion); 8988 ScheduleStart = I; 8989 if (isOneOf(S, I) != I) 8990 CheckScheduleForI(I); 8991 LLVM_DEBUG(dbgs() << "SLP: extend schedule region start to " << *I 8992 << "\n"); 8993 return true; 8994 } 8995 assert((UpIter == UpperEnd || (DownIter != LowerEnd && &*DownIter == I)) && 8996 "Expected to reach top of the basic block or instruction down the " 8997 "lower end."); 8998 assert(I->getParent() == ScheduleEnd->getParent() && 8999 "Instruction is in wrong basic block."); 9000 initScheduleData(ScheduleEnd, I->getNextNode(), LastLoadStoreInRegion, 9001 nullptr); 9002 ScheduleEnd = I->getNextNode(); 9003 if (isOneOf(S, I) != I) 9004 CheckScheduleForI(I); 9005 assert(ScheduleEnd && "tried to vectorize a terminator?"); 9006 LLVM_DEBUG(dbgs() << "SLP: extend schedule region end to " << *I << "\n"); 9007 return true; 9008 } 9009 9010 void BoUpSLP::BlockScheduling::initScheduleData(Instruction *FromI, 9011 Instruction *ToI, 9012 ScheduleData *PrevLoadStore, 9013 ScheduleData *NextLoadStore) { 9014 ScheduleData *CurrentLoadStore = PrevLoadStore; 9015 for (Instruction *I = FromI; I != ToI; I = I->getNextNode()) { 9016 // No need to allocate data for non-schedulable instructions. 9017 if (doesNotNeedToBeScheduled(I)) 9018 continue; 9019 ScheduleData *SD = ScheduleDataMap.lookup(I); 9020 if (!SD) { 9021 SD = allocateScheduleDataChunks(); 9022 ScheduleDataMap[I] = SD; 9023 SD->Inst = I; 9024 } 9025 assert(!isInSchedulingRegion(SD) && 9026 "new ScheduleData already in scheduling region"); 9027 SD->init(SchedulingRegionID, I); 9028 9029 if (I->mayReadOrWriteMemory() && 9030 (!isa<IntrinsicInst>(I) || 9031 (cast<IntrinsicInst>(I)->getIntrinsicID() != Intrinsic::sideeffect && 9032 cast<IntrinsicInst>(I)->getIntrinsicID() != 9033 Intrinsic::pseudoprobe))) { 9034 // Update the linked list of memory accessing instructions. 9035 if (CurrentLoadStore) { 9036 CurrentLoadStore->NextLoadStore = SD; 9037 } else { 9038 FirstLoadStoreInRegion = SD; 9039 } 9040 CurrentLoadStore = SD; 9041 } 9042 9043 if (match(I, m_Intrinsic<Intrinsic::stacksave>()) || 9044 match(I, m_Intrinsic<Intrinsic::stackrestore>())) 9045 RegionHasStackSave = true; 9046 } 9047 if (NextLoadStore) { 9048 if (CurrentLoadStore) 9049 CurrentLoadStore->NextLoadStore = NextLoadStore; 9050 } else { 9051 LastLoadStoreInRegion = CurrentLoadStore; 9052 } 9053 } 9054 9055 void BoUpSLP::BlockScheduling::calculateDependencies(ScheduleData *SD, 9056 bool InsertInReadyList, 9057 BoUpSLP *SLP) { 9058 assert(SD->isSchedulingEntity()); 9059 9060 SmallVector<ScheduleData *, 10> WorkList; 9061 WorkList.push_back(SD); 9062 9063 while (!WorkList.empty()) { 9064 ScheduleData *SD = WorkList.pop_back_val(); 9065 for (ScheduleData *BundleMember = SD; BundleMember; 9066 BundleMember = BundleMember->NextInBundle) { 9067 assert(isInSchedulingRegion(BundleMember)); 9068 if (BundleMember->hasValidDependencies()) 9069 continue; 9070 9071 LLVM_DEBUG(dbgs() << "SLP: update deps of " << *BundleMember 9072 << "\n"); 9073 BundleMember->Dependencies = 0; 9074 BundleMember->resetUnscheduledDeps(); 9075 9076 // Handle def-use chain dependencies. 9077 if (BundleMember->OpValue != BundleMember->Inst) { 9078 if (ScheduleData *UseSD = getScheduleData(BundleMember->Inst)) { 9079 BundleMember->Dependencies++; 9080 ScheduleData *DestBundle = UseSD->FirstInBundle; 9081 if (!DestBundle->IsScheduled) 9082 BundleMember->incrementUnscheduledDeps(1); 9083 if (!DestBundle->hasValidDependencies()) 9084 WorkList.push_back(DestBundle); 9085 } 9086 } else { 9087 for (User *U : BundleMember->Inst->users()) { 9088 if (ScheduleData *UseSD = getScheduleData(cast<Instruction>(U))) { 9089 BundleMember->Dependencies++; 9090 ScheduleData *DestBundle = UseSD->FirstInBundle; 9091 if (!DestBundle->IsScheduled) 9092 BundleMember->incrementUnscheduledDeps(1); 9093 if (!DestBundle->hasValidDependencies()) 9094 WorkList.push_back(DestBundle); 9095 } 9096 } 9097 } 9098 9099 auto makeControlDependent = [&](Instruction *I) { 9100 auto *DepDest = getScheduleData(I); 9101 assert(DepDest && "must be in schedule window"); 9102 DepDest->ControlDependencies.push_back(BundleMember); 9103 BundleMember->Dependencies++; 9104 ScheduleData *DestBundle = DepDest->FirstInBundle; 9105 if (!DestBundle->IsScheduled) 9106 BundleMember->incrementUnscheduledDeps(1); 9107 if (!DestBundle->hasValidDependencies()) 9108 WorkList.push_back(DestBundle); 9109 }; 9110 9111 // Any instruction which isn't safe to speculate at the begining of the 9112 // block is control dependend on any early exit or non-willreturn call 9113 // which proceeds it. 9114 if (!isGuaranteedToTransferExecutionToSuccessor(BundleMember->Inst)) { 9115 for (Instruction *I = BundleMember->Inst->getNextNode(); 9116 I != ScheduleEnd; I = I->getNextNode()) { 9117 if (isSafeToSpeculativelyExecute(I, &*BB->begin())) 9118 continue; 9119 9120 // Add the dependency 9121 makeControlDependent(I); 9122 9123 if (!isGuaranteedToTransferExecutionToSuccessor(I)) 9124 // Everything past here must be control dependent on I. 9125 break; 9126 } 9127 } 9128 9129 if (RegionHasStackSave) { 9130 // If we have an inalloc alloca instruction, it needs to be scheduled 9131 // after any preceeding stacksave. We also need to prevent any alloca 9132 // from reordering above a preceeding stackrestore. 9133 if (match(BundleMember->Inst, m_Intrinsic<Intrinsic::stacksave>()) || 9134 match(BundleMember->Inst, m_Intrinsic<Intrinsic::stackrestore>())) { 9135 for (Instruction *I = BundleMember->Inst->getNextNode(); 9136 I != ScheduleEnd; I = I->getNextNode()) { 9137 if (match(I, m_Intrinsic<Intrinsic::stacksave>()) || 9138 match(I, m_Intrinsic<Intrinsic::stackrestore>())) 9139 // Any allocas past here must be control dependent on I, and I 9140 // must be memory dependend on BundleMember->Inst. 9141 break; 9142 9143 if (!isa<AllocaInst>(I)) 9144 continue; 9145 9146 // Add the dependency 9147 makeControlDependent(I); 9148 } 9149 } 9150 9151 // In addition to the cases handle just above, we need to prevent 9152 // allocas from moving below a stacksave. The stackrestore case 9153 // is currently thought to be conservatism. 9154 if (isa<AllocaInst>(BundleMember->Inst)) { 9155 for (Instruction *I = BundleMember->Inst->getNextNode(); 9156 I != ScheduleEnd; I = I->getNextNode()) { 9157 if (!match(I, m_Intrinsic<Intrinsic::stacksave>()) && 9158 !match(I, m_Intrinsic<Intrinsic::stackrestore>())) 9159 continue; 9160 9161 // Add the dependency 9162 makeControlDependent(I); 9163 break; 9164 } 9165 } 9166 } 9167 9168 // Handle the memory dependencies (if any). 9169 ScheduleData *DepDest = BundleMember->NextLoadStore; 9170 if (!DepDest) 9171 continue; 9172 Instruction *SrcInst = BundleMember->Inst; 9173 assert(SrcInst->mayReadOrWriteMemory() && 9174 "NextLoadStore list for non memory effecting bundle?"); 9175 MemoryLocation SrcLoc = getLocation(SrcInst); 9176 bool SrcMayWrite = BundleMember->Inst->mayWriteToMemory(); 9177 unsigned numAliased = 0; 9178 unsigned DistToSrc = 1; 9179 9180 for ( ; DepDest; DepDest = DepDest->NextLoadStore) { 9181 assert(isInSchedulingRegion(DepDest)); 9182 9183 // We have two limits to reduce the complexity: 9184 // 1) AliasedCheckLimit: It's a small limit to reduce calls to 9185 // SLP->isAliased (which is the expensive part in this loop). 9186 // 2) MaxMemDepDistance: It's for very large blocks and it aborts 9187 // the whole loop (even if the loop is fast, it's quadratic). 9188 // It's important for the loop break condition (see below) to 9189 // check this limit even between two read-only instructions. 9190 if (DistToSrc >= MaxMemDepDistance || 9191 ((SrcMayWrite || DepDest->Inst->mayWriteToMemory()) && 9192 (numAliased >= AliasedCheckLimit || 9193 SLP->isAliased(SrcLoc, SrcInst, DepDest->Inst)))) { 9194 9195 // We increment the counter only if the locations are aliased 9196 // (instead of counting all alias checks). This gives a better 9197 // balance between reduced runtime and accurate dependencies. 9198 numAliased++; 9199 9200 DepDest->MemoryDependencies.push_back(BundleMember); 9201 BundleMember->Dependencies++; 9202 ScheduleData *DestBundle = DepDest->FirstInBundle; 9203 if (!DestBundle->IsScheduled) { 9204 BundleMember->incrementUnscheduledDeps(1); 9205 } 9206 if (!DestBundle->hasValidDependencies()) { 9207 WorkList.push_back(DestBundle); 9208 } 9209 } 9210 9211 // Example, explaining the loop break condition: Let's assume our 9212 // starting instruction is i0 and MaxMemDepDistance = 3. 9213 // 9214 // +--------v--v--v 9215 // i0,i1,i2,i3,i4,i5,i6,i7,i8 9216 // +--------^--^--^ 9217 // 9218 // MaxMemDepDistance let us stop alias-checking at i3 and we add 9219 // dependencies from i0 to i3,i4,.. (even if they are not aliased). 9220 // Previously we already added dependencies from i3 to i6,i7,i8 9221 // (because of MaxMemDepDistance). As we added a dependency from 9222 // i0 to i3, we have transitive dependencies from i0 to i6,i7,i8 9223 // and we can abort this loop at i6. 9224 if (DistToSrc >= 2 * MaxMemDepDistance) 9225 break; 9226 DistToSrc++; 9227 } 9228 } 9229 if (InsertInReadyList && SD->isReady()) { 9230 ReadyInsts.insert(SD); 9231 LLVM_DEBUG(dbgs() << "SLP: gets ready on update: " << *SD->Inst 9232 << "\n"); 9233 } 9234 } 9235 } 9236 9237 void BoUpSLP::BlockScheduling::resetSchedule() { 9238 assert(ScheduleStart && 9239 "tried to reset schedule on block which has not been scheduled"); 9240 for (Instruction *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 9241 doForAllOpcodes(I, [&](ScheduleData *SD) { 9242 assert(isInSchedulingRegion(SD) && 9243 "ScheduleData not in scheduling region"); 9244 SD->IsScheduled = false; 9245 SD->resetUnscheduledDeps(); 9246 }); 9247 } 9248 ReadyInsts.clear(); 9249 } 9250 9251 void BoUpSLP::scheduleBlock(BlockScheduling *BS) { 9252 if (!BS->ScheduleStart) 9253 return; 9254 9255 LLVM_DEBUG(dbgs() << "SLP: schedule block " << BS->BB->getName() << "\n"); 9256 9257 // A key point - if we got here, pre-scheduling was able to find a valid 9258 // scheduling of the sub-graph of the scheduling window which consists 9259 // of all vector bundles and their transitive users. As such, we do not 9260 // need to reschedule anything *outside of* that subgraph. 9261 9262 BS->resetSchedule(); 9263 9264 // For the real scheduling we use a more sophisticated ready-list: it is 9265 // sorted by the original instruction location. This lets the final schedule 9266 // be as close as possible to the original instruction order. 9267 // WARNING: If changing this order causes a correctness issue, that means 9268 // there is some missing dependence edge in the schedule data graph. 9269 struct ScheduleDataCompare { 9270 bool operator()(ScheduleData *SD1, ScheduleData *SD2) const { 9271 return SD2->SchedulingPriority < SD1->SchedulingPriority; 9272 } 9273 }; 9274 std::set<ScheduleData *, ScheduleDataCompare> ReadyInsts; 9275 9276 // Ensure that all dependency data is updated (for nodes in the sub-graph) 9277 // and fill the ready-list with initial instructions. 9278 int Idx = 0; 9279 for (auto *I = BS->ScheduleStart; I != BS->ScheduleEnd; 9280 I = I->getNextNode()) { 9281 BS->doForAllOpcodes(I, [this, &Idx, BS](ScheduleData *SD) { 9282 TreeEntry *SDTE = getTreeEntry(SD->Inst); 9283 (void)SDTE; 9284 assert((isVectorLikeInstWithConstOps(SD->Inst) || 9285 SD->isPartOfBundle() == 9286 (SDTE && !doesNotNeedToSchedule(SDTE->Scalars))) && 9287 "scheduler and vectorizer bundle mismatch"); 9288 SD->FirstInBundle->SchedulingPriority = Idx++; 9289 9290 if (SD->isSchedulingEntity() && SD->isPartOfBundle()) 9291 BS->calculateDependencies(SD, false, this); 9292 }); 9293 } 9294 BS->initialFillReadyList(ReadyInsts); 9295 9296 Instruction *LastScheduledInst = BS->ScheduleEnd; 9297 9298 // Do the "real" scheduling. 9299 while (!ReadyInsts.empty()) { 9300 ScheduleData *picked = *ReadyInsts.begin(); 9301 ReadyInsts.erase(ReadyInsts.begin()); 9302 9303 // Move the scheduled instruction(s) to their dedicated places, if not 9304 // there yet. 9305 for (ScheduleData *BundleMember = picked; BundleMember; 9306 BundleMember = BundleMember->NextInBundle) { 9307 Instruction *pickedInst = BundleMember->Inst; 9308 if (pickedInst->getNextNode() != LastScheduledInst) 9309 pickedInst->moveBefore(LastScheduledInst); 9310 LastScheduledInst = pickedInst; 9311 } 9312 9313 BS->schedule(picked, ReadyInsts); 9314 } 9315 9316 // Check that we didn't break any of our invariants. 9317 #ifdef EXPENSIVE_CHECKS 9318 BS->verify(); 9319 #endif 9320 9321 #if !defined(NDEBUG) || defined(EXPENSIVE_CHECKS) 9322 // Check that all schedulable entities got scheduled 9323 for (auto *I = BS->ScheduleStart; I != BS->ScheduleEnd; I = I->getNextNode()) { 9324 BS->doForAllOpcodes(I, [&](ScheduleData *SD) { 9325 if (SD->isSchedulingEntity() && SD->hasValidDependencies()) { 9326 assert(SD->IsScheduled && "must be scheduled at this point"); 9327 } 9328 }); 9329 } 9330 #endif 9331 9332 // Avoid duplicate scheduling of the block. 9333 BS->ScheduleStart = nullptr; 9334 } 9335 9336 unsigned BoUpSLP::getVectorElementSize(Value *V) { 9337 // If V is a store, just return the width of the stored value (or value 9338 // truncated just before storing) without traversing the expression tree. 9339 // This is the common case. 9340 if (auto *Store = dyn_cast<StoreInst>(V)) 9341 return DL->getTypeSizeInBits(Store->getValueOperand()->getType()); 9342 9343 if (auto *IEI = dyn_cast<InsertElementInst>(V)) 9344 return getVectorElementSize(IEI->getOperand(1)); 9345 9346 auto E = InstrElementSize.find(V); 9347 if (E != InstrElementSize.end()) 9348 return E->second; 9349 9350 // If V is not a store, we can traverse the expression tree to find loads 9351 // that feed it. The type of the loaded value may indicate a more suitable 9352 // width than V's type. We want to base the vector element size on the width 9353 // of memory operations where possible. 9354 SmallVector<std::pair<Instruction *, BasicBlock *>, 16> Worklist; 9355 SmallPtrSet<Instruction *, 16> Visited; 9356 if (auto *I = dyn_cast<Instruction>(V)) { 9357 Worklist.emplace_back(I, I->getParent()); 9358 Visited.insert(I); 9359 } 9360 9361 // Traverse the expression tree in bottom-up order looking for loads. If we 9362 // encounter an instruction we don't yet handle, we give up. 9363 auto Width = 0u; 9364 while (!Worklist.empty()) { 9365 Instruction *I; 9366 BasicBlock *Parent; 9367 std::tie(I, Parent) = Worklist.pop_back_val(); 9368 9369 // We should only be looking at scalar instructions here. If the current 9370 // instruction has a vector type, skip. 9371 auto *Ty = I->getType(); 9372 if (isa<VectorType>(Ty)) 9373 continue; 9374 9375 // If the current instruction is a load, update MaxWidth to reflect the 9376 // width of the loaded value. 9377 if (isa<LoadInst>(I) || isa<ExtractElementInst>(I) || 9378 isa<ExtractValueInst>(I)) 9379 Width = std::max<unsigned>(Width, DL->getTypeSizeInBits(Ty)); 9380 9381 // Otherwise, we need to visit the operands of the instruction. We only 9382 // handle the interesting cases from buildTree here. If an operand is an 9383 // instruction we haven't yet visited and from the same basic block as the 9384 // user or the use is a PHI node, we add it to the worklist. 9385 else if (isa<PHINode>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) || 9386 isa<CmpInst>(I) || isa<SelectInst>(I) || isa<BinaryOperator>(I) || 9387 isa<UnaryOperator>(I)) { 9388 for (Use &U : I->operands()) 9389 if (auto *J = dyn_cast<Instruction>(U.get())) 9390 if (Visited.insert(J).second && 9391 (isa<PHINode>(I) || J->getParent() == Parent)) 9392 Worklist.emplace_back(J, J->getParent()); 9393 } else { 9394 break; 9395 } 9396 } 9397 9398 // If we didn't encounter a memory access in the expression tree, or if we 9399 // gave up for some reason, just return the width of V. Otherwise, return the 9400 // maximum width we found. 9401 if (!Width) { 9402 if (auto *CI = dyn_cast<CmpInst>(V)) 9403 V = CI->getOperand(0); 9404 Width = DL->getTypeSizeInBits(V->getType()); 9405 } 9406 9407 for (Instruction *I : Visited) 9408 InstrElementSize[I] = Width; 9409 9410 return Width; 9411 } 9412 9413 // Determine if a value V in a vectorizable expression Expr can be demoted to a 9414 // smaller type with a truncation. We collect the values that will be demoted 9415 // in ToDemote and additional roots that require investigating in Roots. 9416 static bool collectValuesToDemote(Value *V, SmallPtrSetImpl<Value *> &Expr, 9417 SmallVectorImpl<Value *> &ToDemote, 9418 SmallVectorImpl<Value *> &Roots) { 9419 // We can always demote constants. 9420 if (isa<Constant>(V)) { 9421 ToDemote.push_back(V); 9422 return true; 9423 } 9424 9425 // If the value is not an instruction in the expression with only one use, it 9426 // cannot be demoted. 9427 auto *I = dyn_cast<Instruction>(V); 9428 if (!I || !I->hasOneUse() || !Expr.count(I)) 9429 return false; 9430 9431 switch (I->getOpcode()) { 9432 9433 // We can always demote truncations and extensions. Since truncations can 9434 // seed additional demotion, we save the truncated value. 9435 case Instruction::Trunc: 9436 Roots.push_back(I->getOperand(0)); 9437 break; 9438 case Instruction::ZExt: 9439 case Instruction::SExt: 9440 if (isa<ExtractElementInst>(I->getOperand(0)) || 9441 isa<InsertElementInst>(I->getOperand(0))) 9442 return false; 9443 break; 9444 9445 // We can demote certain binary operations if we can demote both of their 9446 // operands. 9447 case Instruction::Add: 9448 case Instruction::Sub: 9449 case Instruction::Mul: 9450 case Instruction::And: 9451 case Instruction::Or: 9452 case Instruction::Xor: 9453 if (!collectValuesToDemote(I->getOperand(0), Expr, ToDemote, Roots) || 9454 !collectValuesToDemote(I->getOperand(1), Expr, ToDemote, Roots)) 9455 return false; 9456 break; 9457 9458 // We can demote selects if we can demote their true and false values. 9459 case Instruction::Select: { 9460 SelectInst *SI = cast<SelectInst>(I); 9461 if (!collectValuesToDemote(SI->getTrueValue(), Expr, ToDemote, Roots) || 9462 !collectValuesToDemote(SI->getFalseValue(), Expr, ToDemote, Roots)) 9463 return false; 9464 break; 9465 } 9466 9467 // We can demote phis if we can demote all their incoming operands. Note that 9468 // we don't need to worry about cycles since we ensure single use above. 9469 case Instruction::PHI: { 9470 PHINode *PN = cast<PHINode>(I); 9471 for (Value *IncValue : PN->incoming_values()) 9472 if (!collectValuesToDemote(IncValue, Expr, ToDemote, Roots)) 9473 return false; 9474 break; 9475 } 9476 9477 // Otherwise, conservatively give up. 9478 default: 9479 return false; 9480 } 9481 9482 // Record the value that we can demote. 9483 ToDemote.push_back(V); 9484 return true; 9485 } 9486 9487 void BoUpSLP::computeMinimumValueSizes() { 9488 // If there are no external uses, the expression tree must be rooted by a 9489 // store. We can't demote in-memory values, so there is nothing to do here. 9490 if (ExternalUses.empty()) 9491 return; 9492 9493 // We only attempt to truncate integer expressions. 9494 auto &TreeRoot = VectorizableTree[0]->Scalars; 9495 auto *TreeRootIT = dyn_cast<IntegerType>(TreeRoot[0]->getType()); 9496 if (!TreeRootIT) 9497 return; 9498 9499 // If the expression is not rooted by a store, these roots should have 9500 // external uses. We will rely on InstCombine to rewrite the expression in 9501 // the narrower type. However, InstCombine only rewrites single-use values. 9502 // This means that if a tree entry other than a root is used externally, it 9503 // must have multiple uses and InstCombine will not rewrite it. The code 9504 // below ensures that only the roots are used externally. 9505 SmallPtrSet<Value *, 32> Expr(TreeRoot.begin(), TreeRoot.end()); 9506 for (auto &EU : ExternalUses) 9507 if (!Expr.erase(EU.Scalar)) 9508 return; 9509 if (!Expr.empty()) 9510 return; 9511 9512 // Collect the scalar values of the vectorizable expression. We will use this 9513 // context to determine which values can be demoted. If we see a truncation, 9514 // we mark it as seeding another demotion. 9515 for (auto &EntryPtr : VectorizableTree) 9516 Expr.insert(EntryPtr->Scalars.begin(), EntryPtr->Scalars.end()); 9517 9518 // Ensure the roots of the vectorizable tree don't form a cycle. They must 9519 // have a single external user that is not in the vectorizable tree. 9520 for (auto *Root : TreeRoot) 9521 if (!Root->hasOneUse() || Expr.count(*Root->user_begin())) 9522 return; 9523 9524 // Conservatively determine if we can actually truncate the roots of the 9525 // expression. Collect the values that can be demoted in ToDemote and 9526 // additional roots that require investigating in Roots. 9527 SmallVector<Value *, 32> ToDemote; 9528 SmallVector<Value *, 4> Roots; 9529 for (auto *Root : TreeRoot) 9530 if (!collectValuesToDemote(Root, Expr, ToDemote, Roots)) 9531 return; 9532 9533 // The maximum bit width required to represent all the values that can be 9534 // demoted without loss of precision. It would be safe to truncate the roots 9535 // of the expression to this width. 9536 auto MaxBitWidth = 8u; 9537 9538 // We first check if all the bits of the roots are demanded. If they're not, 9539 // we can truncate the roots to this narrower type. 9540 for (auto *Root : TreeRoot) { 9541 auto Mask = DB->getDemandedBits(cast<Instruction>(Root)); 9542 MaxBitWidth = std::max<unsigned>( 9543 Mask.getBitWidth() - Mask.countLeadingZeros(), MaxBitWidth); 9544 } 9545 9546 // True if the roots can be zero-extended back to their original type, rather 9547 // than sign-extended. We know that if the leading bits are not demanded, we 9548 // can safely zero-extend. So we initialize IsKnownPositive to True. 9549 bool IsKnownPositive = true; 9550 9551 // If all the bits of the roots are demanded, we can try a little harder to 9552 // compute a narrower type. This can happen, for example, if the roots are 9553 // getelementptr indices. InstCombine promotes these indices to the pointer 9554 // width. Thus, all their bits are technically demanded even though the 9555 // address computation might be vectorized in a smaller type. 9556 // 9557 // We start by looking at each entry that can be demoted. We compute the 9558 // maximum bit width required to store the scalar by using ValueTracking to 9559 // compute the number of high-order bits we can truncate. 9560 if (MaxBitWidth == DL->getTypeSizeInBits(TreeRoot[0]->getType()) && 9561 llvm::all_of(TreeRoot, [](Value *R) { 9562 assert(R->hasOneUse() && "Root should have only one use!"); 9563 return isa<GetElementPtrInst>(R->user_back()); 9564 })) { 9565 MaxBitWidth = 8u; 9566 9567 // Determine if the sign bit of all the roots is known to be zero. If not, 9568 // IsKnownPositive is set to False. 9569 IsKnownPositive = llvm::all_of(TreeRoot, [&](Value *R) { 9570 KnownBits Known = computeKnownBits(R, *DL); 9571 return Known.isNonNegative(); 9572 }); 9573 9574 // Determine the maximum number of bits required to store the scalar 9575 // values. 9576 for (auto *Scalar : ToDemote) { 9577 auto NumSignBits = ComputeNumSignBits(Scalar, *DL, 0, AC, nullptr, DT); 9578 auto NumTypeBits = DL->getTypeSizeInBits(Scalar->getType()); 9579 MaxBitWidth = std::max<unsigned>(NumTypeBits - NumSignBits, MaxBitWidth); 9580 } 9581 9582 // If we can't prove that the sign bit is zero, we must add one to the 9583 // maximum bit width to account for the unknown sign bit. This preserves 9584 // the existing sign bit so we can safely sign-extend the root back to the 9585 // original type. Otherwise, if we know the sign bit is zero, we will 9586 // zero-extend the root instead. 9587 // 9588 // FIXME: This is somewhat suboptimal, as there will be cases where adding 9589 // one to the maximum bit width will yield a larger-than-necessary 9590 // type. In general, we need to add an extra bit only if we can't 9591 // prove that the upper bit of the original type is equal to the 9592 // upper bit of the proposed smaller type. If these two bits are the 9593 // same (either zero or one) we know that sign-extending from the 9594 // smaller type will result in the same value. Here, since we can't 9595 // yet prove this, we are just making the proposed smaller type 9596 // larger to ensure correctness. 9597 if (!IsKnownPositive) 9598 ++MaxBitWidth; 9599 } 9600 9601 // Round MaxBitWidth up to the next power-of-two. 9602 if (!isPowerOf2_64(MaxBitWidth)) 9603 MaxBitWidth = NextPowerOf2(MaxBitWidth); 9604 9605 // If the maximum bit width we compute is less than the with of the roots' 9606 // type, we can proceed with the narrowing. Otherwise, do nothing. 9607 if (MaxBitWidth >= TreeRootIT->getBitWidth()) 9608 return; 9609 9610 // If we can truncate the root, we must collect additional values that might 9611 // be demoted as a result. That is, those seeded by truncations we will 9612 // modify. 9613 while (!Roots.empty()) 9614 collectValuesToDemote(Roots.pop_back_val(), Expr, ToDemote, Roots); 9615 9616 // Finally, map the values we can demote to the maximum bit with we computed. 9617 for (auto *Scalar : ToDemote) 9618 MinBWs[Scalar] = std::make_pair(MaxBitWidth, !IsKnownPositive); 9619 } 9620 9621 namespace { 9622 9623 /// The SLPVectorizer Pass. 9624 struct SLPVectorizer : public FunctionPass { 9625 SLPVectorizerPass Impl; 9626 9627 /// Pass identification, replacement for typeid 9628 static char ID; 9629 9630 explicit SLPVectorizer() : FunctionPass(ID) { 9631 initializeSLPVectorizerPass(*PassRegistry::getPassRegistry()); 9632 } 9633 9634 bool doInitialization(Module &M) override { return false; } 9635 9636 bool runOnFunction(Function &F) override { 9637 if (skipFunction(F)) 9638 return false; 9639 9640 auto *SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE(); 9641 auto *TTI = &getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F); 9642 auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>(); 9643 auto *TLI = TLIP ? &TLIP->getTLI(F) : nullptr; 9644 auto *AA = &getAnalysis<AAResultsWrapperPass>().getAAResults(); 9645 auto *LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo(); 9646 auto *DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 9647 auto *AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F); 9648 auto *DB = &getAnalysis<DemandedBitsWrapperPass>().getDemandedBits(); 9649 auto *ORE = &getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE(); 9650 9651 return Impl.runImpl(F, SE, TTI, TLI, AA, LI, DT, AC, DB, ORE); 9652 } 9653 9654 void getAnalysisUsage(AnalysisUsage &AU) const override { 9655 FunctionPass::getAnalysisUsage(AU); 9656 AU.addRequired<AssumptionCacheTracker>(); 9657 AU.addRequired<ScalarEvolutionWrapperPass>(); 9658 AU.addRequired<AAResultsWrapperPass>(); 9659 AU.addRequired<TargetTransformInfoWrapperPass>(); 9660 AU.addRequired<LoopInfoWrapperPass>(); 9661 AU.addRequired<DominatorTreeWrapperPass>(); 9662 AU.addRequired<DemandedBitsWrapperPass>(); 9663 AU.addRequired<OptimizationRemarkEmitterWrapperPass>(); 9664 AU.addRequired<InjectTLIMappingsLegacy>(); 9665 AU.addPreserved<LoopInfoWrapperPass>(); 9666 AU.addPreserved<DominatorTreeWrapperPass>(); 9667 AU.addPreserved<AAResultsWrapperPass>(); 9668 AU.addPreserved<GlobalsAAWrapperPass>(); 9669 AU.setPreservesCFG(); 9670 } 9671 }; 9672 9673 } // end anonymous namespace 9674 9675 PreservedAnalyses SLPVectorizerPass::run(Function &F, FunctionAnalysisManager &AM) { 9676 auto *SE = &AM.getResult<ScalarEvolutionAnalysis>(F); 9677 auto *TTI = &AM.getResult<TargetIRAnalysis>(F); 9678 auto *TLI = AM.getCachedResult<TargetLibraryAnalysis>(F); 9679 auto *AA = &AM.getResult<AAManager>(F); 9680 auto *LI = &AM.getResult<LoopAnalysis>(F); 9681 auto *DT = &AM.getResult<DominatorTreeAnalysis>(F); 9682 auto *AC = &AM.getResult<AssumptionAnalysis>(F); 9683 auto *DB = &AM.getResult<DemandedBitsAnalysis>(F); 9684 auto *ORE = &AM.getResult<OptimizationRemarkEmitterAnalysis>(F); 9685 9686 bool Changed = runImpl(F, SE, TTI, TLI, AA, LI, DT, AC, DB, ORE); 9687 if (!Changed) 9688 return PreservedAnalyses::all(); 9689 9690 PreservedAnalyses PA; 9691 PA.preserveSet<CFGAnalyses>(); 9692 return PA; 9693 } 9694 9695 bool SLPVectorizerPass::runImpl(Function &F, ScalarEvolution *SE_, 9696 TargetTransformInfo *TTI_, 9697 TargetLibraryInfo *TLI_, AAResults *AA_, 9698 LoopInfo *LI_, DominatorTree *DT_, 9699 AssumptionCache *AC_, DemandedBits *DB_, 9700 OptimizationRemarkEmitter *ORE_) { 9701 if (!RunSLPVectorization) 9702 return false; 9703 SE = SE_; 9704 TTI = TTI_; 9705 TLI = TLI_; 9706 AA = AA_; 9707 LI = LI_; 9708 DT = DT_; 9709 AC = AC_; 9710 DB = DB_; 9711 DL = &F.getParent()->getDataLayout(); 9712 9713 Stores.clear(); 9714 GEPs.clear(); 9715 bool Changed = false; 9716 9717 // If the target claims to have no vector registers don't attempt 9718 // vectorization. 9719 if (!TTI->getNumberOfRegisters(TTI->getRegisterClassForType(true))) { 9720 LLVM_DEBUG( 9721 dbgs() << "SLP: Didn't find any vector registers for target, abort.\n"); 9722 return false; 9723 } 9724 9725 // Don't vectorize when the attribute NoImplicitFloat is used. 9726 if (F.hasFnAttribute(Attribute::NoImplicitFloat)) 9727 return false; 9728 9729 LLVM_DEBUG(dbgs() << "SLP: Analyzing blocks in " << F.getName() << ".\n"); 9730 9731 // Use the bottom up slp vectorizer to construct chains that start with 9732 // store instructions. 9733 BoUpSLP R(&F, SE, TTI, TLI, AA, LI, DT, AC, DB, DL, ORE_); 9734 9735 // A general note: the vectorizer must use BoUpSLP::eraseInstruction() to 9736 // delete instructions. 9737 9738 // Update DFS numbers now so that we can use them for ordering. 9739 DT->updateDFSNumbers(); 9740 9741 // Scan the blocks in the function in post order. 9742 for (auto BB : post_order(&F.getEntryBlock())) { 9743 // Start new block - clear the list of reduction roots. 9744 R.clearReductionData(); 9745 collectSeedInstructions(BB); 9746 9747 // Vectorize trees that end at stores. 9748 if (!Stores.empty()) { 9749 LLVM_DEBUG(dbgs() << "SLP: Found stores for " << Stores.size() 9750 << " underlying objects.\n"); 9751 Changed |= vectorizeStoreChains(R); 9752 } 9753 9754 // Vectorize trees that end at reductions. 9755 Changed |= vectorizeChainsInBlock(BB, R); 9756 9757 // Vectorize the index computations of getelementptr instructions. This 9758 // is primarily intended to catch gather-like idioms ending at 9759 // non-consecutive loads. 9760 if (!GEPs.empty()) { 9761 LLVM_DEBUG(dbgs() << "SLP: Found GEPs for " << GEPs.size() 9762 << " underlying objects.\n"); 9763 Changed |= vectorizeGEPIndices(BB, R); 9764 } 9765 } 9766 9767 if (Changed) { 9768 R.optimizeGatherSequence(); 9769 LLVM_DEBUG(dbgs() << "SLP: vectorized \"" << F.getName() << "\"\n"); 9770 } 9771 return Changed; 9772 } 9773 9774 bool SLPVectorizerPass::vectorizeStoreChain(ArrayRef<Value *> Chain, BoUpSLP &R, 9775 unsigned Idx, unsigned MinVF) { 9776 LLVM_DEBUG(dbgs() << "SLP: Analyzing a store chain of length " << Chain.size() 9777 << "\n"); 9778 const unsigned Sz = R.getVectorElementSize(Chain[0]); 9779 unsigned VF = Chain.size(); 9780 9781 if (!isPowerOf2_32(Sz) || !isPowerOf2_32(VF) || VF < 2 || VF < MinVF) 9782 return false; 9783 9784 LLVM_DEBUG(dbgs() << "SLP: Analyzing " << VF << " stores at offset " << Idx 9785 << "\n"); 9786 9787 R.buildTree(Chain); 9788 if (R.isTreeTinyAndNotFullyVectorizable()) 9789 return false; 9790 if (R.isLoadCombineCandidate()) 9791 return false; 9792 R.reorderTopToBottom(); 9793 R.reorderBottomToTop(); 9794 R.buildExternalUses(); 9795 9796 R.computeMinimumValueSizes(); 9797 9798 InstructionCost Cost = R.getTreeCost(); 9799 9800 LLVM_DEBUG(dbgs() << "SLP: Found cost = " << Cost << " for VF =" << VF << "\n"); 9801 if (Cost < -SLPCostThreshold) { 9802 LLVM_DEBUG(dbgs() << "SLP: Decided to vectorize cost = " << Cost << "\n"); 9803 9804 using namespace ore; 9805 9806 R.getORE()->emit(OptimizationRemark(SV_NAME, "StoresVectorized", 9807 cast<StoreInst>(Chain[0])) 9808 << "Stores SLP vectorized with cost " << NV("Cost", Cost) 9809 << " and with tree size " 9810 << NV("TreeSize", R.getTreeSize())); 9811 9812 R.vectorizeTree(); 9813 return true; 9814 } 9815 9816 return false; 9817 } 9818 9819 bool SLPVectorizerPass::vectorizeStores(ArrayRef<StoreInst *> Stores, 9820 BoUpSLP &R) { 9821 // We may run into multiple chains that merge into a single chain. We mark the 9822 // stores that we vectorized so that we don't visit the same store twice. 9823 BoUpSLP::ValueSet VectorizedStores; 9824 bool Changed = false; 9825 9826 int E = Stores.size(); 9827 SmallBitVector Tails(E, false); 9828 int MaxIter = MaxStoreLookup.getValue(); 9829 SmallVector<std::pair<int, int>, 16> ConsecutiveChain( 9830 E, std::make_pair(E, INT_MAX)); 9831 SmallVector<SmallBitVector, 4> CheckedPairs(E, SmallBitVector(E, false)); 9832 int IterCnt; 9833 auto &&FindConsecutiveAccess = [this, &Stores, &Tails, &IterCnt, MaxIter, 9834 &CheckedPairs, 9835 &ConsecutiveChain](int K, int Idx) { 9836 if (IterCnt >= MaxIter) 9837 return true; 9838 if (CheckedPairs[Idx].test(K)) 9839 return ConsecutiveChain[K].second == 1 && 9840 ConsecutiveChain[K].first == Idx; 9841 ++IterCnt; 9842 CheckedPairs[Idx].set(K); 9843 CheckedPairs[K].set(Idx); 9844 Optional<int> Diff = getPointersDiff( 9845 Stores[K]->getValueOperand()->getType(), Stores[K]->getPointerOperand(), 9846 Stores[Idx]->getValueOperand()->getType(), 9847 Stores[Idx]->getPointerOperand(), *DL, *SE, /*StrictCheck=*/true); 9848 if (!Diff || *Diff == 0) 9849 return false; 9850 int Val = *Diff; 9851 if (Val < 0) { 9852 if (ConsecutiveChain[Idx].second > -Val) { 9853 Tails.set(K); 9854 ConsecutiveChain[Idx] = std::make_pair(K, -Val); 9855 } 9856 return false; 9857 } 9858 if (ConsecutiveChain[K].second <= Val) 9859 return false; 9860 9861 Tails.set(Idx); 9862 ConsecutiveChain[K] = std::make_pair(Idx, Val); 9863 return Val == 1; 9864 }; 9865 // Do a quadratic search on all of the given stores in reverse order and find 9866 // all of the pairs of stores that follow each other. 9867 for (int Idx = E - 1; Idx >= 0; --Idx) { 9868 // If a store has multiple consecutive store candidates, search according 9869 // to the sequence: Idx-1, Idx+1, Idx-2, Idx+2, ... 9870 // This is because usually pairing with immediate succeeding or preceding 9871 // candidate create the best chance to find slp vectorization opportunity. 9872 const int MaxLookDepth = std::max(E - Idx, Idx + 1); 9873 IterCnt = 0; 9874 for (int Offset = 1, F = MaxLookDepth; Offset < F; ++Offset) 9875 if ((Idx >= Offset && FindConsecutiveAccess(Idx - Offset, Idx)) || 9876 (Idx + Offset < E && FindConsecutiveAccess(Idx + Offset, Idx))) 9877 break; 9878 } 9879 9880 // Tracks if we tried to vectorize stores starting from the given tail 9881 // already. 9882 SmallBitVector TriedTails(E, false); 9883 // For stores that start but don't end a link in the chain: 9884 for (int Cnt = E; Cnt > 0; --Cnt) { 9885 int I = Cnt - 1; 9886 if (ConsecutiveChain[I].first == E || Tails.test(I)) 9887 continue; 9888 // We found a store instr that starts a chain. Now follow the chain and try 9889 // to vectorize it. 9890 BoUpSLP::ValueList Operands; 9891 // Collect the chain into a list. 9892 while (I != E && !VectorizedStores.count(Stores[I])) { 9893 Operands.push_back(Stores[I]); 9894 Tails.set(I); 9895 if (ConsecutiveChain[I].second != 1) { 9896 // Mark the new end in the chain and go back, if required. It might be 9897 // required if the original stores come in reversed order, for example. 9898 if (ConsecutiveChain[I].first != E && 9899 Tails.test(ConsecutiveChain[I].first) && !TriedTails.test(I) && 9900 !VectorizedStores.count(Stores[ConsecutiveChain[I].first])) { 9901 TriedTails.set(I); 9902 Tails.reset(ConsecutiveChain[I].first); 9903 if (Cnt < ConsecutiveChain[I].first + 2) 9904 Cnt = ConsecutiveChain[I].first + 2; 9905 } 9906 break; 9907 } 9908 // Move to the next value in the chain. 9909 I = ConsecutiveChain[I].first; 9910 } 9911 assert(!Operands.empty() && "Expected non-empty list of stores."); 9912 9913 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 9914 unsigned EltSize = R.getVectorElementSize(Operands[0]); 9915 unsigned MaxElts = llvm::PowerOf2Floor(MaxVecRegSize / EltSize); 9916 9917 unsigned MaxVF = std::min(R.getMaximumVF(EltSize, Instruction::Store), 9918 MaxElts); 9919 auto *Store = cast<StoreInst>(Operands[0]); 9920 Type *StoreTy = Store->getValueOperand()->getType(); 9921 Type *ValueTy = StoreTy; 9922 if (auto *Trunc = dyn_cast<TruncInst>(Store->getValueOperand())) 9923 ValueTy = Trunc->getSrcTy(); 9924 unsigned MinVF = TTI->getStoreMinimumVF( 9925 R.getMinVF(DL->getTypeSizeInBits(ValueTy)), StoreTy, ValueTy); 9926 9927 // FIXME: Is division-by-2 the correct step? Should we assert that the 9928 // register size is a power-of-2? 9929 unsigned StartIdx = 0; 9930 for (unsigned Size = MaxVF; Size >= MinVF; Size /= 2) { 9931 for (unsigned Cnt = StartIdx, E = Operands.size(); Cnt + Size <= E;) { 9932 ArrayRef<Value *> Slice = makeArrayRef(Operands).slice(Cnt, Size); 9933 if (!VectorizedStores.count(Slice.front()) && 9934 !VectorizedStores.count(Slice.back()) && 9935 vectorizeStoreChain(Slice, R, Cnt, MinVF)) { 9936 // Mark the vectorized stores so that we don't vectorize them again. 9937 VectorizedStores.insert(Slice.begin(), Slice.end()); 9938 Changed = true; 9939 // If we vectorized initial block, no need to try to vectorize it 9940 // again. 9941 if (Cnt == StartIdx) 9942 StartIdx += Size; 9943 Cnt += Size; 9944 continue; 9945 } 9946 ++Cnt; 9947 } 9948 // Check if the whole array was vectorized already - exit. 9949 if (StartIdx >= Operands.size()) 9950 break; 9951 } 9952 } 9953 9954 return Changed; 9955 } 9956 9957 void SLPVectorizerPass::collectSeedInstructions(BasicBlock *BB) { 9958 // Initialize the collections. We will make a single pass over the block. 9959 Stores.clear(); 9960 GEPs.clear(); 9961 9962 // Visit the store and getelementptr instructions in BB and organize them in 9963 // Stores and GEPs according to the underlying objects of their pointer 9964 // operands. 9965 for (Instruction &I : *BB) { 9966 // Ignore store instructions that are volatile or have a pointer operand 9967 // that doesn't point to a scalar type. 9968 if (auto *SI = dyn_cast<StoreInst>(&I)) { 9969 if (!SI->isSimple()) 9970 continue; 9971 if (!isValidElementType(SI->getValueOperand()->getType())) 9972 continue; 9973 Stores[getUnderlyingObject(SI->getPointerOperand())].push_back(SI); 9974 } 9975 9976 // Ignore getelementptr instructions that have more than one index, a 9977 // constant index, or a pointer operand that doesn't point to a scalar 9978 // type. 9979 else if (auto *GEP = dyn_cast<GetElementPtrInst>(&I)) { 9980 auto Idx = GEP->idx_begin()->get(); 9981 if (GEP->getNumIndices() > 1 || isa<Constant>(Idx)) 9982 continue; 9983 if (!isValidElementType(Idx->getType())) 9984 continue; 9985 if (GEP->getType()->isVectorTy()) 9986 continue; 9987 GEPs[GEP->getPointerOperand()].push_back(GEP); 9988 } 9989 } 9990 } 9991 9992 bool SLPVectorizerPass::tryToVectorizePair(Value *A, Value *B, BoUpSLP &R) { 9993 if (!A || !B) 9994 return false; 9995 if (isa<InsertElementInst>(A) || isa<InsertElementInst>(B)) 9996 return false; 9997 Value *VL[] = {A, B}; 9998 return tryToVectorizeList(VL, R); 9999 } 10000 10001 bool SLPVectorizerPass::tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R, 10002 bool LimitForRegisterSize) { 10003 if (VL.size() < 2) 10004 return false; 10005 10006 LLVM_DEBUG(dbgs() << "SLP: Trying to vectorize a list of length = " 10007 << VL.size() << ".\n"); 10008 10009 // Check that all of the parts are instructions of the same type, 10010 // we permit an alternate opcode via InstructionsState. 10011 InstructionsState S = getSameOpcode(VL); 10012 if (!S.getOpcode()) 10013 return false; 10014 10015 Instruction *I0 = cast<Instruction>(S.OpValue); 10016 // Make sure invalid types (including vector type) are rejected before 10017 // determining vectorization factor for scalar instructions. 10018 for (Value *V : VL) { 10019 Type *Ty = V->getType(); 10020 if (!isa<InsertElementInst>(V) && !isValidElementType(Ty)) { 10021 // NOTE: the following will give user internal llvm type name, which may 10022 // not be useful. 10023 R.getORE()->emit([&]() { 10024 std::string type_str; 10025 llvm::raw_string_ostream rso(type_str); 10026 Ty->print(rso); 10027 return OptimizationRemarkMissed(SV_NAME, "UnsupportedType", I0) 10028 << "Cannot SLP vectorize list: type " 10029 << rso.str() + " is unsupported by vectorizer"; 10030 }); 10031 return false; 10032 } 10033 } 10034 10035 unsigned Sz = R.getVectorElementSize(I0); 10036 unsigned MinVF = R.getMinVF(Sz); 10037 unsigned MaxVF = std::max<unsigned>(PowerOf2Floor(VL.size()), MinVF); 10038 MaxVF = std::min(R.getMaximumVF(Sz, S.getOpcode()), MaxVF); 10039 if (MaxVF < 2) { 10040 R.getORE()->emit([&]() { 10041 return OptimizationRemarkMissed(SV_NAME, "SmallVF", I0) 10042 << "Cannot SLP vectorize list: vectorization factor " 10043 << "less than 2 is not supported"; 10044 }); 10045 return false; 10046 } 10047 10048 bool Changed = false; 10049 bool CandidateFound = false; 10050 InstructionCost MinCost = SLPCostThreshold.getValue(); 10051 Type *ScalarTy = VL[0]->getType(); 10052 if (auto *IE = dyn_cast<InsertElementInst>(VL[0])) 10053 ScalarTy = IE->getOperand(1)->getType(); 10054 10055 unsigned NextInst = 0, MaxInst = VL.size(); 10056 for (unsigned VF = MaxVF; NextInst + 1 < MaxInst && VF >= MinVF; VF /= 2) { 10057 // No actual vectorization should happen, if number of parts is the same as 10058 // provided vectorization factor (i.e. the scalar type is used for vector 10059 // code during codegen). 10060 auto *VecTy = FixedVectorType::get(ScalarTy, VF); 10061 if (TTI->getNumberOfParts(VecTy) == VF) 10062 continue; 10063 for (unsigned I = NextInst; I < MaxInst; ++I) { 10064 unsigned OpsWidth = 0; 10065 10066 if (I + VF > MaxInst) 10067 OpsWidth = MaxInst - I; 10068 else 10069 OpsWidth = VF; 10070 10071 if (!isPowerOf2_32(OpsWidth)) 10072 continue; 10073 10074 if ((LimitForRegisterSize && OpsWidth < MaxVF) || 10075 (VF > MinVF && OpsWidth <= VF / 2) || (VF == MinVF && OpsWidth < 2)) 10076 break; 10077 10078 ArrayRef<Value *> Ops = VL.slice(I, OpsWidth); 10079 // Check that a previous iteration of this loop did not delete the Value. 10080 if (llvm::any_of(Ops, [&R](Value *V) { 10081 auto *I = dyn_cast<Instruction>(V); 10082 return I && R.isDeleted(I); 10083 })) 10084 continue; 10085 10086 LLVM_DEBUG(dbgs() << "SLP: Analyzing " << OpsWidth << " operations " 10087 << "\n"); 10088 10089 R.buildTree(Ops); 10090 if (R.isTreeTinyAndNotFullyVectorizable()) 10091 continue; 10092 R.reorderTopToBottom(); 10093 R.reorderBottomToTop(!isa<InsertElementInst>(Ops.front())); 10094 R.buildExternalUses(); 10095 10096 R.computeMinimumValueSizes(); 10097 InstructionCost Cost = R.getTreeCost(); 10098 CandidateFound = true; 10099 MinCost = std::min(MinCost, Cost); 10100 10101 if (Cost < -SLPCostThreshold) { 10102 LLVM_DEBUG(dbgs() << "SLP: Vectorizing list at cost:" << Cost << ".\n"); 10103 R.getORE()->emit(OptimizationRemark(SV_NAME, "VectorizedList", 10104 cast<Instruction>(Ops[0])) 10105 << "SLP vectorized with cost " << ore::NV("Cost", Cost) 10106 << " and with tree size " 10107 << ore::NV("TreeSize", R.getTreeSize())); 10108 10109 R.vectorizeTree(); 10110 // Move to the next bundle. 10111 I += VF - 1; 10112 NextInst = I + 1; 10113 Changed = true; 10114 } 10115 } 10116 } 10117 10118 if (!Changed && CandidateFound) { 10119 R.getORE()->emit([&]() { 10120 return OptimizationRemarkMissed(SV_NAME, "NotBeneficial", I0) 10121 << "List vectorization was possible but not beneficial with cost " 10122 << ore::NV("Cost", MinCost) << " >= " 10123 << ore::NV("Treshold", -SLPCostThreshold); 10124 }); 10125 } else if (!Changed) { 10126 R.getORE()->emit([&]() { 10127 return OptimizationRemarkMissed(SV_NAME, "NotPossible", I0) 10128 << "Cannot SLP vectorize list: vectorization was impossible" 10129 << " with available vectorization factors"; 10130 }); 10131 } 10132 return Changed; 10133 } 10134 10135 bool SLPVectorizerPass::tryToVectorize(Instruction *I, BoUpSLP &R) { 10136 if (!I) 10137 return false; 10138 10139 if ((!isa<BinaryOperator>(I) && !isa<CmpInst>(I)) || 10140 isa<VectorType>(I->getType())) 10141 return false; 10142 10143 Value *P = I->getParent(); 10144 10145 // Vectorize in current basic block only. 10146 auto *Op0 = dyn_cast<Instruction>(I->getOperand(0)); 10147 auto *Op1 = dyn_cast<Instruction>(I->getOperand(1)); 10148 if (!Op0 || !Op1 || Op0->getParent() != P || Op1->getParent() != P) 10149 return false; 10150 10151 // First collect all possible candidates 10152 SmallVector<std::pair<Value *, Value *>, 4> Candidates; 10153 Candidates.emplace_back(Op0, Op1); 10154 10155 auto *A = dyn_cast<BinaryOperator>(Op0); 10156 auto *B = dyn_cast<BinaryOperator>(Op1); 10157 // Try to skip B. 10158 if (A && B && B->hasOneUse()) { 10159 auto *B0 = dyn_cast<BinaryOperator>(B->getOperand(0)); 10160 auto *B1 = dyn_cast<BinaryOperator>(B->getOperand(1)); 10161 if (B0 && B0->getParent() == P) 10162 Candidates.emplace_back(A, B0); 10163 if (B1 && B1->getParent() == P) 10164 Candidates.emplace_back(A, B1); 10165 } 10166 // Try to skip A. 10167 if (B && A && A->hasOneUse()) { 10168 auto *A0 = dyn_cast<BinaryOperator>(A->getOperand(0)); 10169 auto *A1 = dyn_cast<BinaryOperator>(A->getOperand(1)); 10170 if (A0 && A0->getParent() == P) 10171 Candidates.emplace_back(A0, B); 10172 if (A1 && A1->getParent() == P) 10173 Candidates.emplace_back(A1, B); 10174 } 10175 10176 if (Candidates.size() == 1) 10177 return tryToVectorizePair(Op0, Op1, R); 10178 10179 // We have multiple options. Try to pick the single best. 10180 Optional<int> BestCandidate = R.findBestRootPair(Candidates); 10181 if (!BestCandidate) 10182 return false; 10183 return tryToVectorizePair(Candidates[*BestCandidate].first, 10184 Candidates[*BestCandidate].second, R); 10185 } 10186 10187 namespace { 10188 10189 /// Model horizontal reductions. 10190 /// 10191 /// A horizontal reduction is a tree of reduction instructions that has values 10192 /// that can be put into a vector as its leaves. For example: 10193 /// 10194 /// mul mul mul mul 10195 /// \ / \ / 10196 /// + + 10197 /// \ / 10198 /// + 10199 /// This tree has "mul" as its leaf values and "+" as its reduction 10200 /// instructions. A reduction can feed into a store or a binary operation 10201 /// feeding a phi. 10202 /// ... 10203 /// \ / 10204 /// + 10205 /// | 10206 /// phi += 10207 /// 10208 /// Or: 10209 /// ... 10210 /// \ / 10211 /// + 10212 /// | 10213 /// *p = 10214 /// 10215 class HorizontalReduction { 10216 using ReductionOpsType = SmallVector<Value *, 16>; 10217 using ReductionOpsListType = SmallVector<ReductionOpsType, 2>; 10218 ReductionOpsListType ReductionOps; 10219 /// List of possibly reduced values. 10220 SmallVector<SmallVector<Value *>> ReducedVals; 10221 /// Maps reduced value to the corresponding reduction operation. 10222 DenseMap<Value *, SmallVector<Instruction *>> ReducedValsToOps; 10223 // Use map vector to make stable output. 10224 MapVector<Instruction *, Value *> ExtraArgs; 10225 WeakTrackingVH ReductionRoot; 10226 /// The type of reduction operation. 10227 RecurKind RdxKind; 10228 10229 static bool isCmpSelMinMax(Instruction *I) { 10230 return match(I, m_Select(m_Cmp(), m_Value(), m_Value())) && 10231 RecurrenceDescriptor::isMinMaxRecurrenceKind(getRdxKind(I)); 10232 } 10233 10234 // And/or are potentially poison-safe logical patterns like: 10235 // select x, y, false 10236 // select x, true, y 10237 static bool isBoolLogicOp(Instruction *I) { 10238 return match(I, m_LogicalAnd(m_Value(), m_Value())) || 10239 match(I, m_LogicalOr(m_Value(), m_Value())); 10240 } 10241 10242 /// Checks if instruction is associative and can be vectorized. 10243 static bool isVectorizable(RecurKind Kind, Instruction *I) { 10244 if (Kind == RecurKind::None) 10245 return false; 10246 10247 // Integer ops that map to select instructions or intrinsics are fine. 10248 if (RecurrenceDescriptor::isIntMinMaxRecurrenceKind(Kind) || 10249 isBoolLogicOp(I)) 10250 return true; 10251 10252 if (Kind == RecurKind::FMax || Kind == RecurKind::FMin) { 10253 // FP min/max are associative except for NaN and -0.0. We do not 10254 // have to rule out -0.0 here because the intrinsic semantics do not 10255 // specify a fixed result for it. 10256 return I->getFastMathFlags().noNaNs(); 10257 } 10258 10259 return I->isAssociative(); 10260 } 10261 10262 static Value *getRdxOperand(Instruction *I, unsigned Index) { 10263 // Poison-safe 'or' takes the form: select X, true, Y 10264 // To make that work with the normal operand processing, we skip the 10265 // true value operand. 10266 // TODO: Change the code and data structures to handle this without a hack. 10267 if (getRdxKind(I) == RecurKind::Or && isa<SelectInst>(I) && Index == 1) 10268 return I->getOperand(2); 10269 return I->getOperand(Index); 10270 } 10271 10272 /// Creates reduction operation with the current opcode. 10273 static Value *createOp(IRBuilder<> &Builder, RecurKind Kind, Value *LHS, 10274 Value *RHS, const Twine &Name, bool UseSelect) { 10275 unsigned RdxOpcode = RecurrenceDescriptor::getOpcode(Kind); 10276 switch (Kind) { 10277 case RecurKind::Or: 10278 if (UseSelect && 10279 LHS->getType() == CmpInst::makeCmpResultType(LHS->getType())) 10280 return Builder.CreateSelect(LHS, Builder.getTrue(), RHS, Name); 10281 return Builder.CreateBinOp((Instruction::BinaryOps)RdxOpcode, LHS, RHS, 10282 Name); 10283 case RecurKind::And: 10284 if (UseSelect && 10285 LHS->getType() == CmpInst::makeCmpResultType(LHS->getType())) 10286 return Builder.CreateSelect(LHS, RHS, Builder.getFalse(), Name); 10287 return Builder.CreateBinOp((Instruction::BinaryOps)RdxOpcode, LHS, RHS, 10288 Name); 10289 case RecurKind::Add: 10290 case RecurKind::Mul: 10291 case RecurKind::Xor: 10292 case RecurKind::FAdd: 10293 case RecurKind::FMul: 10294 return Builder.CreateBinOp((Instruction::BinaryOps)RdxOpcode, LHS, RHS, 10295 Name); 10296 case RecurKind::FMax: 10297 return Builder.CreateBinaryIntrinsic(Intrinsic::maxnum, LHS, RHS); 10298 case RecurKind::FMin: 10299 return Builder.CreateBinaryIntrinsic(Intrinsic::minnum, LHS, RHS); 10300 case RecurKind::SMax: 10301 if (UseSelect) { 10302 Value *Cmp = Builder.CreateICmpSGT(LHS, RHS, Name); 10303 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10304 } 10305 return Builder.CreateBinaryIntrinsic(Intrinsic::smax, LHS, RHS); 10306 case RecurKind::SMin: 10307 if (UseSelect) { 10308 Value *Cmp = Builder.CreateICmpSLT(LHS, RHS, Name); 10309 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10310 } 10311 return Builder.CreateBinaryIntrinsic(Intrinsic::smin, LHS, RHS); 10312 case RecurKind::UMax: 10313 if (UseSelect) { 10314 Value *Cmp = Builder.CreateICmpUGT(LHS, RHS, Name); 10315 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10316 } 10317 return Builder.CreateBinaryIntrinsic(Intrinsic::umax, LHS, RHS); 10318 case RecurKind::UMin: 10319 if (UseSelect) { 10320 Value *Cmp = Builder.CreateICmpULT(LHS, RHS, Name); 10321 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 10322 } 10323 return Builder.CreateBinaryIntrinsic(Intrinsic::umin, LHS, RHS); 10324 default: 10325 llvm_unreachable("Unknown reduction operation."); 10326 } 10327 } 10328 10329 /// Creates reduction operation with the current opcode with the IR flags 10330 /// from \p ReductionOps. 10331 static Value *createOp(IRBuilder<> &Builder, RecurKind RdxKind, Value *LHS, 10332 Value *RHS, const Twine &Name, 10333 const ReductionOpsListType &ReductionOps) { 10334 bool UseSelect = ReductionOps.size() == 2 || 10335 // Logical or/and. 10336 (ReductionOps.size() == 1 && 10337 isa<SelectInst>(ReductionOps.front().front())); 10338 assert((!UseSelect || ReductionOps.size() != 2 || 10339 isa<SelectInst>(ReductionOps[1][0])) && 10340 "Expected cmp + select pairs for reduction"); 10341 Value *Op = createOp(Builder, RdxKind, LHS, RHS, Name, UseSelect); 10342 if (RecurrenceDescriptor::isIntMinMaxRecurrenceKind(RdxKind)) { 10343 if (auto *Sel = dyn_cast<SelectInst>(Op)) { 10344 propagateIRFlags(Sel->getCondition(), ReductionOps[0]); 10345 propagateIRFlags(Op, ReductionOps[1]); 10346 return Op; 10347 } 10348 } 10349 propagateIRFlags(Op, ReductionOps[0]); 10350 return Op; 10351 } 10352 10353 /// Creates reduction operation with the current opcode with the IR flags 10354 /// from \p I. 10355 static Value *createOp(IRBuilder<> &Builder, RecurKind RdxKind, Value *LHS, 10356 Value *RHS, const Twine &Name, Value *I) { 10357 auto *SelI = dyn_cast<SelectInst>(I); 10358 Value *Op = createOp(Builder, RdxKind, LHS, RHS, Name, SelI != nullptr); 10359 if (SelI && RecurrenceDescriptor::isIntMinMaxRecurrenceKind(RdxKind)) { 10360 if (auto *Sel = dyn_cast<SelectInst>(Op)) 10361 propagateIRFlags(Sel->getCondition(), SelI->getCondition()); 10362 } 10363 propagateIRFlags(Op, I); 10364 return Op; 10365 } 10366 10367 static RecurKind getRdxKind(Value *V) { 10368 auto *I = dyn_cast<Instruction>(V); 10369 if (!I) 10370 return RecurKind::None; 10371 if (match(I, m_Add(m_Value(), m_Value()))) 10372 return RecurKind::Add; 10373 if (match(I, m_Mul(m_Value(), m_Value()))) 10374 return RecurKind::Mul; 10375 if (match(I, m_And(m_Value(), m_Value())) || 10376 match(I, m_LogicalAnd(m_Value(), m_Value()))) 10377 return RecurKind::And; 10378 if (match(I, m_Or(m_Value(), m_Value())) || 10379 match(I, m_LogicalOr(m_Value(), m_Value()))) 10380 return RecurKind::Or; 10381 if (match(I, m_Xor(m_Value(), m_Value()))) 10382 return RecurKind::Xor; 10383 if (match(I, m_FAdd(m_Value(), m_Value()))) 10384 return RecurKind::FAdd; 10385 if (match(I, m_FMul(m_Value(), m_Value()))) 10386 return RecurKind::FMul; 10387 10388 if (match(I, m_Intrinsic<Intrinsic::maxnum>(m_Value(), m_Value()))) 10389 return RecurKind::FMax; 10390 if (match(I, m_Intrinsic<Intrinsic::minnum>(m_Value(), m_Value()))) 10391 return RecurKind::FMin; 10392 10393 // This matches either cmp+select or intrinsics. SLP is expected to handle 10394 // either form. 10395 // TODO: If we are canonicalizing to intrinsics, we can remove several 10396 // special-case paths that deal with selects. 10397 if (match(I, m_SMax(m_Value(), m_Value()))) 10398 return RecurKind::SMax; 10399 if (match(I, m_SMin(m_Value(), m_Value()))) 10400 return RecurKind::SMin; 10401 if (match(I, m_UMax(m_Value(), m_Value()))) 10402 return RecurKind::UMax; 10403 if (match(I, m_UMin(m_Value(), m_Value()))) 10404 return RecurKind::UMin; 10405 10406 if (auto *Select = dyn_cast<SelectInst>(I)) { 10407 // Try harder: look for min/max pattern based on instructions producing 10408 // same values such as: select ((cmp Inst1, Inst2), Inst1, Inst2). 10409 // During the intermediate stages of SLP, it's very common to have 10410 // pattern like this (since optimizeGatherSequence is run only once 10411 // at the end): 10412 // %1 = extractelement <2 x i32> %a, i32 0 10413 // %2 = extractelement <2 x i32> %a, i32 1 10414 // %cond = icmp sgt i32 %1, %2 10415 // %3 = extractelement <2 x i32> %a, i32 0 10416 // %4 = extractelement <2 x i32> %a, i32 1 10417 // %select = select i1 %cond, i32 %3, i32 %4 10418 CmpInst::Predicate Pred; 10419 Instruction *L1; 10420 Instruction *L2; 10421 10422 Value *LHS = Select->getTrueValue(); 10423 Value *RHS = Select->getFalseValue(); 10424 Value *Cond = Select->getCondition(); 10425 10426 // TODO: Support inverse predicates. 10427 if (match(Cond, m_Cmp(Pred, m_Specific(LHS), m_Instruction(L2)))) { 10428 if (!isa<ExtractElementInst>(RHS) || 10429 !L2->isIdenticalTo(cast<Instruction>(RHS))) 10430 return RecurKind::None; 10431 } else if (match(Cond, m_Cmp(Pred, m_Instruction(L1), m_Specific(RHS)))) { 10432 if (!isa<ExtractElementInst>(LHS) || 10433 !L1->isIdenticalTo(cast<Instruction>(LHS))) 10434 return RecurKind::None; 10435 } else { 10436 if (!isa<ExtractElementInst>(LHS) || !isa<ExtractElementInst>(RHS)) 10437 return RecurKind::None; 10438 if (!match(Cond, m_Cmp(Pred, m_Instruction(L1), m_Instruction(L2))) || 10439 !L1->isIdenticalTo(cast<Instruction>(LHS)) || 10440 !L2->isIdenticalTo(cast<Instruction>(RHS))) 10441 return RecurKind::None; 10442 } 10443 10444 switch (Pred) { 10445 default: 10446 return RecurKind::None; 10447 case CmpInst::ICMP_SGT: 10448 case CmpInst::ICMP_SGE: 10449 return RecurKind::SMax; 10450 case CmpInst::ICMP_SLT: 10451 case CmpInst::ICMP_SLE: 10452 return RecurKind::SMin; 10453 case CmpInst::ICMP_UGT: 10454 case CmpInst::ICMP_UGE: 10455 return RecurKind::UMax; 10456 case CmpInst::ICMP_ULT: 10457 case CmpInst::ICMP_ULE: 10458 return RecurKind::UMin; 10459 } 10460 } 10461 return RecurKind::None; 10462 } 10463 10464 /// Get the index of the first operand. 10465 static unsigned getFirstOperandIndex(Instruction *I) { 10466 return isCmpSelMinMax(I) ? 1 : 0; 10467 } 10468 10469 /// Total number of operands in the reduction operation. 10470 static unsigned getNumberOfOperands(Instruction *I) { 10471 return isCmpSelMinMax(I) ? 3 : 2; 10472 } 10473 10474 /// Checks if the instruction is in basic block \p BB. 10475 /// For a cmp+sel min/max reduction check that both ops are in \p BB. 10476 static bool hasSameParent(Instruction *I, BasicBlock *BB) { 10477 if (isCmpSelMinMax(I) || (isBoolLogicOp(I) && isa<SelectInst>(I))) { 10478 auto *Sel = cast<SelectInst>(I); 10479 auto *Cmp = dyn_cast<Instruction>(Sel->getCondition()); 10480 return Sel->getParent() == BB && Cmp && Cmp->getParent() == BB; 10481 } 10482 return I->getParent() == BB; 10483 } 10484 10485 /// Expected number of uses for reduction operations/reduced values. 10486 static bool hasRequiredNumberOfUses(bool IsCmpSelMinMax, Instruction *I) { 10487 if (IsCmpSelMinMax) { 10488 // SelectInst must be used twice while the condition op must have single 10489 // use only. 10490 if (auto *Sel = dyn_cast<SelectInst>(I)) 10491 return Sel->hasNUses(2) && Sel->getCondition()->hasOneUse(); 10492 return I->hasNUses(2); 10493 } 10494 10495 // Arithmetic reduction operation must be used once only. 10496 return I->hasOneUse(); 10497 } 10498 10499 /// Initializes the list of reduction operations. 10500 void initReductionOps(Instruction *I) { 10501 if (isCmpSelMinMax(I)) 10502 ReductionOps.assign(2, ReductionOpsType()); 10503 else 10504 ReductionOps.assign(1, ReductionOpsType()); 10505 } 10506 10507 /// Add all reduction operations for the reduction instruction \p I. 10508 void addReductionOps(Instruction *I) { 10509 if (isCmpSelMinMax(I)) { 10510 ReductionOps[0].emplace_back(cast<SelectInst>(I)->getCondition()); 10511 ReductionOps[1].emplace_back(I); 10512 } else { 10513 ReductionOps[0].emplace_back(I); 10514 } 10515 } 10516 10517 static Value *getLHS(RecurKind Kind, Instruction *I) { 10518 if (Kind == RecurKind::None) 10519 return nullptr; 10520 return I->getOperand(getFirstOperandIndex(I)); 10521 } 10522 static Value *getRHS(RecurKind Kind, Instruction *I) { 10523 if (Kind == RecurKind::None) 10524 return nullptr; 10525 return I->getOperand(getFirstOperandIndex(I) + 1); 10526 } 10527 10528 public: 10529 HorizontalReduction() = default; 10530 10531 /// Try to find a reduction tree. 10532 bool matchAssociativeReduction(PHINode *Phi, Instruction *Inst, 10533 ScalarEvolution &SE, const DataLayout &DL, 10534 const TargetLibraryInfo &TLI) { 10535 assert((!Phi || is_contained(Phi->operands(), Inst)) && 10536 "Phi needs to use the binary operator"); 10537 assert((isa<BinaryOperator>(Inst) || isa<SelectInst>(Inst) || 10538 isa<IntrinsicInst>(Inst)) && 10539 "Expected binop, select, or intrinsic for reduction matching"); 10540 RdxKind = getRdxKind(Inst); 10541 10542 // We could have a initial reductions that is not an add. 10543 // r *= v1 + v2 + v3 + v4 10544 // In such a case start looking for a tree rooted in the first '+'. 10545 if (Phi) { 10546 if (getLHS(RdxKind, Inst) == Phi) { 10547 Phi = nullptr; 10548 Inst = dyn_cast<Instruction>(getRHS(RdxKind, Inst)); 10549 if (!Inst) 10550 return false; 10551 RdxKind = getRdxKind(Inst); 10552 } else if (getRHS(RdxKind, Inst) == Phi) { 10553 Phi = nullptr; 10554 Inst = dyn_cast<Instruction>(getLHS(RdxKind, Inst)); 10555 if (!Inst) 10556 return false; 10557 RdxKind = getRdxKind(Inst); 10558 } 10559 } 10560 10561 if (!isVectorizable(RdxKind, Inst)) 10562 return false; 10563 10564 // Analyze "regular" integer/FP types for reductions - no target-specific 10565 // types or pointers. 10566 Type *Ty = Inst->getType(); 10567 if (!isValidElementType(Ty) || Ty->isPointerTy()) 10568 return false; 10569 10570 // Though the ultimate reduction may have multiple uses, its condition must 10571 // have only single use. 10572 if (auto *Sel = dyn_cast<SelectInst>(Inst)) 10573 if (!Sel->getCondition()->hasOneUse()) 10574 return false; 10575 10576 ReductionRoot = Inst; 10577 10578 // Iterate through all the operands of the possible reduction tree and 10579 // gather all the reduced values, sorting them by their value id. 10580 BasicBlock *BB = Inst->getParent(); 10581 bool IsCmpSelMinMax = isCmpSelMinMax(Inst); 10582 SmallVector<Instruction *> Worklist(1, Inst); 10583 // Checks if the operands of the \p TreeN instruction are also reduction 10584 // operations or should be treated as reduced values or an extra argument, 10585 // which is not part of the reduction. 10586 auto &&CheckOperands = [this, IsCmpSelMinMax, 10587 BB](Instruction *TreeN, 10588 SmallVectorImpl<Value *> &ExtraArgs, 10589 SmallVectorImpl<Value *> &PossibleReducedVals, 10590 SmallVectorImpl<Instruction *> &ReductionOps) { 10591 for (int I = getFirstOperandIndex(TreeN), 10592 End = getNumberOfOperands(TreeN); 10593 I < End; ++I) { 10594 Value *EdgeVal = getRdxOperand(TreeN, I); 10595 ReducedValsToOps[EdgeVal].push_back(TreeN); 10596 auto *EdgeInst = dyn_cast<Instruction>(EdgeVal); 10597 // Edge has wrong parent - mark as an extra argument. 10598 if (EdgeInst && !isVectorLikeInstWithConstOps(EdgeInst) && 10599 !hasSameParent(EdgeInst, BB)) { 10600 ExtraArgs.push_back(EdgeVal); 10601 continue; 10602 } 10603 // If the edge is not an instruction, or it is different from the main 10604 // reduction opcode or has too many uses - possible reduced value. 10605 if (!EdgeInst || getRdxKind(EdgeInst) != RdxKind || 10606 IsCmpSelMinMax != isCmpSelMinMax(EdgeInst) || 10607 !hasRequiredNumberOfUses(IsCmpSelMinMax, EdgeInst) || 10608 !isVectorizable(getRdxKind(EdgeInst), EdgeInst)) { 10609 PossibleReducedVals.push_back(EdgeVal); 10610 continue; 10611 } 10612 ReductionOps.push_back(EdgeInst); 10613 } 10614 }; 10615 // Try to regroup reduced values so that it gets more profitable to try to 10616 // reduce them. Values are grouped by their value ids, instructions - by 10617 // instruction op id and/or alternate op id, plus do extra analysis for 10618 // loads (grouping them by the distabce between pointers) and cmp 10619 // instructions (grouping them by the predicate). 10620 MapVector<size_t, MapVector<size_t, MapVector<Value *, unsigned>>> 10621 PossibleReducedVals; 10622 initReductionOps(Inst); 10623 while (!Worklist.empty()) { 10624 Instruction *TreeN = Worklist.pop_back_val(); 10625 SmallVector<Value *> Args; 10626 SmallVector<Value *> PossibleRedVals; 10627 SmallVector<Instruction *> PossibleReductionOps; 10628 CheckOperands(TreeN, Args, PossibleRedVals, PossibleReductionOps); 10629 // If too many extra args - mark the instruction itself as a reduction 10630 // value, not a reduction operation. 10631 if (Args.size() < 2) { 10632 addReductionOps(TreeN); 10633 // Add extra args. 10634 if (!Args.empty()) { 10635 assert(Args.size() == 1 && "Expected only single argument."); 10636 ExtraArgs[TreeN] = Args.front(); 10637 } 10638 // Add reduction values. The values are sorted for better vectorization 10639 // results. 10640 for (Value *V : PossibleRedVals) { 10641 size_t Key, Idx; 10642 std::tie(Key, Idx) = generateKeySubkey( 10643 V, &TLI, 10644 [&PossibleReducedVals, &DL, &SE](size_t Key, LoadInst *LI) { 10645 for (const auto &LoadData : PossibleReducedVals[Key]) { 10646 auto *RLI = cast<LoadInst>(LoadData.second.front().first); 10647 if (getPointersDiff(RLI->getType(), RLI->getPointerOperand(), 10648 LI->getType(), LI->getPointerOperand(), 10649 DL, SE, /*StrictCheck=*/true)) 10650 return hash_value(RLI->getPointerOperand()); 10651 } 10652 return hash_value(LI->getPointerOperand()); 10653 }, 10654 /*AllowAlternate=*/false); 10655 ++PossibleReducedVals[Key][Idx] 10656 .insert(std::make_pair(V, 0)) 10657 .first->second; 10658 } 10659 Worklist.append(PossibleReductionOps.rbegin(), 10660 PossibleReductionOps.rend()); 10661 } else { 10662 size_t Key, Idx; 10663 std::tie(Key, Idx) = generateKeySubkey( 10664 TreeN, &TLI, 10665 [&PossibleReducedVals, &DL, &SE](size_t Key, LoadInst *LI) { 10666 for (const auto &LoadData : PossibleReducedVals[Key]) { 10667 auto *RLI = cast<LoadInst>(LoadData.second.front().first); 10668 if (getPointersDiff(RLI->getType(), RLI->getPointerOperand(), 10669 LI->getType(), LI->getPointerOperand(), DL, 10670 SE, /*StrictCheck=*/true)) 10671 return hash_value(RLI->getPointerOperand()); 10672 } 10673 return hash_value(LI->getPointerOperand()); 10674 }, 10675 /*AllowAlternate=*/false); 10676 ++PossibleReducedVals[Key][Idx] 10677 .insert(std::make_pair(TreeN, 0)) 10678 .first->second; 10679 } 10680 } 10681 auto PossibleReducedValsVect = PossibleReducedVals.takeVector(); 10682 // Sort values by the total number of values kinds to start the reduction 10683 // from the longest possible reduced values sequences. 10684 for (auto &PossibleReducedVals : PossibleReducedValsVect) { 10685 auto PossibleRedVals = PossibleReducedVals.second.takeVector(); 10686 SmallVector<SmallVector<Value *>> PossibleRedValsVect; 10687 for (auto It = PossibleRedVals.begin(), E = PossibleRedVals.end(); 10688 It != E; ++It) { 10689 PossibleRedValsVect.emplace_back(); 10690 auto RedValsVect = It->second.takeVector(); 10691 stable_sort(RedValsVect, [](const auto &P1, const auto &P2) { 10692 return P1.second < P2.second; 10693 }); 10694 for (const std::pair<Value *, unsigned> &Data : RedValsVect) 10695 PossibleRedValsVect.back().append(Data.second, Data.first); 10696 } 10697 stable_sort(PossibleRedValsVect, [](const auto &P1, const auto &P2) { 10698 return P1.size() > P2.size(); 10699 }); 10700 ReducedVals.emplace_back(); 10701 for (ArrayRef<Value *> Data : PossibleRedValsVect) 10702 ReducedVals.back().append(Data.rbegin(), Data.rend()); 10703 } 10704 // Sort the reduced values by number of same/alternate opcode and/or pointer 10705 // operand. 10706 stable_sort(ReducedVals, [](ArrayRef<Value *> P1, ArrayRef<Value *> P2) { 10707 return P1.size() > P2.size(); 10708 }); 10709 return true; 10710 } 10711 10712 /// Attempt to vectorize the tree found by matchAssociativeReduction. 10713 Value *tryToReduce(BoUpSLP &V, TargetTransformInfo *TTI) { 10714 constexpr int ReductionLimit = 4; 10715 constexpr unsigned RegMaxNumber = 4; 10716 constexpr unsigned RedValsMaxNumber = 128; 10717 // If there are a sufficient number of reduction values, reduce 10718 // to a nearby power-of-2. We can safely generate oversized 10719 // vectors and rely on the backend to split them to legal sizes. 10720 unsigned NumReducedVals = std::accumulate( 10721 ReducedVals.begin(), ReducedVals.end(), 0, 10722 [](int Num, ArrayRef<Value *> Vals) { return Num + Vals.size(); }); 10723 if (NumReducedVals < ReductionLimit) 10724 return nullptr; 10725 10726 IRBuilder<> Builder(cast<Instruction>(ReductionRoot)); 10727 10728 // Track the reduced values in case if they are replaced by extractelement 10729 // because of the vectorization. 10730 DenseMap<Value *, WeakTrackingVH> TrackedVals; 10731 BoUpSLP::ExtraValueToDebugLocsMap ExternallyUsedValues; 10732 // The same extra argument may be used several times, so log each attempt 10733 // to use it. 10734 for (const std::pair<Instruction *, Value *> &Pair : ExtraArgs) { 10735 assert(Pair.first && "DebugLoc must be set."); 10736 ExternallyUsedValues[Pair.second].push_back(Pair.first); 10737 TrackedVals.try_emplace(Pair.second, Pair.second); 10738 } 10739 10740 // The compare instruction of a min/max is the insertion point for new 10741 // instructions and may be replaced with a new compare instruction. 10742 auto &&GetCmpForMinMaxReduction = [](Instruction *RdxRootInst) { 10743 assert(isa<SelectInst>(RdxRootInst) && 10744 "Expected min/max reduction to have select root instruction"); 10745 Value *ScalarCond = cast<SelectInst>(RdxRootInst)->getCondition(); 10746 assert(isa<Instruction>(ScalarCond) && 10747 "Expected min/max reduction to have compare condition"); 10748 return cast<Instruction>(ScalarCond); 10749 }; 10750 10751 // The reduction root is used as the insertion point for new instructions, 10752 // so set it as externally used to prevent it from being deleted. 10753 ExternallyUsedValues[ReductionRoot]; 10754 SmallDenseSet<Value *> IgnoreList; 10755 for (ReductionOpsType &RdxOps : ReductionOps) 10756 for (Value *RdxOp : RdxOps) { 10757 if (!RdxOp) 10758 continue; 10759 IgnoreList.insert(RdxOp); 10760 } 10761 bool IsCmpSelMinMax = isCmpSelMinMax(cast<Instruction>(ReductionRoot)); 10762 10763 // Need to track reduced vals, they may be changed during vectorization of 10764 // subvectors. 10765 for (ArrayRef<Value *> Candidates : ReducedVals) 10766 for (Value *V : Candidates) 10767 TrackedVals.try_emplace(V, V); 10768 10769 DenseMap<Value *, unsigned> VectorizedVals; 10770 Value *VectorizedTree = nullptr; 10771 bool CheckForReusedReductionOps = false; 10772 // Try to vectorize elements based on their type. 10773 for (unsigned I = 0, E = ReducedVals.size(); I < E; ++I) { 10774 ArrayRef<Value *> OrigReducedVals = ReducedVals[I]; 10775 InstructionsState S = getSameOpcode(OrigReducedVals); 10776 SmallVector<Value *> Candidates; 10777 DenseMap<Value *, Value *> TrackedToOrig; 10778 for (unsigned Cnt = 0, Sz = OrigReducedVals.size(); Cnt < Sz; ++Cnt) { 10779 Value *RdxVal = TrackedVals.find(OrigReducedVals[Cnt])->second; 10780 // Check if the reduction value was not overriden by the extractelement 10781 // instruction because of the vectorization and exclude it, if it is not 10782 // compatible with other values. 10783 if (auto *Inst = dyn_cast<Instruction>(RdxVal)) 10784 if (isVectorLikeInstWithConstOps(Inst) && 10785 (!S.getOpcode() || !S.isOpcodeOrAlt(Inst))) 10786 continue; 10787 Candidates.push_back(RdxVal); 10788 TrackedToOrig.try_emplace(RdxVal, OrigReducedVals[Cnt]); 10789 } 10790 bool ShuffledExtracts = false; 10791 // Try to handle shuffled extractelements. 10792 if (S.getOpcode() == Instruction::ExtractElement && !S.isAltShuffle() && 10793 I + 1 < E) { 10794 InstructionsState NextS = getSameOpcode(ReducedVals[I + 1]); 10795 if (NextS.getOpcode() == Instruction::ExtractElement && 10796 !NextS.isAltShuffle()) { 10797 SmallVector<Value *> CommonCandidates(Candidates); 10798 for (Value *RV : ReducedVals[I + 1]) { 10799 Value *RdxVal = TrackedVals.find(RV)->second; 10800 // Check if the reduction value was not overriden by the 10801 // extractelement instruction because of the vectorization and 10802 // exclude it, if it is not compatible with other values. 10803 if (auto *Inst = dyn_cast<Instruction>(RdxVal)) 10804 if (!NextS.getOpcode() || !NextS.isOpcodeOrAlt(Inst)) 10805 continue; 10806 CommonCandidates.push_back(RdxVal); 10807 TrackedToOrig.try_emplace(RdxVal, RV); 10808 } 10809 SmallVector<int> Mask; 10810 if (isFixedVectorShuffle(CommonCandidates, Mask)) { 10811 ++I; 10812 Candidates.swap(CommonCandidates); 10813 ShuffledExtracts = true; 10814 } 10815 } 10816 } 10817 unsigned NumReducedVals = Candidates.size(); 10818 if (NumReducedVals < ReductionLimit) 10819 continue; 10820 10821 unsigned MaxVecRegSize = V.getMaxVecRegSize(); 10822 unsigned EltSize = V.getVectorElementSize(Candidates[0]); 10823 unsigned MaxElts = RegMaxNumber * PowerOf2Floor(MaxVecRegSize / EltSize); 10824 10825 unsigned ReduxWidth = std::min<unsigned>( 10826 PowerOf2Floor(NumReducedVals), std::max(RedValsMaxNumber, MaxElts)); 10827 unsigned Start = 0; 10828 unsigned Pos = Start; 10829 // Restarts vectorization attempt with lower vector factor. 10830 unsigned PrevReduxWidth = ReduxWidth; 10831 bool CheckForReusedReductionOpsLocal = false; 10832 auto &&AdjustReducedVals = [&Pos, &Start, &ReduxWidth, NumReducedVals, 10833 &CheckForReusedReductionOpsLocal, 10834 &PrevReduxWidth, &V, 10835 &IgnoreList](bool IgnoreVL = false) { 10836 bool IsAnyRedOpGathered = !IgnoreVL && V.isAnyGathered(IgnoreList); 10837 if (!CheckForReusedReductionOpsLocal && PrevReduxWidth == ReduxWidth) { 10838 // Check if any of the reduction ops are gathered. If so, worth 10839 // trying again with less number of reduction ops. 10840 CheckForReusedReductionOpsLocal |= IsAnyRedOpGathered; 10841 } 10842 ++Pos; 10843 if (Pos < NumReducedVals - ReduxWidth + 1) 10844 return IsAnyRedOpGathered; 10845 Pos = Start; 10846 ReduxWidth /= 2; 10847 return IsAnyRedOpGathered; 10848 }; 10849 while (Pos < NumReducedVals - ReduxWidth + 1 && 10850 ReduxWidth >= ReductionLimit) { 10851 // Dependency in tree of the reduction ops - drop this attempt, try 10852 // later. 10853 if (CheckForReusedReductionOpsLocal && PrevReduxWidth != ReduxWidth && 10854 Start == 0) { 10855 CheckForReusedReductionOps = true; 10856 break; 10857 } 10858 PrevReduxWidth = ReduxWidth; 10859 ArrayRef<Value *> VL(std::next(Candidates.begin(), Pos), ReduxWidth); 10860 // Beeing analyzed already - skip. 10861 if (V.areAnalyzedReductionVals(VL)) { 10862 (void)AdjustReducedVals(/*IgnoreVL=*/true); 10863 continue; 10864 } 10865 // Early exit if any of the reduction values were deleted during 10866 // previous vectorization attempts. 10867 if (any_of(VL, [&V](Value *RedVal) { 10868 auto *RedValI = dyn_cast<Instruction>(RedVal); 10869 if (!RedValI) 10870 return false; 10871 return V.isDeleted(RedValI); 10872 })) 10873 break; 10874 V.buildTree(VL, IgnoreList); 10875 if (V.isTreeTinyAndNotFullyVectorizable(/*ForReduction=*/true)) { 10876 if (!AdjustReducedVals()) 10877 V.analyzedReductionVals(VL); 10878 continue; 10879 } 10880 if (V.isLoadCombineReductionCandidate(RdxKind)) { 10881 if (!AdjustReducedVals()) 10882 V.analyzedReductionVals(VL); 10883 continue; 10884 } 10885 V.reorderTopToBottom(); 10886 // No need to reorder the root node at all. 10887 V.reorderBottomToTop(/*IgnoreReorder=*/true); 10888 // Keep extracted other reduction values, if they are used in the 10889 // vectorization trees. 10890 BoUpSLP::ExtraValueToDebugLocsMap LocalExternallyUsedValues( 10891 ExternallyUsedValues); 10892 for (unsigned Cnt = 0, Sz = ReducedVals.size(); Cnt < Sz; ++Cnt) { 10893 if (Cnt == I || (ShuffledExtracts && Cnt == I - 1)) 10894 continue; 10895 for_each(ReducedVals[Cnt], 10896 [&LocalExternallyUsedValues, &TrackedVals](Value *V) { 10897 if (isa<Instruction>(V)) 10898 LocalExternallyUsedValues[TrackedVals[V]]; 10899 }); 10900 } 10901 // Number of uses of the candidates in the vector of values. 10902 SmallDenseMap<Value *, unsigned> NumUses; 10903 for (unsigned Cnt = 0; Cnt < Pos; ++Cnt) { 10904 Value *V = Candidates[Cnt]; 10905 if (NumUses.count(V) > 0) 10906 continue; 10907 NumUses[V] = std::count(VL.begin(), VL.end(), V); 10908 } 10909 for (unsigned Cnt = Pos + ReduxWidth; Cnt < NumReducedVals; ++Cnt) { 10910 Value *V = Candidates[Cnt]; 10911 if (NumUses.count(V) > 0) 10912 continue; 10913 NumUses[V] = std::count(VL.begin(), VL.end(), V); 10914 } 10915 // Gather externally used values. 10916 SmallPtrSet<Value *, 4> Visited; 10917 for (unsigned Cnt = 0; Cnt < Pos; ++Cnt) { 10918 Value *V = Candidates[Cnt]; 10919 if (!Visited.insert(V).second) 10920 continue; 10921 unsigned NumOps = VectorizedVals.lookup(V) + NumUses[V]; 10922 if (NumOps != ReducedValsToOps.find(V)->second.size()) 10923 LocalExternallyUsedValues[V]; 10924 } 10925 for (unsigned Cnt = Pos + ReduxWidth; Cnt < NumReducedVals; ++Cnt) { 10926 Value *V = Candidates[Cnt]; 10927 if (!Visited.insert(V).second) 10928 continue; 10929 unsigned NumOps = VectorizedVals.lookup(V) + NumUses[V]; 10930 if (NumOps != ReducedValsToOps.find(V)->second.size()) 10931 LocalExternallyUsedValues[V]; 10932 } 10933 V.buildExternalUses(LocalExternallyUsedValues); 10934 10935 V.computeMinimumValueSizes(); 10936 10937 // Intersect the fast-math-flags from all reduction operations. 10938 FastMathFlags RdxFMF; 10939 RdxFMF.set(); 10940 for (Value *U : IgnoreList) 10941 if (auto *FPMO = dyn_cast<FPMathOperator>(U)) 10942 RdxFMF &= FPMO->getFastMathFlags(); 10943 // Estimate cost. 10944 InstructionCost TreeCost = V.getTreeCost(VL); 10945 InstructionCost ReductionCost = 10946 getReductionCost(TTI, VL, ReduxWidth, RdxFMF); 10947 InstructionCost Cost = TreeCost + ReductionCost; 10948 if (!Cost.isValid()) { 10949 LLVM_DEBUG(dbgs() << "Encountered invalid baseline cost.\n"); 10950 return nullptr; 10951 } 10952 if (Cost >= -SLPCostThreshold) { 10953 V.getORE()->emit([&]() { 10954 return OptimizationRemarkMissed( 10955 SV_NAME, "HorSLPNotBeneficial", 10956 ReducedValsToOps.find(VL[0])->second.front()) 10957 << "Vectorizing horizontal reduction is possible" 10958 << "but not beneficial with cost " << ore::NV("Cost", Cost) 10959 << " and threshold " 10960 << ore::NV("Threshold", -SLPCostThreshold); 10961 }); 10962 if (!AdjustReducedVals()) 10963 V.analyzedReductionVals(VL); 10964 continue; 10965 } 10966 10967 LLVM_DEBUG(dbgs() << "SLP: Vectorizing horizontal reduction at cost:" 10968 << Cost << ". (HorRdx)\n"); 10969 V.getORE()->emit([&]() { 10970 return OptimizationRemark( 10971 SV_NAME, "VectorizedHorizontalReduction", 10972 ReducedValsToOps.find(VL[0])->second.front()) 10973 << "Vectorized horizontal reduction with cost " 10974 << ore::NV("Cost", Cost) << " and with tree size " 10975 << ore::NV("TreeSize", V.getTreeSize()); 10976 }); 10977 10978 Builder.setFastMathFlags(RdxFMF); 10979 10980 // Vectorize a tree. 10981 Value *VectorizedRoot = V.vectorizeTree(LocalExternallyUsedValues); 10982 10983 // Emit a reduction. If the root is a select (min/max idiom), the insert 10984 // point is the compare condition of that select. 10985 Instruction *RdxRootInst = cast<Instruction>(ReductionRoot); 10986 if (IsCmpSelMinMax) 10987 Builder.SetInsertPoint(GetCmpForMinMaxReduction(RdxRootInst)); 10988 else 10989 Builder.SetInsertPoint(RdxRootInst); 10990 10991 // To prevent poison from leaking across what used to be sequential, 10992 // safe, scalar boolean logic operations, the reduction operand must be 10993 // frozen. 10994 if (isa<SelectInst>(RdxRootInst) && isBoolLogicOp(RdxRootInst)) 10995 VectorizedRoot = Builder.CreateFreeze(VectorizedRoot); 10996 10997 Value *ReducedSubTree = 10998 emitReduction(VectorizedRoot, Builder, ReduxWidth, TTI); 10999 11000 if (!VectorizedTree) { 11001 // Initialize the final value in the reduction. 11002 VectorizedTree = ReducedSubTree; 11003 } else { 11004 // Update the final value in the reduction. 11005 Builder.SetCurrentDebugLocation( 11006 cast<Instruction>(ReductionOps.front().front())->getDebugLoc()); 11007 VectorizedTree = createOp(Builder, RdxKind, VectorizedTree, 11008 ReducedSubTree, "op.rdx", ReductionOps); 11009 } 11010 // Count vectorized reduced values to exclude them from final reduction. 11011 for (Value *V : VL) 11012 ++VectorizedVals.try_emplace(TrackedToOrig.find(V)->second, 0) 11013 .first->getSecond(); 11014 Pos += ReduxWidth; 11015 Start = Pos; 11016 ReduxWidth = PowerOf2Floor(NumReducedVals - Pos); 11017 } 11018 } 11019 if (VectorizedTree) { 11020 // Finish the reduction. 11021 // Need to add extra arguments and not vectorized possible reduction 11022 // values. 11023 // Try to avoid dependencies between the scalar remainders after 11024 // reductions. 11025 auto &&FinalGen = 11026 [this, &Builder, 11027 &TrackedVals](ArrayRef<std::pair<Instruction *, Value *>> InstVals) { 11028 unsigned Sz = InstVals.size(); 11029 SmallVector<std::pair<Instruction *, Value *>> ExtraReds(Sz / 2 + 11030 Sz % 2); 11031 for (unsigned I = 0, E = (Sz / 2) * 2; I < E; I += 2) { 11032 Instruction *RedOp = InstVals[I + 1].first; 11033 Builder.SetCurrentDebugLocation(RedOp->getDebugLoc()); 11034 ReductionOpsListType Ops; 11035 if (auto *Sel = dyn_cast<SelectInst>(RedOp)) 11036 Ops.emplace_back().push_back(Sel->getCondition()); 11037 Ops.emplace_back().push_back(RedOp); 11038 Value *RdxVal1 = InstVals[I].second; 11039 Value *StableRdxVal1 = RdxVal1; 11040 auto It1 = TrackedVals.find(RdxVal1); 11041 if (It1 != TrackedVals.end()) 11042 StableRdxVal1 = It1->second; 11043 Value *RdxVal2 = InstVals[I + 1].second; 11044 Value *StableRdxVal2 = RdxVal2; 11045 auto It2 = TrackedVals.find(RdxVal2); 11046 if (It2 != TrackedVals.end()) 11047 StableRdxVal2 = It2->second; 11048 Value *ExtraRed = createOp(Builder, RdxKind, StableRdxVal1, 11049 StableRdxVal2, "op.rdx", Ops); 11050 ExtraReds[I / 2] = std::make_pair(InstVals[I].first, ExtraRed); 11051 } 11052 if (Sz % 2 == 1) 11053 ExtraReds[Sz / 2] = InstVals.back(); 11054 return ExtraReds; 11055 }; 11056 SmallVector<std::pair<Instruction *, Value *>> ExtraReductions; 11057 SmallPtrSet<Value *, 8> Visited; 11058 for (ArrayRef<Value *> Candidates : ReducedVals) { 11059 for (Value *RdxVal : Candidates) { 11060 if (!Visited.insert(RdxVal).second) 11061 continue; 11062 unsigned NumOps = VectorizedVals.lookup(RdxVal); 11063 for (Instruction *RedOp : 11064 makeArrayRef(ReducedValsToOps.find(RdxVal)->second) 11065 .drop_back(NumOps)) 11066 ExtraReductions.emplace_back(RedOp, RdxVal); 11067 } 11068 } 11069 for (auto &Pair : ExternallyUsedValues) { 11070 // Add each externally used value to the final reduction. 11071 for (auto *I : Pair.second) 11072 ExtraReductions.emplace_back(I, Pair.first); 11073 } 11074 // Iterate through all not-vectorized reduction values/extra arguments. 11075 while (ExtraReductions.size() > 1) { 11076 SmallVector<std::pair<Instruction *, Value *>> NewReds = 11077 FinalGen(ExtraReductions); 11078 ExtraReductions.swap(NewReds); 11079 } 11080 // Final reduction. 11081 if (ExtraReductions.size() == 1) { 11082 Instruction *RedOp = ExtraReductions.back().first; 11083 Builder.SetCurrentDebugLocation(RedOp->getDebugLoc()); 11084 ReductionOpsListType Ops; 11085 if (auto *Sel = dyn_cast<SelectInst>(RedOp)) 11086 Ops.emplace_back().push_back(Sel->getCondition()); 11087 Ops.emplace_back().push_back(RedOp); 11088 Value *RdxVal = ExtraReductions.back().second; 11089 Value *StableRdxVal = RdxVal; 11090 auto It = TrackedVals.find(RdxVal); 11091 if (It != TrackedVals.end()) 11092 StableRdxVal = It->second; 11093 VectorizedTree = createOp(Builder, RdxKind, VectorizedTree, 11094 StableRdxVal, "op.rdx", Ops); 11095 } 11096 11097 ReductionRoot->replaceAllUsesWith(VectorizedTree); 11098 11099 // The original scalar reduction is expected to have no remaining 11100 // uses outside the reduction tree itself. Assert that we got this 11101 // correct, replace internal uses with undef, and mark for eventual 11102 // deletion. 11103 #ifndef NDEBUG 11104 SmallSet<Value *, 4> IgnoreSet; 11105 for (ArrayRef<Value *> RdxOps : ReductionOps) 11106 IgnoreSet.insert(RdxOps.begin(), RdxOps.end()); 11107 #endif 11108 for (ArrayRef<Value *> RdxOps : ReductionOps) { 11109 for (Value *Ignore : RdxOps) { 11110 if (!Ignore) 11111 continue; 11112 #ifndef NDEBUG 11113 for (auto *U : Ignore->users()) { 11114 assert(IgnoreSet.count(U) && 11115 "All users must be either in the reduction ops list."); 11116 } 11117 #endif 11118 if (!Ignore->use_empty()) { 11119 Value *Undef = UndefValue::get(Ignore->getType()); 11120 Ignore->replaceAllUsesWith(Undef); 11121 } 11122 V.eraseInstruction(cast<Instruction>(Ignore)); 11123 } 11124 } 11125 } else if (!CheckForReusedReductionOps) { 11126 for (ReductionOpsType &RdxOps : ReductionOps) 11127 for (Value *RdxOp : RdxOps) 11128 V.analyzedReductionRoot(cast<Instruction>(RdxOp)); 11129 } 11130 return VectorizedTree; 11131 } 11132 11133 private: 11134 /// Calculate the cost of a reduction. 11135 InstructionCost getReductionCost(TargetTransformInfo *TTI, 11136 ArrayRef<Value *> ReducedVals, 11137 unsigned ReduxWidth, FastMathFlags FMF) { 11138 TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput; 11139 Value *FirstReducedVal = ReducedVals.front(); 11140 Type *ScalarTy = FirstReducedVal->getType(); 11141 FixedVectorType *VectorTy = FixedVectorType::get(ScalarTy, ReduxWidth); 11142 InstructionCost VectorCost = 0, ScalarCost; 11143 // If all of the reduced values are constant, the vector cost is 0, since 11144 // the reduction value can be calculated at the compile time. 11145 bool AllConsts = all_of(ReducedVals, isConstant); 11146 switch (RdxKind) { 11147 case RecurKind::Add: 11148 case RecurKind::Mul: 11149 case RecurKind::Or: 11150 case RecurKind::And: 11151 case RecurKind::Xor: 11152 case RecurKind::FAdd: 11153 case RecurKind::FMul: { 11154 unsigned RdxOpcode = RecurrenceDescriptor::getOpcode(RdxKind); 11155 if (!AllConsts) 11156 VectorCost = 11157 TTI->getArithmeticReductionCost(RdxOpcode, VectorTy, FMF, CostKind); 11158 ScalarCost = TTI->getArithmeticInstrCost(RdxOpcode, ScalarTy, CostKind); 11159 break; 11160 } 11161 case RecurKind::FMax: 11162 case RecurKind::FMin: { 11163 auto *SclCondTy = CmpInst::makeCmpResultType(ScalarTy); 11164 if (!AllConsts) { 11165 auto *VecCondTy = 11166 cast<VectorType>(CmpInst::makeCmpResultType(VectorTy)); 11167 VectorCost = 11168 TTI->getMinMaxReductionCost(VectorTy, VecCondTy, 11169 /*IsUnsigned=*/false, CostKind); 11170 } 11171 CmpInst::Predicate RdxPred = getMinMaxReductionPredicate(RdxKind); 11172 ScalarCost = TTI->getCmpSelInstrCost(Instruction::FCmp, ScalarTy, 11173 SclCondTy, RdxPred, CostKind) + 11174 TTI->getCmpSelInstrCost(Instruction::Select, ScalarTy, 11175 SclCondTy, RdxPred, CostKind); 11176 break; 11177 } 11178 case RecurKind::SMax: 11179 case RecurKind::SMin: 11180 case RecurKind::UMax: 11181 case RecurKind::UMin: { 11182 auto *SclCondTy = CmpInst::makeCmpResultType(ScalarTy); 11183 if (!AllConsts) { 11184 auto *VecCondTy = 11185 cast<VectorType>(CmpInst::makeCmpResultType(VectorTy)); 11186 bool IsUnsigned = 11187 RdxKind == RecurKind::UMax || RdxKind == RecurKind::UMin; 11188 VectorCost = TTI->getMinMaxReductionCost(VectorTy, VecCondTy, 11189 IsUnsigned, CostKind); 11190 } 11191 CmpInst::Predicate RdxPred = getMinMaxReductionPredicate(RdxKind); 11192 ScalarCost = TTI->getCmpSelInstrCost(Instruction::ICmp, ScalarTy, 11193 SclCondTy, RdxPred, CostKind) + 11194 TTI->getCmpSelInstrCost(Instruction::Select, ScalarTy, 11195 SclCondTy, RdxPred, CostKind); 11196 break; 11197 } 11198 default: 11199 llvm_unreachable("Expected arithmetic or min/max reduction operation"); 11200 } 11201 11202 // Scalar cost is repeated for N-1 elements. 11203 ScalarCost *= (ReduxWidth - 1); 11204 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << VectorCost - ScalarCost 11205 << " for reduction that starts with " << *FirstReducedVal 11206 << " (It is a splitting reduction)\n"); 11207 return VectorCost - ScalarCost; 11208 } 11209 11210 /// Emit a horizontal reduction of the vectorized value. 11211 Value *emitReduction(Value *VectorizedValue, IRBuilder<> &Builder, 11212 unsigned ReduxWidth, const TargetTransformInfo *TTI) { 11213 assert(VectorizedValue && "Need to have a vectorized tree node"); 11214 assert(isPowerOf2_32(ReduxWidth) && 11215 "We only handle power-of-two reductions for now"); 11216 assert(RdxKind != RecurKind::FMulAdd && 11217 "A call to the llvm.fmuladd intrinsic is not handled yet"); 11218 11219 ++NumVectorInstructions; 11220 return createSimpleTargetReduction(Builder, TTI, VectorizedValue, RdxKind); 11221 } 11222 }; 11223 11224 } // end anonymous namespace 11225 11226 static Optional<unsigned> getAggregateSize(Instruction *InsertInst) { 11227 if (auto *IE = dyn_cast<InsertElementInst>(InsertInst)) 11228 return cast<FixedVectorType>(IE->getType())->getNumElements(); 11229 11230 unsigned AggregateSize = 1; 11231 auto *IV = cast<InsertValueInst>(InsertInst); 11232 Type *CurrentType = IV->getType(); 11233 do { 11234 if (auto *ST = dyn_cast<StructType>(CurrentType)) { 11235 for (auto *Elt : ST->elements()) 11236 if (Elt != ST->getElementType(0)) // check homogeneity 11237 return None; 11238 AggregateSize *= ST->getNumElements(); 11239 CurrentType = ST->getElementType(0); 11240 } else if (auto *AT = dyn_cast<ArrayType>(CurrentType)) { 11241 AggregateSize *= AT->getNumElements(); 11242 CurrentType = AT->getElementType(); 11243 } else if (auto *VT = dyn_cast<FixedVectorType>(CurrentType)) { 11244 AggregateSize *= VT->getNumElements(); 11245 return AggregateSize; 11246 } else if (CurrentType->isSingleValueType()) { 11247 return AggregateSize; 11248 } else { 11249 return None; 11250 } 11251 } while (true); 11252 } 11253 11254 static void findBuildAggregate_rec(Instruction *LastInsertInst, 11255 TargetTransformInfo *TTI, 11256 SmallVectorImpl<Value *> &BuildVectorOpds, 11257 SmallVectorImpl<Value *> &InsertElts, 11258 unsigned OperandOffset) { 11259 do { 11260 Value *InsertedOperand = LastInsertInst->getOperand(1); 11261 Optional<unsigned> OperandIndex = 11262 getInsertIndex(LastInsertInst, OperandOffset); 11263 if (!OperandIndex) 11264 return; 11265 if (isa<InsertElementInst>(InsertedOperand) || 11266 isa<InsertValueInst>(InsertedOperand)) { 11267 findBuildAggregate_rec(cast<Instruction>(InsertedOperand), TTI, 11268 BuildVectorOpds, InsertElts, *OperandIndex); 11269 11270 } else { 11271 BuildVectorOpds[*OperandIndex] = InsertedOperand; 11272 InsertElts[*OperandIndex] = LastInsertInst; 11273 } 11274 LastInsertInst = dyn_cast<Instruction>(LastInsertInst->getOperand(0)); 11275 } while (LastInsertInst != nullptr && 11276 (isa<InsertValueInst>(LastInsertInst) || 11277 isa<InsertElementInst>(LastInsertInst)) && 11278 LastInsertInst->hasOneUse()); 11279 } 11280 11281 /// Recognize construction of vectors like 11282 /// %ra = insertelement <4 x float> poison, float %s0, i32 0 11283 /// %rb = insertelement <4 x float> %ra, float %s1, i32 1 11284 /// %rc = insertelement <4 x float> %rb, float %s2, i32 2 11285 /// %rd = insertelement <4 x float> %rc, float %s3, i32 3 11286 /// starting from the last insertelement or insertvalue instruction. 11287 /// 11288 /// Also recognize homogeneous aggregates like {<2 x float>, <2 x float>}, 11289 /// {{float, float}, {float, float}}, [2 x {float, float}] and so on. 11290 /// See llvm/test/Transforms/SLPVectorizer/X86/pr42022.ll for examples. 11291 /// 11292 /// Assume LastInsertInst is of InsertElementInst or InsertValueInst type. 11293 /// 11294 /// \return true if it matches. 11295 static bool findBuildAggregate(Instruction *LastInsertInst, 11296 TargetTransformInfo *TTI, 11297 SmallVectorImpl<Value *> &BuildVectorOpds, 11298 SmallVectorImpl<Value *> &InsertElts) { 11299 11300 assert((isa<InsertElementInst>(LastInsertInst) || 11301 isa<InsertValueInst>(LastInsertInst)) && 11302 "Expected insertelement or insertvalue instruction!"); 11303 11304 assert((BuildVectorOpds.empty() && InsertElts.empty()) && 11305 "Expected empty result vectors!"); 11306 11307 Optional<unsigned> AggregateSize = getAggregateSize(LastInsertInst); 11308 if (!AggregateSize) 11309 return false; 11310 BuildVectorOpds.resize(*AggregateSize); 11311 InsertElts.resize(*AggregateSize); 11312 11313 findBuildAggregate_rec(LastInsertInst, TTI, BuildVectorOpds, InsertElts, 0); 11314 llvm::erase_value(BuildVectorOpds, nullptr); 11315 llvm::erase_value(InsertElts, nullptr); 11316 if (BuildVectorOpds.size() >= 2) 11317 return true; 11318 11319 return false; 11320 } 11321 11322 /// Try and get a reduction value from a phi node. 11323 /// 11324 /// Given a phi node \p P in a block \p ParentBB, consider possible reductions 11325 /// if they come from either \p ParentBB or a containing loop latch. 11326 /// 11327 /// \returns A candidate reduction value if possible, or \code nullptr \endcode 11328 /// if not possible. 11329 static Value *getReductionValue(const DominatorTree *DT, PHINode *P, 11330 BasicBlock *ParentBB, LoopInfo *LI) { 11331 // There are situations where the reduction value is not dominated by the 11332 // reduction phi. Vectorizing such cases has been reported to cause 11333 // miscompiles. See PR25787. 11334 auto DominatedReduxValue = [&](Value *R) { 11335 return isa<Instruction>(R) && 11336 DT->dominates(P->getParent(), cast<Instruction>(R)->getParent()); 11337 }; 11338 11339 Value *Rdx = nullptr; 11340 11341 // Return the incoming value if it comes from the same BB as the phi node. 11342 if (P->getIncomingBlock(0) == ParentBB) { 11343 Rdx = P->getIncomingValue(0); 11344 } else if (P->getIncomingBlock(1) == ParentBB) { 11345 Rdx = P->getIncomingValue(1); 11346 } 11347 11348 if (Rdx && DominatedReduxValue(Rdx)) 11349 return Rdx; 11350 11351 // Otherwise, check whether we have a loop latch to look at. 11352 Loop *BBL = LI->getLoopFor(ParentBB); 11353 if (!BBL) 11354 return nullptr; 11355 BasicBlock *BBLatch = BBL->getLoopLatch(); 11356 if (!BBLatch) 11357 return nullptr; 11358 11359 // There is a loop latch, return the incoming value if it comes from 11360 // that. This reduction pattern occasionally turns up. 11361 if (P->getIncomingBlock(0) == BBLatch) { 11362 Rdx = P->getIncomingValue(0); 11363 } else if (P->getIncomingBlock(1) == BBLatch) { 11364 Rdx = P->getIncomingValue(1); 11365 } 11366 11367 if (Rdx && DominatedReduxValue(Rdx)) 11368 return Rdx; 11369 11370 return nullptr; 11371 } 11372 11373 static bool matchRdxBop(Instruction *I, Value *&V0, Value *&V1) { 11374 if (match(I, m_BinOp(m_Value(V0), m_Value(V1)))) 11375 return true; 11376 if (match(I, m_Intrinsic<Intrinsic::maxnum>(m_Value(V0), m_Value(V1)))) 11377 return true; 11378 if (match(I, m_Intrinsic<Intrinsic::minnum>(m_Value(V0), m_Value(V1)))) 11379 return true; 11380 if (match(I, m_Intrinsic<Intrinsic::smax>(m_Value(V0), m_Value(V1)))) 11381 return true; 11382 if (match(I, m_Intrinsic<Intrinsic::smin>(m_Value(V0), m_Value(V1)))) 11383 return true; 11384 if (match(I, m_Intrinsic<Intrinsic::umax>(m_Value(V0), m_Value(V1)))) 11385 return true; 11386 if (match(I, m_Intrinsic<Intrinsic::umin>(m_Value(V0), m_Value(V1)))) 11387 return true; 11388 return false; 11389 } 11390 11391 /// Attempt to reduce a horizontal reduction. 11392 /// If it is legal to match a horizontal reduction feeding the phi node \a P 11393 /// with reduction operators \a Root (or one of its operands) in a basic block 11394 /// \a BB, then check if it can be done. If horizontal reduction is not found 11395 /// and root instruction is a binary operation, vectorization of the operands is 11396 /// attempted. 11397 /// \returns true if a horizontal reduction was matched and reduced or operands 11398 /// of one of the binary instruction were vectorized. 11399 /// \returns false if a horizontal reduction was not matched (or not possible) 11400 /// or no vectorization of any binary operation feeding \a Root instruction was 11401 /// performed. 11402 static bool tryToVectorizeHorReductionOrInstOperands( 11403 PHINode *P, Instruction *Root, BasicBlock *BB, BoUpSLP &R, 11404 TargetTransformInfo *TTI, ScalarEvolution &SE, const DataLayout &DL, 11405 const TargetLibraryInfo &TLI, 11406 const function_ref<bool(Instruction *, BoUpSLP &)> Vectorize) { 11407 if (!ShouldVectorizeHor) 11408 return false; 11409 11410 if (!Root) 11411 return false; 11412 11413 if (Root->getParent() != BB || isa<PHINode>(Root)) 11414 return false; 11415 // Start analysis starting from Root instruction. If horizontal reduction is 11416 // found, try to vectorize it. If it is not a horizontal reduction or 11417 // vectorization is not possible or not effective, and currently analyzed 11418 // instruction is a binary operation, try to vectorize the operands, using 11419 // pre-order DFS traversal order. If the operands were not vectorized, repeat 11420 // the same procedure considering each operand as a possible root of the 11421 // horizontal reduction. 11422 // Interrupt the process if the Root instruction itself was vectorized or all 11423 // sub-trees not higher that RecursionMaxDepth were analyzed/vectorized. 11424 // Skip the analysis of CmpInsts. Compiler implements postanalysis of the 11425 // CmpInsts so we can skip extra attempts in 11426 // tryToVectorizeHorReductionOrInstOperands and save compile time. 11427 std::queue<std::pair<Instruction *, unsigned>> Stack; 11428 Stack.emplace(Root, 0); 11429 SmallPtrSet<Value *, 8> VisitedInstrs; 11430 SmallVector<WeakTrackingVH> PostponedInsts; 11431 bool Res = false; 11432 auto &&TryToReduce = [TTI, &SE, &DL, &P, &R, &TLI](Instruction *Inst, 11433 Value *&B0, 11434 Value *&B1) -> Value * { 11435 if (R.isAnalyzedReductionRoot(Inst)) 11436 return nullptr; 11437 bool IsBinop = matchRdxBop(Inst, B0, B1); 11438 bool IsSelect = match(Inst, m_Select(m_Value(), m_Value(), m_Value())); 11439 if (IsBinop || IsSelect) { 11440 HorizontalReduction HorRdx; 11441 if (HorRdx.matchAssociativeReduction(P, Inst, SE, DL, TLI)) 11442 return HorRdx.tryToReduce(R, TTI); 11443 } 11444 return nullptr; 11445 }; 11446 while (!Stack.empty()) { 11447 Instruction *Inst; 11448 unsigned Level; 11449 std::tie(Inst, Level) = Stack.front(); 11450 Stack.pop(); 11451 // Do not try to analyze instruction that has already been vectorized. 11452 // This may happen when we vectorize instruction operands on a previous 11453 // iteration while stack was populated before that happened. 11454 if (R.isDeleted(Inst)) 11455 continue; 11456 Value *B0 = nullptr, *B1 = nullptr; 11457 if (Value *V = TryToReduce(Inst, B0, B1)) { 11458 Res = true; 11459 // Set P to nullptr to avoid re-analysis of phi node in 11460 // matchAssociativeReduction function unless this is the root node. 11461 P = nullptr; 11462 if (auto *I = dyn_cast<Instruction>(V)) { 11463 // Try to find another reduction. 11464 Stack.emplace(I, Level); 11465 continue; 11466 } 11467 } else { 11468 bool IsBinop = B0 && B1; 11469 if (P && IsBinop) { 11470 Inst = dyn_cast<Instruction>(B0); 11471 if (Inst == P) 11472 Inst = dyn_cast<Instruction>(B1); 11473 if (!Inst) { 11474 // Set P to nullptr to avoid re-analysis of phi node in 11475 // matchAssociativeReduction function unless this is the root node. 11476 P = nullptr; 11477 continue; 11478 } 11479 } 11480 // Set P to nullptr to avoid re-analysis of phi node in 11481 // matchAssociativeReduction function unless this is the root node. 11482 P = nullptr; 11483 // Do not try to vectorize CmpInst operands, this is done separately. 11484 // Final attempt for binop args vectorization should happen after the loop 11485 // to try to find reductions. 11486 if (!isa<CmpInst, InsertElementInst, InsertValueInst>(Inst)) 11487 PostponedInsts.push_back(Inst); 11488 } 11489 11490 // Try to vectorize operands. 11491 // Continue analysis for the instruction from the same basic block only to 11492 // save compile time. 11493 if (++Level < RecursionMaxDepth) 11494 for (auto *Op : Inst->operand_values()) 11495 if (VisitedInstrs.insert(Op).second) 11496 if (auto *I = dyn_cast<Instruction>(Op)) 11497 // Do not try to vectorize CmpInst operands, this is done 11498 // separately. 11499 if (!isa<PHINode, CmpInst, InsertElementInst, InsertValueInst>(I) && 11500 !R.isDeleted(I) && I->getParent() == BB) 11501 Stack.emplace(I, Level); 11502 } 11503 // Try to vectorized binops where reductions were not found. 11504 for (Value *V : PostponedInsts) 11505 if (auto *Inst = dyn_cast<Instruction>(V)) 11506 if (!R.isDeleted(Inst)) 11507 Res |= Vectorize(Inst, R); 11508 return Res; 11509 } 11510 11511 bool SLPVectorizerPass::vectorizeRootInstruction(PHINode *P, Value *V, 11512 BasicBlock *BB, BoUpSLP &R, 11513 TargetTransformInfo *TTI) { 11514 auto *I = dyn_cast_or_null<Instruction>(V); 11515 if (!I) 11516 return false; 11517 11518 if (!isa<BinaryOperator>(I)) 11519 P = nullptr; 11520 // Try to match and vectorize a horizontal reduction. 11521 auto &&ExtraVectorization = [this](Instruction *I, BoUpSLP &R) -> bool { 11522 return tryToVectorize(I, R); 11523 }; 11524 return tryToVectorizeHorReductionOrInstOperands(P, I, BB, R, TTI, *SE, *DL, 11525 *TLI, ExtraVectorization); 11526 } 11527 11528 bool SLPVectorizerPass::vectorizeInsertValueInst(InsertValueInst *IVI, 11529 BasicBlock *BB, BoUpSLP &R) { 11530 const DataLayout &DL = BB->getModule()->getDataLayout(); 11531 if (!R.canMapToVector(IVI->getType(), DL)) 11532 return false; 11533 11534 SmallVector<Value *, 16> BuildVectorOpds; 11535 SmallVector<Value *, 16> BuildVectorInsts; 11536 if (!findBuildAggregate(IVI, TTI, BuildVectorOpds, BuildVectorInsts)) 11537 return false; 11538 11539 LLVM_DEBUG(dbgs() << "SLP: array mappable to vector: " << *IVI << "\n"); 11540 // Aggregate value is unlikely to be processed in vector register. 11541 return tryToVectorizeList(BuildVectorOpds, R); 11542 } 11543 11544 bool SLPVectorizerPass::vectorizeInsertElementInst(InsertElementInst *IEI, 11545 BasicBlock *BB, BoUpSLP &R) { 11546 SmallVector<Value *, 16> BuildVectorInsts; 11547 SmallVector<Value *, 16> BuildVectorOpds; 11548 SmallVector<int> Mask; 11549 if (!findBuildAggregate(IEI, TTI, BuildVectorOpds, BuildVectorInsts) || 11550 (llvm::all_of( 11551 BuildVectorOpds, 11552 [](Value *V) { return isa<ExtractElementInst, UndefValue>(V); }) && 11553 isFixedVectorShuffle(BuildVectorOpds, Mask))) 11554 return false; 11555 11556 LLVM_DEBUG(dbgs() << "SLP: array mappable to vector: " << *IEI << "\n"); 11557 return tryToVectorizeList(BuildVectorInsts, R); 11558 } 11559 11560 template <typename T> 11561 static bool 11562 tryToVectorizeSequence(SmallVectorImpl<T *> &Incoming, 11563 function_ref<unsigned(T *)> Limit, 11564 function_ref<bool(T *, T *)> Comparator, 11565 function_ref<bool(T *, T *)> AreCompatible, 11566 function_ref<bool(ArrayRef<T *>, bool)> TryToVectorizeHelper, 11567 bool LimitForRegisterSize) { 11568 bool Changed = false; 11569 // Sort by type, parent, operands. 11570 stable_sort(Incoming, Comparator); 11571 11572 // Try to vectorize elements base on their type. 11573 SmallVector<T *> Candidates; 11574 for (auto *IncIt = Incoming.begin(), *E = Incoming.end(); IncIt != E;) { 11575 // Look for the next elements with the same type, parent and operand 11576 // kinds. 11577 auto *SameTypeIt = IncIt; 11578 while (SameTypeIt != E && AreCompatible(*SameTypeIt, *IncIt)) 11579 ++SameTypeIt; 11580 11581 // Try to vectorize them. 11582 unsigned NumElts = (SameTypeIt - IncIt); 11583 LLVM_DEBUG(dbgs() << "SLP: Trying to vectorize starting at nodes (" 11584 << NumElts << ")\n"); 11585 // The vectorization is a 3-state attempt: 11586 // 1. Try to vectorize instructions with the same/alternate opcodes with the 11587 // size of maximal register at first. 11588 // 2. Try to vectorize remaining instructions with the same type, if 11589 // possible. This may result in the better vectorization results rather than 11590 // if we try just to vectorize instructions with the same/alternate opcodes. 11591 // 3. Final attempt to try to vectorize all instructions with the 11592 // same/alternate ops only, this may result in some extra final 11593 // vectorization. 11594 if (NumElts > 1 && 11595 TryToVectorizeHelper(makeArrayRef(IncIt, NumElts), LimitForRegisterSize)) { 11596 // Success start over because instructions might have been changed. 11597 Changed = true; 11598 } else if (NumElts < Limit(*IncIt) && 11599 (Candidates.empty() || 11600 Candidates.front()->getType() == (*IncIt)->getType())) { 11601 Candidates.append(IncIt, std::next(IncIt, NumElts)); 11602 } 11603 // Final attempt to vectorize instructions with the same types. 11604 if (Candidates.size() > 1 && 11605 (SameTypeIt == E || (*SameTypeIt)->getType() != (*IncIt)->getType())) { 11606 if (TryToVectorizeHelper(Candidates, /*LimitForRegisterSize=*/false)) { 11607 // Success start over because instructions might have been changed. 11608 Changed = true; 11609 } else if (LimitForRegisterSize) { 11610 // Try to vectorize using small vectors. 11611 for (auto *It = Candidates.begin(), *End = Candidates.end(); 11612 It != End;) { 11613 auto *SameTypeIt = It; 11614 while (SameTypeIt != End && AreCompatible(*SameTypeIt, *It)) 11615 ++SameTypeIt; 11616 unsigned NumElts = (SameTypeIt - It); 11617 if (NumElts > 1 && TryToVectorizeHelper(makeArrayRef(It, NumElts), 11618 /*LimitForRegisterSize=*/false)) 11619 Changed = true; 11620 It = SameTypeIt; 11621 } 11622 } 11623 Candidates.clear(); 11624 } 11625 11626 // Start over at the next instruction of a different type (or the end). 11627 IncIt = SameTypeIt; 11628 } 11629 return Changed; 11630 } 11631 11632 /// Compare two cmp instructions. If IsCompatibility is true, function returns 11633 /// true if 2 cmps have same/swapped predicates and mos compatible corresponding 11634 /// operands. If IsCompatibility is false, function implements strict weak 11635 /// ordering relation between two cmp instructions, returning true if the first 11636 /// instruction is "less" than the second, i.e. its predicate is less than the 11637 /// predicate of the second or the operands IDs are less than the operands IDs 11638 /// of the second cmp instruction. 11639 template <bool IsCompatibility> 11640 static bool compareCmp(Value *V, Value *V2, 11641 function_ref<bool(Instruction *)> IsDeleted) { 11642 auto *CI1 = cast<CmpInst>(V); 11643 auto *CI2 = cast<CmpInst>(V2); 11644 if (IsDeleted(CI2) || !isValidElementType(CI2->getType())) 11645 return false; 11646 if (CI1->getOperand(0)->getType()->getTypeID() < 11647 CI2->getOperand(0)->getType()->getTypeID()) 11648 return !IsCompatibility; 11649 if (CI1->getOperand(0)->getType()->getTypeID() > 11650 CI2->getOperand(0)->getType()->getTypeID()) 11651 return false; 11652 CmpInst::Predicate Pred1 = CI1->getPredicate(); 11653 CmpInst::Predicate Pred2 = CI2->getPredicate(); 11654 CmpInst::Predicate SwapPred1 = CmpInst::getSwappedPredicate(Pred1); 11655 CmpInst::Predicate SwapPred2 = CmpInst::getSwappedPredicate(Pred2); 11656 CmpInst::Predicate BasePred1 = std::min(Pred1, SwapPred1); 11657 CmpInst::Predicate BasePred2 = std::min(Pred2, SwapPred2); 11658 if (BasePred1 < BasePred2) 11659 return !IsCompatibility; 11660 if (BasePred1 > BasePred2) 11661 return false; 11662 // Compare operands. 11663 bool LEPreds = Pred1 <= Pred2; 11664 bool GEPreds = Pred1 >= Pred2; 11665 for (int I = 0, E = CI1->getNumOperands(); I < E; ++I) { 11666 auto *Op1 = CI1->getOperand(LEPreds ? I : E - I - 1); 11667 auto *Op2 = CI2->getOperand(GEPreds ? I : E - I - 1); 11668 if (Op1->getValueID() < Op2->getValueID()) 11669 return !IsCompatibility; 11670 if (Op1->getValueID() > Op2->getValueID()) 11671 return false; 11672 if (auto *I1 = dyn_cast<Instruction>(Op1)) 11673 if (auto *I2 = dyn_cast<Instruction>(Op2)) { 11674 if (I1->getParent() != I2->getParent()) 11675 return false; 11676 InstructionsState S = getSameOpcode({I1, I2}); 11677 if (S.getOpcode()) 11678 continue; 11679 return false; 11680 } 11681 } 11682 return IsCompatibility; 11683 } 11684 11685 bool SLPVectorizerPass::vectorizeSimpleInstructions( 11686 SmallVectorImpl<Instruction *> &Instructions, BasicBlock *BB, BoUpSLP &R, 11687 bool AtTerminator) { 11688 bool OpsChanged = false; 11689 SmallVector<Instruction *, 4> PostponedCmps; 11690 for (auto *I : reverse(Instructions)) { 11691 if (R.isDeleted(I)) 11692 continue; 11693 if (auto *LastInsertValue = dyn_cast<InsertValueInst>(I)) { 11694 OpsChanged |= vectorizeInsertValueInst(LastInsertValue, BB, R); 11695 } else if (auto *LastInsertElem = dyn_cast<InsertElementInst>(I)) { 11696 OpsChanged |= vectorizeInsertElementInst(LastInsertElem, BB, R); 11697 } else if (isa<CmpInst>(I)) { 11698 PostponedCmps.push_back(I); 11699 continue; 11700 } 11701 // Try to find reductions in buildvector sequnces. 11702 OpsChanged |= vectorizeRootInstruction(nullptr, I, BB, R, TTI); 11703 } 11704 if (AtTerminator) { 11705 // Try to find reductions first. 11706 for (Instruction *I : PostponedCmps) { 11707 if (R.isDeleted(I)) 11708 continue; 11709 for (Value *Op : I->operands()) 11710 OpsChanged |= vectorizeRootInstruction(nullptr, Op, BB, R, TTI); 11711 } 11712 // Try to vectorize operands as vector bundles. 11713 for (Instruction *I : PostponedCmps) { 11714 if (R.isDeleted(I)) 11715 continue; 11716 OpsChanged |= tryToVectorize(I, R); 11717 } 11718 // Try to vectorize list of compares. 11719 // Sort by type, compare predicate, etc. 11720 auto &&CompareSorter = [&R](Value *V, Value *V2) { 11721 return compareCmp<false>(V, V2, 11722 [&R](Instruction *I) { return R.isDeleted(I); }); 11723 }; 11724 11725 auto &&AreCompatibleCompares = [&R](Value *V1, Value *V2) { 11726 if (V1 == V2) 11727 return true; 11728 return compareCmp<true>(V1, V2, 11729 [&R](Instruction *I) { return R.isDeleted(I); }); 11730 }; 11731 auto Limit = [&R](Value *V) { 11732 unsigned EltSize = R.getVectorElementSize(V); 11733 return std::max(2U, R.getMaxVecRegSize() / EltSize); 11734 }; 11735 11736 SmallVector<Value *> Vals(PostponedCmps.begin(), PostponedCmps.end()); 11737 OpsChanged |= tryToVectorizeSequence<Value>( 11738 Vals, Limit, CompareSorter, AreCompatibleCompares, 11739 [this, &R](ArrayRef<Value *> Candidates, bool LimitForRegisterSize) { 11740 // Exclude possible reductions from other blocks. 11741 bool ArePossiblyReducedInOtherBlock = 11742 any_of(Candidates, [](Value *V) { 11743 return any_of(V->users(), [V](User *U) { 11744 return isa<SelectInst>(U) && 11745 cast<SelectInst>(U)->getParent() != 11746 cast<Instruction>(V)->getParent(); 11747 }); 11748 }); 11749 if (ArePossiblyReducedInOtherBlock) 11750 return false; 11751 return tryToVectorizeList(Candidates, R, LimitForRegisterSize); 11752 }, 11753 /*LimitForRegisterSize=*/true); 11754 Instructions.clear(); 11755 } else { 11756 // Insert in reverse order since the PostponedCmps vector was filled in 11757 // reverse order. 11758 Instructions.assign(PostponedCmps.rbegin(), PostponedCmps.rend()); 11759 } 11760 return OpsChanged; 11761 } 11762 11763 bool SLPVectorizerPass::vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R) { 11764 bool Changed = false; 11765 SmallVector<Value *, 4> Incoming; 11766 SmallPtrSet<Value *, 16> VisitedInstrs; 11767 // Maps phi nodes to the non-phi nodes found in the use tree for each phi 11768 // node. Allows better to identify the chains that can be vectorized in the 11769 // better way. 11770 DenseMap<Value *, SmallVector<Value *, 4>> PHIToOpcodes; 11771 auto PHICompare = [this, &PHIToOpcodes](Value *V1, Value *V2) { 11772 assert(isValidElementType(V1->getType()) && 11773 isValidElementType(V2->getType()) && 11774 "Expected vectorizable types only."); 11775 // It is fine to compare type IDs here, since we expect only vectorizable 11776 // types, like ints, floats and pointers, we don't care about other type. 11777 if (V1->getType()->getTypeID() < V2->getType()->getTypeID()) 11778 return true; 11779 if (V1->getType()->getTypeID() > V2->getType()->getTypeID()) 11780 return false; 11781 ArrayRef<Value *> Opcodes1 = PHIToOpcodes[V1]; 11782 ArrayRef<Value *> Opcodes2 = PHIToOpcodes[V2]; 11783 if (Opcodes1.size() < Opcodes2.size()) 11784 return true; 11785 if (Opcodes1.size() > Opcodes2.size()) 11786 return false; 11787 Optional<bool> ConstOrder; 11788 for (int I = 0, E = Opcodes1.size(); I < E; ++I) { 11789 // Undefs are compatible with any other value. 11790 if (isa<UndefValue>(Opcodes1[I]) || isa<UndefValue>(Opcodes2[I])) { 11791 if (!ConstOrder) 11792 ConstOrder = 11793 !isa<UndefValue>(Opcodes1[I]) && isa<UndefValue>(Opcodes2[I]); 11794 continue; 11795 } 11796 if (auto *I1 = dyn_cast<Instruction>(Opcodes1[I])) 11797 if (auto *I2 = dyn_cast<Instruction>(Opcodes2[I])) { 11798 DomTreeNodeBase<BasicBlock> *NodeI1 = DT->getNode(I1->getParent()); 11799 DomTreeNodeBase<BasicBlock> *NodeI2 = DT->getNode(I2->getParent()); 11800 if (!NodeI1) 11801 return NodeI2 != nullptr; 11802 if (!NodeI2) 11803 return false; 11804 assert((NodeI1 == NodeI2) == 11805 (NodeI1->getDFSNumIn() == NodeI2->getDFSNumIn()) && 11806 "Different nodes should have different DFS numbers"); 11807 if (NodeI1 != NodeI2) 11808 return NodeI1->getDFSNumIn() < NodeI2->getDFSNumIn(); 11809 InstructionsState S = getSameOpcode({I1, I2}); 11810 if (S.getOpcode()) 11811 continue; 11812 return I1->getOpcode() < I2->getOpcode(); 11813 } 11814 if (isa<Constant>(Opcodes1[I]) && isa<Constant>(Opcodes2[I])) { 11815 if (!ConstOrder) 11816 ConstOrder = Opcodes1[I]->getValueID() < Opcodes2[I]->getValueID(); 11817 continue; 11818 } 11819 if (Opcodes1[I]->getValueID() < Opcodes2[I]->getValueID()) 11820 return true; 11821 if (Opcodes1[I]->getValueID() > Opcodes2[I]->getValueID()) 11822 return false; 11823 } 11824 return ConstOrder && *ConstOrder; 11825 }; 11826 auto AreCompatiblePHIs = [&PHIToOpcodes](Value *V1, Value *V2) { 11827 if (V1 == V2) 11828 return true; 11829 if (V1->getType() != V2->getType()) 11830 return false; 11831 ArrayRef<Value *> Opcodes1 = PHIToOpcodes[V1]; 11832 ArrayRef<Value *> Opcodes2 = PHIToOpcodes[V2]; 11833 if (Opcodes1.size() != Opcodes2.size()) 11834 return false; 11835 for (int I = 0, E = Opcodes1.size(); I < E; ++I) { 11836 // Undefs are compatible with any other value. 11837 if (isa<UndefValue>(Opcodes1[I]) || isa<UndefValue>(Opcodes2[I])) 11838 continue; 11839 if (auto *I1 = dyn_cast<Instruction>(Opcodes1[I])) 11840 if (auto *I2 = dyn_cast<Instruction>(Opcodes2[I])) { 11841 if (I1->getParent() != I2->getParent()) 11842 return false; 11843 InstructionsState S = getSameOpcode({I1, I2}); 11844 if (S.getOpcode()) 11845 continue; 11846 return false; 11847 } 11848 if (isa<Constant>(Opcodes1[I]) && isa<Constant>(Opcodes2[I])) 11849 continue; 11850 if (Opcodes1[I]->getValueID() != Opcodes2[I]->getValueID()) 11851 return false; 11852 } 11853 return true; 11854 }; 11855 auto Limit = [&R](Value *V) { 11856 unsigned EltSize = R.getVectorElementSize(V); 11857 return std::max(2U, R.getMaxVecRegSize() / EltSize); 11858 }; 11859 11860 bool HaveVectorizedPhiNodes = false; 11861 do { 11862 // Collect the incoming values from the PHIs. 11863 Incoming.clear(); 11864 for (Instruction &I : *BB) { 11865 PHINode *P = dyn_cast<PHINode>(&I); 11866 if (!P) 11867 break; 11868 11869 // No need to analyze deleted, vectorized and non-vectorizable 11870 // instructions. 11871 if (!VisitedInstrs.count(P) && !R.isDeleted(P) && 11872 isValidElementType(P->getType())) 11873 Incoming.push_back(P); 11874 } 11875 11876 // Find the corresponding non-phi nodes for better matching when trying to 11877 // build the tree. 11878 for (Value *V : Incoming) { 11879 SmallVectorImpl<Value *> &Opcodes = 11880 PHIToOpcodes.try_emplace(V).first->getSecond(); 11881 if (!Opcodes.empty()) 11882 continue; 11883 SmallVector<Value *, 4> Nodes(1, V); 11884 SmallPtrSet<Value *, 4> Visited; 11885 while (!Nodes.empty()) { 11886 auto *PHI = cast<PHINode>(Nodes.pop_back_val()); 11887 if (!Visited.insert(PHI).second) 11888 continue; 11889 for (Value *V : PHI->incoming_values()) { 11890 if (auto *PHI1 = dyn_cast<PHINode>((V))) { 11891 Nodes.push_back(PHI1); 11892 continue; 11893 } 11894 Opcodes.emplace_back(V); 11895 } 11896 } 11897 } 11898 11899 HaveVectorizedPhiNodes = tryToVectorizeSequence<Value>( 11900 Incoming, Limit, PHICompare, AreCompatiblePHIs, 11901 [this, &R](ArrayRef<Value *> Candidates, bool LimitForRegisterSize) { 11902 return tryToVectorizeList(Candidates, R, LimitForRegisterSize); 11903 }, 11904 /*LimitForRegisterSize=*/true); 11905 Changed |= HaveVectorizedPhiNodes; 11906 VisitedInstrs.insert(Incoming.begin(), Incoming.end()); 11907 } while (HaveVectorizedPhiNodes); 11908 11909 VisitedInstrs.clear(); 11910 11911 SmallVector<Instruction *, 8> PostProcessInstructions; 11912 SmallDenseSet<Instruction *, 4> KeyNodes; 11913 for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) { 11914 // Skip instructions with scalable type. The num of elements is unknown at 11915 // compile-time for scalable type. 11916 if (isa<ScalableVectorType>(it->getType())) 11917 continue; 11918 11919 // Skip instructions marked for the deletion. 11920 if (R.isDeleted(&*it)) 11921 continue; 11922 // We may go through BB multiple times so skip the one we have checked. 11923 if (!VisitedInstrs.insert(&*it).second) { 11924 if (it->use_empty() && KeyNodes.contains(&*it) && 11925 vectorizeSimpleInstructions(PostProcessInstructions, BB, R, 11926 it->isTerminator())) { 11927 // We would like to start over since some instructions are deleted 11928 // and the iterator may become invalid value. 11929 Changed = true; 11930 it = BB->begin(); 11931 e = BB->end(); 11932 } 11933 continue; 11934 } 11935 11936 if (isa<DbgInfoIntrinsic>(it)) 11937 continue; 11938 11939 // Try to vectorize reductions that use PHINodes. 11940 if (PHINode *P = dyn_cast<PHINode>(it)) { 11941 // Check that the PHI is a reduction PHI. 11942 if (P->getNumIncomingValues() == 2) { 11943 // Try to match and vectorize a horizontal reduction. 11944 if (vectorizeRootInstruction(P, getReductionValue(DT, P, BB, LI), BB, R, 11945 TTI)) { 11946 Changed = true; 11947 it = BB->begin(); 11948 e = BB->end(); 11949 continue; 11950 } 11951 } 11952 // Try to vectorize the incoming values of the PHI, to catch reductions 11953 // that feed into PHIs. 11954 for (unsigned I = 0, E = P->getNumIncomingValues(); I != E; I++) { 11955 // Skip if the incoming block is the current BB for now. Also, bypass 11956 // unreachable IR for efficiency and to avoid crashing. 11957 // TODO: Collect the skipped incoming values and try to vectorize them 11958 // after processing BB. 11959 if (BB == P->getIncomingBlock(I) || 11960 !DT->isReachableFromEntry(P->getIncomingBlock(I))) 11961 continue; 11962 11963 Changed |= vectorizeRootInstruction(nullptr, P->getIncomingValue(I), 11964 P->getIncomingBlock(I), R, TTI); 11965 } 11966 continue; 11967 } 11968 11969 // Ran into an instruction without users, like terminator, or function call 11970 // with ignored return value, store. Ignore unused instructions (basing on 11971 // instruction type, except for CallInst and InvokeInst). 11972 if (it->use_empty() && (it->getType()->isVoidTy() || isa<CallInst>(it) || 11973 isa<InvokeInst>(it))) { 11974 KeyNodes.insert(&*it); 11975 bool OpsChanged = false; 11976 if (ShouldStartVectorizeHorAtStore || !isa<StoreInst>(it)) { 11977 for (auto *V : it->operand_values()) { 11978 // Try to match and vectorize a horizontal reduction. 11979 OpsChanged |= vectorizeRootInstruction(nullptr, V, BB, R, TTI); 11980 } 11981 } 11982 // Start vectorization of post-process list of instructions from the 11983 // top-tree instructions to try to vectorize as many instructions as 11984 // possible. 11985 OpsChanged |= vectorizeSimpleInstructions(PostProcessInstructions, BB, R, 11986 it->isTerminator()); 11987 if (OpsChanged) { 11988 // We would like to start over since some instructions are deleted 11989 // and the iterator may become invalid value. 11990 Changed = true; 11991 it = BB->begin(); 11992 e = BB->end(); 11993 continue; 11994 } 11995 } 11996 11997 if (isa<InsertElementInst>(it) || isa<CmpInst>(it) || 11998 isa<InsertValueInst>(it)) 11999 PostProcessInstructions.push_back(&*it); 12000 } 12001 12002 return Changed; 12003 } 12004 12005 bool SLPVectorizerPass::vectorizeGEPIndices(BasicBlock *BB, BoUpSLP &R) { 12006 auto Changed = false; 12007 for (auto &Entry : GEPs) { 12008 // If the getelementptr list has fewer than two elements, there's nothing 12009 // to do. 12010 if (Entry.second.size() < 2) 12011 continue; 12012 12013 LLVM_DEBUG(dbgs() << "SLP: Analyzing a getelementptr list of length " 12014 << Entry.second.size() << ".\n"); 12015 12016 // Process the GEP list in chunks suitable for the target's supported 12017 // vector size. If a vector register can't hold 1 element, we are done. We 12018 // are trying to vectorize the index computations, so the maximum number of 12019 // elements is based on the size of the index expression, rather than the 12020 // size of the GEP itself (the target's pointer size). 12021 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 12022 unsigned EltSize = R.getVectorElementSize(*Entry.second[0]->idx_begin()); 12023 if (MaxVecRegSize < EltSize) 12024 continue; 12025 12026 unsigned MaxElts = MaxVecRegSize / EltSize; 12027 for (unsigned BI = 0, BE = Entry.second.size(); BI < BE; BI += MaxElts) { 12028 auto Len = std::min<unsigned>(BE - BI, MaxElts); 12029 ArrayRef<GetElementPtrInst *> GEPList(&Entry.second[BI], Len); 12030 12031 // Initialize a set a candidate getelementptrs. Note that we use a 12032 // SetVector here to preserve program order. If the index computations 12033 // are vectorizable and begin with loads, we want to minimize the chance 12034 // of having to reorder them later. 12035 SetVector<Value *> Candidates(GEPList.begin(), GEPList.end()); 12036 12037 // Some of the candidates may have already been vectorized after we 12038 // initially collected them. If so, they are marked as deleted, so remove 12039 // them from the set of candidates. 12040 Candidates.remove_if( 12041 [&R](Value *I) { return R.isDeleted(cast<Instruction>(I)); }); 12042 12043 // Remove from the set of candidates all pairs of getelementptrs with 12044 // constant differences. Such getelementptrs are likely not good 12045 // candidates for vectorization in a bottom-up phase since one can be 12046 // computed from the other. We also ensure all candidate getelementptr 12047 // indices are unique. 12048 for (int I = 0, E = GEPList.size(); I < E && Candidates.size() > 1; ++I) { 12049 auto *GEPI = GEPList[I]; 12050 if (!Candidates.count(GEPI)) 12051 continue; 12052 auto *SCEVI = SE->getSCEV(GEPList[I]); 12053 for (int J = I + 1; J < E && Candidates.size() > 1; ++J) { 12054 auto *GEPJ = GEPList[J]; 12055 auto *SCEVJ = SE->getSCEV(GEPList[J]); 12056 if (isa<SCEVConstant>(SE->getMinusSCEV(SCEVI, SCEVJ))) { 12057 Candidates.remove(GEPI); 12058 Candidates.remove(GEPJ); 12059 } else if (GEPI->idx_begin()->get() == GEPJ->idx_begin()->get()) { 12060 Candidates.remove(GEPJ); 12061 } 12062 } 12063 } 12064 12065 // We break out of the above computation as soon as we know there are 12066 // fewer than two candidates remaining. 12067 if (Candidates.size() < 2) 12068 continue; 12069 12070 // Add the single, non-constant index of each candidate to the bundle. We 12071 // ensured the indices met these constraints when we originally collected 12072 // the getelementptrs. 12073 SmallVector<Value *, 16> Bundle(Candidates.size()); 12074 auto BundleIndex = 0u; 12075 for (auto *V : Candidates) { 12076 auto *GEP = cast<GetElementPtrInst>(V); 12077 auto *GEPIdx = GEP->idx_begin()->get(); 12078 assert(GEP->getNumIndices() == 1 || !isa<Constant>(GEPIdx)); 12079 Bundle[BundleIndex++] = GEPIdx; 12080 } 12081 12082 // Try and vectorize the indices. We are currently only interested in 12083 // gather-like cases of the form: 12084 // 12085 // ... = g[a[0] - b[0]] + g[a[1] - b[1]] + ... 12086 // 12087 // where the loads of "a", the loads of "b", and the subtractions can be 12088 // performed in parallel. It's likely that detecting this pattern in a 12089 // bottom-up phase will be simpler and less costly than building a 12090 // full-blown top-down phase beginning at the consecutive loads. 12091 Changed |= tryToVectorizeList(Bundle, R); 12092 } 12093 } 12094 return Changed; 12095 } 12096 12097 bool SLPVectorizerPass::vectorizeStoreChains(BoUpSLP &R) { 12098 bool Changed = false; 12099 // Sort by type, base pointers and values operand. Value operands must be 12100 // compatible (have the same opcode, same parent), otherwise it is 12101 // definitely not profitable to try to vectorize them. 12102 auto &&StoreSorter = [this](StoreInst *V, StoreInst *V2) { 12103 if (V->getPointerOperandType()->getTypeID() < 12104 V2->getPointerOperandType()->getTypeID()) 12105 return true; 12106 if (V->getPointerOperandType()->getTypeID() > 12107 V2->getPointerOperandType()->getTypeID()) 12108 return false; 12109 // UndefValues are compatible with all other values. 12110 if (isa<UndefValue>(V->getValueOperand()) || 12111 isa<UndefValue>(V2->getValueOperand())) 12112 return false; 12113 if (auto *I1 = dyn_cast<Instruction>(V->getValueOperand())) 12114 if (auto *I2 = dyn_cast<Instruction>(V2->getValueOperand())) { 12115 DomTreeNodeBase<llvm::BasicBlock> *NodeI1 = 12116 DT->getNode(I1->getParent()); 12117 DomTreeNodeBase<llvm::BasicBlock> *NodeI2 = 12118 DT->getNode(I2->getParent()); 12119 assert(NodeI1 && "Should only process reachable instructions"); 12120 assert(NodeI2 && "Should only process reachable instructions"); 12121 assert((NodeI1 == NodeI2) == 12122 (NodeI1->getDFSNumIn() == NodeI2->getDFSNumIn()) && 12123 "Different nodes should have different DFS numbers"); 12124 if (NodeI1 != NodeI2) 12125 return NodeI1->getDFSNumIn() < NodeI2->getDFSNumIn(); 12126 InstructionsState S = getSameOpcode({I1, I2}); 12127 if (S.getOpcode()) 12128 return false; 12129 return I1->getOpcode() < I2->getOpcode(); 12130 } 12131 if (isa<Constant>(V->getValueOperand()) && 12132 isa<Constant>(V2->getValueOperand())) 12133 return false; 12134 return V->getValueOperand()->getValueID() < 12135 V2->getValueOperand()->getValueID(); 12136 }; 12137 12138 auto &&AreCompatibleStores = [](StoreInst *V1, StoreInst *V2) { 12139 if (V1 == V2) 12140 return true; 12141 if (V1->getPointerOperandType() != V2->getPointerOperandType()) 12142 return false; 12143 // Undefs are compatible with any other value. 12144 if (isa<UndefValue>(V1->getValueOperand()) || 12145 isa<UndefValue>(V2->getValueOperand())) 12146 return true; 12147 if (auto *I1 = dyn_cast<Instruction>(V1->getValueOperand())) 12148 if (auto *I2 = dyn_cast<Instruction>(V2->getValueOperand())) { 12149 if (I1->getParent() != I2->getParent()) 12150 return false; 12151 InstructionsState S = getSameOpcode({I1, I2}); 12152 return S.getOpcode() > 0; 12153 } 12154 if (isa<Constant>(V1->getValueOperand()) && 12155 isa<Constant>(V2->getValueOperand())) 12156 return true; 12157 return V1->getValueOperand()->getValueID() == 12158 V2->getValueOperand()->getValueID(); 12159 }; 12160 auto Limit = [&R, this](StoreInst *SI) { 12161 unsigned EltSize = DL->getTypeSizeInBits(SI->getValueOperand()->getType()); 12162 return R.getMinVF(EltSize); 12163 }; 12164 12165 // Attempt to sort and vectorize each of the store-groups. 12166 for (auto &Pair : Stores) { 12167 if (Pair.second.size() < 2) 12168 continue; 12169 12170 LLVM_DEBUG(dbgs() << "SLP: Analyzing a store chain of length " 12171 << Pair.second.size() << ".\n"); 12172 12173 if (!isValidElementType(Pair.second.front()->getValueOperand()->getType())) 12174 continue; 12175 12176 Changed |= tryToVectorizeSequence<StoreInst>( 12177 Pair.second, Limit, StoreSorter, AreCompatibleStores, 12178 [this, &R](ArrayRef<StoreInst *> Candidates, bool) { 12179 return vectorizeStores(Candidates, R); 12180 }, 12181 /*LimitForRegisterSize=*/false); 12182 } 12183 return Changed; 12184 } 12185 12186 char SLPVectorizer::ID = 0; 12187 12188 static const char lv_name[] = "SLP Vectorizer"; 12189 12190 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false) 12191 INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass) 12192 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass) 12193 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 12194 INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass) 12195 INITIALIZE_PASS_DEPENDENCY(LoopSimplify) 12196 INITIALIZE_PASS_DEPENDENCY(DemandedBitsWrapperPass) 12197 INITIALIZE_PASS_DEPENDENCY(OptimizationRemarkEmitterWrapperPass) 12198 INITIALIZE_PASS_DEPENDENCY(InjectTLIMappingsLegacy) 12199 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false) 12200 12201 Pass *llvm::createSLPVectorizerPass() { return new SLPVectorizer(); } 12202