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/STLExtras.h" 25 #include "llvm/ADT/SetVector.h" 26 #include "llvm/ADT/SmallBitVector.h" 27 #include "llvm/ADT/SmallPtrSet.h" 28 #include "llvm/ADT/SmallSet.h" 29 #include "llvm/ADT/SmallString.h" 30 #include "llvm/ADT/Statistic.h" 31 #include "llvm/ADT/iterator.h" 32 #include "llvm/ADT/iterator_range.h" 33 #include "llvm/Analysis/AliasAnalysis.h" 34 #include "llvm/Analysis/AssumptionCache.h" 35 #include "llvm/Analysis/CodeMetrics.h" 36 #include "llvm/Analysis/DemandedBits.h" 37 #include "llvm/Analysis/GlobalsModRef.h" 38 #include "llvm/Analysis/LoopAccessAnalysis.h" 39 #include "llvm/Analysis/LoopInfo.h" 40 #include "llvm/Analysis/MemoryLocation.h" 41 #include "llvm/Analysis/OptimizationRemarkEmitter.h" 42 #include "llvm/Analysis/ScalarEvolution.h" 43 #include "llvm/Analysis/ScalarEvolutionExpressions.h" 44 #include "llvm/Analysis/TargetLibraryInfo.h" 45 #include "llvm/Analysis/TargetTransformInfo.h" 46 #include "llvm/Analysis/ValueTracking.h" 47 #include "llvm/Analysis/VectorUtils.h" 48 #include "llvm/IR/Attributes.h" 49 #include "llvm/IR/BasicBlock.h" 50 #include "llvm/IR/Constant.h" 51 #include "llvm/IR/Constants.h" 52 #include "llvm/IR/DataLayout.h" 53 #include "llvm/IR/DebugLoc.h" 54 #include "llvm/IR/DerivedTypes.h" 55 #include "llvm/IR/Dominators.h" 56 #include "llvm/IR/Function.h" 57 #include "llvm/IR/IRBuilder.h" 58 #include "llvm/IR/InstrTypes.h" 59 #include "llvm/IR/Instruction.h" 60 #include "llvm/IR/Instructions.h" 61 #include "llvm/IR/IntrinsicInst.h" 62 #include "llvm/IR/Intrinsics.h" 63 #include "llvm/IR/Module.h" 64 #include "llvm/IR/NoFolder.h" 65 #include "llvm/IR/Operator.h" 66 #include "llvm/IR/PatternMatch.h" 67 #include "llvm/IR/Type.h" 68 #include "llvm/IR/Use.h" 69 #include "llvm/IR/User.h" 70 #include "llvm/IR/Value.h" 71 #include "llvm/IR/ValueHandle.h" 72 #include "llvm/IR/Verifier.h" 73 #include "llvm/InitializePasses.h" 74 #include "llvm/Pass.h" 75 #include "llvm/Support/Casting.h" 76 #include "llvm/Support/CommandLine.h" 77 #include "llvm/Support/Compiler.h" 78 #include "llvm/Support/DOTGraphTraits.h" 79 #include "llvm/Support/Debug.h" 80 #include "llvm/Support/ErrorHandling.h" 81 #include "llvm/Support/GraphWriter.h" 82 #include "llvm/Support/KnownBits.h" 83 #include "llvm/Support/MathExtras.h" 84 #include "llvm/Support/raw_ostream.h" 85 #include "llvm/Transforms/Utils/InjectTLIMappings.h" 86 #include "llvm/Transforms/Utils/LoopUtils.h" 87 #include "llvm/Transforms/Vectorize.h" 88 #include <algorithm> 89 #include <cassert> 90 #include <cstdint> 91 #include <iterator> 92 #include <memory> 93 #include <set> 94 #include <string> 95 #include <tuple> 96 #include <utility> 97 #include <vector> 98 99 using namespace llvm; 100 using namespace llvm::PatternMatch; 101 using namespace slpvectorizer; 102 103 #define SV_NAME "slp-vectorizer" 104 #define DEBUG_TYPE "SLP" 105 106 STATISTIC(NumVectorInstructions, "Number of vector instructions generated"); 107 108 cl::opt<bool> RunSLPVectorization("vectorize-slp", cl::init(true), cl::Hidden, 109 cl::desc("Run the SLP vectorization passes")); 110 111 static cl::opt<int> 112 SLPCostThreshold("slp-threshold", cl::init(0), cl::Hidden, 113 cl::desc("Only vectorize if you gain more than this " 114 "number ")); 115 116 static cl::opt<bool> 117 ShouldVectorizeHor("slp-vectorize-hor", cl::init(true), cl::Hidden, 118 cl::desc("Attempt to vectorize horizontal reductions")); 119 120 static cl::opt<bool> ShouldStartVectorizeHorAtStore( 121 "slp-vectorize-hor-store", cl::init(false), cl::Hidden, 122 cl::desc( 123 "Attempt to vectorize horizontal reductions feeding into a store")); 124 125 static cl::opt<int> 126 MaxVectorRegSizeOption("slp-max-reg-size", cl::init(128), cl::Hidden, 127 cl::desc("Attempt to vectorize for this register size in bits")); 128 129 static cl::opt<int> 130 MaxStoreLookup("slp-max-store-lookup", cl::init(32), cl::Hidden, 131 cl::desc("Maximum depth of the lookup for consecutive stores.")); 132 133 /// Limits the size of scheduling regions in a block. 134 /// It avoid long compile times for _very_ large blocks where vector 135 /// instructions are spread over a wide range. 136 /// This limit is way higher than needed by real-world functions. 137 static cl::opt<int> 138 ScheduleRegionSizeBudget("slp-schedule-budget", cl::init(100000), cl::Hidden, 139 cl::desc("Limit the size of the SLP scheduling region per block")); 140 141 static cl::opt<int> MinVectorRegSizeOption( 142 "slp-min-reg-size", cl::init(128), cl::Hidden, 143 cl::desc("Attempt to vectorize for this register size in bits")); 144 145 static cl::opt<unsigned> RecursionMaxDepth( 146 "slp-recursion-max-depth", cl::init(12), cl::Hidden, 147 cl::desc("Limit the recursion depth when building a vectorizable tree")); 148 149 static cl::opt<unsigned> MinTreeSize( 150 "slp-min-tree-size", cl::init(3), cl::Hidden, 151 cl::desc("Only vectorize small trees if they are fully vectorizable")); 152 153 // The maximum depth that the look-ahead score heuristic will explore. 154 // The higher this value, the higher the compilation time overhead. 155 static cl::opt<int> LookAheadMaxDepth( 156 "slp-max-look-ahead-depth", cl::init(2), cl::Hidden, 157 cl::desc("The maximum look-ahead depth for operand reordering scores")); 158 159 // The Look-ahead heuristic goes through the users of the bundle to calculate 160 // the users cost in getExternalUsesCost(). To avoid compilation time increase 161 // we limit the number of users visited to this value. 162 static cl::opt<unsigned> LookAheadUsersBudget( 163 "slp-look-ahead-users-budget", cl::init(2), cl::Hidden, 164 cl::desc("The maximum number of users to visit while visiting the " 165 "predecessors. This prevents compilation time increase.")); 166 167 static cl::opt<bool> 168 ViewSLPTree("view-slp-tree", cl::Hidden, 169 cl::desc("Display the SLP trees with Graphviz")); 170 171 // Limit the number of alias checks. The limit is chosen so that 172 // it has no negative effect on the llvm benchmarks. 173 static const unsigned AliasedCheckLimit = 10; 174 175 // Another limit for the alias checks: The maximum distance between load/store 176 // instructions where alias checks are done. 177 // This limit is useful for very large basic blocks. 178 static const unsigned MaxMemDepDistance = 160; 179 180 /// If the ScheduleRegionSizeBudget is exhausted, we allow small scheduling 181 /// regions to be handled. 182 static const int MinScheduleRegionSize = 16; 183 184 /// Predicate for the element types that the SLP vectorizer supports. 185 /// 186 /// The most important thing to filter here are types which are invalid in LLVM 187 /// vectors. We also filter target specific types which have absolutely no 188 /// meaningful vectorization path such as x86_fp80 and ppc_f128. This just 189 /// avoids spending time checking the cost model and realizing that they will 190 /// be inevitably scalarized. 191 static bool isValidElementType(Type *Ty) { 192 return VectorType::isValidElementType(Ty) && !Ty->isX86_FP80Ty() && 193 !Ty->isPPC_FP128Ty(); 194 } 195 196 /// \returns true if all of the instructions in \p VL are in the same block or 197 /// false otherwise. 198 static bool allSameBlock(ArrayRef<Value *> VL) { 199 Instruction *I0 = dyn_cast<Instruction>(VL[0]); 200 if (!I0) 201 return false; 202 BasicBlock *BB = I0->getParent(); 203 for (int I = 1, E = VL.size(); I < E; I++) { 204 auto *II = dyn_cast<Instruction>(VL[I]); 205 if (!II) 206 return false; 207 208 if (BB != II->getParent()) 209 return false; 210 } 211 return true; 212 } 213 214 /// \returns True if all of the values in \p VL are constants (but not 215 /// globals/constant expressions). 216 static bool allConstant(ArrayRef<Value *> VL) { 217 // Constant expressions and globals can't be vectorized like normal integer/FP 218 // constants. 219 for (Value *i : VL) 220 if (!isa<Constant>(i) || isa<ConstantExpr>(i) || isa<GlobalValue>(i)) 221 return false; 222 return true; 223 } 224 225 /// \returns True if all of the values in \p VL are identical. 226 static bool isSplat(ArrayRef<Value *> VL) { 227 for (unsigned i = 1, e = VL.size(); i < e; ++i) 228 if (VL[i] != VL[0]) 229 return false; 230 return true; 231 } 232 233 /// \returns True if \p I is commutative, handles CmpInst and BinaryOperator. 234 static bool isCommutative(Instruction *I) { 235 if (auto *Cmp = dyn_cast<CmpInst>(I)) 236 return Cmp->isCommutative(); 237 if (auto *BO = dyn_cast<BinaryOperator>(I)) 238 return BO->isCommutative(); 239 // TODO: This should check for generic Instruction::isCommutative(), but 240 // we need to confirm that the caller code correctly handles Intrinsics 241 // for example (does not have 2 operands). 242 return false; 243 } 244 245 /// Checks if the vector of instructions can be represented as a shuffle, like: 246 /// %x0 = extractelement <4 x i8> %x, i32 0 247 /// %x3 = extractelement <4 x i8> %x, i32 3 248 /// %y1 = extractelement <4 x i8> %y, i32 1 249 /// %y2 = extractelement <4 x i8> %y, i32 2 250 /// %x0x0 = mul i8 %x0, %x0 251 /// %x3x3 = mul i8 %x3, %x3 252 /// %y1y1 = mul i8 %y1, %y1 253 /// %y2y2 = mul i8 %y2, %y2 254 /// %ins1 = insertelement <4 x i8> undef, i8 %x0x0, i32 0 255 /// %ins2 = insertelement <4 x i8> %ins1, i8 %x3x3, i32 1 256 /// %ins3 = insertelement <4 x i8> %ins2, i8 %y1y1, i32 2 257 /// %ins4 = insertelement <4 x i8> %ins3, i8 %y2y2, i32 3 258 /// ret <4 x i8> %ins4 259 /// can be transformed into: 260 /// %1 = shufflevector <4 x i8> %x, <4 x i8> %y, <4 x i32> <i32 0, i32 3, i32 5, 261 /// i32 6> 262 /// %2 = mul <4 x i8> %1, %1 263 /// ret <4 x i8> %2 264 /// We convert this initially to something like: 265 /// %x0 = extractelement <4 x i8> %x, i32 0 266 /// %x3 = extractelement <4 x i8> %x, i32 3 267 /// %y1 = extractelement <4 x i8> %y, i32 1 268 /// %y2 = extractelement <4 x i8> %y, i32 2 269 /// %1 = insertelement <4 x i8> undef, i8 %x0, i32 0 270 /// %2 = insertelement <4 x i8> %1, i8 %x3, i32 1 271 /// %3 = insertelement <4 x i8> %2, i8 %y1, i32 2 272 /// %4 = insertelement <4 x i8> %3, i8 %y2, i32 3 273 /// %5 = mul <4 x i8> %4, %4 274 /// %6 = extractelement <4 x i8> %5, i32 0 275 /// %ins1 = insertelement <4 x i8> undef, i8 %6, i32 0 276 /// %7 = extractelement <4 x i8> %5, i32 1 277 /// %ins2 = insertelement <4 x i8> %ins1, i8 %7, i32 1 278 /// %8 = extractelement <4 x i8> %5, i32 2 279 /// %ins3 = insertelement <4 x i8> %ins2, i8 %8, i32 2 280 /// %9 = extractelement <4 x i8> %5, i32 3 281 /// %ins4 = insertelement <4 x i8> %ins3, i8 %9, i32 3 282 /// ret <4 x i8> %ins4 283 /// InstCombiner transforms this into a shuffle and vector mul 284 /// TODO: Can we split off and reuse the shuffle mask detection from 285 /// TargetTransformInfo::getInstructionThroughput? 286 static Optional<TargetTransformInfo::ShuffleKind> 287 isShuffle(ArrayRef<Value *> VL) { 288 auto *EI0 = cast<ExtractElementInst>(VL[0]); 289 unsigned Size = 290 cast<FixedVectorType>(EI0->getVectorOperandType())->getNumElements(); 291 Value *Vec1 = nullptr; 292 Value *Vec2 = nullptr; 293 enum ShuffleMode { Unknown, Select, Permute }; 294 ShuffleMode CommonShuffleMode = Unknown; 295 for (unsigned I = 0, E = VL.size(); I < E; ++I) { 296 auto *EI = cast<ExtractElementInst>(VL[I]); 297 auto *Vec = EI->getVectorOperand(); 298 // All vector operands must have the same number of vector elements. 299 if (cast<FixedVectorType>(Vec->getType())->getNumElements() != Size) 300 return None; 301 auto *Idx = dyn_cast<ConstantInt>(EI->getIndexOperand()); 302 if (!Idx) 303 return None; 304 // Undefined behavior if Idx is negative or >= Size. 305 if (Idx->getValue().uge(Size)) 306 continue; 307 unsigned IntIdx = Idx->getValue().getZExtValue(); 308 // We can extractelement from undef vector. 309 if (isa<UndefValue>(Vec)) 310 continue; 311 // For correct shuffling we have to have at most 2 different vector operands 312 // in all extractelement instructions. 313 if (!Vec1 || Vec1 == Vec) 314 Vec1 = Vec; 315 else if (!Vec2 || Vec2 == Vec) 316 Vec2 = Vec; 317 else 318 return None; 319 if (CommonShuffleMode == Permute) 320 continue; 321 // If the extract index is not the same as the operation number, it is a 322 // permutation. 323 if (IntIdx != I) { 324 CommonShuffleMode = Permute; 325 continue; 326 } 327 CommonShuffleMode = Select; 328 } 329 // If we're not crossing lanes in different vectors, consider it as blending. 330 if (CommonShuffleMode == Select && Vec2) 331 return TargetTransformInfo::SK_Select; 332 // If Vec2 was never used, we have a permutation of a single vector, otherwise 333 // we have permutation of 2 vectors. 334 return Vec2 ? TargetTransformInfo::SK_PermuteTwoSrc 335 : TargetTransformInfo::SK_PermuteSingleSrc; 336 } 337 338 namespace { 339 340 /// Main data required for vectorization of instructions. 341 struct InstructionsState { 342 /// The very first instruction in the list with the main opcode. 343 Value *OpValue = nullptr; 344 345 /// The main/alternate instruction. 346 Instruction *MainOp = nullptr; 347 Instruction *AltOp = nullptr; 348 349 /// The main/alternate opcodes for the list of instructions. 350 unsigned getOpcode() const { 351 return MainOp ? MainOp->getOpcode() : 0; 352 } 353 354 unsigned getAltOpcode() const { 355 return AltOp ? AltOp->getOpcode() : 0; 356 } 357 358 /// Some of the instructions in the list have alternate opcodes. 359 bool isAltShuffle() const { return getOpcode() != getAltOpcode(); } 360 361 bool isOpcodeOrAlt(Instruction *I) const { 362 unsigned CheckedOpcode = I->getOpcode(); 363 return getOpcode() == CheckedOpcode || getAltOpcode() == CheckedOpcode; 364 } 365 366 InstructionsState() = delete; 367 InstructionsState(Value *OpValue, Instruction *MainOp, Instruction *AltOp) 368 : OpValue(OpValue), MainOp(MainOp), AltOp(AltOp) {} 369 }; 370 371 } // end anonymous namespace 372 373 /// Chooses the correct key for scheduling data. If \p Op has the same (or 374 /// alternate) opcode as \p OpValue, the key is \p Op. Otherwise the key is \p 375 /// OpValue. 376 static Value *isOneOf(const InstructionsState &S, Value *Op) { 377 auto *I = dyn_cast<Instruction>(Op); 378 if (I && S.isOpcodeOrAlt(I)) 379 return Op; 380 return S.OpValue; 381 } 382 383 /// \returns true if \p Opcode is allowed as part of of the main/alternate 384 /// instruction for SLP vectorization. 385 /// 386 /// Example of unsupported opcode is SDIV that can potentially cause UB if the 387 /// "shuffled out" lane would result in division by zero. 388 static bool isValidForAlternation(unsigned Opcode) { 389 if (Instruction::isIntDivRem(Opcode)) 390 return false; 391 392 return true; 393 } 394 395 /// \returns analysis of the Instructions in \p VL described in 396 /// InstructionsState, the Opcode that we suppose the whole list 397 /// could be vectorized even if its structure is diverse. 398 static InstructionsState getSameOpcode(ArrayRef<Value *> VL, 399 unsigned BaseIndex = 0) { 400 // Make sure these are all Instructions. 401 if (llvm::any_of(VL, [](Value *V) { return !isa<Instruction>(V); })) 402 return InstructionsState(VL[BaseIndex], nullptr, nullptr); 403 404 bool IsCastOp = isa<CastInst>(VL[BaseIndex]); 405 bool IsBinOp = isa<BinaryOperator>(VL[BaseIndex]); 406 unsigned Opcode = cast<Instruction>(VL[BaseIndex])->getOpcode(); 407 unsigned AltOpcode = Opcode; 408 unsigned AltIndex = BaseIndex; 409 410 // Check for one alternate opcode from another BinaryOperator. 411 // TODO - generalize to support all operators (types, calls etc.). 412 for (int Cnt = 0, E = VL.size(); Cnt < E; Cnt++) { 413 unsigned InstOpcode = cast<Instruction>(VL[Cnt])->getOpcode(); 414 if (IsBinOp && isa<BinaryOperator>(VL[Cnt])) { 415 if (InstOpcode == Opcode || InstOpcode == AltOpcode) 416 continue; 417 if (Opcode == AltOpcode && isValidForAlternation(InstOpcode) && 418 isValidForAlternation(Opcode)) { 419 AltOpcode = InstOpcode; 420 AltIndex = Cnt; 421 continue; 422 } 423 } else if (IsCastOp && isa<CastInst>(VL[Cnt])) { 424 Type *Ty0 = cast<Instruction>(VL[BaseIndex])->getOperand(0)->getType(); 425 Type *Ty1 = cast<Instruction>(VL[Cnt])->getOperand(0)->getType(); 426 if (Ty0 == Ty1) { 427 if (InstOpcode == Opcode || InstOpcode == AltOpcode) 428 continue; 429 if (Opcode == AltOpcode) { 430 assert(isValidForAlternation(Opcode) && 431 isValidForAlternation(InstOpcode) && 432 "Cast isn't safe for alternation, logic needs to be updated!"); 433 AltOpcode = InstOpcode; 434 AltIndex = Cnt; 435 continue; 436 } 437 } 438 } else if (InstOpcode == Opcode || InstOpcode == AltOpcode) 439 continue; 440 return InstructionsState(VL[BaseIndex], nullptr, nullptr); 441 } 442 443 return InstructionsState(VL[BaseIndex], cast<Instruction>(VL[BaseIndex]), 444 cast<Instruction>(VL[AltIndex])); 445 } 446 447 /// \returns true if all of the values in \p VL have the same type or false 448 /// otherwise. 449 static bool allSameType(ArrayRef<Value *> VL) { 450 Type *Ty = VL[0]->getType(); 451 for (int i = 1, e = VL.size(); i < e; i++) 452 if (VL[i]->getType() != Ty) 453 return false; 454 455 return true; 456 } 457 458 /// \returns True if Extract{Value,Element} instruction extracts element Idx. 459 static Optional<unsigned> getExtractIndex(Instruction *E) { 460 unsigned Opcode = E->getOpcode(); 461 assert((Opcode == Instruction::ExtractElement || 462 Opcode == Instruction::ExtractValue) && 463 "Expected extractelement or extractvalue instruction."); 464 if (Opcode == Instruction::ExtractElement) { 465 auto *CI = dyn_cast<ConstantInt>(E->getOperand(1)); 466 if (!CI) 467 return None; 468 return CI->getZExtValue(); 469 } 470 ExtractValueInst *EI = cast<ExtractValueInst>(E); 471 if (EI->getNumIndices() != 1) 472 return None; 473 return *EI->idx_begin(); 474 } 475 476 /// \returns True if in-tree use also needs extract. This refers to 477 /// possible scalar operand in vectorized instruction. 478 static bool InTreeUserNeedToExtract(Value *Scalar, Instruction *UserInst, 479 TargetLibraryInfo *TLI) { 480 unsigned Opcode = UserInst->getOpcode(); 481 switch (Opcode) { 482 case Instruction::Load: { 483 LoadInst *LI = cast<LoadInst>(UserInst); 484 return (LI->getPointerOperand() == Scalar); 485 } 486 case Instruction::Store: { 487 StoreInst *SI = cast<StoreInst>(UserInst); 488 return (SI->getPointerOperand() == Scalar); 489 } 490 case Instruction::Call: { 491 CallInst *CI = cast<CallInst>(UserInst); 492 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 493 for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i) { 494 if (hasVectorInstrinsicScalarOpd(ID, i)) 495 return (CI->getArgOperand(i) == Scalar); 496 } 497 LLVM_FALLTHROUGH; 498 } 499 default: 500 return false; 501 } 502 } 503 504 /// \returns the AA location that is being access by the instruction. 505 static MemoryLocation getLocation(Instruction *I, AAResults *AA) { 506 if (StoreInst *SI = dyn_cast<StoreInst>(I)) 507 return MemoryLocation::get(SI); 508 if (LoadInst *LI = dyn_cast<LoadInst>(I)) 509 return MemoryLocation::get(LI); 510 return MemoryLocation(); 511 } 512 513 /// \returns True if the instruction is not a volatile or atomic load/store. 514 static bool isSimple(Instruction *I) { 515 if (LoadInst *LI = dyn_cast<LoadInst>(I)) 516 return LI->isSimple(); 517 if (StoreInst *SI = dyn_cast<StoreInst>(I)) 518 return SI->isSimple(); 519 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I)) 520 return !MI->isVolatile(); 521 return true; 522 } 523 524 namespace llvm { 525 526 static void inversePermutation(ArrayRef<unsigned> Indices, 527 SmallVectorImpl<int> &Mask) { 528 Mask.clear(); 529 const unsigned E = Indices.size(); 530 Mask.resize(E, E + 1); 531 for (unsigned I = 0; I < E; ++I) 532 Mask[Indices[I]] = I; 533 } 534 535 namespace slpvectorizer { 536 537 /// Bottom Up SLP Vectorizer. 538 class BoUpSLP { 539 struct TreeEntry; 540 struct ScheduleData; 541 542 public: 543 using ValueList = SmallVector<Value *, 8>; 544 using InstrList = SmallVector<Instruction *, 16>; 545 using ValueSet = SmallPtrSet<Value *, 16>; 546 using StoreList = SmallVector<StoreInst *, 8>; 547 using ExtraValueToDebugLocsMap = 548 MapVector<Value *, SmallVector<Instruction *, 2>>; 549 using OrdersType = SmallVector<unsigned, 4>; 550 551 BoUpSLP(Function *Func, ScalarEvolution *Se, TargetTransformInfo *Tti, 552 TargetLibraryInfo *TLi, AAResults *Aa, LoopInfo *Li, 553 DominatorTree *Dt, AssumptionCache *AC, DemandedBits *DB, 554 const DataLayout *DL, OptimizationRemarkEmitter *ORE) 555 : F(Func), SE(Se), TTI(Tti), TLI(TLi), AA(Aa), LI(Li), DT(Dt), AC(AC), 556 DB(DB), DL(DL), ORE(ORE), Builder(Se->getContext()) { 557 CodeMetrics::collectEphemeralValues(F, AC, EphValues); 558 // Use the vector register size specified by the target unless overridden 559 // by a command-line option. 560 // TODO: It would be better to limit the vectorization factor based on 561 // data type rather than just register size. For example, x86 AVX has 562 // 256-bit registers, but it does not support integer operations 563 // at that width (that requires AVX2). 564 if (MaxVectorRegSizeOption.getNumOccurrences()) 565 MaxVecRegSize = MaxVectorRegSizeOption; 566 else 567 MaxVecRegSize = TTI->getRegisterBitWidth(true); 568 569 if (MinVectorRegSizeOption.getNumOccurrences()) 570 MinVecRegSize = MinVectorRegSizeOption; 571 else 572 MinVecRegSize = TTI->getMinVectorRegisterBitWidth(); 573 } 574 575 /// Vectorize the tree that starts with the elements in \p VL. 576 /// Returns the vectorized root. 577 Value *vectorizeTree(); 578 579 /// Vectorize the tree but with the list of externally used values \p 580 /// ExternallyUsedValues. Values in this MapVector can be replaced but the 581 /// generated extractvalue instructions. 582 Value *vectorizeTree(ExtraValueToDebugLocsMap &ExternallyUsedValues); 583 584 /// \returns the cost incurred by unwanted spills and fills, caused by 585 /// holding live values over call sites. 586 int getSpillCost() const; 587 588 /// \returns the vectorization cost of the subtree that starts at \p VL. 589 /// A negative number means that this is profitable. 590 int getTreeCost(); 591 592 /// Construct a vectorizable tree that starts at \p Roots, ignoring users for 593 /// the purpose of scheduling and extraction in the \p UserIgnoreLst. 594 void buildTree(ArrayRef<Value *> Roots, 595 ArrayRef<Value *> UserIgnoreLst = None); 596 597 /// Construct a vectorizable tree that starts at \p Roots, ignoring users for 598 /// the purpose of scheduling and extraction in the \p UserIgnoreLst taking 599 /// into account (and updating it, if required) list of externally used 600 /// values stored in \p ExternallyUsedValues. 601 void buildTree(ArrayRef<Value *> Roots, 602 ExtraValueToDebugLocsMap &ExternallyUsedValues, 603 ArrayRef<Value *> UserIgnoreLst = None); 604 605 /// Clear the internal data structures that are created by 'buildTree'. 606 void deleteTree() { 607 VectorizableTree.clear(); 608 ScalarToTreeEntry.clear(); 609 MustGather.clear(); 610 ExternalUses.clear(); 611 NumOpsWantToKeepOrder.clear(); 612 NumOpsWantToKeepOriginalOrder = 0; 613 for (auto &Iter : BlocksSchedules) { 614 BlockScheduling *BS = Iter.second.get(); 615 BS->clear(); 616 } 617 MinBWs.clear(); 618 } 619 620 unsigned getTreeSize() const { return VectorizableTree.size(); } 621 622 /// Perform LICM and CSE on the newly generated gather sequences. 623 void optimizeGatherSequence(); 624 625 /// \returns The best order of instructions for vectorization. 626 Optional<ArrayRef<unsigned>> bestOrder() const { 627 assert(llvm::all_of( 628 NumOpsWantToKeepOrder, 629 [this](const decltype(NumOpsWantToKeepOrder)::value_type &D) { 630 return D.getFirst().size() == 631 VectorizableTree[0]->Scalars.size(); 632 }) && 633 "All orders must have the same size as number of instructions in " 634 "tree node."); 635 auto I = std::max_element( 636 NumOpsWantToKeepOrder.begin(), NumOpsWantToKeepOrder.end(), 637 [](const decltype(NumOpsWantToKeepOrder)::value_type &D1, 638 const decltype(NumOpsWantToKeepOrder)::value_type &D2) { 639 return D1.second < D2.second; 640 }); 641 if (I == NumOpsWantToKeepOrder.end() || 642 I->getSecond() <= NumOpsWantToKeepOriginalOrder) 643 return None; 644 645 return makeArrayRef(I->getFirst()); 646 } 647 648 /// Builds the correct order for root instructions. 649 /// If some leaves have the same instructions to be vectorized, we may 650 /// incorrectly evaluate the best order for the root node (it is built for the 651 /// vector of instructions without repeated instructions and, thus, has less 652 /// elements than the root node). This function builds the correct order for 653 /// the root node. 654 /// For example, if the root node is \<a+b, a+c, a+d, f+e\>, then the leaves 655 /// are \<a, a, a, f\> and \<b, c, d, e\>. When we try to vectorize the first 656 /// leaf, it will be shrink to \<a, b\>. If instructions in this leaf should 657 /// be reordered, the best order will be \<1, 0\>. We need to extend this 658 /// order for the root node. For the root node this order should look like 659 /// \<3, 0, 1, 2\>. This function extends the order for the reused 660 /// instructions. 661 void findRootOrder(OrdersType &Order) { 662 // If the leaf has the same number of instructions to vectorize as the root 663 // - order must be set already. 664 unsigned RootSize = VectorizableTree[0]->Scalars.size(); 665 if (Order.size() == RootSize) 666 return; 667 SmallVector<unsigned, 4> RealOrder(Order.size()); 668 std::swap(Order, RealOrder); 669 SmallVector<int, 4> Mask; 670 inversePermutation(RealOrder, Mask); 671 Order.assign(Mask.begin(), Mask.end()); 672 // The leaf has less number of instructions - need to find the true order of 673 // the root. 674 // Scan the nodes starting from the leaf back to the root. 675 const TreeEntry *PNode = VectorizableTree.back().get(); 676 SmallVector<const TreeEntry *, 4> Nodes(1, PNode); 677 SmallPtrSet<const TreeEntry *, 4> Visited; 678 while (!Nodes.empty() && Order.size() != RootSize) { 679 const TreeEntry *PNode = Nodes.pop_back_val(); 680 if (!Visited.insert(PNode).second) 681 continue; 682 const TreeEntry &Node = *PNode; 683 for (const EdgeInfo &EI : Node.UserTreeIndices) 684 if (EI.UserTE) 685 Nodes.push_back(EI.UserTE); 686 if (Node.ReuseShuffleIndices.empty()) 687 continue; 688 // Build the order for the parent node. 689 OrdersType NewOrder(Node.ReuseShuffleIndices.size(), RootSize); 690 SmallVector<unsigned, 4> OrderCounter(Order.size(), 0); 691 // The algorithm of the order extension is: 692 // 1. Calculate the number of the same instructions for the order. 693 // 2. Calculate the index of the new order: total number of instructions 694 // with order less than the order of the current instruction + reuse 695 // number of the current instruction. 696 // 3. The new order is just the index of the instruction in the original 697 // vector of the instructions. 698 for (unsigned I : Node.ReuseShuffleIndices) 699 ++OrderCounter[Order[I]]; 700 SmallVector<unsigned, 4> CurrentCounter(Order.size(), 0); 701 for (unsigned I = 0, E = Node.ReuseShuffleIndices.size(); I < E; ++I) { 702 unsigned ReusedIdx = Node.ReuseShuffleIndices[I]; 703 unsigned OrderIdx = Order[ReusedIdx]; 704 unsigned NewIdx = 0; 705 for (unsigned J = 0; J < OrderIdx; ++J) 706 NewIdx += OrderCounter[J]; 707 NewIdx += CurrentCounter[OrderIdx]; 708 ++CurrentCounter[OrderIdx]; 709 assert(NewOrder[NewIdx] == RootSize && 710 "The order index should not be written already."); 711 NewOrder[NewIdx] = I; 712 } 713 std::swap(Order, NewOrder); 714 } 715 assert(Order.size() == RootSize && 716 "Root node is expected or the size of the order must be the same as " 717 "the number of elements in the root node."); 718 assert(llvm::all_of(Order, 719 [RootSize](unsigned Val) { return Val != RootSize; }) && 720 "All indices must be initialized"); 721 } 722 723 /// \return The vector element size in bits to use when vectorizing the 724 /// expression tree ending at \p V. If V is a store, the size is the width of 725 /// the stored value. Otherwise, the size is the width of the largest loaded 726 /// value reaching V. This method is used by the vectorizer to calculate 727 /// vectorization factors. 728 unsigned getVectorElementSize(Value *V); 729 730 /// Compute the minimum type sizes required to represent the entries in a 731 /// vectorizable tree. 732 void computeMinimumValueSizes(); 733 734 // \returns maximum vector register size as set by TTI or overridden by cl::opt. 735 unsigned getMaxVecRegSize() const { 736 return MaxVecRegSize; 737 } 738 739 // \returns minimum vector register size as set by cl::opt. 740 unsigned getMinVecRegSize() const { 741 return MinVecRegSize; 742 } 743 744 /// Check if homogeneous aggregate is isomorphic to some VectorType. 745 /// Accepts homogeneous multidimensional aggregate of scalars/vectors like 746 /// {[4 x i16], [4 x i16]}, { <2 x float>, <2 x float> }, 747 /// {{{i16, i16}, {i16, i16}}, {{i16, i16}, {i16, i16}}} and so on. 748 /// 749 /// \returns number of elements in vector if isomorphism exists, 0 otherwise. 750 unsigned canMapToVector(Type *T, const DataLayout &DL) const; 751 752 /// \returns True if the VectorizableTree is both tiny and not fully 753 /// vectorizable. We do not vectorize such trees. 754 bool isTreeTinyAndNotFullyVectorizable() const; 755 756 /// Assume that a legal-sized 'or'-reduction of shifted/zexted loaded values 757 /// can be load combined in the backend. Load combining may not be allowed in 758 /// the IR optimizer, so we do not want to alter the pattern. For example, 759 /// partially transforming a scalar bswap() pattern into vector code is 760 /// effectively impossible for the backend to undo. 761 /// TODO: If load combining is allowed in the IR optimizer, this analysis 762 /// may not be necessary. 763 bool isLoadCombineReductionCandidate(unsigned ReductionOpcode) const; 764 765 /// Assume that a vector of stores of bitwise-or/shifted/zexted loaded values 766 /// can be load combined in the backend. Load combining may not be allowed in 767 /// the IR optimizer, so we do not want to alter the pattern. For example, 768 /// partially transforming a scalar bswap() pattern into vector code is 769 /// effectively impossible for the backend to undo. 770 /// TODO: If load combining is allowed in the IR optimizer, this analysis 771 /// may not be necessary. 772 bool isLoadCombineCandidate() const; 773 774 OptimizationRemarkEmitter *getORE() { return ORE; } 775 776 /// This structure holds any data we need about the edges being traversed 777 /// during buildTree_rec(). We keep track of: 778 /// (i) the user TreeEntry index, and 779 /// (ii) the index of the edge. 780 struct EdgeInfo { 781 EdgeInfo() = default; 782 EdgeInfo(TreeEntry *UserTE, unsigned EdgeIdx) 783 : UserTE(UserTE), EdgeIdx(EdgeIdx) {} 784 /// The user TreeEntry. 785 TreeEntry *UserTE = nullptr; 786 /// The operand index of the use. 787 unsigned EdgeIdx = UINT_MAX; 788 #ifndef NDEBUG 789 friend inline raw_ostream &operator<<(raw_ostream &OS, 790 const BoUpSLP::EdgeInfo &EI) { 791 EI.dump(OS); 792 return OS; 793 } 794 /// Debug print. 795 void dump(raw_ostream &OS) const { 796 OS << "{User:" << (UserTE ? std::to_string(UserTE->Idx) : "null") 797 << " EdgeIdx:" << EdgeIdx << "}"; 798 } 799 LLVM_DUMP_METHOD void dump() const { dump(dbgs()); } 800 #endif 801 }; 802 803 /// A helper data structure to hold the operands of a vector of instructions. 804 /// This supports a fixed vector length for all operand vectors. 805 class VLOperands { 806 /// For each operand we need (i) the value, and (ii) the opcode that it 807 /// would be attached to if the expression was in a left-linearized form. 808 /// This is required to avoid illegal operand reordering. 809 /// For example: 810 /// \verbatim 811 /// 0 Op1 812 /// |/ 813 /// Op1 Op2 Linearized + Op2 814 /// \ / ----------> |/ 815 /// - - 816 /// 817 /// Op1 - Op2 (0 + Op1) - Op2 818 /// \endverbatim 819 /// 820 /// Value Op1 is attached to a '+' operation, and Op2 to a '-'. 821 /// 822 /// Another way to think of this is to track all the operations across the 823 /// path from the operand all the way to the root of the tree and to 824 /// calculate the operation that corresponds to this path. For example, the 825 /// path from Op2 to the root crosses the RHS of the '-', therefore the 826 /// corresponding operation is a '-' (which matches the one in the 827 /// linearized tree, as shown above). 828 /// 829 /// For lack of a better term, we refer to this operation as Accumulated 830 /// Path Operation (APO). 831 struct OperandData { 832 OperandData() = default; 833 OperandData(Value *V, bool APO, bool IsUsed) 834 : V(V), APO(APO), IsUsed(IsUsed) {} 835 /// The operand value. 836 Value *V = nullptr; 837 /// TreeEntries only allow a single opcode, or an alternate sequence of 838 /// them (e.g, +, -). Therefore, we can safely use a boolean value for the 839 /// APO. It is set to 'true' if 'V' is attached to an inverse operation 840 /// in the left-linearized form (e.g., Sub/Div), and 'false' otherwise 841 /// (e.g., Add/Mul) 842 bool APO = false; 843 /// Helper data for the reordering function. 844 bool IsUsed = false; 845 }; 846 847 /// During operand reordering, we are trying to select the operand at lane 848 /// that matches best with the operand at the neighboring lane. Our 849 /// selection is based on the type of value we are looking for. For example, 850 /// if the neighboring lane has a load, we need to look for a load that is 851 /// accessing a consecutive address. These strategies are summarized in the 852 /// 'ReorderingMode' enumerator. 853 enum class ReorderingMode { 854 Load, ///< Matching loads to consecutive memory addresses 855 Opcode, ///< Matching instructions based on opcode (same or alternate) 856 Constant, ///< Matching constants 857 Splat, ///< Matching the same instruction multiple times (broadcast) 858 Failed, ///< We failed to create a vectorizable group 859 }; 860 861 using OperandDataVec = SmallVector<OperandData, 2>; 862 863 /// A vector of operand vectors. 864 SmallVector<OperandDataVec, 4> OpsVec; 865 866 const DataLayout &DL; 867 ScalarEvolution &SE; 868 const BoUpSLP &R; 869 870 /// \returns the operand data at \p OpIdx and \p Lane. 871 OperandData &getData(unsigned OpIdx, unsigned Lane) { 872 return OpsVec[OpIdx][Lane]; 873 } 874 875 /// \returns the operand data at \p OpIdx and \p Lane. Const version. 876 const OperandData &getData(unsigned OpIdx, unsigned Lane) const { 877 return OpsVec[OpIdx][Lane]; 878 } 879 880 /// Clears the used flag for all entries. 881 void clearUsed() { 882 for (unsigned OpIdx = 0, NumOperands = getNumOperands(); 883 OpIdx != NumOperands; ++OpIdx) 884 for (unsigned Lane = 0, NumLanes = getNumLanes(); Lane != NumLanes; 885 ++Lane) 886 OpsVec[OpIdx][Lane].IsUsed = false; 887 } 888 889 /// Swap the operand at \p OpIdx1 with that one at \p OpIdx2. 890 void swap(unsigned OpIdx1, unsigned OpIdx2, unsigned Lane) { 891 std::swap(OpsVec[OpIdx1][Lane], OpsVec[OpIdx2][Lane]); 892 } 893 894 // The hard-coded scores listed here are not very important. When computing 895 // the scores of matching one sub-tree with another, we are basically 896 // counting the number of values that are matching. So even if all scores 897 // are set to 1, we would still get a decent matching result. 898 // However, sometimes we have to break ties. For example we may have to 899 // choose between matching loads vs matching opcodes. This is what these 900 // scores are helping us with: they provide the order of preference. 901 902 /// Loads from consecutive memory addresses, e.g. load(A[i]), load(A[i+1]). 903 static const int ScoreConsecutiveLoads = 3; 904 /// ExtractElementInst from same vector and consecutive indexes. 905 static const int ScoreConsecutiveExtracts = 3; 906 /// Constants. 907 static const int ScoreConstants = 2; 908 /// Instructions with the same opcode. 909 static const int ScoreSameOpcode = 2; 910 /// Instructions with alt opcodes (e.g, add + sub). 911 static const int ScoreAltOpcodes = 1; 912 /// Identical instructions (a.k.a. splat or broadcast). 913 static const int ScoreSplat = 1; 914 /// Matching with an undef is preferable to failing. 915 static const int ScoreUndef = 1; 916 /// Score for failing to find a decent match. 917 static const int ScoreFail = 0; 918 /// User exteranl to the vectorized code. 919 static const int ExternalUseCost = 1; 920 /// The user is internal but in a different lane. 921 static const int UserInDiffLaneCost = ExternalUseCost; 922 923 /// \returns the score of placing \p V1 and \p V2 in consecutive lanes. 924 static int getShallowScore(Value *V1, Value *V2, const DataLayout &DL, 925 ScalarEvolution &SE) { 926 auto *LI1 = dyn_cast<LoadInst>(V1); 927 auto *LI2 = dyn_cast<LoadInst>(V2); 928 if (LI1 && LI2) 929 return isConsecutiveAccess(LI1, LI2, DL, SE) 930 ? VLOperands::ScoreConsecutiveLoads 931 : VLOperands::ScoreFail; 932 933 auto *C1 = dyn_cast<Constant>(V1); 934 auto *C2 = dyn_cast<Constant>(V2); 935 if (C1 && C2) 936 return VLOperands::ScoreConstants; 937 938 // Extracts from consecutive indexes of the same vector better score as 939 // the extracts could be optimized away. 940 Value *EV; 941 ConstantInt *Ex1Idx, *Ex2Idx; 942 if (match(V1, m_ExtractElt(m_Value(EV), m_ConstantInt(Ex1Idx))) && 943 match(V2, m_ExtractElt(m_Deferred(EV), m_ConstantInt(Ex2Idx))) && 944 Ex1Idx->getZExtValue() + 1 == Ex2Idx->getZExtValue()) 945 return VLOperands::ScoreConsecutiveExtracts; 946 947 auto *I1 = dyn_cast<Instruction>(V1); 948 auto *I2 = dyn_cast<Instruction>(V2); 949 if (I1 && I2) { 950 if (I1 == I2) 951 return VLOperands::ScoreSplat; 952 InstructionsState S = getSameOpcode({I1, I2}); 953 // Note: Only consider instructions with <= 2 operands to avoid 954 // complexity explosion. 955 if (S.getOpcode() && S.MainOp->getNumOperands() <= 2) 956 return S.isAltShuffle() ? VLOperands::ScoreAltOpcodes 957 : VLOperands::ScoreSameOpcode; 958 } 959 960 if (isa<UndefValue>(V2)) 961 return VLOperands::ScoreUndef; 962 963 return VLOperands::ScoreFail; 964 } 965 966 /// Holds the values and their lane that are taking part in the look-ahead 967 /// score calculation. This is used in the external uses cost calculation. 968 SmallDenseMap<Value *, int> InLookAheadValues; 969 970 /// \Returns the additinal cost due to uses of \p LHS and \p RHS that are 971 /// either external to the vectorized code, or require shuffling. 972 int getExternalUsesCost(const std::pair<Value *, int> &LHS, 973 const std::pair<Value *, int> &RHS) { 974 int Cost = 0; 975 std::array<std::pair<Value *, int>, 2> Values = {{LHS, RHS}}; 976 for (int Idx = 0, IdxE = Values.size(); Idx != IdxE; ++Idx) { 977 Value *V = Values[Idx].first; 978 // Calculate the absolute lane, using the minimum relative lane of LHS 979 // and RHS as base and Idx as the offset. 980 int Ln = std::min(LHS.second, RHS.second) + Idx; 981 assert(Ln >= 0 && "Bad lane calculation"); 982 unsigned UsersBudget = LookAheadUsersBudget; 983 for (User *U : V->users()) { 984 if (const TreeEntry *UserTE = R.getTreeEntry(U)) { 985 // The user is in the VectorizableTree. Check if we need to insert. 986 auto It = llvm::find(UserTE->Scalars, U); 987 assert(It != UserTE->Scalars.end() && "U is in UserTE"); 988 int UserLn = std::distance(UserTE->Scalars.begin(), It); 989 assert(UserLn >= 0 && "Bad lane"); 990 if (UserLn != Ln) 991 Cost += UserInDiffLaneCost; 992 } else { 993 // Check if the user is in the look-ahead code. 994 auto It2 = InLookAheadValues.find(U); 995 if (It2 != InLookAheadValues.end()) { 996 // The user is in the look-ahead code. Check the lane. 997 if (It2->second != Ln) 998 Cost += UserInDiffLaneCost; 999 } else { 1000 // The user is neither in SLP tree nor in the look-ahead code. 1001 Cost += ExternalUseCost; 1002 } 1003 } 1004 // Limit the number of visited uses to cap compilation time. 1005 if (--UsersBudget == 0) 1006 break; 1007 } 1008 } 1009 return Cost; 1010 } 1011 1012 /// Go through the operands of \p LHS and \p RHS recursively until \p 1013 /// MaxLevel, and return the cummulative score. For example: 1014 /// \verbatim 1015 /// A[0] B[0] A[1] B[1] C[0] D[0] B[1] A[1] 1016 /// \ / \ / \ / \ / 1017 /// + + + + 1018 /// G1 G2 G3 G4 1019 /// \endverbatim 1020 /// The getScoreAtLevelRec(G1, G2) function will try to match the nodes at 1021 /// each level recursively, accumulating the score. It starts from matching 1022 /// the additions at level 0, then moves on to the loads (level 1). The 1023 /// score of G1 and G2 is higher than G1 and G3, because {A[0],A[1]} and 1024 /// {B[0],B[1]} match with VLOperands::ScoreConsecutiveLoads, while 1025 /// {A[0],C[0]} has a score of VLOperands::ScoreFail. 1026 /// Please note that the order of the operands does not matter, as we 1027 /// evaluate the score of all profitable combinations of operands. In 1028 /// other words the score of G1 and G4 is the same as G1 and G2. This 1029 /// heuristic is based on ideas described in: 1030 /// Look-ahead SLP: Auto-vectorization in the presence of commutative 1031 /// operations, CGO 2018 by Vasileios Porpodas, Rodrigo C. O. Rocha, 1032 /// Luís F. W. Góes 1033 int getScoreAtLevelRec(const std::pair<Value *, int> &LHS, 1034 const std::pair<Value *, int> &RHS, int CurrLevel, 1035 int MaxLevel) { 1036 1037 Value *V1 = LHS.first; 1038 Value *V2 = RHS.first; 1039 // Get the shallow score of V1 and V2. 1040 int ShallowScoreAtThisLevel = 1041 std::max((int)ScoreFail, getShallowScore(V1, V2, DL, SE) - 1042 getExternalUsesCost(LHS, RHS)); 1043 int Lane1 = LHS.second; 1044 int Lane2 = RHS.second; 1045 1046 // If reached MaxLevel, 1047 // or if V1 and V2 are not instructions, 1048 // or if they are SPLAT, 1049 // or if they are not consecutive, early return the current cost. 1050 auto *I1 = dyn_cast<Instruction>(V1); 1051 auto *I2 = dyn_cast<Instruction>(V2); 1052 if (CurrLevel == MaxLevel || !(I1 && I2) || I1 == I2 || 1053 ShallowScoreAtThisLevel == VLOperands::ScoreFail || 1054 (isa<LoadInst>(I1) && isa<LoadInst>(I2) && ShallowScoreAtThisLevel)) 1055 return ShallowScoreAtThisLevel; 1056 assert(I1 && I2 && "Should have early exited."); 1057 1058 // Keep track of in-tree values for determining the external-use cost. 1059 InLookAheadValues[V1] = Lane1; 1060 InLookAheadValues[V2] = Lane2; 1061 1062 // Contains the I2 operand indexes that got matched with I1 operands. 1063 SmallSet<unsigned, 4> Op2Used; 1064 1065 // Recursion towards the operands of I1 and I2. We are trying all possbile 1066 // operand pairs, and keeping track of the best score. 1067 for (unsigned OpIdx1 = 0, NumOperands1 = I1->getNumOperands(); 1068 OpIdx1 != NumOperands1; ++OpIdx1) { 1069 // Try to pair op1I with the best operand of I2. 1070 int MaxTmpScore = 0; 1071 unsigned MaxOpIdx2 = 0; 1072 bool FoundBest = false; 1073 // If I2 is commutative try all combinations. 1074 unsigned FromIdx = isCommutative(I2) ? 0 : OpIdx1; 1075 unsigned ToIdx = isCommutative(I2) 1076 ? I2->getNumOperands() 1077 : std::min(I2->getNumOperands(), OpIdx1 + 1); 1078 assert(FromIdx <= ToIdx && "Bad index"); 1079 for (unsigned OpIdx2 = FromIdx; OpIdx2 != ToIdx; ++OpIdx2) { 1080 // Skip operands already paired with OpIdx1. 1081 if (Op2Used.count(OpIdx2)) 1082 continue; 1083 // Recursively calculate the cost at each level 1084 int TmpScore = getScoreAtLevelRec({I1->getOperand(OpIdx1), Lane1}, 1085 {I2->getOperand(OpIdx2), Lane2}, 1086 CurrLevel + 1, MaxLevel); 1087 // Look for the best score. 1088 if (TmpScore > VLOperands::ScoreFail && TmpScore > MaxTmpScore) { 1089 MaxTmpScore = TmpScore; 1090 MaxOpIdx2 = OpIdx2; 1091 FoundBest = true; 1092 } 1093 } 1094 if (FoundBest) { 1095 // Pair {OpIdx1, MaxOpIdx2} was found to be best. Never revisit it. 1096 Op2Used.insert(MaxOpIdx2); 1097 ShallowScoreAtThisLevel += MaxTmpScore; 1098 } 1099 } 1100 return ShallowScoreAtThisLevel; 1101 } 1102 1103 /// \Returns the look-ahead score, which tells us how much the sub-trees 1104 /// rooted at \p LHS and \p RHS match, the more they match the higher the 1105 /// score. This helps break ties in an informed way when we cannot decide on 1106 /// the order of the operands by just considering the immediate 1107 /// predecessors. 1108 int getLookAheadScore(const std::pair<Value *, int> &LHS, 1109 const std::pair<Value *, int> &RHS) { 1110 InLookAheadValues.clear(); 1111 return getScoreAtLevelRec(LHS, RHS, 1, LookAheadMaxDepth); 1112 } 1113 1114 // Search all operands in Ops[*][Lane] for the one that matches best 1115 // Ops[OpIdx][LastLane] and return its opreand index. 1116 // If no good match can be found, return None. 1117 Optional<unsigned> 1118 getBestOperand(unsigned OpIdx, int Lane, int LastLane, 1119 ArrayRef<ReorderingMode> ReorderingModes) { 1120 unsigned NumOperands = getNumOperands(); 1121 1122 // The operand of the previous lane at OpIdx. 1123 Value *OpLastLane = getData(OpIdx, LastLane).V; 1124 1125 // Our strategy mode for OpIdx. 1126 ReorderingMode RMode = ReorderingModes[OpIdx]; 1127 1128 // The linearized opcode of the operand at OpIdx, Lane. 1129 bool OpIdxAPO = getData(OpIdx, Lane).APO; 1130 1131 // The best operand index and its score. 1132 // Sometimes we have more than one option (e.g., Opcode and Undefs), so we 1133 // are using the score to differentiate between the two. 1134 struct BestOpData { 1135 Optional<unsigned> Idx = None; 1136 unsigned Score = 0; 1137 } BestOp; 1138 1139 // Iterate through all unused operands and look for the best. 1140 for (unsigned Idx = 0; Idx != NumOperands; ++Idx) { 1141 // Get the operand at Idx and Lane. 1142 OperandData &OpData = getData(Idx, Lane); 1143 Value *Op = OpData.V; 1144 bool OpAPO = OpData.APO; 1145 1146 // Skip already selected operands. 1147 if (OpData.IsUsed) 1148 continue; 1149 1150 // Skip if we are trying to move the operand to a position with a 1151 // different opcode in the linearized tree form. This would break the 1152 // semantics. 1153 if (OpAPO != OpIdxAPO) 1154 continue; 1155 1156 // Look for an operand that matches the current mode. 1157 switch (RMode) { 1158 case ReorderingMode::Load: 1159 case ReorderingMode::Constant: 1160 case ReorderingMode::Opcode: { 1161 bool LeftToRight = Lane > LastLane; 1162 Value *OpLeft = (LeftToRight) ? OpLastLane : Op; 1163 Value *OpRight = (LeftToRight) ? Op : OpLastLane; 1164 unsigned Score = 1165 getLookAheadScore({OpLeft, LastLane}, {OpRight, Lane}); 1166 if (Score > BestOp.Score) { 1167 BestOp.Idx = Idx; 1168 BestOp.Score = Score; 1169 } 1170 break; 1171 } 1172 case ReorderingMode::Splat: 1173 if (Op == OpLastLane) 1174 BestOp.Idx = Idx; 1175 break; 1176 case ReorderingMode::Failed: 1177 return None; 1178 } 1179 } 1180 1181 if (BestOp.Idx) { 1182 getData(BestOp.Idx.getValue(), Lane).IsUsed = true; 1183 return BestOp.Idx; 1184 } 1185 // If we could not find a good match return None. 1186 return None; 1187 } 1188 1189 /// Helper for reorderOperandVecs. \Returns the lane that we should start 1190 /// reordering from. This is the one which has the least number of operands 1191 /// that can freely move about. 1192 unsigned getBestLaneToStartReordering() const { 1193 unsigned BestLane = 0; 1194 unsigned Min = UINT_MAX; 1195 for (unsigned Lane = 0, NumLanes = getNumLanes(); Lane != NumLanes; 1196 ++Lane) { 1197 unsigned NumFreeOps = getMaxNumOperandsThatCanBeReordered(Lane); 1198 if (NumFreeOps < Min) { 1199 Min = NumFreeOps; 1200 BestLane = Lane; 1201 } 1202 } 1203 return BestLane; 1204 } 1205 1206 /// \Returns the maximum number of operands that are allowed to be reordered 1207 /// for \p Lane. This is used as a heuristic for selecting the first lane to 1208 /// start operand reordering. 1209 unsigned getMaxNumOperandsThatCanBeReordered(unsigned Lane) const { 1210 unsigned CntTrue = 0; 1211 unsigned NumOperands = getNumOperands(); 1212 // Operands with the same APO can be reordered. We therefore need to count 1213 // how many of them we have for each APO, like this: Cnt[APO] = x. 1214 // Since we only have two APOs, namely true and false, we can avoid using 1215 // a map. Instead we can simply count the number of operands that 1216 // correspond to one of them (in this case the 'true' APO), and calculate 1217 // the other by subtracting it from the total number of operands. 1218 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) 1219 if (getData(OpIdx, Lane).APO) 1220 ++CntTrue; 1221 unsigned CntFalse = NumOperands - CntTrue; 1222 return std::max(CntTrue, CntFalse); 1223 } 1224 1225 /// Go through the instructions in VL and append their operands. 1226 void appendOperandsOfVL(ArrayRef<Value *> VL) { 1227 assert(!VL.empty() && "Bad VL"); 1228 assert((empty() || VL.size() == getNumLanes()) && 1229 "Expected same number of lanes"); 1230 assert(isa<Instruction>(VL[0]) && "Expected instruction"); 1231 unsigned NumOperands = cast<Instruction>(VL[0])->getNumOperands(); 1232 OpsVec.resize(NumOperands); 1233 unsigned NumLanes = VL.size(); 1234 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1235 OpsVec[OpIdx].resize(NumLanes); 1236 for (unsigned Lane = 0; Lane != NumLanes; ++Lane) { 1237 assert(isa<Instruction>(VL[Lane]) && "Expected instruction"); 1238 // Our tree has just 3 nodes: the root and two operands. 1239 // It is therefore trivial to get the APO. We only need to check the 1240 // opcode of VL[Lane] and whether the operand at OpIdx is the LHS or 1241 // RHS operand. The LHS operand of both add and sub is never attached 1242 // to an inversese operation in the linearized form, therefore its APO 1243 // is false. The RHS is true only if VL[Lane] is an inverse operation. 1244 1245 // Since operand reordering is performed on groups of commutative 1246 // operations or alternating sequences (e.g., +, -), we can safely 1247 // tell the inverse operations by checking commutativity. 1248 bool IsInverseOperation = !isCommutative(cast<Instruction>(VL[Lane])); 1249 bool APO = (OpIdx == 0) ? false : IsInverseOperation; 1250 OpsVec[OpIdx][Lane] = {cast<Instruction>(VL[Lane])->getOperand(OpIdx), 1251 APO, false}; 1252 } 1253 } 1254 } 1255 1256 /// \returns the number of operands. 1257 unsigned getNumOperands() const { return OpsVec.size(); } 1258 1259 /// \returns the number of lanes. 1260 unsigned getNumLanes() const { return OpsVec[0].size(); } 1261 1262 /// \returns the operand value at \p OpIdx and \p Lane. 1263 Value *getValue(unsigned OpIdx, unsigned Lane) const { 1264 return getData(OpIdx, Lane).V; 1265 } 1266 1267 /// \returns true if the data structure is empty. 1268 bool empty() const { return OpsVec.empty(); } 1269 1270 /// Clears the data. 1271 void clear() { OpsVec.clear(); } 1272 1273 /// \Returns true if there are enough operands identical to \p Op to fill 1274 /// the whole vector. 1275 /// Note: This modifies the 'IsUsed' flag, so a cleanUsed() must follow. 1276 bool shouldBroadcast(Value *Op, unsigned OpIdx, unsigned Lane) { 1277 bool OpAPO = getData(OpIdx, Lane).APO; 1278 for (unsigned Ln = 0, Lns = getNumLanes(); Ln != Lns; ++Ln) { 1279 if (Ln == Lane) 1280 continue; 1281 // This is set to true if we found a candidate for broadcast at Lane. 1282 bool FoundCandidate = false; 1283 for (unsigned OpI = 0, OpE = getNumOperands(); OpI != OpE; ++OpI) { 1284 OperandData &Data = getData(OpI, Ln); 1285 if (Data.APO != OpAPO || Data.IsUsed) 1286 continue; 1287 if (Data.V == Op) { 1288 FoundCandidate = true; 1289 Data.IsUsed = true; 1290 break; 1291 } 1292 } 1293 if (!FoundCandidate) 1294 return false; 1295 } 1296 return true; 1297 } 1298 1299 public: 1300 /// Initialize with all the operands of the instruction vector \p RootVL. 1301 VLOperands(ArrayRef<Value *> RootVL, const DataLayout &DL, 1302 ScalarEvolution &SE, const BoUpSLP &R) 1303 : DL(DL), SE(SE), R(R) { 1304 // Append all the operands of RootVL. 1305 appendOperandsOfVL(RootVL); 1306 } 1307 1308 /// \Returns a value vector with the operands across all lanes for the 1309 /// opearnd at \p OpIdx. 1310 ValueList getVL(unsigned OpIdx) const { 1311 ValueList OpVL(OpsVec[OpIdx].size()); 1312 assert(OpsVec[OpIdx].size() == getNumLanes() && 1313 "Expected same num of lanes across all operands"); 1314 for (unsigned Lane = 0, Lanes = getNumLanes(); Lane != Lanes; ++Lane) 1315 OpVL[Lane] = OpsVec[OpIdx][Lane].V; 1316 return OpVL; 1317 } 1318 1319 // Performs operand reordering for 2 or more operands. 1320 // The original operands are in OrigOps[OpIdx][Lane]. 1321 // The reordered operands are returned in 'SortedOps[OpIdx][Lane]'. 1322 void reorder() { 1323 unsigned NumOperands = getNumOperands(); 1324 unsigned NumLanes = getNumLanes(); 1325 // Each operand has its own mode. We are using this mode to help us select 1326 // the instructions for each lane, so that they match best with the ones 1327 // we have selected so far. 1328 SmallVector<ReorderingMode, 2> ReorderingModes(NumOperands); 1329 1330 // This is a greedy single-pass algorithm. We are going over each lane 1331 // once and deciding on the best order right away with no back-tracking. 1332 // However, in order to increase its effectiveness, we start with the lane 1333 // that has operands that can move the least. For example, given the 1334 // following lanes: 1335 // Lane 0 : A[0] = B[0] + C[0] // Visited 3rd 1336 // Lane 1 : A[1] = C[1] - B[1] // Visited 1st 1337 // Lane 2 : A[2] = B[2] + C[2] // Visited 2nd 1338 // Lane 3 : A[3] = C[3] - B[3] // Visited 4th 1339 // we will start at Lane 1, since the operands of the subtraction cannot 1340 // be reordered. Then we will visit the rest of the lanes in a circular 1341 // fashion. That is, Lanes 2, then Lane 0, and finally Lane 3. 1342 1343 // Find the first lane that we will start our search from. 1344 unsigned FirstLane = getBestLaneToStartReordering(); 1345 1346 // Initialize the modes. 1347 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1348 Value *OpLane0 = getValue(OpIdx, FirstLane); 1349 // Keep track if we have instructions with all the same opcode on one 1350 // side. 1351 if (isa<LoadInst>(OpLane0)) 1352 ReorderingModes[OpIdx] = ReorderingMode::Load; 1353 else if (isa<Instruction>(OpLane0)) { 1354 // Check if OpLane0 should be broadcast. 1355 if (shouldBroadcast(OpLane0, OpIdx, FirstLane)) 1356 ReorderingModes[OpIdx] = ReorderingMode::Splat; 1357 else 1358 ReorderingModes[OpIdx] = ReorderingMode::Opcode; 1359 } 1360 else if (isa<Constant>(OpLane0)) 1361 ReorderingModes[OpIdx] = ReorderingMode::Constant; 1362 else if (isa<Argument>(OpLane0)) 1363 // Our best hope is a Splat. It may save some cost in some cases. 1364 ReorderingModes[OpIdx] = ReorderingMode::Splat; 1365 else 1366 // NOTE: This should be unreachable. 1367 ReorderingModes[OpIdx] = ReorderingMode::Failed; 1368 } 1369 1370 // If the initial strategy fails for any of the operand indexes, then we 1371 // perform reordering again in a second pass. This helps avoid assigning 1372 // high priority to the failed strategy, and should improve reordering for 1373 // the non-failed operand indexes. 1374 for (int Pass = 0; Pass != 2; ++Pass) { 1375 // Skip the second pass if the first pass did not fail. 1376 bool StrategyFailed = false; 1377 // Mark all operand data as free to use. 1378 clearUsed(); 1379 // We keep the original operand order for the FirstLane, so reorder the 1380 // rest of the lanes. We are visiting the nodes in a circular fashion, 1381 // using FirstLane as the center point and increasing the radius 1382 // distance. 1383 for (unsigned Distance = 1; Distance != NumLanes; ++Distance) { 1384 // Visit the lane on the right and then the lane on the left. 1385 for (int Direction : {+1, -1}) { 1386 int Lane = FirstLane + Direction * Distance; 1387 if (Lane < 0 || Lane >= (int)NumLanes) 1388 continue; 1389 int LastLane = Lane - Direction; 1390 assert(LastLane >= 0 && LastLane < (int)NumLanes && 1391 "Out of bounds"); 1392 // Look for a good match for each operand. 1393 for (unsigned OpIdx = 0; OpIdx != NumOperands; ++OpIdx) { 1394 // Search for the operand that matches SortedOps[OpIdx][Lane-1]. 1395 Optional<unsigned> BestIdx = 1396 getBestOperand(OpIdx, Lane, LastLane, ReorderingModes); 1397 // By not selecting a value, we allow the operands that follow to 1398 // select a better matching value. We will get a non-null value in 1399 // the next run of getBestOperand(). 1400 if (BestIdx) { 1401 // Swap the current operand with the one returned by 1402 // getBestOperand(). 1403 swap(OpIdx, BestIdx.getValue(), Lane); 1404 } else { 1405 // We failed to find a best operand, set mode to 'Failed'. 1406 ReorderingModes[OpIdx] = ReorderingMode::Failed; 1407 // Enable the second pass. 1408 StrategyFailed = true; 1409 } 1410 } 1411 } 1412 } 1413 // Skip second pass if the strategy did not fail. 1414 if (!StrategyFailed) 1415 break; 1416 } 1417 } 1418 1419 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 1420 LLVM_DUMP_METHOD static StringRef getModeStr(ReorderingMode RMode) { 1421 switch (RMode) { 1422 case ReorderingMode::Load: 1423 return "Load"; 1424 case ReorderingMode::Opcode: 1425 return "Opcode"; 1426 case ReorderingMode::Constant: 1427 return "Constant"; 1428 case ReorderingMode::Splat: 1429 return "Splat"; 1430 case ReorderingMode::Failed: 1431 return "Failed"; 1432 } 1433 llvm_unreachable("Unimplemented Reordering Type"); 1434 } 1435 1436 LLVM_DUMP_METHOD static raw_ostream &printMode(ReorderingMode RMode, 1437 raw_ostream &OS) { 1438 return OS << getModeStr(RMode); 1439 } 1440 1441 /// Debug print. 1442 LLVM_DUMP_METHOD static void dumpMode(ReorderingMode RMode) { 1443 printMode(RMode, dbgs()); 1444 } 1445 1446 friend raw_ostream &operator<<(raw_ostream &OS, ReorderingMode RMode) { 1447 return printMode(RMode, OS); 1448 } 1449 1450 LLVM_DUMP_METHOD raw_ostream &print(raw_ostream &OS) const { 1451 const unsigned Indent = 2; 1452 unsigned Cnt = 0; 1453 for (const OperandDataVec &OpDataVec : OpsVec) { 1454 OS << "Operand " << Cnt++ << "\n"; 1455 for (const OperandData &OpData : OpDataVec) { 1456 OS.indent(Indent) << "{"; 1457 if (Value *V = OpData.V) 1458 OS << *V; 1459 else 1460 OS << "null"; 1461 OS << ", APO:" << OpData.APO << "}\n"; 1462 } 1463 OS << "\n"; 1464 } 1465 return OS; 1466 } 1467 1468 /// Debug print. 1469 LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 1470 #endif 1471 }; 1472 1473 /// Checks if the instruction is marked for deletion. 1474 bool isDeleted(Instruction *I) const { return DeletedInstructions.count(I); } 1475 1476 /// Marks values operands for later deletion by replacing them with Undefs. 1477 void eraseInstructions(ArrayRef<Value *> AV); 1478 1479 ~BoUpSLP(); 1480 1481 private: 1482 /// Checks if all users of \p I are the part of the vectorization tree. 1483 bool areAllUsersVectorized(Instruction *I) const; 1484 1485 /// \returns the cost of the vectorizable entry. 1486 int getEntryCost(TreeEntry *E); 1487 1488 /// This is the recursive part of buildTree. 1489 void buildTree_rec(ArrayRef<Value *> Roots, unsigned Depth, 1490 const EdgeInfo &EI); 1491 1492 /// \returns true if the ExtractElement/ExtractValue instructions in \p VL can 1493 /// be vectorized to use the original vector (or aggregate "bitcast" to a 1494 /// vector) and sets \p CurrentOrder to the identity permutation; otherwise 1495 /// returns false, setting \p CurrentOrder to either an empty vector or a 1496 /// non-identity permutation that allows to reuse extract instructions. 1497 bool canReuseExtract(ArrayRef<Value *> VL, Value *OpValue, 1498 SmallVectorImpl<unsigned> &CurrentOrder) const; 1499 1500 /// Vectorize a single entry in the tree. 1501 Value *vectorizeTree(TreeEntry *E); 1502 1503 /// Vectorize a single entry in the tree, starting in \p VL. 1504 Value *vectorizeTree(ArrayRef<Value *> VL); 1505 1506 /// \returns the scalarization cost for this type. Scalarization in this 1507 /// context means the creation of vectors from a group of scalars. 1508 int getGatherCost(FixedVectorType *Ty, 1509 const DenseSet<unsigned> &ShuffledIndices) const; 1510 1511 /// \returns the scalarization cost for this list of values. Assuming that 1512 /// this subtree gets vectorized, we may need to extract the values from the 1513 /// roots. This method calculates the cost of extracting the values. 1514 int getGatherCost(ArrayRef<Value *> VL) const; 1515 1516 /// Set the Builder insert point to one after the last instruction in 1517 /// the bundle 1518 void setInsertPointAfterBundle(TreeEntry *E); 1519 1520 /// \returns a vector from a collection of scalars in \p VL. 1521 Value *gather(ArrayRef<Value *> VL); 1522 1523 /// \returns whether the VectorizableTree is fully vectorizable and will 1524 /// be beneficial even the tree height is tiny. 1525 bool isFullyVectorizableTinyTree() const; 1526 1527 /// Reorder commutative or alt operands to get better probability of 1528 /// generating vectorized code. 1529 static void reorderInputsAccordingToOpcode(ArrayRef<Value *> VL, 1530 SmallVectorImpl<Value *> &Left, 1531 SmallVectorImpl<Value *> &Right, 1532 const DataLayout &DL, 1533 ScalarEvolution &SE, 1534 const BoUpSLP &R); 1535 struct TreeEntry { 1536 using VecTreeTy = SmallVector<std::unique_ptr<TreeEntry>, 8>; 1537 TreeEntry(VecTreeTy &Container) : Container(Container) {} 1538 1539 /// \returns true if the scalars in VL are equal to this entry. 1540 bool isSame(ArrayRef<Value *> VL) const { 1541 if (VL.size() == Scalars.size()) 1542 return std::equal(VL.begin(), VL.end(), Scalars.begin()); 1543 return VL.size() == ReuseShuffleIndices.size() && 1544 std::equal( 1545 VL.begin(), VL.end(), ReuseShuffleIndices.begin(), 1546 [this](Value *V, int Idx) { return V == Scalars[Idx]; }); 1547 } 1548 1549 /// A vector of scalars. 1550 ValueList Scalars; 1551 1552 /// The Scalars are vectorized into this value. It is initialized to Null. 1553 Value *VectorizedValue = nullptr; 1554 1555 /// Do we need to gather this sequence ? 1556 enum EntryState { Vectorize, NeedToGather }; 1557 EntryState State; 1558 1559 /// Does this sequence require some shuffling? 1560 SmallVector<int, 4> ReuseShuffleIndices; 1561 1562 /// Does this entry require reordering? 1563 SmallVector<unsigned, 4> ReorderIndices; 1564 1565 /// Points back to the VectorizableTree. 1566 /// 1567 /// Only used for Graphviz right now. Unfortunately GraphTrait::NodeRef has 1568 /// to be a pointer and needs to be able to initialize the child iterator. 1569 /// Thus we need a reference back to the container to translate the indices 1570 /// to entries. 1571 VecTreeTy &Container; 1572 1573 /// The TreeEntry index containing the user of this entry. We can actually 1574 /// have multiple users so the data structure is not truly a tree. 1575 SmallVector<EdgeInfo, 1> UserTreeIndices; 1576 1577 /// The index of this treeEntry in VectorizableTree. 1578 int Idx = -1; 1579 1580 private: 1581 /// The operands of each instruction in each lane Operands[op_index][lane]. 1582 /// Note: This helps avoid the replication of the code that performs the 1583 /// reordering of operands during buildTree_rec() and vectorizeTree(). 1584 SmallVector<ValueList, 2> Operands; 1585 1586 /// The main/alternate instruction. 1587 Instruction *MainOp = nullptr; 1588 Instruction *AltOp = nullptr; 1589 1590 public: 1591 /// Set this bundle's \p OpIdx'th operand to \p OpVL. 1592 void setOperand(unsigned OpIdx, ArrayRef<Value *> OpVL) { 1593 if (Operands.size() < OpIdx + 1) 1594 Operands.resize(OpIdx + 1); 1595 assert(Operands[OpIdx].size() == 0 && "Already resized?"); 1596 Operands[OpIdx].resize(Scalars.size()); 1597 for (unsigned Lane = 0, E = Scalars.size(); Lane != E; ++Lane) 1598 Operands[OpIdx][Lane] = OpVL[Lane]; 1599 } 1600 1601 /// Set the operands of this bundle in their original order. 1602 void setOperandsInOrder() { 1603 assert(Operands.empty() && "Already initialized?"); 1604 auto *I0 = cast<Instruction>(Scalars[0]); 1605 Operands.resize(I0->getNumOperands()); 1606 unsigned NumLanes = Scalars.size(); 1607 for (unsigned OpIdx = 0, NumOperands = I0->getNumOperands(); 1608 OpIdx != NumOperands; ++OpIdx) { 1609 Operands[OpIdx].resize(NumLanes); 1610 for (unsigned Lane = 0; Lane != NumLanes; ++Lane) { 1611 auto *I = cast<Instruction>(Scalars[Lane]); 1612 assert(I->getNumOperands() == NumOperands && 1613 "Expected same number of operands"); 1614 Operands[OpIdx][Lane] = I->getOperand(OpIdx); 1615 } 1616 } 1617 } 1618 1619 /// \returns the \p OpIdx operand of this TreeEntry. 1620 ValueList &getOperand(unsigned OpIdx) { 1621 assert(OpIdx < Operands.size() && "Off bounds"); 1622 return Operands[OpIdx]; 1623 } 1624 1625 /// \returns the number of operands. 1626 unsigned getNumOperands() const { return Operands.size(); } 1627 1628 /// \return the single \p OpIdx operand. 1629 Value *getSingleOperand(unsigned OpIdx) const { 1630 assert(OpIdx < Operands.size() && "Off bounds"); 1631 assert(!Operands[OpIdx].empty() && "No operand available"); 1632 return Operands[OpIdx][0]; 1633 } 1634 1635 /// Some of the instructions in the list have alternate opcodes. 1636 bool isAltShuffle() const { 1637 return getOpcode() != getAltOpcode(); 1638 } 1639 1640 bool isOpcodeOrAlt(Instruction *I) const { 1641 unsigned CheckedOpcode = I->getOpcode(); 1642 return (getOpcode() == CheckedOpcode || 1643 getAltOpcode() == CheckedOpcode); 1644 } 1645 1646 /// Chooses the correct key for scheduling data. If \p Op has the same (or 1647 /// alternate) opcode as \p OpValue, the key is \p Op. Otherwise the key is 1648 /// \p OpValue. 1649 Value *isOneOf(Value *Op) const { 1650 auto *I = dyn_cast<Instruction>(Op); 1651 if (I && isOpcodeOrAlt(I)) 1652 return Op; 1653 return MainOp; 1654 } 1655 1656 void setOperations(const InstructionsState &S) { 1657 MainOp = S.MainOp; 1658 AltOp = S.AltOp; 1659 } 1660 1661 Instruction *getMainOp() const { 1662 return MainOp; 1663 } 1664 1665 Instruction *getAltOp() const { 1666 return AltOp; 1667 } 1668 1669 /// The main/alternate opcodes for the list of instructions. 1670 unsigned getOpcode() const { 1671 return MainOp ? MainOp->getOpcode() : 0; 1672 } 1673 1674 unsigned getAltOpcode() const { 1675 return AltOp ? AltOp->getOpcode() : 0; 1676 } 1677 1678 /// Update operations state of this entry if reorder occurred. 1679 bool updateStateIfReorder() { 1680 if (ReorderIndices.empty()) 1681 return false; 1682 InstructionsState S = getSameOpcode(Scalars, ReorderIndices.front()); 1683 setOperations(S); 1684 return true; 1685 } 1686 1687 #ifndef NDEBUG 1688 /// Debug printer. 1689 LLVM_DUMP_METHOD void dump() const { 1690 dbgs() << Idx << ".\n"; 1691 for (unsigned OpI = 0, OpE = Operands.size(); OpI != OpE; ++OpI) { 1692 dbgs() << "Operand " << OpI << ":\n"; 1693 for (const Value *V : Operands[OpI]) 1694 dbgs().indent(2) << *V << "\n"; 1695 } 1696 dbgs() << "Scalars: \n"; 1697 for (Value *V : Scalars) 1698 dbgs().indent(2) << *V << "\n"; 1699 dbgs() << "State: "; 1700 switch (State) { 1701 case Vectorize: 1702 dbgs() << "Vectorize\n"; 1703 break; 1704 case NeedToGather: 1705 dbgs() << "NeedToGather\n"; 1706 break; 1707 } 1708 dbgs() << "MainOp: "; 1709 if (MainOp) 1710 dbgs() << *MainOp << "\n"; 1711 else 1712 dbgs() << "NULL\n"; 1713 dbgs() << "AltOp: "; 1714 if (AltOp) 1715 dbgs() << *AltOp << "\n"; 1716 else 1717 dbgs() << "NULL\n"; 1718 dbgs() << "VectorizedValue: "; 1719 if (VectorizedValue) 1720 dbgs() << *VectorizedValue << "\n"; 1721 else 1722 dbgs() << "NULL\n"; 1723 dbgs() << "ReuseShuffleIndices: "; 1724 if (ReuseShuffleIndices.empty()) 1725 dbgs() << "Emtpy"; 1726 else 1727 for (unsigned ReuseIdx : ReuseShuffleIndices) 1728 dbgs() << ReuseIdx << ", "; 1729 dbgs() << "\n"; 1730 dbgs() << "ReorderIndices: "; 1731 for (unsigned ReorderIdx : ReorderIndices) 1732 dbgs() << ReorderIdx << ", "; 1733 dbgs() << "\n"; 1734 dbgs() << "UserTreeIndices: "; 1735 for (const auto &EInfo : UserTreeIndices) 1736 dbgs() << EInfo << ", "; 1737 dbgs() << "\n"; 1738 } 1739 #endif 1740 }; 1741 1742 /// Create a new VectorizableTree entry. 1743 TreeEntry *newTreeEntry(ArrayRef<Value *> VL, Optional<ScheduleData *> Bundle, 1744 const InstructionsState &S, 1745 const EdgeInfo &UserTreeIdx, 1746 ArrayRef<unsigned> ReuseShuffleIndices = None, 1747 ArrayRef<unsigned> ReorderIndices = None) { 1748 bool Vectorized = (bool)Bundle; 1749 VectorizableTree.push_back(std::make_unique<TreeEntry>(VectorizableTree)); 1750 TreeEntry *Last = VectorizableTree.back().get(); 1751 Last->Idx = VectorizableTree.size() - 1; 1752 Last->Scalars.insert(Last->Scalars.begin(), VL.begin(), VL.end()); 1753 Last->State = Vectorized ? TreeEntry::Vectorize : TreeEntry::NeedToGather; 1754 Last->ReuseShuffleIndices.append(ReuseShuffleIndices.begin(), 1755 ReuseShuffleIndices.end()); 1756 Last->ReorderIndices.append(ReorderIndices.begin(), ReorderIndices.end()); 1757 Last->setOperations(S); 1758 if (Vectorized) { 1759 for (Value *V : VL) { 1760 assert(!getTreeEntry(V) && "Scalar already in tree!"); 1761 ScalarToTreeEntry[V] = Last; 1762 } 1763 // Update the scheduler bundle to point to this TreeEntry. 1764 unsigned Lane = 0; 1765 for (ScheduleData *BundleMember = Bundle.getValue(); BundleMember; 1766 BundleMember = BundleMember->NextInBundle) { 1767 BundleMember->TE = Last; 1768 BundleMember->Lane = Lane; 1769 ++Lane; 1770 } 1771 assert((!Bundle.getValue() || Lane == VL.size()) && 1772 "Bundle and VL out of sync"); 1773 } else { 1774 MustGather.insert(VL.begin(), VL.end()); 1775 } 1776 1777 if (UserTreeIdx.UserTE) 1778 Last->UserTreeIndices.push_back(UserTreeIdx); 1779 1780 return Last; 1781 } 1782 1783 /// -- Vectorization State -- 1784 /// Holds all of the tree entries. 1785 TreeEntry::VecTreeTy VectorizableTree; 1786 1787 #ifndef NDEBUG 1788 /// Debug printer. 1789 LLVM_DUMP_METHOD void dumpVectorizableTree() const { 1790 for (unsigned Id = 0, IdE = VectorizableTree.size(); Id != IdE; ++Id) { 1791 VectorizableTree[Id]->dump(); 1792 dbgs() << "\n"; 1793 } 1794 } 1795 #endif 1796 1797 TreeEntry *getTreeEntry(Value *V) { 1798 auto I = ScalarToTreeEntry.find(V); 1799 if (I != ScalarToTreeEntry.end()) 1800 return I->second; 1801 return nullptr; 1802 } 1803 1804 const TreeEntry *getTreeEntry(Value *V) const { 1805 auto I = ScalarToTreeEntry.find(V); 1806 if (I != ScalarToTreeEntry.end()) 1807 return I->second; 1808 return nullptr; 1809 } 1810 1811 /// Maps a specific scalar to its tree entry. 1812 SmallDenseMap<Value*, TreeEntry *> ScalarToTreeEntry; 1813 1814 /// Maps a value to the proposed vectorizable size. 1815 SmallDenseMap<Value *, unsigned> InstrElementSize; 1816 1817 /// A list of scalars that we found that we need to keep as scalars. 1818 ValueSet MustGather; 1819 1820 /// This POD struct describes one external user in the vectorized tree. 1821 struct ExternalUser { 1822 ExternalUser(Value *S, llvm::User *U, int L) 1823 : Scalar(S), User(U), Lane(L) {} 1824 1825 // Which scalar in our function. 1826 Value *Scalar; 1827 1828 // Which user that uses the scalar. 1829 llvm::User *User; 1830 1831 // Which lane does the scalar belong to. 1832 int Lane; 1833 }; 1834 using UserList = SmallVector<ExternalUser, 16>; 1835 1836 /// Checks if two instructions may access the same memory. 1837 /// 1838 /// \p Loc1 is the location of \p Inst1. It is passed explicitly because it 1839 /// is invariant in the calling loop. 1840 bool isAliased(const MemoryLocation &Loc1, Instruction *Inst1, 1841 Instruction *Inst2) { 1842 // First check if the result is already in the cache. 1843 AliasCacheKey key = std::make_pair(Inst1, Inst2); 1844 Optional<bool> &result = AliasCache[key]; 1845 if (result.hasValue()) { 1846 return result.getValue(); 1847 } 1848 MemoryLocation Loc2 = getLocation(Inst2, AA); 1849 bool aliased = true; 1850 if (Loc1.Ptr && Loc2.Ptr && isSimple(Inst1) && isSimple(Inst2)) { 1851 // Do the alias check. 1852 aliased = AA->alias(Loc1, Loc2); 1853 } 1854 // Store the result in the cache. 1855 result = aliased; 1856 return aliased; 1857 } 1858 1859 using AliasCacheKey = std::pair<Instruction *, Instruction *>; 1860 1861 /// Cache for alias results. 1862 /// TODO: consider moving this to the AliasAnalysis itself. 1863 DenseMap<AliasCacheKey, Optional<bool>> AliasCache; 1864 1865 /// Removes an instruction from its block and eventually deletes it. 1866 /// It's like Instruction::eraseFromParent() except that the actual deletion 1867 /// is delayed until BoUpSLP is destructed. 1868 /// This is required to ensure that there are no incorrect collisions in the 1869 /// AliasCache, which can happen if a new instruction is allocated at the 1870 /// same address as a previously deleted instruction. 1871 void eraseInstruction(Instruction *I, bool ReplaceOpsWithUndef = false) { 1872 auto It = DeletedInstructions.try_emplace(I, ReplaceOpsWithUndef).first; 1873 It->getSecond() = It->getSecond() && ReplaceOpsWithUndef; 1874 } 1875 1876 /// Temporary store for deleted instructions. Instructions will be deleted 1877 /// eventually when the BoUpSLP is destructed. 1878 DenseMap<Instruction *, bool> DeletedInstructions; 1879 1880 /// A list of values that need to extracted out of the tree. 1881 /// This list holds pairs of (Internal Scalar : External User). External User 1882 /// can be nullptr, it means that this Internal Scalar will be used later, 1883 /// after vectorization. 1884 UserList ExternalUses; 1885 1886 /// Values used only by @llvm.assume calls. 1887 SmallPtrSet<const Value *, 32> EphValues; 1888 1889 /// Holds all of the instructions that we gathered. 1890 SetVector<Instruction *> GatherSeq; 1891 1892 /// A list of blocks that we are going to CSE. 1893 SetVector<BasicBlock *> CSEBlocks; 1894 1895 /// Contains all scheduling relevant data for an instruction. 1896 /// A ScheduleData either represents a single instruction or a member of an 1897 /// instruction bundle (= a group of instructions which is combined into a 1898 /// vector instruction). 1899 struct ScheduleData { 1900 // The initial value for the dependency counters. It means that the 1901 // dependencies are not calculated yet. 1902 enum { InvalidDeps = -1 }; 1903 1904 ScheduleData() = default; 1905 1906 void init(int BlockSchedulingRegionID, Value *OpVal) { 1907 FirstInBundle = this; 1908 NextInBundle = nullptr; 1909 NextLoadStore = nullptr; 1910 IsScheduled = false; 1911 SchedulingRegionID = BlockSchedulingRegionID; 1912 UnscheduledDepsInBundle = UnscheduledDeps; 1913 clearDependencies(); 1914 OpValue = OpVal; 1915 TE = nullptr; 1916 Lane = -1; 1917 } 1918 1919 /// Returns true if the dependency information has been calculated. 1920 bool hasValidDependencies() const { return Dependencies != InvalidDeps; } 1921 1922 /// Returns true for single instructions and for bundle representatives 1923 /// (= the head of a bundle). 1924 bool isSchedulingEntity() const { return FirstInBundle == this; } 1925 1926 /// Returns true if it represents an instruction bundle and not only a 1927 /// single instruction. 1928 bool isPartOfBundle() const { 1929 return NextInBundle != nullptr || FirstInBundle != this; 1930 } 1931 1932 /// Returns true if it is ready for scheduling, i.e. it has no more 1933 /// unscheduled depending instructions/bundles. 1934 bool isReady() const { 1935 assert(isSchedulingEntity() && 1936 "can't consider non-scheduling entity for ready list"); 1937 return UnscheduledDepsInBundle == 0 && !IsScheduled; 1938 } 1939 1940 /// Modifies the number of unscheduled dependencies, also updating it for 1941 /// the whole bundle. 1942 int incrementUnscheduledDeps(int Incr) { 1943 UnscheduledDeps += Incr; 1944 return FirstInBundle->UnscheduledDepsInBundle += Incr; 1945 } 1946 1947 /// Sets the number of unscheduled dependencies to the number of 1948 /// dependencies. 1949 void resetUnscheduledDeps() { 1950 incrementUnscheduledDeps(Dependencies - UnscheduledDeps); 1951 } 1952 1953 /// Clears all dependency information. 1954 void clearDependencies() { 1955 Dependencies = InvalidDeps; 1956 resetUnscheduledDeps(); 1957 MemoryDependencies.clear(); 1958 } 1959 1960 void dump(raw_ostream &os) const { 1961 if (!isSchedulingEntity()) { 1962 os << "/ " << *Inst; 1963 } else if (NextInBundle) { 1964 os << '[' << *Inst; 1965 ScheduleData *SD = NextInBundle; 1966 while (SD) { 1967 os << ';' << *SD->Inst; 1968 SD = SD->NextInBundle; 1969 } 1970 os << ']'; 1971 } else { 1972 os << *Inst; 1973 } 1974 } 1975 1976 Instruction *Inst = nullptr; 1977 1978 /// Points to the head in an instruction bundle (and always to this for 1979 /// single instructions). 1980 ScheduleData *FirstInBundle = nullptr; 1981 1982 /// Single linked list of all instructions in a bundle. Null if it is a 1983 /// single instruction. 1984 ScheduleData *NextInBundle = nullptr; 1985 1986 /// Single linked list of all memory instructions (e.g. load, store, call) 1987 /// in the block - until the end of the scheduling region. 1988 ScheduleData *NextLoadStore = nullptr; 1989 1990 /// The dependent memory instructions. 1991 /// This list is derived on demand in calculateDependencies(). 1992 SmallVector<ScheduleData *, 4> MemoryDependencies; 1993 1994 /// This ScheduleData is in the current scheduling region if this matches 1995 /// the current SchedulingRegionID of BlockScheduling. 1996 int SchedulingRegionID = 0; 1997 1998 /// Used for getting a "good" final ordering of instructions. 1999 int SchedulingPriority = 0; 2000 2001 /// The number of dependencies. Constitutes of the number of users of the 2002 /// instruction plus the number of dependent memory instructions (if any). 2003 /// This value is calculated on demand. 2004 /// If InvalidDeps, the number of dependencies is not calculated yet. 2005 int Dependencies = InvalidDeps; 2006 2007 /// The number of dependencies minus the number of dependencies of scheduled 2008 /// instructions. As soon as this is zero, the instruction/bundle gets ready 2009 /// for scheduling. 2010 /// Note that this is negative as long as Dependencies is not calculated. 2011 int UnscheduledDeps = InvalidDeps; 2012 2013 /// The sum of UnscheduledDeps in a bundle. Equals to UnscheduledDeps for 2014 /// single instructions. 2015 int UnscheduledDepsInBundle = InvalidDeps; 2016 2017 /// True if this instruction is scheduled (or considered as scheduled in the 2018 /// dry-run). 2019 bool IsScheduled = false; 2020 2021 /// Opcode of the current instruction in the schedule data. 2022 Value *OpValue = nullptr; 2023 2024 /// The TreeEntry that this instruction corresponds to. 2025 TreeEntry *TE = nullptr; 2026 2027 /// The lane of this node in the TreeEntry. 2028 int Lane = -1; 2029 }; 2030 2031 #ifndef NDEBUG 2032 friend inline raw_ostream &operator<<(raw_ostream &os, 2033 const BoUpSLP::ScheduleData &SD) { 2034 SD.dump(os); 2035 return os; 2036 } 2037 #endif 2038 2039 friend struct GraphTraits<BoUpSLP *>; 2040 friend struct DOTGraphTraits<BoUpSLP *>; 2041 2042 /// Contains all scheduling data for a basic block. 2043 struct BlockScheduling { 2044 BlockScheduling(BasicBlock *BB) 2045 : BB(BB), ChunkSize(BB->size()), ChunkPos(ChunkSize) {} 2046 2047 void clear() { 2048 ReadyInsts.clear(); 2049 ScheduleStart = nullptr; 2050 ScheduleEnd = nullptr; 2051 FirstLoadStoreInRegion = nullptr; 2052 LastLoadStoreInRegion = nullptr; 2053 2054 // Reduce the maximum schedule region size by the size of the 2055 // previous scheduling run. 2056 ScheduleRegionSizeLimit -= ScheduleRegionSize; 2057 if (ScheduleRegionSizeLimit < MinScheduleRegionSize) 2058 ScheduleRegionSizeLimit = MinScheduleRegionSize; 2059 ScheduleRegionSize = 0; 2060 2061 // Make a new scheduling region, i.e. all existing ScheduleData is not 2062 // in the new region yet. 2063 ++SchedulingRegionID; 2064 } 2065 2066 ScheduleData *getScheduleData(Value *V) { 2067 ScheduleData *SD = ScheduleDataMap[V]; 2068 if (SD && SD->SchedulingRegionID == SchedulingRegionID) 2069 return SD; 2070 return nullptr; 2071 } 2072 2073 ScheduleData *getScheduleData(Value *V, Value *Key) { 2074 if (V == Key) 2075 return getScheduleData(V); 2076 auto I = ExtraScheduleDataMap.find(V); 2077 if (I != ExtraScheduleDataMap.end()) { 2078 ScheduleData *SD = I->second[Key]; 2079 if (SD && SD->SchedulingRegionID == SchedulingRegionID) 2080 return SD; 2081 } 2082 return nullptr; 2083 } 2084 2085 bool isInSchedulingRegion(ScheduleData *SD) const { 2086 return SD->SchedulingRegionID == SchedulingRegionID; 2087 } 2088 2089 /// Marks an instruction as scheduled and puts all dependent ready 2090 /// instructions into the ready-list. 2091 template <typename ReadyListType> 2092 void schedule(ScheduleData *SD, ReadyListType &ReadyList) { 2093 SD->IsScheduled = true; 2094 LLVM_DEBUG(dbgs() << "SLP: schedule " << *SD << "\n"); 2095 2096 ScheduleData *BundleMember = SD; 2097 while (BundleMember) { 2098 if (BundleMember->Inst != BundleMember->OpValue) { 2099 BundleMember = BundleMember->NextInBundle; 2100 continue; 2101 } 2102 // Handle the def-use chain dependencies. 2103 2104 // Decrement the unscheduled counter and insert to ready list if ready. 2105 auto &&DecrUnsched = [this, &ReadyList](Instruction *I) { 2106 doForAllOpcodes(I, [&ReadyList](ScheduleData *OpDef) { 2107 if (OpDef && OpDef->hasValidDependencies() && 2108 OpDef->incrementUnscheduledDeps(-1) == 0) { 2109 // There are no more unscheduled dependencies after 2110 // decrementing, so we can put the dependent instruction 2111 // into the ready list. 2112 ScheduleData *DepBundle = OpDef->FirstInBundle; 2113 assert(!DepBundle->IsScheduled && 2114 "already scheduled bundle gets ready"); 2115 ReadyList.insert(DepBundle); 2116 LLVM_DEBUG(dbgs() 2117 << "SLP: gets ready (def): " << *DepBundle << "\n"); 2118 } 2119 }); 2120 }; 2121 2122 // If BundleMember is a vector bundle, its operands may have been 2123 // reordered duiring buildTree(). We therefore need to get its operands 2124 // through the TreeEntry. 2125 if (TreeEntry *TE = BundleMember->TE) { 2126 int Lane = BundleMember->Lane; 2127 assert(Lane >= 0 && "Lane not set"); 2128 2129 // Since vectorization tree is being built recursively this assertion 2130 // ensures that the tree entry has all operands set before reaching 2131 // this code. Couple of exceptions known at the moment are extracts 2132 // where their second (immediate) operand is not added. Since 2133 // immediates do not affect scheduler behavior this is considered 2134 // okay. 2135 auto *In = TE->getMainOp(); 2136 assert(In && 2137 (isa<ExtractValueInst>(In) || isa<ExtractElementInst>(In) || 2138 In->getNumOperands() == TE->getNumOperands()) && 2139 "Missed TreeEntry operands?"); 2140 (void)In; // fake use to avoid build failure when assertions disabled 2141 2142 for (unsigned OpIdx = 0, NumOperands = TE->getNumOperands(); 2143 OpIdx != NumOperands; ++OpIdx) 2144 if (auto *I = dyn_cast<Instruction>(TE->getOperand(OpIdx)[Lane])) 2145 DecrUnsched(I); 2146 } else { 2147 // If BundleMember is a stand-alone instruction, no operand reordering 2148 // has taken place, so we directly access its operands. 2149 for (Use &U : BundleMember->Inst->operands()) 2150 if (auto *I = dyn_cast<Instruction>(U.get())) 2151 DecrUnsched(I); 2152 } 2153 // Handle the memory dependencies. 2154 for (ScheduleData *MemoryDepSD : BundleMember->MemoryDependencies) { 2155 if (MemoryDepSD->incrementUnscheduledDeps(-1) == 0) { 2156 // There are no more unscheduled dependencies after decrementing, 2157 // so we can put the dependent instruction into the ready list. 2158 ScheduleData *DepBundle = MemoryDepSD->FirstInBundle; 2159 assert(!DepBundle->IsScheduled && 2160 "already scheduled bundle gets ready"); 2161 ReadyList.insert(DepBundle); 2162 LLVM_DEBUG(dbgs() 2163 << "SLP: gets ready (mem): " << *DepBundle << "\n"); 2164 } 2165 } 2166 BundleMember = BundleMember->NextInBundle; 2167 } 2168 } 2169 2170 void doForAllOpcodes(Value *V, 2171 function_ref<void(ScheduleData *SD)> Action) { 2172 if (ScheduleData *SD = getScheduleData(V)) 2173 Action(SD); 2174 auto I = ExtraScheduleDataMap.find(V); 2175 if (I != ExtraScheduleDataMap.end()) 2176 for (auto &P : I->second) 2177 if (P.second->SchedulingRegionID == SchedulingRegionID) 2178 Action(P.second); 2179 } 2180 2181 /// Put all instructions into the ReadyList which are ready for scheduling. 2182 template <typename ReadyListType> 2183 void initialFillReadyList(ReadyListType &ReadyList) { 2184 for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 2185 doForAllOpcodes(I, [&](ScheduleData *SD) { 2186 if (SD->isSchedulingEntity() && SD->isReady()) { 2187 ReadyList.insert(SD); 2188 LLVM_DEBUG(dbgs() 2189 << "SLP: initially in ready list: " << *I << "\n"); 2190 } 2191 }); 2192 } 2193 } 2194 2195 /// Checks if a bundle of instructions can be scheduled, i.e. has no 2196 /// cyclic dependencies. This is only a dry-run, no instructions are 2197 /// actually moved at this stage. 2198 /// \returns the scheduling bundle. The returned Optional value is non-None 2199 /// if \p VL is allowed to be scheduled. 2200 Optional<ScheduleData *> 2201 tryScheduleBundle(ArrayRef<Value *> VL, BoUpSLP *SLP, 2202 const InstructionsState &S); 2203 2204 /// Un-bundles a group of instructions. 2205 void cancelScheduling(ArrayRef<Value *> VL, Value *OpValue); 2206 2207 /// Allocates schedule data chunk. 2208 ScheduleData *allocateScheduleDataChunks(); 2209 2210 /// Extends the scheduling region so that V is inside the region. 2211 /// \returns true if the region size is within the limit. 2212 bool extendSchedulingRegion(Value *V, const InstructionsState &S); 2213 2214 /// Initialize the ScheduleData structures for new instructions in the 2215 /// scheduling region. 2216 void initScheduleData(Instruction *FromI, Instruction *ToI, 2217 ScheduleData *PrevLoadStore, 2218 ScheduleData *NextLoadStore); 2219 2220 /// Updates the dependency information of a bundle and of all instructions/ 2221 /// bundles which depend on the original bundle. 2222 void calculateDependencies(ScheduleData *SD, bool InsertInReadyList, 2223 BoUpSLP *SLP); 2224 2225 /// Sets all instruction in the scheduling region to un-scheduled. 2226 void resetSchedule(); 2227 2228 BasicBlock *BB; 2229 2230 /// Simple memory allocation for ScheduleData. 2231 std::vector<std::unique_ptr<ScheduleData[]>> ScheduleDataChunks; 2232 2233 /// The size of a ScheduleData array in ScheduleDataChunks. 2234 int ChunkSize; 2235 2236 /// The allocator position in the current chunk, which is the last entry 2237 /// of ScheduleDataChunks. 2238 int ChunkPos; 2239 2240 /// Attaches ScheduleData to Instruction. 2241 /// Note that the mapping survives during all vectorization iterations, i.e. 2242 /// ScheduleData structures are recycled. 2243 DenseMap<Value *, ScheduleData *> ScheduleDataMap; 2244 2245 /// Attaches ScheduleData to Instruction with the leading key. 2246 DenseMap<Value *, SmallDenseMap<Value *, ScheduleData *>> 2247 ExtraScheduleDataMap; 2248 2249 struct ReadyList : SmallVector<ScheduleData *, 8> { 2250 void insert(ScheduleData *SD) { push_back(SD); } 2251 }; 2252 2253 /// The ready-list for scheduling (only used for the dry-run). 2254 ReadyList ReadyInsts; 2255 2256 /// The first instruction of the scheduling region. 2257 Instruction *ScheduleStart = nullptr; 2258 2259 /// The first instruction _after_ the scheduling region. 2260 Instruction *ScheduleEnd = nullptr; 2261 2262 /// The first memory accessing instruction in the scheduling region 2263 /// (can be null). 2264 ScheduleData *FirstLoadStoreInRegion = nullptr; 2265 2266 /// The last memory accessing instruction in the scheduling region 2267 /// (can be null). 2268 ScheduleData *LastLoadStoreInRegion = nullptr; 2269 2270 /// The current size of the scheduling region. 2271 int ScheduleRegionSize = 0; 2272 2273 /// The maximum size allowed for the scheduling region. 2274 int ScheduleRegionSizeLimit = ScheduleRegionSizeBudget; 2275 2276 /// The ID of the scheduling region. For a new vectorization iteration this 2277 /// is incremented which "removes" all ScheduleData from the region. 2278 // Make sure that the initial SchedulingRegionID is greater than the 2279 // initial SchedulingRegionID in ScheduleData (which is 0). 2280 int SchedulingRegionID = 1; 2281 }; 2282 2283 /// Attaches the BlockScheduling structures to basic blocks. 2284 MapVector<BasicBlock *, std::unique_ptr<BlockScheduling>> BlocksSchedules; 2285 2286 /// Performs the "real" scheduling. Done before vectorization is actually 2287 /// performed in a basic block. 2288 void scheduleBlock(BlockScheduling *BS); 2289 2290 /// List of users to ignore during scheduling and that don't need extracting. 2291 ArrayRef<Value *> UserIgnoreList; 2292 2293 /// A DenseMapInfo implementation for holding DenseMaps and DenseSets of 2294 /// sorted SmallVectors of unsigned. 2295 struct OrdersTypeDenseMapInfo { 2296 static OrdersType getEmptyKey() { 2297 OrdersType V; 2298 V.push_back(~1U); 2299 return V; 2300 } 2301 2302 static OrdersType getTombstoneKey() { 2303 OrdersType V; 2304 V.push_back(~2U); 2305 return V; 2306 } 2307 2308 static unsigned getHashValue(const OrdersType &V) { 2309 return static_cast<unsigned>(hash_combine_range(V.begin(), V.end())); 2310 } 2311 2312 static bool isEqual(const OrdersType &LHS, const OrdersType &RHS) { 2313 return LHS == RHS; 2314 } 2315 }; 2316 2317 /// Contains orders of operations along with the number of bundles that have 2318 /// operations in this order. It stores only those orders that require 2319 /// reordering, if reordering is not required it is counted using \a 2320 /// NumOpsWantToKeepOriginalOrder. 2321 DenseMap<OrdersType, unsigned, OrdersTypeDenseMapInfo> NumOpsWantToKeepOrder; 2322 /// Number of bundles that do not require reordering. 2323 unsigned NumOpsWantToKeepOriginalOrder = 0; 2324 2325 // Analysis and block reference. 2326 Function *F; 2327 ScalarEvolution *SE; 2328 TargetTransformInfo *TTI; 2329 TargetLibraryInfo *TLI; 2330 AAResults *AA; 2331 LoopInfo *LI; 2332 DominatorTree *DT; 2333 AssumptionCache *AC; 2334 DemandedBits *DB; 2335 const DataLayout *DL; 2336 OptimizationRemarkEmitter *ORE; 2337 2338 unsigned MaxVecRegSize; // This is set by TTI or overridden by cl::opt. 2339 unsigned MinVecRegSize; // Set by cl::opt (default: 128). 2340 2341 /// Instruction builder to construct the vectorized tree. 2342 IRBuilder<> Builder; 2343 2344 /// A map of scalar integer values to the smallest bit width with which they 2345 /// can legally be represented. The values map to (width, signed) pairs, 2346 /// where "width" indicates the minimum bit width and "signed" is True if the 2347 /// value must be signed-extended, rather than zero-extended, back to its 2348 /// original width. 2349 MapVector<Value *, std::pair<uint64_t, bool>> MinBWs; 2350 }; 2351 2352 } // end namespace slpvectorizer 2353 2354 template <> struct GraphTraits<BoUpSLP *> { 2355 using TreeEntry = BoUpSLP::TreeEntry; 2356 2357 /// NodeRef has to be a pointer per the GraphWriter. 2358 using NodeRef = TreeEntry *; 2359 2360 using ContainerTy = BoUpSLP::TreeEntry::VecTreeTy; 2361 2362 /// Add the VectorizableTree to the index iterator to be able to return 2363 /// TreeEntry pointers. 2364 struct ChildIteratorType 2365 : public iterator_adaptor_base< 2366 ChildIteratorType, SmallVector<BoUpSLP::EdgeInfo, 1>::iterator> { 2367 ContainerTy &VectorizableTree; 2368 2369 ChildIteratorType(SmallVector<BoUpSLP::EdgeInfo, 1>::iterator W, 2370 ContainerTy &VT) 2371 : ChildIteratorType::iterator_adaptor_base(W), VectorizableTree(VT) {} 2372 2373 NodeRef operator*() { return I->UserTE; } 2374 }; 2375 2376 static NodeRef getEntryNode(BoUpSLP &R) { 2377 return R.VectorizableTree[0].get(); 2378 } 2379 2380 static ChildIteratorType child_begin(NodeRef N) { 2381 return {N->UserTreeIndices.begin(), N->Container}; 2382 } 2383 2384 static ChildIteratorType child_end(NodeRef N) { 2385 return {N->UserTreeIndices.end(), N->Container}; 2386 } 2387 2388 /// For the node iterator we just need to turn the TreeEntry iterator into a 2389 /// TreeEntry* iterator so that it dereferences to NodeRef. 2390 class nodes_iterator { 2391 using ItTy = ContainerTy::iterator; 2392 ItTy It; 2393 2394 public: 2395 nodes_iterator(const ItTy &It2) : It(It2) {} 2396 NodeRef operator*() { return It->get(); } 2397 nodes_iterator operator++() { 2398 ++It; 2399 return *this; 2400 } 2401 bool operator!=(const nodes_iterator &N2) const { return N2.It != It; } 2402 }; 2403 2404 static nodes_iterator nodes_begin(BoUpSLP *R) { 2405 return nodes_iterator(R->VectorizableTree.begin()); 2406 } 2407 2408 static nodes_iterator nodes_end(BoUpSLP *R) { 2409 return nodes_iterator(R->VectorizableTree.end()); 2410 } 2411 2412 static unsigned size(BoUpSLP *R) { return R->VectorizableTree.size(); } 2413 }; 2414 2415 template <> struct DOTGraphTraits<BoUpSLP *> : public DefaultDOTGraphTraits { 2416 using TreeEntry = BoUpSLP::TreeEntry; 2417 2418 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {} 2419 2420 std::string getNodeLabel(const TreeEntry *Entry, const BoUpSLP *R) { 2421 std::string Str; 2422 raw_string_ostream OS(Str); 2423 if (isSplat(Entry->Scalars)) { 2424 OS << "<splat> " << *Entry->Scalars[0]; 2425 return Str; 2426 } 2427 for (auto V : Entry->Scalars) { 2428 OS << *V; 2429 if (std::any_of( 2430 R->ExternalUses.begin(), R->ExternalUses.end(), 2431 [&](const BoUpSLP::ExternalUser &EU) { return EU.Scalar == V; })) 2432 OS << " <extract>"; 2433 OS << "\n"; 2434 } 2435 return Str; 2436 } 2437 2438 static std::string getNodeAttributes(const TreeEntry *Entry, 2439 const BoUpSLP *) { 2440 if (Entry->State == TreeEntry::NeedToGather) 2441 return "color=red"; 2442 return ""; 2443 } 2444 }; 2445 2446 } // end namespace llvm 2447 2448 BoUpSLP::~BoUpSLP() { 2449 for (const auto &Pair : DeletedInstructions) { 2450 // Replace operands of ignored instructions with Undefs in case if they were 2451 // marked for deletion. 2452 if (Pair.getSecond()) { 2453 Value *Undef = UndefValue::get(Pair.getFirst()->getType()); 2454 Pair.getFirst()->replaceAllUsesWith(Undef); 2455 } 2456 Pair.getFirst()->dropAllReferences(); 2457 } 2458 for (const auto &Pair : DeletedInstructions) { 2459 assert(Pair.getFirst()->use_empty() && 2460 "trying to erase instruction with users."); 2461 Pair.getFirst()->eraseFromParent(); 2462 } 2463 assert(!verifyFunction(*F, &dbgs())); 2464 } 2465 2466 void BoUpSLP::eraseInstructions(ArrayRef<Value *> AV) { 2467 for (auto *V : AV) { 2468 if (auto *I = dyn_cast<Instruction>(V)) 2469 eraseInstruction(I, /*ReplaceOpsWithUndef=*/true); 2470 }; 2471 } 2472 2473 void BoUpSLP::buildTree(ArrayRef<Value *> Roots, 2474 ArrayRef<Value *> UserIgnoreLst) { 2475 ExtraValueToDebugLocsMap ExternallyUsedValues; 2476 buildTree(Roots, ExternallyUsedValues, UserIgnoreLst); 2477 } 2478 2479 void BoUpSLP::buildTree(ArrayRef<Value *> Roots, 2480 ExtraValueToDebugLocsMap &ExternallyUsedValues, 2481 ArrayRef<Value *> UserIgnoreLst) { 2482 deleteTree(); 2483 UserIgnoreList = UserIgnoreLst; 2484 if (!allSameType(Roots)) 2485 return; 2486 buildTree_rec(Roots, 0, EdgeInfo()); 2487 2488 // Collect the values that we need to extract from the tree. 2489 for (auto &TEPtr : VectorizableTree) { 2490 TreeEntry *Entry = TEPtr.get(); 2491 2492 // No need to handle users of gathered values. 2493 if (Entry->State == TreeEntry::NeedToGather) 2494 continue; 2495 2496 // For each lane: 2497 for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) { 2498 Value *Scalar = Entry->Scalars[Lane]; 2499 int FoundLane = Lane; 2500 if (!Entry->ReuseShuffleIndices.empty()) { 2501 FoundLane = 2502 std::distance(Entry->ReuseShuffleIndices.begin(), 2503 llvm::find(Entry->ReuseShuffleIndices, FoundLane)); 2504 } 2505 2506 // Check if the scalar is externally used as an extra arg. 2507 auto ExtI = ExternallyUsedValues.find(Scalar); 2508 if (ExtI != ExternallyUsedValues.end()) { 2509 LLVM_DEBUG(dbgs() << "SLP: Need to extract: Extra arg from lane " 2510 << Lane << " from " << *Scalar << ".\n"); 2511 ExternalUses.emplace_back(Scalar, nullptr, FoundLane); 2512 } 2513 for (User *U : Scalar->users()) { 2514 LLVM_DEBUG(dbgs() << "SLP: Checking user:" << *U << ".\n"); 2515 2516 Instruction *UserInst = dyn_cast<Instruction>(U); 2517 if (!UserInst) 2518 continue; 2519 2520 // Skip in-tree scalars that become vectors 2521 if (TreeEntry *UseEntry = getTreeEntry(U)) { 2522 Value *UseScalar = UseEntry->Scalars[0]; 2523 // Some in-tree scalars will remain as scalar in vectorized 2524 // instructions. If that is the case, the one in Lane 0 will 2525 // be used. 2526 if (UseScalar != U || 2527 !InTreeUserNeedToExtract(Scalar, UserInst, TLI)) { 2528 LLVM_DEBUG(dbgs() << "SLP: \tInternal user will be removed:" << *U 2529 << ".\n"); 2530 assert(UseEntry->State != TreeEntry::NeedToGather && "Bad state"); 2531 continue; 2532 } 2533 } 2534 2535 // Ignore users in the user ignore list. 2536 if (is_contained(UserIgnoreList, UserInst)) 2537 continue; 2538 2539 LLVM_DEBUG(dbgs() << "SLP: Need to extract:" << *U << " from lane " 2540 << Lane << " from " << *Scalar << ".\n"); 2541 ExternalUses.push_back(ExternalUser(Scalar, U, FoundLane)); 2542 } 2543 } 2544 } 2545 } 2546 2547 void BoUpSLP::buildTree_rec(ArrayRef<Value *> VL, unsigned Depth, 2548 const EdgeInfo &UserTreeIdx) { 2549 assert((allConstant(VL) || allSameType(VL)) && "Invalid types!"); 2550 2551 InstructionsState S = getSameOpcode(VL); 2552 if (Depth == RecursionMaxDepth) { 2553 LLVM_DEBUG(dbgs() << "SLP: Gathering due to max recursion depth.\n"); 2554 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2555 return; 2556 } 2557 2558 // Don't handle vectors. 2559 if (S.OpValue->getType()->isVectorTy()) { 2560 LLVM_DEBUG(dbgs() << "SLP: Gathering due to vector type.\n"); 2561 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2562 return; 2563 } 2564 2565 if (StoreInst *SI = dyn_cast<StoreInst>(S.OpValue)) 2566 if (SI->getValueOperand()->getType()->isVectorTy()) { 2567 LLVM_DEBUG(dbgs() << "SLP: Gathering due to store vector type.\n"); 2568 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2569 return; 2570 } 2571 2572 // If all of the operands are identical or constant we have a simple solution. 2573 if (allConstant(VL) || isSplat(VL) || !allSameBlock(VL) || !S.getOpcode()) { 2574 LLVM_DEBUG(dbgs() << "SLP: Gathering due to C,S,B,O. \n"); 2575 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2576 return; 2577 } 2578 2579 // We now know that this is a vector of instructions of the same type from 2580 // the same block. 2581 2582 // Don't vectorize ephemeral values. 2583 for (Value *V : VL) { 2584 if (EphValues.count(V)) { 2585 LLVM_DEBUG(dbgs() << "SLP: The instruction (" << *V 2586 << ") is ephemeral.\n"); 2587 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2588 return; 2589 } 2590 } 2591 2592 // Check if this is a duplicate of another entry. 2593 if (TreeEntry *E = getTreeEntry(S.OpValue)) { 2594 LLVM_DEBUG(dbgs() << "SLP: \tChecking bundle: " << *S.OpValue << ".\n"); 2595 if (!E->isSame(VL)) { 2596 LLVM_DEBUG(dbgs() << "SLP: Gathering due to partial overlap.\n"); 2597 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2598 return; 2599 } 2600 // Record the reuse of the tree node. FIXME, currently this is only used to 2601 // properly draw the graph rather than for the actual vectorization. 2602 E->UserTreeIndices.push_back(UserTreeIdx); 2603 LLVM_DEBUG(dbgs() << "SLP: Perfect diamond merge at " << *S.OpValue 2604 << ".\n"); 2605 return; 2606 } 2607 2608 // Check that none of the instructions in the bundle are already in the tree. 2609 for (Value *V : VL) { 2610 auto *I = dyn_cast<Instruction>(V); 2611 if (!I) 2612 continue; 2613 if (getTreeEntry(I)) { 2614 LLVM_DEBUG(dbgs() << "SLP: The instruction (" << *V 2615 << ") is already in tree.\n"); 2616 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2617 return; 2618 } 2619 } 2620 2621 // If any of the scalars is marked as a value that needs to stay scalar, then 2622 // we need to gather the scalars. 2623 // The reduction nodes (stored in UserIgnoreList) also should stay scalar. 2624 for (Value *V : VL) { 2625 if (MustGather.count(V) || is_contained(UserIgnoreList, V)) { 2626 LLVM_DEBUG(dbgs() << "SLP: Gathering due to gathered scalar.\n"); 2627 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2628 return; 2629 } 2630 } 2631 2632 // Check that all of the users of the scalars that we want to vectorize are 2633 // schedulable. 2634 auto *VL0 = cast<Instruction>(S.OpValue); 2635 BasicBlock *BB = VL0->getParent(); 2636 2637 if (!DT->isReachableFromEntry(BB)) { 2638 // Don't go into unreachable blocks. They may contain instructions with 2639 // dependency cycles which confuse the final scheduling. 2640 LLVM_DEBUG(dbgs() << "SLP: bundle in unreachable block.\n"); 2641 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2642 return; 2643 } 2644 2645 // Check that every instruction appears once in this bundle. 2646 SmallVector<unsigned, 4> ReuseShuffleIndicies; 2647 SmallVector<Value *, 4> UniqueValues; 2648 DenseMap<Value *, unsigned> UniquePositions; 2649 for (Value *V : VL) { 2650 auto Res = UniquePositions.try_emplace(V, UniqueValues.size()); 2651 ReuseShuffleIndicies.emplace_back(Res.first->second); 2652 if (Res.second) 2653 UniqueValues.emplace_back(V); 2654 } 2655 size_t NumUniqueScalarValues = UniqueValues.size(); 2656 if (NumUniqueScalarValues == VL.size()) { 2657 ReuseShuffleIndicies.clear(); 2658 } else { 2659 LLVM_DEBUG(dbgs() << "SLP: Shuffle for reused scalars.\n"); 2660 if (NumUniqueScalarValues <= 1 || 2661 !llvm::isPowerOf2_32(NumUniqueScalarValues)) { 2662 LLVM_DEBUG(dbgs() << "SLP: Scalar used twice in bundle.\n"); 2663 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx); 2664 return; 2665 } 2666 VL = UniqueValues; 2667 } 2668 2669 auto &BSRef = BlocksSchedules[BB]; 2670 if (!BSRef) 2671 BSRef = std::make_unique<BlockScheduling>(BB); 2672 2673 BlockScheduling &BS = *BSRef.get(); 2674 2675 Optional<ScheduleData *> Bundle = BS.tryScheduleBundle(VL, this, S); 2676 if (!Bundle) { 2677 LLVM_DEBUG(dbgs() << "SLP: We are not able to schedule this bundle!\n"); 2678 assert((!BS.getScheduleData(VL0) || 2679 !BS.getScheduleData(VL0)->isPartOfBundle()) && 2680 "tryScheduleBundle should cancelScheduling on failure"); 2681 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2682 ReuseShuffleIndicies); 2683 return; 2684 } 2685 LLVM_DEBUG(dbgs() << "SLP: We are able to schedule this bundle.\n"); 2686 2687 unsigned ShuffleOrOp = S.isAltShuffle() ? 2688 (unsigned) Instruction::ShuffleVector : S.getOpcode(); 2689 switch (ShuffleOrOp) { 2690 case Instruction::PHI: { 2691 auto *PH = cast<PHINode>(VL0); 2692 2693 // Check for terminator values (e.g. invoke). 2694 for (Value *V : VL) 2695 for (unsigned I = 0, E = PH->getNumIncomingValues(); I < E; ++I) { 2696 Instruction *Term = dyn_cast<Instruction>( 2697 cast<PHINode>(V)->getIncomingValueForBlock( 2698 PH->getIncomingBlock(I))); 2699 if (Term && Term->isTerminator()) { 2700 LLVM_DEBUG(dbgs() 2701 << "SLP: Need to swizzle PHINodes (terminator use).\n"); 2702 BS.cancelScheduling(VL, VL0); 2703 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2704 ReuseShuffleIndicies); 2705 return; 2706 } 2707 } 2708 2709 TreeEntry *TE = 2710 newTreeEntry(VL, Bundle, S, UserTreeIdx, ReuseShuffleIndicies); 2711 LLVM_DEBUG(dbgs() << "SLP: added a vector of PHINodes.\n"); 2712 2713 // Keeps the reordered operands to avoid code duplication. 2714 SmallVector<ValueList, 2> OperandsVec; 2715 for (unsigned I = 0, E = PH->getNumIncomingValues(); I < E; ++I) { 2716 ValueList Operands; 2717 // Prepare the operand vector. 2718 for (Value *V : VL) 2719 Operands.push_back(cast<PHINode>(V)->getIncomingValueForBlock( 2720 PH->getIncomingBlock(I))); 2721 TE->setOperand(I, Operands); 2722 OperandsVec.push_back(Operands); 2723 } 2724 for (unsigned OpIdx = 0, OpE = OperandsVec.size(); OpIdx != OpE; ++OpIdx) 2725 buildTree_rec(OperandsVec[OpIdx], Depth + 1, {TE, OpIdx}); 2726 return; 2727 } 2728 case Instruction::ExtractValue: 2729 case Instruction::ExtractElement: { 2730 OrdersType CurrentOrder; 2731 bool Reuse = canReuseExtract(VL, VL0, CurrentOrder); 2732 if (Reuse) { 2733 LLVM_DEBUG(dbgs() << "SLP: Reusing or shuffling extract sequence.\n"); 2734 ++NumOpsWantToKeepOriginalOrder; 2735 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 2736 ReuseShuffleIndicies); 2737 // This is a special case, as it does not gather, but at the same time 2738 // we are not extending buildTree_rec() towards the operands. 2739 ValueList Op0; 2740 Op0.assign(VL.size(), VL0->getOperand(0)); 2741 VectorizableTree.back()->setOperand(0, Op0); 2742 return; 2743 } 2744 if (!CurrentOrder.empty()) { 2745 LLVM_DEBUG({ 2746 dbgs() << "SLP: Reusing or shuffling of reordered extract sequence " 2747 "with order"; 2748 for (unsigned Idx : CurrentOrder) 2749 dbgs() << " " << Idx; 2750 dbgs() << "\n"; 2751 }); 2752 // Insert new order with initial value 0, if it does not exist, 2753 // otherwise return the iterator to the existing one. 2754 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 2755 ReuseShuffleIndicies, CurrentOrder); 2756 findRootOrder(CurrentOrder); 2757 ++NumOpsWantToKeepOrder[CurrentOrder]; 2758 // This is a special case, as it does not gather, but at the same time 2759 // we are not extending buildTree_rec() towards the operands. 2760 ValueList Op0; 2761 Op0.assign(VL.size(), VL0->getOperand(0)); 2762 VectorizableTree.back()->setOperand(0, Op0); 2763 return; 2764 } 2765 LLVM_DEBUG(dbgs() << "SLP: Gather extract sequence.\n"); 2766 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2767 ReuseShuffleIndicies); 2768 BS.cancelScheduling(VL, VL0); 2769 return; 2770 } 2771 case Instruction::Load: { 2772 // Check that a vectorized load would load the same memory as a scalar 2773 // load. For example, we don't want to vectorize loads that are smaller 2774 // than 8-bit. Even though we have a packed struct {<i2, i2, i2, i2>} LLVM 2775 // treats loading/storing it as an i8 struct. If we vectorize loads/stores 2776 // from such a struct, we read/write packed bits disagreeing with the 2777 // unvectorized version. 2778 Type *ScalarTy = VL0->getType(); 2779 2780 if (DL->getTypeSizeInBits(ScalarTy) != 2781 DL->getTypeAllocSizeInBits(ScalarTy)) { 2782 BS.cancelScheduling(VL, VL0); 2783 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2784 ReuseShuffleIndicies); 2785 LLVM_DEBUG(dbgs() << "SLP: Gathering loads of non-packed type.\n"); 2786 return; 2787 } 2788 2789 // Make sure all loads in the bundle are simple - we can't vectorize 2790 // atomic or volatile loads. 2791 SmallVector<Value *, 4> PointerOps(VL.size()); 2792 auto POIter = PointerOps.begin(); 2793 for (Value *V : VL) { 2794 auto *L = cast<LoadInst>(V); 2795 if (!L->isSimple()) { 2796 BS.cancelScheduling(VL, VL0); 2797 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2798 ReuseShuffleIndicies); 2799 LLVM_DEBUG(dbgs() << "SLP: Gathering non-simple loads.\n"); 2800 return; 2801 } 2802 *POIter = L->getPointerOperand(); 2803 ++POIter; 2804 } 2805 2806 OrdersType CurrentOrder; 2807 // Check the order of pointer operands. 2808 if (llvm::sortPtrAccesses(PointerOps, *DL, *SE, CurrentOrder)) { 2809 Value *Ptr0; 2810 Value *PtrN; 2811 if (CurrentOrder.empty()) { 2812 Ptr0 = PointerOps.front(); 2813 PtrN = PointerOps.back(); 2814 } else { 2815 Ptr0 = PointerOps[CurrentOrder.front()]; 2816 PtrN = PointerOps[CurrentOrder.back()]; 2817 } 2818 const SCEV *Scev0 = SE->getSCEV(Ptr0); 2819 const SCEV *ScevN = SE->getSCEV(PtrN); 2820 const auto *Diff = 2821 dyn_cast<SCEVConstant>(SE->getMinusSCEV(ScevN, Scev0)); 2822 uint64_t Size = DL->getTypeAllocSize(ScalarTy); 2823 // Check that the sorted loads are consecutive. 2824 if (Diff && Diff->getAPInt() == (VL.size() - 1) * Size) { 2825 if (CurrentOrder.empty()) { 2826 // Original loads are consecutive and does not require reordering. 2827 ++NumOpsWantToKeepOriginalOrder; 2828 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, 2829 UserTreeIdx, ReuseShuffleIndicies); 2830 TE->setOperandsInOrder(); 2831 LLVM_DEBUG(dbgs() << "SLP: added a vector of loads.\n"); 2832 } else { 2833 // Need to reorder. 2834 TreeEntry *TE = 2835 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 2836 ReuseShuffleIndicies, CurrentOrder); 2837 TE->setOperandsInOrder(); 2838 LLVM_DEBUG(dbgs() << "SLP: added a vector of jumbled loads.\n"); 2839 findRootOrder(CurrentOrder); 2840 ++NumOpsWantToKeepOrder[CurrentOrder]; 2841 } 2842 return; 2843 } 2844 } 2845 2846 LLVM_DEBUG(dbgs() << "SLP: Gathering non-consecutive loads.\n"); 2847 BS.cancelScheduling(VL, VL0); 2848 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2849 ReuseShuffleIndicies); 2850 return; 2851 } 2852 case Instruction::ZExt: 2853 case Instruction::SExt: 2854 case Instruction::FPToUI: 2855 case Instruction::FPToSI: 2856 case Instruction::FPExt: 2857 case Instruction::PtrToInt: 2858 case Instruction::IntToPtr: 2859 case Instruction::SIToFP: 2860 case Instruction::UIToFP: 2861 case Instruction::Trunc: 2862 case Instruction::FPTrunc: 2863 case Instruction::BitCast: { 2864 Type *SrcTy = VL0->getOperand(0)->getType(); 2865 for (Value *V : VL) { 2866 Type *Ty = cast<Instruction>(V)->getOperand(0)->getType(); 2867 if (Ty != SrcTy || !isValidElementType(Ty)) { 2868 BS.cancelScheduling(VL, VL0); 2869 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2870 ReuseShuffleIndicies); 2871 LLVM_DEBUG(dbgs() 2872 << "SLP: Gathering casts with different src types.\n"); 2873 return; 2874 } 2875 } 2876 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 2877 ReuseShuffleIndicies); 2878 LLVM_DEBUG(dbgs() << "SLP: added a vector of casts.\n"); 2879 2880 TE->setOperandsInOrder(); 2881 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 2882 ValueList Operands; 2883 // Prepare the operand vector. 2884 for (Value *V : VL) 2885 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 2886 2887 buildTree_rec(Operands, Depth + 1, {TE, i}); 2888 } 2889 return; 2890 } 2891 case Instruction::ICmp: 2892 case Instruction::FCmp: { 2893 // Check that all of the compares have the same predicate. 2894 CmpInst::Predicate P0 = cast<CmpInst>(VL0)->getPredicate(); 2895 CmpInst::Predicate SwapP0 = CmpInst::getSwappedPredicate(P0); 2896 Type *ComparedTy = VL0->getOperand(0)->getType(); 2897 for (Value *V : VL) { 2898 CmpInst *Cmp = cast<CmpInst>(V); 2899 if ((Cmp->getPredicate() != P0 && Cmp->getPredicate() != SwapP0) || 2900 Cmp->getOperand(0)->getType() != ComparedTy) { 2901 BS.cancelScheduling(VL, VL0); 2902 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2903 ReuseShuffleIndicies); 2904 LLVM_DEBUG(dbgs() 2905 << "SLP: Gathering cmp with different predicate.\n"); 2906 return; 2907 } 2908 } 2909 2910 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 2911 ReuseShuffleIndicies); 2912 LLVM_DEBUG(dbgs() << "SLP: added a vector of compares.\n"); 2913 2914 ValueList Left, Right; 2915 if (cast<CmpInst>(VL0)->isCommutative()) { 2916 // Commutative predicate - collect + sort operands of the instructions 2917 // so that each side is more likely to have the same opcode. 2918 assert(P0 == SwapP0 && "Commutative Predicate mismatch"); 2919 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 2920 } else { 2921 // Collect operands - commute if it uses the swapped predicate. 2922 for (Value *V : VL) { 2923 auto *Cmp = cast<CmpInst>(V); 2924 Value *LHS = Cmp->getOperand(0); 2925 Value *RHS = Cmp->getOperand(1); 2926 if (Cmp->getPredicate() != P0) 2927 std::swap(LHS, RHS); 2928 Left.push_back(LHS); 2929 Right.push_back(RHS); 2930 } 2931 } 2932 TE->setOperand(0, Left); 2933 TE->setOperand(1, Right); 2934 buildTree_rec(Left, Depth + 1, {TE, 0}); 2935 buildTree_rec(Right, Depth + 1, {TE, 1}); 2936 return; 2937 } 2938 case Instruction::Select: 2939 case Instruction::FNeg: 2940 case Instruction::Add: 2941 case Instruction::FAdd: 2942 case Instruction::Sub: 2943 case Instruction::FSub: 2944 case Instruction::Mul: 2945 case Instruction::FMul: 2946 case Instruction::UDiv: 2947 case Instruction::SDiv: 2948 case Instruction::FDiv: 2949 case Instruction::URem: 2950 case Instruction::SRem: 2951 case Instruction::FRem: 2952 case Instruction::Shl: 2953 case Instruction::LShr: 2954 case Instruction::AShr: 2955 case Instruction::And: 2956 case Instruction::Or: 2957 case Instruction::Xor: { 2958 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 2959 ReuseShuffleIndicies); 2960 LLVM_DEBUG(dbgs() << "SLP: added a vector of un/bin op.\n"); 2961 2962 // Sort operands of the instructions so that each side is more likely to 2963 // have the same opcode. 2964 if (isa<BinaryOperator>(VL0) && VL0->isCommutative()) { 2965 ValueList Left, Right; 2966 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 2967 TE->setOperand(0, Left); 2968 TE->setOperand(1, Right); 2969 buildTree_rec(Left, Depth + 1, {TE, 0}); 2970 buildTree_rec(Right, Depth + 1, {TE, 1}); 2971 return; 2972 } 2973 2974 TE->setOperandsInOrder(); 2975 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 2976 ValueList Operands; 2977 // Prepare the operand vector. 2978 for (Value *V : VL) 2979 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 2980 2981 buildTree_rec(Operands, Depth + 1, {TE, i}); 2982 } 2983 return; 2984 } 2985 case Instruction::GetElementPtr: { 2986 // We don't combine GEPs with complicated (nested) indexing. 2987 for (Value *V : VL) { 2988 if (cast<Instruction>(V)->getNumOperands() != 2) { 2989 LLVM_DEBUG(dbgs() << "SLP: not-vectorizable GEP (nested indexes).\n"); 2990 BS.cancelScheduling(VL, VL0); 2991 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 2992 ReuseShuffleIndicies); 2993 return; 2994 } 2995 } 2996 2997 // We can't combine several GEPs into one vector if they operate on 2998 // different types. 2999 Type *Ty0 = VL0->getOperand(0)->getType(); 3000 for (Value *V : VL) { 3001 Type *CurTy = cast<Instruction>(V)->getOperand(0)->getType(); 3002 if (Ty0 != CurTy) { 3003 LLVM_DEBUG(dbgs() 3004 << "SLP: not-vectorizable GEP (different types).\n"); 3005 BS.cancelScheduling(VL, VL0); 3006 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3007 ReuseShuffleIndicies); 3008 return; 3009 } 3010 } 3011 3012 // We don't combine GEPs with non-constant indexes. 3013 Type *Ty1 = VL0->getOperand(1)->getType(); 3014 for (Value *V : VL) { 3015 auto Op = cast<Instruction>(V)->getOperand(1); 3016 if (!isa<ConstantInt>(Op) || 3017 (Op->getType() != Ty1 && 3018 Op->getType()->getScalarSizeInBits() > 3019 DL->getIndexSizeInBits( 3020 V->getType()->getPointerAddressSpace()))) { 3021 LLVM_DEBUG(dbgs() 3022 << "SLP: not-vectorizable GEP (non-constant indexes).\n"); 3023 BS.cancelScheduling(VL, VL0); 3024 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3025 ReuseShuffleIndicies); 3026 return; 3027 } 3028 } 3029 3030 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 3031 ReuseShuffleIndicies); 3032 LLVM_DEBUG(dbgs() << "SLP: added a vector of GEPs.\n"); 3033 TE->setOperandsInOrder(); 3034 for (unsigned i = 0, e = 2; i < e; ++i) { 3035 ValueList Operands; 3036 // Prepare the operand vector. 3037 for (Value *V : VL) 3038 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 3039 3040 buildTree_rec(Operands, Depth + 1, {TE, i}); 3041 } 3042 return; 3043 } 3044 case Instruction::Store: { 3045 // Check if the stores are consecutive or if we need to swizzle them. 3046 llvm::Type *ScalarTy = cast<StoreInst>(VL0)->getValueOperand()->getType(); 3047 // Make sure all stores in the bundle are simple - we can't vectorize 3048 // atomic or volatile stores. 3049 SmallVector<Value *, 4> PointerOps(VL.size()); 3050 ValueList Operands(VL.size()); 3051 auto POIter = PointerOps.begin(); 3052 auto OIter = Operands.begin(); 3053 for (Value *V : VL) { 3054 auto *SI = cast<StoreInst>(V); 3055 if (!SI->isSimple()) { 3056 BS.cancelScheduling(VL, VL0); 3057 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3058 ReuseShuffleIndicies); 3059 LLVM_DEBUG(dbgs() << "SLP: Gathering non-simple stores.\n"); 3060 return; 3061 } 3062 *POIter = SI->getPointerOperand(); 3063 *OIter = SI->getValueOperand(); 3064 ++POIter; 3065 ++OIter; 3066 } 3067 3068 OrdersType CurrentOrder; 3069 // Check the order of pointer operands. 3070 if (llvm::sortPtrAccesses(PointerOps, *DL, *SE, CurrentOrder)) { 3071 Value *Ptr0; 3072 Value *PtrN; 3073 if (CurrentOrder.empty()) { 3074 Ptr0 = PointerOps.front(); 3075 PtrN = PointerOps.back(); 3076 } else { 3077 Ptr0 = PointerOps[CurrentOrder.front()]; 3078 PtrN = PointerOps[CurrentOrder.back()]; 3079 } 3080 const SCEV *Scev0 = SE->getSCEV(Ptr0); 3081 const SCEV *ScevN = SE->getSCEV(PtrN); 3082 const auto *Diff = 3083 dyn_cast<SCEVConstant>(SE->getMinusSCEV(ScevN, Scev0)); 3084 uint64_t Size = DL->getTypeAllocSize(ScalarTy); 3085 // Check that the sorted pointer operands are consecutive. 3086 if (Diff && Diff->getAPInt() == (VL.size() - 1) * Size) { 3087 if (CurrentOrder.empty()) { 3088 // Original stores are consecutive and does not require reordering. 3089 ++NumOpsWantToKeepOriginalOrder; 3090 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, 3091 UserTreeIdx, ReuseShuffleIndicies); 3092 TE->setOperandsInOrder(); 3093 buildTree_rec(Operands, Depth + 1, {TE, 0}); 3094 LLVM_DEBUG(dbgs() << "SLP: added a vector of stores.\n"); 3095 } else { 3096 TreeEntry *TE = 3097 newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 3098 ReuseShuffleIndicies, CurrentOrder); 3099 TE->setOperandsInOrder(); 3100 buildTree_rec(Operands, Depth + 1, {TE, 0}); 3101 LLVM_DEBUG(dbgs() << "SLP: added a vector of jumbled stores.\n"); 3102 findRootOrder(CurrentOrder); 3103 ++NumOpsWantToKeepOrder[CurrentOrder]; 3104 } 3105 return; 3106 } 3107 } 3108 3109 BS.cancelScheduling(VL, VL0); 3110 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3111 ReuseShuffleIndicies); 3112 LLVM_DEBUG(dbgs() << "SLP: Non-consecutive store.\n"); 3113 return; 3114 } 3115 case Instruction::Call: { 3116 // Check if the calls are all to the same vectorizable intrinsic or 3117 // library function. 3118 CallInst *CI = cast<CallInst>(VL0); 3119 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 3120 3121 VFShape Shape = VFShape::get( 3122 *CI, ElementCount::getFixed(static_cast<unsigned int>(VL.size())), 3123 false /*HasGlobalPred*/); 3124 Function *VecFunc = VFDatabase(*CI).getVectorizedFunction(Shape); 3125 3126 if (!VecFunc && !isTriviallyVectorizable(ID)) { 3127 BS.cancelScheduling(VL, VL0); 3128 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3129 ReuseShuffleIndicies); 3130 LLVM_DEBUG(dbgs() << "SLP: Non-vectorizable call.\n"); 3131 return; 3132 } 3133 Function *F = CI->getCalledFunction(); 3134 unsigned NumArgs = CI->getNumArgOperands(); 3135 SmallVector<Value*, 4> ScalarArgs(NumArgs, nullptr); 3136 for (unsigned j = 0; j != NumArgs; ++j) 3137 if (hasVectorInstrinsicScalarOpd(ID, j)) 3138 ScalarArgs[j] = CI->getArgOperand(j); 3139 for (Value *V : VL) { 3140 CallInst *CI2 = dyn_cast<CallInst>(V); 3141 if (!CI2 || CI2->getCalledFunction() != F || 3142 getVectorIntrinsicIDForCall(CI2, TLI) != ID || 3143 (VecFunc && 3144 VecFunc != VFDatabase(*CI2).getVectorizedFunction(Shape)) || 3145 !CI->hasIdenticalOperandBundleSchema(*CI2)) { 3146 BS.cancelScheduling(VL, VL0); 3147 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3148 ReuseShuffleIndicies); 3149 LLVM_DEBUG(dbgs() << "SLP: mismatched calls:" << *CI << "!=" << *V 3150 << "\n"); 3151 return; 3152 } 3153 // Some intrinsics have scalar arguments and should be same in order for 3154 // them to be vectorized. 3155 for (unsigned j = 0; j != NumArgs; ++j) { 3156 if (hasVectorInstrinsicScalarOpd(ID, j)) { 3157 Value *A1J = CI2->getArgOperand(j); 3158 if (ScalarArgs[j] != A1J) { 3159 BS.cancelScheduling(VL, VL0); 3160 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3161 ReuseShuffleIndicies); 3162 LLVM_DEBUG(dbgs() << "SLP: mismatched arguments in call:" << *CI 3163 << " argument " << ScalarArgs[j] << "!=" << A1J 3164 << "\n"); 3165 return; 3166 } 3167 } 3168 } 3169 // Verify that the bundle operands are identical between the two calls. 3170 if (CI->hasOperandBundles() && 3171 !std::equal(CI->op_begin() + CI->getBundleOperandsStartIndex(), 3172 CI->op_begin() + CI->getBundleOperandsEndIndex(), 3173 CI2->op_begin() + CI2->getBundleOperandsStartIndex())) { 3174 BS.cancelScheduling(VL, VL0); 3175 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3176 ReuseShuffleIndicies); 3177 LLVM_DEBUG(dbgs() << "SLP: mismatched bundle operands in calls:" 3178 << *CI << "!=" << *V << '\n'); 3179 return; 3180 } 3181 } 3182 3183 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 3184 ReuseShuffleIndicies); 3185 TE->setOperandsInOrder(); 3186 for (unsigned i = 0, e = CI->getNumArgOperands(); i != e; ++i) { 3187 ValueList Operands; 3188 // Prepare the operand vector. 3189 for (Value *V : VL) { 3190 auto *CI2 = cast<CallInst>(V); 3191 Operands.push_back(CI2->getArgOperand(i)); 3192 } 3193 buildTree_rec(Operands, Depth + 1, {TE, i}); 3194 } 3195 return; 3196 } 3197 case Instruction::ShuffleVector: { 3198 // If this is not an alternate sequence of opcode like add-sub 3199 // then do not vectorize this instruction. 3200 if (!S.isAltShuffle()) { 3201 BS.cancelScheduling(VL, VL0); 3202 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3203 ReuseShuffleIndicies); 3204 LLVM_DEBUG(dbgs() << "SLP: ShuffleVector are not vectorized.\n"); 3205 return; 3206 } 3207 TreeEntry *TE = newTreeEntry(VL, Bundle /*vectorized*/, S, UserTreeIdx, 3208 ReuseShuffleIndicies); 3209 LLVM_DEBUG(dbgs() << "SLP: added a ShuffleVector op.\n"); 3210 3211 // Reorder operands if reordering would enable vectorization. 3212 if (isa<BinaryOperator>(VL0)) { 3213 ValueList Left, Right; 3214 reorderInputsAccordingToOpcode(VL, Left, Right, *DL, *SE, *this); 3215 TE->setOperand(0, Left); 3216 TE->setOperand(1, Right); 3217 buildTree_rec(Left, Depth + 1, {TE, 0}); 3218 buildTree_rec(Right, Depth + 1, {TE, 1}); 3219 return; 3220 } 3221 3222 TE->setOperandsInOrder(); 3223 for (unsigned i = 0, e = VL0->getNumOperands(); i < e; ++i) { 3224 ValueList Operands; 3225 // Prepare the operand vector. 3226 for (Value *V : VL) 3227 Operands.push_back(cast<Instruction>(V)->getOperand(i)); 3228 3229 buildTree_rec(Operands, Depth + 1, {TE, i}); 3230 } 3231 return; 3232 } 3233 default: 3234 BS.cancelScheduling(VL, VL0); 3235 newTreeEntry(VL, None /*not vectorized*/, S, UserTreeIdx, 3236 ReuseShuffleIndicies); 3237 LLVM_DEBUG(dbgs() << "SLP: Gathering unknown instruction.\n"); 3238 return; 3239 } 3240 } 3241 3242 unsigned BoUpSLP::canMapToVector(Type *T, const DataLayout &DL) const { 3243 unsigned N = 1; 3244 Type *EltTy = T; 3245 3246 while (isa<StructType>(EltTy) || isa<ArrayType>(EltTy) || 3247 isa<VectorType>(EltTy)) { 3248 if (auto *ST = dyn_cast<StructType>(EltTy)) { 3249 // Check that struct is homogeneous. 3250 for (const auto *Ty : ST->elements()) 3251 if (Ty != *ST->element_begin()) 3252 return 0; 3253 N *= ST->getNumElements(); 3254 EltTy = *ST->element_begin(); 3255 } else if (auto *AT = dyn_cast<ArrayType>(EltTy)) { 3256 N *= AT->getNumElements(); 3257 EltTy = AT->getElementType(); 3258 } else { 3259 auto *VT = cast<FixedVectorType>(EltTy); 3260 N *= VT->getNumElements(); 3261 EltTy = VT->getElementType(); 3262 } 3263 } 3264 3265 if (!isValidElementType(EltTy)) 3266 return 0; 3267 uint64_t VTSize = DL.getTypeStoreSizeInBits(FixedVectorType::get(EltTy, N)); 3268 if (VTSize < MinVecRegSize || VTSize > MaxVecRegSize || VTSize != DL.getTypeStoreSizeInBits(T)) 3269 return 0; 3270 return N; 3271 } 3272 3273 bool BoUpSLP::canReuseExtract(ArrayRef<Value *> VL, Value *OpValue, 3274 SmallVectorImpl<unsigned> &CurrentOrder) const { 3275 Instruction *E0 = cast<Instruction>(OpValue); 3276 assert(E0->getOpcode() == Instruction::ExtractElement || 3277 E0->getOpcode() == Instruction::ExtractValue); 3278 assert(E0->getOpcode() == getSameOpcode(VL).getOpcode() && "Invalid opcode"); 3279 // Check if all of the extracts come from the same vector and from the 3280 // correct offset. 3281 Value *Vec = E0->getOperand(0); 3282 3283 CurrentOrder.clear(); 3284 3285 // We have to extract from a vector/aggregate with the same number of elements. 3286 unsigned NElts; 3287 if (E0->getOpcode() == Instruction::ExtractValue) { 3288 const DataLayout &DL = E0->getModule()->getDataLayout(); 3289 NElts = canMapToVector(Vec->getType(), DL); 3290 if (!NElts) 3291 return false; 3292 // Check if load can be rewritten as load of vector. 3293 LoadInst *LI = dyn_cast<LoadInst>(Vec); 3294 if (!LI || !LI->isSimple() || !LI->hasNUses(VL.size())) 3295 return false; 3296 } else { 3297 NElts = cast<FixedVectorType>(Vec->getType())->getNumElements(); 3298 } 3299 3300 if (NElts != VL.size()) 3301 return false; 3302 3303 // Check that all of the indices extract from the correct offset. 3304 bool ShouldKeepOrder = true; 3305 unsigned E = VL.size(); 3306 // Assign to all items the initial value E + 1 so we can check if the extract 3307 // instruction index was used already. 3308 // Also, later we can check that all the indices are used and we have a 3309 // consecutive access in the extract instructions, by checking that no 3310 // element of CurrentOrder still has value E + 1. 3311 CurrentOrder.assign(E, E + 1); 3312 unsigned I = 0; 3313 for (; I < E; ++I) { 3314 auto *Inst = cast<Instruction>(VL[I]); 3315 if (Inst->getOperand(0) != Vec) 3316 break; 3317 Optional<unsigned> Idx = getExtractIndex(Inst); 3318 if (!Idx) 3319 break; 3320 const unsigned ExtIdx = *Idx; 3321 if (ExtIdx != I) { 3322 if (ExtIdx >= E || CurrentOrder[ExtIdx] != E + 1) 3323 break; 3324 ShouldKeepOrder = false; 3325 CurrentOrder[ExtIdx] = I; 3326 } else { 3327 if (CurrentOrder[I] != E + 1) 3328 break; 3329 CurrentOrder[I] = I; 3330 } 3331 } 3332 if (I < E) { 3333 CurrentOrder.clear(); 3334 return false; 3335 } 3336 3337 return ShouldKeepOrder; 3338 } 3339 3340 bool BoUpSLP::areAllUsersVectorized(Instruction *I) const { 3341 return I->hasOneUse() || 3342 std::all_of(I->user_begin(), I->user_end(), [this](User *U) { 3343 return ScalarToTreeEntry.count(U) > 0; 3344 }); 3345 } 3346 3347 static std::pair<unsigned, unsigned> 3348 getVectorCallCosts(CallInst *CI, FixedVectorType *VecTy, 3349 TargetTransformInfo *TTI, TargetLibraryInfo *TLI) { 3350 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 3351 3352 // Calculate the cost of the scalar and vector calls. 3353 IntrinsicCostAttributes CostAttrs(ID, *CI, VecTy->getNumElements()); 3354 int IntrinsicCost = 3355 TTI->getIntrinsicInstrCost(CostAttrs, TTI::TCK_RecipThroughput); 3356 3357 auto Shape = VFShape::get(*CI, ElementCount::getFixed(static_cast<unsigned>( 3358 VecTy->getNumElements())), 3359 false /*HasGlobalPred*/); 3360 Function *VecFunc = VFDatabase(*CI).getVectorizedFunction(Shape); 3361 int LibCost = IntrinsicCost; 3362 if (!CI->isNoBuiltin() && VecFunc) { 3363 // Calculate the cost of the vector library call. 3364 SmallVector<Type *, 4> VecTys; 3365 for (Use &Arg : CI->args()) 3366 VecTys.push_back( 3367 FixedVectorType::get(Arg->getType(), VecTy->getNumElements())); 3368 3369 // If the corresponding vector call is cheaper, return its cost. 3370 LibCost = TTI->getCallInstrCost(nullptr, VecTy, VecTys, 3371 TTI::TCK_RecipThroughput); 3372 } 3373 return {IntrinsicCost, LibCost}; 3374 } 3375 3376 int BoUpSLP::getEntryCost(TreeEntry *E) { 3377 ArrayRef<Value*> VL = E->Scalars; 3378 3379 Type *ScalarTy = VL[0]->getType(); 3380 if (StoreInst *SI = dyn_cast<StoreInst>(VL[0])) 3381 ScalarTy = SI->getValueOperand()->getType(); 3382 else if (CmpInst *CI = dyn_cast<CmpInst>(VL[0])) 3383 ScalarTy = CI->getOperand(0)->getType(); 3384 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 3385 TTI::TargetCostKind CostKind = TTI::TCK_RecipThroughput; 3386 3387 // If we have computed a smaller type for the expression, update VecTy so 3388 // that the costs will be accurate. 3389 if (MinBWs.count(VL[0])) 3390 VecTy = FixedVectorType::get( 3391 IntegerType::get(F->getContext(), MinBWs[VL[0]].first), VL.size()); 3392 3393 unsigned ReuseShuffleNumbers = E->ReuseShuffleIndices.size(); 3394 bool NeedToShuffleReuses = !E->ReuseShuffleIndices.empty(); 3395 int ReuseShuffleCost = 0; 3396 if (NeedToShuffleReuses) { 3397 ReuseShuffleCost = 3398 TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, VecTy); 3399 } 3400 if (E->State == TreeEntry::NeedToGather) { 3401 if (allConstant(VL)) 3402 return 0; 3403 if (isSplat(VL)) { 3404 return ReuseShuffleCost + 3405 TTI->getShuffleCost(TargetTransformInfo::SK_Broadcast, VecTy, 0); 3406 } 3407 if (E->getOpcode() == Instruction::ExtractElement && 3408 allSameType(VL) && allSameBlock(VL)) { 3409 Optional<TargetTransformInfo::ShuffleKind> ShuffleKind = isShuffle(VL); 3410 if (ShuffleKind.hasValue()) { 3411 int Cost = TTI->getShuffleCost(ShuffleKind.getValue(), VecTy); 3412 for (auto *V : VL) { 3413 // If all users of instruction are going to be vectorized and this 3414 // instruction itself is not going to be vectorized, consider this 3415 // instruction as dead and remove its cost from the final cost of the 3416 // vectorized tree. 3417 if (areAllUsersVectorized(cast<Instruction>(V)) && 3418 !ScalarToTreeEntry.count(V)) { 3419 auto *IO = cast<ConstantInt>( 3420 cast<ExtractElementInst>(V)->getIndexOperand()); 3421 Cost -= TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, 3422 IO->getZExtValue()); 3423 } 3424 } 3425 return ReuseShuffleCost + Cost; 3426 } 3427 } 3428 return ReuseShuffleCost + getGatherCost(VL); 3429 } 3430 assert(E->State == TreeEntry::Vectorize && "Unhandled state"); 3431 assert(E->getOpcode() && allSameType(VL) && allSameBlock(VL) && "Invalid VL"); 3432 Instruction *VL0 = E->getMainOp(); 3433 unsigned ShuffleOrOp = 3434 E->isAltShuffle() ? (unsigned)Instruction::ShuffleVector : E->getOpcode(); 3435 switch (ShuffleOrOp) { 3436 case Instruction::PHI: 3437 return 0; 3438 3439 case Instruction::ExtractValue: 3440 case Instruction::ExtractElement: { 3441 if (NeedToShuffleReuses) { 3442 unsigned Idx = 0; 3443 for (unsigned I : E->ReuseShuffleIndices) { 3444 if (ShuffleOrOp == Instruction::ExtractElement) { 3445 auto *IO = cast<ConstantInt>( 3446 cast<ExtractElementInst>(VL[I])->getIndexOperand()); 3447 Idx = IO->getZExtValue(); 3448 ReuseShuffleCost -= TTI->getVectorInstrCost( 3449 Instruction::ExtractElement, VecTy, Idx); 3450 } else { 3451 ReuseShuffleCost -= TTI->getVectorInstrCost( 3452 Instruction::ExtractElement, VecTy, Idx); 3453 ++Idx; 3454 } 3455 } 3456 Idx = ReuseShuffleNumbers; 3457 for (Value *V : VL) { 3458 if (ShuffleOrOp == Instruction::ExtractElement) { 3459 auto *IO = cast<ConstantInt>( 3460 cast<ExtractElementInst>(V)->getIndexOperand()); 3461 Idx = IO->getZExtValue(); 3462 } else { 3463 --Idx; 3464 } 3465 ReuseShuffleCost += 3466 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, Idx); 3467 } 3468 } 3469 int DeadCost = ReuseShuffleCost; 3470 if (!E->ReorderIndices.empty()) { 3471 // TODO: Merge this shuffle with the ReuseShuffleCost. 3472 DeadCost += TTI->getShuffleCost( 3473 TargetTransformInfo::SK_PermuteSingleSrc, VecTy); 3474 } 3475 for (unsigned I = 0, E = VL.size(); I < E; ++I) { 3476 Instruction *EI = cast<Instruction>(VL[I]); 3477 // If all users are going to be vectorized, instruction can be 3478 // considered as dead. 3479 // The same, if have only one user, it will be vectorized for sure. 3480 if (areAllUsersVectorized(EI)) { 3481 // Take credit for instruction that will become dead. 3482 if (EI->hasOneUse()) { 3483 Instruction *Ext = EI->user_back(); 3484 if ((isa<SExtInst>(Ext) || isa<ZExtInst>(Ext)) && 3485 all_of(Ext->users(), 3486 [](User *U) { return isa<GetElementPtrInst>(U); })) { 3487 // Use getExtractWithExtendCost() to calculate the cost of 3488 // extractelement/ext pair. 3489 DeadCost -= TTI->getExtractWithExtendCost( 3490 Ext->getOpcode(), Ext->getType(), VecTy, I); 3491 // Add back the cost of s|zext which is subtracted separately. 3492 DeadCost += TTI->getCastInstrCost( 3493 Ext->getOpcode(), Ext->getType(), EI->getType(), 3494 TTI::getCastContextHint(Ext), CostKind, Ext); 3495 continue; 3496 } 3497 } 3498 DeadCost -= 3499 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, I); 3500 } 3501 } 3502 return DeadCost; 3503 } 3504 case Instruction::ZExt: 3505 case Instruction::SExt: 3506 case Instruction::FPToUI: 3507 case Instruction::FPToSI: 3508 case Instruction::FPExt: 3509 case Instruction::PtrToInt: 3510 case Instruction::IntToPtr: 3511 case Instruction::SIToFP: 3512 case Instruction::UIToFP: 3513 case Instruction::Trunc: 3514 case Instruction::FPTrunc: 3515 case Instruction::BitCast: { 3516 Type *SrcTy = VL0->getOperand(0)->getType(); 3517 int ScalarEltCost = 3518 TTI->getCastInstrCost(E->getOpcode(), ScalarTy, SrcTy, 3519 TTI::getCastContextHint(VL0), CostKind, VL0); 3520 if (NeedToShuffleReuses) { 3521 ReuseShuffleCost -= (ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3522 } 3523 3524 // Calculate the cost of this instruction. 3525 int ScalarCost = VL.size() * ScalarEltCost; 3526 3527 auto *SrcVecTy = FixedVectorType::get(SrcTy, VL.size()); 3528 int VecCost = 0; 3529 // Check if the values are candidates to demote. 3530 if (!MinBWs.count(VL0) || VecTy != SrcVecTy) { 3531 VecCost = 3532 ReuseShuffleCost + 3533 TTI->getCastInstrCost(E->getOpcode(), VecTy, SrcVecTy, 3534 TTI::getCastContextHint(VL0), CostKind, VL0); 3535 } 3536 return VecCost - ScalarCost; 3537 } 3538 case Instruction::FCmp: 3539 case Instruction::ICmp: 3540 case Instruction::Select: { 3541 // Calculate the cost of this instruction. 3542 int ScalarEltCost = TTI->getCmpSelInstrCost(E->getOpcode(), ScalarTy, 3543 Builder.getInt1Ty(), 3544 CostKind, VL0); 3545 if (NeedToShuffleReuses) { 3546 ReuseShuffleCost -= (ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3547 } 3548 auto *MaskTy = FixedVectorType::get(Builder.getInt1Ty(), VL.size()); 3549 int ScalarCost = VecTy->getNumElements() * ScalarEltCost; 3550 int VecCost = TTI->getCmpSelInstrCost(E->getOpcode(), VecTy, MaskTy, 3551 CostKind, VL0); 3552 return ReuseShuffleCost + VecCost - ScalarCost; 3553 } 3554 case Instruction::FNeg: 3555 case Instruction::Add: 3556 case Instruction::FAdd: 3557 case Instruction::Sub: 3558 case Instruction::FSub: 3559 case Instruction::Mul: 3560 case Instruction::FMul: 3561 case Instruction::UDiv: 3562 case Instruction::SDiv: 3563 case Instruction::FDiv: 3564 case Instruction::URem: 3565 case Instruction::SRem: 3566 case Instruction::FRem: 3567 case Instruction::Shl: 3568 case Instruction::LShr: 3569 case Instruction::AShr: 3570 case Instruction::And: 3571 case Instruction::Or: 3572 case Instruction::Xor: { 3573 // Certain instructions can be cheaper to vectorize if they have a 3574 // constant second vector operand. 3575 TargetTransformInfo::OperandValueKind Op1VK = 3576 TargetTransformInfo::OK_AnyValue; 3577 TargetTransformInfo::OperandValueKind Op2VK = 3578 TargetTransformInfo::OK_UniformConstantValue; 3579 TargetTransformInfo::OperandValueProperties Op1VP = 3580 TargetTransformInfo::OP_None; 3581 TargetTransformInfo::OperandValueProperties Op2VP = 3582 TargetTransformInfo::OP_PowerOf2; 3583 3584 // If all operands are exactly the same ConstantInt then set the 3585 // operand kind to OK_UniformConstantValue. 3586 // If instead not all operands are constants, then set the operand kind 3587 // to OK_AnyValue. If all operands are constants but not the same, 3588 // then set the operand kind to OK_NonUniformConstantValue. 3589 ConstantInt *CInt0 = nullptr; 3590 for (unsigned i = 0, e = VL.size(); i < e; ++i) { 3591 const Instruction *I = cast<Instruction>(VL[i]); 3592 unsigned OpIdx = isa<BinaryOperator>(I) ? 1 : 0; 3593 ConstantInt *CInt = dyn_cast<ConstantInt>(I->getOperand(OpIdx)); 3594 if (!CInt) { 3595 Op2VK = TargetTransformInfo::OK_AnyValue; 3596 Op2VP = TargetTransformInfo::OP_None; 3597 break; 3598 } 3599 if (Op2VP == TargetTransformInfo::OP_PowerOf2 && 3600 !CInt->getValue().isPowerOf2()) 3601 Op2VP = TargetTransformInfo::OP_None; 3602 if (i == 0) { 3603 CInt0 = CInt; 3604 continue; 3605 } 3606 if (CInt0 != CInt) 3607 Op2VK = TargetTransformInfo::OK_NonUniformConstantValue; 3608 } 3609 3610 SmallVector<const Value *, 4> Operands(VL0->operand_values()); 3611 int ScalarEltCost = TTI->getArithmeticInstrCost( 3612 E->getOpcode(), ScalarTy, CostKind, Op1VK, Op2VK, Op1VP, Op2VP, 3613 Operands, VL0); 3614 if (NeedToShuffleReuses) { 3615 ReuseShuffleCost -= (ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3616 } 3617 int ScalarCost = VecTy->getNumElements() * ScalarEltCost; 3618 int VecCost = TTI->getArithmeticInstrCost( 3619 E->getOpcode(), VecTy, CostKind, Op1VK, Op2VK, Op1VP, Op2VP, 3620 Operands, VL0); 3621 return ReuseShuffleCost + VecCost - ScalarCost; 3622 } 3623 case Instruction::GetElementPtr: { 3624 TargetTransformInfo::OperandValueKind Op1VK = 3625 TargetTransformInfo::OK_AnyValue; 3626 TargetTransformInfo::OperandValueKind Op2VK = 3627 TargetTransformInfo::OK_UniformConstantValue; 3628 3629 int ScalarEltCost = 3630 TTI->getArithmeticInstrCost(Instruction::Add, ScalarTy, CostKind, 3631 Op1VK, Op2VK); 3632 if (NeedToShuffleReuses) { 3633 ReuseShuffleCost -= (ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3634 } 3635 int ScalarCost = VecTy->getNumElements() * ScalarEltCost; 3636 int VecCost = 3637 TTI->getArithmeticInstrCost(Instruction::Add, VecTy, CostKind, 3638 Op1VK, Op2VK); 3639 return ReuseShuffleCost + VecCost - ScalarCost; 3640 } 3641 case Instruction::Load: { 3642 // Cost of wide load - cost of scalar loads. 3643 Align alignment = cast<LoadInst>(VL0)->getAlign(); 3644 int ScalarEltCost = 3645 TTI->getMemoryOpCost(Instruction::Load, ScalarTy, alignment, 0, 3646 CostKind, VL0); 3647 if (NeedToShuffleReuses) { 3648 ReuseShuffleCost -= (ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3649 } 3650 int ScalarLdCost = VecTy->getNumElements() * ScalarEltCost; 3651 int VecLdCost = 3652 TTI->getMemoryOpCost(Instruction::Load, VecTy, alignment, 0, 3653 CostKind, VL0); 3654 if (!E->ReorderIndices.empty()) { 3655 // TODO: Merge this shuffle with the ReuseShuffleCost. 3656 VecLdCost += TTI->getShuffleCost( 3657 TargetTransformInfo::SK_PermuteSingleSrc, VecTy); 3658 } 3659 return ReuseShuffleCost + VecLdCost - ScalarLdCost; 3660 } 3661 case Instruction::Store: { 3662 // We know that we can merge the stores. Calculate the cost. 3663 bool IsReorder = !E->ReorderIndices.empty(); 3664 auto *SI = 3665 cast<StoreInst>(IsReorder ? VL[E->ReorderIndices.front()] : VL0); 3666 Align Alignment = SI->getAlign(); 3667 int ScalarEltCost = 3668 TTI->getMemoryOpCost(Instruction::Store, ScalarTy, Alignment, 0, 3669 CostKind, VL0); 3670 if (NeedToShuffleReuses) 3671 ReuseShuffleCost = -(ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3672 int ScalarStCost = VecTy->getNumElements() * ScalarEltCost; 3673 int VecStCost = TTI->getMemoryOpCost(Instruction::Store, 3674 VecTy, Alignment, 0, CostKind, VL0); 3675 if (IsReorder) { 3676 // TODO: Merge this shuffle with the ReuseShuffleCost. 3677 VecStCost += TTI->getShuffleCost( 3678 TargetTransformInfo::SK_PermuteSingleSrc, VecTy); 3679 } 3680 return ReuseShuffleCost + VecStCost - ScalarStCost; 3681 } 3682 case Instruction::Call: { 3683 CallInst *CI = cast<CallInst>(VL0); 3684 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 3685 3686 // Calculate the cost of the scalar and vector calls. 3687 IntrinsicCostAttributes CostAttrs(ID, *CI, 1, 1); 3688 int ScalarEltCost = TTI->getIntrinsicInstrCost(CostAttrs, CostKind); 3689 if (NeedToShuffleReuses) { 3690 ReuseShuffleCost -= (ReuseShuffleNumbers - VL.size()) * ScalarEltCost; 3691 } 3692 int ScalarCallCost = VecTy->getNumElements() * ScalarEltCost; 3693 3694 auto VecCallCosts = getVectorCallCosts(CI, VecTy, TTI, TLI); 3695 int VecCallCost = std::min(VecCallCosts.first, VecCallCosts.second); 3696 3697 LLVM_DEBUG(dbgs() << "SLP: Call cost " << VecCallCost - ScalarCallCost 3698 << " (" << VecCallCost << "-" << ScalarCallCost << ")" 3699 << " for " << *CI << "\n"); 3700 3701 return ReuseShuffleCost + VecCallCost - ScalarCallCost; 3702 } 3703 case Instruction::ShuffleVector: { 3704 assert(E->isAltShuffle() && 3705 ((Instruction::isBinaryOp(E->getOpcode()) && 3706 Instruction::isBinaryOp(E->getAltOpcode())) || 3707 (Instruction::isCast(E->getOpcode()) && 3708 Instruction::isCast(E->getAltOpcode()))) && 3709 "Invalid Shuffle Vector Operand"); 3710 int ScalarCost = 0; 3711 if (NeedToShuffleReuses) { 3712 for (unsigned Idx : E->ReuseShuffleIndices) { 3713 Instruction *I = cast<Instruction>(VL[Idx]); 3714 ReuseShuffleCost -= TTI->getInstructionCost(I, CostKind); 3715 } 3716 for (Value *V : VL) { 3717 Instruction *I = cast<Instruction>(V); 3718 ReuseShuffleCost += TTI->getInstructionCost(I, CostKind); 3719 } 3720 } 3721 for (Value *V : VL) { 3722 Instruction *I = cast<Instruction>(V); 3723 assert(E->isOpcodeOrAlt(I) && "Unexpected main/alternate opcode"); 3724 ScalarCost += TTI->getInstructionCost(I, CostKind); 3725 } 3726 // VecCost is equal to sum of the cost of creating 2 vectors 3727 // and the cost of creating shuffle. 3728 int VecCost = 0; 3729 if (Instruction::isBinaryOp(E->getOpcode())) { 3730 VecCost = TTI->getArithmeticInstrCost(E->getOpcode(), VecTy, CostKind); 3731 VecCost += TTI->getArithmeticInstrCost(E->getAltOpcode(), VecTy, 3732 CostKind); 3733 } else { 3734 Type *Src0SclTy = E->getMainOp()->getOperand(0)->getType(); 3735 Type *Src1SclTy = E->getAltOp()->getOperand(0)->getType(); 3736 auto *Src0Ty = FixedVectorType::get(Src0SclTy, VL.size()); 3737 auto *Src1Ty = FixedVectorType::get(Src1SclTy, VL.size()); 3738 VecCost = TTI->getCastInstrCost(E->getOpcode(), VecTy, Src0Ty, 3739 TTI::CastContextHint::None, CostKind); 3740 VecCost += TTI->getCastInstrCost(E->getAltOpcode(), VecTy, Src1Ty, 3741 TTI::CastContextHint::None, CostKind); 3742 } 3743 VecCost += TTI->getShuffleCost(TargetTransformInfo::SK_Select, VecTy, 0); 3744 return ReuseShuffleCost + VecCost - ScalarCost; 3745 } 3746 default: 3747 llvm_unreachable("Unknown instruction"); 3748 } 3749 } 3750 3751 bool BoUpSLP::isFullyVectorizableTinyTree() const { 3752 LLVM_DEBUG(dbgs() << "SLP: Check whether the tree with height " 3753 << VectorizableTree.size() << " is fully vectorizable .\n"); 3754 3755 // We only handle trees of heights 1 and 2. 3756 if (VectorizableTree.size() == 1 && 3757 VectorizableTree[0]->State == TreeEntry::Vectorize) 3758 return true; 3759 3760 if (VectorizableTree.size() != 2) 3761 return false; 3762 3763 // Handle splat and all-constants stores. 3764 if (VectorizableTree[0]->State == TreeEntry::Vectorize && 3765 (allConstant(VectorizableTree[1]->Scalars) || 3766 isSplat(VectorizableTree[1]->Scalars))) 3767 return true; 3768 3769 // Gathering cost would be too much for tiny trees. 3770 if (VectorizableTree[0]->State == TreeEntry::NeedToGather || 3771 VectorizableTree[1]->State == TreeEntry::NeedToGather) 3772 return false; 3773 3774 return true; 3775 } 3776 3777 static bool isLoadCombineCandidateImpl(Value *Root, unsigned NumElts, 3778 TargetTransformInfo *TTI) { 3779 // Look past the root to find a source value. Arbitrarily follow the 3780 // path through operand 0 of any 'or'. Also, peek through optional 3781 // shift-left-by-multiple-of-8-bits. 3782 Value *ZextLoad = Root; 3783 const APInt *ShAmtC; 3784 while (!isa<ConstantExpr>(ZextLoad) && 3785 (match(ZextLoad, m_Or(m_Value(), m_Value())) || 3786 (match(ZextLoad, m_Shl(m_Value(), m_APInt(ShAmtC))) && 3787 ShAmtC->urem(8) == 0))) 3788 ZextLoad = cast<BinaryOperator>(ZextLoad)->getOperand(0); 3789 3790 // Check if the input is an extended load of the required or/shift expression. 3791 Value *LoadPtr; 3792 if (ZextLoad == Root || !match(ZextLoad, m_ZExt(m_Load(m_Value(LoadPtr))))) 3793 return false; 3794 3795 // Require that the total load bit width is a legal integer type. 3796 // For example, <8 x i8> --> i64 is a legal integer on a 64-bit target. 3797 // But <16 x i8> --> i128 is not, so the backend probably can't reduce it. 3798 Type *SrcTy = LoadPtr->getType()->getPointerElementType(); 3799 unsigned LoadBitWidth = SrcTy->getIntegerBitWidth() * NumElts; 3800 if (!TTI->isTypeLegal(IntegerType::get(Root->getContext(), LoadBitWidth))) 3801 return false; 3802 3803 // Everything matched - assume that we can fold the whole sequence using 3804 // load combining. 3805 LLVM_DEBUG(dbgs() << "SLP: Assume load combining for tree starting at " 3806 << *(cast<Instruction>(Root)) << "\n"); 3807 3808 return true; 3809 } 3810 3811 bool BoUpSLP::isLoadCombineReductionCandidate(unsigned RdxOpcode) const { 3812 if (RdxOpcode != Instruction::Or) 3813 return false; 3814 3815 unsigned NumElts = VectorizableTree[0]->Scalars.size(); 3816 Value *FirstReduced = VectorizableTree[0]->Scalars[0]; 3817 return isLoadCombineCandidateImpl(FirstReduced, NumElts, TTI); 3818 } 3819 3820 bool BoUpSLP::isLoadCombineCandidate() const { 3821 // Peek through a final sequence of stores and check if all operations are 3822 // likely to be load-combined. 3823 unsigned NumElts = VectorizableTree[0]->Scalars.size(); 3824 for (Value *Scalar : VectorizableTree[0]->Scalars) { 3825 Value *X; 3826 if (!match(Scalar, m_Store(m_Value(X), m_Value())) || 3827 !isLoadCombineCandidateImpl(X, NumElts, TTI)) 3828 return false; 3829 } 3830 return true; 3831 } 3832 3833 bool BoUpSLP::isTreeTinyAndNotFullyVectorizable() const { 3834 // We can vectorize the tree if its size is greater than or equal to the 3835 // minimum size specified by the MinTreeSize command line option. 3836 if (VectorizableTree.size() >= MinTreeSize) 3837 return false; 3838 3839 // If we have a tiny tree (a tree whose size is less than MinTreeSize), we 3840 // can vectorize it if we can prove it fully vectorizable. 3841 if (isFullyVectorizableTinyTree()) 3842 return false; 3843 3844 assert(VectorizableTree.empty() 3845 ? ExternalUses.empty() 3846 : true && "We shouldn't have any external users"); 3847 3848 // Otherwise, we can't vectorize the tree. It is both tiny and not fully 3849 // vectorizable. 3850 return true; 3851 } 3852 3853 int BoUpSLP::getSpillCost() const { 3854 // Walk from the bottom of the tree to the top, tracking which values are 3855 // live. When we see a call instruction that is not part of our tree, 3856 // query TTI to see if there is a cost to keeping values live over it 3857 // (for example, if spills and fills are required). 3858 unsigned BundleWidth = VectorizableTree.front()->Scalars.size(); 3859 int Cost = 0; 3860 3861 SmallPtrSet<Instruction*, 4> LiveValues; 3862 Instruction *PrevInst = nullptr; 3863 3864 // The entries in VectorizableTree are not necessarily ordered by their 3865 // position in basic blocks. Collect them and order them by dominance so later 3866 // instructions are guaranteed to be visited first. For instructions in 3867 // different basic blocks, we only scan to the beginning of the block, so 3868 // their order does not matter, as long as all instructions in a basic block 3869 // are grouped together. Using dominance ensures a deterministic order. 3870 SmallVector<Instruction *, 16> OrderedScalars; 3871 for (const auto &TEPtr : VectorizableTree) { 3872 Instruction *Inst = dyn_cast<Instruction>(TEPtr->Scalars[0]); 3873 if (!Inst) 3874 continue; 3875 OrderedScalars.push_back(Inst); 3876 } 3877 llvm::stable_sort(OrderedScalars, [this](Instruction *A, Instruction *B) { 3878 return DT->dominates(B, A); 3879 }); 3880 3881 for (Instruction *Inst : OrderedScalars) { 3882 if (!PrevInst) { 3883 PrevInst = Inst; 3884 continue; 3885 } 3886 3887 // Update LiveValues. 3888 LiveValues.erase(PrevInst); 3889 for (auto &J : PrevInst->operands()) { 3890 if (isa<Instruction>(&*J) && getTreeEntry(&*J)) 3891 LiveValues.insert(cast<Instruction>(&*J)); 3892 } 3893 3894 LLVM_DEBUG({ 3895 dbgs() << "SLP: #LV: " << LiveValues.size(); 3896 for (auto *X : LiveValues) 3897 dbgs() << " " << X->getName(); 3898 dbgs() << ", Looking at "; 3899 Inst->dump(); 3900 }); 3901 3902 // Now find the sequence of instructions between PrevInst and Inst. 3903 unsigned NumCalls = 0; 3904 BasicBlock::reverse_iterator InstIt = ++Inst->getIterator().getReverse(), 3905 PrevInstIt = 3906 PrevInst->getIterator().getReverse(); 3907 while (InstIt != PrevInstIt) { 3908 if (PrevInstIt == PrevInst->getParent()->rend()) { 3909 PrevInstIt = Inst->getParent()->rbegin(); 3910 continue; 3911 } 3912 3913 // Debug information does not impact spill cost. 3914 if ((isa<CallInst>(&*PrevInstIt) && 3915 !isa<DbgInfoIntrinsic>(&*PrevInstIt)) && 3916 &*PrevInstIt != PrevInst) 3917 NumCalls++; 3918 3919 ++PrevInstIt; 3920 } 3921 3922 if (NumCalls) { 3923 SmallVector<Type*, 4> V; 3924 for (auto *II : LiveValues) 3925 V.push_back(FixedVectorType::get(II->getType(), BundleWidth)); 3926 Cost += NumCalls * TTI->getCostOfKeepingLiveOverCall(V); 3927 } 3928 3929 PrevInst = Inst; 3930 } 3931 3932 return Cost; 3933 } 3934 3935 int BoUpSLP::getTreeCost() { 3936 int Cost = 0; 3937 LLVM_DEBUG(dbgs() << "SLP: Calculating cost for tree of size " 3938 << VectorizableTree.size() << ".\n"); 3939 3940 unsigned BundleWidth = VectorizableTree[0]->Scalars.size(); 3941 3942 for (unsigned I = 0, E = VectorizableTree.size(); I < E; ++I) { 3943 TreeEntry &TE = *VectorizableTree[I].get(); 3944 3945 // We create duplicate tree entries for gather sequences that have multiple 3946 // uses. However, we should not compute the cost of duplicate sequences. 3947 // For example, if we have a build vector (i.e., insertelement sequence) 3948 // that is used by more than one vector instruction, we only need to 3949 // compute the cost of the insertelement instructions once. The redundant 3950 // instructions will be eliminated by CSE. 3951 // 3952 // We should consider not creating duplicate tree entries for gather 3953 // sequences, and instead add additional edges to the tree representing 3954 // their uses. Since such an approach results in fewer total entries, 3955 // existing heuristics based on tree size may yield different results. 3956 // 3957 if (TE.State == TreeEntry::NeedToGather && 3958 std::any_of(std::next(VectorizableTree.begin(), I + 1), 3959 VectorizableTree.end(), 3960 [TE](const std::unique_ptr<TreeEntry> &EntryPtr) { 3961 return EntryPtr->State == TreeEntry::NeedToGather && 3962 EntryPtr->isSame(TE.Scalars); 3963 })) 3964 continue; 3965 3966 int C = getEntryCost(&TE); 3967 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << C 3968 << " for bundle that starts with " << *TE.Scalars[0] 3969 << ".\n"); 3970 Cost += C; 3971 } 3972 3973 SmallPtrSet<Value *, 16> ExtractCostCalculated; 3974 int ExtractCost = 0; 3975 for (ExternalUser &EU : ExternalUses) { 3976 // We only add extract cost once for the same scalar. 3977 if (!ExtractCostCalculated.insert(EU.Scalar).second) 3978 continue; 3979 3980 // Uses by ephemeral values are free (because the ephemeral value will be 3981 // removed prior to code generation, and so the extraction will be 3982 // removed as well). 3983 if (EphValues.count(EU.User)) 3984 continue; 3985 3986 // If we plan to rewrite the tree in a smaller type, we will need to sign 3987 // extend the extracted value back to the original type. Here, we account 3988 // for the extract and the added cost of the sign extend if needed. 3989 auto *VecTy = FixedVectorType::get(EU.Scalar->getType(), BundleWidth); 3990 auto *ScalarRoot = VectorizableTree[0]->Scalars[0]; 3991 if (MinBWs.count(ScalarRoot)) { 3992 auto *MinTy = IntegerType::get(F->getContext(), MinBWs[ScalarRoot].first); 3993 auto Extend = 3994 MinBWs[ScalarRoot].second ? Instruction::SExt : Instruction::ZExt; 3995 VecTy = FixedVectorType::get(MinTy, BundleWidth); 3996 ExtractCost += TTI->getExtractWithExtendCost(Extend, EU.Scalar->getType(), 3997 VecTy, EU.Lane); 3998 } else { 3999 ExtractCost += 4000 TTI->getVectorInstrCost(Instruction::ExtractElement, VecTy, EU.Lane); 4001 } 4002 } 4003 4004 int SpillCost = getSpillCost(); 4005 Cost += SpillCost + ExtractCost; 4006 4007 #ifndef NDEBUG 4008 SmallString<256> Str; 4009 { 4010 raw_svector_ostream OS(Str); 4011 OS << "SLP: Spill Cost = " << SpillCost << ".\n" 4012 << "SLP: Extract Cost = " << ExtractCost << ".\n" 4013 << "SLP: Total Cost = " << Cost << ".\n"; 4014 } 4015 LLVM_DEBUG(dbgs() << Str); 4016 if (ViewSLPTree) 4017 ViewGraph(this, "SLP" + F->getName(), false, Str); 4018 #endif 4019 4020 return Cost; 4021 } 4022 4023 int BoUpSLP::getGatherCost(FixedVectorType *Ty, 4024 const DenseSet<unsigned> &ShuffledIndices) const { 4025 unsigned NumElts = Ty->getNumElements(); 4026 APInt DemandedElts = APInt::getNullValue(NumElts); 4027 for (unsigned I = 0; I < NumElts; ++I) 4028 if (!ShuffledIndices.count(I)) 4029 DemandedElts.setBit(I); 4030 int Cost = TTI->getScalarizationOverhead(Ty, DemandedElts, /*Insert*/ true, 4031 /*Extract*/ false); 4032 if (!ShuffledIndices.empty()) 4033 Cost += TTI->getShuffleCost(TargetTransformInfo::SK_PermuteSingleSrc, Ty); 4034 return Cost; 4035 } 4036 4037 int BoUpSLP::getGatherCost(ArrayRef<Value *> VL) const { 4038 // Find the type of the operands in VL. 4039 Type *ScalarTy = VL[0]->getType(); 4040 if (StoreInst *SI = dyn_cast<StoreInst>(VL[0])) 4041 ScalarTy = SI->getValueOperand()->getType(); 4042 auto *VecTy = FixedVectorType::get(ScalarTy, VL.size()); 4043 // Find the cost of inserting/extracting values from the vector. 4044 // Check if the same elements are inserted several times and count them as 4045 // shuffle candidates. 4046 DenseSet<unsigned> ShuffledElements; 4047 DenseSet<Value *> UniqueElements; 4048 // Iterate in reverse order to consider insert elements with the high cost. 4049 for (unsigned I = VL.size(); I > 0; --I) { 4050 unsigned Idx = I - 1; 4051 if (!UniqueElements.insert(VL[Idx]).second) 4052 ShuffledElements.insert(Idx); 4053 } 4054 return getGatherCost(VecTy, ShuffledElements); 4055 } 4056 4057 // Perform operand reordering on the instructions in VL and return the reordered 4058 // operands in Left and Right. 4059 void BoUpSLP::reorderInputsAccordingToOpcode(ArrayRef<Value *> VL, 4060 SmallVectorImpl<Value *> &Left, 4061 SmallVectorImpl<Value *> &Right, 4062 const DataLayout &DL, 4063 ScalarEvolution &SE, 4064 const BoUpSLP &R) { 4065 if (VL.empty()) 4066 return; 4067 VLOperands Ops(VL, DL, SE, R); 4068 // Reorder the operands in place. 4069 Ops.reorder(); 4070 Left = Ops.getVL(0); 4071 Right = Ops.getVL(1); 4072 } 4073 4074 void BoUpSLP::setInsertPointAfterBundle(TreeEntry *E) { 4075 // Get the basic block this bundle is in. All instructions in the bundle 4076 // should be in this block. 4077 auto *Front = E->getMainOp(); 4078 auto *BB = Front->getParent(); 4079 assert(llvm::all_of(make_range(E->Scalars.begin(), E->Scalars.end()), 4080 [=](Value *V) -> bool { 4081 auto *I = cast<Instruction>(V); 4082 return !E->isOpcodeOrAlt(I) || I->getParent() == BB; 4083 })); 4084 4085 // The last instruction in the bundle in program order. 4086 Instruction *LastInst = nullptr; 4087 4088 // Find the last instruction. The common case should be that BB has been 4089 // scheduled, and the last instruction is VL.back(). So we start with 4090 // VL.back() and iterate over schedule data until we reach the end of the 4091 // bundle. The end of the bundle is marked by null ScheduleData. 4092 if (BlocksSchedules.count(BB)) { 4093 auto *Bundle = 4094 BlocksSchedules[BB]->getScheduleData(E->isOneOf(E->Scalars.back())); 4095 if (Bundle && Bundle->isPartOfBundle()) 4096 for (; Bundle; Bundle = Bundle->NextInBundle) 4097 if (Bundle->OpValue == Bundle->Inst) 4098 LastInst = Bundle->Inst; 4099 } 4100 4101 // LastInst can still be null at this point if there's either not an entry 4102 // for BB in BlocksSchedules or there's no ScheduleData available for 4103 // VL.back(). This can be the case if buildTree_rec aborts for various 4104 // reasons (e.g., the maximum recursion depth is reached, the maximum region 4105 // size is reached, etc.). ScheduleData is initialized in the scheduling 4106 // "dry-run". 4107 // 4108 // If this happens, we can still find the last instruction by brute force. We 4109 // iterate forwards from Front (inclusive) until we either see all 4110 // instructions in the bundle or reach the end of the block. If Front is the 4111 // last instruction in program order, LastInst will be set to Front, and we 4112 // will visit all the remaining instructions in the block. 4113 // 4114 // One of the reasons we exit early from buildTree_rec is to place an upper 4115 // bound on compile-time. Thus, taking an additional compile-time hit here is 4116 // not ideal. However, this should be exceedingly rare since it requires that 4117 // we both exit early from buildTree_rec and that the bundle be out-of-order 4118 // (causing us to iterate all the way to the end of the block). 4119 if (!LastInst) { 4120 SmallPtrSet<Value *, 16> Bundle(E->Scalars.begin(), E->Scalars.end()); 4121 for (auto &I : make_range(BasicBlock::iterator(Front), BB->end())) { 4122 if (Bundle.erase(&I) && E->isOpcodeOrAlt(&I)) 4123 LastInst = &I; 4124 if (Bundle.empty()) 4125 break; 4126 } 4127 } 4128 assert(LastInst && "Failed to find last instruction in bundle"); 4129 4130 // Set the insertion point after the last instruction in the bundle. Set the 4131 // debug location to Front. 4132 Builder.SetInsertPoint(BB, ++LastInst->getIterator()); 4133 Builder.SetCurrentDebugLocation(Front->getDebugLoc()); 4134 } 4135 4136 Value *BoUpSLP::gather(ArrayRef<Value *> VL) { 4137 Value *Val0 = 4138 isa<StoreInst>(VL[0]) ? cast<StoreInst>(VL[0])->getValueOperand() : VL[0]; 4139 FixedVectorType *VecTy = FixedVectorType::get(Val0->getType(), VL.size()); 4140 Value *Vec = UndefValue::get(VecTy); 4141 unsigned InsIndex = 0; 4142 for (Value *Val : VL) { 4143 Vec = Builder.CreateInsertElement(Vec, Val, Builder.getInt32(InsIndex++)); 4144 auto *InsElt = dyn_cast<InsertElementInst>(Vec); 4145 if (!InsElt) 4146 continue; 4147 GatherSeq.insert(InsElt); 4148 CSEBlocks.insert(InsElt->getParent()); 4149 // Add to our 'need-to-extract' list. 4150 if (TreeEntry *Entry = getTreeEntry(Val)) { 4151 // Find which lane we need to extract. 4152 unsigned FoundLane = std::distance(Entry->Scalars.begin(), 4153 find(Entry->Scalars, Val)); 4154 assert(FoundLane < Entry->Scalars.size() && "Couldn't find extract lane"); 4155 if (!Entry->ReuseShuffleIndices.empty()) { 4156 FoundLane = std::distance(Entry->ReuseShuffleIndices.begin(), 4157 find(Entry->ReuseShuffleIndices, FoundLane)); 4158 } 4159 ExternalUses.push_back(ExternalUser(Val, InsElt, FoundLane)); 4160 } 4161 } 4162 4163 return Vec; 4164 } 4165 4166 Value *BoUpSLP::vectorizeTree(ArrayRef<Value *> VL) { 4167 InstructionsState S = getSameOpcode(VL); 4168 if (S.getOpcode()) { 4169 if (TreeEntry *E = getTreeEntry(S.OpValue)) { 4170 if (E->isSame(VL)) { 4171 Value *V = vectorizeTree(E); 4172 if (VL.size() == E->Scalars.size() && !E->ReuseShuffleIndices.empty()) { 4173 // We need to get the vectorized value but without shuffle. 4174 if (auto *SV = dyn_cast<ShuffleVectorInst>(V)) { 4175 V = SV->getOperand(0); 4176 } else { 4177 // Reshuffle to get only unique values. 4178 SmallVector<int, 4> UniqueIdxs; 4179 SmallSet<int, 4> UsedIdxs; 4180 for (int Idx : E->ReuseShuffleIndices) 4181 if (UsedIdxs.insert(Idx).second) 4182 UniqueIdxs.emplace_back(Idx); 4183 V = Builder.CreateShuffleVector(V, UniqueIdxs); 4184 } 4185 } 4186 return V; 4187 } 4188 } 4189 } 4190 4191 // Check that every instruction appears once in this bundle. 4192 SmallVector<int, 4> ReuseShuffleIndicies; 4193 SmallVector<Value *, 4> UniqueValues; 4194 if (VL.size() > 2) { 4195 DenseMap<Value *, unsigned> UniquePositions; 4196 for (Value *V : VL) { 4197 auto Res = UniquePositions.try_emplace(V, UniqueValues.size()); 4198 ReuseShuffleIndicies.emplace_back(Res.first->second); 4199 if (Res.second || isa<Constant>(V)) 4200 UniqueValues.emplace_back(V); 4201 } 4202 // Do not shuffle single element or if number of unique values is not power 4203 // of 2. 4204 if (UniqueValues.size() == VL.size() || UniqueValues.size() <= 1 || 4205 !llvm::isPowerOf2_32(UniqueValues.size())) 4206 ReuseShuffleIndicies.clear(); 4207 else 4208 VL = UniqueValues; 4209 } 4210 4211 Value *Vec = gather(VL); 4212 if (!ReuseShuffleIndicies.empty()) { 4213 Vec = Builder.CreateShuffleVector(Vec, ReuseShuffleIndicies, "shuffle"); 4214 if (auto *I = dyn_cast<Instruction>(Vec)) { 4215 GatherSeq.insert(I); 4216 CSEBlocks.insert(I->getParent()); 4217 } 4218 } 4219 return Vec; 4220 } 4221 4222 Value *BoUpSLP::vectorizeTree(TreeEntry *E) { 4223 IRBuilder<>::InsertPointGuard Guard(Builder); 4224 4225 if (E->VectorizedValue) { 4226 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *E->Scalars[0] << ".\n"); 4227 return E->VectorizedValue; 4228 } 4229 4230 bool NeedToShuffleReuses = !E->ReuseShuffleIndices.empty(); 4231 if (E->State == TreeEntry::NeedToGather) { 4232 setInsertPointAfterBundle(E); 4233 Value *Vec = gather(E->Scalars); 4234 if (NeedToShuffleReuses) { 4235 Vec = Builder.CreateShuffleVector(Vec, E->ReuseShuffleIndices, "shuffle"); 4236 if (auto *I = dyn_cast<Instruction>(Vec)) { 4237 GatherSeq.insert(I); 4238 CSEBlocks.insert(I->getParent()); 4239 } 4240 } 4241 E->VectorizedValue = Vec; 4242 return Vec; 4243 } 4244 4245 assert(E->State == TreeEntry::Vectorize && "Unhandled state"); 4246 unsigned ShuffleOrOp = 4247 E->isAltShuffle() ? (unsigned)Instruction::ShuffleVector : E->getOpcode(); 4248 Instruction *VL0 = E->getMainOp(); 4249 Type *ScalarTy = VL0->getType(); 4250 if (auto *Store = dyn_cast<StoreInst>(VL0)) 4251 ScalarTy = Store->getValueOperand()->getType(); 4252 auto *VecTy = FixedVectorType::get(ScalarTy, E->Scalars.size()); 4253 switch (ShuffleOrOp) { 4254 case Instruction::PHI: { 4255 auto *PH = cast<PHINode>(VL0); 4256 Builder.SetInsertPoint(PH->getParent()->getFirstNonPHI()); 4257 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 4258 PHINode *NewPhi = Builder.CreatePHI(VecTy, PH->getNumIncomingValues()); 4259 Value *V = NewPhi; 4260 if (NeedToShuffleReuses) 4261 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4262 4263 E->VectorizedValue = V; 4264 4265 // PHINodes may have multiple entries from the same block. We want to 4266 // visit every block once. 4267 SmallPtrSet<BasicBlock*, 4> VisitedBBs; 4268 4269 for (unsigned i = 0, e = PH->getNumIncomingValues(); i < e; ++i) { 4270 ValueList Operands; 4271 BasicBlock *IBB = PH->getIncomingBlock(i); 4272 4273 if (!VisitedBBs.insert(IBB).second) { 4274 NewPhi->addIncoming(NewPhi->getIncomingValueForBlock(IBB), IBB); 4275 continue; 4276 } 4277 4278 Builder.SetInsertPoint(IBB->getTerminator()); 4279 Builder.SetCurrentDebugLocation(PH->getDebugLoc()); 4280 Value *Vec = vectorizeTree(E->getOperand(i)); 4281 NewPhi->addIncoming(Vec, IBB); 4282 } 4283 4284 assert(NewPhi->getNumIncomingValues() == PH->getNumIncomingValues() && 4285 "Invalid number of incoming values"); 4286 return V; 4287 } 4288 4289 case Instruction::ExtractElement: { 4290 Value *V = E->getSingleOperand(0); 4291 if (!E->ReorderIndices.empty()) { 4292 SmallVector<int, 4> Mask; 4293 inversePermutation(E->ReorderIndices, Mask); 4294 Builder.SetInsertPoint(VL0); 4295 V = Builder.CreateShuffleVector(V, Mask, "reorder_shuffle"); 4296 } 4297 if (NeedToShuffleReuses) { 4298 // TODO: Merge this shuffle with the ReorderShuffleMask. 4299 if (E->ReorderIndices.empty()) 4300 Builder.SetInsertPoint(VL0); 4301 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4302 } 4303 E->VectorizedValue = V; 4304 return V; 4305 } 4306 case Instruction::ExtractValue: { 4307 auto *LI = cast<LoadInst>(E->getSingleOperand(0)); 4308 Builder.SetInsertPoint(LI); 4309 auto *PtrTy = PointerType::get(VecTy, LI->getPointerAddressSpace()); 4310 Value *Ptr = Builder.CreateBitCast(LI->getOperand(0), PtrTy); 4311 LoadInst *V = Builder.CreateAlignedLoad(VecTy, Ptr, LI->getAlign()); 4312 Value *NewV = propagateMetadata(V, E->Scalars); 4313 if (!E->ReorderIndices.empty()) { 4314 SmallVector<int, 4> Mask; 4315 inversePermutation(E->ReorderIndices, Mask); 4316 NewV = Builder.CreateShuffleVector(NewV, Mask, "reorder_shuffle"); 4317 } 4318 if (NeedToShuffleReuses) { 4319 // TODO: Merge this shuffle with the ReorderShuffleMask. 4320 NewV = Builder.CreateShuffleVector(NewV, E->ReuseShuffleIndices, 4321 "shuffle"); 4322 } 4323 E->VectorizedValue = NewV; 4324 return NewV; 4325 } 4326 case Instruction::ZExt: 4327 case Instruction::SExt: 4328 case Instruction::FPToUI: 4329 case Instruction::FPToSI: 4330 case Instruction::FPExt: 4331 case Instruction::PtrToInt: 4332 case Instruction::IntToPtr: 4333 case Instruction::SIToFP: 4334 case Instruction::UIToFP: 4335 case Instruction::Trunc: 4336 case Instruction::FPTrunc: 4337 case Instruction::BitCast: { 4338 setInsertPointAfterBundle(E); 4339 4340 Value *InVec = vectorizeTree(E->getOperand(0)); 4341 4342 if (E->VectorizedValue) { 4343 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 4344 return E->VectorizedValue; 4345 } 4346 4347 auto *CI = cast<CastInst>(VL0); 4348 Value *V = Builder.CreateCast(CI->getOpcode(), InVec, VecTy); 4349 if (NeedToShuffleReuses) 4350 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4351 4352 E->VectorizedValue = V; 4353 ++NumVectorInstructions; 4354 return V; 4355 } 4356 case Instruction::FCmp: 4357 case Instruction::ICmp: { 4358 setInsertPointAfterBundle(E); 4359 4360 Value *L = vectorizeTree(E->getOperand(0)); 4361 Value *R = vectorizeTree(E->getOperand(1)); 4362 4363 if (E->VectorizedValue) { 4364 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 4365 return E->VectorizedValue; 4366 } 4367 4368 CmpInst::Predicate P0 = cast<CmpInst>(VL0)->getPredicate(); 4369 Value *V = Builder.CreateCmp(P0, L, R); 4370 propagateIRFlags(V, E->Scalars, VL0); 4371 if (NeedToShuffleReuses) 4372 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4373 4374 E->VectorizedValue = V; 4375 ++NumVectorInstructions; 4376 return V; 4377 } 4378 case Instruction::Select: { 4379 setInsertPointAfterBundle(E); 4380 4381 Value *Cond = vectorizeTree(E->getOperand(0)); 4382 Value *True = vectorizeTree(E->getOperand(1)); 4383 Value *False = vectorizeTree(E->getOperand(2)); 4384 4385 if (E->VectorizedValue) { 4386 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 4387 return E->VectorizedValue; 4388 } 4389 4390 Value *V = Builder.CreateSelect(Cond, True, False); 4391 if (NeedToShuffleReuses) 4392 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4393 4394 E->VectorizedValue = V; 4395 ++NumVectorInstructions; 4396 return V; 4397 } 4398 case Instruction::FNeg: { 4399 setInsertPointAfterBundle(E); 4400 4401 Value *Op = vectorizeTree(E->getOperand(0)); 4402 4403 if (E->VectorizedValue) { 4404 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 4405 return E->VectorizedValue; 4406 } 4407 4408 Value *V = Builder.CreateUnOp( 4409 static_cast<Instruction::UnaryOps>(E->getOpcode()), Op); 4410 propagateIRFlags(V, E->Scalars, VL0); 4411 if (auto *I = dyn_cast<Instruction>(V)) 4412 V = propagateMetadata(I, E->Scalars); 4413 4414 if (NeedToShuffleReuses) 4415 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4416 4417 E->VectorizedValue = V; 4418 ++NumVectorInstructions; 4419 4420 return V; 4421 } 4422 case Instruction::Add: 4423 case Instruction::FAdd: 4424 case Instruction::Sub: 4425 case Instruction::FSub: 4426 case Instruction::Mul: 4427 case Instruction::FMul: 4428 case Instruction::UDiv: 4429 case Instruction::SDiv: 4430 case Instruction::FDiv: 4431 case Instruction::URem: 4432 case Instruction::SRem: 4433 case Instruction::FRem: 4434 case Instruction::Shl: 4435 case Instruction::LShr: 4436 case Instruction::AShr: 4437 case Instruction::And: 4438 case Instruction::Or: 4439 case Instruction::Xor: { 4440 setInsertPointAfterBundle(E); 4441 4442 Value *LHS = vectorizeTree(E->getOperand(0)); 4443 Value *RHS = vectorizeTree(E->getOperand(1)); 4444 4445 if (E->VectorizedValue) { 4446 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 4447 return E->VectorizedValue; 4448 } 4449 4450 Value *V = Builder.CreateBinOp( 4451 static_cast<Instruction::BinaryOps>(E->getOpcode()), LHS, 4452 RHS); 4453 propagateIRFlags(V, E->Scalars, VL0); 4454 if (auto *I = dyn_cast<Instruction>(V)) 4455 V = propagateMetadata(I, E->Scalars); 4456 4457 if (NeedToShuffleReuses) 4458 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4459 4460 E->VectorizedValue = V; 4461 ++NumVectorInstructions; 4462 4463 return V; 4464 } 4465 case Instruction::Load: { 4466 // Loads are inserted at the head of the tree because we don't want to 4467 // sink them all the way down past store instructions. 4468 bool IsReorder = E->updateStateIfReorder(); 4469 if (IsReorder) 4470 VL0 = E->getMainOp(); 4471 setInsertPointAfterBundle(E); 4472 4473 LoadInst *LI = cast<LoadInst>(VL0); 4474 unsigned AS = LI->getPointerAddressSpace(); 4475 4476 Value *VecPtr = Builder.CreateBitCast(LI->getPointerOperand(), 4477 VecTy->getPointerTo(AS)); 4478 4479 // The pointer operand uses an in-tree scalar so we add the new BitCast to 4480 // ExternalUses list to make sure that an extract will be generated in the 4481 // future. 4482 Value *PO = LI->getPointerOperand(); 4483 if (getTreeEntry(PO)) 4484 ExternalUses.push_back(ExternalUser(PO, cast<User>(VecPtr), 0)); 4485 4486 LI = Builder.CreateAlignedLoad(VecTy, VecPtr, LI->getAlign()); 4487 Value *V = propagateMetadata(LI, E->Scalars); 4488 if (IsReorder) { 4489 SmallVector<int, 4> Mask; 4490 inversePermutation(E->ReorderIndices, Mask); 4491 V = Builder.CreateShuffleVector(V, Mask, "reorder_shuffle"); 4492 } 4493 if (NeedToShuffleReuses) { 4494 // TODO: Merge this shuffle with the ReorderShuffleMask. 4495 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4496 } 4497 E->VectorizedValue = V; 4498 ++NumVectorInstructions; 4499 return V; 4500 } 4501 case Instruction::Store: { 4502 bool IsReorder = !E->ReorderIndices.empty(); 4503 auto *SI = cast<StoreInst>( 4504 IsReorder ? E->Scalars[E->ReorderIndices.front()] : VL0); 4505 unsigned AS = SI->getPointerAddressSpace(); 4506 4507 setInsertPointAfterBundle(E); 4508 4509 Value *VecValue = vectorizeTree(E->getOperand(0)); 4510 if (IsReorder) { 4511 SmallVector<int, 4> Mask(E->ReorderIndices.begin(), 4512 E->ReorderIndices.end()); 4513 VecValue = Builder.CreateShuffleVector(VecValue, Mask, "reorder_shuf"); 4514 } 4515 Value *ScalarPtr = SI->getPointerOperand(); 4516 Value *VecPtr = Builder.CreateBitCast( 4517 ScalarPtr, VecValue->getType()->getPointerTo(AS)); 4518 StoreInst *ST = Builder.CreateAlignedStore(VecValue, VecPtr, 4519 SI->getAlign()); 4520 4521 // The pointer operand uses an in-tree scalar, so add the new BitCast to 4522 // ExternalUses to make sure that an extract will be generated in the 4523 // future. 4524 if (getTreeEntry(ScalarPtr)) 4525 ExternalUses.push_back(ExternalUser(ScalarPtr, cast<User>(VecPtr), 0)); 4526 4527 Value *V = propagateMetadata(ST, E->Scalars); 4528 if (NeedToShuffleReuses) 4529 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4530 4531 E->VectorizedValue = V; 4532 ++NumVectorInstructions; 4533 return V; 4534 } 4535 case Instruction::GetElementPtr: { 4536 setInsertPointAfterBundle(E); 4537 4538 Value *Op0 = vectorizeTree(E->getOperand(0)); 4539 4540 std::vector<Value *> OpVecs; 4541 for (int j = 1, e = cast<GetElementPtrInst>(VL0)->getNumOperands(); j < e; 4542 ++j) { 4543 ValueList &VL = E->getOperand(j); 4544 // Need to cast all elements to the same type before vectorization to 4545 // avoid crash. 4546 Type *VL0Ty = VL0->getOperand(j)->getType(); 4547 Type *Ty = llvm::all_of( 4548 VL, [VL0Ty](Value *V) { return VL0Ty == V->getType(); }) 4549 ? VL0Ty 4550 : DL->getIndexType(cast<GetElementPtrInst>(VL0) 4551 ->getPointerOperandType() 4552 ->getScalarType()); 4553 for (Value *&V : VL) { 4554 auto *CI = cast<ConstantInt>(V); 4555 V = ConstantExpr::getIntegerCast(CI, Ty, 4556 CI->getValue().isSignBitSet()); 4557 } 4558 Value *OpVec = vectorizeTree(VL); 4559 OpVecs.push_back(OpVec); 4560 } 4561 4562 Value *V = Builder.CreateGEP( 4563 cast<GetElementPtrInst>(VL0)->getSourceElementType(), Op0, OpVecs); 4564 if (Instruction *I = dyn_cast<Instruction>(V)) 4565 V = propagateMetadata(I, E->Scalars); 4566 4567 if (NeedToShuffleReuses) 4568 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4569 4570 E->VectorizedValue = V; 4571 ++NumVectorInstructions; 4572 4573 return V; 4574 } 4575 case Instruction::Call: { 4576 CallInst *CI = cast<CallInst>(VL0); 4577 setInsertPointAfterBundle(E); 4578 4579 Intrinsic::ID IID = Intrinsic::not_intrinsic; 4580 if (Function *FI = CI->getCalledFunction()) 4581 IID = FI->getIntrinsicID(); 4582 4583 Intrinsic::ID ID = getVectorIntrinsicIDForCall(CI, TLI); 4584 4585 auto VecCallCosts = getVectorCallCosts(CI, VecTy, TTI, TLI); 4586 bool UseIntrinsic = ID != Intrinsic::not_intrinsic && 4587 VecCallCosts.first <= VecCallCosts.second; 4588 4589 Value *ScalarArg = nullptr; 4590 std::vector<Value *> OpVecs; 4591 for (int j = 0, e = CI->getNumArgOperands(); j < e; ++j) { 4592 ValueList OpVL; 4593 // Some intrinsics have scalar arguments. This argument should not be 4594 // vectorized. 4595 if (UseIntrinsic && hasVectorInstrinsicScalarOpd(IID, j)) { 4596 CallInst *CEI = cast<CallInst>(VL0); 4597 ScalarArg = CEI->getArgOperand(j); 4598 OpVecs.push_back(CEI->getArgOperand(j)); 4599 continue; 4600 } 4601 4602 Value *OpVec = vectorizeTree(E->getOperand(j)); 4603 LLVM_DEBUG(dbgs() << "SLP: OpVec[" << j << "]: " << *OpVec << "\n"); 4604 OpVecs.push_back(OpVec); 4605 } 4606 4607 Function *CF; 4608 if (!UseIntrinsic) { 4609 VFShape Shape = 4610 VFShape::get(*CI, ElementCount::getFixed(static_cast<unsigned>( 4611 VecTy->getNumElements())), 4612 false /*HasGlobalPred*/); 4613 CF = VFDatabase(*CI).getVectorizedFunction(Shape); 4614 } else { 4615 Type *Tys[] = {FixedVectorType::get(CI->getType(), E->Scalars.size())}; 4616 CF = Intrinsic::getDeclaration(F->getParent(), ID, Tys); 4617 } 4618 4619 SmallVector<OperandBundleDef, 1> OpBundles; 4620 CI->getOperandBundlesAsDefs(OpBundles); 4621 Value *V = Builder.CreateCall(CF, OpVecs, OpBundles); 4622 4623 // The scalar argument uses an in-tree scalar so we add the new vectorized 4624 // call to ExternalUses list to make sure that an extract will be 4625 // generated in the future. 4626 if (ScalarArg && getTreeEntry(ScalarArg)) 4627 ExternalUses.push_back(ExternalUser(ScalarArg, cast<User>(V), 0)); 4628 4629 propagateIRFlags(V, E->Scalars, VL0); 4630 if (NeedToShuffleReuses) 4631 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4632 4633 E->VectorizedValue = V; 4634 ++NumVectorInstructions; 4635 return V; 4636 } 4637 case Instruction::ShuffleVector: { 4638 assert(E->isAltShuffle() && 4639 ((Instruction::isBinaryOp(E->getOpcode()) && 4640 Instruction::isBinaryOp(E->getAltOpcode())) || 4641 (Instruction::isCast(E->getOpcode()) && 4642 Instruction::isCast(E->getAltOpcode()))) && 4643 "Invalid Shuffle Vector Operand"); 4644 4645 Value *LHS = nullptr, *RHS = nullptr; 4646 if (Instruction::isBinaryOp(E->getOpcode())) { 4647 setInsertPointAfterBundle(E); 4648 LHS = vectorizeTree(E->getOperand(0)); 4649 RHS = vectorizeTree(E->getOperand(1)); 4650 } else { 4651 setInsertPointAfterBundle(E); 4652 LHS = vectorizeTree(E->getOperand(0)); 4653 } 4654 4655 if (E->VectorizedValue) { 4656 LLVM_DEBUG(dbgs() << "SLP: Diamond merged for " << *VL0 << ".\n"); 4657 return E->VectorizedValue; 4658 } 4659 4660 Value *V0, *V1; 4661 if (Instruction::isBinaryOp(E->getOpcode())) { 4662 V0 = Builder.CreateBinOp( 4663 static_cast<Instruction::BinaryOps>(E->getOpcode()), LHS, RHS); 4664 V1 = Builder.CreateBinOp( 4665 static_cast<Instruction::BinaryOps>(E->getAltOpcode()), LHS, RHS); 4666 } else { 4667 V0 = Builder.CreateCast( 4668 static_cast<Instruction::CastOps>(E->getOpcode()), LHS, VecTy); 4669 V1 = Builder.CreateCast( 4670 static_cast<Instruction::CastOps>(E->getAltOpcode()), LHS, VecTy); 4671 } 4672 4673 // Create shuffle to take alternate operations from the vector. 4674 // Also, gather up main and alt scalar ops to propagate IR flags to 4675 // each vector operation. 4676 ValueList OpScalars, AltScalars; 4677 unsigned e = E->Scalars.size(); 4678 SmallVector<int, 8> Mask(e); 4679 for (unsigned i = 0; i < e; ++i) { 4680 auto *OpInst = cast<Instruction>(E->Scalars[i]); 4681 assert(E->isOpcodeOrAlt(OpInst) && "Unexpected main/alternate opcode"); 4682 if (OpInst->getOpcode() == E->getAltOpcode()) { 4683 Mask[i] = e + i; 4684 AltScalars.push_back(E->Scalars[i]); 4685 } else { 4686 Mask[i] = i; 4687 OpScalars.push_back(E->Scalars[i]); 4688 } 4689 } 4690 4691 propagateIRFlags(V0, OpScalars); 4692 propagateIRFlags(V1, AltScalars); 4693 4694 Value *V = Builder.CreateShuffleVector(V0, V1, Mask); 4695 if (Instruction *I = dyn_cast<Instruction>(V)) 4696 V = propagateMetadata(I, E->Scalars); 4697 if (NeedToShuffleReuses) 4698 V = Builder.CreateShuffleVector(V, E->ReuseShuffleIndices, "shuffle"); 4699 4700 E->VectorizedValue = V; 4701 ++NumVectorInstructions; 4702 4703 return V; 4704 } 4705 default: 4706 llvm_unreachable("unknown inst"); 4707 } 4708 return nullptr; 4709 } 4710 4711 Value *BoUpSLP::vectorizeTree() { 4712 ExtraValueToDebugLocsMap ExternallyUsedValues; 4713 return vectorizeTree(ExternallyUsedValues); 4714 } 4715 4716 Value * 4717 BoUpSLP::vectorizeTree(ExtraValueToDebugLocsMap &ExternallyUsedValues) { 4718 // All blocks must be scheduled before any instructions are inserted. 4719 for (auto &BSIter : BlocksSchedules) { 4720 scheduleBlock(BSIter.second.get()); 4721 } 4722 4723 Builder.SetInsertPoint(&F->getEntryBlock().front()); 4724 auto *VectorRoot = vectorizeTree(VectorizableTree[0].get()); 4725 4726 // If the vectorized tree can be rewritten in a smaller type, we truncate the 4727 // vectorized root. InstCombine will then rewrite the entire expression. We 4728 // sign extend the extracted values below. 4729 auto *ScalarRoot = VectorizableTree[0]->Scalars[0]; 4730 if (MinBWs.count(ScalarRoot)) { 4731 if (auto *I = dyn_cast<Instruction>(VectorRoot)) 4732 Builder.SetInsertPoint(&*++BasicBlock::iterator(I)); 4733 auto BundleWidth = VectorizableTree[0]->Scalars.size(); 4734 auto *MinTy = IntegerType::get(F->getContext(), MinBWs[ScalarRoot].first); 4735 auto *VecTy = FixedVectorType::get(MinTy, BundleWidth); 4736 auto *Trunc = Builder.CreateTrunc(VectorRoot, VecTy); 4737 VectorizableTree[0]->VectorizedValue = Trunc; 4738 } 4739 4740 LLVM_DEBUG(dbgs() << "SLP: Extracting " << ExternalUses.size() 4741 << " values .\n"); 4742 4743 // If necessary, sign-extend or zero-extend ScalarRoot to the larger type 4744 // specified by ScalarType. 4745 auto extend = [&](Value *ScalarRoot, Value *Ex, Type *ScalarType) { 4746 if (!MinBWs.count(ScalarRoot)) 4747 return Ex; 4748 if (MinBWs[ScalarRoot].second) 4749 return Builder.CreateSExt(Ex, ScalarType); 4750 return Builder.CreateZExt(Ex, ScalarType); 4751 }; 4752 4753 // Extract all of the elements with the external uses. 4754 for (const auto &ExternalUse : ExternalUses) { 4755 Value *Scalar = ExternalUse.Scalar; 4756 llvm::User *User = ExternalUse.User; 4757 4758 // Skip users that we already RAUW. This happens when one instruction 4759 // has multiple uses of the same value. 4760 if (User && !is_contained(Scalar->users(), User)) 4761 continue; 4762 TreeEntry *E = getTreeEntry(Scalar); 4763 assert(E && "Invalid scalar"); 4764 assert(E->State == TreeEntry::Vectorize && "Extracting from a gather list"); 4765 4766 Value *Vec = E->VectorizedValue; 4767 assert(Vec && "Can't find vectorizable value"); 4768 4769 Value *Lane = Builder.getInt32(ExternalUse.Lane); 4770 // If User == nullptr, the Scalar is used as extra arg. Generate 4771 // ExtractElement instruction and update the record for this scalar in 4772 // ExternallyUsedValues. 4773 if (!User) { 4774 assert(ExternallyUsedValues.count(Scalar) && 4775 "Scalar with nullptr as an external user must be registered in " 4776 "ExternallyUsedValues map"); 4777 if (auto *VecI = dyn_cast<Instruction>(Vec)) { 4778 Builder.SetInsertPoint(VecI->getParent(), 4779 std::next(VecI->getIterator())); 4780 } else { 4781 Builder.SetInsertPoint(&F->getEntryBlock().front()); 4782 } 4783 Value *Ex = Builder.CreateExtractElement(Vec, Lane); 4784 Ex = extend(ScalarRoot, Ex, Scalar->getType()); 4785 CSEBlocks.insert(cast<Instruction>(Scalar)->getParent()); 4786 auto &Locs = ExternallyUsedValues[Scalar]; 4787 ExternallyUsedValues.insert({Ex, Locs}); 4788 ExternallyUsedValues.erase(Scalar); 4789 // Required to update internally referenced instructions. 4790 Scalar->replaceAllUsesWith(Ex); 4791 continue; 4792 } 4793 4794 // Generate extracts for out-of-tree users. 4795 // Find the insertion point for the extractelement lane. 4796 if (auto *VecI = dyn_cast<Instruction>(Vec)) { 4797 if (PHINode *PH = dyn_cast<PHINode>(User)) { 4798 for (int i = 0, e = PH->getNumIncomingValues(); i != e; ++i) { 4799 if (PH->getIncomingValue(i) == Scalar) { 4800 Instruction *IncomingTerminator = 4801 PH->getIncomingBlock(i)->getTerminator(); 4802 if (isa<CatchSwitchInst>(IncomingTerminator)) { 4803 Builder.SetInsertPoint(VecI->getParent(), 4804 std::next(VecI->getIterator())); 4805 } else { 4806 Builder.SetInsertPoint(PH->getIncomingBlock(i)->getTerminator()); 4807 } 4808 Value *Ex = Builder.CreateExtractElement(Vec, Lane); 4809 Ex = extend(ScalarRoot, Ex, Scalar->getType()); 4810 CSEBlocks.insert(PH->getIncomingBlock(i)); 4811 PH->setOperand(i, Ex); 4812 } 4813 } 4814 } else { 4815 Builder.SetInsertPoint(cast<Instruction>(User)); 4816 Value *Ex = Builder.CreateExtractElement(Vec, Lane); 4817 Ex = extend(ScalarRoot, Ex, Scalar->getType()); 4818 CSEBlocks.insert(cast<Instruction>(User)->getParent()); 4819 User->replaceUsesOfWith(Scalar, Ex); 4820 } 4821 } else { 4822 Builder.SetInsertPoint(&F->getEntryBlock().front()); 4823 Value *Ex = Builder.CreateExtractElement(Vec, Lane); 4824 Ex = extend(ScalarRoot, Ex, Scalar->getType()); 4825 CSEBlocks.insert(&F->getEntryBlock()); 4826 User->replaceUsesOfWith(Scalar, Ex); 4827 } 4828 4829 LLVM_DEBUG(dbgs() << "SLP: Replaced:" << *User << ".\n"); 4830 } 4831 4832 // For each vectorized value: 4833 for (auto &TEPtr : VectorizableTree) { 4834 TreeEntry *Entry = TEPtr.get(); 4835 4836 // No need to handle users of gathered values. 4837 if (Entry->State == TreeEntry::NeedToGather) 4838 continue; 4839 4840 assert(Entry->VectorizedValue && "Can't find vectorizable value"); 4841 4842 // For each lane: 4843 for (int Lane = 0, LE = Entry->Scalars.size(); Lane != LE; ++Lane) { 4844 Value *Scalar = Entry->Scalars[Lane]; 4845 4846 #ifndef NDEBUG 4847 Type *Ty = Scalar->getType(); 4848 if (!Ty->isVoidTy()) { 4849 for (User *U : Scalar->users()) { 4850 LLVM_DEBUG(dbgs() << "SLP: \tvalidating user:" << *U << ".\n"); 4851 4852 // It is legal to delete users in the ignorelist. 4853 assert((getTreeEntry(U) || is_contained(UserIgnoreList, U)) && 4854 "Deleting out-of-tree value"); 4855 } 4856 } 4857 #endif 4858 LLVM_DEBUG(dbgs() << "SLP: \tErasing scalar:" << *Scalar << ".\n"); 4859 eraseInstruction(cast<Instruction>(Scalar)); 4860 } 4861 } 4862 4863 Builder.ClearInsertionPoint(); 4864 InstrElementSize.clear(); 4865 4866 return VectorizableTree[0]->VectorizedValue; 4867 } 4868 4869 void BoUpSLP::optimizeGatherSequence() { 4870 LLVM_DEBUG(dbgs() << "SLP: Optimizing " << GatherSeq.size() 4871 << " gather sequences instructions.\n"); 4872 // LICM InsertElementInst sequences. 4873 for (Instruction *I : GatherSeq) { 4874 if (isDeleted(I)) 4875 continue; 4876 4877 // Check if this block is inside a loop. 4878 Loop *L = LI->getLoopFor(I->getParent()); 4879 if (!L) 4880 continue; 4881 4882 // Check if it has a preheader. 4883 BasicBlock *PreHeader = L->getLoopPreheader(); 4884 if (!PreHeader) 4885 continue; 4886 4887 // If the vector or the element that we insert into it are 4888 // instructions that are defined in this basic block then we can't 4889 // hoist this instruction. 4890 auto *Op0 = dyn_cast<Instruction>(I->getOperand(0)); 4891 auto *Op1 = dyn_cast<Instruction>(I->getOperand(1)); 4892 if (Op0 && L->contains(Op0)) 4893 continue; 4894 if (Op1 && L->contains(Op1)) 4895 continue; 4896 4897 // We can hoist this instruction. Move it to the pre-header. 4898 I->moveBefore(PreHeader->getTerminator()); 4899 } 4900 4901 // Make a list of all reachable blocks in our CSE queue. 4902 SmallVector<const DomTreeNode *, 8> CSEWorkList; 4903 CSEWorkList.reserve(CSEBlocks.size()); 4904 for (BasicBlock *BB : CSEBlocks) 4905 if (DomTreeNode *N = DT->getNode(BB)) { 4906 assert(DT->isReachableFromEntry(N)); 4907 CSEWorkList.push_back(N); 4908 } 4909 4910 // Sort blocks by domination. This ensures we visit a block after all blocks 4911 // dominating it are visited. 4912 llvm::stable_sort(CSEWorkList, 4913 [this](const DomTreeNode *A, const DomTreeNode *B) { 4914 return DT->properlyDominates(A, B); 4915 }); 4916 4917 // Perform O(N^2) search over the gather sequences and merge identical 4918 // instructions. TODO: We can further optimize this scan if we split the 4919 // instructions into different buckets based on the insert lane. 4920 SmallVector<Instruction *, 16> Visited; 4921 for (auto I = CSEWorkList.begin(), E = CSEWorkList.end(); I != E; ++I) { 4922 assert(*I && 4923 (I == CSEWorkList.begin() || !DT->dominates(*I, *std::prev(I))) && 4924 "Worklist not sorted properly!"); 4925 BasicBlock *BB = (*I)->getBlock(); 4926 // For all instructions in blocks containing gather sequences: 4927 for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e;) { 4928 Instruction *In = &*it++; 4929 if (isDeleted(In)) 4930 continue; 4931 if (!isa<InsertElementInst>(In) && !isa<ExtractElementInst>(In)) 4932 continue; 4933 4934 // Check if we can replace this instruction with any of the 4935 // visited instructions. 4936 for (Instruction *v : Visited) { 4937 if (In->isIdenticalTo(v) && 4938 DT->dominates(v->getParent(), In->getParent())) { 4939 In->replaceAllUsesWith(v); 4940 eraseInstruction(In); 4941 In = nullptr; 4942 break; 4943 } 4944 } 4945 if (In) { 4946 assert(!is_contained(Visited, In)); 4947 Visited.push_back(In); 4948 } 4949 } 4950 } 4951 CSEBlocks.clear(); 4952 GatherSeq.clear(); 4953 } 4954 4955 // Groups the instructions to a bundle (which is then a single scheduling entity) 4956 // and schedules instructions until the bundle gets ready. 4957 Optional<BoUpSLP::ScheduleData *> 4958 BoUpSLP::BlockScheduling::tryScheduleBundle(ArrayRef<Value *> VL, BoUpSLP *SLP, 4959 const InstructionsState &S) { 4960 if (isa<PHINode>(S.OpValue)) 4961 return nullptr; 4962 4963 // Initialize the instruction bundle. 4964 Instruction *OldScheduleEnd = ScheduleEnd; 4965 ScheduleData *PrevInBundle = nullptr; 4966 ScheduleData *Bundle = nullptr; 4967 bool ReSchedule = false; 4968 LLVM_DEBUG(dbgs() << "SLP: bundle: " << *S.OpValue << "\n"); 4969 4970 // Make sure that the scheduling region contains all 4971 // instructions of the bundle. 4972 for (Value *V : VL) { 4973 if (!extendSchedulingRegion(V, S)) 4974 return None; 4975 } 4976 4977 for (Value *V : VL) { 4978 ScheduleData *BundleMember = getScheduleData(V); 4979 assert(BundleMember && 4980 "no ScheduleData for bundle member (maybe not in same basic block)"); 4981 if (BundleMember->IsScheduled) { 4982 // A bundle member was scheduled as single instruction before and now 4983 // needs to be scheduled as part of the bundle. We just get rid of the 4984 // existing schedule. 4985 LLVM_DEBUG(dbgs() << "SLP: reset schedule because " << *BundleMember 4986 << " was already scheduled\n"); 4987 ReSchedule = true; 4988 } 4989 assert(BundleMember->isSchedulingEntity() && 4990 "bundle member already part of other bundle"); 4991 if (PrevInBundle) { 4992 PrevInBundle->NextInBundle = BundleMember; 4993 } else { 4994 Bundle = BundleMember; 4995 } 4996 BundleMember->UnscheduledDepsInBundle = 0; 4997 Bundle->UnscheduledDepsInBundle += BundleMember->UnscheduledDeps; 4998 4999 // Group the instructions to a bundle. 5000 BundleMember->FirstInBundle = Bundle; 5001 PrevInBundle = BundleMember; 5002 } 5003 if (ScheduleEnd != OldScheduleEnd) { 5004 // The scheduling region got new instructions at the lower end (or it is a 5005 // new region for the first bundle). This makes it necessary to 5006 // recalculate all dependencies. 5007 // It is seldom that this needs to be done a second time after adding the 5008 // initial bundle to the region. 5009 for (auto *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 5010 doForAllOpcodes(I, [](ScheduleData *SD) { 5011 SD->clearDependencies(); 5012 }); 5013 } 5014 ReSchedule = true; 5015 } 5016 if (ReSchedule) { 5017 resetSchedule(); 5018 initialFillReadyList(ReadyInsts); 5019 } 5020 assert(Bundle && "Failed to find schedule bundle"); 5021 5022 LLVM_DEBUG(dbgs() << "SLP: try schedule bundle " << *Bundle << " in block " 5023 << BB->getName() << "\n"); 5024 5025 calculateDependencies(Bundle, true, SLP); 5026 5027 // Now try to schedule the new bundle. As soon as the bundle is "ready" it 5028 // means that there are no cyclic dependencies and we can schedule it. 5029 // Note that's important that we don't "schedule" the bundle yet (see 5030 // cancelScheduling). 5031 while (!Bundle->isReady() && !ReadyInsts.empty()) { 5032 5033 ScheduleData *pickedSD = ReadyInsts.back(); 5034 ReadyInsts.pop_back(); 5035 5036 if (pickedSD->isSchedulingEntity() && pickedSD->isReady()) { 5037 schedule(pickedSD, ReadyInsts); 5038 } 5039 } 5040 if (!Bundle->isReady()) { 5041 cancelScheduling(VL, S.OpValue); 5042 return None; 5043 } 5044 return Bundle; 5045 } 5046 5047 void BoUpSLP::BlockScheduling::cancelScheduling(ArrayRef<Value *> VL, 5048 Value *OpValue) { 5049 if (isa<PHINode>(OpValue)) 5050 return; 5051 5052 ScheduleData *Bundle = getScheduleData(OpValue); 5053 LLVM_DEBUG(dbgs() << "SLP: cancel scheduling of " << *Bundle << "\n"); 5054 assert(!Bundle->IsScheduled && 5055 "Can't cancel bundle which is already scheduled"); 5056 assert(Bundle->isSchedulingEntity() && Bundle->isPartOfBundle() && 5057 "tried to unbundle something which is not a bundle"); 5058 5059 // Un-bundle: make single instructions out of the bundle. 5060 ScheduleData *BundleMember = Bundle; 5061 while (BundleMember) { 5062 assert(BundleMember->FirstInBundle == Bundle && "corrupt bundle links"); 5063 BundleMember->FirstInBundle = BundleMember; 5064 ScheduleData *Next = BundleMember->NextInBundle; 5065 BundleMember->NextInBundle = nullptr; 5066 BundleMember->UnscheduledDepsInBundle = BundleMember->UnscheduledDeps; 5067 if (BundleMember->UnscheduledDepsInBundle == 0) { 5068 ReadyInsts.insert(BundleMember); 5069 } 5070 BundleMember = Next; 5071 } 5072 } 5073 5074 BoUpSLP::ScheduleData *BoUpSLP::BlockScheduling::allocateScheduleDataChunks() { 5075 // Allocate a new ScheduleData for the instruction. 5076 if (ChunkPos >= ChunkSize) { 5077 ScheduleDataChunks.push_back(std::make_unique<ScheduleData[]>(ChunkSize)); 5078 ChunkPos = 0; 5079 } 5080 return &(ScheduleDataChunks.back()[ChunkPos++]); 5081 } 5082 5083 bool BoUpSLP::BlockScheduling::extendSchedulingRegion(Value *V, 5084 const InstructionsState &S) { 5085 if (getScheduleData(V, isOneOf(S, V))) 5086 return true; 5087 Instruction *I = dyn_cast<Instruction>(V); 5088 assert(I && "bundle member must be an instruction"); 5089 assert(!isa<PHINode>(I) && "phi nodes don't need to be scheduled"); 5090 auto &&CheckSheduleForI = [this, &S](Instruction *I) -> bool { 5091 ScheduleData *ISD = getScheduleData(I); 5092 if (!ISD) 5093 return false; 5094 assert(isInSchedulingRegion(ISD) && 5095 "ScheduleData not in scheduling region"); 5096 ScheduleData *SD = allocateScheduleDataChunks(); 5097 SD->Inst = I; 5098 SD->init(SchedulingRegionID, S.OpValue); 5099 ExtraScheduleDataMap[I][S.OpValue] = SD; 5100 return true; 5101 }; 5102 if (CheckSheduleForI(I)) 5103 return true; 5104 if (!ScheduleStart) { 5105 // It's the first instruction in the new region. 5106 initScheduleData(I, I->getNextNode(), nullptr, nullptr); 5107 ScheduleStart = I; 5108 ScheduleEnd = I->getNextNode(); 5109 if (isOneOf(S, I) != I) 5110 CheckSheduleForI(I); 5111 assert(ScheduleEnd && "tried to vectorize a terminator?"); 5112 LLVM_DEBUG(dbgs() << "SLP: initialize schedule region to " << *I << "\n"); 5113 return true; 5114 } 5115 // Search up and down at the same time, because we don't know if the new 5116 // instruction is above or below the existing scheduling region. 5117 BasicBlock::reverse_iterator UpIter = 5118 ++ScheduleStart->getIterator().getReverse(); 5119 BasicBlock::reverse_iterator UpperEnd = BB->rend(); 5120 BasicBlock::iterator DownIter = ScheduleEnd->getIterator(); 5121 BasicBlock::iterator LowerEnd = BB->end(); 5122 while (true) { 5123 if (++ScheduleRegionSize > ScheduleRegionSizeLimit) { 5124 LLVM_DEBUG(dbgs() << "SLP: exceeded schedule region size limit\n"); 5125 return false; 5126 } 5127 5128 if (UpIter != UpperEnd) { 5129 if (&*UpIter == I) { 5130 initScheduleData(I, ScheduleStart, nullptr, FirstLoadStoreInRegion); 5131 ScheduleStart = I; 5132 if (isOneOf(S, I) != I) 5133 CheckSheduleForI(I); 5134 LLVM_DEBUG(dbgs() << "SLP: extend schedule region start to " << *I 5135 << "\n"); 5136 return true; 5137 } 5138 ++UpIter; 5139 } 5140 if (DownIter != LowerEnd) { 5141 if (&*DownIter == I) { 5142 initScheduleData(ScheduleEnd, I->getNextNode(), LastLoadStoreInRegion, 5143 nullptr); 5144 ScheduleEnd = I->getNextNode(); 5145 if (isOneOf(S, I) != I) 5146 CheckSheduleForI(I); 5147 assert(ScheduleEnd && "tried to vectorize a terminator?"); 5148 LLVM_DEBUG(dbgs() << "SLP: extend schedule region end to " << *I 5149 << "\n"); 5150 return true; 5151 } 5152 ++DownIter; 5153 } 5154 assert((UpIter != UpperEnd || DownIter != LowerEnd) && 5155 "instruction not found in block"); 5156 } 5157 return true; 5158 } 5159 5160 void BoUpSLP::BlockScheduling::initScheduleData(Instruction *FromI, 5161 Instruction *ToI, 5162 ScheduleData *PrevLoadStore, 5163 ScheduleData *NextLoadStore) { 5164 ScheduleData *CurrentLoadStore = PrevLoadStore; 5165 for (Instruction *I = FromI; I != ToI; I = I->getNextNode()) { 5166 ScheduleData *SD = ScheduleDataMap[I]; 5167 if (!SD) { 5168 SD = allocateScheduleDataChunks(); 5169 ScheduleDataMap[I] = SD; 5170 SD->Inst = I; 5171 } 5172 assert(!isInSchedulingRegion(SD) && 5173 "new ScheduleData already in scheduling region"); 5174 SD->init(SchedulingRegionID, I); 5175 5176 if (I->mayReadOrWriteMemory() && 5177 (!isa<IntrinsicInst>(I) || 5178 cast<IntrinsicInst>(I)->getIntrinsicID() != Intrinsic::sideeffect)) { 5179 // Update the linked list of memory accessing instructions. 5180 if (CurrentLoadStore) { 5181 CurrentLoadStore->NextLoadStore = SD; 5182 } else { 5183 FirstLoadStoreInRegion = SD; 5184 } 5185 CurrentLoadStore = SD; 5186 } 5187 } 5188 if (NextLoadStore) { 5189 if (CurrentLoadStore) 5190 CurrentLoadStore->NextLoadStore = NextLoadStore; 5191 } else { 5192 LastLoadStoreInRegion = CurrentLoadStore; 5193 } 5194 } 5195 5196 void BoUpSLP::BlockScheduling::calculateDependencies(ScheduleData *SD, 5197 bool InsertInReadyList, 5198 BoUpSLP *SLP) { 5199 assert(SD->isSchedulingEntity()); 5200 5201 SmallVector<ScheduleData *, 10> WorkList; 5202 WorkList.push_back(SD); 5203 5204 while (!WorkList.empty()) { 5205 ScheduleData *SD = WorkList.back(); 5206 WorkList.pop_back(); 5207 5208 ScheduleData *BundleMember = SD; 5209 while (BundleMember) { 5210 assert(isInSchedulingRegion(BundleMember)); 5211 if (!BundleMember->hasValidDependencies()) { 5212 5213 LLVM_DEBUG(dbgs() << "SLP: update deps of " << *BundleMember 5214 << "\n"); 5215 BundleMember->Dependencies = 0; 5216 BundleMember->resetUnscheduledDeps(); 5217 5218 // Handle def-use chain dependencies. 5219 if (BundleMember->OpValue != BundleMember->Inst) { 5220 ScheduleData *UseSD = getScheduleData(BundleMember->Inst); 5221 if (UseSD && isInSchedulingRegion(UseSD->FirstInBundle)) { 5222 BundleMember->Dependencies++; 5223 ScheduleData *DestBundle = UseSD->FirstInBundle; 5224 if (!DestBundle->IsScheduled) 5225 BundleMember->incrementUnscheduledDeps(1); 5226 if (!DestBundle->hasValidDependencies()) 5227 WorkList.push_back(DestBundle); 5228 } 5229 } else { 5230 for (User *U : BundleMember->Inst->users()) { 5231 if (isa<Instruction>(U)) { 5232 ScheduleData *UseSD = getScheduleData(U); 5233 if (UseSD && isInSchedulingRegion(UseSD->FirstInBundle)) { 5234 BundleMember->Dependencies++; 5235 ScheduleData *DestBundle = UseSD->FirstInBundle; 5236 if (!DestBundle->IsScheduled) 5237 BundleMember->incrementUnscheduledDeps(1); 5238 if (!DestBundle->hasValidDependencies()) 5239 WorkList.push_back(DestBundle); 5240 } 5241 } else { 5242 // I'm not sure if this can ever happen. But we need to be safe. 5243 // This lets the instruction/bundle never be scheduled and 5244 // eventually disable vectorization. 5245 BundleMember->Dependencies++; 5246 BundleMember->incrementUnscheduledDeps(1); 5247 } 5248 } 5249 } 5250 5251 // Handle the memory dependencies. 5252 ScheduleData *DepDest = BundleMember->NextLoadStore; 5253 if (DepDest) { 5254 Instruction *SrcInst = BundleMember->Inst; 5255 MemoryLocation SrcLoc = getLocation(SrcInst, SLP->AA); 5256 bool SrcMayWrite = BundleMember->Inst->mayWriteToMemory(); 5257 unsigned numAliased = 0; 5258 unsigned DistToSrc = 1; 5259 5260 while (DepDest) { 5261 assert(isInSchedulingRegion(DepDest)); 5262 5263 // We have two limits to reduce the complexity: 5264 // 1) AliasedCheckLimit: It's a small limit to reduce calls to 5265 // SLP->isAliased (which is the expensive part in this loop). 5266 // 2) MaxMemDepDistance: It's for very large blocks and it aborts 5267 // the whole loop (even if the loop is fast, it's quadratic). 5268 // It's important for the loop break condition (see below) to 5269 // check this limit even between two read-only instructions. 5270 if (DistToSrc >= MaxMemDepDistance || 5271 ((SrcMayWrite || DepDest->Inst->mayWriteToMemory()) && 5272 (numAliased >= AliasedCheckLimit || 5273 SLP->isAliased(SrcLoc, SrcInst, DepDest->Inst)))) { 5274 5275 // We increment the counter only if the locations are aliased 5276 // (instead of counting all alias checks). This gives a better 5277 // balance between reduced runtime and accurate dependencies. 5278 numAliased++; 5279 5280 DepDest->MemoryDependencies.push_back(BundleMember); 5281 BundleMember->Dependencies++; 5282 ScheduleData *DestBundle = DepDest->FirstInBundle; 5283 if (!DestBundle->IsScheduled) { 5284 BundleMember->incrementUnscheduledDeps(1); 5285 } 5286 if (!DestBundle->hasValidDependencies()) { 5287 WorkList.push_back(DestBundle); 5288 } 5289 } 5290 DepDest = DepDest->NextLoadStore; 5291 5292 // Example, explaining the loop break condition: Let's assume our 5293 // starting instruction is i0 and MaxMemDepDistance = 3. 5294 // 5295 // +--------v--v--v 5296 // i0,i1,i2,i3,i4,i5,i6,i7,i8 5297 // +--------^--^--^ 5298 // 5299 // MaxMemDepDistance let us stop alias-checking at i3 and we add 5300 // dependencies from i0 to i3,i4,.. (even if they are not aliased). 5301 // Previously we already added dependencies from i3 to i6,i7,i8 5302 // (because of MaxMemDepDistance). As we added a dependency from 5303 // i0 to i3, we have transitive dependencies from i0 to i6,i7,i8 5304 // and we can abort this loop at i6. 5305 if (DistToSrc >= 2 * MaxMemDepDistance) 5306 break; 5307 DistToSrc++; 5308 } 5309 } 5310 } 5311 BundleMember = BundleMember->NextInBundle; 5312 } 5313 if (InsertInReadyList && SD->isReady()) { 5314 ReadyInsts.push_back(SD); 5315 LLVM_DEBUG(dbgs() << "SLP: gets ready on update: " << *SD->Inst 5316 << "\n"); 5317 } 5318 } 5319 } 5320 5321 void BoUpSLP::BlockScheduling::resetSchedule() { 5322 assert(ScheduleStart && 5323 "tried to reset schedule on block which has not been scheduled"); 5324 for (Instruction *I = ScheduleStart; I != ScheduleEnd; I = I->getNextNode()) { 5325 doForAllOpcodes(I, [&](ScheduleData *SD) { 5326 assert(isInSchedulingRegion(SD) && 5327 "ScheduleData not in scheduling region"); 5328 SD->IsScheduled = false; 5329 SD->resetUnscheduledDeps(); 5330 }); 5331 } 5332 ReadyInsts.clear(); 5333 } 5334 5335 void BoUpSLP::scheduleBlock(BlockScheduling *BS) { 5336 if (!BS->ScheduleStart) 5337 return; 5338 5339 LLVM_DEBUG(dbgs() << "SLP: schedule block " << BS->BB->getName() << "\n"); 5340 5341 BS->resetSchedule(); 5342 5343 // For the real scheduling we use a more sophisticated ready-list: it is 5344 // sorted by the original instruction location. This lets the final schedule 5345 // be as close as possible to the original instruction order. 5346 struct ScheduleDataCompare { 5347 bool operator()(ScheduleData *SD1, ScheduleData *SD2) const { 5348 return SD2->SchedulingPriority < SD1->SchedulingPriority; 5349 } 5350 }; 5351 std::set<ScheduleData *, ScheduleDataCompare> ReadyInsts; 5352 5353 // Ensure that all dependency data is updated and fill the ready-list with 5354 // initial instructions. 5355 int Idx = 0; 5356 int NumToSchedule = 0; 5357 for (auto *I = BS->ScheduleStart; I != BS->ScheduleEnd; 5358 I = I->getNextNode()) { 5359 BS->doForAllOpcodes(I, [this, &Idx, &NumToSchedule, BS](ScheduleData *SD) { 5360 assert(SD->isPartOfBundle() == 5361 (getTreeEntry(SD->Inst) != nullptr) && 5362 "scheduler and vectorizer bundle mismatch"); 5363 SD->FirstInBundle->SchedulingPriority = Idx++; 5364 if (SD->isSchedulingEntity()) { 5365 BS->calculateDependencies(SD, false, this); 5366 NumToSchedule++; 5367 } 5368 }); 5369 } 5370 BS->initialFillReadyList(ReadyInsts); 5371 5372 Instruction *LastScheduledInst = BS->ScheduleEnd; 5373 5374 // Do the "real" scheduling. 5375 while (!ReadyInsts.empty()) { 5376 ScheduleData *picked = *ReadyInsts.begin(); 5377 ReadyInsts.erase(ReadyInsts.begin()); 5378 5379 // Move the scheduled instruction(s) to their dedicated places, if not 5380 // there yet. 5381 ScheduleData *BundleMember = picked; 5382 while (BundleMember) { 5383 Instruction *pickedInst = BundleMember->Inst; 5384 if (LastScheduledInst->getNextNode() != pickedInst) { 5385 BS->BB->getInstList().remove(pickedInst); 5386 BS->BB->getInstList().insert(LastScheduledInst->getIterator(), 5387 pickedInst); 5388 } 5389 LastScheduledInst = pickedInst; 5390 BundleMember = BundleMember->NextInBundle; 5391 } 5392 5393 BS->schedule(picked, ReadyInsts); 5394 NumToSchedule--; 5395 } 5396 assert(NumToSchedule == 0 && "could not schedule all instructions"); 5397 5398 // Avoid duplicate scheduling of the block. 5399 BS->ScheduleStart = nullptr; 5400 } 5401 5402 unsigned BoUpSLP::getVectorElementSize(Value *V) { 5403 // If V is a store, just return the width of the stored value without 5404 // traversing the expression tree. This is the common case. 5405 if (auto *Store = dyn_cast<StoreInst>(V)) 5406 return DL->getTypeSizeInBits(Store->getValueOperand()->getType()); 5407 5408 auto E = InstrElementSize.find(V); 5409 if (E != InstrElementSize.end()) 5410 return E->second; 5411 5412 // If V is not a store, we can traverse the expression tree to find loads 5413 // that feed it. The type of the loaded value may indicate a more suitable 5414 // width than V's type. We want to base the vector element size on the width 5415 // of memory operations where possible. 5416 SmallVector<Instruction *, 16> Worklist; 5417 SmallPtrSet<Instruction *, 16> Visited; 5418 if (auto *I = dyn_cast<Instruction>(V)) { 5419 Worklist.push_back(I); 5420 Visited.insert(I); 5421 } 5422 5423 // Traverse the expression tree in bottom-up order looking for loads. If we 5424 // encounter an instruction we don't yet handle, we give up. 5425 auto MaxWidth = 0u; 5426 auto FoundUnknownInst = false; 5427 while (!Worklist.empty() && !FoundUnknownInst) { 5428 auto *I = Worklist.pop_back_val(); 5429 5430 // We should only be looking at scalar instructions here. If the current 5431 // instruction has a vector type, give up. 5432 auto *Ty = I->getType(); 5433 if (isa<VectorType>(Ty)) 5434 FoundUnknownInst = true; 5435 5436 // If the current instruction is a load, update MaxWidth to reflect the 5437 // width of the loaded value. 5438 else if (isa<LoadInst>(I)) 5439 MaxWidth = std::max<unsigned>(MaxWidth, DL->getTypeSizeInBits(Ty)); 5440 5441 // Otherwise, we need to visit the operands of the instruction. We only 5442 // handle the interesting cases from buildTree here. If an operand is an 5443 // instruction we haven't yet visited, we add it to the worklist. 5444 else if (isa<PHINode>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) || 5445 isa<CmpInst>(I) || isa<SelectInst>(I) || isa<BinaryOperator>(I)) { 5446 for (Use &U : I->operands()) 5447 if (auto *J = dyn_cast<Instruction>(U.get())) 5448 if (Visited.insert(J).second) 5449 Worklist.push_back(J); 5450 } 5451 5452 // If we don't yet handle the instruction, give up. 5453 else 5454 FoundUnknownInst = true; 5455 } 5456 5457 int Width = MaxWidth; 5458 // If we didn't encounter a memory access in the expression tree, or if we 5459 // gave up for some reason, just return the width of V. Otherwise, return the 5460 // maximum width we found. 5461 if (!MaxWidth || FoundUnknownInst) 5462 Width = DL->getTypeSizeInBits(V->getType()); 5463 5464 for (Instruction *I : Visited) 5465 InstrElementSize[I] = Width; 5466 5467 return Width; 5468 } 5469 5470 // Determine if a value V in a vectorizable expression Expr can be demoted to a 5471 // smaller type with a truncation. We collect the values that will be demoted 5472 // in ToDemote and additional roots that require investigating in Roots. 5473 static bool collectValuesToDemote(Value *V, SmallPtrSetImpl<Value *> &Expr, 5474 SmallVectorImpl<Value *> &ToDemote, 5475 SmallVectorImpl<Value *> &Roots) { 5476 // We can always demote constants. 5477 if (isa<Constant>(V)) { 5478 ToDemote.push_back(V); 5479 return true; 5480 } 5481 5482 // If the value is not an instruction in the expression with only one use, it 5483 // cannot be demoted. 5484 auto *I = dyn_cast<Instruction>(V); 5485 if (!I || !I->hasOneUse() || !Expr.count(I)) 5486 return false; 5487 5488 switch (I->getOpcode()) { 5489 5490 // We can always demote truncations and extensions. Since truncations can 5491 // seed additional demotion, we save the truncated value. 5492 case Instruction::Trunc: 5493 Roots.push_back(I->getOperand(0)); 5494 break; 5495 case Instruction::ZExt: 5496 case Instruction::SExt: 5497 break; 5498 5499 // We can demote certain binary operations if we can demote both of their 5500 // operands. 5501 case Instruction::Add: 5502 case Instruction::Sub: 5503 case Instruction::Mul: 5504 case Instruction::And: 5505 case Instruction::Or: 5506 case Instruction::Xor: 5507 if (!collectValuesToDemote(I->getOperand(0), Expr, ToDemote, Roots) || 5508 !collectValuesToDemote(I->getOperand(1), Expr, ToDemote, Roots)) 5509 return false; 5510 break; 5511 5512 // We can demote selects if we can demote their true and false values. 5513 case Instruction::Select: { 5514 SelectInst *SI = cast<SelectInst>(I); 5515 if (!collectValuesToDemote(SI->getTrueValue(), Expr, ToDemote, Roots) || 5516 !collectValuesToDemote(SI->getFalseValue(), Expr, ToDemote, Roots)) 5517 return false; 5518 break; 5519 } 5520 5521 // We can demote phis if we can demote all their incoming operands. Note that 5522 // we don't need to worry about cycles since we ensure single use above. 5523 case Instruction::PHI: { 5524 PHINode *PN = cast<PHINode>(I); 5525 for (Value *IncValue : PN->incoming_values()) 5526 if (!collectValuesToDemote(IncValue, Expr, ToDemote, Roots)) 5527 return false; 5528 break; 5529 } 5530 5531 // Otherwise, conservatively give up. 5532 default: 5533 return false; 5534 } 5535 5536 // Record the value that we can demote. 5537 ToDemote.push_back(V); 5538 return true; 5539 } 5540 5541 void BoUpSLP::computeMinimumValueSizes() { 5542 // If there are no external uses, the expression tree must be rooted by a 5543 // store. We can't demote in-memory values, so there is nothing to do here. 5544 if (ExternalUses.empty()) 5545 return; 5546 5547 // We only attempt to truncate integer expressions. 5548 auto &TreeRoot = VectorizableTree[0]->Scalars; 5549 auto *TreeRootIT = dyn_cast<IntegerType>(TreeRoot[0]->getType()); 5550 if (!TreeRootIT) 5551 return; 5552 5553 // If the expression is not rooted by a store, these roots should have 5554 // external uses. We will rely on InstCombine to rewrite the expression in 5555 // the narrower type. However, InstCombine only rewrites single-use values. 5556 // This means that if a tree entry other than a root is used externally, it 5557 // must have multiple uses and InstCombine will not rewrite it. The code 5558 // below ensures that only the roots are used externally. 5559 SmallPtrSet<Value *, 32> Expr(TreeRoot.begin(), TreeRoot.end()); 5560 for (auto &EU : ExternalUses) 5561 if (!Expr.erase(EU.Scalar)) 5562 return; 5563 if (!Expr.empty()) 5564 return; 5565 5566 // Collect the scalar values of the vectorizable expression. We will use this 5567 // context to determine which values can be demoted. If we see a truncation, 5568 // we mark it as seeding another demotion. 5569 for (auto &EntryPtr : VectorizableTree) 5570 Expr.insert(EntryPtr->Scalars.begin(), EntryPtr->Scalars.end()); 5571 5572 // Ensure the roots of the vectorizable tree don't form a cycle. They must 5573 // have a single external user that is not in the vectorizable tree. 5574 for (auto *Root : TreeRoot) 5575 if (!Root->hasOneUse() || Expr.count(*Root->user_begin())) 5576 return; 5577 5578 // Conservatively determine if we can actually truncate the roots of the 5579 // expression. Collect the values that can be demoted in ToDemote and 5580 // additional roots that require investigating in Roots. 5581 SmallVector<Value *, 32> ToDemote; 5582 SmallVector<Value *, 4> Roots; 5583 for (auto *Root : TreeRoot) 5584 if (!collectValuesToDemote(Root, Expr, ToDemote, Roots)) 5585 return; 5586 5587 // The maximum bit width required to represent all the values that can be 5588 // demoted without loss of precision. It would be safe to truncate the roots 5589 // of the expression to this width. 5590 auto MaxBitWidth = 8u; 5591 5592 // We first check if all the bits of the roots are demanded. If they're not, 5593 // we can truncate the roots to this narrower type. 5594 for (auto *Root : TreeRoot) { 5595 auto Mask = DB->getDemandedBits(cast<Instruction>(Root)); 5596 MaxBitWidth = std::max<unsigned>( 5597 Mask.getBitWidth() - Mask.countLeadingZeros(), MaxBitWidth); 5598 } 5599 5600 // True if the roots can be zero-extended back to their original type, rather 5601 // than sign-extended. We know that if the leading bits are not demanded, we 5602 // can safely zero-extend. So we initialize IsKnownPositive to True. 5603 bool IsKnownPositive = true; 5604 5605 // If all the bits of the roots are demanded, we can try a little harder to 5606 // compute a narrower type. This can happen, for example, if the roots are 5607 // getelementptr indices. InstCombine promotes these indices to the pointer 5608 // width. Thus, all their bits are technically demanded even though the 5609 // address computation might be vectorized in a smaller type. 5610 // 5611 // We start by looking at each entry that can be demoted. We compute the 5612 // maximum bit width required to store the scalar by using ValueTracking to 5613 // compute the number of high-order bits we can truncate. 5614 if (MaxBitWidth == DL->getTypeSizeInBits(TreeRoot[0]->getType()) && 5615 llvm::all_of(TreeRoot, [](Value *R) { 5616 assert(R->hasOneUse() && "Root should have only one use!"); 5617 return isa<GetElementPtrInst>(R->user_back()); 5618 })) { 5619 MaxBitWidth = 8u; 5620 5621 // Determine if the sign bit of all the roots is known to be zero. If not, 5622 // IsKnownPositive is set to False. 5623 IsKnownPositive = llvm::all_of(TreeRoot, [&](Value *R) { 5624 KnownBits Known = computeKnownBits(R, *DL); 5625 return Known.isNonNegative(); 5626 }); 5627 5628 // Determine the maximum number of bits required to store the scalar 5629 // values. 5630 for (auto *Scalar : ToDemote) { 5631 auto NumSignBits = ComputeNumSignBits(Scalar, *DL, 0, AC, nullptr, DT); 5632 auto NumTypeBits = DL->getTypeSizeInBits(Scalar->getType()); 5633 MaxBitWidth = std::max<unsigned>(NumTypeBits - NumSignBits, MaxBitWidth); 5634 } 5635 5636 // If we can't prove that the sign bit is zero, we must add one to the 5637 // maximum bit width to account for the unknown sign bit. This preserves 5638 // the existing sign bit so we can safely sign-extend the root back to the 5639 // original type. Otherwise, if we know the sign bit is zero, we will 5640 // zero-extend the root instead. 5641 // 5642 // FIXME: This is somewhat suboptimal, as there will be cases where adding 5643 // one to the maximum bit width will yield a larger-than-necessary 5644 // type. In general, we need to add an extra bit only if we can't 5645 // prove that the upper bit of the original type is equal to the 5646 // upper bit of the proposed smaller type. If these two bits are the 5647 // same (either zero or one) we know that sign-extending from the 5648 // smaller type will result in the same value. Here, since we can't 5649 // yet prove this, we are just making the proposed smaller type 5650 // larger to ensure correctness. 5651 if (!IsKnownPositive) 5652 ++MaxBitWidth; 5653 } 5654 5655 // Round MaxBitWidth up to the next power-of-two. 5656 if (!isPowerOf2_64(MaxBitWidth)) 5657 MaxBitWidth = NextPowerOf2(MaxBitWidth); 5658 5659 // If the maximum bit width we compute is less than the with of the roots' 5660 // type, we can proceed with the narrowing. Otherwise, do nothing. 5661 if (MaxBitWidth >= TreeRootIT->getBitWidth()) 5662 return; 5663 5664 // If we can truncate the root, we must collect additional values that might 5665 // be demoted as a result. That is, those seeded by truncations we will 5666 // modify. 5667 while (!Roots.empty()) 5668 collectValuesToDemote(Roots.pop_back_val(), Expr, ToDemote, Roots); 5669 5670 // Finally, map the values we can demote to the maximum bit with we computed. 5671 for (auto *Scalar : ToDemote) 5672 MinBWs[Scalar] = std::make_pair(MaxBitWidth, !IsKnownPositive); 5673 } 5674 5675 namespace { 5676 5677 /// The SLPVectorizer Pass. 5678 struct SLPVectorizer : public FunctionPass { 5679 SLPVectorizerPass Impl; 5680 5681 /// Pass identification, replacement for typeid 5682 static char ID; 5683 5684 explicit SLPVectorizer() : FunctionPass(ID) { 5685 initializeSLPVectorizerPass(*PassRegistry::getPassRegistry()); 5686 } 5687 5688 bool doInitialization(Module &M) override { 5689 return false; 5690 } 5691 5692 bool runOnFunction(Function &F) override { 5693 if (skipFunction(F)) 5694 return false; 5695 5696 auto *SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE(); 5697 auto *TTI = &getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F); 5698 auto *TLIP = getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>(); 5699 auto *TLI = TLIP ? &TLIP->getTLI(F) : nullptr; 5700 auto *AA = &getAnalysis<AAResultsWrapperPass>().getAAResults(); 5701 auto *LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo(); 5702 auto *DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 5703 auto *AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F); 5704 auto *DB = &getAnalysis<DemandedBitsWrapperPass>().getDemandedBits(); 5705 auto *ORE = &getAnalysis<OptimizationRemarkEmitterWrapperPass>().getORE(); 5706 5707 return Impl.runImpl(F, SE, TTI, TLI, AA, LI, DT, AC, DB, ORE); 5708 } 5709 5710 void getAnalysisUsage(AnalysisUsage &AU) const override { 5711 FunctionPass::getAnalysisUsage(AU); 5712 AU.addRequired<AssumptionCacheTracker>(); 5713 AU.addRequired<ScalarEvolutionWrapperPass>(); 5714 AU.addRequired<AAResultsWrapperPass>(); 5715 AU.addRequired<TargetTransformInfoWrapperPass>(); 5716 AU.addRequired<LoopInfoWrapperPass>(); 5717 AU.addRequired<DominatorTreeWrapperPass>(); 5718 AU.addRequired<DemandedBitsWrapperPass>(); 5719 AU.addRequired<OptimizationRemarkEmitterWrapperPass>(); 5720 AU.addRequired<InjectTLIMappingsLegacy>(); 5721 AU.addPreserved<LoopInfoWrapperPass>(); 5722 AU.addPreserved<DominatorTreeWrapperPass>(); 5723 AU.addPreserved<AAResultsWrapperPass>(); 5724 AU.addPreserved<GlobalsAAWrapperPass>(); 5725 AU.setPreservesCFG(); 5726 } 5727 }; 5728 5729 } // end anonymous namespace 5730 5731 PreservedAnalyses SLPVectorizerPass::run(Function &F, FunctionAnalysisManager &AM) { 5732 auto *SE = &AM.getResult<ScalarEvolutionAnalysis>(F); 5733 auto *TTI = &AM.getResult<TargetIRAnalysis>(F); 5734 auto *TLI = AM.getCachedResult<TargetLibraryAnalysis>(F); 5735 auto *AA = &AM.getResult<AAManager>(F); 5736 auto *LI = &AM.getResult<LoopAnalysis>(F); 5737 auto *DT = &AM.getResult<DominatorTreeAnalysis>(F); 5738 auto *AC = &AM.getResult<AssumptionAnalysis>(F); 5739 auto *DB = &AM.getResult<DemandedBitsAnalysis>(F); 5740 auto *ORE = &AM.getResult<OptimizationRemarkEmitterAnalysis>(F); 5741 5742 bool Changed = runImpl(F, SE, TTI, TLI, AA, LI, DT, AC, DB, ORE); 5743 if (!Changed) 5744 return PreservedAnalyses::all(); 5745 5746 PreservedAnalyses PA; 5747 PA.preserveSet<CFGAnalyses>(); 5748 PA.preserve<AAManager>(); 5749 PA.preserve<GlobalsAA>(); 5750 return PA; 5751 } 5752 5753 bool SLPVectorizerPass::runImpl(Function &F, ScalarEvolution *SE_, 5754 TargetTransformInfo *TTI_, 5755 TargetLibraryInfo *TLI_, AAResults *AA_, 5756 LoopInfo *LI_, DominatorTree *DT_, 5757 AssumptionCache *AC_, DemandedBits *DB_, 5758 OptimizationRemarkEmitter *ORE_) { 5759 if (!RunSLPVectorization) 5760 return false; 5761 SE = SE_; 5762 TTI = TTI_; 5763 TLI = TLI_; 5764 AA = AA_; 5765 LI = LI_; 5766 DT = DT_; 5767 AC = AC_; 5768 DB = DB_; 5769 DL = &F.getParent()->getDataLayout(); 5770 5771 Stores.clear(); 5772 GEPs.clear(); 5773 bool Changed = false; 5774 5775 // If the target claims to have no vector registers don't attempt 5776 // vectorization. 5777 if (!TTI->getNumberOfRegisters(TTI->getRegisterClassForType(true))) 5778 return false; 5779 5780 // Don't vectorize when the attribute NoImplicitFloat is used. 5781 if (F.hasFnAttribute(Attribute::NoImplicitFloat)) 5782 return false; 5783 5784 LLVM_DEBUG(dbgs() << "SLP: Analyzing blocks in " << F.getName() << ".\n"); 5785 5786 // Use the bottom up slp vectorizer to construct chains that start with 5787 // store instructions. 5788 BoUpSLP R(&F, SE, TTI, TLI, AA, LI, DT, AC, DB, DL, ORE_); 5789 5790 // A general note: the vectorizer must use BoUpSLP::eraseInstruction() to 5791 // delete instructions. 5792 5793 // Scan the blocks in the function in post order. 5794 for (auto BB : post_order(&F.getEntryBlock())) { 5795 collectSeedInstructions(BB); 5796 5797 // Vectorize trees that end at stores. 5798 if (!Stores.empty()) { 5799 LLVM_DEBUG(dbgs() << "SLP: Found stores for " << Stores.size() 5800 << " underlying objects.\n"); 5801 Changed |= vectorizeStoreChains(R); 5802 } 5803 5804 // Vectorize trees that end at reductions. 5805 Changed |= vectorizeChainsInBlock(BB, R); 5806 5807 // Vectorize the index computations of getelementptr instructions. This 5808 // is primarily intended to catch gather-like idioms ending at 5809 // non-consecutive loads. 5810 if (!GEPs.empty()) { 5811 LLVM_DEBUG(dbgs() << "SLP: Found GEPs for " << GEPs.size() 5812 << " underlying objects.\n"); 5813 Changed |= vectorizeGEPIndices(BB, R); 5814 } 5815 } 5816 5817 if (Changed) { 5818 R.optimizeGatherSequence(); 5819 LLVM_DEBUG(dbgs() << "SLP: vectorized \"" << F.getName() << "\"\n"); 5820 } 5821 return Changed; 5822 } 5823 5824 bool SLPVectorizerPass::vectorizeStoreChain(ArrayRef<Value *> Chain, BoUpSLP &R, 5825 unsigned Idx) { 5826 LLVM_DEBUG(dbgs() << "SLP: Analyzing a store chain of length " << Chain.size() 5827 << "\n"); 5828 const unsigned Sz = R.getVectorElementSize(Chain[0]); 5829 const unsigned MinVF = R.getMinVecRegSize() / Sz; 5830 unsigned VF = Chain.size(); 5831 5832 if (!isPowerOf2_32(Sz) || !isPowerOf2_32(VF) || VF < 2 || VF < MinVF) 5833 return false; 5834 5835 LLVM_DEBUG(dbgs() << "SLP: Analyzing " << VF << " stores at offset " << Idx 5836 << "\n"); 5837 5838 R.buildTree(Chain); 5839 Optional<ArrayRef<unsigned>> Order = R.bestOrder(); 5840 // TODO: Handle orders of size less than number of elements in the vector. 5841 if (Order && Order->size() == Chain.size()) { 5842 // TODO: reorder tree nodes without tree rebuilding. 5843 SmallVector<Value *, 4> ReorderedOps(Chain.rbegin(), Chain.rend()); 5844 llvm::transform(*Order, ReorderedOps.begin(), 5845 [Chain](const unsigned Idx) { return Chain[Idx]; }); 5846 R.buildTree(ReorderedOps); 5847 } 5848 if (R.isTreeTinyAndNotFullyVectorizable()) 5849 return false; 5850 if (R.isLoadCombineCandidate()) 5851 return false; 5852 5853 R.computeMinimumValueSizes(); 5854 5855 int Cost = R.getTreeCost(); 5856 5857 LLVM_DEBUG(dbgs() << "SLP: Found cost=" << Cost << " for VF=" << VF << "\n"); 5858 if (Cost < -SLPCostThreshold) { 5859 LLVM_DEBUG(dbgs() << "SLP: Decided to vectorize cost=" << Cost << "\n"); 5860 5861 using namespace ore; 5862 5863 R.getORE()->emit(OptimizationRemark(SV_NAME, "StoresVectorized", 5864 cast<StoreInst>(Chain[0])) 5865 << "Stores SLP vectorized with cost " << NV("Cost", Cost) 5866 << " and with tree size " 5867 << NV("TreeSize", R.getTreeSize())); 5868 5869 R.vectorizeTree(); 5870 return true; 5871 } 5872 5873 return false; 5874 } 5875 5876 bool SLPVectorizerPass::vectorizeStores(ArrayRef<StoreInst *> Stores, 5877 BoUpSLP &R) { 5878 // We may run into multiple chains that merge into a single chain. We mark the 5879 // stores that we vectorized so that we don't visit the same store twice. 5880 BoUpSLP::ValueSet VectorizedStores; 5881 bool Changed = false; 5882 5883 int E = Stores.size(); 5884 SmallBitVector Tails(E, false); 5885 SmallVector<int, 16> ConsecutiveChain(E, E + 1); 5886 int MaxIter = MaxStoreLookup.getValue(); 5887 int IterCnt; 5888 auto &&FindConsecutiveAccess = [this, &Stores, &Tails, &IterCnt, MaxIter, 5889 &ConsecutiveChain](int K, int Idx) { 5890 if (IterCnt >= MaxIter) 5891 return true; 5892 ++IterCnt; 5893 if (!isConsecutiveAccess(Stores[K], Stores[Idx], *DL, *SE)) 5894 return false; 5895 5896 Tails.set(Idx); 5897 ConsecutiveChain[K] = Idx; 5898 return true; 5899 }; 5900 // Do a quadratic search on all of the given stores in reverse order and find 5901 // all of the pairs of stores that follow each other. 5902 for (int Idx = E - 1; Idx >= 0; --Idx) { 5903 // If a store has multiple consecutive store candidates, search according 5904 // to the sequence: Idx-1, Idx+1, Idx-2, Idx+2, ... 5905 // This is because usually pairing with immediate succeeding or preceding 5906 // candidate create the best chance to find slp vectorization opportunity. 5907 const int MaxLookDepth = std::max(E - Idx, Idx + 1); 5908 IterCnt = 0; 5909 for (int Offset = 1, F = MaxLookDepth; Offset < F; ++Offset) 5910 if ((Idx >= Offset && FindConsecutiveAccess(Idx - Offset, Idx)) || 5911 (Idx + Offset < E && FindConsecutiveAccess(Idx + Offset, Idx))) 5912 break; 5913 } 5914 5915 // For stores that start but don't end a link in the chain: 5916 for (int Cnt = E; Cnt > 0; --Cnt) { 5917 int I = Cnt - 1; 5918 if (ConsecutiveChain[I] == E + 1 || Tails.test(I)) 5919 continue; 5920 // We found a store instr that starts a chain. Now follow the chain and try 5921 // to vectorize it. 5922 BoUpSLP::ValueList Operands; 5923 // Collect the chain into a list. 5924 while (I != E + 1 && !VectorizedStores.count(Stores[I])) { 5925 Operands.push_back(Stores[I]); 5926 // Move to the next value in the chain. 5927 I = ConsecutiveChain[I]; 5928 } 5929 5930 // If a vector register can't hold 1 element, we are done. 5931 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 5932 unsigned EltSize = R.getVectorElementSize(Stores[0]); 5933 if (MaxVecRegSize % EltSize != 0) 5934 continue; 5935 5936 unsigned MaxElts = MaxVecRegSize / EltSize; 5937 // FIXME: Is division-by-2 the correct step? Should we assert that the 5938 // register size is a power-of-2? 5939 unsigned StartIdx = 0; 5940 for (unsigned Size = llvm::PowerOf2Ceil(MaxElts); Size >= 2; Size /= 2) { 5941 for (unsigned Cnt = StartIdx, E = Operands.size(); Cnt + Size <= E;) { 5942 ArrayRef<Value *> Slice = makeArrayRef(Operands).slice(Cnt, Size); 5943 if (!VectorizedStores.count(Slice.front()) && 5944 !VectorizedStores.count(Slice.back()) && 5945 vectorizeStoreChain(Slice, R, Cnt)) { 5946 // Mark the vectorized stores so that we don't vectorize them again. 5947 VectorizedStores.insert(Slice.begin(), Slice.end()); 5948 Changed = true; 5949 // If we vectorized initial block, no need to try to vectorize it 5950 // again. 5951 if (Cnt == StartIdx) 5952 StartIdx += Size; 5953 Cnt += Size; 5954 continue; 5955 } 5956 ++Cnt; 5957 } 5958 // Check if the whole array was vectorized already - exit. 5959 if (StartIdx >= Operands.size()) 5960 break; 5961 } 5962 } 5963 5964 return Changed; 5965 } 5966 5967 void SLPVectorizerPass::collectSeedInstructions(BasicBlock *BB) { 5968 // Initialize the collections. We will make a single pass over the block. 5969 Stores.clear(); 5970 GEPs.clear(); 5971 5972 // Visit the store and getelementptr instructions in BB and organize them in 5973 // Stores and GEPs according to the underlying objects of their pointer 5974 // operands. 5975 for (Instruction &I : *BB) { 5976 // Ignore store instructions that are volatile or have a pointer operand 5977 // that doesn't point to a scalar type. 5978 if (auto *SI = dyn_cast<StoreInst>(&I)) { 5979 if (!SI->isSimple()) 5980 continue; 5981 if (!isValidElementType(SI->getValueOperand()->getType())) 5982 continue; 5983 Stores[getUnderlyingObject(SI->getPointerOperand())].push_back(SI); 5984 } 5985 5986 // Ignore getelementptr instructions that have more than one index, a 5987 // constant index, or a pointer operand that doesn't point to a scalar 5988 // type. 5989 else if (auto *GEP = dyn_cast<GetElementPtrInst>(&I)) { 5990 auto Idx = GEP->idx_begin()->get(); 5991 if (GEP->getNumIndices() > 1 || isa<Constant>(Idx)) 5992 continue; 5993 if (!isValidElementType(Idx->getType())) 5994 continue; 5995 if (GEP->getType()->isVectorTy()) 5996 continue; 5997 GEPs[GEP->getPointerOperand()].push_back(GEP); 5998 } 5999 } 6000 } 6001 6002 bool SLPVectorizerPass::tryToVectorizePair(Value *A, Value *B, BoUpSLP &R) { 6003 if (!A || !B) 6004 return false; 6005 Value *VL[] = {A, B}; 6006 return tryToVectorizeList(VL, R, /*AllowReorder=*/true); 6007 } 6008 6009 bool SLPVectorizerPass::tryToVectorizeList(ArrayRef<Value *> VL, BoUpSLP &R, 6010 bool AllowReorder, 6011 ArrayRef<Value *> InsertUses) { 6012 if (VL.size() < 2) 6013 return false; 6014 6015 LLVM_DEBUG(dbgs() << "SLP: Trying to vectorize a list of length = " 6016 << VL.size() << ".\n"); 6017 6018 // Check that all of the parts are instructions of the same type, 6019 // we permit an alternate opcode via InstructionsState. 6020 InstructionsState S = getSameOpcode(VL); 6021 if (!S.getOpcode()) 6022 return false; 6023 6024 Instruction *I0 = cast<Instruction>(S.OpValue); 6025 // Make sure invalid types (including vector type) are rejected before 6026 // determining vectorization factor for scalar instructions. 6027 for (Value *V : VL) { 6028 Type *Ty = V->getType(); 6029 if (!isValidElementType(Ty)) { 6030 // NOTE: the following will give user internal llvm type name, which may 6031 // not be useful. 6032 R.getORE()->emit([&]() { 6033 std::string type_str; 6034 llvm::raw_string_ostream rso(type_str); 6035 Ty->print(rso); 6036 return OptimizationRemarkMissed(SV_NAME, "UnsupportedType", I0) 6037 << "Cannot SLP vectorize list: type " 6038 << rso.str() + " is unsupported by vectorizer"; 6039 }); 6040 return false; 6041 } 6042 } 6043 6044 unsigned Sz = R.getVectorElementSize(I0); 6045 unsigned MinVF = std::max(2U, R.getMinVecRegSize() / Sz); 6046 unsigned MaxVF = std::max<unsigned>(PowerOf2Floor(VL.size()), MinVF); 6047 if (MaxVF < 2) { 6048 R.getORE()->emit([&]() { 6049 return OptimizationRemarkMissed(SV_NAME, "SmallVF", I0) 6050 << "Cannot SLP vectorize list: vectorization factor " 6051 << "less than 2 is not supported"; 6052 }); 6053 return false; 6054 } 6055 6056 bool Changed = false; 6057 bool CandidateFound = false; 6058 int MinCost = SLPCostThreshold; 6059 6060 bool CompensateUseCost = 6061 !InsertUses.empty() && llvm::all_of(InsertUses, [](const Value *V) { 6062 return V && isa<InsertElementInst>(V); 6063 }); 6064 assert((!CompensateUseCost || InsertUses.size() == VL.size()) && 6065 "Each scalar expected to have an associated InsertElement user."); 6066 6067 unsigned NextInst = 0, MaxInst = VL.size(); 6068 for (unsigned VF = MaxVF; NextInst + 1 < MaxInst && VF >= MinVF; VF /= 2) { 6069 // No actual vectorization should happen, if number of parts is the same as 6070 // provided vectorization factor (i.e. the scalar type is used for vector 6071 // code during codegen). 6072 auto *VecTy = FixedVectorType::get(VL[0]->getType(), VF); 6073 if (TTI->getNumberOfParts(VecTy) == VF) 6074 continue; 6075 for (unsigned I = NextInst; I < MaxInst; ++I) { 6076 unsigned OpsWidth = 0; 6077 6078 if (I + VF > MaxInst) 6079 OpsWidth = MaxInst - I; 6080 else 6081 OpsWidth = VF; 6082 6083 if (!isPowerOf2_32(OpsWidth) || OpsWidth < 2) 6084 break; 6085 6086 ArrayRef<Value *> Ops = VL.slice(I, OpsWidth); 6087 // Check that a previous iteration of this loop did not delete the Value. 6088 if (llvm::any_of(Ops, [&R](Value *V) { 6089 auto *I = dyn_cast<Instruction>(V); 6090 return I && R.isDeleted(I); 6091 })) 6092 continue; 6093 6094 LLVM_DEBUG(dbgs() << "SLP: Analyzing " << OpsWidth << " operations " 6095 << "\n"); 6096 6097 R.buildTree(Ops); 6098 Optional<ArrayRef<unsigned>> Order = R.bestOrder(); 6099 // TODO: check if we can allow reordering for more cases. 6100 if (AllowReorder && Order) { 6101 // TODO: reorder tree nodes without tree rebuilding. 6102 // Conceptually, there is nothing actually preventing us from trying to 6103 // reorder a larger list. In fact, we do exactly this when vectorizing 6104 // reductions. However, at this point, we only expect to get here when 6105 // there are exactly two operations. 6106 assert(Ops.size() == 2); 6107 Value *ReorderedOps[] = {Ops[1], Ops[0]}; 6108 R.buildTree(ReorderedOps, None); 6109 } 6110 if (R.isTreeTinyAndNotFullyVectorizable()) 6111 continue; 6112 6113 R.computeMinimumValueSizes(); 6114 int Cost = R.getTreeCost(); 6115 CandidateFound = true; 6116 if (CompensateUseCost) { 6117 // TODO: Use TTI's getScalarizationOverhead for sequence of inserts 6118 // rather than sum of single inserts as the latter may overestimate 6119 // cost. This work should imply improving cost estimation for extracts 6120 // that added in for external (for vectorization tree) users,i.e. that 6121 // part should also switch to same interface. 6122 // For example, the following case is projected code after SLP: 6123 // %4 = extractelement <4 x i64> %3, i32 0 6124 // %v0 = insertelement <4 x i64> undef, i64 %4, i32 0 6125 // %5 = extractelement <4 x i64> %3, i32 1 6126 // %v1 = insertelement <4 x i64> %v0, i64 %5, i32 1 6127 // %6 = extractelement <4 x i64> %3, i32 2 6128 // %v2 = insertelement <4 x i64> %v1, i64 %6, i32 2 6129 // %7 = extractelement <4 x i64> %3, i32 3 6130 // %v3 = insertelement <4 x i64> %v2, i64 %7, i32 3 6131 // 6132 // Extracts here added by SLP in order to feed users (the inserts) of 6133 // original scalars and contribute to "ExtractCost" at cost evaluation. 6134 // The inserts in turn form sequence to build an aggregate that 6135 // detected by findBuildAggregate routine. 6136 // SLP makes an assumption that such sequence will be optimized away 6137 // later (instcombine) so it tries to compensate ExctractCost with 6138 // cost of insert sequence. 6139 // Current per element cost calculation approach is not quite accurate 6140 // and tends to create bias toward favoring vectorization. 6141 // Switching to the TTI interface might help a bit. 6142 // Alternative solution could be pattern-match to detect a no-op or 6143 // shuffle. 6144 unsigned UserCost = 0; 6145 for (unsigned Lane = 0; Lane < OpsWidth; Lane++) { 6146 auto *IE = cast<InsertElementInst>(InsertUses[I + Lane]); 6147 if (auto *CI = dyn_cast<ConstantInt>(IE->getOperand(2))) 6148 UserCost += TTI->getVectorInstrCost( 6149 Instruction::InsertElement, IE->getType(), CI->getZExtValue()); 6150 } 6151 LLVM_DEBUG(dbgs() << "SLP: Compensate cost of users by: " << UserCost 6152 << ".\n"); 6153 Cost -= UserCost; 6154 } 6155 6156 MinCost = std::min(MinCost, Cost); 6157 6158 if (Cost < -SLPCostThreshold) { 6159 LLVM_DEBUG(dbgs() << "SLP: Vectorizing list at cost:" << Cost << ".\n"); 6160 R.getORE()->emit(OptimizationRemark(SV_NAME, "VectorizedList", 6161 cast<Instruction>(Ops[0])) 6162 << "SLP vectorized with cost " << ore::NV("Cost", Cost) 6163 << " and with tree size " 6164 << ore::NV("TreeSize", R.getTreeSize())); 6165 6166 R.vectorizeTree(); 6167 // Move to the next bundle. 6168 I += VF - 1; 6169 NextInst = I + 1; 6170 Changed = true; 6171 } 6172 } 6173 } 6174 6175 if (!Changed && CandidateFound) { 6176 R.getORE()->emit([&]() { 6177 return OptimizationRemarkMissed(SV_NAME, "NotBeneficial", I0) 6178 << "List vectorization was possible but not beneficial with cost " 6179 << ore::NV("Cost", MinCost) << " >= " 6180 << ore::NV("Treshold", -SLPCostThreshold); 6181 }); 6182 } else if (!Changed) { 6183 R.getORE()->emit([&]() { 6184 return OptimizationRemarkMissed(SV_NAME, "NotPossible", I0) 6185 << "Cannot SLP vectorize list: vectorization was impossible" 6186 << " with available vectorization factors"; 6187 }); 6188 } 6189 return Changed; 6190 } 6191 6192 bool SLPVectorizerPass::tryToVectorize(Instruction *I, BoUpSLP &R) { 6193 if (!I) 6194 return false; 6195 6196 if (!isa<BinaryOperator>(I) && !isa<CmpInst>(I)) 6197 return false; 6198 6199 Value *P = I->getParent(); 6200 6201 // Vectorize in current basic block only. 6202 auto *Op0 = dyn_cast<Instruction>(I->getOperand(0)); 6203 auto *Op1 = dyn_cast<Instruction>(I->getOperand(1)); 6204 if (!Op0 || !Op1 || Op0->getParent() != P || Op1->getParent() != P) 6205 return false; 6206 6207 // Try to vectorize V. 6208 if (tryToVectorizePair(Op0, Op1, R)) 6209 return true; 6210 6211 auto *A = dyn_cast<BinaryOperator>(Op0); 6212 auto *B = dyn_cast<BinaryOperator>(Op1); 6213 // Try to skip B. 6214 if (B && B->hasOneUse()) { 6215 auto *B0 = dyn_cast<BinaryOperator>(B->getOperand(0)); 6216 auto *B1 = dyn_cast<BinaryOperator>(B->getOperand(1)); 6217 if (B0 && B0->getParent() == P && tryToVectorizePair(A, B0, R)) 6218 return true; 6219 if (B1 && B1->getParent() == P && tryToVectorizePair(A, B1, R)) 6220 return true; 6221 } 6222 6223 // Try to skip A. 6224 if (A && A->hasOneUse()) { 6225 auto *A0 = dyn_cast<BinaryOperator>(A->getOperand(0)); 6226 auto *A1 = dyn_cast<BinaryOperator>(A->getOperand(1)); 6227 if (A0 && A0->getParent() == P && tryToVectorizePair(A0, B, R)) 6228 return true; 6229 if (A1 && A1->getParent() == P && tryToVectorizePair(A1, B, R)) 6230 return true; 6231 } 6232 return false; 6233 } 6234 6235 /// Generate a shuffle mask to be used in a reduction tree. 6236 /// 6237 /// \param VecLen The length of the vector to be reduced. 6238 /// \param NumEltsToRdx The number of elements that should be reduced in the 6239 /// vector. 6240 /// \param IsPairwise Whether the reduction is a pairwise or splitting 6241 /// reduction. A pairwise reduction will generate a mask of 6242 /// <0,2,...> or <1,3,..> while a splitting reduction will generate 6243 /// <2,3, undef,undef> for a vector of 4 and NumElts = 2. 6244 /// \param IsLeft True will generate a mask of even elements, odd otherwise. 6245 static SmallVector<int, 32> createRdxShuffleMask(unsigned VecLen, 6246 unsigned NumEltsToRdx, 6247 bool IsPairwise, bool IsLeft) { 6248 assert((IsPairwise || !IsLeft) && "Don't support a <0,1,undef,...> mask"); 6249 6250 SmallVector<int, 32> ShuffleMask(VecLen, -1); 6251 6252 if (IsPairwise) 6253 // Build a mask of 0, 2, ... (left) or 1, 3, ... (right). 6254 for (unsigned i = 0; i != NumEltsToRdx; ++i) 6255 ShuffleMask[i] = 2 * i + !IsLeft; 6256 else 6257 // Move the upper half of the vector to the lower half. 6258 for (unsigned i = 0; i != NumEltsToRdx; ++i) 6259 ShuffleMask[i] = NumEltsToRdx + i; 6260 6261 return ShuffleMask; 6262 } 6263 6264 namespace { 6265 6266 /// Model horizontal reductions. 6267 /// 6268 /// A horizontal reduction is a tree of reduction operations (currently add and 6269 /// fadd) that has operations that can be put into a vector as its leaf. 6270 /// For example, this tree: 6271 /// 6272 /// mul mul mul mul 6273 /// \ / \ / 6274 /// + + 6275 /// \ / 6276 /// + 6277 /// This tree has "mul" as its reduced values and "+" as its reduction 6278 /// operations. A reduction might be feeding into a store or a binary operation 6279 /// feeding a phi. 6280 /// ... 6281 /// \ / 6282 /// + 6283 /// | 6284 /// phi += 6285 /// 6286 /// Or: 6287 /// ... 6288 /// \ / 6289 /// + 6290 /// | 6291 /// *p = 6292 /// 6293 class HorizontalReduction { 6294 using ReductionOpsType = SmallVector<Value *, 16>; 6295 using ReductionOpsListType = SmallVector<ReductionOpsType, 2>; 6296 ReductionOpsListType ReductionOps; 6297 SmallVector<Value *, 32> ReducedVals; 6298 // Use map vector to make stable output. 6299 MapVector<Instruction *, Value *> ExtraArgs; 6300 6301 /// Kind of the reduction data. 6302 enum ReductionKind { 6303 RK_None, /// Not a reduction. 6304 RK_Arithmetic, /// Binary reduction data. 6305 RK_SMin, /// Signed minimum reduction data. 6306 RK_UMin, /// Unsigned minimum reduction data. 6307 RK_SMax, /// Signed maximum reduction data. 6308 RK_UMax, /// Unsigned maximum reduction data. 6309 }; 6310 6311 /// Contains info about operation, like its opcode, left and right operands. 6312 class OperationData { 6313 /// Opcode of the instruction. 6314 unsigned Opcode = 0; 6315 6316 /// Kind of the reduction operation. 6317 ReductionKind Kind = RK_None; 6318 6319 /// Checks if the reduction operation can be vectorized. 6320 bool isVectorizable() const { 6321 // We currently only support add/mul/logical && min/max reductions. 6322 return ((Kind == RK_Arithmetic && 6323 (Opcode == Instruction::Add || Opcode == Instruction::FAdd || 6324 Opcode == Instruction::Mul || Opcode == Instruction::FMul || 6325 Opcode == Instruction::And || Opcode == Instruction::Or || 6326 Opcode == Instruction::Xor)) || 6327 (Opcode == Instruction::ICmp && 6328 (Kind == RK_SMin || Kind == RK_SMax || 6329 Kind == RK_UMin || Kind == RK_UMax))); 6330 } 6331 6332 /// Creates reduction operation with the current opcode. 6333 Value *createOp(IRBuilder<> &Builder, Value *LHS, Value *RHS, 6334 const Twine &Name) const { 6335 assert(isVectorizable() && 6336 "Expected add|fadd or min/max reduction operation."); 6337 Value *Cmp = nullptr; 6338 switch (Kind) { 6339 case RK_Arithmetic: 6340 return Builder.CreateBinOp((Instruction::BinaryOps)Opcode, LHS, RHS, 6341 Name); 6342 case RK_SMin: 6343 assert(Opcode == Instruction::ICmp && "Expected integer types."); 6344 Cmp = Builder.CreateICmpSLT(LHS, RHS); 6345 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 6346 case RK_SMax: 6347 assert(Opcode == Instruction::ICmp && "Expected integer types."); 6348 Cmp = Builder.CreateICmpSGT(LHS, RHS); 6349 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 6350 case RK_UMin: 6351 assert(Opcode == Instruction::ICmp && "Expected integer types."); 6352 Cmp = Builder.CreateICmpULT(LHS, RHS); 6353 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 6354 case RK_UMax: 6355 assert(Opcode == Instruction::ICmp && "Expected integer types."); 6356 Cmp = Builder.CreateICmpUGT(LHS, RHS); 6357 return Builder.CreateSelect(Cmp, LHS, RHS, Name); 6358 case RK_None: 6359 break; 6360 } 6361 llvm_unreachable("Unknown reduction operation."); 6362 } 6363 6364 public: 6365 explicit OperationData() = default; 6366 6367 /// Construction for reduced values. They are identified by opcode only and 6368 /// don't have associated LHS/RHS values. 6369 explicit OperationData(Instruction &I) { 6370 Opcode = I.getOpcode(); 6371 } 6372 6373 /// Constructor for reduction operations with opcode and its left and 6374 /// right operands. 6375 OperationData(unsigned Opcode, ReductionKind Kind) 6376 : Opcode(Opcode), Kind(Kind) { 6377 assert(Kind != RK_None && "One of the reduction operations is expected."); 6378 } 6379 6380 explicit operator bool() const { return Opcode; } 6381 6382 /// Return true if this operation is any kind of minimum or maximum. 6383 bool isMinMax() const { 6384 switch (Kind) { 6385 case RK_Arithmetic: 6386 return false; 6387 case RK_SMin: 6388 case RK_SMax: 6389 case RK_UMin: 6390 case RK_UMax: 6391 return true; 6392 case RK_None: 6393 break; 6394 } 6395 llvm_unreachable("Reduction kind is not set"); 6396 } 6397 6398 /// Get the index of the first operand. 6399 unsigned getFirstOperandIndex() const { 6400 assert(!!*this && "The opcode is not set."); 6401 // We allow calling this before 'Kind' is set, so handle that specially. 6402 if (Kind == RK_None) 6403 return 0; 6404 return isMinMax() ? 1 : 0; 6405 } 6406 6407 /// Total number of operands in the reduction operation. 6408 unsigned getNumberOfOperands() const { 6409 assert(Kind != RK_None && !!*this && "Expected reduction operation."); 6410 return isMinMax() ? 3 : 2; 6411 } 6412 6413 /// Checks if the instruction is in basic block \p BB. 6414 /// For a min/max reduction check that both compare and select are in \p BB. 6415 bool hasSameParent(Instruction *I, BasicBlock *BB, bool IsRedOp) const { 6416 assert(Kind != RK_None && !!*this && "Expected reduction operation."); 6417 if (IsRedOp && isMinMax()) { 6418 auto *Cmp = cast<Instruction>(cast<SelectInst>(I)->getCondition()); 6419 return I->getParent() == BB && Cmp && Cmp->getParent() == BB; 6420 } 6421 return I->getParent() == BB; 6422 } 6423 6424 /// Expected number of uses for reduction operations/reduced values. 6425 bool hasRequiredNumberOfUses(Instruction *I, bool IsReductionOp) const { 6426 assert(Kind != RK_None && !!*this && "Expected reduction operation."); 6427 // SelectInst must be used twice while the condition op must have single 6428 // use only. 6429 if (isMinMax()) 6430 return I->hasNUses(2) && 6431 (!IsReductionOp || 6432 cast<SelectInst>(I)->getCondition()->hasOneUse()); 6433 6434 // Arithmetic reduction operation must be used once only. 6435 return I->hasOneUse(); 6436 } 6437 6438 /// Initializes the list of reduction operations. 6439 void initReductionOps(ReductionOpsListType &ReductionOps) { 6440 assert(Kind != RK_None && !!*this && "Expected reduction operation."); 6441 if (isMinMax()) 6442 ReductionOps.assign(2, ReductionOpsType()); 6443 else 6444 ReductionOps.assign(1, ReductionOpsType()); 6445 } 6446 6447 /// Add all reduction operations for the reduction instruction \p I. 6448 void addReductionOps(Instruction *I, ReductionOpsListType &ReductionOps) { 6449 assert(Kind != RK_None && !!*this && "Expected reduction operation."); 6450 if (isMinMax()) { 6451 ReductionOps[0].emplace_back(cast<SelectInst>(I)->getCondition()); 6452 ReductionOps[1].emplace_back(I); 6453 } else { 6454 ReductionOps[0].emplace_back(I); 6455 } 6456 } 6457 6458 /// Checks if instruction is associative and can be vectorized. 6459 bool isAssociative(Instruction *I) const { 6460 assert(Kind != RK_None && *this && "Expected reduction operation."); 6461 switch (Kind) { 6462 case RK_Arithmetic: 6463 return I->isAssociative(); 6464 case RK_SMin: 6465 case RK_SMax: 6466 case RK_UMin: 6467 case RK_UMax: 6468 assert(Opcode == Instruction::ICmp && 6469 "Only integer compare operation is expected."); 6470 return true; 6471 case RK_None: 6472 break; 6473 } 6474 llvm_unreachable("Reduction kind is not set"); 6475 } 6476 6477 /// Checks if the reduction operation can be vectorized. 6478 bool isVectorizable(Instruction *I) const { 6479 return isVectorizable() && isAssociative(I); 6480 } 6481 6482 /// Checks if two operation data are both a reduction op or both a reduced 6483 /// value. 6484 bool operator==(const OperationData &OD) const { 6485 assert(((Kind != OD.Kind) || (Opcode != 0 && OD.Opcode != 0)) && 6486 "One of the comparing operations is incorrect."); 6487 return Kind == OD.Kind && Opcode == OD.Opcode; 6488 } 6489 bool operator!=(const OperationData &OD) const { return !(*this == OD); } 6490 void clear() { 6491 Opcode = 0; 6492 Kind = RK_None; 6493 } 6494 6495 /// Get the opcode of the reduction operation. 6496 unsigned getOpcode() const { 6497 assert(isVectorizable() && "Expected vectorizable operation."); 6498 return Opcode; 6499 } 6500 6501 /// Get kind of reduction data. 6502 ReductionKind getKind() const { return Kind; } 6503 Value *getLHS(Instruction *I) const { 6504 if (Kind == RK_None) 6505 return nullptr; 6506 return I->getOperand(getFirstOperandIndex()); 6507 } 6508 Value *getRHS(Instruction *I) const { 6509 if (Kind == RK_None) 6510 return nullptr; 6511 return I->getOperand(getFirstOperandIndex() + 1); 6512 } 6513 6514 /// Creates reduction operation with the current opcode with the IR flags 6515 /// from \p ReductionOps. 6516 Value *createOp(IRBuilder<> &Builder, Value *LHS, Value *RHS, 6517 const Twine &Name, 6518 const ReductionOpsListType &ReductionOps) const { 6519 assert(isVectorizable() && 6520 "Expected add|fadd or min/max reduction operation."); 6521 auto *Op = createOp(Builder, LHS, RHS, Name); 6522 switch (Kind) { 6523 case RK_Arithmetic: 6524 propagateIRFlags(Op, ReductionOps[0]); 6525 return Op; 6526 case RK_SMin: 6527 case RK_SMax: 6528 case RK_UMin: 6529 case RK_UMax: 6530 if (auto *SI = dyn_cast<SelectInst>(Op)) 6531 propagateIRFlags(SI->getCondition(), ReductionOps[0]); 6532 propagateIRFlags(Op, ReductionOps[1]); 6533 return Op; 6534 case RK_None: 6535 break; 6536 } 6537 llvm_unreachable("Unknown reduction operation."); 6538 } 6539 /// Creates reduction operation with the current opcode with the IR flags 6540 /// from \p I. 6541 Value *createOp(IRBuilder<> &Builder, Value *LHS, Value *RHS, 6542 const Twine &Name, Instruction *I) const { 6543 assert(isVectorizable() && 6544 "Expected add|fadd or min/max reduction operation."); 6545 auto *Op = createOp(Builder, LHS, RHS, Name); 6546 switch (Kind) { 6547 case RK_Arithmetic: 6548 propagateIRFlags(Op, I); 6549 return Op; 6550 case RK_SMin: 6551 case RK_SMax: 6552 case RK_UMin: 6553 case RK_UMax: 6554 if (auto *SI = dyn_cast<SelectInst>(Op)) { 6555 propagateIRFlags(SI->getCondition(), 6556 cast<SelectInst>(I)->getCondition()); 6557 } 6558 propagateIRFlags(Op, I); 6559 return Op; 6560 case RK_None: 6561 break; 6562 } 6563 llvm_unreachable("Unknown reduction operation."); 6564 } 6565 6566 TargetTransformInfo::ReductionFlags getFlags() const { 6567 TargetTransformInfo::ReductionFlags Flags; 6568 switch (Kind) { 6569 case RK_Arithmetic: 6570 break; 6571 case RK_SMin: 6572 Flags.IsSigned = true; 6573 Flags.IsMaxOp = false; 6574 break; 6575 case RK_SMax: 6576 Flags.IsSigned = true; 6577 Flags.IsMaxOp = true; 6578 break; 6579 case RK_UMin: 6580 Flags.IsSigned = false; 6581 Flags.IsMaxOp = false; 6582 break; 6583 case RK_UMax: 6584 Flags.IsSigned = false; 6585 Flags.IsMaxOp = true; 6586 break; 6587 case RK_None: 6588 llvm_unreachable("Reduction kind is not set"); 6589 } 6590 return Flags; 6591 } 6592 }; 6593 6594 WeakTrackingVH ReductionRoot; 6595 6596 /// The operation data of the reduction operation. 6597 OperationData ReductionData; 6598 6599 /// The operation data of the values we perform a reduction on. 6600 OperationData ReducedValueData; 6601 6602 /// Should we model this reduction as a pairwise reduction tree or a tree that 6603 /// splits the vector in halves and adds those halves. 6604 bool IsPairwiseReduction = false; 6605 6606 /// Checks if the ParentStackElem.first should be marked as a reduction 6607 /// operation with an extra argument or as extra argument itself. 6608 void markExtraArg(std::pair<Instruction *, unsigned> &ParentStackElem, 6609 Value *ExtraArg) { 6610 if (ExtraArgs.count(ParentStackElem.first)) { 6611 ExtraArgs[ParentStackElem.first] = nullptr; 6612 // We ran into something like: 6613 // ParentStackElem.first = ExtraArgs[ParentStackElem.first] + ExtraArg. 6614 // The whole ParentStackElem.first should be considered as an extra value 6615 // in this case. 6616 // Do not perform analysis of remaining operands of ParentStackElem.first 6617 // instruction, this whole instruction is an extra argument. 6618 ParentStackElem.second = ParentStackElem.first->getNumOperands(); 6619 } else { 6620 // We ran into something like: 6621 // ParentStackElem.first += ... + ExtraArg + ... 6622 ExtraArgs[ParentStackElem.first] = ExtraArg; 6623 } 6624 } 6625 6626 static OperationData getOperationData(Instruction *I) { 6627 if (!I) 6628 return OperationData(); 6629 6630 Value *LHS; 6631 Value *RHS; 6632 if (m_BinOp(m_Value(LHS), m_Value(RHS)).match(I)) { 6633 return OperationData(cast<BinaryOperator>(I)->getOpcode(), RK_Arithmetic); 6634 } 6635 if (auto *Select = dyn_cast<SelectInst>(I)) { 6636 // Look for a min/max pattern. 6637 if (m_UMin(m_Value(LHS), m_Value(RHS)).match(Select)) { 6638 return OperationData(Instruction::ICmp, RK_UMin); 6639 } else if (m_SMin(m_Value(LHS), m_Value(RHS)).match(Select)) { 6640 return OperationData(Instruction::ICmp, RK_SMin); 6641 } else if (m_UMax(m_Value(LHS), m_Value(RHS)).match(Select)) { 6642 return OperationData(Instruction::ICmp, RK_UMax); 6643 } else if (m_SMax(m_Value(LHS), m_Value(RHS)).match(Select)) { 6644 return OperationData(Instruction::ICmp, RK_SMax); 6645 } else { 6646 // Try harder: look for min/max pattern based on instructions producing 6647 // same values such as: select ((cmp Inst1, Inst2), Inst1, Inst2). 6648 // During the intermediate stages of SLP, it's very common to have 6649 // pattern like this (since optimizeGatherSequence is run only once 6650 // at the end): 6651 // %1 = extractelement <2 x i32> %a, i32 0 6652 // %2 = extractelement <2 x i32> %a, i32 1 6653 // %cond = icmp sgt i32 %1, %2 6654 // %3 = extractelement <2 x i32> %a, i32 0 6655 // %4 = extractelement <2 x i32> %a, i32 1 6656 // %select = select i1 %cond, i32 %3, i32 %4 6657 CmpInst::Predicate Pred; 6658 Instruction *L1; 6659 Instruction *L2; 6660 6661 LHS = Select->getTrueValue(); 6662 RHS = Select->getFalseValue(); 6663 Value *Cond = Select->getCondition(); 6664 6665 // TODO: Support inverse predicates. 6666 if (match(Cond, m_Cmp(Pred, m_Specific(LHS), m_Instruction(L2)))) { 6667 if (!isa<ExtractElementInst>(RHS) || 6668 !L2->isIdenticalTo(cast<Instruction>(RHS))) 6669 return OperationData(*I); 6670 } else if (match(Cond, m_Cmp(Pred, m_Instruction(L1), m_Specific(RHS)))) { 6671 if (!isa<ExtractElementInst>(LHS) || 6672 !L1->isIdenticalTo(cast<Instruction>(LHS))) 6673 return OperationData(*I); 6674 } else { 6675 if (!isa<ExtractElementInst>(LHS) || !isa<ExtractElementInst>(RHS)) 6676 return OperationData(*I); 6677 if (!match(Cond, m_Cmp(Pred, m_Instruction(L1), m_Instruction(L2))) || 6678 !L1->isIdenticalTo(cast<Instruction>(LHS)) || 6679 !L2->isIdenticalTo(cast<Instruction>(RHS))) 6680 return OperationData(*I); 6681 } 6682 switch (Pred) { 6683 default: 6684 return OperationData(*I); 6685 6686 case CmpInst::ICMP_ULT: 6687 case CmpInst::ICMP_ULE: 6688 return OperationData(Instruction::ICmp, RK_UMin); 6689 6690 case CmpInst::ICMP_SLT: 6691 case CmpInst::ICMP_SLE: 6692 return OperationData(Instruction::ICmp, RK_SMin); 6693 6694 case CmpInst::ICMP_UGT: 6695 case CmpInst::ICMP_UGE: 6696 return OperationData(Instruction::ICmp, RK_UMax); 6697 6698 case CmpInst::ICMP_SGT: 6699 case CmpInst::ICMP_SGE: 6700 return OperationData(Instruction::ICmp, RK_SMax); 6701 } 6702 } 6703 } 6704 return OperationData(*I); 6705 } 6706 6707 public: 6708 HorizontalReduction() = default; 6709 6710 /// Try to find a reduction tree. 6711 bool matchAssociativeReduction(PHINode *Phi, Instruction *B) { 6712 assert((!Phi || is_contained(Phi->operands(), B)) && 6713 "Thi phi needs to use the binary operator"); 6714 6715 ReductionData = getOperationData(B); 6716 6717 // We could have a initial reductions that is not an add. 6718 // r *= v1 + v2 + v3 + v4 6719 // In such a case start looking for a tree rooted in the first '+'. 6720 if (Phi) { 6721 if (ReductionData.getLHS(B) == Phi) { 6722 Phi = nullptr; 6723 B = dyn_cast<Instruction>(ReductionData.getRHS(B)); 6724 ReductionData = getOperationData(B); 6725 } else if (ReductionData.getRHS(B) == Phi) { 6726 Phi = nullptr; 6727 B = dyn_cast<Instruction>(ReductionData.getLHS(B)); 6728 ReductionData = getOperationData(B); 6729 } 6730 } 6731 6732 if (!ReductionData.isVectorizable(B)) 6733 return false; 6734 6735 Type *Ty = B->getType(); 6736 if (!isValidElementType(Ty)) 6737 return false; 6738 if (!Ty->isIntOrIntVectorTy() && !Ty->isFPOrFPVectorTy()) 6739 return false; 6740 6741 ReducedValueData.clear(); 6742 ReductionRoot = B; 6743 6744 // Post order traverse the reduction tree starting at B. We only handle true 6745 // trees containing only binary operators. 6746 SmallVector<std::pair<Instruction *, unsigned>, 32> Stack; 6747 Stack.push_back(std::make_pair(B, ReductionData.getFirstOperandIndex())); 6748 ReductionData.initReductionOps(ReductionOps); 6749 while (!Stack.empty()) { 6750 Instruction *TreeN = Stack.back().first; 6751 unsigned EdgeToVist = Stack.back().second++; 6752 OperationData OpData = getOperationData(TreeN); 6753 bool IsReducedValue = OpData != ReductionData; 6754 6755 // Postorder vist. 6756 if (IsReducedValue || EdgeToVist == OpData.getNumberOfOperands()) { 6757 if (IsReducedValue) 6758 ReducedVals.push_back(TreeN); 6759 else { 6760 auto I = ExtraArgs.find(TreeN); 6761 if (I != ExtraArgs.end() && !I->second) { 6762 // Check if TreeN is an extra argument of its parent operation. 6763 if (Stack.size() <= 1) { 6764 // TreeN can't be an extra argument as it is a root reduction 6765 // operation. 6766 return false; 6767 } 6768 // Yes, TreeN is an extra argument, do not add it to a list of 6769 // reduction operations. 6770 // Stack[Stack.size() - 2] always points to the parent operation. 6771 markExtraArg(Stack[Stack.size() - 2], TreeN); 6772 ExtraArgs.erase(TreeN); 6773 } else 6774 ReductionData.addReductionOps(TreeN, ReductionOps); 6775 } 6776 // Retract. 6777 Stack.pop_back(); 6778 continue; 6779 } 6780 6781 // Visit left or right. 6782 Value *NextV = TreeN->getOperand(EdgeToVist); 6783 if (NextV != Phi) { 6784 auto *I = dyn_cast<Instruction>(NextV); 6785 OpData = getOperationData(I); 6786 // Continue analysis if the next operand is a reduction operation or 6787 // (possibly) a reduced value. If the reduced value opcode is not set, 6788 // the first met operation != reduction operation is considered as the 6789 // reduced value class. 6790 if (I && (!ReducedValueData || OpData == ReducedValueData || 6791 OpData == ReductionData)) { 6792 const bool IsReductionOperation = OpData == ReductionData; 6793 // Only handle trees in the current basic block. 6794 if (!ReductionData.hasSameParent(I, B->getParent(), 6795 IsReductionOperation)) { 6796 // I is an extra argument for TreeN (its parent operation). 6797 markExtraArg(Stack.back(), I); 6798 continue; 6799 } 6800 6801 // Each tree node needs to have minimal number of users except for the 6802 // ultimate reduction. 6803 if (!ReductionData.hasRequiredNumberOfUses(I, 6804 OpData == ReductionData) && 6805 I != B) { 6806 // I is an extra argument for TreeN (its parent operation). 6807 markExtraArg(Stack.back(), I); 6808 continue; 6809 } 6810 6811 if (IsReductionOperation) { 6812 // We need to be able to reassociate the reduction operations. 6813 if (!OpData.isAssociative(I)) { 6814 // I is an extra argument for TreeN (its parent operation). 6815 markExtraArg(Stack.back(), I); 6816 continue; 6817 } 6818 } else if (ReducedValueData && 6819 ReducedValueData != OpData) { 6820 // Make sure that the opcodes of the operations that we are going to 6821 // reduce match. 6822 // I is an extra argument for TreeN (its parent operation). 6823 markExtraArg(Stack.back(), I); 6824 continue; 6825 } else if (!ReducedValueData) 6826 ReducedValueData = OpData; 6827 6828 Stack.push_back(std::make_pair(I, OpData.getFirstOperandIndex())); 6829 continue; 6830 } 6831 } 6832 // NextV is an extra argument for TreeN (its parent operation). 6833 markExtraArg(Stack.back(), NextV); 6834 } 6835 return true; 6836 } 6837 6838 /// Attempt to vectorize the tree found by matchAssociativeReduction. 6839 bool tryToReduce(BoUpSLP &V, TargetTransformInfo *TTI) { 6840 // If there are a sufficient number of reduction values, reduce 6841 // to a nearby power-of-2. We can safely generate oversized 6842 // vectors and rely on the backend to split them to legal sizes. 6843 unsigned NumReducedVals = ReducedVals.size(); 6844 if (NumReducedVals < 4) 6845 return false; 6846 6847 // FIXME: Fast-math-flags should be set based on the instructions in the 6848 // reduction (not all of 'fast' are required). 6849 IRBuilder<> Builder(cast<Instruction>(ReductionRoot)); 6850 FastMathFlags Unsafe; 6851 Unsafe.setFast(); 6852 Builder.setFastMathFlags(Unsafe); 6853 6854 BoUpSLP::ExtraValueToDebugLocsMap ExternallyUsedValues; 6855 // The same extra argument may be used several times, so log each attempt 6856 // to use it. 6857 for (const std::pair<Instruction *, Value *> &Pair : ExtraArgs) { 6858 assert(Pair.first && "DebugLoc must be set."); 6859 ExternallyUsedValues[Pair.second].push_back(Pair.first); 6860 } 6861 6862 // The compare instruction of a min/max is the insertion point for new 6863 // instructions and may be replaced with a new compare instruction. 6864 auto getCmpForMinMaxReduction = [](Instruction *RdxRootInst) { 6865 assert(isa<SelectInst>(RdxRootInst) && 6866 "Expected min/max reduction to have select root instruction"); 6867 Value *ScalarCond = cast<SelectInst>(RdxRootInst)->getCondition(); 6868 assert(isa<Instruction>(ScalarCond) && 6869 "Expected min/max reduction to have compare condition"); 6870 return cast<Instruction>(ScalarCond); 6871 }; 6872 6873 // The reduction root is used as the insertion point for new instructions, 6874 // so set it as externally used to prevent it from being deleted. 6875 ExternallyUsedValues[ReductionRoot]; 6876 SmallVector<Value *, 16> IgnoreList; 6877 for (ReductionOpsType &RdxOp : ReductionOps) 6878 IgnoreList.append(RdxOp.begin(), RdxOp.end()); 6879 6880 unsigned ReduxWidth = PowerOf2Floor(NumReducedVals); 6881 if (NumReducedVals > ReduxWidth) { 6882 // In the loop below, we are building a tree based on a window of 6883 // 'ReduxWidth' values. 6884 // If the operands of those values have common traits (compare predicate, 6885 // constant operand, etc), then we want to group those together to 6886 // minimize the cost of the reduction. 6887 6888 // TODO: This should be extended to count common operands for 6889 // compares and binops. 6890 6891 // Step 1: Count the number of times each compare predicate occurs. 6892 SmallDenseMap<unsigned, unsigned> PredCountMap; 6893 for (Value *RdxVal : ReducedVals) { 6894 CmpInst::Predicate Pred; 6895 if (match(RdxVal, m_Cmp(Pred, m_Value(), m_Value()))) 6896 ++PredCountMap[Pred]; 6897 } 6898 // Step 2: Sort the values so the most common predicates come first. 6899 stable_sort(ReducedVals, [&PredCountMap](Value *A, Value *B) { 6900 CmpInst::Predicate PredA, PredB; 6901 if (match(A, m_Cmp(PredA, m_Value(), m_Value())) && 6902 match(B, m_Cmp(PredB, m_Value(), m_Value()))) { 6903 return PredCountMap[PredA] > PredCountMap[PredB]; 6904 } 6905 return false; 6906 }); 6907 } 6908 6909 Value *VectorizedTree = nullptr; 6910 unsigned i = 0; 6911 while (i < NumReducedVals - ReduxWidth + 1 && ReduxWidth > 2) { 6912 ArrayRef<Value *> VL(&ReducedVals[i], ReduxWidth); 6913 V.buildTree(VL, ExternallyUsedValues, IgnoreList); 6914 Optional<ArrayRef<unsigned>> Order = V.bestOrder(); 6915 if (Order) { 6916 assert(Order->size() == VL.size() && 6917 "Order size must be the same as number of vectorized " 6918 "instructions."); 6919 // TODO: reorder tree nodes without tree rebuilding. 6920 SmallVector<Value *, 4> ReorderedOps(VL.size()); 6921 llvm::transform(*Order, ReorderedOps.begin(), 6922 [VL](const unsigned Idx) { return VL[Idx]; }); 6923 V.buildTree(ReorderedOps, ExternallyUsedValues, IgnoreList); 6924 } 6925 if (V.isTreeTinyAndNotFullyVectorizable()) 6926 break; 6927 if (V.isLoadCombineReductionCandidate(ReductionData.getOpcode())) 6928 break; 6929 6930 V.computeMinimumValueSizes(); 6931 6932 // Estimate cost. 6933 int TreeCost = V.getTreeCost(); 6934 int ReductionCost = getReductionCost(TTI, ReducedVals[i], ReduxWidth); 6935 int Cost = TreeCost + ReductionCost; 6936 if (Cost >= -SLPCostThreshold) { 6937 V.getORE()->emit([&]() { 6938 return OptimizationRemarkMissed(SV_NAME, "HorSLPNotBeneficial", 6939 cast<Instruction>(VL[0])) 6940 << "Vectorizing horizontal reduction is possible" 6941 << "but not beneficial with cost " << ore::NV("Cost", Cost) 6942 << " and threshold " 6943 << ore::NV("Threshold", -SLPCostThreshold); 6944 }); 6945 break; 6946 } 6947 6948 LLVM_DEBUG(dbgs() << "SLP: Vectorizing horizontal reduction at cost:" 6949 << Cost << ". (HorRdx)\n"); 6950 V.getORE()->emit([&]() { 6951 return OptimizationRemark(SV_NAME, "VectorizedHorizontalReduction", 6952 cast<Instruction>(VL[0])) 6953 << "Vectorized horizontal reduction with cost " 6954 << ore::NV("Cost", Cost) << " and with tree size " 6955 << ore::NV("TreeSize", V.getTreeSize()); 6956 }); 6957 6958 // Vectorize a tree. 6959 DebugLoc Loc = cast<Instruction>(ReducedVals[i])->getDebugLoc(); 6960 Value *VectorizedRoot = V.vectorizeTree(ExternallyUsedValues); 6961 6962 // Emit a reduction. For min/max, the root is a select, but the insertion 6963 // point is the compare condition of that select. 6964 Instruction *RdxRootInst = cast<Instruction>(ReductionRoot); 6965 if (ReductionData.isMinMax()) 6966 Builder.SetInsertPoint(getCmpForMinMaxReduction(RdxRootInst)); 6967 else 6968 Builder.SetInsertPoint(RdxRootInst); 6969 6970 Value *ReducedSubTree = 6971 emitReduction(VectorizedRoot, Builder, ReduxWidth, TTI); 6972 6973 if (!VectorizedTree) { 6974 // Initialize the final value in the reduction. 6975 VectorizedTree = ReducedSubTree; 6976 } else { 6977 // Update the final value in the reduction. 6978 Builder.SetCurrentDebugLocation(Loc); 6979 VectorizedTree = ReductionData.createOp( 6980 Builder, VectorizedTree, ReducedSubTree, "op.rdx", ReductionOps); 6981 } 6982 i += ReduxWidth; 6983 ReduxWidth = PowerOf2Floor(NumReducedVals - i); 6984 } 6985 6986 if (VectorizedTree) { 6987 // Finish the reduction. 6988 for (; i < NumReducedVals; ++i) { 6989 auto *I = cast<Instruction>(ReducedVals[i]); 6990 Builder.SetCurrentDebugLocation(I->getDebugLoc()); 6991 VectorizedTree = ReductionData.createOp(Builder, VectorizedTree, I, "", 6992 ReductionOps); 6993 } 6994 for (auto &Pair : ExternallyUsedValues) { 6995 // Add each externally used value to the final reduction. 6996 for (auto *I : Pair.second) { 6997 Builder.SetCurrentDebugLocation(I->getDebugLoc()); 6998 VectorizedTree = ReductionData.createOp(Builder, VectorizedTree, 6999 Pair.first, "op.extra", I); 7000 } 7001 } 7002 7003 // Update users. For a min/max reduction that ends with a compare and 7004 // select, we also have to RAUW for the compare instruction feeding the 7005 // reduction root. That's because the original compare may have extra uses 7006 // besides the final select of the reduction. 7007 if (ReductionData.isMinMax()) { 7008 if (auto *VecSelect = dyn_cast<SelectInst>(VectorizedTree)) { 7009 Instruction *ScalarCmp = 7010 getCmpForMinMaxReduction(cast<Instruction>(ReductionRoot)); 7011 ScalarCmp->replaceAllUsesWith(VecSelect->getCondition()); 7012 } 7013 } 7014 ReductionRoot->replaceAllUsesWith(VectorizedTree); 7015 7016 // Mark all scalar reduction ops for deletion, they are replaced by the 7017 // vector reductions. 7018 V.eraseInstructions(IgnoreList); 7019 } 7020 return VectorizedTree != nullptr; 7021 } 7022 7023 unsigned numReductionValues() const { 7024 return ReducedVals.size(); 7025 } 7026 7027 private: 7028 /// Calculate the cost of a reduction. 7029 int getReductionCost(TargetTransformInfo *TTI, Value *FirstReducedVal, 7030 unsigned ReduxWidth) { 7031 Type *ScalarTy = FirstReducedVal->getType(); 7032 auto *VecTy = FixedVectorType::get(ScalarTy, ReduxWidth); 7033 7034 int PairwiseRdxCost; 7035 int SplittingRdxCost; 7036 switch (ReductionData.getKind()) { 7037 case RK_Arithmetic: 7038 PairwiseRdxCost = 7039 TTI->getArithmeticReductionCost(ReductionData.getOpcode(), VecTy, 7040 /*IsPairwiseForm=*/true); 7041 SplittingRdxCost = 7042 TTI->getArithmeticReductionCost(ReductionData.getOpcode(), VecTy, 7043 /*IsPairwiseForm=*/false); 7044 break; 7045 case RK_SMin: 7046 case RK_SMax: 7047 case RK_UMin: 7048 case RK_UMax: { 7049 auto *VecCondTy = cast<VectorType>(CmpInst::makeCmpResultType(VecTy)); 7050 bool IsUnsigned = ReductionData.getKind() == RK_UMin || 7051 ReductionData.getKind() == RK_UMax; 7052 PairwiseRdxCost = 7053 TTI->getMinMaxReductionCost(VecTy, VecCondTy, 7054 /*IsPairwiseForm=*/true, IsUnsigned); 7055 SplittingRdxCost = 7056 TTI->getMinMaxReductionCost(VecTy, VecCondTy, 7057 /*IsPairwiseForm=*/false, IsUnsigned); 7058 break; 7059 } 7060 case RK_None: 7061 llvm_unreachable("Expected arithmetic or min/max reduction operation"); 7062 } 7063 7064 IsPairwiseReduction = PairwiseRdxCost < SplittingRdxCost; 7065 int VecReduxCost = IsPairwiseReduction ? PairwiseRdxCost : SplittingRdxCost; 7066 7067 int ScalarReduxCost = 0; 7068 switch (ReductionData.getKind()) { 7069 case RK_Arithmetic: 7070 ScalarReduxCost = 7071 TTI->getArithmeticInstrCost(ReductionData.getOpcode(), ScalarTy); 7072 break; 7073 case RK_SMin: 7074 case RK_SMax: 7075 case RK_UMin: 7076 case RK_UMax: 7077 ScalarReduxCost = 7078 TTI->getCmpSelInstrCost(ReductionData.getOpcode(), ScalarTy) + 7079 TTI->getCmpSelInstrCost(Instruction::Select, ScalarTy, 7080 CmpInst::makeCmpResultType(ScalarTy)); 7081 break; 7082 case RK_None: 7083 llvm_unreachable("Expected arithmetic or min/max reduction operation"); 7084 } 7085 ScalarReduxCost *= (ReduxWidth - 1); 7086 7087 LLVM_DEBUG(dbgs() << "SLP: Adding cost " << VecReduxCost - ScalarReduxCost 7088 << " for reduction that starts with " << *FirstReducedVal 7089 << " (It is a " 7090 << (IsPairwiseReduction ? "pairwise" : "splitting") 7091 << " reduction)\n"); 7092 7093 return VecReduxCost - ScalarReduxCost; 7094 } 7095 7096 /// Emit a horizontal reduction of the vectorized value. 7097 Value *emitReduction(Value *VectorizedValue, IRBuilder<> &Builder, 7098 unsigned ReduxWidth, const TargetTransformInfo *TTI) { 7099 assert(VectorizedValue && "Need to have a vectorized tree node"); 7100 assert(isPowerOf2_32(ReduxWidth) && 7101 "We only handle power-of-two reductions for now"); 7102 7103 if (!IsPairwiseReduction) { 7104 // FIXME: The builder should use an FMF guard. It should not be hard-coded 7105 // to 'fast'. 7106 assert(Builder.getFastMathFlags().isFast() && "Expected 'fast' FMF"); 7107 return createSimpleTargetReduction( 7108 Builder, TTI, ReductionData.getOpcode(), VectorizedValue, 7109 ReductionData.getFlags(), ReductionOps.back()); 7110 } 7111 7112 Value *TmpVec = VectorizedValue; 7113 for (unsigned i = ReduxWidth / 2; i != 0; i >>= 1) { 7114 auto LeftMask = createRdxShuffleMask(ReduxWidth, i, true, true); 7115 auto RightMask = createRdxShuffleMask(ReduxWidth, i, true, false); 7116 7117 Value *LeftShuf = 7118 Builder.CreateShuffleVector(TmpVec, LeftMask, "rdx.shuf.l"); 7119 Value *RightShuf = 7120 Builder.CreateShuffleVector(TmpVec, RightMask, "rdx.shuf.r"); 7121 TmpVec = ReductionData.createOp(Builder, LeftShuf, RightShuf, "op.rdx", 7122 ReductionOps); 7123 } 7124 7125 // The result is in the first element of the vector. 7126 return Builder.CreateExtractElement(TmpVec, Builder.getInt32(0)); 7127 } 7128 }; 7129 7130 } // end anonymous namespace 7131 7132 static Optional<unsigned> getAggregateSize(Instruction *InsertInst) { 7133 if (auto *IE = dyn_cast<InsertElementInst>(InsertInst)) 7134 return cast<FixedVectorType>(IE->getType())->getNumElements(); 7135 7136 unsigned AggregateSize = 1; 7137 auto *IV = cast<InsertValueInst>(InsertInst); 7138 Type *CurrentType = IV->getType(); 7139 do { 7140 if (auto *ST = dyn_cast<StructType>(CurrentType)) { 7141 for (auto *Elt : ST->elements()) 7142 if (Elt != ST->getElementType(0)) // check homogeneity 7143 return None; 7144 AggregateSize *= ST->getNumElements(); 7145 CurrentType = ST->getElementType(0); 7146 } else if (auto *AT = dyn_cast<ArrayType>(CurrentType)) { 7147 AggregateSize *= AT->getNumElements(); 7148 CurrentType = AT->getElementType(); 7149 } else if (auto *VT = dyn_cast<FixedVectorType>(CurrentType)) { 7150 AggregateSize *= VT->getNumElements(); 7151 return AggregateSize; 7152 } else if (CurrentType->isSingleValueType()) { 7153 return AggregateSize; 7154 } else { 7155 return None; 7156 } 7157 } while (true); 7158 } 7159 7160 static Optional<unsigned> getOperandIndex(Instruction *InsertInst, 7161 unsigned OperandOffset) { 7162 unsigned OperandIndex = OperandOffset; 7163 if (auto *IE = dyn_cast<InsertElementInst>(InsertInst)) { 7164 if (auto *CI = dyn_cast<ConstantInt>(IE->getOperand(2))) { 7165 auto *VT = cast<FixedVectorType>(IE->getType()); 7166 OperandIndex *= VT->getNumElements(); 7167 OperandIndex += CI->getZExtValue(); 7168 return OperandIndex; 7169 } 7170 return None; 7171 } 7172 7173 auto *IV = cast<InsertValueInst>(InsertInst); 7174 Type *CurrentType = IV->getType(); 7175 for (unsigned int Index : IV->indices()) { 7176 if (auto *ST = dyn_cast<StructType>(CurrentType)) { 7177 OperandIndex *= ST->getNumElements(); 7178 CurrentType = ST->getElementType(Index); 7179 } else if (auto *AT = dyn_cast<ArrayType>(CurrentType)) { 7180 OperandIndex *= AT->getNumElements(); 7181 CurrentType = AT->getElementType(); 7182 } else { 7183 return None; 7184 } 7185 OperandIndex += Index; 7186 } 7187 return OperandIndex; 7188 } 7189 7190 static bool findBuildAggregate_rec(Instruction *LastInsertInst, 7191 TargetTransformInfo *TTI, 7192 SmallVectorImpl<Value *> &BuildVectorOpds, 7193 SmallVectorImpl<Value *> &InsertElts, 7194 unsigned OperandOffset) { 7195 do { 7196 Value *InsertedOperand = LastInsertInst->getOperand(1); 7197 Optional<unsigned> OperandIndex = 7198 getOperandIndex(LastInsertInst, OperandOffset); 7199 if (!OperandIndex) 7200 return false; 7201 if (isa<InsertElementInst>(InsertedOperand) || 7202 isa<InsertValueInst>(InsertedOperand)) { 7203 if (!findBuildAggregate_rec(cast<Instruction>(InsertedOperand), TTI, 7204 BuildVectorOpds, InsertElts, *OperandIndex)) 7205 return false; 7206 } else { 7207 BuildVectorOpds[*OperandIndex] = InsertedOperand; 7208 InsertElts[*OperandIndex] = LastInsertInst; 7209 } 7210 if (isa<UndefValue>(LastInsertInst->getOperand(0))) 7211 return true; 7212 LastInsertInst = dyn_cast<Instruction>(LastInsertInst->getOperand(0)); 7213 } while (LastInsertInst != nullptr && 7214 (isa<InsertValueInst>(LastInsertInst) || 7215 isa<InsertElementInst>(LastInsertInst)) && 7216 LastInsertInst->hasOneUse()); 7217 return false; 7218 } 7219 7220 /// Recognize construction of vectors like 7221 /// %ra = insertelement <4 x float> undef, float %s0, i32 0 7222 /// %rb = insertelement <4 x float> %ra, float %s1, i32 1 7223 /// %rc = insertelement <4 x float> %rb, float %s2, i32 2 7224 /// %rd = insertelement <4 x float> %rc, float %s3, i32 3 7225 /// starting from the last insertelement or insertvalue instruction. 7226 /// 7227 /// Also recognize homogeneous aggregates like {<2 x float>, <2 x float>}, 7228 /// {{float, float}, {float, float}}, [2 x {float, float}] and so on. 7229 /// See llvm/test/Transforms/SLPVectorizer/X86/pr42022.ll for examples. 7230 /// 7231 /// Assume LastInsertInst is of InsertElementInst or InsertValueInst type. 7232 /// 7233 /// \return true if it matches. 7234 static bool findBuildAggregate(Instruction *LastInsertInst, 7235 TargetTransformInfo *TTI, 7236 SmallVectorImpl<Value *> &BuildVectorOpds, 7237 SmallVectorImpl<Value *> &InsertElts) { 7238 7239 assert((isa<InsertElementInst>(LastInsertInst) || 7240 isa<InsertValueInst>(LastInsertInst)) && 7241 "Expected insertelement or insertvalue instruction!"); 7242 7243 assert((BuildVectorOpds.empty() && InsertElts.empty()) && 7244 "Expected empty result vectors!"); 7245 7246 Optional<unsigned> AggregateSize = getAggregateSize(LastInsertInst); 7247 if (!AggregateSize) 7248 return false; 7249 BuildVectorOpds.resize(*AggregateSize); 7250 InsertElts.resize(*AggregateSize); 7251 7252 if (findBuildAggregate_rec(LastInsertInst, TTI, BuildVectorOpds, InsertElts, 7253 0)) { 7254 llvm::erase_if(BuildVectorOpds, 7255 [](const Value *V) { return V == nullptr; }); 7256 llvm::erase_if(InsertElts, [](const Value *V) { return V == nullptr; }); 7257 if (BuildVectorOpds.size() >= 2) 7258 return true; 7259 } 7260 7261 return false; 7262 } 7263 7264 static bool PhiTypeSorterFunc(Value *V, Value *V2) { 7265 return V->getType() < V2->getType(); 7266 } 7267 7268 /// Try and get a reduction value from a phi node. 7269 /// 7270 /// Given a phi node \p P in a block \p ParentBB, consider possible reductions 7271 /// if they come from either \p ParentBB or a containing loop latch. 7272 /// 7273 /// \returns A candidate reduction value if possible, or \code nullptr \endcode 7274 /// if not possible. 7275 static Value *getReductionValue(const DominatorTree *DT, PHINode *P, 7276 BasicBlock *ParentBB, LoopInfo *LI) { 7277 // There are situations where the reduction value is not dominated by the 7278 // reduction phi. Vectorizing such cases has been reported to cause 7279 // miscompiles. See PR25787. 7280 auto DominatedReduxValue = [&](Value *R) { 7281 return isa<Instruction>(R) && 7282 DT->dominates(P->getParent(), cast<Instruction>(R)->getParent()); 7283 }; 7284 7285 Value *Rdx = nullptr; 7286 7287 // Return the incoming value if it comes from the same BB as the phi node. 7288 if (P->getIncomingBlock(0) == ParentBB) { 7289 Rdx = P->getIncomingValue(0); 7290 } else if (P->getIncomingBlock(1) == ParentBB) { 7291 Rdx = P->getIncomingValue(1); 7292 } 7293 7294 if (Rdx && DominatedReduxValue(Rdx)) 7295 return Rdx; 7296 7297 // Otherwise, check whether we have a loop latch to look at. 7298 Loop *BBL = LI->getLoopFor(ParentBB); 7299 if (!BBL) 7300 return nullptr; 7301 BasicBlock *BBLatch = BBL->getLoopLatch(); 7302 if (!BBLatch) 7303 return nullptr; 7304 7305 // There is a loop latch, return the incoming value if it comes from 7306 // that. This reduction pattern occasionally turns up. 7307 if (P->getIncomingBlock(0) == BBLatch) { 7308 Rdx = P->getIncomingValue(0); 7309 } else if (P->getIncomingBlock(1) == BBLatch) { 7310 Rdx = P->getIncomingValue(1); 7311 } 7312 7313 if (Rdx && DominatedReduxValue(Rdx)) 7314 return Rdx; 7315 7316 return nullptr; 7317 } 7318 7319 /// Attempt to reduce a horizontal reduction. 7320 /// If it is legal to match a horizontal reduction feeding the phi node \a P 7321 /// with reduction operators \a Root (or one of its operands) in a basic block 7322 /// \a BB, then check if it can be done. If horizontal reduction is not found 7323 /// and root instruction is a binary operation, vectorization of the operands is 7324 /// attempted. 7325 /// \returns true if a horizontal reduction was matched and reduced or operands 7326 /// of one of the binary instruction were vectorized. 7327 /// \returns false if a horizontal reduction was not matched (or not possible) 7328 /// or no vectorization of any binary operation feeding \a Root instruction was 7329 /// performed. 7330 static bool tryToVectorizeHorReductionOrInstOperands( 7331 PHINode *P, Instruction *Root, BasicBlock *BB, BoUpSLP &R, 7332 TargetTransformInfo *TTI, 7333 const function_ref<bool(Instruction *, BoUpSLP &)> Vectorize) { 7334 if (!ShouldVectorizeHor) 7335 return false; 7336 7337 if (!Root) 7338 return false; 7339 7340 if (Root->getParent() != BB || isa<PHINode>(Root)) 7341 return false; 7342 // Start analysis starting from Root instruction. If horizontal reduction is 7343 // found, try to vectorize it. If it is not a horizontal reduction or 7344 // vectorization is not possible or not effective, and currently analyzed 7345 // instruction is a binary operation, try to vectorize the operands, using 7346 // pre-order DFS traversal order. If the operands were not vectorized, repeat 7347 // the same procedure considering each operand as a possible root of the 7348 // horizontal reduction. 7349 // Interrupt the process if the Root instruction itself was vectorized or all 7350 // sub-trees not higher that RecursionMaxDepth were analyzed/vectorized. 7351 SmallVector<std::pair<Instruction *, unsigned>, 8> Stack(1, {Root, 0}); 7352 SmallPtrSet<Value *, 8> VisitedInstrs; 7353 bool Res = false; 7354 while (!Stack.empty()) { 7355 Instruction *Inst; 7356 unsigned Level; 7357 std::tie(Inst, Level) = Stack.pop_back_val(); 7358 auto *BI = dyn_cast<BinaryOperator>(Inst); 7359 auto *SI = dyn_cast<SelectInst>(Inst); 7360 if (BI || SI) { 7361 HorizontalReduction HorRdx; 7362 if (HorRdx.matchAssociativeReduction(P, Inst)) { 7363 if (HorRdx.tryToReduce(R, TTI)) { 7364 Res = true; 7365 // Set P to nullptr to avoid re-analysis of phi node in 7366 // matchAssociativeReduction function unless this is the root node. 7367 P = nullptr; 7368 continue; 7369 } 7370 } 7371 if (P && BI) { 7372 Inst = dyn_cast<Instruction>(BI->getOperand(0)); 7373 if (Inst == P) 7374 Inst = dyn_cast<Instruction>(BI->getOperand(1)); 7375 if (!Inst) { 7376 // Set P to nullptr to avoid re-analysis of phi node in 7377 // matchAssociativeReduction function unless this is the root node. 7378 P = nullptr; 7379 continue; 7380 } 7381 } 7382 } 7383 // Set P to nullptr to avoid re-analysis of phi node in 7384 // matchAssociativeReduction function unless this is the root node. 7385 P = nullptr; 7386 if (Vectorize(Inst, R)) { 7387 Res = true; 7388 continue; 7389 } 7390 7391 // Try to vectorize operands. 7392 // Continue analysis for the instruction from the same basic block only to 7393 // save compile time. 7394 if (++Level < RecursionMaxDepth) 7395 for (auto *Op : Inst->operand_values()) 7396 if (VisitedInstrs.insert(Op).second) 7397 if (auto *I = dyn_cast<Instruction>(Op)) 7398 if (!isa<PHINode>(I) && !R.isDeleted(I) && I->getParent() == BB) 7399 Stack.emplace_back(I, Level); 7400 } 7401 return Res; 7402 } 7403 7404 bool SLPVectorizerPass::vectorizeRootInstruction(PHINode *P, Value *V, 7405 BasicBlock *BB, BoUpSLP &R, 7406 TargetTransformInfo *TTI) { 7407 auto *I = dyn_cast_or_null<Instruction>(V); 7408 if (!I) 7409 return false; 7410 7411 if (!isa<BinaryOperator>(I)) 7412 P = nullptr; 7413 // Try to match and vectorize a horizontal reduction. 7414 auto &&ExtraVectorization = [this](Instruction *I, BoUpSLP &R) -> bool { 7415 return tryToVectorize(I, R); 7416 }; 7417 return tryToVectorizeHorReductionOrInstOperands(P, I, BB, R, TTI, 7418 ExtraVectorization); 7419 } 7420 7421 bool SLPVectorizerPass::vectorizeInsertValueInst(InsertValueInst *IVI, 7422 BasicBlock *BB, BoUpSLP &R) { 7423 const DataLayout &DL = BB->getModule()->getDataLayout(); 7424 if (!R.canMapToVector(IVI->getType(), DL)) 7425 return false; 7426 7427 SmallVector<Value *, 16> BuildVectorOpds; 7428 SmallVector<Value *, 16> BuildVectorInsts; 7429 if (!findBuildAggregate(IVI, TTI, BuildVectorOpds, BuildVectorInsts)) 7430 return false; 7431 7432 LLVM_DEBUG(dbgs() << "SLP: array mappable to vector: " << *IVI << "\n"); 7433 // Aggregate value is unlikely to be processed in vector register, we need to 7434 // extract scalars into scalar registers, so NeedExtraction is set true. 7435 return tryToVectorizeList(BuildVectorOpds, R, /*AllowReorder=*/false, 7436 BuildVectorInsts); 7437 } 7438 7439 bool SLPVectorizerPass::vectorizeInsertElementInst(InsertElementInst *IEI, 7440 BasicBlock *BB, BoUpSLP &R) { 7441 SmallVector<Value *, 16> BuildVectorInsts; 7442 SmallVector<Value *, 16> BuildVectorOpds; 7443 if (!findBuildAggregate(IEI, TTI, BuildVectorOpds, BuildVectorInsts) || 7444 (llvm::all_of(BuildVectorOpds, 7445 [](Value *V) { return isa<ExtractElementInst>(V); }) && 7446 isShuffle(BuildVectorOpds))) 7447 return false; 7448 7449 // Vectorize starting with the build vector operands ignoring the BuildVector 7450 // instructions for the purpose of scheduling and user extraction. 7451 return tryToVectorizeList(BuildVectorOpds, R, /*AllowReorder=*/false, 7452 BuildVectorInsts); 7453 } 7454 7455 bool SLPVectorizerPass::vectorizeCmpInst(CmpInst *CI, BasicBlock *BB, 7456 BoUpSLP &R) { 7457 if (tryToVectorizePair(CI->getOperand(0), CI->getOperand(1), R)) 7458 return true; 7459 7460 bool OpsChanged = false; 7461 for (int Idx = 0; Idx < 2; ++Idx) { 7462 OpsChanged |= 7463 vectorizeRootInstruction(nullptr, CI->getOperand(Idx), BB, R, TTI); 7464 } 7465 return OpsChanged; 7466 } 7467 7468 bool SLPVectorizerPass::vectorizeSimpleInstructions( 7469 SmallVectorImpl<Instruction *> &Instructions, BasicBlock *BB, BoUpSLP &R) { 7470 bool OpsChanged = false; 7471 for (auto *I : reverse(Instructions)) { 7472 if (R.isDeleted(I)) 7473 continue; 7474 if (auto *LastInsertValue = dyn_cast<InsertValueInst>(I)) 7475 OpsChanged |= vectorizeInsertValueInst(LastInsertValue, BB, R); 7476 else if (auto *LastInsertElem = dyn_cast<InsertElementInst>(I)) 7477 OpsChanged |= vectorizeInsertElementInst(LastInsertElem, BB, R); 7478 else if (auto *CI = dyn_cast<CmpInst>(I)) 7479 OpsChanged |= vectorizeCmpInst(CI, BB, R); 7480 } 7481 Instructions.clear(); 7482 return OpsChanged; 7483 } 7484 7485 bool SLPVectorizerPass::vectorizeChainsInBlock(BasicBlock *BB, BoUpSLP &R) { 7486 bool Changed = false; 7487 SmallVector<Value *, 4> Incoming; 7488 SmallPtrSet<Value *, 16> VisitedInstrs; 7489 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 7490 7491 bool HaveVectorizedPhiNodes = true; 7492 while (HaveVectorizedPhiNodes) { 7493 HaveVectorizedPhiNodes = false; 7494 7495 // Collect the incoming values from the PHIs. 7496 Incoming.clear(); 7497 for (Instruction &I : *BB) { 7498 PHINode *P = dyn_cast<PHINode>(&I); 7499 if (!P) 7500 break; 7501 7502 if (!VisitedInstrs.count(P) && !R.isDeleted(P)) 7503 Incoming.push_back(P); 7504 } 7505 7506 // Sort by type. 7507 llvm::stable_sort(Incoming, PhiTypeSorterFunc); 7508 7509 // Try to vectorize elements base on their type. 7510 for (SmallVector<Value *, 4>::iterator IncIt = Incoming.begin(), 7511 E = Incoming.end(); 7512 IncIt != E;) { 7513 7514 // Look for the next elements with the same type. 7515 SmallVector<Value *, 4>::iterator SameTypeIt = IncIt; 7516 Type *EltTy = (*IncIt)->getType(); 7517 7518 assert(EltTy->isSized() && 7519 "Instructions should all be sized at this point"); 7520 TypeSize EltTS = DL->getTypeSizeInBits(EltTy); 7521 if (EltTS.isScalable()) { 7522 // For now, just ignore vectorizing scalable types. 7523 ++IncIt; 7524 continue; 7525 } 7526 7527 unsigned EltSize = EltTS.getFixedSize(); 7528 unsigned MaxNumElts = MaxVecRegSize / EltSize; 7529 if (MaxNumElts < 2) { 7530 ++IncIt; 7531 continue; 7532 } 7533 7534 while (SameTypeIt != E && 7535 (*SameTypeIt)->getType() == EltTy && 7536 static_cast<unsigned>(SameTypeIt - IncIt) < MaxNumElts) { 7537 VisitedInstrs.insert(*SameTypeIt); 7538 ++SameTypeIt; 7539 } 7540 7541 // Try to vectorize them. 7542 unsigned NumElts = (SameTypeIt - IncIt); 7543 LLVM_DEBUG(dbgs() << "SLP: Trying to vectorize starting at PHIs (" 7544 << NumElts << ")\n"); 7545 // The order in which the phi nodes appear in the program does not matter. 7546 // So allow tryToVectorizeList to reorder them if it is beneficial. This 7547 // is done when there are exactly two elements since tryToVectorizeList 7548 // asserts that there are only two values when AllowReorder is true. 7549 bool AllowReorder = NumElts == 2; 7550 if (NumElts > 1 && 7551 tryToVectorizeList(makeArrayRef(IncIt, NumElts), R, AllowReorder)) { 7552 // Success start over because instructions might have been changed. 7553 HaveVectorizedPhiNodes = true; 7554 Changed = true; 7555 break; 7556 } 7557 7558 // Start over at the next instruction of a different type (or the end). 7559 IncIt = SameTypeIt; 7560 } 7561 } 7562 7563 VisitedInstrs.clear(); 7564 7565 SmallVector<Instruction *, 8> PostProcessInstructions; 7566 SmallDenseSet<Instruction *, 4> KeyNodes; 7567 for (BasicBlock::iterator it = BB->begin(), e = BB->end(); it != e; ++it) { 7568 // Skip instructions with scalable type. The num of elements is unknown at 7569 // compile-time for scalable type. 7570 if (isa<ScalableVectorType>(it->getType())) 7571 continue; 7572 7573 // Skip instructions marked for the deletion. 7574 if (R.isDeleted(&*it)) 7575 continue; 7576 // We may go through BB multiple times so skip the one we have checked. 7577 if (!VisitedInstrs.insert(&*it).second) { 7578 if (it->use_empty() && KeyNodes.count(&*it) > 0 && 7579 vectorizeSimpleInstructions(PostProcessInstructions, BB, R)) { 7580 // We would like to start over since some instructions are deleted 7581 // and the iterator may become invalid value. 7582 Changed = true; 7583 it = BB->begin(); 7584 e = BB->end(); 7585 } 7586 continue; 7587 } 7588 7589 if (isa<DbgInfoIntrinsic>(it)) 7590 continue; 7591 7592 // Try to vectorize reductions that use PHINodes. 7593 if (PHINode *P = dyn_cast<PHINode>(it)) { 7594 // Check that the PHI is a reduction PHI. 7595 if (P->getNumIncomingValues() != 2) 7596 return Changed; 7597 7598 // Try to match and vectorize a horizontal reduction. 7599 if (vectorizeRootInstruction(P, getReductionValue(DT, P, BB, LI), BB, R, 7600 TTI)) { 7601 Changed = true; 7602 it = BB->begin(); 7603 e = BB->end(); 7604 continue; 7605 } 7606 continue; 7607 } 7608 7609 // Ran into an instruction without users, like terminator, or function call 7610 // with ignored return value, store. Ignore unused instructions (basing on 7611 // instruction type, except for CallInst and InvokeInst). 7612 if (it->use_empty() && (it->getType()->isVoidTy() || isa<CallInst>(it) || 7613 isa<InvokeInst>(it))) { 7614 KeyNodes.insert(&*it); 7615 bool OpsChanged = false; 7616 if (ShouldStartVectorizeHorAtStore || !isa<StoreInst>(it)) { 7617 for (auto *V : it->operand_values()) { 7618 // Try to match and vectorize a horizontal reduction. 7619 OpsChanged |= vectorizeRootInstruction(nullptr, V, BB, R, TTI); 7620 } 7621 } 7622 // Start vectorization of post-process list of instructions from the 7623 // top-tree instructions to try to vectorize as many instructions as 7624 // possible. 7625 OpsChanged |= vectorizeSimpleInstructions(PostProcessInstructions, BB, R); 7626 if (OpsChanged) { 7627 // We would like to start over since some instructions are deleted 7628 // and the iterator may become invalid value. 7629 Changed = true; 7630 it = BB->begin(); 7631 e = BB->end(); 7632 continue; 7633 } 7634 } 7635 7636 if (isa<InsertElementInst>(it) || isa<CmpInst>(it) || 7637 isa<InsertValueInst>(it)) 7638 PostProcessInstructions.push_back(&*it); 7639 } 7640 7641 return Changed; 7642 } 7643 7644 bool SLPVectorizerPass::vectorizeGEPIndices(BasicBlock *BB, BoUpSLP &R) { 7645 auto Changed = false; 7646 for (auto &Entry : GEPs) { 7647 // If the getelementptr list has fewer than two elements, there's nothing 7648 // to do. 7649 if (Entry.second.size() < 2) 7650 continue; 7651 7652 LLVM_DEBUG(dbgs() << "SLP: Analyzing a getelementptr list of length " 7653 << Entry.second.size() << ".\n"); 7654 7655 // Process the GEP list in chunks suitable for the target's supported 7656 // vector size. If a vector register can't hold 1 element, we are done. We 7657 // are trying to vectorize the index computations, so the maximum number of 7658 // elements is based on the size of the index expression, rather than the 7659 // size of the GEP itself (the target's pointer size). 7660 unsigned MaxVecRegSize = R.getMaxVecRegSize(); 7661 unsigned EltSize = R.getVectorElementSize(*Entry.second[0]->idx_begin()); 7662 if (MaxVecRegSize < EltSize) 7663 continue; 7664 7665 unsigned MaxElts = MaxVecRegSize / EltSize; 7666 for (unsigned BI = 0, BE = Entry.second.size(); BI < BE; BI += MaxElts) { 7667 auto Len = std::min<unsigned>(BE - BI, MaxElts); 7668 ArrayRef<GetElementPtrInst *> GEPList(&Entry.second[BI], Len); 7669 7670 // Initialize a set a candidate getelementptrs. Note that we use a 7671 // SetVector here to preserve program order. If the index computations 7672 // are vectorizable and begin with loads, we want to minimize the chance 7673 // of having to reorder them later. 7674 SetVector<Value *> Candidates(GEPList.begin(), GEPList.end()); 7675 7676 // Some of the candidates may have already been vectorized after we 7677 // initially collected them. If so, they are marked as deleted, so remove 7678 // them from the set of candidates. 7679 Candidates.remove_if( 7680 [&R](Value *I) { return R.isDeleted(cast<Instruction>(I)); }); 7681 7682 // Remove from the set of candidates all pairs of getelementptrs with 7683 // constant differences. Such getelementptrs are likely not good 7684 // candidates for vectorization in a bottom-up phase since one can be 7685 // computed from the other. We also ensure all candidate getelementptr 7686 // indices are unique. 7687 for (int I = 0, E = GEPList.size(); I < E && Candidates.size() > 1; ++I) { 7688 auto *GEPI = GEPList[I]; 7689 if (!Candidates.count(GEPI)) 7690 continue; 7691 auto *SCEVI = SE->getSCEV(GEPList[I]); 7692 for (int J = I + 1; J < E && Candidates.size() > 1; ++J) { 7693 auto *GEPJ = GEPList[J]; 7694 auto *SCEVJ = SE->getSCEV(GEPList[J]); 7695 if (isa<SCEVConstant>(SE->getMinusSCEV(SCEVI, SCEVJ))) { 7696 Candidates.remove(GEPI); 7697 Candidates.remove(GEPJ); 7698 } else if (GEPI->idx_begin()->get() == GEPJ->idx_begin()->get()) { 7699 Candidates.remove(GEPJ); 7700 } 7701 } 7702 } 7703 7704 // We break out of the above computation as soon as we know there are 7705 // fewer than two candidates remaining. 7706 if (Candidates.size() < 2) 7707 continue; 7708 7709 // Add the single, non-constant index of each candidate to the bundle. We 7710 // ensured the indices met these constraints when we originally collected 7711 // the getelementptrs. 7712 SmallVector<Value *, 16> Bundle(Candidates.size()); 7713 auto BundleIndex = 0u; 7714 for (auto *V : Candidates) { 7715 auto *GEP = cast<GetElementPtrInst>(V); 7716 auto *GEPIdx = GEP->idx_begin()->get(); 7717 assert(GEP->getNumIndices() == 1 || !isa<Constant>(GEPIdx)); 7718 Bundle[BundleIndex++] = GEPIdx; 7719 } 7720 7721 // Try and vectorize the indices. We are currently only interested in 7722 // gather-like cases of the form: 7723 // 7724 // ... = g[a[0] - b[0]] + g[a[1] - b[1]] + ... 7725 // 7726 // where the loads of "a", the loads of "b", and the subtractions can be 7727 // performed in parallel. It's likely that detecting this pattern in a 7728 // bottom-up phase will be simpler and less costly than building a 7729 // full-blown top-down phase beginning at the consecutive loads. 7730 Changed |= tryToVectorizeList(Bundle, R); 7731 } 7732 } 7733 return Changed; 7734 } 7735 7736 bool SLPVectorizerPass::vectorizeStoreChains(BoUpSLP &R) { 7737 bool Changed = false; 7738 // Attempt to sort and vectorize each of the store-groups. 7739 for (StoreListMap::iterator it = Stores.begin(), e = Stores.end(); it != e; 7740 ++it) { 7741 if (it->second.size() < 2) 7742 continue; 7743 7744 LLVM_DEBUG(dbgs() << "SLP: Analyzing a store chain of length " 7745 << it->second.size() << ".\n"); 7746 7747 Changed |= vectorizeStores(it->second, R); 7748 } 7749 return Changed; 7750 } 7751 7752 char SLPVectorizer::ID = 0; 7753 7754 static const char lv_name[] = "SLP Vectorizer"; 7755 7756 INITIALIZE_PASS_BEGIN(SLPVectorizer, SV_NAME, lv_name, false, false) 7757 INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass) 7758 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass) 7759 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 7760 INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass) 7761 INITIALIZE_PASS_DEPENDENCY(LoopSimplify) 7762 INITIALIZE_PASS_DEPENDENCY(DemandedBitsWrapperPass) 7763 INITIALIZE_PASS_DEPENDENCY(OptimizationRemarkEmitterWrapperPass) 7764 INITIALIZE_PASS_DEPENDENCY(InjectTLIMappingsLegacy) 7765 INITIALIZE_PASS_END(SLPVectorizer, SV_NAME, lv_name, false, false) 7766 7767 Pass *llvm::createSLPVectorizerPass() { return new SLPVectorizer(); } 7768