LLVM 22.0.0git
VPlan.cpp
Go to the documentation of this file.
1//===- VPlan.cpp - Vectorizer Plan ----------------------------------------===//
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/// \file
10/// This is the LLVM vectorization plan. It represents a candidate for
11/// vectorization, allowing to plan and optimize how to vectorize a given loop
12/// before generating LLVM-IR.
13/// The vectorizer uses vectorization plans to estimate the costs of potential
14/// candidates and if profitable to execute the desired plan, generating vector
15/// LLVM-IR code.
16///
17//===----------------------------------------------------------------------===//
18
19#include "VPlan.h"
21#include "VPlanCFG.h"
22#include "VPlanDominatorTree.h"
23#include "VPlanHelpers.h"
24#include "VPlanPatternMatch.h"
25#include "VPlanTransforms.h"
26#include "VPlanUtils.h"
28#include "llvm/ADT/STLExtras.h"
31#include "llvm/ADT/Twine.h"
34#include "llvm/IR/BasicBlock.h"
35#include "llvm/IR/CFG.h"
36#include "llvm/IR/IRBuilder.h"
37#include "llvm/IR/Instruction.h"
39#include "llvm/IR/Type.h"
40#include "llvm/IR/Value.h"
43#include "llvm/Support/Debug.h"
49#include <cassert>
50#include <string>
51
52using namespace llvm;
53using namespace llvm::VPlanPatternMatch;
54
55namespace llvm {
57}
58
59/// @{
60/// Metadata attribute names
61const char LLVMLoopVectorizeFollowupAll[] = "llvm.loop.vectorize.followup_all";
63 "llvm.loop.vectorize.followup_vectorized";
65 "llvm.loop.vectorize.followup_epilogue";
66/// @}
67
69
71 "vplan-print-in-dot-format", cl::Hidden,
72 cl::desc("Use dot format instead of plain text when dumping VPlans"));
73
74#define DEBUG_TYPE "loop-vectorize"
75
76#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
78 const VPBasicBlock *Parent = R.getParent();
79 VPSlotTracker SlotTracker(Parent ? Parent->getPlan() : nullptr);
80 R.print(OS, "", SlotTracker);
81 return OS;
82}
83#endif
84
86 const ElementCount &VF) const {
87 switch (LaneKind) {
89 // Lane = RuntimeVF - VF.getKnownMinValue() + Lane
90 return Builder.CreateSub(getRuntimeVF(Builder, Builder.getInt32Ty(), VF),
91 Builder.getInt32(VF.getKnownMinValue() - Lane));
93 return Builder.getInt32(Lane);
94 }
95 llvm_unreachable("Unknown lane kind");
96}
97
98VPValue::VPValue(const unsigned char SC, Value *UV, VPDef *Def)
99 : SubclassID(SC), UnderlyingVal(UV), Def(Def) {
100 if (Def)
101 Def->addDefinedValue(this);
102}
103
105 assert(Users.empty() && "trying to delete a VPValue with remaining users");
106 if (Def)
107 Def->removeDefinedValue(this);
108}
109
110#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
113 R->print(OS, "", SlotTracker);
114 else
116}
117
118void VPValue::dump() const {
119 const VPRecipeBase *Instr = dyn_cast_or_null<VPRecipeBase>(this->Def);
121 (Instr && Instr->getParent()) ? Instr->getParent()->getPlan() : nullptr);
123 dbgs() << "\n";
124}
125
126void VPDef::dump() const {
127 const VPRecipeBase *Instr = dyn_cast_or_null<VPRecipeBase>(this);
129 (Instr && Instr->getParent()) ? Instr->getParent()->getPlan() : nullptr);
130 print(dbgs(), "", SlotTracker);
131 dbgs() << "\n";
132}
133#endif
134
138
142
143// Get the top-most entry block of \p Start. This is the entry block of the
144// containing VPlan. This function is templated to support both const and non-const blocks
145template <typename T> static T *getPlanEntry(T *Start) {
146 T *Next = Start;
147 T *Current = Start;
148 while ((Next = Next->getParent()))
149 Current = Next;
150
151 SmallSetVector<T *, 8> WorkList;
152 WorkList.insert(Current);
153
154 for (unsigned i = 0; i < WorkList.size(); i++) {
155 T *Current = WorkList[i];
156 if (!Current->hasPredecessors())
157 return Current;
158 auto &Predecessors = Current->getPredecessors();
159 WorkList.insert_range(Predecessors);
160 }
161
162 llvm_unreachable("VPlan without any entry node without predecessors");
163}
164
165VPlan *VPBlockBase::getPlan() { return getPlanEntry(this)->Plan; }
166
167const VPlan *VPBlockBase::getPlan() const { return getPlanEntry(this)->Plan; }
168
169/// \return the VPBasicBlock that is the entry of Block, possibly indirectly.
176
183
184void VPBlockBase::setPlan(VPlan *ParentPlan) {
185 assert(ParentPlan->getEntry() == this && "Can only set plan on its entry.");
186 Plan = ParentPlan;
187}
188
189/// \return the VPBasicBlock that is the exit of Block, possibly indirectly.
191 const VPBlockBase *Block = this;
193 Block = Region->getExiting();
195}
196
203
205 if (!Successors.empty() || !Parent)
206 return this;
207 assert(Parent->getExiting() == this &&
208 "Block w/o successors not the exiting block of its parent.");
209 return Parent->getEnclosingBlockWithSuccessors();
210}
211
213 if (!Predecessors.empty() || !Parent)
214 return this;
215 assert(Parent->getEntry() == this &&
216 "Block w/o predecessors not the entry of its parent.");
217 return Parent->getEnclosingBlockWithPredecessors();
218}
219
221 const VPDominatorTree &VPDT) {
222 auto *VPBB = dyn_cast<VPBasicBlock>(VPB);
223 if (!VPBB)
224 return false;
225
226 // If VPBB is in a region R, VPBB is a loop header if R is a loop region with
227 // VPBB as its entry, i.e., free of predecessors.
228 if (auto *R = VPBB->getParent())
229 return !R->isReplicator() && !VPBB->hasPredecessors();
230
231 // A header dominates its second predecessor (the latch), with the other
232 // predecessor being the preheader
233 return VPB->getPredecessors().size() == 2 &&
234 VPDT.dominates(VPB, VPB->getPredecessors()[1]);
235}
236
238 const VPDominatorTree &VPDT) {
239 // A latch has a header as its second successor, with its other successor
240 // leaving the loop. A preheader OTOH has a header as its first (and only)
241 // successor.
242 return VPB->getNumSuccessors() == 2 &&
243 VPBlockUtils::isHeader(VPB->getSuccessors()[1], VPDT);
244}
245
247 iterator It = begin();
248 while (It != end() && It->isPhi())
249 It++;
250 return It;
251}
252
260
262 if (Def->isLiveIn())
263 return Def->getLiveInIRValue();
264
265 if (hasScalarValue(Def, Lane))
266 return Data.VPV2Scalars[Def][Lane.mapToCacheIndex(VF)];
267
268 if (!Lane.isFirstLane() && vputils::isSingleScalar(Def) &&
270 return Data.VPV2Scalars[Def][0];
271 }
272
273 // Look through BuildVector to avoid redundant extracts.
274 // TODO: Remove once replicate regions are unrolled explicitly.
275 if (Lane.getKind() == VPLane::Kind::First && match(Def, m_BuildVector())) {
276 auto *BuildVector = cast<VPInstruction>(Def);
277 return get(BuildVector->getOperand(Lane.getKnownLane()), true);
278 }
279
281 auto *VecPart = Data.VPV2Vector[Def];
282 if (!VecPart->getType()->isVectorTy()) {
283 assert(Lane.isFirstLane() && "cannot get lane > 0 for scalar");
284 return VecPart;
285 }
286 // TODO: Cache created scalar values.
287 Value *LaneV = Lane.getAsRuntimeExpr(Builder, VF);
288 auto *Extract = Builder.CreateExtractElement(VecPart, LaneV);
289 // set(Def, Extract, Instance);
290 return Extract;
291}
292
293Value *VPTransformState::get(const VPValue *Def, bool NeedsScalar) {
294 if (NeedsScalar) {
295 assert((VF.isScalar() || Def->isLiveIn() || hasVectorValue(Def) ||
297 (hasScalarValue(Def, VPLane(0)) &&
298 Data.VPV2Scalars[Def].size() == 1)) &&
299 "Trying to access a single scalar per part but has multiple scalars "
300 "per part.");
301 return get(Def, VPLane(0));
302 }
303
304 // If Values have been set for this Def return the one relevant for \p Part.
305 if (hasVectorValue(Def))
306 return Data.VPV2Vector[Def];
307
308 auto GetBroadcastInstrs = [this](Value *V) {
309 if (VF.isScalar())
310 return V;
311 // Broadcast the scalar into all locations in the vector.
312 Value *Shuf = Builder.CreateVectorSplat(VF, V, "broadcast");
313 return Shuf;
314 };
315
316 if (!hasScalarValue(Def, {0})) {
317 assert(Def->isLiveIn() && "expected a live-in");
318 Value *IRV = Def->getLiveInIRValue();
319 Value *B = GetBroadcastInstrs(IRV);
320 set(Def, B);
321 return B;
322 }
323
324 Value *ScalarValue = get(Def, VPLane(0));
325 // If we aren't vectorizing, we can just copy the scalar map values over
326 // to the vector map.
327 if (VF.isScalar()) {
328 set(Def, ScalarValue);
329 return ScalarValue;
330 }
331
332 bool IsSingleScalar = vputils::isSingleScalar(Def);
333
334 VPLane LastLane(IsSingleScalar ? 0 : VF.getFixedValue() - 1);
335 // Check if there is a scalar value for the selected lane.
336 if (!hasScalarValue(Def, LastLane)) {
337 // At the moment, VPWidenIntOrFpInductionRecipes, VPScalarIVStepsRecipes and
338 // VPExpandSCEVRecipes can also be a single scalar.
340 VPExpandSCEVRecipe>(Def->getDefiningRecipe())) &&
341 "unexpected recipe found to be invariant");
342 IsSingleScalar = true;
343 LastLane = 0;
344 }
345
346 // We need to construct the vector value for a single-scalar value by
347 // broadcasting the scalar to all lanes.
348 // TODO: Replace by introducing Broadcast VPInstructions.
349 assert(IsSingleScalar && "must be a single-scalar at this point");
350 // Set the insert point after the last scalarized instruction or after the
351 // last PHI, if LastInst is a PHI. This ensures the insertelement sequence
352 // will directly follow the scalar definitions.
353 auto OldIP = Builder.saveIP();
354 auto *LastInst = cast<Instruction>(get(Def, LastLane));
355 auto NewIP = isa<PHINode>(LastInst)
356 ? LastInst->getParent()->getFirstNonPHIIt()
357 : std::next(BasicBlock::iterator(LastInst));
358 Builder.SetInsertPoint(&*NewIP);
359 Value *VectorValue = GetBroadcastInstrs(ScalarValue);
360 set(Def, VectorValue);
361 Builder.restoreIP(OldIP);
362 return VectorValue;
363}
364
366 const DILocation *DIL = DL;
367 // When a FSDiscriminator is enabled, we don't need to add the multiply
368 // factors to the discriminators.
369 if (DIL &&
370 Builder.GetInsertBlock()
371 ->getParent()
372 ->shouldEmitDebugInfoForProfiling() &&
374 // FIXME: For scalable vectors, assume vscale=1.
375 unsigned UF = Plan->getUF();
376 auto NewDIL =
378 if (NewDIL)
379 Builder.SetCurrentDebugLocation(*NewDIL);
380 else
381 LLVM_DEBUG(dbgs() << "Failed to create new discriminator: "
382 << DIL->getFilename() << " Line: " << DIL->getLine());
383 } else
384 Builder.SetCurrentDebugLocation(DL);
385}
386
388 Value *WideValue,
389 const VPLane &Lane) {
390 Value *ScalarInst = get(Def, Lane);
391 Value *LaneExpr = Lane.getAsRuntimeExpr(Builder, VF);
392 if (auto *StructTy = dyn_cast<StructType>(WideValue->getType())) {
393 // We must handle each element of a vectorized struct type.
394 for (unsigned I = 0, E = StructTy->getNumElements(); I != E; I++) {
395 Value *ScalarValue = Builder.CreateExtractValue(ScalarInst, I);
396 Value *VectorValue = Builder.CreateExtractValue(WideValue, I);
397 VectorValue =
398 Builder.CreateInsertElement(VectorValue, ScalarValue, LaneExpr);
399 WideValue = Builder.CreateInsertValue(WideValue, VectorValue, I);
400 }
401 } else {
402 WideValue = Builder.CreateInsertElement(WideValue, ScalarInst, LaneExpr);
403 }
404 return WideValue;
405}
406
407BasicBlock *VPBasicBlock::createEmptyBasicBlock(VPTransformState &State) {
408 auto &CFG = State.CFG;
409 // BB stands for IR BasicBlocks. VPBB stands for VPlan VPBasicBlocks.
410 // Pred stands for Predessor. Prev stands for Previous - last visited/created.
411 BasicBlock *PrevBB = CFG.PrevBB;
412 BasicBlock *NewBB = BasicBlock::Create(PrevBB->getContext(), getName(),
413 PrevBB->getParent(), CFG.ExitBB);
414 LLVM_DEBUG(dbgs() << "LV: created " << NewBB->getName() << '\n');
415
416 return NewBB;
417}
418
420 auto &CFG = State.CFG;
421 BasicBlock *NewBB = CFG.VPBB2IRBB[this];
422
423 // Register NewBB in its loop. In innermost loops its the same for all
424 // BB's.
425 Loop *ParentLoop = State.CurrentParentLoop;
426 // If this block has a sole successor that is an exit block or is an exit
427 // block itself then it needs adding to the same parent loop as the exit
428 // block.
429 VPBlockBase *SuccOrExitVPB = getSingleSuccessor();
430 SuccOrExitVPB = SuccOrExitVPB ? SuccOrExitVPB : this;
431 if (State.Plan->isExitBlock(SuccOrExitVPB)) {
432 ParentLoop = State.LI->getLoopFor(
433 cast<VPIRBasicBlock>(SuccOrExitVPB)->getIRBasicBlock());
434 }
435
436 if (ParentLoop && !State.LI->getLoopFor(NewBB))
437 ParentLoop->addBasicBlockToLoop(NewBB, *State.LI);
438
440 if (VPBlockUtils::isHeader(this, State.VPDT)) {
441 // There's no block for the latch yet, connect to the preheader only.
442 Preds = {getPredecessors()[0]};
443 } else {
444 Preds = to_vector(getPredecessors());
445 }
446
447 // Hook up the new basic block to its predecessors.
448 for (VPBlockBase *PredVPBlock : Preds) {
449 VPBasicBlock *PredVPBB = PredVPBlock->getExitingBasicBlock();
450 auto &PredVPSuccessors = PredVPBB->getHierarchicalSuccessors();
451 assert(CFG.VPBB2IRBB.contains(PredVPBB) &&
452 "Predecessor basic-block not found building successor.");
453 BasicBlock *PredBB = CFG.VPBB2IRBB[PredVPBB];
454 auto *PredBBTerminator = PredBB->getTerminator();
455 LLVM_DEBUG(dbgs() << "LV: draw edge from " << PredBB->getName() << '\n');
456
457 auto *TermBr = dyn_cast<BranchInst>(PredBBTerminator);
458 if (isa<UnreachableInst>(PredBBTerminator)) {
459 assert(PredVPSuccessors.size() == 1 &&
460 "Predecessor ending w/o branch must have single successor.");
461 DebugLoc DL = PredBBTerminator->getDebugLoc();
462 PredBBTerminator->eraseFromParent();
463 auto *Br = BranchInst::Create(NewBB, PredBB);
464 Br->setDebugLoc(DL);
465 } else if (TermBr && !TermBr->isConditional()) {
466 TermBr->setSuccessor(0, NewBB);
467 } else {
468 // Set each forward successor here when it is created, excluding
469 // backedges. A backward successor is set when the branch is created.
470 // Branches to VPIRBasicBlocks must have the same successors in VPlan as
471 // in the original IR, except when the predecessor is the entry block.
472 // This enables including SCEV and memory runtime check blocks in VPlan.
473 // TODO: Remove exception by modeling the terminator of entry block using
474 // BranchOnCond.
475 unsigned idx = PredVPSuccessors.front() == this ? 0 : 1;
476 assert((TermBr && (!TermBr->getSuccessor(idx) ||
477 (isa<VPIRBasicBlock>(this) &&
478 (TermBr->getSuccessor(idx) == NewBB ||
479 PredVPBlock == getPlan()->getEntry())))) &&
480 "Trying to reset an existing successor block.");
481 TermBr->setSuccessor(idx, NewBB);
482 }
483 CFG.DTU.applyUpdates({{DominatorTree::Insert, PredBB, NewBB}});
484 }
485}
486
489 "VPIRBasicBlock can have at most two successors at the moment!");
490 // Move completely disconnected blocks to their final position.
491 if (IRBB->hasNPredecessors(0) && succ_begin(IRBB) == succ_end(IRBB))
492 IRBB->moveAfter(State->CFG.PrevBB);
493 State->Builder.SetInsertPoint(IRBB->getTerminator());
494 State->CFG.PrevBB = IRBB;
495 State->CFG.VPBB2IRBB[this] = IRBB;
496 executeRecipes(State, IRBB);
497 // Create a branch instruction to terminate IRBB if one was not created yet
498 // and is needed.
499 if (getSingleSuccessor() && isa<UnreachableInst>(IRBB->getTerminator())) {
500 auto *Br = State->Builder.CreateBr(IRBB);
501 Br->setOperand(0, nullptr);
502 IRBB->getTerminator()->eraseFromParent();
503 } else {
504 assert(
505 (getNumSuccessors() == 0 || isa<BranchInst>(IRBB->getTerminator())) &&
506 "other blocks must be terminated by a branch");
507 }
508
509 connectToPredecessors(*State);
510}
511
512VPIRBasicBlock *VPIRBasicBlock::clone() {
513 auto *NewBlock = getPlan()->createEmptyVPIRBasicBlock(IRBB);
514 for (VPRecipeBase &R : Recipes)
515 NewBlock->appendRecipe(R.clone());
516 return NewBlock;
517}
518
520 bool Replica = bool(State->Lane);
521 BasicBlock *NewBB = State->CFG.PrevBB; // Reuse it if possible.
522
523 if (VPBlockUtils::isHeader(this, State->VPDT)) {
524 // Create and register the new vector loop.
525 Loop *PrevParentLoop = State->CurrentParentLoop;
526 State->CurrentParentLoop = State->LI->AllocateLoop();
527
528 // Insert the new loop into the loop nest and register the new basic blocks
529 // before calling any utilities such as SCEV that require valid LoopInfo.
530 if (PrevParentLoop)
531 PrevParentLoop->addChildLoop(State->CurrentParentLoop);
532 else
533 State->LI->addTopLevelLoop(State->CurrentParentLoop);
534 }
535
536 auto IsReplicateRegion = [](VPBlockBase *BB) {
538 assert((!R || R->isReplicator()) &&
539 "only replicate region blocks should remain");
540 return R;
541 };
542 // 1. Create an IR basic block.
543 if ((Replica && this == getParent()->getEntry()) ||
544 IsReplicateRegion(getSingleHierarchicalPredecessor())) {
545 // Reuse the previous basic block if the current VPBB is either
546 // * the entry to a replicate region, or
547 // * the exit of a replicate region.
548 State->CFG.VPBB2IRBB[this] = NewBB;
549 } else {
550 NewBB = createEmptyBasicBlock(*State);
551
552 State->Builder.SetInsertPoint(NewBB);
553 // Temporarily terminate with unreachable until CFG is rewired.
554 UnreachableInst *Terminator = State->Builder.CreateUnreachable();
555 State->Builder.SetInsertPoint(Terminator);
556
557 State->CFG.PrevBB = NewBB;
558 State->CFG.VPBB2IRBB[this] = NewBB;
559 connectToPredecessors(*State);
560 }
561
562 // 2. Fill the IR basic block with IR instructions.
563 executeRecipes(State, NewBB);
564
565 // If this block is a latch, update CurrentParentLoop.
566 if (VPBlockUtils::isLatch(this, State->VPDT))
567 State->CurrentParentLoop = State->CurrentParentLoop->getParentLoop();
568}
569
570VPBasicBlock *VPBasicBlock::clone() {
571 auto *NewBlock = getPlan()->createVPBasicBlock(getName());
572 for (VPRecipeBase &R : *this)
573 NewBlock->appendRecipe(R.clone());
574 return NewBlock;
575}
576
578 LLVM_DEBUG(dbgs() << "LV: vectorizing VPBB: " << getName()
579 << " in BB: " << BB->getName() << '\n');
580
581 State->CFG.PrevVPBB = this;
582
583 for (VPRecipeBase &Recipe : Recipes) {
584 State->setDebugLocFrom(Recipe.getDebugLoc());
585 Recipe.execute(*State);
586 }
587
588 LLVM_DEBUG(dbgs() << "LV: filled BB: " << *BB);
589}
590
591VPBasicBlock *VPBasicBlock::splitAt(iterator SplitAt) {
592 assert((SplitAt == end() || SplitAt->getParent() == this) &&
593 "can only split at a position in the same block");
594
595 // Create new empty block after the block to split.
596 auto *SplitBlock = getPlan()->createVPBasicBlock(getName() + ".split");
598
599 // Finally, move the recipes starting at SplitAt to new block.
600 for (VPRecipeBase &ToMove :
601 make_early_inc_range(make_range(SplitAt, this->end())))
602 ToMove.moveBefore(*SplitBlock, SplitBlock->end());
603
604 return SplitBlock;
605}
606
607/// Return the enclosing loop region for region \p P. The templated version is
608/// used to support both const and non-const block arguments.
609template <typename T> static T *getEnclosingLoopRegionForRegion(T *P) {
610 if (P && P->isReplicator()) {
611 P = P->getParent();
612 // Multiple loop regions can be nested, but replicate regions can only be
613 // nested inside a loop region or must be outside any other region.
614 assert((!P || !P->isReplicator()) && "unexpected nested replicate regions");
615 }
616 return P;
617}
618
622
626
627static bool hasConditionalTerminator(const VPBasicBlock *VPBB) {
628 if (VPBB->empty()) {
629 assert(
630 VPBB->getNumSuccessors() < 2 &&
631 "block with multiple successors doesn't have a recipe as terminator");
632 return false;
633 }
634
635 const VPRecipeBase *R = &VPBB->back();
636 bool IsSwitch = isa<VPInstruction>(R) &&
637 cast<VPInstruction>(R)->getOpcode() == Instruction::Switch;
641 (void)IsCondBranch;
642 (void)IsSwitch;
643 if (VPBB->getNumSuccessors() == 2 ||
644 (VPBB->isExiting() && !VPBB->getParent()->isReplicator())) {
645 assert((IsCondBranch || IsSwitch) &&
646 "block with multiple successors not terminated by "
647 "conditional branch nor switch recipe");
648
649 return true;
650 }
651
652 if (VPBB->getNumSuccessors() > 2) {
653 assert(IsSwitch && "block with more than 2 successors not terminated by "
654 "a switch recipe");
655 return true;
656 }
657
658 assert(
659 !IsCondBranch &&
660 "block with 0 or 1 successors terminated by conditional branch recipe");
661 return false;
662}
663
665 if (hasConditionalTerminator(this))
666 return &back();
667 return nullptr;
668}
669
671 if (hasConditionalTerminator(this))
672 return &back();
673 return nullptr;
674}
675
677 return getParent() && getParent()->getExitingBasicBlock() == this;
678}
679
680#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
685
686void VPBlockBase::printSuccessors(raw_ostream &O, const Twine &Indent) const {
687 if (getSuccessors().empty()) {
688 O << Indent << "No successors\n";
689 } else {
690 O << Indent << "Successor(s): ";
691 ListSeparator LS;
692 for (auto *Succ : getSuccessors())
693 O << LS << Succ->getName();
694 O << '\n';
695 }
696}
697
698void VPBasicBlock::print(raw_ostream &O, const Twine &Indent,
699 VPSlotTracker &SlotTracker) const {
700 O << Indent << getName() << ":\n";
701
702 auto RecipeIndent = Indent + " ";
703 for (const VPRecipeBase &Recipe : *this) {
704 Recipe.print(O, RecipeIndent, SlotTracker);
705 O << '\n';
706 }
707
708 printSuccessors(O, Indent);
709}
710#endif
711
712static std::pair<VPBlockBase *, VPBlockBase *> cloneFrom(VPBlockBase *Entry);
713
714// Clone the CFG for all nodes reachable from \p Entry, this includes cloning
715// the blocks and their recipes. Operands of cloned recipes will NOT be updated.
716// Remapping of operands must be done separately. Returns a pair with the new
717// entry and exiting blocks of the cloned region. If \p Entry isn't part of a
718// region, return nullptr for the exiting block.
719static std::pair<VPBlockBase *, VPBlockBase *> cloneFrom(VPBlockBase *Entry) {
721 VPBlockBase *Exiting = nullptr;
722 bool InRegion = Entry->getParent();
723 // First, clone blocks reachable from Entry.
724 for (VPBlockBase *BB : vp_depth_first_shallow(Entry)) {
725 VPBlockBase *NewBB = BB->clone();
726 Old2NewVPBlocks[BB] = NewBB;
727 if (InRegion && BB->getNumSuccessors() == 0) {
728 assert(!Exiting && "Multiple exiting blocks?");
729 Exiting = BB;
730 }
731 }
732 assert((!InRegion || Exiting) && "regions must have a single exiting block");
733
734 // Second, update the predecessors & successors of the cloned blocks.
735 for (VPBlockBase *BB : vp_depth_first_shallow(Entry)) {
736 VPBlockBase *NewBB = Old2NewVPBlocks[BB];
738 for (VPBlockBase *Pred : BB->getPredecessors()) {
739 NewPreds.push_back(Old2NewVPBlocks[Pred]);
740 }
741 NewBB->setPredecessors(NewPreds);
743 for (VPBlockBase *Succ : BB->successors()) {
744 NewSuccs.push_back(Old2NewVPBlocks[Succ]);
745 }
746 NewBB->setSuccessors(NewSuccs);
747 }
748
749#if !defined(NDEBUG)
750 // Verify that the order of predecessors and successors matches in the cloned
751 // version.
752 for (const auto &[OldBB, NewBB] :
754 vp_depth_first_shallow(Old2NewVPBlocks[Entry]))) {
755 for (const auto &[OldPred, NewPred] :
756 zip(OldBB->getPredecessors(), NewBB->getPredecessors()))
757 assert(NewPred == Old2NewVPBlocks[OldPred] && "Different predecessors");
758
759 for (const auto &[OldSucc, NewSucc] :
760 zip(OldBB->successors(), NewBB->successors()))
761 assert(NewSucc == Old2NewVPBlocks[OldSucc] && "Different successors");
762 }
763#endif
764
765 return std::make_pair(Old2NewVPBlocks[Entry],
766 Exiting ? Old2NewVPBlocks[Exiting] : nullptr);
767}
768
769VPRegionBlock *VPRegionBlock::clone() {
770 const auto &[NewEntry, NewExiting] = cloneFrom(getEntry());
771 auto *NewRegion = getPlan()->createVPRegionBlock(NewEntry, NewExiting,
772 getName(), isReplicator());
773 for (VPBlockBase *Block : vp_depth_first_shallow(NewEntry))
774 Block->setParent(NewRegion);
775 return NewRegion;
776}
777
780 "Loop regions should have been lowered to plain CFG");
781 assert(!State->Lane && "Replicating a Region with non-null instance.");
782 assert(!State->VF.isScalable() && "VF is assumed to be non scalable.");
783
785 Entry);
786 State->Lane = VPLane(0);
787 for (unsigned Lane = 0, VF = State->VF.getFixedValue(); Lane < VF; ++Lane) {
788 State->Lane = VPLane(Lane, VPLane::Kind::First);
789 // Visit the VPBlocks connected to \p this, starting from it.
790 for (VPBlockBase *Block : RPOT) {
791 LLVM_DEBUG(dbgs() << "LV: VPBlock in RPO " << Block->getName() << '\n');
792 Block->execute(State);
793 }
794 }
795
796 // Exit replicating mode.
797 State->Lane.reset();
798}
799
802 for (VPRecipeBase &R : Recipes)
803 Cost += R.cost(VF, Ctx);
804 return Cost;
805}
806
807const VPBasicBlock *VPBasicBlock::getCFGPredecessor(unsigned Idx) const {
808 const VPBlockBase *Pred = nullptr;
809 if (hasPredecessors()) {
810 Pred = getPredecessors()[Idx];
811 } else {
812 auto *Region = getParent();
813 assert(Region && !Region->isReplicator() && Region->getEntry() == this &&
814 "must be in the entry block of a non-replicate region");
815 assert(Idx < 2 && Region->getNumPredecessors() == 1 &&
816 "loop region has a single predecessor (preheader), its entry block "
817 "has 2 incoming blocks");
818
819 // Idx == 0 selects the predecessor of the region, Idx == 1 selects the
820 // region itself whose exiting block feeds the phi across the backedge.
821 Pred = Idx == 0 ? Region->getSinglePredecessor() : Region;
822 }
823 return Pred->getExitingBasicBlock();
824}
825
827 if (!isReplicator()) {
830 Cost += Block->cost(VF, Ctx);
831 InstructionCost BackedgeCost =
832 ForceTargetInstructionCost.getNumOccurrences()
833 ? InstructionCost(ForceTargetInstructionCost.getNumOccurrences())
834 : Ctx.TTI.getCFInstrCost(Instruction::Br, Ctx.CostKind);
835 LLVM_DEBUG(dbgs() << "Cost of " << BackedgeCost << " for VF " << VF
836 << ": vector loop backedge\n");
837 Cost += BackedgeCost;
838 return Cost;
839 }
840
841 // Compute the cost of a replicate region. Replicating isn't supported for
842 // scalable vectors, return an invalid cost for them.
843 // TODO: Discard scalable VPlans with replicate recipes earlier after
844 // construction.
845 if (VF.isScalable())
847
848 // First compute the cost of the conditionally executed recipes, followed by
849 // account for the branching cost, except if the mask is a header mask or
850 // uniform condition.
851 using namespace llvm::VPlanPatternMatch;
853 InstructionCost ThenCost = Then->cost(VF, Ctx);
854
855 // For the scalar case, we may not always execute the original predicated
856 // block, Thus, scale the block's cost by the probability of executing it.
857 if (VF.isScalar())
858 return ThenCost / getPredBlockCostDivisor(Ctx.CostKind);
859
860 return ThenCost;
861}
862
863#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
865 VPSlotTracker &SlotTracker) const {
866 O << Indent << (isReplicator() ? "<xVFxUF> " : "<x1> ") << getName() << ": {";
867 auto NewIndent = Indent + " ";
868 for (auto *BlockBase : vp_depth_first_shallow(Entry)) {
869 O << '\n';
870 BlockBase->print(O, NewIndent, SlotTracker);
871 }
872 O << Indent << "}\n";
873
874 printSuccessors(O, Indent);
875}
876#endif
877
879 auto *Header = cast<VPBasicBlock>(getEntry());
880 if (auto *CanIV = dyn_cast<VPCanonicalIVPHIRecipe>(&Header->front())) {
881 assert(this == getPlan()->getVectorLoopRegion() &&
882 "Canonical IV must be in the entry of the top-level loop region");
883 auto *ScalarR = VPBuilder(CanIV).createScalarPhi(
884 {CanIV->getStartValue(), CanIV->getBackedgeValue()},
885 CanIV->getDebugLoc(), "index");
886 CanIV->replaceAllUsesWith(ScalarR);
887 CanIV->eraseFromParent();
888 }
889
890 VPBlockBase *Preheader = getSinglePredecessor();
891 auto *ExitingLatch = cast<VPBasicBlock>(getExiting());
893 VPBlockUtils::disconnectBlocks(Preheader, this);
894 VPBlockUtils::disconnectBlocks(this, Middle);
895
896 for (VPBlockBase *VPB : vp_depth_first_shallow(Entry))
897 VPB->setParent(getParent());
898
899 VPBlockUtils::connectBlocks(Preheader, Header);
900 VPBlockUtils::connectBlocks(ExitingLatch, Middle);
901 VPBlockUtils::connectBlocks(ExitingLatch, Header);
902}
903
904VPlan::VPlan(Loop *L) {
905 setEntry(createVPIRBasicBlock(L->getLoopPreheader()));
906 ScalarHeader = createVPIRBasicBlock(L->getHeader());
907
908 SmallVector<BasicBlock *> IRExitBlocks;
909 L->getUniqueExitBlocks(IRExitBlocks);
910 for (BasicBlock *EB : IRExitBlocks)
911 ExitBlocks.push_back(createVPIRBasicBlock(EB));
912}
913
915 VPValue DummyValue;
916
917 for (auto *VPB : CreatedBlocks) {
918 if (auto *VPBB = dyn_cast<VPBasicBlock>(VPB)) {
919 // Replace all operands of recipes and all VPValues defined in VPBB with
920 // DummyValue so the block can be deleted.
921 for (VPRecipeBase &R : *VPBB) {
922 for (auto *Def : R.definedValues())
923 Def->replaceAllUsesWith(&DummyValue);
924
925 for (unsigned I = 0, E = R.getNumOperands(); I != E; I++)
926 R.setOperand(I, &DummyValue);
927 }
928 }
929 delete VPB;
930 }
931 for (VPValue *VPV : getLiveIns())
932 delete VPV;
933 if (BackedgeTakenCount)
934 delete BackedgeTakenCount;
935}
936
938 auto Iter = find_if(getExitBlocks(), [IRBB](const VPIRBasicBlock *VPIRBB) {
939 return VPIRBB->getIRBasicBlock() == IRBB;
940 });
941 assert(Iter != getExitBlocks().end() && "no exit block found");
942 return *Iter;
943}
944
946 return is_contained(ExitBlocks, VPBB);
947}
948
949/// Generate the code inside the preheader and body of the vectorized loop.
950/// Assumes a single pre-header basic-block was created for this. Introduce
951/// additional basic-blocks as needed, and fill them all.
953 // Initialize CFG state.
954 State->CFG.PrevVPBB = nullptr;
955 State->CFG.ExitBB = State->CFG.PrevBB->getSingleSuccessor();
956
957 // Update VPDominatorTree since VPBasicBlock may be removed after State was
958 // constructed.
959 State->VPDT.recalculate(*this);
960
961 // Disconnect VectorPreHeader from ExitBB in both the CFG and DT.
962 BasicBlock *VectorPreHeader = State->CFG.PrevBB;
963 cast<BranchInst>(VectorPreHeader->getTerminator())->setSuccessor(0, nullptr);
964 State->CFG.DTU.applyUpdates(
965 {{DominatorTree::Delete, VectorPreHeader, State->CFG.ExitBB}});
966
967 LLVM_DEBUG(dbgs() << "Executing best plan with VF=" << State->VF
968 << ", UF=" << getUF() << '\n');
969 setName("Final VPlan");
970 LLVM_DEBUG(dump());
971
972 // Disconnect scalar preheader and scalar header, as the dominator tree edge
973 // will be updated as part of VPlan execution. This allows keeping the DTU
974 // logic generic during VPlan execution.
975 BasicBlock *ScalarPh = State->CFG.ExitBB;
976 State->CFG.DTU.applyUpdates(
977 {{DominatorTree::Delete, ScalarPh, ScalarPh->getSingleSuccessor()}});
978
980 Entry);
981 // Generate code for the VPlan, in parts of the vector skeleton, loop body and
982 // successor blocks including the middle, exit and scalar preheader blocks.
983 for (VPBlockBase *Block : RPOT)
984 Block->execute(State);
985
986 State->CFG.DTU.flush();
987
988 VPBasicBlock *Header = vputils::getFirstLoopHeader(*this, State->VPDT);
989 if (!Header)
990 return;
991
992 auto *LatchVPBB = cast<VPBasicBlock>(Header->getPredecessors()[1]);
993 BasicBlock *VectorLatchBB = State->CFG.VPBB2IRBB[LatchVPBB];
994
995 // Fix the latch value of canonical, reduction and first-order recurrences
996 // phis in the vector loop.
997 for (VPRecipeBase &R : Header->phis()) {
998 // Skip phi-like recipes that generate their backedege values themselves.
999 if (isa<VPWidenPHIRecipe>(&R))
1000 continue;
1001
1002 auto *PhiR = cast<VPSingleDefRecipe>(&R);
1003 // VPInstructions currently model scalar Phis only.
1004 bool NeedsScalar = isa<VPInstruction>(PhiR) ||
1006 cast<VPReductionPHIRecipe>(PhiR)->isInLoop());
1007
1008 Value *Phi = State->get(PhiR, NeedsScalar);
1009 // VPHeaderPHIRecipe supports getBackedgeValue() but VPInstruction does
1010 // not.
1011 Value *Val = State->get(PhiR->getOperand(1), NeedsScalar);
1012 cast<PHINode>(Phi)->addIncoming(Val, VectorLatchBB);
1013 }
1014}
1015
1017 // For now only return the cost of the vector loop region, ignoring any other
1018 // blocks, like the preheader or middle blocks, expect for checking them for
1019 // recipes with invalid costs.
1021
1022 // If the cost of the loop region is invalid or any recipe in the skeleton
1023 // outside loop regions are invalid return an invalid cost.
1026 [&VF, &Ctx](VPBasicBlock *VPBB) {
1027 return !VPBB->cost(VF, Ctx).isValid();
1028 }))
1030
1031 return Cost;
1032}
1033
1035 // TODO: Cache if possible.
1037 if (auto *R = dyn_cast<VPRegionBlock>(B))
1038 return R->isReplicator() ? nullptr : R;
1039 return nullptr;
1040}
1041
1044 if (auto *R = dyn_cast<VPRegionBlock>(B))
1045 return R->isReplicator() ? nullptr : R;
1046 return nullptr;
1047}
1048
1049#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1052
1053 if (VF.getNumUsers() > 0) {
1054 O << "\nLive-in ";
1055 VF.printAsOperand(O, SlotTracker);
1056 O << " = VF";
1057 }
1058
1059 if (VFxUF.getNumUsers() > 0) {
1060 O << "\nLive-in ";
1061 VFxUF.printAsOperand(O, SlotTracker);
1062 O << " = VF * UF";
1063 }
1064
1065 if (VectorTripCount.getNumUsers() > 0) {
1066 O << "\nLive-in ";
1067 VectorTripCount.printAsOperand(O, SlotTracker);
1068 O << " = vector-trip-count";
1069 }
1070
1071 if (BackedgeTakenCount && BackedgeTakenCount->getNumUsers()) {
1072 O << "\nLive-in ";
1073 BackedgeTakenCount->printAsOperand(O, SlotTracker);
1074 O << " = backedge-taken count";
1075 }
1076
1077 O << "\n";
1078 if (TripCount) {
1079 if (TripCount->isLiveIn())
1080 O << "Live-in ";
1081 TripCount->printAsOperand(O, SlotTracker);
1082 O << " = original trip-count";
1083 O << "\n";
1084 }
1085}
1086
1090
1091 O << "VPlan '" << getName() << "' {";
1092
1093 printLiveIns(O);
1094
1096 RPOT(getEntry());
1097 for (const VPBlockBase *Block : RPOT) {
1098 O << '\n';
1099 Block->print(O, "", SlotTracker);
1100 }
1101
1102 O << "}\n";
1103}
1104
1105std::string VPlan::getName() const {
1106 std::string Out;
1107 raw_string_ostream RSO(Out);
1108 RSO << Name << " for ";
1109 if (!VFs.empty()) {
1110 RSO << "VF={" << VFs[0];
1111 for (ElementCount VF : drop_begin(VFs))
1112 RSO << "," << VF;
1113 RSO << "},";
1114 }
1115
1116 if (UFs.empty()) {
1117 RSO << "UF>=1";
1118 } else {
1119 RSO << "UF={" << UFs[0];
1120 for (unsigned UF : drop_begin(UFs))
1121 RSO << "," << UF;
1122 RSO << "}";
1123 }
1124
1125 return Out;
1126}
1127
1130 VPlanPrinter Printer(O, *this);
1131 Printer.dump();
1132}
1133
1135void VPlan::dump() const { print(dbgs()); }
1136#endif
1137
1138static void remapOperands(VPBlockBase *Entry, VPBlockBase *NewEntry,
1139 DenseMap<VPValue *, VPValue *> &Old2NewVPValues) {
1140 // Update the operands of all cloned recipes starting at NewEntry. This
1141 // traverses all reachable blocks. This is done in two steps, to handle cycles
1142 // in PHI recipes.
1144 OldDeepRPOT(Entry);
1146 NewDeepRPOT(NewEntry);
1147 // First, collect all mappings from old to new VPValues defined by cloned
1148 // recipes.
1149 for (const auto &[OldBB, NewBB] :
1152 assert(OldBB->getRecipeList().size() == NewBB->getRecipeList().size() &&
1153 "blocks must have the same number of recipes");
1154 for (const auto &[OldR, NewR] : zip(*OldBB, *NewBB)) {
1155 assert(OldR.getNumOperands() == NewR.getNumOperands() &&
1156 "recipes must have the same number of operands");
1157 assert(OldR.getNumDefinedValues() == NewR.getNumDefinedValues() &&
1158 "recipes must define the same number of operands");
1159 for (const auto &[OldV, NewV] :
1160 zip(OldR.definedValues(), NewR.definedValues()))
1161 Old2NewVPValues[OldV] = NewV;
1162 }
1163 }
1164
1165 // Update all operands to use cloned VPValues.
1166 for (VPBasicBlock *NewBB :
1168 for (VPRecipeBase &NewR : *NewBB)
1169 for (unsigned I = 0, E = NewR.getNumOperands(); I != E; ++I) {
1170 VPValue *NewOp = Old2NewVPValues.lookup(NewR.getOperand(I));
1171 NewR.setOperand(I, NewOp);
1172 }
1173 }
1174}
1175
1177 unsigned NumBlocksBeforeCloning = CreatedBlocks.size();
1178 // Clone blocks.
1179 const auto &[NewEntry, __] = cloneFrom(Entry);
1180
1181 BasicBlock *ScalarHeaderIRBB = getScalarHeader()->getIRBasicBlock();
1182 VPIRBasicBlock *NewScalarHeader = nullptr;
1183 if (getScalarHeader()->hasPredecessors()) {
1184 NewScalarHeader = cast<VPIRBasicBlock>(*find_if(
1185 vp_depth_first_shallow(NewEntry), [ScalarHeaderIRBB](VPBlockBase *VPB) {
1186 auto *VPIRBB = dyn_cast<VPIRBasicBlock>(VPB);
1187 return VPIRBB && VPIRBB->getIRBasicBlock() == ScalarHeaderIRBB;
1188 }));
1189 } else {
1190 NewScalarHeader = createVPIRBasicBlock(ScalarHeaderIRBB);
1191 }
1192 // Create VPlan, clone live-ins and remap operands in the cloned blocks.
1193 auto *NewPlan = new VPlan(cast<VPBasicBlock>(NewEntry), NewScalarHeader);
1194 DenseMap<VPValue *, VPValue *> Old2NewVPValues;
1195 for (VPValue *OldLiveIn : getLiveIns()) {
1196 Old2NewVPValues[OldLiveIn] =
1197 NewPlan->getOrAddLiveIn(OldLiveIn->getLiveInIRValue());
1198 }
1199 Old2NewVPValues[&VectorTripCount] = &NewPlan->VectorTripCount;
1200 Old2NewVPValues[&VF] = &NewPlan->VF;
1201 Old2NewVPValues[&VFxUF] = &NewPlan->VFxUF;
1202 if (BackedgeTakenCount) {
1203 NewPlan->BackedgeTakenCount = new VPValue();
1204 Old2NewVPValues[BackedgeTakenCount] = NewPlan->BackedgeTakenCount;
1205 }
1206 if (TripCount && TripCount->isLiveIn())
1207 Old2NewVPValues[TripCount] =
1208 NewPlan->getOrAddLiveIn(TripCount->getLiveInIRValue());
1209 // else NewTripCount will be created and inserted into Old2NewVPValues when
1210 // TripCount is cloned. In any case NewPlan->TripCount is updated below.
1211
1212 remapOperands(Entry, NewEntry, Old2NewVPValues);
1213
1214 // Initialize remaining fields of cloned VPlan.
1215 NewPlan->VFs = VFs;
1216 NewPlan->UFs = UFs;
1217 // TODO: Adjust names.
1218 NewPlan->Name = Name;
1219 if (TripCount) {
1220 assert(Old2NewVPValues.contains(TripCount) &&
1221 "TripCount must have been added to Old2NewVPValues");
1222 NewPlan->TripCount = Old2NewVPValues[TripCount];
1223 }
1224
1225 // Transfer all cloned blocks (the second half of all current blocks) from
1226 // current to new VPlan.
1227 unsigned NumBlocksAfterCloning = CreatedBlocks.size();
1228 for (unsigned I :
1229 seq<unsigned>(NumBlocksBeforeCloning, NumBlocksAfterCloning))
1230 NewPlan->CreatedBlocks.push_back(this->CreatedBlocks[I]);
1231 CreatedBlocks.truncate(NumBlocksBeforeCloning);
1232
1233 // Update ExitBlocks of the new plan.
1234 for (VPBlockBase *VPB : NewPlan->CreatedBlocks) {
1235 if (VPB->getNumSuccessors() == 0 && isa<VPIRBasicBlock>(VPB) &&
1236 VPB != NewScalarHeader)
1237 NewPlan->ExitBlocks.push_back(cast<VPIRBasicBlock>(VPB));
1238 }
1239
1240 return NewPlan;
1241}
1242
1244 auto *VPIRBB = new VPIRBasicBlock(IRBB);
1245 CreatedBlocks.push_back(VPIRBB);
1246 return VPIRBB;
1247}
1248
1250 auto *VPIRBB = createEmptyVPIRBasicBlock(IRBB);
1251 for (Instruction &I :
1252 make_range(IRBB->begin(), IRBB->getTerminator()->getIterator()))
1253 VPIRBB->appendRecipe(VPIRInstruction::create(I));
1254 return VPIRBB;
1255}
1256
1257#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1258
1259Twine VPlanPrinter::getUID(const VPBlockBase *Block) {
1260 return (isa<VPRegionBlock>(Block) ? "cluster_N" : "N") +
1261 Twine(getOrCreateBID(Block));
1262}
1263
1264Twine VPlanPrinter::getOrCreateName(const VPBlockBase *Block) {
1265 const std::string &Name = Block->getName();
1266 if (!Name.empty())
1267 return Name;
1268 return "VPB" + Twine(getOrCreateBID(Block));
1269}
1270
1272 Depth = 1;
1273 bumpIndent(0);
1274 OS << "digraph VPlan {\n";
1275 OS << "graph [labelloc=t, fontsize=30; label=\"Vectorization Plan";
1276 if (!Plan.getName().empty())
1277 OS << "\\n" << DOT::EscapeString(Plan.getName());
1278
1279 {
1280 // Print live-ins.
1281 std::string Str;
1282 raw_string_ostream SS(Str);
1283 Plan.printLiveIns(SS);
1285 StringRef(Str).rtrim('\n').split(Lines, "\n");
1286 for (auto Line : Lines)
1287 OS << DOT::EscapeString(Line.str()) << "\\n";
1288 }
1289
1290 OS << "\"]\n";
1291 OS << "node [shape=rect, fontname=Courier, fontsize=30]\n";
1292 OS << "edge [fontname=Courier, fontsize=30]\n";
1293 OS << "compound=true\n";
1294
1295 for (const VPBlockBase *Block : vp_depth_first_shallow(Plan.getEntry()))
1296 dumpBlock(Block);
1297
1298 OS << "}\n";
1299}
1300
1301void VPlanPrinter::dumpBlock(const VPBlockBase *Block) {
1303 dumpBasicBlock(BasicBlock);
1305 dumpRegion(Region);
1306 else
1307 llvm_unreachable("Unsupported kind of VPBlock.");
1308}
1309
1310void VPlanPrinter::drawEdge(const VPBlockBase *From, const VPBlockBase *To,
1311 bool Hidden, const Twine &Label) {
1312 // Due to "dot" we print an edge between two regions as an edge between the
1313 // exiting basic block and the entry basic of the respective regions.
1314 const VPBlockBase *Tail = From->getExitingBasicBlock();
1315 const VPBlockBase *Head = To->getEntryBasicBlock();
1316 OS << Indent << getUID(Tail) << " -> " << getUID(Head);
1317 OS << " [ label=\"" << Label << '\"';
1318 if (Tail != From)
1319 OS << " ltail=" << getUID(From);
1320 if (Head != To)
1321 OS << " lhead=" << getUID(To);
1322 if (Hidden)
1323 OS << "; splines=none";
1324 OS << "]\n";
1325}
1326
1327void VPlanPrinter::dumpEdges(const VPBlockBase *Block) {
1328 auto &Successors = Block->getSuccessors();
1329 if (Successors.size() == 1)
1330 drawEdge(Block, Successors.front(), false, "");
1331 else if (Successors.size() == 2) {
1332 drawEdge(Block, Successors.front(), false, "T");
1333 drawEdge(Block, Successors.back(), false, "F");
1334 } else {
1335 unsigned SuccessorNumber = 0;
1336 for (auto *Successor : Successors)
1337 drawEdge(Block, Successor, false, Twine(SuccessorNumber++));
1338 }
1339}
1340
1341void VPlanPrinter::dumpBasicBlock(const VPBasicBlock *BasicBlock) {
1342 // Implement dot-formatted dump by performing plain-text dump into the
1343 // temporary storage followed by some post-processing.
1344 OS << Indent << getUID(BasicBlock) << " [label =\n";
1345 bumpIndent(1);
1346 std::string Str;
1347 raw_string_ostream SS(Str);
1348 // Use no indentation as we need to wrap the lines into quotes ourselves.
1349 BasicBlock->print(SS, "", SlotTracker);
1350
1351 // We need to process each line of the output separately, so split
1352 // single-string plain-text dump.
1354 StringRef(Str).rtrim('\n').split(Lines, "\n");
1355
1356 auto EmitLine = [&](StringRef Line, StringRef Suffix) {
1357 OS << Indent << '"' << DOT::EscapeString(Line.str()) << "\\l\"" << Suffix;
1358 };
1359
1360 // Don't need the "+" after the last line.
1361 for (auto Line : make_range(Lines.begin(), Lines.end() - 1))
1362 EmitLine(Line, " +\n");
1363 EmitLine(Lines.back(), "\n");
1364
1365 bumpIndent(-1);
1366 OS << Indent << "]\n";
1367
1368 dumpEdges(BasicBlock);
1369}
1370
1371void VPlanPrinter::dumpRegion(const VPRegionBlock *Region) {
1372 OS << Indent << "subgraph " << getUID(Region) << " {\n";
1373 bumpIndent(1);
1374 OS << Indent << "fontname=Courier\n"
1375 << Indent << "label=\""
1376 << DOT::EscapeString(Region->isReplicator() ? "<xVFxUF> " : "<x1> ")
1377 << DOT::EscapeString(Region->getName()) << "\"\n";
1378 // Dump the blocks of the region.
1379 assert(Region->getEntry() && "Region contains no inner blocks.");
1380 for (const VPBlockBase *Block : vp_depth_first_shallow(Region->getEntry()))
1381 dumpBlock(Block);
1382 bumpIndent(-1);
1383 OS << Indent << "}\n";
1384 dumpEdges(Region);
1385}
1386
1387#endif
1388
1389/// Returns true if there is a vector loop region and \p VPV is defined in a
1390/// loop region.
1391static bool isDefinedInsideLoopRegions(const VPValue *VPV) {
1392 const VPRecipeBase *DefR = VPV->getDefiningRecipe();
1393 return DefR && (!DefR->getParent()->getPlan()->getVectorLoopRegion() ||
1395}
1396
1401 replaceUsesWithIf(New, [](VPUser &, unsigned) { return true; });
1402}
1403
1405 VPValue *New,
1406 llvm::function_ref<bool(VPUser &U, unsigned Idx)> ShouldReplace) {
1407 // Note that this early exit is required for correctness; the implementation
1408 // below relies on the number of users for this VPValue to decrease, which
1409 // isn't the case if this == New.
1410 if (this == New)
1411 return;
1412
1413 for (unsigned J = 0; J < getNumUsers();) {
1414 VPUser *User = Users[J];
1415 bool RemovedUser = false;
1416 for (unsigned I = 0, E = User->getNumOperands(); I < E; ++I) {
1417 if (User->getOperand(I) != this || !ShouldReplace(*User, I))
1418 continue;
1419
1420 RemovedUser = true;
1421 User->setOperand(I, New);
1422 }
1423 // If a user got removed after updating the current user, the next user to
1424 // update will be moved to the current position, so we only need to
1425 // increment the index if the number of users did not change.
1426 if (!RemovedUser)
1427 J++;
1428 }
1429}
1430
1432 for (unsigned Idx = 0; Idx != getNumOperands(); ++Idx) {
1433 if (getOperand(Idx) == From)
1434 setOperand(Idx, To);
1435 }
1436}
1437
1438#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1440 OS << Tracker.getOrCreateName(this);
1441}
1442
1445 Op->printAsOperand(O, SlotTracker);
1446 });
1447}
1448#endif
1449
1450void VPSlotTracker::assignName(const VPValue *V) {
1451 assert(!VPValue2Name.contains(V) && "VPValue already has a name!");
1452 auto *UV = V->getUnderlyingValue();
1453 auto *VPI = dyn_cast_or_null<VPInstruction>(V->getDefiningRecipe());
1454 if (!UV && !(VPI && !VPI->getName().empty())) {
1455 VPValue2Name[V] = (Twine("vp<%") + Twine(NextSlot) + ">").str();
1456 NextSlot++;
1457 return;
1458 }
1459
1460 // Use the name of the underlying Value, wrapped in "ir<>", and versioned by
1461 // appending ".Number" to the name if there are multiple uses.
1462 std::string Name;
1463 if (UV)
1464 Name = getName(UV);
1465 else
1466 Name = VPI->getName();
1467
1468 assert(!Name.empty() && "Name cannot be empty.");
1469 StringRef Prefix = UV ? "ir<" : "vp<%";
1470 std::string BaseName = (Twine(Prefix) + Name + Twine(">")).str();
1471
1472 // First assign the base name for V.
1473 const auto &[A, _] = VPValue2Name.try_emplace(V, BaseName);
1474 // Integer or FP constants with different types will result in he same string
1475 // due to stripping types.
1476 if (V->isLiveIn() && isa<ConstantInt, ConstantFP>(UV))
1477 return;
1478
1479 // If it is already used by C > 0 other VPValues, increase the version counter
1480 // C and use it for V.
1481 const auto &[C, UseInserted] = BaseName2Version.try_emplace(BaseName, 0);
1482 if (!UseInserted) {
1483 C->second++;
1484 A->second = (BaseName + Twine(".") + Twine(C->second)).str();
1485 }
1486}
1487
1488void VPSlotTracker::assignNames(const VPlan &Plan) {
1489 if (Plan.VF.getNumUsers() > 0)
1490 assignName(&Plan.VF);
1491 if (Plan.VFxUF.getNumUsers() > 0)
1492 assignName(&Plan.VFxUF);
1493 assignName(&Plan.VectorTripCount);
1494 if (Plan.BackedgeTakenCount)
1495 assignName(Plan.BackedgeTakenCount);
1496 for (VPValue *LI : Plan.getLiveIns())
1497 assignName(LI);
1498
1499 ReversePostOrderTraversal<VPBlockDeepTraversalWrapper<const VPBlockBase *>>
1500 RPOT(VPBlockDeepTraversalWrapper<const VPBlockBase *>(Plan.getEntry()));
1501 for (const VPBasicBlock *VPBB :
1503 assignNames(VPBB);
1504}
1505
1506void VPSlotTracker::assignNames(const VPBasicBlock *VPBB) {
1507 for (const VPRecipeBase &Recipe : *VPBB)
1508 for (VPValue *Def : Recipe.definedValues())
1509 assignName(Def);
1510}
1511
1512std::string VPSlotTracker::getName(const Value *V) {
1513 std::string Name;
1514 raw_string_ostream S(Name);
1515 if (V->hasName() || !isa<Instruction>(V)) {
1516 V->printAsOperand(S, false);
1517 return Name;
1518 }
1519
1520 if (!MST) {
1521 // Lazily create the ModuleSlotTracker when we first hit an unnamed
1522 // instruction.
1523 auto *I = cast<Instruction>(V);
1524 // This check is required to support unit tests with incomplete IR.
1525 if (I->getParent()) {
1526 MST = std::make_unique<ModuleSlotTracker>(I->getModule());
1527 MST->incorporateFunction(*I->getFunction());
1528 } else {
1529 MST = std::make_unique<ModuleSlotTracker>(nullptr);
1530 }
1531 }
1532 V->printAsOperand(S, false, *MST);
1533 return Name;
1534}
1535
1536std::string VPSlotTracker::getOrCreateName(const VPValue *V) const {
1537 std::string Name = VPValue2Name.lookup(V);
1538 if (!Name.empty())
1539 return Name;
1540
1541 // If no name was assigned, no VPlan was provided when creating the slot
1542 // tracker or it is not reachable from the provided VPlan. This can happen,
1543 // e.g. when trying to print a recipe that has not been inserted into a VPlan
1544 // in a debugger.
1545 // TODO: Update VPSlotTracker constructor to assign names to recipes &
1546 // VPValues not associated with a VPlan, instead of constructing names ad-hoc
1547 // here.
1548 const VPRecipeBase *DefR = V->getDefiningRecipe();
1549 (void)DefR;
1550 assert((!DefR || !DefR->getParent() || !DefR->getParent()->getPlan()) &&
1551 "VPValue defined by a recipe in a VPlan?");
1552
1553 // Use the underlying value's name, if there is one.
1554 if (auto *UV = V->getUnderlyingValue()) {
1555 std::string Name;
1556 raw_string_ostream S(Name);
1557 UV->printAsOperand(S, false);
1558 return (Twine("ir<") + Name + ">").str();
1559 }
1560
1561 return "<badref>";
1562}
1563
1565 const std::function<bool(ElementCount)> &Predicate, VFRange &Range) {
1566 assert(!Range.isEmpty() && "Trying to test an empty VF range.");
1567 bool PredicateAtRangeStart = Predicate(Range.Start);
1568
1569 for (ElementCount TmpVF : VFRange(Range.Start * 2, Range.End))
1570 if (Predicate(TmpVF) != PredicateAtRangeStart) {
1571 Range.End = TmpVF;
1572 break;
1573 }
1574
1575 return PredicateAtRangeStart;
1576}
1577
1578/// Build VPlans for the full range of feasible VF's = {\p MinVF, 2 * \p MinVF,
1579/// 4 * \p MinVF, ..., \p MaxVF} by repeatedly building a VPlan for a sub-range
1580/// of VF's starting at a given VF and extending it as much as possible. Each
1581/// vectorization decision can potentially shorten this sub-range during
1582/// buildVPlan().
1584 ElementCount MaxVF) {
1585 auto MaxVFTimes2 = MaxVF * 2;
1586 for (ElementCount VF = MinVF; ElementCount::isKnownLT(VF, MaxVFTimes2);) {
1587 VFRange SubRange = {VF, MaxVFTimes2};
1588 if (auto Plan = tryToBuildVPlan(SubRange)) {
1590 // Update the name of the latch of the top-level vector loop region region
1591 // after optimizations which includes block folding.
1592 Plan->getVectorLoopRegion()->getExiting()->setName("vector.latch");
1593 VPlans.push_back(std::move(Plan));
1594 }
1595 VF = SubRange.End;
1596 }
1597}
1598
1600 assert(count_if(VPlans,
1601 [VF](const VPlanPtr &Plan) { return Plan->hasVF(VF); }) ==
1602 1 &&
1603 "Multiple VPlans for VF.");
1604
1605 for (const VPlanPtr &Plan : VPlans) {
1606 if (Plan->hasVF(VF))
1607 return *Plan.get();
1608 }
1609 llvm_unreachable("No plan found!");
1610}
1611
1614 // Reserve first location for self reference to the LoopID metadata node.
1615 MDs.push_back(nullptr);
1616 bool IsUnrollMetadata = false;
1617 MDNode *LoopID = L->getLoopID();
1618 if (LoopID) {
1619 // First find existing loop unrolling disable metadata.
1620 for (unsigned I = 1, IE = LoopID->getNumOperands(); I < IE; ++I) {
1621 auto *MD = dyn_cast<MDNode>(LoopID->getOperand(I));
1622 if (MD) {
1623 const auto *S = dyn_cast<MDString>(MD->getOperand(0));
1624 if (!S)
1625 continue;
1626 if (S->getString().starts_with("llvm.loop.unroll.runtime.disable"))
1627 continue;
1628 IsUnrollMetadata =
1629 S->getString().starts_with("llvm.loop.unroll.disable");
1630 }
1631 MDs.push_back(LoopID->getOperand(I));
1632 }
1633 }
1634
1635 if (!IsUnrollMetadata) {
1636 // Add runtime unroll disable metadata.
1637 LLVMContext &Context = L->getHeader()->getContext();
1638 SmallVector<Metadata *, 1> DisableOperands;
1639 DisableOperands.push_back(
1640 MDString::get(Context, "llvm.loop.unroll.runtime.disable"));
1641 MDNode *DisableNode = MDNode::get(Context, DisableOperands);
1642 MDs.push_back(DisableNode);
1643 MDNode *NewLoopID = MDNode::get(Context, MDs);
1644 // Set operand 0 to refer to the loop id itself.
1645 NewLoopID->replaceOperandWith(0, NewLoopID);
1646 L->setLoopID(NewLoopID);
1647 }
1648}
1649
1651 Loop *VectorLoop, VPBasicBlock *HeaderVPBB, bool VectorizingEpilogue,
1652 unsigned EstimatedVFxUF, bool DisableRuntimeUnroll) {
1653 MDNode *LID = OrigLoop->getLoopID();
1654 // Update the metadata of the scalar loop. Skip the update when vectorizing
1655 // the epilogue loop, to ensure it is only updated once.
1656 if (!VectorizingEpilogue) {
1657 std::optional<MDNode *> RemainderLoopID = makeFollowupLoopID(
1659 if (RemainderLoopID) {
1660 OrigLoop->setLoopID(*RemainderLoopID);
1661 } else {
1662 if (DisableRuntimeUnroll)
1664
1665 LoopVectorizeHints Hints(OrigLoop, true, *ORE);
1666 Hints.setAlreadyVectorized();
1667 }
1668 }
1669
1670 if (!VectorLoop)
1671 return;
1672
1673 if (std::optional<MDNode *> VectorizedLoopID =
1676 VectorLoop->setLoopID(*VectorizedLoopID);
1677 } else {
1678 // Keep all loop hints from the original loop on the vector loop (we'll
1679 // replace the vectorizer-specific hints below).
1680 if (LID)
1681 VectorLoop->setLoopID(LID);
1682
1683 if (!VectorizingEpilogue) {
1684 LoopVectorizeHints Hints(VectorLoop, true, *ORE);
1685 Hints.setAlreadyVectorized();
1686 }
1687
1688 // Check if it's EVL-vectorized and mark the corresponding metadata.
1689 bool IsEVLVectorized =
1690 llvm::any_of(*HeaderVPBB, [](const VPRecipeBase &Recipe) {
1691 // Looking for the ExplictVectorLength VPInstruction.
1692 if (const auto *VI = dyn_cast<VPInstruction>(&Recipe))
1693 return VI->getOpcode() == VPInstruction::ExplicitVectorLength;
1694 return false;
1695 });
1696 if (IsEVLVectorized) {
1697 LLVMContext &Context = VectorLoop->getHeader()->getContext();
1698 MDNode *LoopID = VectorLoop->getLoopID();
1699 auto *IsEVLVectorizedMD = MDNode::get(
1700 Context,
1701 {MDString::get(Context, "llvm.loop.isvectorized.tailfoldingstyle"),
1702 MDString::get(Context, "evl")});
1703 MDNode *NewLoopID = makePostTransformationMetadata(Context, LoopID, {},
1704 {IsEVLVectorizedMD});
1705 VectorLoop->setLoopID(NewLoopID);
1706 }
1707 }
1709 TTI.getUnrollingPreferences(VectorLoop, *PSE.getSE(), UP, ORE);
1710 if (!UP.UnrollVectorizedLoop || VectorizingEpilogue)
1712
1713 // Set/update profile weights for the vector and remainder loops as original
1714 // loop iterations are now distributed among them. Note that original loop
1715 // becomes the scalar remainder loop after vectorization.
1716 //
1717 // For cases like foldTailByMasking() and requiresScalarEpiloque() we may
1718 // end up getting slightly roughened result but that should be OK since
1719 // profile is not inherently precise anyway. Note also possible bypass of
1720 // vector code caused by legality checks is ignored, assigning all the weight
1721 // to the vector loop, optimistically.
1722 //
1723 // For scalable vectorization we can't know at compile time how many
1724 // iterations of the loop are handled in one vector iteration, so instead
1725 // use the value of vscale used for tuning.
1726 setProfileInfoAfterUnrolling(OrigLoop, VectorLoop, OrigLoop, EstimatedVFxUF);
1727}
1728
1729#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1731 if (VPlans.empty()) {
1732 O << "LV: No VPlans built.\n";
1733 return;
1734 }
1735 for (const auto &Plan : VPlans)
1737 Plan->printDOT(O);
1738 else
1739 Plan->print(O);
1740}
1741#endif
1742
1745 if (!V->isLiveIn())
1746 return {};
1747
1748 return TTI::getOperandInfo(V->getLiveInIRValue());
1749}
1750
1753 if (VF.isScalar())
1754 return 0;
1755
1756 InstructionCost ScalarizationCost = 0;
1757 // Compute the cost of scalarizing the result if needed.
1758 if (!ResultTy->isVoidTy()) {
1759 for (Type *VectorTy :
1760 to_vector(getContainedTypes(toVectorizedTy(ResultTy, VF)))) {
1761 ScalarizationCost += TTI.getScalarizationOverhead(
1763 /*Insert=*/true,
1764 /*Extract=*/false, CostKind);
1765 }
1766 }
1767 // Compute the cost of scalarizing the operands, skipping ones that do not
1768 // require extraction/scalarization and do not incur any overhead.
1769 SmallPtrSet<const VPValue *, 4> UniqueOperands;
1771 for (auto *Op : Operands) {
1773 !UniqueOperands.insert(Op).second)
1774 continue;
1775 Tys.push_back(toVectorizedTy(Types.inferScalarType(Op), VF));
1776 }
1777 return ScalarizationCost +
1778 TTI.getOperandsScalarizationOverhead(Tys, CostKind);
1779}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Definition Compiler.h:638
dxil pretty DXIL Metadata Pretty Printer
Flatten the CFG
#define _
This file provides various utilities for inspecting and working with the control flow graph in LLVM I...
This file defines the LoopVectorizationLegality class.
This file provides a LoopVectorizationPlanner class.
#define I(x, y, z)
Definition MD5.cpp:58
mir Rename Register Operands
#define T
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
#define P(N)
This file builds on the ADT/GraphTraits.h file to build a generic graph post order iterator.
static StringRef getName(Value *V)
This file contains some templates that are useful if you are working with the STL at all.
This file defines the SmallVector class.
This file contains some functions that are useful when dealing with strings.
#define LLVM_DEBUG(...)
Definition Debug.h:114
This file implements dominator tree analysis for a single level of a VPlan's H-CFG.
This file contains the declarations of different VPlan-related auxiliary helpers.
This file provides utility VPlan to VPlan transformations.
static void addRuntimeUnrollDisableMetaData(Loop *L)
Definition VPlan.cpp:1612
static T * getPlanEntry(T *Start)
Definition VPlan.cpp:145
static T * getEnclosingLoopRegionForRegion(T *P)
Return the enclosing loop region for region P.
Definition VPlan.cpp:609
const char LLVMLoopVectorizeFollowupAll[]
Definition VPlan.cpp:61
static bool isDefinedInsideLoopRegions(const VPValue *VPV)
Returns true if there is a vector loop region and VPV is defined in a loop region.
Definition VPlan.cpp:1391
static bool hasConditionalTerminator(const VPBasicBlock *VPBB)
Definition VPlan.cpp:627
const char LLVMLoopVectorizeFollowupVectorized[]
Definition VPlan.cpp:62
static void remapOperands(VPBlockBase *Entry, VPBlockBase *NewEntry, DenseMap< VPValue *, VPValue * > &Old2NewVPValues)
Definition VPlan.cpp:1138
const char LLVMLoopVectorizeFollowupEpilogue[]
Definition VPlan.cpp:64
static std::pair< VPBlockBase *, VPBlockBase * > cloneFrom(VPBlockBase *Entry)
Definition VPlan.cpp:719
static cl::opt< bool > PrintVPlansInDotFormat("vplan-print-in-dot-format", cl::Hidden, cl::desc("Use dot format instead of plain text when dumping VPlans"))
This file contains the declarations of the Vectorization Plan base classes:
static bool IsCondBranch(unsigned BrOpc)
static APInt getAllOnes(unsigned numBits)
Return an APInt of a specified width with all bits set.
Definition APInt.h:234
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:41
A cache of @llvm.assume calls within a function.
LLVM Basic Block Representation.
Definition BasicBlock.h:62
iterator begin()
Instruction iterator methods.
Definition BasicBlock.h:459
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
static BasicBlock * Create(LLVMContext &Context, const Twine &Name="", Function *Parent=nullptr, BasicBlock *InsertBefore=nullptr)
Creates a new BasicBlock.
Definition BasicBlock.h:206
LLVM_ABI const BasicBlock * getSingleSuccessor() const
Return the successor of this block if it has a single successor.
InstListType::iterator iterator
Instruction iterators...
Definition BasicBlock.h:170
LLVM_ABI LLVMContext & getContext() const
Get the context in which this basic block lives.
size_t size() const
Definition BasicBlock.h:480
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction if the block is well formed or null if the block is not well forme...
Definition BasicBlock.h:233
static BranchInst * Create(BasicBlock *IfTrue, InsertPosition InsertBefore=nullptr)
std::optional< const DILocation * > cloneByMultiplyingDuplicationFactor(unsigned DF) const
Returns a new DILocation with duplication factor DF * current duplication factor encoded in the discr...
A debug info location.
Definition DebugLoc.h:124
ValueT lookup(const_arg_type_t< KeyT > Val) const
lookup - Return the entry for the specified key, or a default constructed value if no such entry exis...
Definition DenseMap.h:187
bool contains(const_arg_type_t< KeyT > Val) const
Return true if the specified key is in the map, false otherwise.
Definition DenseMap.h:156
bool dominates(const DomTreeNodeBase< NodeT > *A, const DomTreeNodeBase< NodeT > *B) const
dominates - Returns true iff A dominates B.
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition Dominators.h:165
constexpr bool isScalar() const
Exactly one element.
Definition TypeSize.h:320
Common base class shared among various IRBuilders.
Definition IRBuilder.h:114
static InstructionCost getInvalid(CostType Val=0)
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
A helper class to return the specified delimiter string after the first invocation of operator String...
BlockT * getHeader() const
void addBasicBlockToLoop(BlockT *NewBB, LoopInfoBase< BlockT, LoopT > &LI)
This method is used by other analyses to update loop information.
void addChildLoop(LoopT *NewChild)
Add the specified loop to be a child of this loop.
VPlan & getPlanFor(ElementCount VF) const
Return the VPlan for VF.
Definition VPlan.cpp:1599
void buildVPlans(ElementCount MinVF, ElementCount MaxVF)
Build VPlans for power-of-2 VF's between MinVF and MaxVF inclusive, according to the information gath...
Definition VPlan.cpp:1583
void updateLoopMetadataAndProfileInfo(Loop *VectorLoop, VPBasicBlock *HeaderVPBB, bool VectorizingEpilogue, unsigned EstimatedVFxUF, bool DisableRuntimeUnroll)
Update loop metadata and profile info for both the scalar remainder loop and VectorLoop,...
Definition VPlan.cpp:1650
static bool getDecisionAndClampRange(const std::function< bool(ElementCount)> &Predicate, VFRange &Range)
Test a Predicate on a Range of VF's.
Definition VPlan.cpp:1564
void printPlans(raw_ostream &O)
Definition VPlan.cpp:1730
Utility class for getting and setting loop vectorizer hints in the form of loop metadata.
Represents a single loop in the control flow graph.
Definition LoopInfo.h:40
void setLoopID(MDNode *LoopID) const
Set the llvm.loop loop id metadata for this loop.
Definition LoopInfo.cpp:526
MDNode * getLoopID() const
Return the llvm.loop loop id metadata node for this loop if it is present.
Definition LoopInfo.cpp:502
Metadata node.
Definition Metadata.h:1077
LLVM_ABI void replaceOperandWith(unsigned I, Metadata *New)
Replace a specific operand.
const MDOperand & getOperand(unsigned I) const
Definition Metadata.h:1445
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1565
unsigned getNumOperands() const
Return number of MDNode operands.
Definition Metadata.h:1451
static LLVM_ABI MDString * get(LLVMContext &Context, StringRef Str)
Definition Metadata.cpp:607
BlockT * getEntry() const
Get the entry BasicBlock of the Region.
Definition RegionInfo.h:320
size_type size() const
Determine the number of elements in the SetVector.
Definition SetVector.h:104
void insert_range(Range &&R)
Definition SetVector.h:193
bool insert(const value_type &X)
Insert a new element into the SetVector.
Definition SetVector.h:168
This class provides computation of slot numbers for LLVM Assembly writing.
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
A SetVector that performs no allocations if smaller than a certain size.
Definition SetVector.h:356
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
std::pair< iterator, bool > try_emplace(StringRef Key, ArgsTy &&...Args)
Emplace a new element for the specified key into the map if the key isn't already in the map.
Definition StringMap.h:370
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition StringRef.h:710
StringRef rtrim(char Char) const
Return string with consecutive Char characters starting from the right removed.
Definition StringRef.h:812
This pass provides access to the codegen interfaces that are needed for IR-level transformations.
static LLVM_ABI OperandValueInfo getOperandInfo(const Value *V)
Collect properties of V used in cost analysis, e.g. OP_PowerOf2.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:45
bool isVoidTy() const
Return true if this is 'void'.
Definition Type.h:139
This function has undefined behavior.
void setOperand(unsigned i, Value *Val)
Definition User.h:237
Value * getOperand(unsigned i) const
Definition User.h:232
unsigned getNumOperands() const
Definition User.h:254
VPBasicBlock serves as the leaf of the Hierarchical Control-Flow Graph.
Definition VPlan.h:3751
void appendRecipe(VPRecipeBase *Recipe)
Augment the existing recipes of a VPBasicBlock with an additional Recipe as the last recipe.
Definition VPlan.h:3826
RecipeListTy::iterator iterator
Instruction iterators...
Definition VPlan.h:3778
void execute(VPTransformState *State) override
The method which generates the output IR instructions that correspond to this VPBasicBlock,...
Definition VPlan.cpp:519
iterator end()
Definition VPlan.h:3788
iterator begin()
Recipe iterator methods.
Definition VPlan.h:3786
VPBasicBlock * clone() override
Clone the current block and it's recipes, without updating the operands of the cloned recipes.
Definition VPlan.cpp:570
InstructionCost cost(ElementCount VF, VPCostContext &Ctx) override
Return the cost of this VPBasicBlock.
Definition VPlan.cpp:800
const VPBasicBlock * getCFGPredecessor(unsigned Idx) const
Returns the predecessor block at index Idx with the predecessors as per the corresponding plain CFG.
Definition VPlan.cpp:807
iterator getFirstNonPhi()
Return the position of the first non-phi node recipe in the block.
Definition VPlan.cpp:246
void connectToPredecessors(VPTransformState &State)
Connect the VPBBs predecessors' in the VPlan CFG to the IR basic block generated for this VPBB.
Definition VPlan.cpp:419
VPRegionBlock * getEnclosingLoopRegion()
Definition VPlan.cpp:619
VPBasicBlock * splitAt(iterator SplitAt)
Split current block at SplitAt by inserting a new block between the current block and its successors ...
Definition VPlan.cpp:591
RecipeListTy Recipes
The VPRecipes held in the order of output instructions to generate.
Definition VPlan.h:3766
void executeRecipes(VPTransformState *State, BasicBlock *BB)
Execute the recipes in the IR basic block BB.
Definition VPlan.cpp:577
void print(raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
Print this VPBsicBlock to O, prefixing all lines with Indent.
Definition VPlan.cpp:698
bool isExiting() const
Returns true if the block is exiting it's parent region.
Definition VPlan.cpp:676
VPRecipeBase * getTerminator()
If the block has multiple successors, return the branch recipe terminating the block.
Definition VPlan.cpp:664
const VPRecipeBase & back() const
Definition VPlan.h:3800
bool empty() const
Definition VPlan.h:3797
size_t size() const
Definition VPlan.h:3796
VPBlockBase is the building block of the Hierarchical Control-Flow Graph.
Definition VPlan.h:81
void setSuccessors(ArrayRef< VPBlockBase * > NewSuccs)
Set each VPBasicBlock in NewSuccss as successor of this VPBlockBase.
Definition VPlan.h:300
VPRegionBlock * getParent()
Definition VPlan.h:173
const VPBasicBlock * getExitingBasicBlock() const
Definition VPlan.cpp:190
void setName(const Twine &newName)
Definition VPlan.h:166
size_t getNumSuccessors() const
Definition VPlan.h:219
iterator_range< VPBlockBase ** > successors()
Definition VPlan.h:201
virtual void print(raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
Print plain-text dump of this VPBlockBase to O, prefixing all lines with Indent.
bool hasPredecessors() const
Returns true if this block has any predecessors.
Definition VPlan.h:223
void printSuccessors(raw_ostream &O, const Twine &Indent) const
Print the successors of this block to O, prefixing all lines with Indent.
Definition VPlan.cpp:686
size_t getNumPredecessors() const
Definition VPlan.h:220
void setPredecessors(ArrayRef< VPBlockBase * > NewPreds)
Set each VPBasicBlock in NewPreds as predecessor of this VPBlockBase.
Definition VPlan.h:291
VPBlockBase * getEnclosingBlockWithPredecessors()
Definition VPlan.cpp:212
const VPBlocksTy & getPredecessors() const
Definition VPlan.h:204
VPlan * getPlan()
Definition VPlan.cpp:165
void setPlan(VPlan *ParentPlan)
Sets the pointer of the plan containing the block.
Definition VPlan.cpp:184
const std::string & getName() const
Definition VPlan.h:164
VPBlockBase * getSinglePredecessor() const
Definition VPlan.h:215
const VPBlocksTy & getHierarchicalSuccessors()
Definition VPlan.h:242
VPBlockBase(const unsigned char SC, const std::string &N)
Definition VPlan.h:150
VPBlockBase * getEnclosingBlockWithSuccessors()
An Enclosing Block of a block B is any block containing B, including B itself.
Definition VPlan.cpp:204
const VPBasicBlock * getEntryBasicBlock() const
Definition VPlan.cpp:170
VPBlockBase * getSingleHierarchicalPredecessor()
Definition VPlan.h:264
VPBlockBase * getSingleSuccessor() const
Definition VPlan.h:209
const VPBlocksTy & getSuccessors() const
Definition VPlan.h:198
static auto blocksOnly(const T &Range)
Return an iterator range over Range which only includes BlockTy blocks.
Definition VPlanUtils.h:217
static void insertBlockAfter(VPBlockBase *NewBlock, VPBlockBase *BlockPtr)
Insert disconnected VPBlockBase NewBlock after BlockPtr.
Definition VPlanUtils.h:120
static bool isLatch(const VPBlockBase *VPB, const VPDominatorTree &VPDT)
Returns true if VPB is a loop latch, using isHeader().
Definition VPlan.cpp:237
static bool isHeader(const VPBlockBase *VPB, const VPDominatorTree &VPDT)
Returns true if VPB is a loop header, based on regions or VPDT in their absence.
Definition VPlan.cpp:220
static void connectBlocks(VPBlockBase *From, VPBlockBase *To, unsigned PredIdx=-1u, unsigned SuccIdx=-1u)
Connect VPBlockBases From and To bi-directionally.
Definition VPlanUtils.h:176
static void disconnectBlocks(VPBlockBase *From, VPBlockBase *To)
Disconnect VPBlockBases From and To bi-directionally.
Definition VPlanUtils.h:195
VPlan-based builder utility analogous to IRBuilder.
VPPhi * createScalarPhi(ArrayRef< VPValue * > IncomingValues, DebugLoc DL, const Twine &Name="")
void dump() const
Dump the VPDef to stderr (for debugging).
Definition VPlan.cpp:126
virtual void print(raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
Each concrete VPDef prints itself.
Template specialization of the standard LLVM dominator tree utility for VPBlockBases.
Recipe to expand a SCEV expression.
Definition VPlan.h:3370
A special type of VPBasicBlock that wraps an existing IR basic block.
Definition VPlan.h:3904
void execute(VPTransformState *State) override
The method which generates the output IR instructions that correspond to this VPBasicBlock,...
Definition VPlan.cpp:487
BasicBlock * getIRBasicBlock() const
Definition VPlan.h:3928
VPIRBasicBlock * clone() override
Clone the current block and it's recipes, without updating the operands of the cloned recipes.
Definition VPlan.cpp:512
static LLVM_ABI_FOR_TEST VPIRInstruction * create(Instruction &I)
Create a new VPIRPhi for \I , if it is a PHINode, otherwise create a VPIRInstruction.
In what follows, the term "input IR" refers to code that is fed into the vectorizer whereas the term ...
Value * getAsRuntimeExpr(IRBuilderBase &Builder, const ElementCount &VF) const
Returns an expression describing the lane index that can be used at runtime.
Definition VPlan.cpp:85
static VPLane getFirstLane()
@ ScalableLast
For ScalableLast, Lane is the offset from the start of the last N-element subvector in a scalable vec...
@ First
For First, Lane is the index into the first N elements of a fixed-vector <N x <ElTy>> or a scalable v...
VPRecipeBase is a base class modeling a sequence of one or more output IR instructions.
Definition VPlan.h:394
VPBasicBlock * getParent()
Definition VPlan.h:415
VPRegionBlock represents a collection of VPBasicBlocks and VPRegionBlocks which form a Single-Entry-S...
Definition VPlan.h:3939
VPRegionBlock * clone() override
Clone all blocks in the single-entry single-exit region of the block and their recipes without updati...
Definition VPlan.cpp:769
const VPBlockBase * getEntry() const
Definition VPlan.h:3975
void dissolveToCFGLoop()
Remove the current region from its VPlan, connecting its predecessor to its entry,...
Definition VPlan.cpp:878
bool isReplicator() const
An indicator whether this region is to generate multiple replicated instances of output IR correspond...
Definition VPlan.h:4007
InstructionCost cost(ElementCount VF, VPCostContext &Ctx) override
Return the cost of the block.
Definition VPlan.cpp:826
void print(raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
Print this VPRegionBlock to O (recursively), prefixing all lines with Indent.
Definition VPlan.cpp:864
void execute(VPTransformState *State) override
The method which generates the output IR instructions that correspond to this VPRegionBlock,...
Definition VPlan.cpp:778
const VPBlockBase * getExiting() const
Definition VPlan.h:3987
A recipe for handling phi nodes of integer and floating-point inductions, producing their scalar valu...
Definition VPlan.h:3641
This class can be used to assign names to VPValues.
std::string getOrCreateName(const VPValue *V) const
Returns the name assigned to V, if there is one, otherwise try to construct one from the underlying v...
Definition VPlan.cpp:1536
This class augments VPValue with operands which provide the inverse def-use edges from VPValue's user...
Definition VPlanValue.h:197
void replaceUsesOfWith(VPValue *From, VPValue *To)
Replaces all uses of From in the VPUser with To.
Definition VPlan.cpp:1431
void printOperands(raw_ostream &O, VPSlotTracker &SlotTracker) const
Print the operands to O.
Definition VPlan.cpp:1443
operand_range operands()
Definition VPlanValue.h:265
void setOperand(unsigned I, VPValue *New)
Definition VPlanValue.h:241
unsigned getNumOperands() const
Definition VPlanValue.h:235
VPValue * getOperand(unsigned N) const
Definition VPlanValue.h:236
bool isDefinedOutsideLoopRegions() const
Returns true if the VPValue is defined outside any loop.
Definition VPlan.cpp:1397
VPRecipeBase * getDefiningRecipe()
Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe,...
Definition VPlan.cpp:135
void printAsOperand(raw_ostream &OS, VPSlotTracker &Tracker) const
Definition VPlan.cpp:1439
friend class VPDef
Definition VPlanValue.h:49
Value * UnderlyingVal
Definition VPlanValue.h:61
void dump() const
Dump the value to stderr (for debugging).
Definition VPlan.cpp:118
VPValue(const unsigned char SC, Value *UV=nullptr, VPDef *Def=nullptr)
Definition VPlan.cpp:98
virtual ~VPValue()
Definition VPlan.cpp:104
void print(raw_ostream &OS, VPSlotTracker &Tracker) const
Definition VPlan.cpp:111
void replaceAllUsesWith(VPValue *New)
Definition VPlan.cpp:1400
unsigned getNumUsers() const
Definition VPlanValue.h:113
void replaceUsesWithIf(VPValue *New, llvm::function_ref< bool(VPUser &U, unsigned Idx)> ShouldReplace)
Go through the uses list for this VPValue and make each use point to New if the callback ShouldReplac...
Definition VPlan.cpp:1404
VPDef * Def
Pointer to the VPDef that defines this VPValue.
Definition VPlanValue.h:65
A recipe for handling phi nodes of integer and floating-point inductions, producing their vector valu...
Definition VPlan.h:2104
LLVM_DUMP_METHOD void dump()
Definition VPlan.cpp:1271
VPlan models a candidate for vectorization, encoding various decisions take to produce efficient outp...
Definition VPlan.h:4042
void printDOT(raw_ostream &O) const
Print this VPlan in DOT format to O.
Definition VPlan.cpp:1129
friend class VPSlotTracker
Definition VPlan.h:4044
std::string getName() const
Return a string with the name of the plan and the applicable VFs and UFs.
Definition VPlan.cpp:1105
VPBasicBlock * getEntry()
Definition VPlan.h:4141
VPRegionBlock * createVPRegionBlock(VPBlockBase *Entry, VPBlockBase *Exiting, const std::string &Name="", bool IsReplicator=false)
Create a new VPRegionBlock with Entry, Exiting and Name.
Definition VPlan.h:4382
void setName(const Twine &newName)
Definition VPlan.h:4289
VPIRBasicBlock * getExitBlock(BasicBlock *IRBB) const
Return the VPIRBasicBlock corresponding to IRBB.
Definition VPlan.cpp:937
LLVM_ABI_FOR_TEST ~VPlan()
Definition VPlan.cpp:914
bool isExitBlock(VPBlockBase *VPBB)
Returns true if VPBB is an exit block.
Definition VPlan.cpp:945
friend class VPlanPrinter
Definition VPlan.h:4043
unsigned getUF() const
Definition VPlan.h:4271
VPIRBasicBlock * createEmptyVPIRBasicBlock(BasicBlock *IRBB)
Create a VPIRBasicBlock wrapping IRBB, but do not create VPIRInstructions wrapping the instructions i...
Definition VPlan.cpp:1243
ArrayRef< VPIRBasicBlock * > getExitBlocks() const
Return an ArrayRef containing VPIRBasicBlocks wrapping the exit blocks of the original scalar loop.
Definition VPlan.h:4193
LLVM_ABI_FOR_TEST VPRegionBlock * getVectorLoopRegion()
Returns the VPRegionBlock of the vector loop.
Definition VPlan.cpp:1034
InstructionCost cost(ElementCount VF, VPCostContext &Ctx)
Return the cost of this plan.
Definition VPlan.cpp:1016
void setEntry(VPBasicBlock *VPBB)
Definition VPlan.h:4130
VPBasicBlock * createVPBasicBlock(const Twine &Name, VPRecipeBase *Recipe=nullptr)
Create a new VPBasicBlock with Name and containing Recipe if present.
Definition VPlan.h:4372
LLVM_ABI_FOR_TEST VPIRBasicBlock * createVPIRBasicBlock(BasicBlock *IRBB)
Create a VPIRBasicBlock from IRBB containing VPIRInstructions for all instructions in IRBB,...
Definition VPlan.cpp:1249
LLVM_DUMP_METHOD void dump() const
Dump the plan to stderr (for debugging).
Definition VPlan.cpp:1135
void execute(VPTransformState *State)
Generate the IR code for this VPlan.
Definition VPlan.cpp:952
ArrayRef< VPValue * > getLiveIns() const
Return the list of live-in VPValues available in the VPlan.
Definition VPlan.h:4323
void print(raw_ostream &O) const
Print this VPlan to O.
Definition VPlan.cpp:1088
VPIRBasicBlock * getScalarHeader() const
Return the VPIRBasicBlock wrapping the header of the scalar loop.
Definition VPlan.h:4189
void printLiveIns(raw_ostream &O) const
Print the live-ins of this VPlan to O.
Definition VPlan.cpp:1050
VPlan * duplicate()
Clone the current VPlan, update all VPValues of the new VPlan and cloned recipes to refer to the clon...
Definition VPlan.cpp:1176
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:256
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:322
constexpr ScalarTy getFixedValue() const
Definition TypeSize.h:200
static constexpr bool isKnownLT(const FixedOrScalableQuantity &LHS, const FixedOrScalableQuantity &RHS)
Definition TypeSize.h:216
constexpr bool isScalable() const
Returns whether the quantity is scaled by a runtime quantity (vscale).
Definition TypeSize.h:169
constexpr ScalarTy getKnownMinValue() const
Returns the minimum value this quantity can represent.
Definition TypeSize.h:166
An efficient, type-erasing, non-owning reference to a callable.
self_iterator getIterator()
Definition ilist_node.h:134
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
A raw_ostream that writes to an std::string.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ Tail
Attemps to make calls as fast as possible while guaranteeing that tail call optimization can always b...
Definition CallingConv.h:76
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
LLVM_ABI std::string EscapeString(const std::string &Label)
@ BasicBlock
Various leaf nodes.
Definition ISDOpcodes.h:81
bool match(Val *V, const Pattern &P)
VPInstruction_match< VPInstruction::BranchOnCount, Op0_t, Op1_t > m_BranchOnCount(const Op0_t &Op0, const Op1_t &Op1)
class_match< VPValue > m_VPValue()
Match an arbitrary VPValue and ignore it.
VPInstruction_match< VPInstruction::BuildVector > m_BuildVector()
BuildVector is matches only its opcode, w/o matching its operands as the number of operands is not fi...
VPInstruction_match< VPInstruction::BranchOnCond, Op0_t > m_BranchOnCond(const Op0_t &Op0)
bool isSingleScalar(const VPValue *VPV)
Returns true if VPV is a single scalar, either because it produces the same value for all lanes or on...
Definition VPlanUtils.h:44
VPBasicBlock * getFirstLoopHeader(VPlan &Plan, VPDominatorTree &VPDT)
Returns the header block of the first, top-level loop, or null if none exist.
bool onlyFirstLaneUsed(const VPValue *Def)
Returns true if only the first lane of Def is used.
This is an optimization pass for GlobalISel generic memory operations.
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition STLExtras.h:310
detail::zippy< detail::zip_shortest, T, U, Args... > zip(T &&t, U &&u, Args &&...args)
zip iterator for two or more iteratable types.
Definition STLExtras.h:823
InstructionCost Cost
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:649
Value * getRuntimeVF(IRBuilderBase &B, Type *Ty, ElementCount VF)
Return the runtime value for VF.
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
LLVM_ABI std::optional< MDNode * > makeFollowupLoopID(MDNode *OrigLoopID, ArrayRef< StringRef > FollowupAttrs, const char *InheritOptionsAttrsPrefix="", bool AlwaysNew=false)
Create a new loop identifier for a loop created from a loop transformation.
void interleaveComma(const Container &c, StreamT &os, UnaryFunctor each_fn)
Definition STLExtras.h:2213
iterator_range< early_inc_iterator_impl< detail::IterOfRange< RangeT > > > make_early_inc_range(RangeT &&Range)
Make a range that does early increment to allow mutation of the underlying range without disrupting i...
Definition STLExtras.h:626
auto cast_or_null(const Y &Val)
Definition Casting.h:720
iterator_range< df_iterator< VPBlockShallowTraversalWrapper< VPBlockBase * > > > vp_depth_first_shallow(VPBlockBase *G)
Returns an iterator range to traverse the graph starting at G in depth-first order.
Definition VPlanCFG.h:216
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:759
LLVM_ABI cl::opt< bool > EnableFSDiscriminator
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1714
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:207
SmallVector< ValueTypeFromRangeType< R >, Size > to_vector(R &&Range)
Given a range of type R, iterate the entire range and return a SmallVector with elements of the vecto...
Type * toVectorizedTy(Type *Ty, ElementCount EC)
A helper for converting to vectorized types.
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
cl::opt< unsigned > ForceTargetInstructionCost
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:548
RNSuccIterator< NodeRef, BlockT, RegionT > succ_begin(NodeRef Node)
RNSuccIterator< NodeRef, BlockT, RegionT > succ_end(NodeRef Node)
LLVM_ABI void setProfileInfoAfterUnrolling(Loop *OrigLoop, Loop *UnrolledLoop, Loop *RemainderLoop, uint64_t UF)
Set weights for UnrolledLoop and RemainderLoop based on weights for OrigLoop and the following distri...
FunctionAddr VTableAddr Next
Definition InstrProf.h:141
DWARFExpression::Operation Op
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
auto count_if(R &&Range, UnaryPredicate P)
Wrapper function around std::count_if to count the number of times an element satisfying a given pred...
Definition STLExtras.h:1943
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:565
LLVM_ABI BasicBlock * SplitBlock(BasicBlock *Old, BasicBlock::iterator SplitPt, DominatorTree *DT, LoopInfo *LI=nullptr, MemorySSAUpdater *MSSAU=nullptr, const Twine &BBName="", bool Before=false)
Split the specified block at the specified instruction.
auto find_if(R &&Range, UnaryPredicate P)
Provide wrappers to std::find_if which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1740
LLVM_ABI llvm::MDNode * makePostTransformationMetadata(llvm::LLVMContext &Context, MDNode *OrigLoopID, llvm::ArrayRef< llvm::StringRef > RemovePrefixes, llvm::ArrayRef< llvm::MDNode * > AddAttrs)
Create a new LoopID after the loop has been transformed.
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition STLExtras.h:1879
cl::opt< bool > EnableVPlanNativePath
Definition VPlan.cpp:56
ArrayRef< Type * > getContainedTypes(Type *const &Ty)
Returns the types contained in Ty.
auto seq(T Begin, T End)
Iterate over an integral type from Begin up to - but not including - End.
Definition Sequence.h:305
unsigned getPredBlockCostDivisor(TargetTransformInfo::TargetCostKind CostKind)
A helper function that returns how much we should divide the cost of a predicated block by.
std::unique_ptr< VPlan > VPlanPtr
Definition VPlan.h:77
Parameters that control the generic loop unrolling transformation.
bool UnrollVectorizedLoop
Don't disable runtime unroll for the loops which were vectorized.
A range of powers-of-2 vectorization factors with fixed start and adjustable end.
ElementCount End
Struct to hold various analysis needed for cost computations.
InstructionCost getScalarizationOverhead(Type *ResultTy, ArrayRef< const VPValue * > Operands, ElementCount VF)
Estimate the overhead of scalarizing a recipe with result type ResultTy and Operands with VF.
Definition VPlan.cpp:1751
TargetTransformInfo::OperandValueInfo getOperandInfo(VPValue *V) const
Returns the OperandInfo for V, if it is a live-in.
Definition VPlan.cpp:1744
TargetTransformInfo::TargetCostKind CostKind
VPTypeAnalysis Types
const TargetTransformInfo & TTI
VPTransformState holds information passed down when "executing" a VPlan, needed for generating the ou...
LoopInfo * LI
Hold a pointer to LoopInfo to register new basic blocks in the loop.
VPTypeAnalysis TypeAnalysis
VPlan-based type analysis.
struct llvm::VPTransformState::DataState Data
struct llvm::VPTransformState::CFGState CFG
Value * get(const VPValue *Def, bool IsScalar=false)
Get the generated vector Value for a given VPValue Def if IsScalar is false, otherwise return the gen...
Definition VPlan.cpp:293
VPTransformState(const TargetTransformInfo *TTI, ElementCount VF, LoopInfo *LI, DominatorTree *DT, AssumptionCache *AC, IRBuilderBase &Builder, VPlan *Plan, Loop *CurrentParentLoop, Type *CanonicalIVTy)
Definition VPlan.cpp:253
std::optional< VPLane > Lane
Hold the index to generate specific scalar instructions.
IRBuilderBase & Builder
Hold a reference to the IRBuilder used to generate output IR code.
bool hasScalarValue(const VPValue *Def, VPLane Lane)
const TargetTransformInfo * TTI
Target Transform Info.
VPlan * Plan
Pointer to the VPlan code is generated for.
void set(const VPValue *Def, Value *V, bool IsScalar=false)
Set the generated vector Value for a given VPValue, if IsScalar is false.
bool hasVectorValue(const VPValue *Def)
VPDominatorTree VPDT
VPlan-based dominator tree.
ElementCount VF
The chosen Vectorization Factor of the loop being vectorized.
Value * packScalarIntoVectorizedValue(const VPValue *Def, Value *WideValue, const VPLane &Lane)
Insert the scalar value of Def at Lane into Lane of WideValue and return the resulting value.
Definition VPlan.cpp:387
AssumptionCache * AC
Hold a pointer to AssumptionCache to register new assumptions after replicating assume calls.
void setDebugLocFrom(DebugLoc DL)
Set the debug location in the builder using the debug location DL.
Definition VPlan.cpp:365
Loop * CurrentParentLoop
The parent loop object for the current scope, or nullptr.
static void optimize(VPlan &Plan)
Apply VPlan-to-VPlan optimizations to Plan, including induction recipe optimizations,...