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