11f58dda4SAyal Zaks //===- VPlan.cpp - Vectorizer Plan ----------------------------------------===//
21f58dda4SAyal Zaks //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
61f58dda4SAyal Zaks //
71f58dda4SAyal Zaks //===----------------------------------------------------------------------===//
81f58dda4SAyal Zaks ///
91f58dda4SAyal Zaks /// \file
101f58dda4SAyal Zaks /// This is the LLVM vectorization plan. It represents a candidate for
111f58dda4SAyal Zaks /// vectorization, allowing to plan and optimize how to vectorize a given loop
121f58dda4SAyal Zaks /// before generating LLVM-IR.
131f58dda4SAyal Zaks /// The vectorizer uses vectorization plans to estimate the costs of potential
141f58dda4SAyal Zaks /// candidates and if profitable to execute the desired plan, generating vector
151f58dda4SAyal Zaks /// LLVM-IR code.
161f58dda4SAyal Zaks ///
171f58dda4SAyal Zaks //===----------------------------------------------------------------------===//
181f58dda4SAyal Zaks 
191f58dda4SAyal Zaks #include "VPlan.h"
202a34ac86SDiego Caballero #include "VPlanDominatorTree.h"
216cadde7fSEugene Zelenko #include "llvm/ADT/DepthFirstIterator.h"
221f58dda4SAyal Zaks #include "llvm/ADT/PostOrderIterator.h"
23533f8576SFlorian Hahn #include "llvm/ADT/STLExtras.h"
246cadde7fSEugene Zelenko #include "llvm/ADT/SmallVector.h"
256cadde7fSEugene Zelenko #include "llvm/ADT/Twine.h"
2600a66011SDavid Green #include "llvm/Analysis/IVDescriptors.h"
271f58dda4SAyal Zaks #include "llvm/Analysis/LoopInfo.h"
281f58dda4SAyal Zaks #include "llvm/IR/BasicBlock.h"
296cadde7fSEugene Zelenko #include "llvm/IR/CFG.h"
306cadde7fSEugene Zelenko #include "llvm/IR/InstrTypes.h"
316cadde7fSEugene Zelenko #include "llvm/IR/Instruction.h"
326cadde7fSEugene Zelenko #include "llvm/IR/Instructions.h"
336cadde7fSEugene Zelenko #include "llvm/IR/Type.h"
346cadde7fSEugene Zelenko #include "llvm/IR/Value.h"
356cadde7fSEugene Zelenko #include "llvm/Support/Casting.h"
364c1a1d3cSReid Kleckner #include "llvm/Support/CommandLine.h"
376cadde7fSEugene Zelenko #include "llvm/Support/Debug.h"
386cadde7fSEugene Zelenko #include "llvm/Support/ErrorHandling.h"
392a34ac86SDiego Caballero #include "llvm/Support/GenericDomTreeConstruction.h"
401f58dda4SAyal Zaks #include "llvm/Support/GraphWriter.h"
416cadde7fSEugene Zelenko #include "llvm/Support/raw_ostream.h"
421f58dda4SAyal Zaks #include "llvm/Transforms/Utils/BasicBlockUtils.h"
436cadde7fSEugene Zelenko #include <cassert>
446cadde7fSEugene Zelenko #include <iterator>
456cadde7fSEugene Zelenko #include <string>
466cadde7fSEugene Zelenko #include <vector>
471f58dda4SAyal Zaks 
481f58dda4SAyal Zaks using namespace llvm;
49ea7f3035SHideki Saito extern cl::opt<bool> EnableVPlanNativePath;
501f58dda4SAyal Zaks 
511f58dda4SAyal Zaks #define DEBUG_TYPE "vplan"
521f58dda4SAyal Zaks 
5392205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
548b9d1f3cSGil Rapaport raw_ostream &llvm::operator<<(raw_ostream &OS, const VPValue &V) {
5540e7bfc4SFlorian Hahn   const VPInstruction *Instr = dyn_cast<VPInstruction>(&V);
5640e7bfc4SFlorian Hahn   VPSlotTracker SlotTracker(
5740e7bfc4SFlorian Hahn       (Instr && Instr->getParent()) ? Instr->getParent()->getPlan() : nullptr);
5840e7bfc4SFlorian Hahn   V.print(OS, SlotTracker);
598b9d1f3cSGil Rapaport   return OS;
608b9d1f3cSGil Rapaport }
6192205cb2SAndrei Elovikov #endif
628b9d1f3cSGil Rapaport 
63fec0a0adSDavid Sherwood Value *VPLane::getAsRuntimeExpr(IRBuilder<> &Builder,
64fec0a0adSDavid Sherwood                                 const ElementCount &VF) const {
65fec0a0adSDavid Sherwood   switch (LaneKind) {
66fec0a0adSDavid Sherwood   case VPLane::Kind::ScalableLast:
67fec0a0adSDavid Sherwood     // Lane = RuntimeVF - VF.getKnownMinValue() + Lane
68fec0a0adSDavid Sherwood     return Builder.CreateSub(getRuntimeVF(Builder, Builder.getInt32Ty(), VF),
69fec0a0adSDavid Sherwood                              Builder.getInt32(VF.getKnownMinValue() - Lane));
70fec0a0adSDavid Sherwood   case VPLane::Kind::First:
71fec0a0adSDavid Sherwood     return Builder.getInt32(Lane);
72fec0a0adSDavid Sherwood   }
73fec0a0adSDavid Sherwood   llvm_unreachable("Unknown lane kind");
74fec0a0adSDavid Sherwood }
75fec0a0adSDavid Sherwood 
7652f3714dSFlorian Hahn VPValue::VPValue(const unsigned char SC, Value *UV, VPDef *Def)
7752f3714dSFlorian Hahn     : SubclassID(SC), UnderlyingVal(UV), Def(Def) {
7852f3714dSFlorian Hahn   if (Def)
7952f3714dSFlorian Hahn     Def->addDefinedValue(this);
8052f3714dSFlorian Hahn }
8152f3714dSFlorian Hahn 
8252f3714dSFlorian Hahn VPValue::~VPValue() {
8352f3714dSFlorian Hahn   assert(Users.empty() && "trying to delete a VPValue with remaining users");
8452f3714dSFlorian Hahn   if (Def)
8552f3714dSFlorian Hahn     Def->removeDefinedValue(this);
8652f3714dSFlorian Hahn }
8752f3714dSFlorian Hahn 
8892205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
8940e7bfc4SFlorian Hahn void VPValue::print(raw_ostream &OS, VPSlotTracker &SlotTracker) const {
90eb0371e4SFlorian Hahn   if (const VPRecipeBase *R = dyn_cast_or_null<VPRecipeBase>(Def))
91eb0371e4SFlorian Hahn     R->print(OS, "", SlotTracker);
9240e7bfc4SFlorian Hahn   else
9340e7bfc4SFlorian Hahn     printAsOperand(OS, SlotTracker);
9440e7bfc4SFlorian Hahn }
9540e7bfc4SFlorian Hahn 
96c671e34bSFlorian Hahn void VPValue::dump() const {
97eb0371e4SFlorian Hahn   const VPRecipeBase *Instr = dyn_cast_or_null<VPRecipeBase>(this->Def);
98c671e34bSFlorian Hahn   VPSlotTracker SlotTracker(
99c671e34bSFlorian Hahn       (Instr && Instr->getParent()) ? Instr->getParent()->getPlan() : nullptr);
100c671e34bSFlorian Hahn   print(dbgs(), SlotTracker);
101c671e34bSFlorian Hahn   dbgs() << "\n";
102c671e34bSFlorian Hahn }
103c671e34bSFlorian Hahn 
104eb0371e4SFlorian Hahn void VPDef::dump() const {
105eb0371e4SFlorian Hahn   const VPRecipeBase *Instr = dyn_cast_or_null<VPRecipeBase>(this);
106eb0371e4SFlorian Hahn   VPSlotTracker SlotTracker(
107eb0371e4SFlorian Hahn       (Instr && Instr->getParent()) ? Instr->getParent()->getPlan() : nullptr);
108c671e34bSFlorian Hahn   print(dbgs(), "", SlotTracker);
109c671e34bSFlorian Hahn   dbgs() << "\n";
110c671e34bSFlorian Hahn }
11192205cb2SAndrei Elovikov #endif
112c671e34bSFlorian Hahn 
11305afa555SFlorian Hahn // Get the top-most entry block of \p Start. This is the entry block of the
11405afa555SFlorian Hahn // containing VPlan. This function is templated to support both const and non-const blocks
11505afa555SFlorian Hahn template <typename T> static T *getPlanEntry(T *Start) {
11605afa555SFlorian Hahn   T *Next = Start;
11705afa555SFlorian Hahn   T *Current = Start;
11805afa555SFlorian Hahn   while ((Next = Next->getParent()))
11905afa555SFlorian Hahn     Current = Next;
12005afa555SFlorian Hahn 
12105afa555SFlorian Hahn   SmallSetVector<T *, 8> WorkList;
12205afa555SFlorian Hahn   WorkList.insert(Current);
12305afa555SFlorian Hahn 
12405afa555SFlorian Hahn   for (unsigned i = 0; i < WorkList.size(); i++) {
12505afa555SFlorian Hahn     T *Current = WorkList[i];
12605afa555SFlorian Hahn     if (Current->getNumPredecessors() == 0)
12705afa555SFlorian Hahn       return Current;
12805afa555SFlorian Hahn     auto &Predecessors = Current->getPredecessors();
12905afa555SFlorian Hahn     WorkList.insert(Predecessors.begin(), Predecessors.end());
13005afa555SFlorian Hahn   }
13105afa555SFlorian Hahn 
13205afa555SFlorian Hahn   llvm_unreachable("VPlan without any entry node without predecessors");
13305afa555SFlorian Hahn }
13405afa555SFlorian Hahn 
13505afa555SFlorian Hahn VPlan *VPBlockBase::getPlan() { return getPlanEntry(this)->Plan; }
13605afa555SFlorian Hahn 
13705afa555SFlorian Hahn const VPlan *VPBlockBase::getPlan() const { return getPlanEntry(this)->Plan; }
13805afa555SFlorian Hahn 
1391f58dda4SAyal Zaks /// \return the VPBasicBlock that is the entry of Block, possibly indirectly.
1401f58dda4SAyal Zaks const VPBasicBlock *VPBlockBase::getEntryBasicBlock() const {
1411f58dda4SAyal Zaks   const VPBlockBase *Block = this;
1421f58dda4SAyal Zaks   while (const VPRegionBlock *Region = dyn_cast<VPRegionBlock>(Block))
1431f58dda4SAyal Zaks     Block = Region->getEntry();
1441f58dda4SAyal Zaks   return cast<VPBasicBlock>(Block);
1451f58dda4SAyal Zaks }
1461f58dda4SAyal Zaks 
1471f58dda4SAyal Zaks VPBasicBlock *VPBlockBase::getEntryBasicBlock() {
1481f58dda4SAyal Zaks   VPBlockBase *Block = this;
1491f58dda4SAyal Zaks   while (VPRegionBlock *Region = dyn_cast<VPRegionBlock>(Block))
1501f58dda4SAyal Zaks     Block = Region->getEntry();
1511f58dda4SAyal Zaks   return cast<VPBasicBlock>(Block);
1521f58dda4SAyal Zaks }
1531f58dda4SAyal Zaks 
15405afa555SFlorian Hahn void VPBlockBase::setPlan(VPlan *ParentPlan) {
15505afa555SFlorian Hahn   assert(ParentPlan->getEntry() == this &&
15605afa555SFlorian Hahn          "Can only set plan on its entry block.");
15705afa555SFlorian Hahn   Plan = ParentPlan;
15805afa555SFlorian Hahn }
15905afa555SFlorian Hahn 
1601f58dda4SAyal Zaks /// \return the VPBasicBlock that is the exit of Block, possibly indirectly.
1611f58dda4SAyal Zaks const VPBasicBlock *VPBlockBase::getExitBasicBlock() const {
1621f58dda4SAyal Zaks   const VPBlockBase *Block = this;
1631f58dda4SAyal Zaks   while (const VPRegionBlock *Region = dyn_cast<VPRegionBlock>(Block))
1641f58dda4SAyal Zaks     Block = Region->getExit();
1651f58dda4SAyal Zaks   return cast<VPBasicBlock>(Block);
1661f58dda4SAyal Zaks }
1671f58dda4SAyal Zaks 
1681f58dda4SAyal Zaks VPBasicBlock *VPBlockBase::getExitBasicBlock() {
1691f58dda4SAyal Zaks   VPBlockBase *Block = this;
1701f58dda4SAyal Zaks   while (VPRegionBlock *Region = dyn_cast<VPRegionBlock>(Block))
1711f58dda4SAyal Zaks     Block = Region->getExit();
1721f58dda4SAyal Zaks   return cast<VPBasicBlock>(Block);
1731f58dda4SAyal Zaks }
1741f58dda4SAyal Zaks 
1751f58dda4SAyal Zaks VPBlockBase *VPBlockBase::getEnclosingBlockWithSuccessors() {
1761f58dda4SAyal Zaks   if (!Successors.empty() || !Parent)
1771f58dda4SAyal Zaks     return this;
1781f58dda4SAyal Zaks   assert(Parent->getExit() == this &&
1791f58dda4SAyal Zaks          "Block w/o successors not the exit of its parent.");
1801f58dda4SAyal Zaks   return Parent->getEnclosingBlockWithSuccessors();
1811f58dda4SAyal Zaks }
1821f58dda4SAyal Zaks 
1831f58dda4SAyal Zaks VPBlockBase *VPBlockBase::getEnclosingBlockWithPredecessors() {
1841f58dda4SAyal Zaks   if (!Predecessors.empty() || !Parent)
1851f58dda4SAyal Zaks     return this;
1861f58dda4SAyal Zaks   assert(Parent->getEntry() == this &&
1871f58dda4SAyal Zaks          "Block w/o predecessors not the entry of its parent.");
1881f58dda4SAyal Zaks   return Parent->getEnclosingBlockWithPredecessors();
1891f58dda4SAyal Zaks }
1901f58dda4SAyal Zaks 
1913605b873SAndrei Elovikov static VPValue *getSingleOperandOrNull(VPUser &U) {
1923605b873SAndrei Elovikov   if (U.getNumOperands() == 1)
1933605b873SAndrei Elovikov     return U.getOperand(0);
1943605b873SAndrei Elovikov 
1953605b873SAndrei Elovikov   return nullptr;
1963605b873SAndrei Elovikov }
1973605b873SAndrei Elovikov 
1983605b873SAndrei Elovikov static const VPValue *getSingleOperandOrNull(const VPUser &U) {
1993605b873SAndrei Elovikov   if (U.getNumOperands() == 1)
2003605b873SAndrei Elovikov     return U.getOperand(0);
2013605b873SAndrei Elovikov 
2023605b873SAndrei Elovikov   return nullptr;
2033605b873SAndrei Elovikov }
2043605b873SAndrei Elovikov 
2053605b873SAndrei Elovikov static void resetSingleOpUser(VPUser &U, VPValue *NewVal) {
2063605b873SAndrei Elovikov   assert(U.getNumOperands() <= 1 && "Didn't expect more than one operand!");
2073605b873SAndrei Elovikov   if (!NewVal) {
2083605b873SAndrei Elovikov     if (U.getNumOperands() == 1)
2093605b873SAndrei Elovikov       U.removeLastOperand();
2103605b873SAndrei Elovikov     return;
2113605b873SAndrei Elovikov   }
2123605b873SAndrei Elovikov 
2133605b873SAndrei Elovikov   if (U.getNumOperands() == 1)
2143605b873SAndrei Elovikov     U.setOperand(0, NewVal);
2153605b873SAndrei Elovikov   else
2163605b873SAndrei Elovikov     U.addOperand(NewVal);
2173605b873SAndrei Elovikov }
2183605b873SAndrei Elovikov 
2193605b873SAndrei Elovikov VPValue *VPBlockBase::getCondBit() {
2203605b873SAndrei Elovikov   return getSingleOperandOrNull(CondBitUser);
2213605b873SAndrei Elovikov }
2223605b873SAndrei Elovikov 
2233605b873SAndrei Elovikov const VPValue *VPBlockBase::getCondBit() const {
2243605b873SAndrei Elovikov   return getSingleOperandOrNull(CondBitUser);
2253605b873SAndrei Elovikov }
2263605b873SAndrei Elovikov 
2273605b873SAndrei Elovikov void VPBlockBase::setCondBit(VPValue *CV) {
2283605b873SAndrei Elovikov   resetSingleOpUser(CondBitUser, CV);
2293605b873SAndrei Elovikov }
2303605b873SAndrei Elovikov 
2313605b873SAndrei Elovikov VPValue *VPBlockBase::getPredicate() {
2323605b873SAndrei Elovikov   return getSingleOperandOrNull(PredicateUser);
2333605b873SAndrei Elovikov }
2343605b873SAndrei Elovikov 
2353605b873SAndrei Elovikov const VPValue *VPBlockBase::getPredicate() const {
2363605b873SAndrei Elovikov   return getSingleOperandOrNull(PredicateUser);
2373605b873SAndrei Elovikov }
2383605b873SAndrei Elovikov 
2393605b873SAndrei Elovikov void VPBlockBase::setPredicate(VPValue *CV) {
2403605b873SAndrei Elovikov   resetSingleOpUser(PredicateUser, CV);
2413605b873SAndrei Elovikov }
2423605b873SAndrei Elovikov 
2431f58dda4SAyal Zaks void VPBlockBase::deleteCFG(VPBlockBase *Entry) {
24419aacdb7SKazu Hirata   SmallVector<VPBlockBase *, 8> Blocks(depth_first(Entry));
2451f58dda4SAyal Zaks 
2461f58dda4SAyal Zaks   for (VPBlockBase *Block : Blocks)
2471f58dda4SAyal Zaks     delete Block;
2481f58dda4SAyal Zaks }
2491f58dda4SAyal Zaks 
250be6e8e50SDavid Green VPBasicBlock::iterator VPBasicBlock::getFirstNonPhi() {
251be6e8e50SDavid Green   iterator It = begin();
252aa1a198aSFlorian Hahn   while (It != end() && (isa<VPWidenPHIRecipe>(&*It) ||
253aa1a198aSFlorian Hahn                          isa<VPWidenIntOrFpInductionRecipe>(&*It) ||
254aa1a198aSFlorian Hahn                          isa<VPPredInstPHIRecipe>(&*It) ||
255aa1a198aSFlorian Hahn                          isa<VPWidenCanonicalIVRecipe>(&*It)))
256be6e8e50SDavid Green     It++;
257be6e8e50SDavid Green   return It;
258be6e8e50SDavid Green }
259be6e8e50SDavid Green 
2603201274dSFlorian Hahn Value *VPTransformState::get(VPValue *Def, const VPIteration &Instance) {
261daaa0e35SFlorian Hahn   if (!Def->getDef())
2623201274dSFlorian Hahn     return Def->getLiveInIRValue();
2633201274dSFlorian Hahn 
264fec0a0adSDavid Sherwood   if (hasScalarValue(Def, Instance)) {
265fec0a0adSDavid Sherwood     return Data
266fec0a0adSDavid Sherwood         .PerPartScalars[Def][Instance.Part][Instance.Lane.mapToCacheIndex(VF)];
267fec0a0adSDavid Sherwood   }
2683201274dSFlorian Hahn 
26954a14c26SFlorian Hahn   assert(hasVectorValue(Def, Instance.Part));
2703201274dSFlorian Hahn   auto *VecPart = Data.PerPartOutput[Def][Instance.Part];
2713201274dSFlorian Hahn   if (!VecPart->getType()->isVectorTy()) {
272fec0a0adSDavid Sherwood     assert(Instance.Lane.isFirstLane() && "cannot get lane > 0 for scalar");
2733201274dSFlorian Hahn     return VecPart;
2743201274dSFlorian Hahn   }
2753201274dSFlorian Hahn   // TODO: Cache created scalar values.
276fec0a0adSDavid Sherwood   Value *Lane = Instance.Lane.getAsRuntimeExpr(Builder, VF);
277fec0a0adSDavid Sherwood   auto *Extract = Builder.CreateExtractElement(VecPart, Lane);
27854a14c26SFlorian Hahn   // set(Def, Extract, Instance);
27954a14c26SFlorian Hahn   return Extract;
2803201274dSFlorian Hahn }
2813201274dSFlorian Hahn 
2821f58dda4SAyal Zaks BasicBlock *
2831f58dda4SAyal Zaks VPBasicBlock::createEmptyBasicBlock(VPTransformState::CFGState &CFG) {
2841f58dda4SAyal Zaks   // BB stands for IR BasicBlocks. VPBB stands for VPlan VPBasicBlocks.
2851f58dda4SAyal Zaks   // Pred stands for Predessor. Prev stands for Previous - last visited/created.
2861f58dda4SAyal Zaks   BasicBlock *PrevBB = CFG.PrevBB;
2871f58dda4SAyal Zaks   BasicBlock *NewBB = BasicBlock::Create(PrevBB->getContext(), getName(),
2881f58dda4SAyal Zaks                                          PrevBB->getParent(), CFG.LastBB);
289d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "LV: created " << NewBB->getName() << '\n');
2901f58dda4SAyal Zaks 
2911f58dda4SAyal Zaks   // Hook up the new basic block to its predecessors.
2921f58dda4SAyal Zaks   for (VPBlockBase *PredVPBlock : getHierarchicalPredecessors()) {
2931f58dda4SAyal Zaks     VPBasicBlock *PredVPBB = PredVPBlock->getExitBasicBlock();
2941f58dda4SAyal Zaks     auto &PredVPSuccessors = PredVPBB->getSuccessors();
2951f58dda4SAyal Zaks     BasicBlock *PredBB = CFG.VPBB2IRBB[PredVPBB];
296ea7f3035SHideki Saito 
297ea7f3035SHideki Saito     // In outer loop vectorization scenario, the predecessor BBlock may not yet
298ea7f3035SHideki Saito     // be visited(backedge). Mark the VPBasicBlock for fixup at the end of
299ea7f3035SHideki Saito     // vectorization. We do not encounter this case in inner loop vectorization
300ea7f3035SHideki Saito     // as we start out by building a loop skeleton with the vector loop header
301ea7f3035SHideki Saito     // and latch blocks. As a result, we never enter this function for the
302ea7f3035SHideki Saito     // header block in the non VPlan-native path.
303ea7f3035SHideki Saito     if (!PredBB) {
304ea7f3035SHideki Saito       assert(EnableVPlanNativePath &&
305ea7f3035SHideki Saito              "Unexpected null predecessor in non VPlan-native path");
306ea7f3035SHideki Saito       CFG.VPBBsToFix.push_back(PredVPBB);
307ea7f3035SHideki Saito       continue;
308ea7f3035SHideki Saito     }
309ea7f3035SHideki Saito 
3101f58dda4SAyal Zaks     assert(PredBB && "Predecessor basic-block not found building successor.");
3111f58dda4SAyal Zaks     auto *PredBBTerminator = PredBB->getTerminator();
312d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "LV: draw edge from" << PredBB->getName() << '\n');
3131f58dda4SAyal Zaks     if (isa<UnreachableInst>(PredBBTerminator)) {
3141f58dda4SAyal Zaks       assert(PredVPSuccessors.size() == 1 &&
3151f58dda4SAyal Zaks              "Predecessor ending w/o branch must have single successor.");
3161f58dda4SAyal Zaks       PredBBTerminator->eraseFromParent();
3171f58dda4SAyal Zaks       BranchInst::Create(NewBB, PredBB);
3181f58dda4SAyal Zaks     } else {
3191f58dda4SAyal Zaks       assert(PredVPSuccessors.size() == 2 &&
3201f58dda4SAyal Zaks              "Predecessor ending with branch must have two successors.");
3211f58dda4SAyal Zaks       unsigned idx = PredVPSuccessors.front() == this ? 0 : 1;
3221f58dda4SAyal Zaks       assert(!PredBBTerminator->getSuccessor(idx) &&
3231f58dda4SAyal Zaks              "Trying to reset an existing successor block.");
3241f58dda4SAyal Zaks       PredBBTerminator->setSuccessor(idx, NewBB);
3251f58dda4SAyal Zaks     }
3261f58dda4SAyal Zaks   }
3271f58dda4SAyal Zaks   return NewBB;
3281f58dda4SAyal Zaks }
3291f58dda4SAyal Zaks 
3301f58dda4SAyal Zaks void VPBasicBlock::execute(VPTransformState *State) {
331d4626eb0SDavid Sherwood   bool Replica = State->Instance && !State->Instance->isFirstIteration();
3321f58dda4SAyal Zaks   VPBasicBlock *PrevVPBB = State->CFG.PrevVPBB;
3331f58dda4SAyal Zaks   VPBlockBase *SingleHPred = nullptr;
3341f58dda4SAyal Zaks   BasicBlock *NewBB = State->CFG.PrevBB; // Reuse it if possible.
3351f58dda4SAyal Zaks 
3361f58dda4SAyal Zaks   // 1. Create an IR basic block, or reuse the last one if possible.
3371f58dda4SAyal Zaks   // The last IR basic block is reused, as an optimization, in three cases:
3381f58dda4SAyal Zaks   // A. the first VPBB reuses the loop header BB - when PrevVPBB is null;
3391f58dda4SAyal Zaks   // B. when the current VPBB has a single (hierarchical) predecessor which
3401f58dda4SAyal Zaks   //    is PrevVPBB and the latter has a single (hierarchical) successor; and
3411f58dda4SAyal Zaks   // C. when the current VPBB is an entry of a region replica - where PrevVPBB
3421f58dda4SAyal Zaks   //    is the exit of this region from a previous instance, or the predecessor
3431f58dda4SAyal Zaks   //    of this region.
3441f58dda4SAyal Zaks   if (PrevVPBB && /* A */
3451f58dda4SAyal Zaks       !((SingleHPred = getSingleHierarchicalPredecessor()) &&
3461f58dda4SAyal Zaks         SingleHPred->getExitBasicBlock() == PrevVPBB &&
3471f58dda4SAyal Zaks         PrevVPBB->getSingleHierarchicalSuccessor()) && /* B */
3481f58dda4SAyal Zaks       !(Replica && getPredecessors().empty())) {       /* C */
3491f58dda4SAyal Zaks     NewBB = createEmptyBasicBlock(State->CFG);
3501f58dda4SAyal Zaks     State->Builder.SetInsertPoint(NewBB);
3511f58dda4SAyal Zaks     // Temporarily terminate with unreachable until CFG is rewired.
3521f58dda4SAyal Zaks     UnreachableInst *Terminator = State->Builder.CreateUnreachable();
3531f58dda4SAyal Zaks     State->Builder.SetInsertPoint(Terminator);
3541f58dda4SAyal Zaks     // Register NewBB in its loop. In innermost loops its the same for all BB's.
3551f58dda4SAyal Zaks     Loop *L = State->LI->getLoopFor(State->CFG.LastBB);
3561f58dda4SAyal Zaks     L->addBasicBlockToLoop(NewBB, *State->LI);
3571f58dda4SAyal Zaks     State->CFG.PrevBB = NewBB;
3581f58dda4SAyal Zaks   }
3591f58dda4SAyal Zaks 
3601f58dda4SAyal Zaks   // 2. Fill the IR basic block with IR instructions.
361d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "LV: vectorizing VPBB:" << getName()
3621f58dda4SAyal Zaks                     << " in BB:" << NewBB->getName() << '\n');
3631f58dda4SAyal Zaks 
3641f58dda4SAyal Zaks   State->CFG.VPBB2IRBB[this] = NewBB;
3651f58dda4SAyal Zaks   State->CFG.PrevVPBB = this;
3661f58dda4SAyal Zaks 
3671f58dda4SAyal Zaks   for (VPRecipeBase &Recipe : Recipes)
3681f58dda4SAyal Zaks     Recipe.execute(*State);
3691f58dda4SAyal Zaks 
370ea7f3035SHideki Saito   VPValue *CBV;
371ea7f3035SHideki Saito   if (EnableVPlanNativePath && (CBV = getCondBit())) {
37259f442e6SBenjamin Kramer     assert(CBV->getUnderlyingValue() &&
37359f442e6SBenjamin Kramer            "Unexpected null underlying value for condition bit");
374ea7f3035SHideki Saito 
375ea7f3035SHideki Saito     // Condition bit value in a VPBasicBlock is used as the branch selector. In
376ea7f3035SHideki Saito     // the VPlan-native path case, since all branches are uniform we generate a
377ea7f3035SHideki Saito     // branch instruction using the condition value from vector lane 0 and dummy
378ea7f3035SHideki Saito     // successors. The successors are fixed later when the successor blocks are
379ea7f3035SHideki Saito     // visited.
380edc92a1cSFlorian Hahn     Value *NewCond = State->get(CBV, {0, 0});
381ea7f3035SHideki Saito 
382ea7f3035SHideki Saito     // Replace the temporary unreachable terminator with the new conditional
383ea7f3035SHideki Saito     // branch.
384ea7f3035SHideki Saito     auto *CurrentTerminator = NewBB->getTerminator();
385ea7f3035SHideki Saito     assert(isa<UnreachableInst>(CurrentTerminator) &&
386ea7f3035SHideki Saito            "Expected to replace unreachable terminator with conditional "
387ea7f3035SHideki Saito            "branch.");
388ea7f3035SHideki Saito     auto *CondBr = BranchInst::Create(NewBB, nullptr, NewCond);
389ea7f3035SHideki Saito     CondBr->setSuccessor(0, nullptr);
390ea7f3035SHideki Saito     ReplaceInstWithInst(CurrentTerminator, CondBr);
391ea7f3035SHideki Saito   }
392ea7f3035SHideki Saito 
393d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "LV: filled BB:" << *NewBB);
3941f58dda4SAyal Zaks }
3951f58dda4SAyal Zaks 
396348d85a6SFlorian Hahn void VPBasicBlock::dropAllReferences(VPValue *NewValue) {
397348d85a6SFlorian Hahn   for (VPRecipeBase &R : Recipes) {
398c0c0ae16SFlorian Hahn     for (auto *Def : R.definedValues())
399cd608dc8SFlorian Hahn       Def->replaceAllUsesWith(NewValue);
400348d85a6SFlorian Hahn 
40185fe5c93SFlorian Hahn     for (unsigned I = 0, E = R.getNumOperands(); I != E; I++)
40285fe5c93SFlorian Hahn       R.setOperand(I, NewValue);
403348d85a6SFlorian Hahn   }
404348d85a6SFlorian Hahn }
405348d85a6SFlorian Hahn 
40692205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
40793a9d2deSAndrei Elovikov void VPBasicBlock::print(raw_ostream &O, const Twine &Indent,
40893a9d2deSAndrei Elovikov                          VPSlotTracker &SlotTracker) const {
40993a9d2deSAndrei Elovikov   O << Indent << getName() << ":\n";
41093a9d2deSAndrei Elovikov   if (const VPValue *Pred = getPredicate()) {
41193a9d2deSAndrei Elovikov     O << Indent << "BlockPredicate:";
41293a9d2deSAndrei Elovikov     Pred->printAsOperand(O, SlotTracker);
41393a9d2deSAndrei Elovikov     if (const auto *PredInst = dyn_cast<VPInstruction>(Pred))
41493a9d2deSAndrei Elovikov       O << " (" << PredInst->getParent()->getName() << ")";
41593a9d2deSAndrei Elovikov     O << '\n';
41693a9d2deSAndrei Elovikov   }
41793a9d2deSAndrei Elovikov 
41893a9d2deSAndrei Elovikov   auto RecipeIndent = Indent + "  ";
41993a9d2deSAndrei Elovikov   for (const VPRecipeBase &Recipe : *this) {
42093a9d2deSAndrei Elovikov     Recipe.print(O, RecipeIndent, SlotTracker);
42193a9d2deSAndrei Elovikov     O << '\n';
42293a9d2deSAndrei Elovikov   }
42393a9d2deSAndrei Elovikov 
42493a9d2deSAndrei Elovikov   if (getSuccessors().empty()) {
42593a9d2deSAndrei Elovikov     O << Indent << "No successors\n";
42693a9d2deSAndrei Elovikov   } else {
42793a9d2deSAndrei Elovikov     O << Indent << "Successor(s): ";
42893a9d2deSAndrei Elovikov     ListSeparator LS;
42993a9d2deSAndrei Elovikov     for (auto *Succ : getSuccessors())
43093a9d2deSAndrei Elovikov       O << LS << Succ->getName();
43193a9d2deSAndrei Elovikov     O << '\n';
43293a9d2deSAndrei Elovikov   }
43393a9d2deSAndrei Elovikov 
43493a9d2deSAndrei Elovikov   if (const VPValue *CBV = getCondBit()) {
43593a9d2deSAndrei Elovikov     O << Indent << "CondBit: ";
43693a9d2deSAndrei Elovikov     CBV->printAsOperand(O, SlotTracker);
43793a9d2deSAndrei Elovikov     if (const auto *CBI = dyn_cast<VPInstruction>(CBV))
43893a9d2deSAndrei Elovikov       O << " (" << CBI->getParent()->getName() << ")";
43993a9d2deSAndrei Elovikov     O << '\n';
44093a9d2deSAndrei Elovikov   }
44193a9d2deSAndrei Elovikov }
44292205cb2SAndrei Elovikov #endif
44393a9d2deSAndrei Elovikov 
444bd0b1311SFlorian Hahn void VPRegionBlock::dropAllReferences(VPValue *NewValue) {
445bd0b1311SFlorian Hahn   for (VPBlockBase *Block : depth_first(Entry))
446bd0b1311SFlorian Hahn     // Drop all references in VPBasicBlocks and replace all uses with
447bd0b1311SFlorian Hahn     // DummyValue.
448bd0b1311SFlorian Hahn     Block->dropAllReferences(NewValue);
449bd0b1311SFlorian Hahn }
450bd0b1311SFlorian Hahn 
4511f58dda4SAyal Zaks void VPRegionBlock::execute(VPTransformState *State) {
4521f58dda4SAyal Zaks   ReversePostOrderTraversal<VPBlockBase *> RPOT(Entry);
4531f58dda4SAyal Zaks 
4541f58dda4SAyal Zaks   if (!isReplicator()) {
4551f58dda4SAyal Zaks     // Visit the VPBlocks connected to "this", starting from it.
4561f58dda4SAyal Zaks     for (VPBlockBase *Block : RPOT) {
457ea7f3035SHideki Saito       if (EnableVPlanNativePath) {
458ea7f3035SHideki Saito         // The inner loop vectorization path does not represent loop preheader
459ea7f3035SHideki Saito         // and exit blocks as part of the VPlan. In the VPlan-native path, skip
460ea7f3035SHideki Saito         // vectorizing loop preheader block. In future, we may replace this
461ea7f3035SHideki Saito         // check with the check for loop preheader.
462ea7f3035SHideki Saito         if (Block->getNumPredecessors() == 0)
463ea7f3035SHideki Saito           continue;
464ea7f3035SHideki Saito 
465ea7f3035SHideki Saito         // Skip vectorizing loop exit block. In future, we may replace this
466ea7f3035SHideki Saito         // check with the check for loop exit.
467ea7f3035SHideki Saito         if (Block->getNumSuccessors() == 0)
468ea7f3035SHideki Saito           continue;
469ea7f3035SHideki Saito       }
470ea7f3035SHideki Saito 
471d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "LV: VPBlock in RPO " << Block->getName() << '\n');
4721f58dda4SAyal Zaks       Block->execute(State);
4731f58dda4SAyal Zaks     }
4741f58dda4SAyal Zaks     return;
4751f58dda4SAyal Zaks   }
4761f58dda4SAyal Zaks 
4771f58dda4SAyal Zaks   assert(!State->Instance && "Replicating a Region with non-null instance.");
4781f58dda4SAyal Zaks 
4791f58dda4SAyal Zaks   // Enter replicating mode.
480d4626eb0SDavid Sherwood   State->Instance = VPIteration(0, 0);
4811f58dda4SAyal Zaks 
4821f58dda4SAyal Zaks   for (unsigned Part = 0, UF = State->UF; Part < UF; ++Part) {
4831f58dda4SAyal Zaks     State->Instance->Part = Part;
484f4257c58SDavid Sherwood     assert(!State->VF.isScalable() && "VF is assumed to be non scalable.");
485f4257c58SDavid Sherwood     for (unsigned Lane = 0, VF = State->VF.getKnownMinValue(); Lane < VF;
486f4257c58SDavid Sherwood          ++Lane) {
487fec0a0adSDavid Sherwood       State->Instance->Lane = VPLane(Lane, VPLane::Kind::First);
4881f58dda4SAyal Zaks       // Visit the VPBlocks connected to \p this, starting from it.
4891f58dda4SAyal Zaks       for (VPBlockBase *Block : RPOT) {
490d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "LV: VPBlock in RPO " << Block->getName() << '\n');
4911f58dda4SAyal Zaks         Block->execute(State);
4921f58dda4SAyal Zaks       }
4931f58dda4SAyal Zaks     }
4941f58dda4SAyal Zaks   }
4951f58dda4SAyal Zaks 
4961f58dda4SAyal Zaks   // Exit replicating mode.
4971f58dda4SAyal Zaks   State->Instance.reset();
4981f58dda4SAyal Zaks }
4991f58dda4SAyal Zaks 
50092205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
50193a9d2deSAndrei Elovikov void VPRegionBlock::print(raw_ostream &O, const Twine &Indent,
50293a9d2deSAndrei Elovikov                           VPSlotTracker &SlotTracker) const {
50393a9d2deSAndrei Elovikov   O << Indent << (isReplicator() ? "<xVFxUF> " : "<x1> ") << getName() << ": {";
50493a9d2deSAndrei Elovikov   auto NewIndent = Indent + "  ";
50593a9d2deSAndrei Elovikov   for (auto *BlockBase : depth_first(Entry)) {
50693a9d2deSAndrei Elovikov     O << '\n';
50793a9d2deSAndrei Elovikov     BlockBase->print(O, NewIndent, SlotTracker);
50893a9d2deSAndrei Elovikov   }
50993a9d2deSAndrei Elovikov   O << Indent << "}\n";
51093a9d2deSAndrei Elovikov }
51192205cb2SAndrei Elovikov #endif
51293a9d2deSAndrei Elovikov 
5137591e4e9SFlorian Hahn void VPRecipeBase::insertBefore(VPRecipeBase *InsertPos) {
5147f152543SGil Rapaport   assert(!Parent && "Recipe already in some VPBasicBlock");
5157f152543SGil Rapaport   assert(InsertPos->getParent() &&
5167f152543SGil Rapaport          "Insertion position not in any VPBasicBlock");
5173bcff366SFlorian Hahn   Parent = InsertPos->getParent();
5183bcff366SFlorian Hahn   Parent->getRecipeList().insert(InsertPos->getIterator(), this);
5197591e4e9SFlorian Hahn }
5207591e4e9SFlorian Hahn 
5217f152543SGil Rapaport void VPRecipeBase::insertAfter(VPRecipeBase *InsertPos) {
5227f152543SGil Rapaport   assert(!Parent && "Recipe already in some VPBasicBlock");
5237f152543SGil Rapaport   assert(InsertPos->getParent() &&
5247f152543SGil Rapaport          "Insertion position not in any VPBasicBlock");
5257f152543SGil Rapaport   Parent = InsertPos->getParent();
5267f152543SGil Rapaport   Parent->getRecipeList().insertAfter(InsertPos->getIterator(), this);
5277f152543SGil Rapaport }
5287f152543SGil Rapaport 
5297f152543SGil Rapaport void VPRecipeBase::removeFromParent() {
5307f152543SGil Rapaport   assert(getParent() && "Recipe not in any VPBasicBlock");
5317f152543SGil Rapaport   getParent()->getRecipeList().remove(getIterator());
5327f152543SGil Rapaport   Parent = nullptr;
5337f152543SGil Rapaport }
5347f152543SGil Rapaport 
53563cbcf98SFlorian Hahn iplist<VPRecipeBase>::iterator VPRecipeBase::eraseFromParent() {
5367f152543SGil Rapaport   assert(getParent() && "Recipe not in any VPBasicBlock");
53763cbcf98SFlorian Hahn   return getParent()->getRecipeList().erase(getIterator());
53863cbcf98SFlorian Hahn }
53963cbcf98SFlorian Hahn 
54039d4c9fdSFlorian Hahn void VPRecipeBase::moveAfter(VPRecipeBase *InsertPos) {
5417f152543SGil Rapaport   removeFromParent();
5427f152543SGil Rapaport   insertAfter(InsertPos);
54339d4c9fdSFlorian Hahn }
54439d4c9fdSFlorian Hahn 
54572fb5ba0SDavid Green void VPRecipeBase::moveBefore(VPBasicBlock &BB,
54672fb5ba0SDavid Green                               iplist<VPRecipeBase>::iterator I) {
54772fb5ba0SDavid Green   assert(I == BB.end() || I->getParent() == &BB);
54872fb5ba0SDavid Green   removeFromParent();
54972fb5ba0SDavid Green   Parent = &BB;
55072fb5ba0SDavid Green   BB.getRecipeList().insert(I, this);
55172fb5ba0SDavid Green }
55272fb5ba0SDavid Green 
5538b9d1f3cSGil Rapaport void VPInstruction::generateInstruction(VPTransformState &State,
5548b9d1f3cSGil Rapaport                                         unsigned Part) {
5558b9d1f3cSGil Rapaport   IRBuilder<> &Builder = State.Builder;
5568b9d1f3cSGil Rapaport 
5578b9d1f3cSGil Rapaport   if (Instruction::isBinaryOp(getOpcode())) {
5588b9d1f3cSGil Rapaport     Value *A = State.get(getOperand(0), Part);
5598b9d1f3cSGil Rapaport     Value *B = State.get(getOperand(1), Part);
5608b9d1f3cSGil Rapaport     Value *V = Builder.CreateBinOp((Instruction::BinaryOps)getOpcode(), A, B);
5618b9d1f3cSGil Rapaport     State.set(this, V, Part);
5628b9d1f3cSGil Rapaport     return;
5638b9d1f3cSGil Rapaport   }
5648b9d1f3cSGil Rapaport 
5658b9d1f3cSGil Rapaport   switch (getOpcode()) {
5668b9d1f3cSGil Rapaport   case VPInstruction::Not: {
5678b9d1f3cSGil Rapaport     Value *A = State.get(getOperand(0), Part);
5688b9d1f3cSGil Rapaport     Value *V = Builder.CreateNot(A);
5698b9d1f3cSGil Rapaport     State.set(this, V, Part);
5708b9d1f3cSGil Rapaport     break;
5718b9d1f3cSGil Rapaport   }
572b0b5312eSAyal Zaks   case VPInstruction::ICmpULE: {
573b0b5312eSAyal Zaks     Value *IV = State.get(getOperand(0), Part);
574b0b5312eSAyal Zaks     Value *TC = State.get(getOperand(1), Part);
575b0b5312eSAyal Zaks     Value *V = Builder.CreateICmpULE(IV, TC);
576b0b5312eSAyal Zaks     State.set(this, V, Part);
577b0b5312eSAyal Zaks     break;
578b0b5312eSAyal Zaks   }
579d15df0edSAyal Zaks   case Instruction::Select: {
580d15df0edSAyal Zaks     Value *Cond = State.get(getOperand(0), Part);
581d15df0edSAyal Zaks     Value *Op1 = State.get(getOperand(1), Part);
582d15df0edSAyal Zaks     Value *Op2 = State.get(getOperand(2), Part);
583d15df0edSAyal Zaks     Value *V = Builder.CreateSelect(Cond, Op1, Op2);
584d15df0edSAyal Zaks     State.set(this, V, Part);
585d15df0edSAyal Zaks     break;
586d15df0edSAyal Zaks   }
587e345d547SSjoerd Meijer   case VPInstruction::ActiveLaneMask: {
588e345d547SSjoerd Meijer     // Get first lane of vector induction variable.
589d4626eb0SDavid Sherwood     Value *VIVElem0 = State.get(getOperand(0), VPIteration(Part, 0));
590ae366479SSjoerd Meijer     // Get the original loop tripcount.
591ae366479SSjoerd Meijer     Value *ScalarTC = State.TripCount;
592e345d547SSjoerd Meijer 
593e345d547SSjoerd Meijer     auto *Int1Ty = Type::getInt1Ty(Builder.getContext());
594f4257c58SDavid Sherwood     auto *PredTy = FixedVectorType::get(Int1Ty, State.VF.getKnownMinValue());
595e345d547SSjoerd Meijer     Instruction *Call = Builder.CreateIntrinsic(
596ae366479SSjoerd Meijer         Intrinsic::get_active_lane_mask, {PredTy, ScalarTC->getType()},
597ae366479SSjoerd Meijer         {VIVElem0, ScalarTC}, nullptr, "active.lane.mask");
598e345d547SSjoerd Meijer     State.set(this, Call, Part);
599e345d547SSjoerd Meijer     break;
600e345d547SSjoerd Meijer   }
6018b9d1f3cSGil Rapaport   default:
6028b9d1f3cSGil Rapaport     llvm_unreachable("Unsupported opcode for instruction");
6038b9d1f3cSGil Rapaport   }
6048b9d1f3cSGil Rapaport }
6058b9d1f3cSGil Rapaport 
6068b9d1f3cSGil Rapaport void VPInstruction::execute(VPTransformState &State) {
6078b9d1f3cSGil Rapaport   assert(!State.Instance && "VPInstruction executing an Instance");
6088b9d1f3cSGil Rapaport   for (unsigned Part = 0; Part < State.UF; ++Part)
6098b9d1f3cSGil Rapaport     generateInstruction(State, Part);
6108b9d1f3cSGil Rapaport }
6118b9d1f3cSGil Rapaport 
61292205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
613eb0371e4SFlorian Hahn void VPInstruction::dump() const {
614eb0371e4SFlorian Hahn   VPSlotTracker SlotTracker(getParent()->getPlan());
615eb0371e4SFlorian Hahn   print(dbgs(), "", SlotTracker);
616eb0371e4SFlorian Hahn }
617eb0371e4SFlorian Hahn 
61840e7bfc4SFlorian Hahn void VPInstruction::print(raw_ostream &O, const Twine &Indent,
61940e7bfc4SFlorian Hahn                           VPSlotTracker &SlotTracker) const {
620b24afec8SAndrei Elovikov   O << Indent << "EMIT ";
6218b9d1f3cSGil Rapaport 
622e6a74803SFlorian Hahn   if (hasResult()) {
62340e7bfc4SFlorian Hahn     printAsOperand(O, SlotTracker);
6248b9d1f3cSGil Rapaport     O << " = ";
625e6a74803SFlorian Hahn   }
6268b9d1f3cSGil Rapaport 
6278b9d1f3cSGil Rapaport   switch (getOpcode()) {
6288b9d1f3cSGil Rapaport   case VPInstruction::Not:
6298b9d1f3cSGil Rapaport     O << "not";
6308b9d1f3cSGil Rapaport     break;
631b0b5312eSAyal Zaks   case VPInstruction::ICmpULE:
632b0b5312eSAyal Zaks     O << "icmp ule";
633b0b5312eSAyal Zaks     break;
63409e516c5SFlorian Hahn   case VPInstruction::SLPLoad:
63509e516c5SFlorian Hahn     O << "combined load";
63609e516c5SFlorian Hahn     break;
63709e516c5SFlorian Hahn   case VPInstruction::SLPStore:
63809e516c5SFlorian Hahn     O << "combined store";
63909e516c5SFlorian Hahn     break;
640e345d547SSjoerd Meijer   case VPInstruction::ActiveLaneMask:
641e345d547SSjoerd Meijer     O << "active lane mask";
642e345d547SSjoerd Meijer     break;
643e345d547SSjoerd Meijer 
6448b9d1f3cSGil Rapaport   default:
6458b9d1f3cSGil Rapaport     O << Instruction::getOpcodeName(getOpcode());
6468b9d1f3cSGil Rapaport   }
6478b9d1f3cSGil Rapaport 
6488b9d1f3cSGil Rapaport   for (const VPValue *Operand : operands()) {
6498b9d1f3cSGil Rapaport     O << " ";
65040e7bfc4SFlorian Hahn     Operand->printAsOperand(O, SlotTracker);
6518b9d1f3cSGil Rapaport   }
6528b9d1f3cSGil Rapaport }
65392205cb2SAndrei Elovikov #endif
6548b9d1f3cSGil Rapaport 
6551f58dda4SAyal Zaks /// Generate the code inside the body of the vectorized loop. Assumes a single
6561f58dda4SAyal Zaks /// LoopVectorBody basic-block was created for this. Introduce additional
6571f58dda4SAyal Zaks /// basic-blocks as needed, and fill them all.
6581f58dda4SAyal Zaks void VPlan::execute(VPTransformState *State) {
659b0b5312eSAyal Zaks   // -1. Check if the backedge taken count is needed, and if so build it.
660b0b5312eSAyal Zaks   if (BackedgeTakenCount && BackedgeTakenCount->getNumUsers()) {
661b0b5312eSAyal Zaks     Value *TC = State->TripCount;
662b0b5312eSAyal Zaks     IRBuilder<> Builder(State->CFG.PrevBB->getTerminator());
663b0b5312eSAyal Zaks     auto *TCMO = Builder.CreateSub(TC, ConstantInt::get(TC->getType(), 1),
664b0b5312eSAyal Zaks                                    "trip.count.minus.1");
66513bf6039SAnh Tuyen Tran     auto VF = State->VF;
66613bf6039SAnh Tuyen Tran     Value *VTCMO =
667c5ba0d33SDavid Sherwood         VF.isScalar() ? TCMO : Builder.CreateVectorSplat(VF, TCMO, "broadcast");
668a3c964a2SAyal Zaks     for (unsigned Part = 0, UF = State->UF; Part < UF; ++Part)
669a3c964a2SAyal Zaks       State->set(BackedgeTakenCount, VTCMO, Part);
670b0b5312eSAyal Zaks   }
671b0b5312eSAyal Zaks 
6728b9d1f3cSGil Rapaport   // 0. Set the reverse mapping from VPValues to Values for code generation.
6738b9d1f3cSGil Rapaport   for (auto &Entry : Value2VPValue)
6748b9d1f3cSGil Rapaport     State->VPValue2Value[Entry.second] = Entry.first;
6758b9d1f3cSGil Rapaport 
6761f58dda4SAyal Zaks   BasicBlock *VectorPreHeaderBB = State->CFG.PrevBB;
6771f58dda4SAyal Zaks   BasicBlock *VectorHeaderBB = VectorPreHeaderBB->getSingleSuccessor();
6781f58dda4SAyal Zaks   assert(VectorHeaderBB && "Loop preheader does not have a single successor.");
6791f58dda4SAyal Zaks 
6801f58dda4SAyal Zaks   // 1. Make room to generate basic-blocks inside loop body if needed.
681cced3eccSSimon Pilgrim   BasicBlock *VectorLatchBB = VectorHeaderBB->splitBasicBlock(
6821f58dda4SAyal Zaks       VectorHeaderBB->getFirstInsertionPt(), "vector.body.latch");
6831f58dda4SAyal Zaks   Loop *L = State->LI->getLoopFor(VectorHeaderBB);
6841f58dda4SAyal Zaks   L->addBasicBlockToLoop(VectorLatchBB, *State->LI);
6851f58dda4SAyal Zaks   // Remove the edge between Header and Latch to allow other connections.
6861f58dda4SAyal Zaks   // Temporarily terminate with unreachable until CFG is rewired.
6871f58dda4SAyal Zaks   // Note: this asserts the generated code's assumption that
6881f58dda4SAyal Zaks   // getFirstInsertionPt() can be dereferenced into an Instruction.
6891f58dda4SAyal Zaks   VectorHeaderBB->getTerminator()->eraseFromParent();
6901f58dda4SAyal Zaks   State->Builder.SetInsertPoint(VectorHeaderBB);
6911f58dda4SAyal Zaks   UnreachableInst *Terminator = State->Builder.CreateUnreachable();
6921f58dda4SAyal Zaks   State->Builder.SetInsertPoint(Terminator);
6931f58dda4SAyal Zaks 
6941f58dda4SAyal Zaks   // 2. Generate code in loop body.
6951f58dda4SAyal Zaks   State->CFG.PrevVPBB = nullptr;
6961f58dda4SAyal Zaks   State->CFG.PrevBB = VectorHeaderBB;
6971f58dda4SAyal Zaks   State->CFG.LastBB = VectorLatchBB;
6981f58dda4SAyal Zaks 
6991f58dda4SAyal Zaks   for (VPBlockBase *Block : depth_first(Entry))
7001f58dda4SAyal Zaks     Block->execute(State);
7011f58dda4SAyal Zaks 
702ea7f3035SHideki Saito   // Setup branch terminator successors for VPBBs in VPBBsToFix based on
703ea7f3035SHideki Saito   // VPBB's successors.
704ea7f3035SHideki Saito   for (auto VPBB : State->CFG.VPBBsToFix) {
705ea7f3035SHideki Saito     assert(EnableVPlanNativePath &&
706ea7f3035SHideki Saito            "Unexpected VPBBsToFix in non VPlan-native path");
707ea7f3035SHideki Saito     BasicBlock *BB = State->CFG.VPBB2IRBB[VPBB];
708ea7f3035SHideki Saito     assert(BB && "Unexpected null basic block for VPBB");
709ea7f3035SHideki Saito 
710ea7f3035SHideki Saito     unsigned Idx = 0;
711ea7f3035SHideki Saito     auto *BBTerminator = BB->getTerminator();
712ea7f3035SHideki Saito 
713ea7f3035SHideki Saito     for (VPBlockBase *SuccVPBlock : VPBB->getHierarchicalSuccessors()) {
714ea7f3035SHideki Saito       VPBasicBlock *SuccVPBB = SuccVPBlock->getEntryBasicBlock();
715ea7f3035SHideki Saito       BBTerminator->setSuccessor(Idx, State->CFG.VPBB2IRBB[SuccVPBB]);
716ea7f3035SHideki Saito       ++Idx;
717ea7f3035SHideki Saito     }
718ea7f3035SHideki Saito   }
719ea7f3035SHideki Saito 
7201f58dda4SAyal Zaks   // 3. Merge the temporary latch created with the last basic-block filled.
7211f58dda4SAyal Zaks   BasicBlock *LastBB = State->CFG.PrevBB;
7221f58dda4SAyal Zaks   // Connect LastBB to VectorLatchBB to facilitate their merge.
723ea7f3035SHideki Saito   assert((EnableVPlanNativePath ||
724ea7f3035SHideki Saito           isa<UnreachableInst>(LastBB->getTerminator())) &&
725ea7f3035SHideki Saito          "Expected InnerLoop VPlan CFG to terminate with unreachable");
726ea7f3035SHideki Saito   assert((!EnableVPlanNativePath || isa<BranchInst>(LastBB->getTerminator())) &&
727ea7f3035SHideki Saito          "Expected VPlan CFG to terminate with branch in NativePath");
7281f58dda4SAyal Zaks   LastBB->getTerminator()->eraseFromParent();
7291f58dda4SAyal Zaks   BranchInst::Create(VectorLatchBB, LastBB);
7301f58dda4SAyal Zaks 
7311f58dda4SAyal Zaks   // Merge LastBB with Latch.
7321f58dda4SAyal Zaks   bool Merged = MergeBlockIntoPredecessor(VectorLatchBB, nullptr, State->LI);
7331f58dda4SAyal Zaks   (void)Merged;
7341f58dda4SAyal Zaks   assert(Merged && "Could not merge last basic block with latch.");
7351f58dda4SAyal Zaks   VectorLatchBB = LastBB;
7361f58dda4SAyal Zaks 
737ea7f3035SHideki Saito   // We do not attempt to preserve DT for outer loop vectorization currently.
738ea7f3035SHideki Saito   if (!EnableVPlanNativePath)
739948e7452SEvgeniy Brevnov     updateDominatorTree(State->DT, VectorPreHeaderBB, VectorLatchBB,
740948e7452SEvgeniy Brevnov                         L->getExitBlock());
7411f58dda4SAyal Zaks }
7421f58dda4SAyal Zaks 
74392205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
74493a9d2deSAndrei Elovikov LLVM_DUMP_METHOD
74593a9d2deSAndrei Elovikov void VPlan::print(raw_ostream &O) const {
74693a9d2deSAndrei Elovikov   VPSlotTracker SlotTracker(this);
74793a9d2deSAndrei Elovikov 
748f759d512SFlorian Hahn   O << "VPlan '" << Name << "' {";
74993a9d2deSAndrei Elovikov   for (const VPBlockBase *Block : depth_first(getEntry())) {
75093a9d2deSAndrei Elovikov     O << '\n';
75193a9d2deSAndrei Elovikov     Block->print(O, "", SlotTracker);
75293a9d2deSAndrei Elovikov   }
75393a9d2deSAndrei Elovikov   O << "}\n";
75493a9d2deSAndrei Elovikov }
75593a9d2deSAndrei Elovikov 
75693a9d2deSAndrei Elovikov LLVM_DUMP_METHOD
75793a9d2deSAndrei Elovikov void VPlan::printDOT(raw_ostream &O) const {
75893a9d2deSAndrei Elovikov   VPlanPrinter Printer(O, *this);
75993a9d2deSAndrei Elovikov   Printer.dump();
76093a9d2deSAndrei Elovikov }
76193a9d2deSAndrei Elovikov 
762e9c68422SFlorian Hahn LLVM_DUMP_METHOD
76393a9d2deSAndrei Elovikov void VPlan::dump() const { print(dbgs()); }
764e9c68422SFlorian Hahn #endif
765e9c68422SFlorian Hahn 
7661f58dda4SAyal Zaks void VPlan::updateDominatorTree(DominatorTree *DT, BasicBlock *LoopPreHeaderBB,
767948e7452SEvgeniy Brevnov                                 BasicBlock *LoopLatchBB,
768948e7452SEvgeniy Brevnov                                 BasicBlock *LoopExitBB) {
7691f58dda4SAyal Zaks   BasicBlock *LoopHeaderBB = LoopPreHeaderBB->getSingleSuccessor();
7701f58dda4SAyal Zaks   assert(LoopHeaderBB && "Loop preheader does not have a single successor.");
7711f58dda4SAyal Zaks   // The vector body may be more than a single basic-block by this point.
7721f58dda4SAyal Zaks   // Update the dominator tree information inside the vector body by propagating
7731f58dda4SAyal Zaks   // it from header to latch, expecting only triangular control-flow, if any.
7741f58dda4SAyal Zaks   BasicBlock *PostDomSucc = nullptr;
7751f58dda4SAyal Zaks   for (auto *BB = LoopHeaderBB; BB != LoopLatchBB; BB = PostDomSucc) {
7761f58dda4SAyal Zaks     // Get the list of successors of this block.
7771f58dda4SAyal Zaks     std::vector<BasicBlock *> Succs(succ_begin(BB), succ_end(BB));
7781f58dda4SAyal Zaks     assert(Succs.size() <= 2 &&
7791f58dda4SAyal Zaks            "Basic block in vector loop has more than 2 successors.");
7801f58dda4SAyal Zaks     PostDomSucc = Succs[0];
7811f58dda4SAyal Zaks     if (Succs.size() == 1) {
7821f58dda4SAyal Zaks       assert(PostDomSucc->getSinglePredecessor() &&
7831f58dda4SAyal Zaks              "PostDom successor has more than one predecessor.");
7841f58dda4SAyal Zaks       DT->addNewBlock(PostDomSucc, BB);
7851f58dda4SAyal Zaks       continue;
7861f58dda4SAyal Zaks     }
7871f58dda4SAyal Zaks     BasicBlock *InterimSucc = Succs[1];
7881f58dda4SAyal Zaks     if (PostDomSucc->getSingleSuccessor() == InterimSucc) {
7891f58dda4SAyal Zaks       PostDomSucc = Succs[1];
7901f58dda4SAyal Zaks       InterimSucc = Succs[0];
7911f58dda4SAyal Zaks     }
7921f58dda4SAyal Zaks     assert(InterimSucc->getSingleSuccessor() == PostDomSucc &&
7931f58dda4SAyal Zaks            "One successor of a basic block does not lead to the other.");
7941f58dda4SAyal Zaks     assert(InterimSucc->getSinglePredecessor() &&
7951f58dda4SAyal Zaks            "Interim successor has more than one predecessor.");
7964de31bbaSVedant Kumar     assert(PostDomSucc->hasNPredecessors(2) &&
7971f58dda4SAyal Zaks            "PostDom successor has more than two predecessors.");
7981f58dda4SAyal Zaks     DT->addNewBlock(InterimSucc, BB);
7991f58dda4SAyal Zaks     DT->addNewBlock(PostDomSucc, BB);
8001f58dda4SAyal Zaks   }
801948e7452SEvgeniy Brevnov   // Latch block is a new dominator for the loop exit.
802948e7452SEvgeniy Brevnov   DT->changeImmediateDominator(LoopExitBB, LoopLatchBB);
803948e7452SEvgeniy Brevnov   assert(DT->verify(DominatorTree::VerificationLevel::Fast));
8041f58dda4SAyal Zaks }
8051f58dda4SAyal Zaks 
80692205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
8071f58dda4SAyal Zaks const Twine VPlanPrinter::getUID(const VPBlockBase *Block) {
8081f58dda4SAyal Zaks   return (isa<VPRegionBlock>(Block) ? "cluster_N" : "N") +
8091f58dda4SAyal Zaks          Twine(getOrCreateBID(Block));
8101f58dda4SAyal Zaks }
8111f58dda4SAyal Zaks 
8121f58dda4SAyal Zaks const Twine VPlanPrinter::getOrCreateName(const VPBlockBase *Block) {
8131f58dda4SAyal Zaks   const std::string &Name = Block->getName();
8141f58dda4SAyal Zaks   if (!Name.empty())
8151f58dda4SAyal Zaks     return Name;
8161f58dda4SAyal Zaks   return "VPB" + Twine(getOrCreateBID(Block));
8171f58dda4SAyal Zaks }
8181f58dda4SAyal Zaks 
8191f58dda4SAyal Zaks void VPlanPrinter::dump() {
8201f58dda4SAyal Zaks   Depth = 1;
8211f58dda4SAyal Zaks   bumpIndent(0);
8221f58dda4SAyal Zaks   OS << "digraph VPlan {\n";
8231f58dda4SAyal Zaks   OS << "graph [labelloc=t, fontsize=30; label=\"Vectorization Plan";
8241f58dda4SAyal Zaks   if (!Plan.getName().empty())
8251f58dda4SAyal Zaks     OS << "\\n" << DOT::EscapeString(Plan.getName());
82640e7bfc4SFlorian Hahn   if (Plan.BackedgeTakenCount) {
827fd2c15e6SFlorian Hahn     OS << ", where:\\n";
82840e7bfc4SFlorian Hahn     Plan.BackedgeTakenCount->print(OS, SlotTracker);
82940e7bfc4SFlorian Hahn     OS << " := BackedgeTakenCount";
83040e7bfc4SFlorian Hahn   }
8311f58dda4SAyal Zaks   OS << "\"]\n";
8321f58dda4SAyal Zaks   OS << "node [shape=rect, fontname=Courier, fontsize=30]\n";
8331f58dda4SAyal Zaks   OS << "edge [fontname=Courier, fontsize=30]\n";
8341f58dda4SAyal Zaks   OS << "compound=true\n";
8351f58dda4SAyal Zaks 
836e9c68422SFlorian Hahn   for (const VPBlockBase *Block : depth_first(Plan.getEntry()))
8371f58dda4SAyal Zaks     dumpBlock(Block);
8381f58dda4SAyal Zaks 
8391f58dda4SAyal Zaks   OS << "}\n";
8401f58dda4SAyal Zaks }
8411f58dda4SAyal Zaks 
8421f58dda4SAyal Zaks void VPlanPrinter::dumpBlock(const VPBlockBase *Block) {
8431f58dda4SAyal Zaks   if (const VPBasicBlock *BasicBlock = dyn_cast<VPBasicBlock>(Block))
8441f58dda4SAyal Zaks     dumpBasicBlock(BasicBlock);
8451f58dda4SAyal Zaks   else if (const VPRegionBlock *Region = dyn_cast<VPRegionBlock>(Block))
8461f58dda4SAyal Zaks     dumpRegion(Region);
8471f58dda4SAyal Zaks   else
8481f58dda4SAyal Zaks     llvm_unreachable("Unsupported kind of VPBlock.");
8491f58dda4SAyal Zaks }
8501f58dda4SAyal Zaks 
8511f58dda4SAyal Zaks void VPlanPrinter::drawEdge(const VPBlockBase *From, const VPBlockBase *To,
8521f58dda4SAyal Zaks                             bool Hidden, const Twine &Label) {
8531f58dda4SAyal Zaks   // Due to "dot" we print an edge between two regions as an edge between the
8541f58dda4SAyal Zaks   // exit basic block and the entry basic of the respective regions.
8551f58dda4SAyal Zaks   const VPBlockBase *Tail = From->getExitBasicBlock();
8561f58dda4SAyal Zaks   const VPBlockBase *Head = To->getEntryBasicBlock();
8571f58dda4SAyal Zaks   OS << Indent << getUID(Tail) << " -> " << getUID(Head);
8581f58dda4SAyal Zaks   OS << " [ label=\"" << Label << '\"';
8591f58dda4SAyal Zaks   if (Tail != From)
8601f58dda4SAyal Zaks     OS << " ltail=" << getUID(From);
8611f58dda4SAyal Zaks   if (Head != To)
8621f58dda4SAyal Zaks     OS << " lhead=" << getUID(To);
8631f58dda4SAyal Zaks   if (Hidden)
8641f58dda4SAyal Zaks     OS << "; splines=none";
8651f58dda4SAyal Zaks   OS << "]\n";
8661f58dda4SAyal Zaks }
8671f58dda4SAyal Zaks 
8681f58dda4SAyal Zaks void VPlanPrinter::dumpEdges(const VPBlockBase *Block) {
8691f58dda4SAyal Zaks   auto &Successors = Block->getSuccessors();
8701f58dda4SAyal Zaks   if (Successors.size() == 1)
8711f58dda4SAyal Zaks     drawEdge(Block, Successors.front(), false, "");
8721f58dda4SAyal Zaks   else if (Successors.size() == 2) {
8731f58dda4SAyal Zaks     drawEdge(Block, Successors.front(), false, "T");
8741f58dda4SAyal Zaks     drawEdge(Block, Successors.back(), false, "F");
8751f58dda4SAyal Zaks   } else {
8761f58dda4SAyal Zaks     unsigned SuccessorNumber = 0;
8771f58dda4SAyal Zaks     for (auto *Successor : Successors)
8781f58dda4SAyal Zaks       drawEdge(Block, Successor, false, Twine(SuccessorNumber++));
8791f58dda4SAyal Zaks   }
8801f58dda4SAyal Zaks }
8811f58dda4SAyal Zaks 
8821f58dda4SAyal Zaks void VPlanPrinter::dumpBasicBlock(const VPBasicBlock *BasicBlock) {
88393a9d2deSAndrei Elovikov   // Implement dot-formatted dump by performing plain-text dump into the
88493a9d2deSAndrei Elovikov   // temporary storage followed by some post-processing.
8851f58dda4SAyal Zaks   OS << Indent << getUID(BasicBlock) << " [label =\n";
8861f58dda4SAyal Zaks   bumpIndent(1);
88793a9d2deSAndrei Elovikov   std::string Str;
88893a9d2deSAndrei Elovikov   raw_string_ostream SS(Str);
88993a9d2deSAndrei Elovikov   // Use no indentation as we need to wrap the lines into quotes ourselves.
89093a9d2deSAndrei Elovikov   BasicBlock->print(SS, "", SlotTracker);
8914e4ecae0SHideki Saito 
89293a9d2deSAndrei Elovikov   // We need to process each line of the output separately, so split
89393a9d2deSAndrei Elovikov   // single-string plain-text dump.
89493a9d2deSAndrei Elovikov   SmallVector<StringRef, 0> Lines;
89593a9d2deSAndrei Elovikov   StringRef(Str).rtrim('\n').split(Lines, "\n");
8964e4ecae0SHideki Saito 
89793a9d2deSAndrei Elovikov   auto EmitLine = [&](StringRef Line, StringRef Suffix) {
89893a9d2deSAndrei Elovikov     OS << Indent << '"' << DOT::EscapeString(Line.str()) << "\\l\"" << Suffix;
89993a9d2deSAndrei Elovikov   };
900d0953014SDiego Caballero 
90193a9d2deSAndrei Elovikov   // Don't need the "+" after the last line.
90293a9d2deSAndrei Elovikov   for (auto Line : make_range(Lines.begin(), Lines.end() - 1))
90393a9d2deSAndrei Elovikov     EmitLine(Line, " +\n");
90493a9d2deSAndrei Elovikov   EmitLine(Lines.back(), "\n");
905d0953014SDiego Caballero 
90693a9d2deSAndrei Elovikov   bumpIndent(-1);
90793a9d2deSAndrei Elovikov   OS << Indent << "]\n";
90893a9d2deSAndrei Elovikov 
9091f58dda4SAyal Zaks   dumpEdges(BasicBlock);
9101f58dda4SAyal Zaks }
9111f58dda4SAyal Zaks 
9121f58dda4SAyal Zaks void VPlanPrinter::dumpRegion(const VPRegionBlock *Region) {
9131f58dda4SAyal Zaks   OS << Indent << "subgraph " << getUID(Region) << " {\n";
9141f58dda4SAyal Zaks   bumpIndent(1);
9151f58dda4SAyal Zaks   OS << Indent << "fontname=Courier\n"
9161f58dda4SAyal Zaks      << Indent << "label=\""
9171f58dda4SAyal Zaks      << DOT::EscapeString(Region->isReplicator() ? "<xVFxUF> " : "<x1> ")
9181f58dda4SAyal Zaks      << DOT::EscapeString(Region->getName()) << "\"\n";
9191f58dda4SAyal Zaks   // Dump the blocks of the region.
9201f58dda4SAyal Zaks   assert(Region->getEntry() && "Region contains no inner blocks.");
9211f58dda4SAyal Zaks   for (const VPBlockBase *Block : depth_first(Region->getEntry()))
9221f58dda4SAyal Zaks     dumpBlock(Block);
9231f58dda4SAyal Zaks   bumpIndent(-1);
9241f58dda4SAyal Zaks   OS << Indent << "}\n";
9251f58dda4SAyal Zaks   dumpEdges(Region);
9261f58dda4SAyal Zaks }
9271f58dda4SAyal Zaks 
92893a9d2deSAndrei Elovikov void VPlanIngredient::print(raw_ostream &O) const {
9291f58dda4SAyal Zaks   if (auto *Inst = dyn_cast<Instruction>(V)) {
9301f58dda4SAyal Zaks     if (!Inst->getType()->isVoidTy()) {
93193a9d2deSAndrei Elovikov       Inst->printAsOperand(O, false);
93293a9d2deSAndrei Elovikov       O << " = ";
9331f58dda4SAyal Zaks     }
93493a9d2deSAndrei Elovikov     O << Inst->getOpcodeName() << " ";
9351f58dda4SAyal Zaks     unsigned E = Inst->getNumOperands();
9361f58dda4SAyal Zaks     if (E > 0) {
93793a9d2deSAndrei Elovikov       Inst->getOperand(0)->printAsOperand(O, false);
9381f58dda4SAyal Zaks       for (unsigned I = 1; I < E; ++I)
93993a9d2deSAndrei Elovikov         Inst->getOperand(I)->printAsOperand(O << ", ", false);
9401f58dda4SAyal Zaks     }
9411f58dda4SAyal Zaks   } else // !Inst
94293a9d2deSAndrei Elovikov     V->printAsOperand(O, false);
9431f58dda4SAyal Zaks }
9447333aa9fSHal Finkel 
94590be3c24SFlorian Hahn void VPWidenCallRecipe::print(raw_ostream &O, const Twine &Indent,
94690be3c24SFlorian Hahn                               VPSlotTracker &SlotTracker) const {
947b24afec8SAndrei Elovikov   O << Indent << "WIDEN-CALL ";
948fec64de2SFlorian Hahn 
949fec64de2SFlorian Hahn   auto *CI = cast<CallInst>(getUnderlyingInstr());
950fec64de2SFlorian Hahn   if (CI->getType()->isVoidTy())
951fec64de2SFlorian Hahn     O << "void ";
952fec64de2SFlorian Hahn   else {
953fec64de2SFlorian Hahn     printAsOperand(O, SlotTracker);
954fec64de2SFlorian Hahn     O << " = ";
955fec64de2SFlorian Hahn   }
956fec64de2SFlorian Hahn 
957fec64de2SFlorian Hahn   O << "call @" << CI->getCalledFunction()->getName() << "(";
958fec64de2SFlorian Hahn   printOperands(O, SlotTracker);
959fec64de2SFlorian Hahn   O << ")";
96090be3c24SFlorian Hahn }
96190be3c24SFlorian Hahn 
96218138e02SFlorian Hahn void VPWidenSelectRecipe::print(raw_ostream &O, const Twine &Indent,
96318138e02SFlorian Hahn                                 VPSlotTracker &SlotTracker) const {
964b24afec8SAndrei Elovikov   O << Indent << "WIDEN-SELECT ";
965a70b511eSFlorian Hahn   printAsOperand(O, SlotTracker);
966a70b511eSFlorian Hahn   O << " = select ";
967a70b511eSFlorian Hahn   getOperand(0)->printAsOperand(O, SlotTracker);
968a70b511eSFlorian Hahn   O << ", ";
969a70b511eSFlorian Hahn   getOperand(1)->printAsOperand(O, SlotTracker);
970a70b511eSFlorian Hahn   O << ", ";
971a70b511eSFlorian Hahn   getOperand(2)->printAsOperand(O, SlotTracker);
972a70b511eSFlorian Hahn   O << (InvariantCond ? " (condition is loop invariant)" : "");
97318138e02SFlorian Hahn }
97418138e02SFlorian Hahn 
97540e7bfc4SFlorian Hahn void VPWidenRecipe::print(raw_ostream &O, const Twine &Indent,
97640e7bfc4SFlorian Hahn                           VPSlotTracker &SlotTracker) const {
977b24afec8SAndrei Elovikov   O << Indent << "WIDEN ";
978e0c479cdSDavid Green   printAsOperand(O, SlotTracker);
979e0c479cdSDavid Green   O << " = " << getUnderlyingInstr()->getOpcodeName() << " ";
980e0c479cdSDavid Green   printOperands(O, SlotTracker);
9817333aa9fSHal Finkel }
9827333aa9fSHal Finkel 
98340e7bfc4SFlorian Hahn void VPWidenIntOrFpInductionRecipe::print(raw_ostream &O, const Twine &Indent,
98440e7bfc4SFlorian Hahn                                           VPSlotTracker &SlotTracker) const {
985b24afec8SAndrei Elovikov   O << Indent << "WIDEN-INDUCTION";
986daaa0e35SFlorian Hahn   if (getTruncInst()) {
9877333aa9fSHal Finkel     O << "\\l\"";
9887333aa9fSHal Finkel     O << " +\n" << Indent << "\"  " << VPlanIngredient(IV) << "\\l\"";
989daaa0e35SFlorian Hahn     O << " +\n" << Indent << "\"  ";
990daaa0e35SFlorian Hahn     getVPValue(0)->printAsOperand(O, SlotTracker);
9917333aa9fSHal Finkel   } else
9924c8285c7SFlorian Hahn     O << " " << VPlanIngredient(IV);
9937333aa9fSHal Finkel }
9947333aa9fSHal Finkel 
99540e7bfc4SFlorian Hahn void VPWidenGEPRecipe::print(raw_ostream &O, const Twine &Indent,
99640e7bfc4SFlorian Hahn                              VPSlotTracker &SlotTracker) const {
997b24afec8SAndrei Elovikov   O << Indent << "WIDEN-GEP ";
99839ccc099SGil Rapaport   O << (IsPtrLoopInvariant ? "Inv" : "Var");
99939ccc099SGil Rapaport   size_t IndicesNumber = IsIndexLoopInvariant.size();
100039ccc099SGil Rapaport   for (size_t I = 0; I < IndicesNumber; ++I)
100139ccc099SGil Rapaport     O << "[" << (IsIndexLoopInvariant[I] ? "Inv" : "Var") << "]";
10020c119ba8SFlorian Hahn 
10030c119ba8SFlorian Hahn   O << " ";
10040c119ba8SFlorian Hahn   printAsOperand(O, SlotTracker);
10050c119ba8SFlorian Hahn   O << " = getelementptr ";
10060c119ba8SFlorian Hahn   printOperands(O, SlotTracker);
100739ccc099SGil Rapaport }
100839ccc099SGil Rapaport 
100940e7bfc4SFlorian Hahn void VPWidenPHIRecipe::print(raw_ostream &O, const Twine &Indent,
101040e7bfc4SFlorian Hahn                              VPSlotTracker &SlotTracker) const {
1011*a6b06b78SFlorian Hahn   O << Indent << "WIDEN-PHI ";
1012*a6b06b78SFlorian Hahn 
1013*a6b06b78SFlorian Hahn   auto *OriginalPhi = cast<PHINode>(getUnderlyingValue());
1014*a6b06b78SFlorian Hahn   // Unless all incoming values are modeled in VPlan  print the original PHI
1015*a6b06b78SFlorian Hahn   // directly.
1016*a6b06b78SFlorian Hahn   // TODO: Remove once all VPWidenPHIRecipe instances keep all relevant incoming
1017*a6b06b78SFlorian Hahn   // values as VPValues.
1018*a6b06b78SFlorian Hahn   if (getNumOperands() != OriginalPhi->getNumOperands()) {
1019*a6b06b78SFlorian Hahn     O << VPlanIngredient(OriginalPhi);
1020*a6b06b78SFlorian Hahn     return;
1021*a6b06b78SFlorian Hahn   }
1022*a6b06b78SFlorian Hahn 
1023*a6b06b78SFlorian Hahn   printAsOperand(O, SlotTracker);
1024*a6b06b78SFlorian Hahn   O << " = phi ";
1025*a6b06b78SFlorian Hahn   printOperands(O, SlotTracker);
10267333aa9fSHal Finkel }
10277333aa9fSHal Finkel 
102840e7bfc4SFlorian Hahn void VPBlendRecipe::print(raw_ostream &O, const Twine &Indent,
102940e7bfc4SFlorian Hahn                           VPSlotTracker &SlotTracker) const {
1030b24afec8SAndrei Elovikov   O << Indent << "BLEND ";
10317333aa9fSHal Finkel   Phi->printAsOperand(O, false);
10327333aa9fSHal Finkel   O << " =";
1033e2a18678SGil Rapaport   if (getNumIncomingValues() == 1) {
10347333aa9fSHal Finkel     // Not a User of any mask: not really blending, this is a
10357333aa9fSHal Finkel     // single-predecessor phi.
10367333aa9fSHal Finkel     O << " ";
1037e2a18678SGil Rapaport     getIncomingValue(0)->printAsOperand(O, SlotTracker);
10387333aa9fSHal Finkel   } else {
1039e2a18678SGil Rapaport     for (unsigned I = 0, E = getNumIncomingValues(); I < E; ++I) {
10407333aa9fSHal Finkel       O << " ";
1041e2a18678SGil Rapaport       getIncomingValue(I)->printAsOperand(O, SlotTracker);
10427333aa9fSHal Finkel       O << "/";
1043e2a18678SGil Rapaport       getMask(I)->printAsOperand(O, SlotTracker);
10447333aa9fSHal Finkel     }
10457333aa9fSHal Finkel   }
10467333aa9fSHal Finkel }
10477333aa9fSHal Finkel 
1048745bf6cfSDavid Green void VPReductionRecipe::print(raw_ostream &O, const Twine &Indent,
1049745bf6cfSDavid Green                               VPSlotTracker &SlotTracker) const {
1050b24afec8SAndrei Elovikov   O << Indent << "REDUCE ";
105100a66011SDavid Green   printAsOperand(O, SlotTracker);
105200a66011SDavid Green   O << " = ";
105300a66011SDavid Green   getChainOp()->printAsOperand(O, SlotTracker);
105436263a7cSSanjay Patel   O << " + reduce." << Instruction::getOpcodeName(RdxDesc->getOpcode())
105500a66011SDavid Green     << " (";
105600a66011SDavid Green   getVecOp()->printAsOperand(O, SlotTracker);
105700a66011SDavid Green   if (getCondOp()) {
1058be6e8e50SDavid Green     O << ", ";
105900a66011SDavid Green     getCondOp()->printAsOperand(O, SlotTracker);
1060be6e8e50SDavid Green   }
1061745bf6cfSDavid Green   O << ")";
1062745bf6cfSDavid Green }
1063745bf6cfSDavid Green 
106440e7bfc4SFlorian Hahn void VPReplicateRecipe::print(raw_ostream &O, const Twine &Indent,
106540e7bfc4SFlorian Hahn                               VPSlotTracker &SlotTracker) const {
1066b24afec8SAndrei Elovikov   O << Indent << (IsUniform ? "CLONE " : "REPLICATE ");
10674bc9b909SFlorian Hahn 
10684bc9b909SFlorian Hahn   if (!getUnderlyingInstr()->getType()->isVoidTy()) {
10694bc9b909SFlorian Hahn     printAsOperand(O, SlotTracker);
10704bc9b909SFlorian Hahn     O << " = ";
10714bc9b909SFlorian Hahn   }
10724bc9b909SFlorian Hahn   O << Instruction::getOpcodeName(getUnderlyingInstr()->getOpcode()) << " ";
10734bc9b909SFlorian Hahn   printOperands(O, SlotTracker);
10744bc9b909SFlorian Hahn 
10757333aa9fSHal Finkel   if (AlsoPack)
10767333aa9fSHal Finkel     O << " (S->V)";
10777333aa9fSHal Finkel }
10787333aa9fSHal Finkel 
107940e7bfc4SFlorian Hahn void VPPredInstPHIRecipe::print(raw_ostream &O, const Twine &Indent,
108040e7bfc4SFlorian Hahn                                 VPSlotTracker &SlotTracker) const {
1081b24afec8SAndrei Elovikov   O << Indent << "PHI-PREDICATED-INSTRUCTION ";
108254a14c26SFlorian Hahn   printAsOperand(O, SlotTracker);
108354a14c26SFlorian Hahn   O << " = ";
1084fe83adb0SFlorian Hahn   printOperands(O, SlotTracker);
10857333aa9fSHal Finkel }
10867333aa9fSHal Finkel 
108740e7bfc4SFlorian Hahn void VPWidenMemoryInstructionRecipe::print(raw_ostream &O, const Twine &Indent,
108840e7bfc4SFlorian Hahn                                            VPSlotTracker &SlotTracker) const {
1089b24afec8SAndrei Elovikov   O << Indent << "WIDEN ";
1090f0d76275SFlorian Hahn 
1091f0d76275SFlorian Hahn   if (!isStore()) {
1092e42e5263SFlorian Hahn     getVPValue()->printAsOperand(O, SlotTracker);
1093f0d76275SFlorian Hahn     O << " = ";
1094f0d76275SFlorian Hahn   }
1095e42e5263SFlorian Hahn   O << Instruction::getOpcodeName(Ingredient.getOpcode()) << " ";
1096ea058d28SFlorian Hahn 
1097091c5c9aSFlorian Hahn   printOperands(O, SlotTracker);
10987333aa9fSHal Finkel }
109992205cb2SAndrei Elovikov #endif
11002a34ac86SDiego Caballero 
110116784892SAyal Zaks void VPWidenCanonicalIVRecipe::execute(VPTransformState &State) {
110216784892SAyal Zaks   Value *CanonicalIV = State.CanonicalIV;
110316784892SAyal Zaks   Type *STy = CanonicalIV->getType();
110416784892SAyal Zaks   IRBuilder<> Builder(State.CFG.PrevBB->getTerminator());
11055a34b3abSFrancesco Petrogalli   ElementCount VF = State.VF;
1106f4257c58SDavid Sherwood   assert(!VF.isScalable() && "the code following assumes non scalables ECs");
1107f4257c58SDavid Sherwood   Value *VStart = VF.isScalar()
1108f4257c58SDavid Sherwood                       ? CanonicalIV
1109f4257c58SDavid Sherwood                       : Builder.CreateVectorSplat(VF.getKnownMinValue(),
1110f4257c58SDavid Sherwood                                                   CanonicalIV, "broadcast");
111116784892SAyal Zaks   for (unsigned Part = 0, UF = State.UF; Part < UF; ++Part) {
111216784892SAyal Zaks     SmallVector<Constant *, 8> Indices;
1113f4257c58SDavid Sherwood     for (unsigned Lane = 0; Lane < VF.getKnownMinValue(); ++Lane)
1114f4257c58SDavid Sherwood       Indices.push_back(
1115f4257c58SDavid Sherwood           ConstantInt::get(STy, Part * VF.getKnownMinValue() + Lane));
111613bf6039SAnh Tuyen Tran     // If VF == 1, there is only one iteration in the loop above, thus the
111713bf6039SAnh Tuyen Tran     // element pushed back into Indices is ConstantInt::get(STy, Part)
1118c5ba0d33SDavid Sherwood     Constant *VStep =
1119c5ba0d33SDavid Sherwood         VF.isScalar() ? Indices.back() : ConstantVector::get(Indices);
112016784892SAyal Zaks     // Add the consecutive indices to the vector value.
112116784892SAyal Zaks     Value *CanonicalVectorIV = Builder.CreateAdd(VStart, VStep, "vec.iv");
112216784892SAyal Zaks     State.set(getVPValue(), CanonicalVectorIV, Part);
112316784892SAyal Zaks   }
112416784892SAyal Zaks }
112516784892SAyal Zaks 
112692205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
112716784892SAyal Zaks void VPWidenCanonicalIVRecipe::print(raw_ostream &O, const Twine &Indent,
112816784892SAyal Zaks                                      VPSlotTracker &SlotTracker) const {
1129b24afec8SAndrei Elovikov   O << Indent << "EMIT ";
113016784892SAyal Zaks   getVPValue()->printAsOperand(O, SlotTracker);
11314c8285c7SFlorian Hahn   O << " = WIDEN-CANONICAL-INDUCTION";
113216784892SAyal Zaks }
113392205cb2SAndrei Elovikov #endif
113416784892SAyal Zaks 
11352a34ac86SDiego Caballero template void DomTreeBuilder::Calculate<VPDominatorTree>(VPDominatorTree &DT);
1136a4dc7feeSFlorian Hahn 
113709e516c5SFlorian Hahn void VPValue::replaceAllUsesWith(VPValue *New) {
1138f5fe7abeSFlorian Hahn   for (unsigned J = 0; J < getNumUsers();) {
1139f5fe7abeSFlorian Hahn     VPUser *User = Users[J];
1140f5fe7abeSFlorian Hahn     unsigned NumUsers = getNumUsers();
114109e516c5SFlorian Hahn     for (unsigned I = 0, E = User->getNumOperands(); I < E; ++I)
114209e516c5SFlorian Hahn       if (User->getOperand(I) == this)
114309e516c5SFlorian Hahn         User->setOperand(I, New);
1144f5fe7abeSFlorian Hahn     // If a user got removed after updating the current user, the next user to
1145f5fe7abeSFlorian Hahn     // update will be moved to the current position, so we only need to
1146f5fe7abeSFlorian Hahn     // increment the index if the number of users did not change.
1147f5fe7abeSFlorian Hahn     if (NumUsers == getNumUsers())
1148f5fe7abeSFlorian Hahn       J++;
1149f5fe7abeSFlorian Hahn   }
115009e516c5SFlorian Hahn }
115109e516c5SFlorian Hahn 
115292205cb2SAndrei Elovikov #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
115340e7bfc4SFlorian Hahn void VPValue::printAsOperand(raw_ostream &OS, VPSlotTracker &Tracker) const {
1154e6a74803SFlorian Hahn   if (const Value *UV = getUnderlyingValue()) {
1155e6a74803SFlorian Hahn     OS << "ir<";
1156e6a74803SFlorian Hahn     UV->printAsOperand(OS, false);
1157e6a74803SFlorian Hahn     OS << ">";
1158e6a74803SFlorian Hahn     return;
1159e6a74803SFlorian Hahn   }
1160e6a74803SFlorian Hahn 
116140e7bfc4SFlorian Hahn   unsigned Slot = Tracker.getSlot(this);
116240e7bfc4SFlorian Hahn   if (Slot == unsigned(-1))
116340e7bfc4SFlorian Hahn     OS << "<badref>";
116440e7bfc4SFlorian Hahn   else
1165e6a74803SFlorian Hahn     OS << "vp<%" << Tracker.getSlot(this) << ">";
116640e7bfc4SFlorian Hahn }
116740e7bfc4SFlorian Hahn 
1168091c5c9aSFlorian Hahn void VPUser::printOperands(raw_ostream &O, VPSlotTracker &SlotTracker) const {
1169533f8576SFlorian Hahn   interleaveComma(operands(), O, [&O, &SlotTracker](VPValue *Op) {
1170091c5c9aSFlorian Hahn     Op->printAsOperand(O, SlotTracker);
1171533f8576SFlorian Hahn   });
1172091c5c9aSFlorian Hahn }
117392205cb2SAndrei Elovikov #endif
1174091c5c9aSFlorian Hahn 
1175a4dc7feeSFlorian Hahn void VPInterleavedAccessInfo::visitRegion(VPRegionBlock *Region,
1176a4dc7feeSFlorian Hahn                                           Old2NewTy &Old2New,
1177a4dc7feeSFlorian Hahn                                           InterleavedAccessInfo &IAI) {
1178a4dc7feeSFlorian Hahn   ReversePostOrderTraversal<VPBlockBase *> RPOT(Region->getEntry());
1179a4dc7feeSFlorian Hahn   for (VPBlockBase *Base : RPOT) {
1180a4dc7feeSFlorian Hahn     visitBlock(Base, Old2New, IAI);
1181a4dc7feeSFlorian Hahn   }
1182a4dc7feeSFlorian Hahn }
1183a4dc7feeSFlorian Hahn 
1184a4dc7feeSFlorian Hahn void VPInterleavedAccessInfo::visitBlock(VPBlockBase *Block, Old2NewTy &Old2New,
1185a4dc7feeSFlorian Hahn                                          InterleavedAccessInfo &IAI) {
1186a4dc7feeSFlorian Hahn   if (VPBasicBlock *VPBB = dyn_cast<VPBasicBlock>(Block)) {
1187a4dc7feeSFlorian Hahn     for (VPRecipeBase &VPI : *VPBB) {
1188c11fd0dfSFlorian Hahn       if (isa<VPWidenPHIRecipe>(&VPI))
1189c11fd0dfSFlorian Hahn         continue;
1190a4dc7feeSFlorian Hahn       assert(isa<VPInstruction>(&VPI) && "Can only handle VPInstructions");
1191a4dc7feeSFlorian Hahn       auto *VPInst = cast<VPInstruction>(&VPI);
1192a4dc7feeSFlorian Hahn       auto *Inst = cast<Instruction>(VPInst->getUnderlyingValue());
1193a4dc7feeSFlorian Hahn       auto *IG = IAI.getInterleaveGroup(Inst);
1194a4dc7feeSFlorian Hahn       if (!IG)
1195a4dc7feeSFlorian Hahn         continue;
1196a4dc7feeSFlorian Hahn 
1197a4dc7feeSFlorian Hahn       auto NewIGIter = Old2New.find(IG);
1198a4dc7feeSFlorian Hahn       if (NewIGIter == Old2New.end())
1199a4dc7feeSFlorian Hahn         Old2New[IG] = new InterleaveGroup<VPInstruction>(
120032851f8dSGuillaume Chatelet             IG->getFactor(), IG->isReverse(), IG->getAlign());
1201a4dc7feeSFlorian Hahn 
1202a4dc7feeSFlorian Hahn       if (Inst == IG->getInsertPos())
1203a4dc7feeSFlorian Hahn         Old2New[IG]->setInsertPos(VPInst);
1204a4dc7feeSFlorian Hahn 
1205a4dc7feeSFlorian Hahn       InterleaveGroupMap[VPInst] = Old2New[IG];
1206a4dc7feeSFlorian Hahn       InterleaveGroupMap[VPInst]->insertMember(
1207a4dc7feeSFlorian Hahn           VPInst, IG->getIndex(Inst),
1208837a1b84SGuillaume Chatelet           Align(IG->isReverse() ? (-1) * int(IG->getFactor())
1209837a1b84SGuillaume Chatelet                                 : IG->getFactor()));
1210a4dc7feeSFlorian Hahn     }
1211a4dc7feeSFlorian Hahn   } else if (VPRegionBlock *Region = dyn_cast<VPRegionBlock>(Block))
1212a4dc7feeSFlorian Hahn     visitRegion(Region, Old2New, IAI);
1213a4dc7feeSFlorian Hahn   else
1214a4dc7feeSFlorian Hahn     llvm_unreachable("Unsupported kind of VPBlock.");
1215a4dc7feeSFlorian Hahn }
1216a4dc7feeSFlorian Hahn 
1217a4dc7feeSFlorian Hahn VPInterleavedAccessInfo::VPInterleavedAccessInfo(VPlan &Plan,
1218a4dc7feeSFlorian Hahn                                                  InterleavedAccessInfo &IAI) {
1219a4dc7feeSFlorian Hahn   Old2NewTy Old2New;
1220a4dc7feeSFlorian Hahn   visitRegion(cast<VPRegionBlock>(Plan.getEntry()), Old2New, IAI);
1221a4dc7feeSFlorian Hahn }
122240e7bfc4SFlorian Hahn 
122340e7bfc4SFlorian Hahn void VPSlotTracker::assignSlot(const VPValue *V) {
122440e7bfc4SFlorian Hahn   assert(Slots.find(V) == Slots.end() && "VPValue already has a slot!");
122540e7bfc4SFlorian Hahn   Slots[V] = NextSlot++;
122640e7bfc4SFlorian Hahn }
122740e7bfc4SFlorian Hahn 
122840e7bfc4SFlorian Hahn void VPSlotTracker::assignSlots(const VPBlockBase *VPBB) {
122940e7bfc4SFlorian Hahn   if (auto *Region = dyn_cast<VPRegionBlock>(VPBB))
123040e7bfc4SFlorian Hahn     assignSlots(Region);
123140e7bfc4SFlorian Hahn   else
123240e7bfc4SFlorian Hahn     assignSlots(cast<VPBasicBlock>(VPBB));
123340e7bfc4SFlorian Hahn }
123440e7bfc4SFlorian Hahn 
123540e7bfc4SFlorian Hahn void VPSlotTracker::assignSlots(const VPRegionBlock *Region) {
123640e7bfc4SFlorian Hahn   ReversePostOrderTraversal<const VPBlockBase *> RPOT(Region->getEntry());
123740e7bfc4SFlorian Hahn   for (const VPBlockBase *Block : RPOT)
123840e7bfc4SFlorian Hahn     assignSlots(Block);
123940e7bfc4SFlorian Hahn }
124040e7bfc4SFlorian Hahn 
124140e7bfc4SFlorian Hahn void VPSlotTracker::assignSlots(const VPBasicBlock *VPBB) {
124240e7bfc4SFlorian Hahn   for (const VPRecipeBase &Recipe : *VPBB) {
1243eb0371e4SFlorian Hahn     for (VPValue *Def : Recipe.definedValues())
1244eb0371e4SFlorian Hahn       assignSlot(Def);
124540e7bfc4SFlorian Hahn   }
124640e7bfc4SFlorian Hahn }
124740e7bfc4SFlorian Hahn 
124840e7bfc4SFlorian Hahn void VPSlotTracker::assignSlots(const VPlan &Plan) {
124940e7bfc4SFlorian Hahn 
125040e7bfc4SFlorian Hahn   for (const VPValue *V : Plan.VPExternalDefs)
125140e7bfc4SFlorian Hahn     assignSlot(V);
125240e7bfc4SFlorian Hahn 
125340e7bfc4SFlorian Hahn   if (Plan.BackedgeTakenCount)
125440e7bfc4SFlorian Hahn     assignSlot(Plan.BackedgeTakenCount);
125540e7bfc4SFlorian Hahn 
125640e7bfc4SFlorian Hahn   ReversePostOrderTraversal<const VPBlockBase *> RPOT(Plan.getEntry());
125740e7bfc4SFlorian Hahn   for (const VPBlockBase *Block : RPOT)
125840e7bfc4SFlorian Hahn     assignSlots(Block);
125940e7bfc4SFlorian Hahn }
1260